Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * arrayfuncs.c
4 : : * Support functions for arrays.
5 : : *
6 : : * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
7 : : * Portions Copyright (c) 1994, Regents of the University of California
8 : : *
9 : : *
10 : : * IDENTIFICATION
11 : : * src/backend/utils/adt/arrayfuncs.c
12 : : *
13 : : *-------------------------------------------------------------------------
14 : : */
15 : : #include "postgres.h"
16 : :
17 : : #include <ctype.h>
18 : : #include <math.h>
19 : :
20 : : #include "access/transam.h"
21 : : #include "catalog/pg_type.h"
22 : : #include "common/int.h"
23 : : #include "funcapi.h"
24 : : #include "libpq/pqformat.h"
25 : : #include "nodes/nodeFuncs.h"
26 : : #include "nodes/supportnodes.h"
27 : : #include "optimizer/optimizer.h"
28 : : #include "parser/scansup.h"
29 : : #include "port/pg_bitutils.h"
30 : : #include "utils/array.h"
31 : : #include "utils/arrayaccess.h"
32 : : #include "utils/builtins.h"
33 : : #include "utils/datum.h"
34 : : #include "utils/fmgroids.h"
35 : : #include "utils/lsyscache.h"
36 : : #include "utils/memutils.h"
37 : : #include "utils/selfuncs.h"
38 : : #include "utils/typcache.h"
39 : :
40 : :
41 : : /*
42 : : * GUC parameter
43 : : */
44 : : bool Array_nulls = true;
45 : :
46 : : /*
47 : : * Local definitions
48 : : */
49 : : #define ASSGN "="
50 : :
51 : : #define AARR_FREE_IF_COPY(array,n) \
52 : : do { \
53 : : if (!VARATT_IS_EXPANDED_HEADER(array)) \
54 : : PG_FREE_IF_COPY(array, n); \
55 : : } while (0)
56 : :
57 : : /* ReadArrayToken return type */
58 : : typedef enum
59 : : {
60 : : ATOK_LEVEL_START,
61 : : ATOK_LEVEL_END,
62 : : ATOK_DELIM,
63 : : ATOK_ELEM,
64 : : ATOK_ELEM_NULL,
65 : : ATOK_ERROR,
66 : : } ArrayToken;
67 : :
68 : : /* Working state for array_iterate() */
69 : : typedef struct ArrayIteratorData
70 : : {
71 : : /* basic info about the array, set up during array_create_iterator() */
72 : : ArrayType *arr; /* array we're iterating through */
73 : : uint8 *nullbitmap; /* its null bitmap, if any */
74 : : int nitems; /* total number of elements in array */
75 : : int16 typlen; /* element type's length */
76 : : bool typbyval; /* element type's byval property */
77 : : char typalign; /* element type's align property */
78 : : uint8 typalignby; /* typalign mapped to numeric alignment */
79 : :
80 : : /* information about the requested slice size */
81 : : int slice_ndim; /* slice dimension, or 0 if not slicing */
82 : : int slice_len; /* number of elements per slice */
83 : : int *slice_dims; /* slice dims array */
84 : : int *slice_lbound; /* slice lbound array */
85 : : Datum *slice_values; /* workspace of length slice_len */
86 : : bool *slice_nulls; /* workspace of length slice_len */
87 : :
88 : : /* current position information, updated on each iteration */
89 : : char *data_ptr; /* our current position in the array */
90 : : int current_item; /* the item # we're at in the array */
91 : : } ArrayIteratorData;
92 : :
93 : : static bool ReadArrayDimensions(char **srcptr, int *ndim_p,
94 : : int *dim, int *lBound,
95 : : const char *origStr, Node *escontext);
96 : : static bool ReadDimensionInt(char **srcptr, int *result,
97 : : const char *origStr, Node *escontext);
98 : : static bool ReadArrayStr(char **srcptr,
99 : : FmgrInfo *inputproc, Oid typioparam, int32 typmod,
100 : : char typdelim,
101 : : int typlen, bool typbyval, char typalign,
102 : : int *ndim_p, int *dim,
103 : : int *nitems_p,
104 : : Datum **values_p, bool **nulls_p,
105 : : const char *origStr, Node *escontext);
106 : : static ArrayToken ReadArrayToken(char **srcptr, StringInfo elembuf, char typdelim,
107 : : const char *origStr, Node *escontext);
108 : : static void ReadArrayBinary(StringInfo buf, int nitems,
109 : : FmgrInfo *receiveproc, Oid typioparam, int32 typmod,
110 : : int typlen, bool typbyval, char typalign,
111 : : Datum *values, bool *nulls,
112 : : bool *hasnulls, int32 *nbytes);
113 : : static Datum array_get_element_expanded(Datum arraydatum,
114 : : int nSubscripts, int *indx,
115 : : int arraytyplen,
116 : : int elmlen, bool elmbyval, char elmalign,
117 : : bool *isNull);
118 : : static Datum array_set_element_expanded(Datum arraydatum,
119 : : int nSubscripts, int *indx,
120 : : Datum dataValue, bool isNull,
121 : : int arraytyplen,
122 : : int elmlen, bool elmbyval, char elmalign);
123 : : static bool array_get_isnull(const uint8 *nullbitmap, int offset);
124 : : static void array_set_isnull(uint8 *nullbitmap, int offset, bool isNull);
125 : : static Datum ArrayCast(char *value, bool byval, int len);
126 : : static int ArrayCastAndSet(Datum src,
127 : : int typlen, bool typbyval, uint8 typalignby,
128 : : char *dest);
129 : : static char *array_seek(char *ptr, int offset, uint8 *nullbitmap, int nitems,
130 : : int typlen, bool typbyval, char typalign);
131 : : static int array_nelems_size(char *ptr, int offset, uint8 *nullbitmap,
132 : : int nitems, int typlen, bool typbyval, char typalign);
133 : : static int array_copy(char *destptr, int nitems,
134 : : char *srcptr, int offset, uint8 *nullbitmap,
135 : : int typlen, bool typbyval, char typalign);
136 : : static int array_slice_size(char *arraydataptr, uint8 *arraynullsptr,
137 : : int ndim, int *dim, int *lb,
138 : : int *st, int *endp,
139 : : int typlen, bool typbyval, char typalign);
140 : : static void array_extract_slice(ArrayType *newarray,
141 : : int ndim, int *dim, int *lb,
142 : : char *arraydataptr, uint8 *arraynullsptr,
143 : : int *st, int *endp,
144 : : int typlen, bool typbyval, char typalign);
145 : : static void array_insert_slice(ArrayType *destArray, ArrayType *origArray,
146 : : ArrayType *srcArray,
147 : : int ndim, int *dim, int *lb,
148 : : int *st, int *endp,
149 : : int typlen, bool typbyval, char typalign);
150 : : static int array_cmp(FunctionCallInfo fcinfo);
151 : : static ArrayType *create_array_envelope(int ndims, int *dimv, int *lbsv, int nbytes,
152 : : Oid elmtype, int dataoffset);
153 : : static ArrayType *array_fill_internal(ArrayType *dims, ArrayType *lbs,
154 : : Datum value, bool isnull, Oid elmtype,
155 : : FunctionCallInfo fcinfo);
156 : : static ArrayType *array_replace_internal(ArrayType *array,
157 : : Datum search, bool search_isnull,
158 : : Datum replace, bool replace_isnull,
159 : : bool remove, Oid collation,
160 : : FunctionCallInfo fcinfo);
161 : : static int width_bucket_array_float8(Datum operand, ArrayType *thresholds);
162 : : static int width_bucket_array_fixed(Datum operand,
163 : : ArrayType *thresholds,
164 : : Oid collation,
165 : : TypeCacheEntry *typentry);
166 : : static int width_bucket_array_variable(Datum operand,
167 : : ArrayType *thresholds,
168 : : Oid collation,
169 : : TypeCacheEntry *typentry);
170 : :
171 : :
172 : : /*
173 : : * array_in :
174 : : * converts an array from the external format in "string" to
175 : : * its internal format.
176 : : *
177 : : * return value :
178 : : * the internal representation of the input array
179 : : */
180 : : Datum
181 : 149169 : array_in(PG_FUNCTION_ARGS)
182 : : {
183 : 149169 : char *string = PG_GETARG_CSTRING(0); /* external form */
184 : 149169 : Oid element_type = PG_GETARG_OID(1); /* type of an array
185 : : * element */
186 : 149169 : int32 typmod = PG_GETARG_INT32(2); /* typmod for array elements */
187 : 149169 : Node *escontext = fcinfo->context;
188 : : int typlen;
189 : : bool typbyval;
190 : : char typalign;
191 : : uint8 typalignby;
192 : : char typdelim;
193 : : Oid typioparam;
194 : : char *p;
195 : : int nitems;
196 : : Datum *values;
197 : : bool *nulls;
198 : : bool hasnulls;
199 : : int32 nbytes;
200 : : int32 dataoffset;
201 : : ArrayType *retval;
202 : : int ndim,
203 : : dim[MAXDIM],
204 : : lBound[MAXDIM];
205 : : ArrayMetaState *my_extra;
206 : :
207 : : /*
208 : : * We arrange to look up info about element type, including its input
209 : : * conversion proc, only once per series of calls, assuming the element
210 : : * type doesn't change underneath us.
211 : : */
212 : 149169 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
213 [ + + ]: 149169 : if (my_extra == NULL)
214 : : {
215 : 54010 : fcinfo->flinfo->fn_extra = MemoryContextAlloc(fcinfo->flinfo->fn_mcxt,
216 : : sizeof(ArrayMetaState));
217 : 54010 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
218 : 54010 : my_extra->element_type = ~element_type;
219 : : }
220 : :
221 [ + + ]: 149169 : if (my_extra->element_type != element_type)
222 : : {
223 : : /*
224 : : * Get info about element type, including its input conversion proc
225 : : */
226 : 54165 : get_type_io_data(element_type, IOFunc_input,
227 : : &my_extra->typlen, &my_extra->typbyval,
228 : : &my_extra->typalign, &my_extra->typdelim,
229 : : &my_extra->typioparam, &my_extra->typiofunc);
230 : 54165 : fmgr_info_cxt(my_extra->typiofunc, &my_extra->proc,
231 : 54165 : fcinfo->flinfo->fn_mcxt);
232 : 54165 : my_extra->element_type = element_type;
233 : : }
234 : 149169 : typlen = my_extra->typlen;
235 : 149169 : typbyval = my_extra->typbyval;
236 : 149169 : typalign = my_extra->typalign;
237 : 149169 : typalignby = typalign_to_alignby(typalign);
238 : 149169 : typdelim = my_extra->typdelim;
239 : 149169 : typioparam = my_extra->typioparam;
240 : :
241 : : /*
242 : : * Initialize dim[] and lBound[] for ReadArrayStr, in case there is no
243 : : * explicit dimension info. (If there is, ReadArrayDimensions will
244 : : * overwrite this.)
245 : : */
246 [ + + ]: 1044183 : for (int i = 0; i < MAXDIM; i++)
247 : : {
248 : 895014 : dim[i] = -1; /* indicates "not yet known" */
249 : 895014 : lBound[i] = 1; /* default lower bound */
250 : : }
251 : :
252 : : /*
253 : : * Start processing the input string.
254 : : *
255 : : * If the input string starts with dimension info, read and use that.
256 : : * Otherwise, we'll determine the dimensions during ReadArrayStr.
257 : : */
258 : 149169 : p = string;
259 [ - + ]: 149169 : if (!ReadArrayDimensions(&p, &ndim, dim, lBound, string, escontext))
260 : 0 : return (Datum) 0;
261 : :
262 [ + + ]: 149141 : if (ndim == 0)
263 : : {
264 : : /* No array dimensions, so next character should be a left brace */
265 [ + + ]: 149044 : if (*p != '{')
266 [ + + ]: 9 : ereturn(escontext, (Datum) 0,
267 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
268 : : errmsg("malformed array literal: \"%s\"", string),
269 : : errdetail("Array value must start with \"{\" or dimension information.")));
270 : : }
271 : : else
272 : : {
273 : : /* If array dimensions are given, expect '=' operator */
274 [ - + ]: 97 : if (strncmp(p, ASSGN, strlen(ASSGN)) != 0)
275 [ # # ]: 0 : ereturn(escontext, (Datum) 0,
276 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
277 : : errmsg("malformed array literal: \"%s\"", string),
278 : : errdetail("Missing \"%s\" after array dimensions.",
279 : : ASSGN)));
280 : 97 : p += strlen(ASSGN);
281 : : /* Allow whitespace after it */
282 [ - + ]: 97 : while (scanner_isspace(*p))
283 : 0 : p++;
284 : :
285 [ - + ]: 97 : if (*p != '{')
286 [ # # ]: 0 : ereturn(escontext, (Datum) 0,
287 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
288 : : errmsg("malformed array literal: \"%s\"", string),
289 : : errdetail("Array contents must start with \"{\".")));
290 : : }
291 : :
292 : : /* Parse the value part, in the curly braces: { ... } */
293 [ + + ]: 149132 : if (!ReadArrayStr(&p,
294 : : &my_extra->proc, typioparam, typmod,
295 : : typdelim,
296 : : typlen, typbyval, typalign,
297 : : &ndim,
298 : : dim,
299 : : &nitems,
300 : : &values, &nulls,
301 : : string,
302 : : escontext))
303 : 52 : return (Datum) 0;
304 : :
305 : : /* only whitespace is allowed after the closing brace */
306 [ + + ]: 148981 : while (*p)
307 : : {
308 [ + - ]: 8 : if (!scanner_isspace(*p++))
309 [ + - ]: 8 : ereturn(escontext, (Datum) 0,
310 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
311 : : errmsg("malformed array literal: \"%s\"", string),
312 : : errdetail("Junk after closing right brace.")));
313 : : }
314 : :
315 : : /* Empty array? */
316 [ + + ]: 148973 : if (nitems == 0)
317 : 2753 : PG_RETURN_ARRAYTYPE_P(construct_empty_array(element_type));
318 : :
319 : : /*
320 : : * Check for nulls, compute total data space needed
321 : : */
322 : 146220 : hasnulls = false;
323 : 146220 : nbytes = 0;
324 [ + + ]: 844893 : for (int i = 0; i < nitems; i++)
325 : : {
326 [ + + ]: 698673 : if (nulls[i])
327 : 503 : hasnulls = true;
328 : : else
329 : : {
330 : : /* let's just make sure data is not toasted */
331 [ + + ]: 698170 : if (typlen == -1)
332 : 393931 : values[i] = PointerGetDatum(PG_DETOAST_DATUM(values[i]));
333 [ + + + + ]: 698170 : nbytes = att_addlength_datum(nbytes, typlen, values[i]);
334 : 698170 : nbytes = att_nominal_alignby(nbytes, typalignby);
335 : : /* check for overflow of total request */
336 [ - + ]: 698170 : if (!AllocSizeIsValid(nbytes))
337 [ # # ]: 0 : ereturn(escontext, (Datum) 0,
338 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
339 : : errmsg("array size exceeds the maximum allowed (%zu)",
340 : : MaxAllocSize)));
341 : : }
342 : : }
343 [ + + ]: 146220 : if (hasnulls)
344 : : {
345 : 454 : dataoffset = ARR_OVERHEAD_WITHNULLS(ndim, nitems);
346 : 454 : nbytes += dataoffset;
347 : : }
348 : : else
349 : : {
350 : 145766 : dataoffset = 0; /* marker for no null bitmap */
351 : 145766 : nbytes += ARR_OVERHEAD_NONULLS(ndim);
352 : : }
353 : :
354 : : /*
355 : : * Construct the final array datum
356 : : */
357 : 146220 : retval = (ArrayType *) palloc0(nbytes);
358 : 146220 : SET_VARSIZE(retval, nbytes);
359 : 146220 : retval->ndim = ndim;
360 : 146220 : retval->dataoffset = dataoffset;
361 : :
362 : : /*
363 : : * This comes from the array's pg_type.typelem (which points to the base
364 : : * data type's pg_type.oid) and stores system oids in user tables. This
365 : : * oid must be preserved by binary upgrades.
366 : : */
367 : 146220 : retval->elemtype = element_type;
368 : 146220 : memcpy(ARR_DIMS(retval), dim, ndim * sizeof(int));
369 : 146220 : memcpy(ARR_LBOUND(retval), lBound, ndim * sizeof(int));
370 : :
371 : 146220 : CopyArrayEls(retval,
372 : : values, nulls, nitems,
373 : : typlen, typbyval, typalign,
374 : : true);
375 : :
376 : 146220 : pfree(values);
377 : 146220 : pfree(nulls);
378 : :
379 : 146220 : PG_RETURN_ARRAYTYPE_P(retval);
380 : : }
381 : :
382 : : /*
383 : : * ReadArrayDimensions
384 : : * parses the array dimensions part of the input and converts the values
385 : : * to internal format.
386 : : *
387 : : * On entry, *srcptr points to the string to parse. It is advanced to point
388 : : * after whitespace (if any) and dimension info (if any).
389 : : *
390 : : * *ndim_p, dim[], and lBound[] are output variables. They are filled with the
391 : : * number of dimensions (<= MAXDIM), the lengths of each dimension, and the
392 : : * lower subscript bounds, respectively. If no dimension info appears,
393 : : * *ndim_p will be set to zero, and dim[] and lBound[] are unchanged.
394 : : *
395 : : * 'origStr' is the original input string, used only in error messages.
396 : : * If *escontext points to an ErrorSaveContext, details of any error are
397 : : * reported there.
398 : : *
399 : : * Result:
400 : : * true for success, false for failure (if escontext is provided).
401 : : *
402 : : * Note that dim[] and lBound[] are allocated by the caller, and must have
403 : : * MAXDIM elements.
404 : : */
405 : : static bool
406 : 149169 : ReadArrayDimensions(char **srcptr, int *ndim_p, int *dim, int *lBound,
407 : : const char *origStr, Node *escontext)
408 : : {
409 : 149169 : char *p = *srcptr;
410 : : int ndim;
411 : :
412 : : /*
413 : : * Dimension info takes the form of one or more [n] or [m:n] items. This
414 : : * loop iterates once per dimension item.
415 : : */
416 : 149169 : ndim = 0;
417 : : for (;;)
418 : 134 : {
419 : : char *q;
420 : : int ub;
421 : : int i;
422 : :
423 : : /*
424 : : * Note: we currently allow whitespace between, but not within,
425 : : * dimension items.
426 : : */
427 [ + + ]: 149311 : while (scanner_isspace(*p))
428 : 8 : p++;
429 [ + + ]: 149303 : if (*p != '[')
430 : 149141 : break; /* no more dimension items */
431 : 162 : p++;
432 [ - + ]: 162 : if (ndim >= MAXDIM)
433 [ # # ]: 0 : ereturn(escontext, false,
434 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
435 : : errmsg("number of array dimensions exceeds the maximum allowed (%d)",
436 : : MAXDIM)));
437 : :
438 : 162 : q = p;
439 [ - + ]: 162 : if (!ReadDimensionInt(&p, &i, origStr, escontext))
440 : 0 : return false;
441 [ + + ]: 154 : if (p == q) /* no digits? */
442 [ + - ]: 4 : ereturn(escontext, false,
443 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
444 : : errmsg("malformed array literal: \"%s\"", origStr),
445 : : errdetail("\"[\" must introduce explicitly-specified array dimensions.")));
446 : :
447 [ + + ]: 150 : if (*p == ':')
448 : : {
449 : : /* [m:n] format */
450 : 142 : lBound[ndim] = i;
451 : 142 : p++;
452 : 142 : q = p;
453 [ - + ]: 142 : if (!ReadDimensionInt(&p, &ub, origStr, escontext))
454 : 0 : return false;
455 [ + + ]: 142 : if (p == q) /* no digits? */
456 [ + - ]: 4 : ereturn(escontext, false,
457 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
458 : : errmsg("malformed array literal: \"%s\"", origStr),
459 : : errdetail("Missing array dimension value.")));
460 : : }
461 : : else
462 : : {
463 : : /* [n] format */
464 : 8 : lBound[ndim] = 1;
465 : 8 : ub = i;
466 : : }
467 [ - + ]: 146 : if (*p != ']')
468 [ # # ]: 0 : ereturn(escontext, false,
469 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
470 : : errmsg("malformed array literal: \"%s\"", origStr),
471 : : errdetail("Missing \"%s\" after array dimensions.",
472 : : "]")));
473 : 146 : p++;
474 : :
475 : : /*
476 : : * Note: we could accept ub = lb-1 to represent a zero-length
477 : : * dimension. However, that would result in an empty array, for which
478 : : * we don't keep any dimension data, so that e.g. [1:0] and [101:100]
479 : : * would be equivalent. Given the lack of field demand, there seems
480 : : * little point in allowing such cases.
481 : : */
482 [ + + ]: 146 : if (ub < lBound[ndim])
483 [ + - ]: 8 : ereturn(escontext, false,
484 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
485 : : errmsg("upper bound cannot be less than lower bound")));
486 : :
487 : : /* Upper bound of INT_MAX must be disallowed, cf ArrayCheckBounds() */
488 [ + + ]: 138 : if (ub == INT_MAX)
489 [ + - ]: 4 : ereturn(escontext, false,
490 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
491 : : errmsg("array upper bound is too large: %d", ub)));
492 : :
493 : : /* Compute "ub - lBound[ndim] + 1", detecting overflow */
494 [ + - - + ]: 268 : if (pg_sub_s32_overflow(ub, lBound[ndim], &ub) ||
495 : 134 : pg_add_s32_overflow(ub, 1, &ub))
496 [ # # ]: 0 : ereturn(escontext, false,
497 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
498 : : errmsg("array size exceeds the maximum allowed (%zu)",
499 : : MaxArraySize)));
500 : :
501 : 134 : dim[ndim] = ub;
502 : 134 : ndim++;
503 : : }
504 : :
505 : 149141 : *srcptr = p;
506 : 149141 : *ndim_p = ndim;
507 : 149141 : return true;
508 : : }
509 : :
510 : : /*
511 : : * ReadDimensionInt
512 : : * parse an integer, for the array dimensions
513 : : *
514 : : * On entry, *srcptr points to the string to parse. It is advanced past the
515 : : * digits of the integer. If there are no digits, returns true and leaves
516 : : * *srcptr unchanged.
517 : : *
518 : : * Result:
519 : : * true for success, false for failure (if escontext is provided).
520 : : * On success, the parsed integer is returned in *result.
521 : : */
522 : : static bool
523 : 304 : ReadDimensionInt(char **srcptr, int *result,
524 : : const char *origStr, Node *escontext)
525 : : {
526 : 304 : char *p = *srcptr;
527 : : long l;
528 : :
529 : : /* don't accept leading whitespace */
530 [ + + + + : 304 : if (!isdigit((unsigned char) *p) && *p != '-' && *p != '+')
+ - ]
531 : : {
532 : 8 : *result = 0;
533 : 8 : return true;
534 : : }
535 : :
536 : 296 : errno = 0;
537 : 296 : l = strtol(p, srcptr, 10);
538 : :
539 [ + - + + : 296 : if (errno == ERANGE || l > PG_INT32_MAX || l < PG_INT32_MIN)
+ + ]
540 [ + - ]: 8 : ereturn(escontext, false,
541 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
542 : : errmsg("array bound is out of integer range")));
543 : :
544 : 288 : *result = (int) l;
545 : 288 : return true;
546 : : }
547 : :
548 : : /*
549 : : * ReadArrayStr :
550 : : * parses the array string pointed to by *srcptr and converts the values
551 : : * to internal format. Determines the array dimensions as it goes.
552 : : *
553 : : * On entry, *srcptr points to the string to parse (it must point to a '{').
554 : : * On successful return, it is advanced to point past the closing '}'.
555 : : *
556 : : * If dimensions were specified explicitly, they are passed in *ndim_p and
557 : : * dim[]. This function will check that the array values match the specified
558 : : * dimensions. If dimensions were not given, caller must pass *ndim_p == 0
559 : : * and initialize all elements of dim[] to -1. Then this function will
560 : : * deduce the dimensions from the structure of the input and store them in
561 : : * *ndim_p and the dim[] array.
562 : : *
563 : : * Element type information:
564 : : * inputproc: type-specific input procedure for element datatype.
565 : : * typioparam, typmod: auxiliary values to pass to inputproc.
566 : : * typdelim: the value delimiter (type-specific).
567 : : * typlen, typbyval, typalign: storage parameters of element datatype.
568 : : *
569 : : * Outputs:
570 : : * *ndim_p, dim: dimensions deduced from the input structure.
571 : : * *nitems_p: total number of elements.
572 : : * *values_p[]: palloc'd array, filled with converted data values.
573 : : * *nulls_p[]: palloc'd array, filled with is-null markers.
574 : : *
575 : : * 'origStr' is the original input string, used only in error messages.
576 : : * If *escontext points to an ErrorSaveContext, details of any error are
577 : : * reported there.
578 : : *
579 : : * Result:
580 : : * true for success, false for failure (if escontext is provided).
581 : : */
582 : : static bool
583 : 149132 : ReadArrayStr(char **srcptr,
584 : : FmgrInfo *inputproc,
585 : : Oid typioparam,
586 : : int32 typmod,
587 : : char typdelim,
588 : : int typlen,
589 : : bool typbyval,
590 : : char typalign,
591 : : int *ndim_p,
592 : : int *dim,
593 : : int *nitems_p,
594 : : Datum **values_p,
595 : : bool **nulls_p,
596 : : const char *origStr,
597 : : Node *escontext)
598 : : {
599 : 149132 : int ndim = *ndim_p;
600 : 149132 : bool dimensions_specified = (ndim != 0);
601 : : int maxitems;
602 : : Datum *values;
603 : : bool *nulls;
604 : : StringInfoData elembuf;
605 : : int nest_level;
606 : : int nitems;
607 : : bool ndim_frozen;
608 : : bool expect_delim;
609 : : int nelems[MAXDIM];
610 : :
611 : : /* Allocate some starting output workspace; we'll enlarge as needed */
612 : 149132 : maxitems = 16;
613 : 149132 : values = palloc_array(Datum, maxitems);
614 : 149132 : nulls = palloc_array(bool, maxitems);
615 : :
616 : : /* Allocate workspace to hold (string representation of) one element */
617 : 149132 : initStringInfo(&elembuf);
618 : :
619 : : /* Loop below assumes first token is ATOK_LEVEL_START */
620 : : Assert(**srcptr == '{');
621 : :
622 : : /* Parse tokens until we reach the matching right brace */
623 : 149132 : nest_level = 0;
624 : 149132 : nitems = 0;
625 : 149132 : ndim_frozen = dimensions_specified;
626 : 149132 : expect_delim = false;
627 : : do
628 : : {
629 : : ArrayToken tok;
630 : :
631 : 1551876 : tok = ReadArrayToken(srcptr, &elembuf, typdelim, origStr, escontext);
632 : :
633 [ + + + + : 1551856 : switch (tok)
+ - ]
634 : : {
635 : 150327 : case ATOK_LEVEL_START:
636 : : /* Can't write left brace where delim is expected */
637 [ + + ]: 150327 : if (expect_delim)
638 [ + - ]: 4 : ereturn(escontext, false,
639 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
640 : : errmsg("malformed array literal: \"%s\"", origStr),
641 : : errdetail("Unexpected \"%c\" character.", '{')));
642 : :
643 : : /* Initialize element counting in the new level */
644 [ + + ]: 150323 : if (nest_level >= MAXDIM)
645 [ + - ]: 1 : ereturn(escontext, false,
646 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
647 : : errmsg("number of array dimensions exceeds the maximum allowed (%d)",
648 : : MAXDIM)));
649 : :
650 : 150322 : nelems[nest_level] = 0;
651 : 150322 : nest_level++;
652 [ + + ]: 150322 : if (nest_level > ndim)
653 : : {
654 : : /* Can't increase ndim once it's frozen */
655 [ + + ]: 149434 : if (ndim_frozen)
656 : 8 : goto dimension_error;
657 : 149426 : ndim = nest_level;
658 : : }
659 : 150314 : break;
660 : :
661 : 150149 : case ATOK_LEVEL_END:
662 : : /* Can't get here with nest_level == 0 */
663 : : Assert(nest_level > 0);
664 : :
665 : : /*
666 : : * We allow a right brace to terminate an empty sub-array,
667 : : * otherwise it must occur where we expect a delimiter.
668 : : */
669 [ + + + + ]: 150149 : if (nelems[nest_level - 1] > 0 && !expect_delim)
670 [ + - ]: 16 : ereturn(escontext, false,
671 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
672 : : errmsg("malformed array literal: \"%s\"", origStr),
673 : : errdetail("Unexpected \"%c\" character.",
674 : : '}')));
675 : 150133 : nest_level--;
676 : : /* Nested sub-arrays count as elements of outer level */
677 [ + + ]: 150133 : if (nest_level > 0)
678 : 1148 : nelems[nest_level - 1]++;
679 : :
680 : : /*
681 : : * Note: if we had dimensionality info, then dim[nest_level]
682 : : * is initially non-negative, and we'll check each sub-array's
683 : : * length against that.
684 : : */
685 [ + + ]: 150133 : if (dim[nest_level] < 0)
686 : : {
687 : : /* Save length of first sub-array of this level */
688 : 149253 : dim[nest_level] = nelems[nest_level];
689 : : }
690 [ + + ]: 880 : else if (nelems[nest_level] != dim[nest_level])
691 : : {
692 : : /* Subsequent sub-arrays must have same length */
693 : 21 : goto dimension_error;
694 : : }
695 : :
696 : : /*
697 : : * Must have a delim or another right brace following, unless
698 : : * we have reached nest_level 0, where this won't matter.
699 : : */
700 : 150112 : expect_delim = true;
701 : 150112 : break;
702 : :
703 : 552543 : case ATOK_DELIM:
704 [ + + ]: 552543 : if (!expect_delim)
705 [ + - ]: 4 : ereturn(escontext, false,
706 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
707 : : errmsg("malformed array literal: \"%s\"", origStr),
708 : : errdetail("Unexpected \"%c\" character.",
709 : : typdelim)));
710 : 552539 : expect_delim = false;
711 : 552539 : break;
712 : :
713 : 698833 : case ATOK_ELEM:
714 : : case ATOK_ELEM_NULL:
715 : : /* Can't get here with nest_level == 0 */
716 : : Assert(nest_level > 0);
717 : :
718 : : /* Disallow consecutive ELEM tokens */
719 [ + + ]: 698833 : if (expect_delim)
720 [ + - ]: 4 : ereturn(escontext, false,
721 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
722 : : errmsg("malformed array literal: \"%s\"", origStr),
723 : : errdetail("Unexpected array element.")));
724 : :
725 : : /* Enlarge the values/nulls arrays if needed */
726 [ + + ]: 698829 : if (nitems >= maxitems)
727 : : {
728 [ - + ]: 3078 : if (maxitems >= MaxArraySize)
729 [ # # ]: 0 : ereturn(escontext, false,
730 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
731 : : errmsg("array size exceeds the maximum allowed (%zu)",
732 : : MaxArraySize)));
733 [ + - ]: 3078 : maxitems = Min(maxitems * 2, MaxArraySize);
734 : 3078 : values = repalloc_array(values, Datum, maxitems);
735 : 3078 : nulls = repalloc_array(nulls, bool, maxitems);
736 : : }
737 : :
738 : : /* Read the element's value, or check that NULL is allowed */
739 [ + + ]: 698829 : if (!InputFunctionCallSafe(inputproc,
740 : : (tok == ATOK_ELEM_NULL) ? NULL : elembuf.data,
741 : : typioparam, typmod,
742 : : escontext,
743 [ + + ]: 698829 : &values[nitems]))
744 : 48 : return false;
745 : 698768 : nulls[nitems] = (tok == ATOK_ELEM_NULL);
746 : 698768 : nitems++;
747 : :
748 : : /*
749 : : * Once we have found an element, the number of dimensions can
750 : : * no longer increase, and subsequent elements must all be at
751 : : * the same nesting depth.
752 : : */
753 : 698768 : ndim_frozen = true;
754 [ + + ]: 698768 : if (nest_level != ndim)
755 : 8 : goto dimension_error;
756 : : /* Count the new element */
757 : 698760 : nelems[nest_level - 1]++;
758 : :
759 : : /* Must have a delim or a right brace following */
760 : 698760 : expect_delim = true;
761 : 698760 : break;
762 : :
763 : 4 : case ATOK_ERROR:
764 : 4 : return false;
765 : : }
766 [ + + ]: 1551725 : } while (nest_level > 0);
767 : :
768 : : /* Clean up and return results */
769 : 148981 : pfree(elembuf.data);
770 : :
771 : 148981 : *ndim_p = ndim;
772 : 148981 : *nitems_p = nitems;
773 : 148981 : *values_p = values;
774 : 148981 : *nulls_p = nulls;
775 : 148981 : return true;
776 : :
777 : 37 : dimension_error:
778 [ + + ]: 37 : if (dimensions_specified)
779 [ + - ]: 4 : ereturn(escontext, false,
780 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
781 : : errmsg("malformed array literal: \"%s\"", origStr),
782 : : errdetail("Specified array dimensions do not match array contents.")));
783 : : else
784 [ + - ]: 33 : ereturn(escontext, false,
785 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
786 : : errmsg("malformed array literal: \"%s\"", origStr),
787 : : errdetail("Multidimensional arrays must have sub-arrays with matching dimensions.")));
788 : : }
789 : :
790 : : /*
791 : : * ReadArrayToken
792 : : * read one token from an array value string
793 : : *
794 : : * Starts scanning from *srcptr. On non-error return, *srcptr is
795 : : * advanced past the token.
796 : : *
797 : : * If the token is ATOK_ELEM, the de-escaped string is returned in elembuf.
798 : : */
799 : : static ArrayToken
800 : 1551876 : ReadArrayToken(char **srcptr, StringInfo elembuf, char typdelim,
801 : : const char *origStr, Node *escontext)
802 : : {
803 : 1551876 : char *p = *srcptr;
804 : : int dstlen;
805 : : bool has_escapes;
806 : :
807 : 1551876 : resetStringInfo(elembuf);
808 : :
809 : : /* Identify token type. Loop advances over leading whitespace. */
810 : : for (;;)
811 : : {
812 [ - + + + : 1568537 : switch (*p)
+ ]
813 : : {
814 : 0 : case '\0':
815 : 0 : goto ending_error;
816 : 150327 : case '{':
817 : 150327 : *srcptr = p + 1;
818 : 150327 : return ATOK_LEVEL_START;
819 : 150149 : case '}':
820 : 150149 : *srcptr = p + 1;
821 : 150149 : return ATOK_LEVEL_END;
822 : 305077 : case '"':
823 : 305077 : p++;
824 : 305077 : goto quoted_element;
825 : 962984 : default:
826 [ + + ]: 962984 : if (*p == typdelim)
827 : : {
828 : 552543 : *srcptr = p + 1;
829 : 552543 : return ATOK_DELIM;
830 : : }
831 [ + + ]: 410441 : if (scanner_isspace(*p))
832 : : {
833 : 16661 : p++;
834 : 16661 : continue;
835 : : }
836 : 393780 : goto unquoted_element;
837 : : }
838 : : }
839 : :
840 : 305077 : quoted_element:
841 : : for (;;)
842 : : {
843 [ - + + + ]: 2263288 : switch (*p)
844 : : {
845 : 0 : case '\0':
846 : 0 : goto ending_error;
847 : 624 : case '\\':
848 : : /* Skip backslash, copy next character as-is. */
849 : 624 : p++;
850 [ - + ]: 624 : if (*p == '\0')
851 : 0 : goto ending_error;
852 : 624 : appendStringInfoChar(elembuf, *p++);
853 : 624 : break;
854 : 305077 : case '"':
855 : :
856 : : /*
857 : : * If next non-whitespace isn't typdelim or a brace, complain
858 : : * about incorrect quoting. While we could leave such cases
859 : : * to be detected as incorrect token sequences, the resulting
860 : : * message wouldn't be as helpful. (We could also give the
861 : : * incorrect-quoting error when next is '{', but treating that
862 : : * as a token sequence error seems better.)
863 : : */
864 [ + - ]: 305101 : while (*(++p) != '\0')
865 : : {
866 [ + + + + : 305101 : if (*p == typdelim || *p == '}' || *p == '{')
+ + ]
867 : : {
868 : 305065 : *srcptr = p;
869 : 305065 : return ATOK_ELEM;
870 : : }
871 [ + + ]: 36 : if (!scanner_isspace(*p))
872 [ + - ]: 12 : ereturn(escontext, ATOK_ERROR,
873 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
874 : : errmsg("malformed array literal: \"%s\"", origStr),
875 : : errdetail("Incorrectly quoted array element.")));
876 : : }
877 : 0 : goto ending_error;
878 : 1957587 : default:
879 : 1957587 : appendStringInfoChar(elembuf, *p++);
880 : 1957587 : break;
881 : : }
882 : : }
883 : :
884 : 393780 : unquoted_element:
885 : :
886 : : /*
887 : : * We don't include trailing whitespace in the result. dstlen tracks how
888 : : * much of the output string is known to not be trailing whitespace.
889 : : */
890 : 393780 : dstlen = 0;
891 : 393780 : has_escapes = false;
892 : : for (;;)
893 : : {
894 [ + + + + : 2164943 : switch (*p)
+ ]
895 : : {
896 : 4 : case '\0':
897 : 4 : goto ending_error;
898 : 4 : case '{':
899 [ + - ]: 4 : ereturn(escontext, ATOK_ERROR,
900 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
901 : : errmsg("malformed array literal: \"%s\"", origStr),
902 : : errdetail("Unexpected \"%c\" character.",
903 : : '{')));
904 : 4 : case '"':
905 : : /* Must double-quote all or none of an element. */
906 [ + - ]: 4 : ereturn(escontext, ATOK_ERROR,
907 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
908 : : errmsg("malformed array literal: \"%s\"", origStr),
909 : : errdetail("Incorrectly quoted array element.")));
910 : 12 : case '\\':
911 : : /* Skip backslash, copy next character as-is. */
912 : 12 : p++;
913 [ - + ]: 12 : if (*p == '\0')
914 : 0 : goto ending_error;
915 : 12 : appendStringInfoChar(elembuf, *p++);
916 : 12 : dstlen = elembuf->len; /* treat it as non-whitespace */
917 : 12 : has_escapes = true;
918 : 12 : break;
919 : 2164919 : default:
920 : : /* End of elem? */
921 [ + + + + ]: 2164919 : if (*p == typdelim || *p == '}')
922 : : {
923 : : /* hack: truncate the output string to dstlen */
924 : 393768 : elembuf->data[dstlen] = '\0';
925 : 393768 : elembuf->len = dstlen;
926 : 393768 : *srcptr = p;
927 : : /* Check if it's unquoted "NULL" */
928 [ + - + + : 787524 : if (Array_nulls && !has_escapes &&
+ + ]
929 : 393756 : pg_strcasecmp(elembuf->data, "NULL") == 0)
930 : 503 : return ATOK_ELEM_NULL;
931 : : else
932 : 393265 : return ATOK_ELEM;
933 : : }
934 : 1771151 : appendStringInfoChar(elembuf, *p);
935 [ + + ]: 1771151 : if (!scanner_isspace(*p))
936 : 1770567 : dstlen = elembuf->len;
937 : 1771151 : p++;
938 : 1771151 : break;
939 : : }
940 : : }
941 : :
942 : 4 : ending_error:
943 [ - + ]: 4 : ereturn(escontext, ATOK_ERROR,
944 : : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
945 : : errmsg("malformed array literal: \"%s\"", origStr),
946 : : errdetail("Unexpected end of input.")));
947 : : }
948 : :
949 : : /*
950 : : * Copy data into an array object from a temporary array of Datums.
951 : : *
952 : : * array: array object (with header fields already filled in)
953 : : * values: array of Datums to be copied
954 : : * nulls: array of is-null flags (can be NULL if no nulls)
955 : : * nitems: number of Datums to be copied
956 : : * typbyval, typlen, typalign: info about element datatype
957 : : * freedata: if true and element type is pass-by-ref, pfree data values
958 : : * referenced by Datums after copying them.
959 : : *
960 : : * If the input data is of varlena type, the caller must have ensured that
961 : : * the values are not toasted. (Doing it here doesn't work since the
962 : : * caller has already allocated space for the array...)
963 : : */
964 : : void
965 : 1162544 : CopyArrayEls(ArrayType *array,
966 : : const Datum *values,
967 : : const bool *nulls,
968 : : int nitems,
969 : : int typlen,
970 : : bool typbyval,
971 : : char typalign,
972 : : bool freedata)
973 : : {
974 [ + + ]: 1162544 : char *p = ARR_DATA_PTR(array);
975 [ + + ]: 1162544 : uint8 *bitmap = ARR_NULLBITMAP(array);
976 : 1162544 : int bitval = 0;
977 : 1162544 : int bitmask = 1;
978 : 1162544 : uint8 typalignby = typalign_to_alignby(typalign);
979 : : int i;
980 : :
981 [ + + ]: 1162544 : if (typbyval)
982 : 778965 : freedata = false;
983 : :
984 [ + + ]: 8632636 : for (i = 0; i < nitems; i++)
985 : : {
986 [ + + + + ]: 7470092 : if (nulls && nulls[i])
987 : : {
988 [ - + ]: 22699 : if (!bitmap) /* shouldn't happen */
989 [ # # ]: 0 : elog(ERROR, "null array element where not supported");
990 : : /* bitmap bit stays 0 */
991 : : }
992 : : else
993 : : {
994 : 7447393 : bitval |= bitmask;
995 : 7447393 : p += ArrayCastAndSet(values[i], typlen, typbyval, typalignby, p);
996 [ + + ]: 7447393 : if (freedata)
997 : 404349 : pfree(DatumGetPointer(values[i]));
998 : : }
999 [ + + ]: 7470092 : if (bitmap)
1000 : : {
1001 : 525274 : bitmask <<= 1;
1002 [ + + ]: 525274 : if (bitmask == 0x100)
1003 : : {
1004 : 63477 : *bitmap++ = bitval;
1005 : 63477 : bitval = 0;
1006 : 63477 : bitmask = 1;
1007 : : }
1008 : : }
1009 : : }
1010 : :
1011 [ + + + + ]: 1162544 : if (bitmap && bitmask != 1)
1012 : 12316 : *bitmap = bitval;
1013 : 1162544 : }
1014 : :
1015 : : /*
1016 : : * array_out :
1017 : : * takes the internal representation of an array and returns a string
1018 : : * containing the array in its external format.
1019 : : */
1020 : : Datum
1021 : 431519 : array_out(PG_FUNCTION_ARGS)
1022 : : {
1023 : 431519 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1024 [ + + ]: 431519 : Oid element_type = AARR_ELEMTYPE(v);
1025 : : int typlen;
1026 : : bool typbyval;
1027 : : char typalign;
1028 : : char typdelim;
1029 : : char *p,
1030 : : *tmp,
1031 : : *retval,
1032 : : **values,
1033 : : dims_str[(MAXDIM * 33) + 2];
1034 : :
1035 : : /*
1036 : : * 33 per dim since we assume 15 digits per number + ':' +'[]'
1037 : : *
1038 : : * +2 allows for assignment operator + trailing null
1039 : : */
1040 : : bool *needquotes,
1041 : 431519 : needdims = false;
1042 : : size_t overall_length;
1043 : : int nitems,
1044 : : i,
1045 : : j,
1046 : : k,
1047 : : indx[MAXDIM];
1048 : : int ndim,
1049 : : *dims,
1050 : : *lb;
1051 : : array_iter iter;
1052 : : ArrayMetaState *my_extra;
1053 : :
1054 : : /*
1055 : : * We arrange to look up info about element type, including its output
1056 : : * conversion proc, only once per series of calls, assuming the element
1057 : : * type doesn't change underneath us.
1058 : : */
1059 : 431519 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
1060 [ + + ]: 431519 : if (my_extra == NULL)
1061 : : {
1062 : 16405 : fcinfo->flinfo->fn_extra = MemoryContextAlloc(fcinfo->flinfo->fn_mcxt,
1063 : : sizeof(ArrayMetaState));
1064 : 16405 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
1065 : 16405 : my_extra->element_type = ~element_type;
1066 : : }
1067 : :
1068 [ + + ]: 431519 : if (my_extra->element_type != element_type)
1069 : : {
1070 : : /*
1071 : : * Get info about element type, including its output conversion proc
1072 : : */
1073 : 18665 : get_type_io_data(element_type, IOFunc_output,
1074 : : &my_extra->typlen, &my_extra->typbyval,
1075 : : &my_extra->typalign, &my_extra->typdelim,
1076 : : &my_extra->typioparam, &my_extra->typiofunc);
1077 : 18665 : fmgr_info_cxt(my_extra->typiofunc, &my_extra->proc,
1078 : 18665 : fcinfo->flinfo->fn_mcxt);
1079 : 18665 : my_extra->element_type = element_type;
1080 : : }
1081 : 431519 : typlen = my_extra->typlen;
1082 : 431519 : typbyval = my_extra->typbyval;
1083 : 431519 : typalign = my_extra->typalign;
1084 : 431519 : typdelim = my_extra->typdelim;
1085 : :
1086 [ + + ]: 431519 : ndim = AARR_NDIM(v);
1087 [ + + ]: 431519 : dims = AARR_DIMS(v);
1088 [ + + ]: 431519 : lb = AARR_LBOUND(v);
1089 : 431519 : nitems = ArrayGetNItems(ndim, dims);
1090 : :
1091 [ + + ]: 431519 : if (nitems == 0)
1092 : : {
1093 : 2172 : retval = pstrdup("{}");
1094 : 2172 : PG_RETURN_CSTRING(retval);
1095 : : }
1096 : :
1097 : : /*
1098 : : * we will need to add explicit dimensions if any dimension has a lower
1099 : : * bound other than one
1100 : : */
1101 [ + + ]: 859166 : for (i = 0; i < ndim; i++)
1102 : : {
1103 [ + + ]: 430021 : if (lb[i] != 1)
1104 : : {
1105 : 202 : needdims = true;
1106 : 202 : break;
1107 : : }
1108 : : }
1109 : :
1110 : : /*
1111 : : * Convert all values to string form, count total space needed (including
1112 : : * any overhead such as escaping backslashes), and detect whether each
1113 : : * item needs double quotes.
1114 : : */
1115 : 429347 : values = (char **) palloc(nitems * sizeof(char *));
1116 : 429347 : needquotes = (bool *) palloc(nitems * sizeof(bool));
1117 : 429347 : overall_length = 0;
1118 : :
1119 : 429347 : array_iter_setup(&iter, v, typlen, typbyval, typalign);
1120 : :
1121 [ + + ]: 1674125 : for (i = 0; i < nitems; i++)
1122 : : {
1123 : : Datum itemvalue;
1124 : : bool isnull;
1125 : : bool needquote;
1126 : :
1127 : : /* Get source element, checking for NULL */
1128 : 1244778 : itemvalue = array_iter_next(&iter, &isnull, i);
1129 : :
1130 [ + + ]: 1244778 : if (isnull)
1131 : : {
1132 : 1544 : values[i] = pstrdup("NULL");
1133 : 1544 : overall_length += 4;
1134 : 1544 : needquote = false;
1135 : : }
1136 : : else
1137 : : {
1138 : 1243234 : values[i] = OutputFunctionCall(&my_extra->proc, itemvalue);
1139 : :
1140 : : /* count data plus backslashes; detect chars needing quotes */
1141 [ + + ]: 1243234 : if (values[i][0] == '\0')
1142 : 317 : needquote = true; /* force quotes for empty string */
1143 [ + + ]: 1242917 : else if (pg_strcasecmp(values[i], "NULL") == 0)
1144 : 12 : needquote = true; /* force quotes for literal NULL */
1145 : : else
1146 : 1242905 : needquote = false;
1147 : :
1148 [ + + ]: 17426652 : for (tmp = values[i]; *tmp != '\0'; tmp++)
1149 : : {
1150 : 16183418 : char ch = *tmp;
1151 : :
1152 : 16183418 : overall_length += 1;
1153 [ + + + + ]: 16183418 : if (ch == '"' || ch == '\\')
1154 : : {
1155 : 2364 : needquote = true;
1156 : 2364 : overall_length += 1;
1157 : : }
1158 [ + + + + : 32332589 : else if (ch == '{' || ch == '}' || ch == typdelim ||
+ + + + ]
1159 : 16151535 : scanner_isspace(ch))
1160 : 120077 : needquote = true;
1161 : : }
1162 : : }
1163 : :
1164 : 1244778 : needquotes[i] = needquote;
1165 : :
1166 : : /* Count the pair of double quotes, if needed */
1167 [ + + ]: 1244778 : if (needquote)
1168 : 15103 : overall_length += 2;
1169 : : /* and the comma (or other typdelim delimiter) */
1170 : 1244778 : overall_length += 1;
1171 : : }
1172 : :
1173 : : /*
1174 : : * The very last array element doesn't have a typdelim delimiter after it,
1175 : : * but that's OK; that space is needed for the trailing '\0'.
1176 : : *
1177 : : * Now count total number of curly brace pairs in output string.
1178 : : */
1179 [ + + ]: 859412 : for (i = j = 0, k = 1; i < ndim; i++)
1180 : : {
1181 : 430065 : j += k, k *= dims[i];
1182 : : }
1183 : 429347 : overall_length += 2 * j;
1184 : :
1185 : : /* Format explicit dimensions if required */
1186 : 429347 : dims_str[0] = '\0';
1187 [ + + ]: 429347 : if (needdims)
1188 : : {
1189 : 202 : char *ptr = dims_str;
1190 : :
1191 [ + + ]: 449 : for (i = 0; i < ndim; i++)
1192 : : {
1193 : 247 : sprintf(ptr, "[%d:%d]", lb[i], lb[i] + dims[i] - 1);
1194 : 247 : ptr += strlen(ptr);
1195 : : }
1196 : 202 : *ptr++ = *ASSGN;
1197 : 202 : *ptr = '\0';
1198 : 202 : overall_length += ptr - dims_str;
1199 : : }
1200 : :
1201 : : /* Now construct the output string */
1202 : 429347 : retval = (char *) palloc(overall_length);
1203 : 429347 : p = retval;
1204 : :
1205 : : #define APPENDSTR(str) (strcpy(p, (str)), p += strlen(p))
1206 : : #define APPENDCHAR(ch) (*p++ = (ch), *p = '\0')
1207 : :
1208 [ + + ]: 429347 : if (needdims)
1209 : 202 : APPENDSTR(dims_str);
1210 : 429347 : APPENDCHAR('{');
1211 [ + + ]: 859412 : for (i = 0; i < ndim; i++)
1212 : 430065 : indx[i] = 0;
1213 : 429347 : j = 0;
1214 : 429347 : k = 0;
1215 : : do
1216 : : {
1217 [ + + ]: 1250009 : for (i = j; i < ndim - 1; i++)
1218 : 5231 : APPENDCHAR('{');
1219 : :
1220 [ + + ]: 1244778 : if (needquotes[k])
1221 : : {
1222 : 15103 : APPENDCHAR('"');
1223 [ + + ]: 647877 : for (tmp = values[k]; *tmp; tmp++)
1224 : : {
1225 : 632774 : char ch = *tmp;
1226 : :
1227 [ + + + + ]: 632774 : if (ch == '"' || ch == '\\')
1228 : 2364 : *p++ = '\\';
1229 : 632774 : *p++ = ch;
1230 : : }
1231 : 15103 : *p = '\0';
1232 : 15103 : APPENDCHAR('"');
1233 : : }
1234 : : else
1235 : 1229675 : APPENDSTR(values[k]);
1236 : 1244778 : pfree(values[k++]);
1237 : :
1238 [ + + ]: 1679356 : for (i = ndim - 1; i >= 0; i--)
1239 : : {
1240 [ + + ]: 1250009 : if (++(indx[i]) < dims[i])
1241 : : {
1242 : 815431 : APPENDCHAR(typdelim);
1243 : 815431 : break;
1244 : : }
1245 : : else
1246 : : {
1247 : 434578 : indx[i] = 0;
1248 : 434578 : APPENDCHAR('}');
1249 : : }
1250 : : }
1251 : 1244778 : j = i;
1252 [ + + ]: 1244778 : } while (j != -1);
1253 : :
1254 : : #undef APPENDSTR
1255 : : #undef APPENDCHAR
1256 : :
1257 : : /* Assert that we calculated the string length accurately */
1258 : : Assert(overall_length == (p - retval + 1));
1259 : :
1260 : 429347 : pfree(values);
1261 : 429347 : pfree(needquotes);
1262 : :
1263 : 429347 : PG_RETURN_CSTRING(retval);
1264 : : }
1265 : :
1266 : : /*
1267 : : * array_recv :
1268 : : * converts an array from the external binary format to
1269 : : * its internal format.
1270 : : *
1271 : : * return value :
1272 : : * the internal representation of the input array
1273 : : */
1274 : : Datum
1275 : 31 : array_recv(PG_FUNCTION_ARGS)
1276 : : {
1277 : 31 : StringInfo buf = (StringInfo) PG_GETARG_POINTER(0);
1278 : 31 : Oid spec_element_type = PG_GETARG_OID(1); /* type of an array
1279 : : * element */
1280 : 31 : int32 typmod = PG_GETARG_INT32(2); /* typmod for array elements */
1281 : : Oid element_type;
1282 : : int typlen;
1283 : : bool typbyval;
1284 : : char typalign;
1285 : : Oid typioparam;
1286 : : int i,
1287 : : nitems;
1288 : : Datum *dataPtr;
1289 : : bool *nullsPtr;
1290 : : bool hasnulls;
1291 : : int32 nbytes;
1292 : : int32 dataoffset;
1293 : : ArrayType *retval;
1294 : : int ndim,
1295 : : flags,
1296 : : dim[MAXDIM],
1297 : : lBound[MAXDIM];
1298 : : ArrayMetaState *my_extra;
1299 : :
1300 : : /* Get the array header information */
1301 : 31 : ndim = pq_getmsgint(buf, 4);
1302 [ - + ]: 31 : if (ndim < 0) /* we do allow zero-dimension arrays */
1303 [ # # ]: 0 : ereport(ERROR,
1304 : : (errcode(ERRCODE_INVALID_BINARY_REPRESENTATION),
1305 : : errmsg("invalid number of dimensions: %d", ndim)));
1306 [ - + ]: 31 : if (ndim > MAXDIM)
1307 [ # # ]: 0 : ereport(ERROR,
1308 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
1309 : : errmsg("number of array dimensions (%d) exceeds the maximum allowed (%d)",
1310 : : ndim, MAXDIM)));
1311 : :
1312 : 31 : flags = pq_getmsgint(buf, 4);
1313 [ - + - - ]: 31 : if (flags != 0 && flags != 1)
1314 [ # # ]: 0 : ereport(ERROR,
1315 : : (errcode(ERRCODE_INVALID_BINARY_REPRESENTATION),
1316 : : errmsg("invalid array flags")));
1317 : :
1318 : : /* Check element type recorded in the data */
1319 : 31 : element_type = pq_getmsgint(buf, sizeof(Oid));
1320 : :
1321 : : /*
1322 : : * From a security standpoint, it doesn't matter whether the input's
1323 : : * element type matches what we expect: the element type's receive
1324 : : * function has to be robust enough to cope with invalid data. However,
1325 : : * from a user-friendliness standpoint, it's nicer to complain about type
1326 : : * mismatches than to throw "improper binary format" errors. But there's
1327 : : * a problem: only built-in types have OIDs that are stable enough to
1328 : : * believe that a mismatch is a real issue. So complain only if both OIDs
1329 : : * are in the built-in range. Otherwise, carry on with the element type
1330 : : * we "should" be getting.
1331 : : */
1332 [ - + ]: 31 : if (element_type != spec_element_type)
1333 : : {
1334 [ # # # # ]: 0 : if (element_type < FirstGenbkiObjectId &&
1335 : : spec_element_type < FirstGenbkiObjectId)
1336 [ # # ]: 0 : ereport(ERROR,
1337 : : (errcode(ERRCODE_DATATYPE_MISMATCH),
1338 : : errmsg("binary data has array element type %u (%s) instead of expected %u (%s)",
1339 : : element_type,
1340 : : format_type_extended(element_type, -1,
1341 : : FORMAT_TYPE_ALLOW_INVALID),
1342 : : spec_element_type,
1343 : : format_type_extended(spec_element_type, -1,
1344 : : FORMAT_TYPE_ALLOW_INVALID))));
1345 : 0 : element_type = spec_element_type;
1346 : : }
1347 : :
1348 [ + + ]: 62 : for (i = 0; i < ndim; i++)
1349 : : {
1350 : 31 : dim[i] = pq_getmsgint(buf, 4);
1351 : 31 : lBound[i] = pq_getmsgint(buf, 4);
1352 : : }
1353 : :
1354 : : /* This checks for overflow of array dimensions */
1355 : 31 : nitems = ArrayGetNItems(ndim, dim);
1356 : 31 : ArrayCheckBounds(ndim, dim, lBound);
1357 : :
1358 : : /*
1359 : : * We arrange to look up info about element type, including its receive
1360 : : * conversion proc, only once per series of calls, assuming the element
1361 : : * type doesn't change underneath us.
1362 : : */
1363 : 31 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
1364 [ + + ]: 31 : if (my_extra == NULL)
1365 : : {
1366 : 28 : fcinfo->flinfo->fn_extra = MemoryContextAlloc(fcinfo->flinfo->fn_mcxt,
1367 : : sizeof(ArrayMetaState));
1368 : 28 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
1369 : 28 : my_extra->element_type = ~element_type;
1370 : : }
1371 : :
1372 [ + + ]: 31 : if (my_extra->element_type != element_type)
1373 : : {
1374 : : /* Get info about element type, including its receive proc */
1375 : 28 : get_type_io_data(element_type, IOFunc_receive,
1376 : : &my_extra->typlen, &my_extra->typbyval,
1377 : : &my_extra->typalign, &my_extra->typdelim,
1378 : : &my_extra->typioparam, &my_extra->typiofunc);
1379 [ - + ]: 28 : if (!OidIsValid(my_extra->typiofunc))
1380 [ # # ]: 0 : ereport(ERROR,
1381 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
1382 : : errmsg("no binary input function available for type %s",
1383 : : format_type_be(element_type))));
1384 : 28 : fmgr_info_cxt(my_extra->typiofunc, &my_extra->proc,
1385 : 28 : fcinfo->flinfo->fn_mcxt);
1386 : 28 : my_extra->element_type = element_type;
1387 : : }
1388 : :
1389 [ - + ]: 31 : if (nitems == 0)
1390 : : {
1391 : : /* Return empty array ... but not till we've validated element_type */
1392 : 0 : PG_RETURN_ARRAYTYPE_P(construct_empty_array(element_type));
1393 : : }
1394 : :
1395 : 31 : typlen = my_extra->typlen;
1396 : 31 : typbyval = my_extra->typbyval;
1397 : 31 : typalign = my_extra->typalign;
1398 : 31 : typioparam = my_extra->typioparam;
1399 : :
1400 : 31 : dataPtr = (Datum *) palloc(nitems * sizeof(Datum));
1401 : 31 : nullsPtr = (bool *) palloc(nitems * sizeof(bool));
1402 : 31 : ReadArrayBinary(buf, nitems,
1403 : : &my_extra->proc, typioparam, typmod,
1404 : : typlen, typbyval, typalign,
1405 : : dataPtr, nullsPtr,
1406 : : &hasnulls, &nbytes);
1407 [ - + ]: 31 : if (hasnulls)
1408 : : {
1409 : 0 : dataoffset = ARR_OVERHEAD_WITHNULLS(ndim, nitems);
1410 : 0 : nbytes += dataoffset;
1411 : : }
1412 : : else
1413 : : {
1414 : 31 : dataoffset = 0; /* marker for no null bitmap */
1415 : 31 : nbytes += ARR_OVERHEAD_NONULLS(ndim);
1416 : : }
1417 : 31 : retval = (ArrayType *) palloc0(nbytes);
1418 : 31 : SET_VARSIZE(retval, nbytes);
1419 : 31 : retval->ndim = ndim;
1420 : 31 : retval->dataoffset = dataoffset;
1421 : 31 : retval->elemtype = element_type;
1422 : 31 : memcpy(ARR_DIMS(retval), dim, ndim * sizeof(int));
1423 : 31 : memcpy(ARR_LBOUND(retval), lBound, ndim * sizeof(int));
1424 : :
1425 : 31 : CopyArrayEls(retval,
1426 : : dataPtr, nullsPtr, nitems,
1427 : : typlen, typbyval, typalign,
1428 : : true);
1429 : :
1430 : 31 : pfree(dataPtr);
1431 : 31 : pfree(nullsPtr);
1432 : :
1433 : 31 : PG_RETURN_ARRAYTYPE_P(retval);
1434 : : }
1435 : :
1436 : : /*
1437 : : * ReadArrayBinary:
1438 : : * collect the data elements of an array being read in binary style.
1439 : : *
1440 : : * Inputs:
1441 : : * buf: the data buffer to read from.
1442 : : * nitems: total number of array elements (already read).
1443 : : * receiveproc: type-specific receive procedure for element datatype.
1444 : : * typioparam, typmod: auxiliary values to pass to receiveproc.
1445 : : * typlen, typbyval, typalign: storage parameters of element datatype.
1446 : : *
1447 : : * Outputs:
1448 : : * values[]: filled with converted data values.
1449 : : * nulls[]: filled with is-null markers.
1450 : : * *hasnulls: set true iff there are any null elements.
1451 : : * *nbytes: set to total size of data area needed (including alignment
1452 : : * padding but not including array header overhead).
1453 : : *
1454 : : * Note that values[] and nulls[] are allocated by the caller, and must have
1455 : : * nitems elements.
1456 : : */
1457 : : static void
1458 : 31 : ReadArrayBinary(StringInfo buf,
1459 : : int nitems,
1460 : : FmgrInfo *receiveproc,
1461 : : Oid typioparam,
1462 : : int32 typmod,
1463 : : int typlen,
1464 : : bool typbyval,
1465 : : char typalign,
1466 : : Datum *values,
1467 : : bool *nulls,
1468 : : bool *hasnulls,
1469 : : int32 *nbytes)
1470 : : {
1471 : : int i;
1472 : : bool hasnull;
1473 : : int32 totbytes;
1474 : 31 : uint8 typalignby = typalign_to_alignby(typalign);
1475 : :
1476 [ + + ]: 124 : for (i = 0; i < nitems; i++)
1477 : : {
1478 : : int itemlen;
1479 : : StringInfoData elem_buf;
1480 : :
1481 : : /* Get and check the item length */
1482 : 93 : itemlen = pq_getmsgint(buf, 4);
1483 [ + - - + ]: 93 : if (itemlen < -1 || itemlen > (buf->len - buf->cursor))
1484 [ # # ]: 0 : ereport(ERROR,
1485 : : (errcode(ERRCODE_INVALID_BINARY_REPRESENTATION),
1486 : : errmsg("insufficient data left in message")));
1487 : :
1488 [ - + ]: 93 : if (itemlen == -1)
1489 : : {
1490 : : /* -1 length means NULL */
1491 : 0 : values[i] = ReceiveFunctionCall(receiveproc, NULL,
1492 : : typioparam, typmod);
1493 : 0 : nulls[i] = true;
1494 : 0 : continue;
1495 : : }
1496 : :
1497 : : /*
1498 : : * Rather than copying data around, we just initialize a StringInfo
1499 : : * pointing to the correct portion of the message buffer.
1500 : : */
1501 : 93 : initReadOnlyStringInfo(&elem_buf, &buf->data[buf->cursor], itemlen);
1502 : :
1503 : 93 : buf->cursor += itemlen;
1504 : :
1505 : : /* Now call the element's receiveproc */
1506 : 93 : values[i] = ReceiveFunctionCall(receiveproc, &elem_buf,
1507 : : typioparam, typmod);
1508 : 93 : nulls[i] = false;
1509 : :
1510 : : /* Trouble if it didn't eat the whole buffer */
1511 [ - + ]: 93 : if (elem_buf.cursor != itemlen)
1512 [ # # ]: 0 : ereport(ERROR,
1513 : : (errcode(ERRCODE_INVALID_BINARY_REPRESENTATION),
1514 : : errmsg("improper binary format in array element %d",
1515 : : i + 1)));
1516 : : }
1517 : :
1518 : : /*
1519 : : * Check for nulls, compute total data space needed
1520 : : */
1521 : 31 : hasnull = false;
1522 : 31 : totbytes = 0;
1523 [ + + ]: 124 : for (i = 0; i < nitems; i++)
1524 : : {
1525 [ - + ]: 93 : if (nulls[i])
1526 : 0 : hasnull = true;
1527 : : else
1528 : : {
1529 : : /* let's just make sure data is not toasted */
1530 [ + + ]: 93 : if (typlen == -1)
1531 : 54 : values[i] = PointerGetDatum(PG_DETOAST_DATUM(values[i]));
1532 [ + + + - ]: 93 : totbytes = att_addlength_datum(totbytes, typlen, values[i]);
1533 : 93 : totbytes = att_nominal_alignby(totbytes, typalignby);
1534 : : /* check for overflow of total request */
1535 [ - + ]: 93 : if (!AllocSizeIsValid(totbytes))
1536 [ # # ]: 0 : ereport(ERROR,
1537 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
1538 : : errmsg("array size exceeds the maximum allowed (%zu)",
1539 : : MaxAllocSize)));
1540 : : }
1541 : : }
1542 : 31 : *hasnulls = hasnull;
1543 : 31 : *nbytes = totbytes;
1544 : 31 : }
1545 : :
1546 : :
1547 : : /*
1548 : : * array_send :
1549 : : * takes the internal representation of an array and returns a bytea
1550 : : * containing the array in its external binary format.
1551 : : */
1552 : : Datum
1553 : 23 : array_send(PG_FUNCTION_ARGS)
1554 : : {
1555 : 23 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1556 [ - + ]: 23 : Oid element_type = AARR_ELEMTYPE(v);
1557 : : int typlen;
1558 : : bool typbyval;
1559 : : char typalign;
1560 : : int nitems,
1561 : : i;
1562 : : int ndim,
1563 : : *dim,
1564 : : *lb;
1565 : : StringInfoData buf;
1566 : : array_iter iter;
1567 : : ArrayMetaState *my_extra;
1568 : :
1569 : : /*
1570 : : * We arrange to look up info about element type, including its send
1571 : : * conversion proc, only once per series of calls, assuming the element
1572 : : * type doesn't change underneath us.
1573 : : */
1574 : 23 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
1575 [ + + ]: 23 : if (my_extra == NULL)
1576 : : {
1577 : 20 : fcinfo->flinfo->fn_extra = MemoryContextAlloc(fcinfo->flinfo->fn_mcxt,
1578 : : sizeof(ArrayMetaState));
1579 : 20 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
1580 : 20 : my_extra->element_type = ~element_type;
1581 : : }
1582 : :
1583 [ + + ]: 23 : if (my_extra->element_type != element_type)
1584 : : {
1585 : : /* Get info about element type, including its send proc */
1586 : 20 : get_type_io_data(element_type, IOFunc_send,
1587 : : &my_extra->typlen, &my_extra->typbyval,
1588 : : &my_extra->typalign, &my_extra->typdelim,
1589 : : &my_extra->typioparam, &my_extra->typiofunc);
1590 [ - + ]: 20 : if (!OidIsValid(my_extra->typiofunc))
1591 [ # # ]: 0 : ereport(ERROR,
1592 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
1593 : : errmsg("no binary output function available for type %s",
1594 : : format_type_be(element_type))));
1595 : 20 : fmgr_info_cxt(my_extra->typiofunc, &my_extra->proc,
1596 : 20 : fcinfo->flinfo->fn_mcxt);
1597 : 20 : my_extra->element_type = element_type;
1598 : : }
1599 : 23 : typlen = my_extra->typlen;
1600 : 23 : typbyval = my_extra->typbyval;
1601 : 23 : typalign = my_extra->typalign;
1602 : :
1603 [ - + ]: 23 : ndim = AARR_NDIM(v);
1604 [ - + ]: 23 : dim = AARR_DIMS(v);
1605 [ - + ]: 23 : lb = AARR_LBOUND(v);
1606 : 23 : nitems = ArrayGetNItems(ndim, dim);
1607 : :
1608 : 23 : pq_begintypsend(&buf);
1609 : :
1610 : : /* Send the array header information */
1611 : 23 : pq_sendint32(&buf, ndim);
1612 [ - + - - ]: 23 : pq_sendint32(&buf, AARR_HASNULL(v) ? 1 : 0);
1613 : 23 : pq_sendint32(&buf, element_type);
1614 [ + + ]: 46 : for (i = 0; i < ndim; i++)
1615 : : {
1616 : 23 : pq_sendint32(&buf, dim[i]);
1617 : 23 : pq_sendint32(&buf, lb[i]);
1618 : : }
1619 : :
1620 : : /* Send the array elements using the element's own sendproc */
1621 : 23 : array_iter_setup(&iter, v, typlen, typbyval, typalign);
1622 : :
1623 [ + + ]: 92 : for (i = 0; i < nitems; i++)
1624 : : {
1625 : : Datum itemvalue;
1626 : : bool isnull;
1627 : :
1628 : : /* Get source element, checking for NULL */
1629 : 69 : itemvalue = array_iter_next(&iter, &isnull, i);
1630 : :
1631 [ - + ]: 69 : if (isnull)
1632 : : {
1633 : : /* -1 length means a NULL */
1634 : 0 : pq_sendint32(&buf, -1);
1635 : : }
1636 : : else
1637 : : {
1638 : : bytea *outputbytes;
1639 : :
1640 : 69 : outputbytes = SendFunctionCall(&my_extra->proc, itemvalue);
1641 : 69 : pq_sendint32(&buf, VARSIZE(outputbytes) - VARHDRSZ);
1642 : 69 : pq_sendbytes(&buf, VARDATA(outputbytes),
1643 : 69 : VARSIZE(outputbytes) - VARHDRSZ);
1644 : 69 : pfree(outputbytes);
1645 : : }
1646 : : }
1647 : :
1648 : 23 : PG_RETURN_BYTEA_P(pq_endtypsend(&buf));
1649 : : }
1650 : :
1651 : : /*
1652 : : * array_ndims :
1653 : : * returns the number of dimensions of the array pointed to by "v"
1654 : : */
1655 : : Datum
1656 : 1279 : array_ndims(PG_FUNCTION_ARGS)
1657 : : {
1658 : 1279 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1659 : :
1660 : : /* Sanity check: does it look like an array at all? */
1661 [ - + - - : 1279 : if (AARR_NDIM(v) <= 0 || AARR_NDIM(v) > MAXDIM)
+ + - + -
- - + ]
1662 : 8 : PG_RETURN_NULL();
1663 : :
1664 [ - + ]: 1271 : PG_RETURN_INT32(AARR_NDIM(v));
1665 : : }
1666 : :
1667 : : /*
1668 : : * array_dims :
1669 : : * returns the dimensions of the array pointed to by "v", as a "text"
1670 : : */
1671 : : Datum
1672 : 6737 : array_dims(PG_FUNCTION_ARGS)
1673 : : {
1674 : 6737 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1675 : : char *p;
1676 : : int i;
1677 : : int *dimv,
1678 : : *lb;
1679 : :
1680 : : /*
1681 : : * 33 since we assume 15 digits per number + ':' +'[]'
1682 : : *
1683 : : * +1 for trailing null
1684 : : */
1685 : : char buf[MAXDIM * 33 + 1];
1686 : :
1687 : : /* Sanity check: does it look like an array at all? */
1688 [ - + - - : 6737 : if (AARR_NDIM(v) <= 0 || AARR_NDIM(v) > MAXDIM)
+ + - + -
- - + ]
1689 : 48 : PG_RETURN_NULL();
1690 : :
1691 [ - + ]: 6689 : dimv = AARR_DIMS(v);
1692 [ - + ]: 6689 : lb = AARR_LBOUND(v);
1693 : :
1694 : 6689 : p = buf;
1695 [ - + + + ]: 13450 : for (i = 0; i < AARR_NDIM(v); i++)
1696 : : {
1697 : 6761 : sprintf(p, "[%d:%d]", lb[i], dimv[i] + lb[i] - 1);
1698 : 6761 : p += strlen(p);
1699 : : }
1700 : :
1701 : 6689 : PG_RETURN_TEXT_P(cstring_to_text(buf));
1702 : : }
1703 : :
1704 : : /*
1705 : : * array_lower :
1706 : : * returns the lower dimension, of the DIM requested, for
1707 : : * the array pointed to by "v", as an int4
1708 : : */
1709 : : Datum
1710 : 17604 : array_lower(PG_FUNCTION_ARGS)
1711 : : {
1712 : 17604 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1713 : 17604 : int reqdim = PG_GETARG_INT32(1);
1714 : : int *lb;
1715 : : int result;
1716 : :
1717 : : /* Sanity check: does it look like an array at all? */
1718 [ + + + - : 17604 : if (AARR_NDIM(v) <= 0 || AARR_NDIM(v) > MAXDIM)
+ - + + -
+ - + ]
1719 : 0 : PG_RETURN_NULL();
1720 : :
1721 : : /* Sanity check: was the requested dim valid */
1722 [ + - + + : 17604 : if (reqdim <= 0 || reqdim > AARR_NDIM(v))
- + ]
1723 : 0 : PG_RETURN_NULL();
1724 : :
1725 [ + + ]: 17604 : lb = AARR_LBOUND(v);
1726 : 17604 : result = lb[reqdim - 1];
1727 : :
1728 : 17604 : PG_RETURN_INT32(result);
1729 : : }
1730 : :
1731 : : /*
1732 : : * array_upper :
1733 : : * returns the upper dimension, of the DIM requested, for
1734 : : * the array pointed to by "v", as an int4
1735 : : */
1736 : : Datum
1737 : 18034 : array_upper(PG_FUNCTION_ARGS)
1738 : : {
1739 : 18034 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1740 : 18034 : int reqdim = PG_GETARG_INT32(1);
1741 : : int *dimv,
1742 : : *lb;
1743 : : int result;
1744 : :
1745 : : /* Sanity check: does it look like an array at all? */
1746 [ + + + - : 18034 : if (AARR_NDIM(v) <= 0 || AARR_NDIM(v) > MAXDIM)
+ + + + -
+ - + ]
1747 : 21 : PG_RETURN_NULL();
1748 : :
1749 : : /* Sanity check: was the requested dim valid */
1750 [ + - + + : 18013 : if (reqdim <= 0 || reqdim > AARR_NDIM(v))
- + ]
1751 : 0 : PG_RETURN_NULL();
1752 : :
1753 [ + + ]: 18013 : lb = AARR_LBOUND(v);
1754 [ + + ]: 18013 : dimv = AARR_DIMS(v);
1755 : :
1756 : 18013 : result = dimv[reqdim - 1] + lb[reqdim - 1] - 1;
1757 : :
1758 : 18013 : PG_RETURN_INT32(result);
1759 : : }
1760 : :
1761 : : /*
1762 : : * array_length :
1763 : : * returns the length, of the dimension requested, for
1764 : : * the array pointed to by "v", as an int4
1765 : : */
1766 : : Datum
1767 : 80795 : array_length(PG_FUNCTION_ARGS)
1768 : : {
1769 : 80795 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1770 : 80795 : int reqdim = PG_GETARG_INT32(1);
1771 : : int *dimv;
1772 : : int result;
1773 : :
1774 : : /* Sanity check: does it look like an array at all? */
1775 [ + + + - : 80795 : if (AARR_NDIM(v) <= 0 || AARR_NDIM(v) > MAXDIM)
+ - + + -
+ - + ]
1776 : 0 : PG_RETURN_NULL();
1777 : :
1778 : : /* Sanity check: was the requested dim valid */
1779 [ + + + + : 80795 : if (reqdim <= 0 || reqdim > AARR_NDIM(v))
+ + ]
1780 : 10 : PG_RETURN_NULL();
1781 : :
1782 [ + + ]: 80785 : dimv = AARR_DIMS(v);
1783 : :
1784 : 80785 : result = dimv[reqdim - 1];
1785 : :
1786 : 80785 : PG_RETURN_INT32(result);
1787 : : }
1788 : :
1789 : : /*
1790 : : * array_cardinality:
1791 : : * returns the total number of elements in an array
1792 : : */
1793 : : Datum
1794 : 1694 : array_cardinality(PG_FUNCTION_ARGS)
1795 : : {
1796 : 1694 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
1797 : :
1798 [ - + - + ]: 1694 : PG_RETURN_INT32(ArrayGetNItems(AARR_NDIM(v), AARR_DIMS(v)));
1799 : : }
1800 : :
1801 : :
1802 : : /*
1803 : : * array_get_element :
1804 : : * This routine takes an array datum and a subscript array and returns
1805 : : * the referenced item as a Datum. Note that for a pass-by-reference
1806 : : * datatype, the returned Datum is a pointer into the array object.
1807 : : *
1808 : : * This handles both ordinary varlena arrays and fixed-length arrays.
1809 : : *
1810 : : * Inputs:
1811 : : * arraydatum: the array object (mustn't be NULL)
1812 : : * nSubscripts: number of subscripts supplied
1813 : : * indx[]: the subscript values
1814 : : * arraytyplen: pg_type.typlen for the array type
1815 : : * elmlen: pg_type.typlen for the array's element type
1816 : : * elmbyval: pg_type.typbyval for the array's element type
1817 : : * elmalign: pg_type.typalign for the array's element type
1818 : : *
1819 : : * Outputs:
1820 : : * The return value is the element Datum.
1821 : : * *isNull is set to indicate whether the element is NULL.
1822 : : */
1823 : : Datum
1824 : 548426 : array_get_element(Datum arraydatum,
1825 : : int nSubscripts,
1826 : : int *indx,
1827 : : int arraytyplen,
1828 : : int elmlen,
1829 : : bool elmbyval,
1830 : : char elmalign,
1831 : : bool *isNull)
1832 : : {
1833 : : int i,
1834 : : ndim,
1835 : : *dim,
1836 : : *lb,
1837 : : offset,
1838 : : fixedDim[1],
1839 : : fixedLb[1];
1840 : : char *arraydataptr,
1841 : : *retptr;
1842 : : uint8 *arraynullsptr;
1843 : :
1844 [ + + ]: 548426 : if (arraytyplen > 0)
1845 : : {
1846 : : /*
1847 : : * fixed-length arrays -- these are assumed to be 1-d, 0-based
1848 : : */
1849 : 185355 : ndim = 1;
1850 : 185355 : fixedDim[0] = arraytyplen / elmlen;
1851 : 185355 : fixedLb[0] = 0;
1852 : 185355 : dim = fixedDim;
1853 : 185355 : lb = fixedLb;
1854 : 185355 : arraydataptr = (char *) DatumGetPointer(arraydatum);
1855 : 185355 : arraynullsptr = NULL;
1856 : : }
1857 [ + + ]: 363071 : else if (VARATT_IS_EXTERNAL_EXPANDED(DatumGetPointer(arraydatum)))
1858 : : {
1859 : : /* expanded array: let's do this in a separate function */
1860 : 3421 : return array_get_element_expanded(arraydatum,
1861 : : nSubscripts,
1862 : : indx,
1863 : : arraytyplen,
1864 : : elmlen,
1865 : : elmbyval,
1866 : : elmalign,
1867 : : isNull);
1868 : : }
1869 : : else
1870 : : {
1871 : : /* detoast array if necessary, producing normal varlena input */
1872 : 359650 : ArrayType *array = DatumGetArrayTypeP(arraydatum);
1873 : :
1874 : 359650 : ndim = ARR_NDIM(array);
1875 : 359650 : dim = ARR_DIMS(array);
1876 : 359650 : lb = ARR_LBOUND(array);
1877 [ + + ]: 359650 : arraydataptr = ARR_DATA_PTR(array);
1878 [ + + ]: 359650 : arraynullsptr = ARR_NULLBITMAP(array);
1879 : : }
1880 : :
1881 : : /*
1882 : : * Return NULL for invalid subscript
1883 : : */
1884 [ + + + - : 545005 : if (ndim != nSubscripts || ndim <= 0 || ndim > MAXDIM)
- + ]
1885 : : {
1886 : 64 : *isNull = true;
1887 : 64 : return (Datum) 0;
1888 : : }
1889 [ + + ]: 1054462 : for (i = 0; i < ndim; i++)
1890 : : {
1891 [ + + + + ]: 545009 : if (indx[i] < lb[i] || indx[i] >= (dim[i] + lb[i]))
1892 : : {
1893 : 35488 : *isNull = true;
1894 : 35488 : return (Datum) 0;
1895 : : }
1896 : : }
1897 : :
1898 : : /*
1899 : : * Calculate the element number
1900 : : */
1901 : 509453 : offset = ArrayGetOffset(nSubscripts, dim, lb, indx);
1902 : :
1903 : : /*
1904 : : * Check for NULL array element
1905 : : */
1906 [ + + ]: 509453 : if (array_get_isnull(arraynullsptr, offset))
1907 : : {
1908 : 48 : *isNull = true;
1909 : 48 : return (Datum) 0;
1910 : : }
1911 : :
1912 : : /*
1913 : : * OK, get the element
1914 : : */
1915 : 509405 : *isNull = false;
1916 : 509405 : retptr = array_seek(arraydataptr, 0, arraynullsptr, offset,
1917 : : elmlen, elmbyval, elmalign);
1918 : 509405 : return ArrayCast(retptr, elmbyval, elmlen);
1919 : : }
1920 : :
1921 : : /*
1922 : : * Implementation of array_get_element() for an expanded array
1923 : : */
1924 : : static Datum
1925 : 3421 : array_get_element_expanded(Datum arraydatum,
1926 : : int nSubscripts, int *indx,
1927 : : int arraytyplen,
1928 : : int elmlen, bool elmbyval, char elmalign,
1929 : : bool *isNull)
1930 : : {
1931 : : ExpandedArrayHeader *eah;
1932 : : int i,
1933 : : ndim,
1934 : : *dim,
1935 : : *lb,
1936 : : offset;
1937 : : Datum *dvalues;
1938 : : bool *dnulls;
1939 : :
1940 : 3421 : eah = (ExpandedArrayHeader *) DatumGetEOHP(arraydatum);
1941 : : Assert(eah->ea_magic == EA_MAGIC);
1942 : :
1943 : : /* sanity-check caller's info against object */
1944 : : Assert(arraytyplen == -1);
1945 : : Assert(elmlen == eah->typlen);
1946 : : Assert(elmbyval == eah->typbyval);
1947 : : Assert(elmalign == eah->typalign);
1948 : :
1949 : 3421 : ndim = eah->ndims;
1950 : 3421 : dim = eah->dims;
1951 : 3421 : lb = eah->lbound;
1952 : :
1953 : : /*
1954 : : * Return NULL for invalid subscript
1955 : : */
1956 [ + + + - : 3421 : if (ndim != nSubscripts || ndim <= 0 || ndim > MAXDIM)
- + ]
1957 : : {
1958 : 4 : *isNull = true;
1959 : 4 : return (Datum) 0;
1960 : : }
1961 [ + + ]: 6834 : for (i = 0; i < ndim; i++)
1962 : : {
1963 [ + - - + ]: 3417 : if (indx[i] < lb[i] || indx[i] >= (dim[i] + lb[i]))
1964 : : {
1965 : 0 : *isNull = true;
1966 : 0 : return (Datum) 0;
1967 : : }
1968 : : }
1969 : :
1970 : : /*
1971 : : * Calculate the element number
1972 : : */
1973 : 3417 : offset = ArrayGetOffset(nSubscripts, dim, lb, indx);
1974 : :
1975 : : /*
1976 : : * Deconstruct array if we didn't already. Note that we apply this even
1977 : : * if the input is nominally read-only: it should be safe enough.
1978 : : */
1979 : 3417 : deconstruct_expanded_array(eah);
1980 : :
1981 : 3417 : dvalues = eah->dvalues;
1982 : 3417 : dnulls = eah->dnulls;
1983 : :
1984 : : /*
1985 : : * Check for NULL array element
1986 : : */
1987 [ - + - - ]: 3417 : if (dnulls && dnulls[offset])
1988 : : {
1989 : 0 : *isNull = true;
1990 : 0 : return (Datum) 0;
1991 : : }
1992 : :
1993 : : /*
1994 : : * OK, get the element. It's OK to return a pass-by-ref value as a
1995 : : * pointer into the expanded array, for the same reason that regular
1996 : : * array_get_element can return a pointer into flat arrays: the value is
1997 : : * assumed not to change for as long as the Datum reference can exist.
1998 : : */
1999 : 3417 : *isNull = false;
2000 : 3417 : return dvalues[offset];
2001 : : }
2002 : :
2003 : : /*
2004 : : * array_get_slice :
2005 : : * This routine takes an array and a range of indices (upperIndx and
2006 : : * lowerIndx), creates a new array structure for the referred elements
2007 : : * and returns a pointer to it.
2008 : : *
2009 : : * This handles both ordinary varlena arrays and fixed-length arrays.
2010 : : *
2011 : : * Inputs:
2012 : : * arraydatum: the array object (mustn't be NULL)
2013 : : * nSubscripts: number of subscripts supplied (must be same for upper/lower)
2014 : : * upperIndx[]: the upper subscript values
2015 : : * lowerIndx[]: the lower subscript values
2016 : : * upperProvided[]: true for provided upper subscript values
2017 : : * lowerProvided[]: true for provided lower subscript values
2018 : : * arraytyplen: pg_type.typlen for the array type
2019 : : * elmlen: pg_type.typlen for the array's element type
2020 : : * elmbyval: pg_type.typbyval for the array's element type
2021 : : * elmalign: pg_type.typalign for the array's element type
2022 : : *
2023 : : * Outputs:
2024 : : * The return value is the new array Datum (it's never NULL)
2025 : : *
2026 : : * Omitted upper and lower subscript values are replaced by the corresponding
2027 : : * array bound.
2028 : : *
2029 : : * NOTE: we assume it is OK to scribble on the provided subscript arrays
2030 : : * lowerIndx[] and upperIndx[]; also, these arrays must be of size MAXDIM
2031 : : * even when nSubscripts is less. These are generally just temporaries.
2032 : : */
2033 : : Datum
2034 : 276 : array_get_slice(Datum arraydatum,
2035 : : int nSubscripts,
2036 : : int *upperIndx,
2037 : : int *lowerIndx,
2038 : : bool *upperProvided,
2039 : : bool *lowerProvided,
2040 : : int arraytyplen,
2041 : : int elmlen,
2042 : : bool elmbyval,
2043 : : char elmalign)
2044 : : {
2045 : : ArrayType *array;
2046 : : ArrayType *newarray;
2047 : : int i,
2048 : : ndim,
2049 : : *dim,
2050 : : *lb,
2051 : : *newlb;
2052 : : int fixedDim[1],
2053 : : fixedLb[1];
2054 : : Oid elemtype;
2055 : : char *arraydataptr;
2056 : : uint8 *arraynullsptr;
2057 : : int32 dataoffset;
2058 : : int bytes,
2059 : : span[MAXDIM];
2060 : :
2061 [ + + ]: 276 : if (arraytyplen > 0)
2062 : : {
2063 : : /*
2064 : : * fixed-length arrays -- currently, cannot slice these because parser
2065 : : * labels output as being of the fixed-length array type! Code below
2066 : : * shows how we could support it if the parser were changed to label
2067 : : * output as a suitable varlena array type.
2068 : : */
2069 [ + - ]: 16 : ereport(ERROR,
2070 : : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2071 : : errmsg("slices of fixed-length arrays not implemented")));
2072 : :
2073 : : /*
2074 : : * fixed-length arrays -- these are assumed to be 1-d, 0-based
2075 : : *
2076 : : * XXX where would we get the correct ELEMTYPE from?
2077 : : */
2078 : : ndim = 1;
2079 : : fixedDim[0] = arraytyplen / elmlen;
2080 : : fixedLb[0] = 0;
2081 : : dim = fixedDim;
2082 : : lb = fixedLb;
2083 : : elemtype = InvalidOid; /* XXX */
2084 : : arraydataptr = (char *) DatumGetPointer(arraydatum);
2085 : : arraynullsptr = NULL;
2086 : : }
2087 : : else
2088 : : {
2089 : : /* detoast input array if necessary */
2090 : 260 : array = DatumGetArrayTypeP(arraydatum);
2091 : :
2092 : 260 : ndim = ARR_NDIM(array);
2093 : 260 : dim = ARR_DIMS(array);
2094 : 260 : lb = ARR_LBOUND(array);
2095 : 260 : elemtype = ARR_ELEMTYPE(array);
2096 [ + + ]: 260 : arraydataptr = ARR_DATA_PTR(array);
2097 [ + + ]: 260 : arraynullsptr = ARR_NULLBITMAP(array);
2098 : : }
2099 : :
2100 : : /*
2101 : : * Check provided subscripts. A slice exceeding the current array limits
2102 : : * is silently truncated to the array limits. If we end up with an empty
2103 : : * slice, return an empty array.
2104 : : */
2105 [ + + + - : 260 : if (ndim < nSubscripts || ndim <= 0 || ndim > MAXDIM)
- + ]
2106 : 64 : return PointerGetDatum(construct_empty_array(elemtype));
2107 : :
2108 [ + + ]: 451 : for (i = 0; i < nSubscripts; i++)
2109 : : {
2110 [ + + + + ]: 263 : if (!lowerProvided[i] || lowerIndx[i] < lb[i])
2111 : 84 : lowerIndx[i] = lb[i];
2112 [ + + + + ]: 263 : if (!upperProvided[i] || upperIndx[i] >= (dim[i] + lb[i]))
2113 : 48 : upperIndx[i] = dim[i] + lb[i] - 1;
2114 [ + + ]: 263 : if (lowerIndx[i] > upperIndx[i])
2115 : 8 : return PointerGetDatum(construct_empty_array(elemtype));
2116 : : }
2117 : : /* fill any missing subscript positions with full array range */
2118 [ + + ]: 221 : for (; i < ndim; i++)
2119 : : {
2120 : 33 : lowerIndx[i] = lb[i];
2121 : 33 : upperIndx[i] = dim[i] + lb[i] - 1;
2122 [ - + ]: 33 : if (lowerIndx[i] > upperIndx[i])
2123 : 0 : return PointerGetDatum(construct_empty_array(elemtype));
2124 : : }
2125 : :
2126 : 188 : mda_get_range(ndim, span, lowerIndx, upperIndx);
2127 : :
2128 : 188 : bytes = array_slice_size(arraydataptr, arraynullsptr,
2129 : : ndim, dim, lb,
2130 : : lowerIndx, upperIndx,
2131 : : elmlen, elmbyval, elmalign);
2132 : :
2133 : : /*
2134 : : * Currently, we put a null bitmap in the result if the source has one;
2135 : : * could be smarter ...
2136 : : */
2137 [ + + ]: 188 : if (arraynullsptr)
2138 : : {
2139 : 24 : dataoffset = ARR_OVERHEAD_WITHNULLS(ndim, ArrayGetNItems(ndim, span));
2140 : 24 : bytes += dataoffset;
2141 : : }
2142 : : else
2143 : : {
2144 : 164 : dataoffset = 0; /* marker for no null bitmap */
2145 : 164 : bytes += ARR_OVERHEAD_NONULLS(ndim);
2146 : : }
2147 : :
2148 : 188 : newarray = (ArrayType *) palloc0(bytes);
2149 : 188 : SET_VARSIZE(newarray, bytes);
2150 : 188 : newarray->ndim = ndim;
2151 : 188 : newarray->dataoffset = dataoffset;
2152 : 188 : newarray->elemtype = elemtype;
2153 : 188 : memcpy(ARR_DIMS(newarray), span, ndim * sizeof(int));
2154 : :
2155 : : /*
2156 : : * Lower bounds of the new array are set to 1. Formerly (before 7.3) we
2157 : : * copied the given lowerIndx values ... but that seems confusing.
2158 : : */
2159 : 188 : newlb = ARR_LBOUND(newarray);
2160 [ + + ]: 476 : for (i = 0; i < ndim; i++)
2161 : 288 : newlb[i] = 1;
2162 : :
2163 : 188 : array_extract_slice(newarray,
2164 : : ndim, dim, lb,
2165 : : arraydataptr, arraynullsptr,
2166 : : lowerIndx, upperIndx,
2167 : : elmlen, elmbyval, elmalign);
2168 : :
2169 : 188 : return PointerGetDatum(newarray);
2170 : : }
2171 : :
2172 : : /*
2173 : : * array_set_element :
2174 : : * This routine sets the value of one array element (specified by
2175 : : * a subscript array) to a new value specified by "dataValue".
2176 : : *
2177 : : * This handles both ordinary varlena arrays and fixed-length arrays.
2178 : : *
2179 : : * Inputs:
2180 : : * arraydatum: the initial array object (mustn't be NULL)
2181 : : * nSubscripts: number of subscripts supplied
2182 : : * indx[]: the subscript values
2183 : : * dataValue: the datum to be inserted at the given position
2184 : : * isNull: whether dataValue is NULL
2185 : : * arraytyplen: pg_type.typlen for the array type
2186 : : * elmlen: pg_type.typlen for the array's element type
2187 : : * elmbyval: pg_type.typbyval for the array's element type
2188 : : * elmalign: pg_type.typalign for the array's element type
2189 : : *
2190 : : * Result:
2191 : : * A new array is returned, just like the old except for the one
2192 : : * modified entry. The original array object is not changed,
2193 : : * unless what is passed is a read-write reference to an expanded
2194 : : * array object; in that case the expanded array is updated in-place.
2195 : : *
2196 : : * For one-dimensional arrays only, we allow the array to be extended
2197 : : * by assigning to a position outside the existing subscript range; any
2198 : : * positions between the existing elements and the new one are set to NULLs.
2199 : : * (XXX TODO: allow a corresponding behavior for multidimensional arrays)
2200 : : *
2201 : : * NOTE: For assignments, we throw an error for invalid subscripts etc,
2202 : : * rather than returning a NULL as the fetch operations do.
2203 : : */
2204 : : Datum
2205 : 2658 : array_set_element(Datum arraydatum,
2206 : : int nSubscripts,
2207 : : int *indx,
2208 : : Datum dataValue,
2209 : : bool isNull,
2210 : : int arraytyplen,
2211 : : int elmlen,
2212 : : bool elmbyval,
2213 : : char elmalign)
2214 : : {
2215 : : ArrayType *array;
2216 : : ArrayType *newarray;
2217 : : int i,
2218 : : ndim,
2219 : : dim[MAXDIM],
2220 : : lb[MAXDIM],
2221 : : offset;
2222 : : char *elt_ptr;
2223 : : bool newhasnulls;
2224 : : uint8 *oldnullbitmap;
2225 : : int oldnitems,
2226 : : newnitems,
2227 : : olddatasize,
2228 : : newsize,
2229 : : olditemlen,
2230 : : newitemlen,
2231 : : overheadlen,
2232 : : oldoverheadlen,
2233 : : addedbefore,
2234 : : addedafter,
2235 : : lenbefore,
2236 : : lenafter;
2237 : 2658 : uint8 elmalignby = typalign_to_alignby(elmalign);
2238 : :
2239 [ + + ]: 2658 : if (arraytyplen > 0)
2240 : : {
2241 : : /*
2242 : : * fixed-length arrays -- these are assumed to be 1-d, 0-based. We
2243 : : * cannot extend them, either.
2244 : : */
2245 : : char *resultarray;
2246 : :
2247 [ - + ]: 12 : if (nSubscripts != 1)
2248 [ # # ]: 0 : ereport(ERROR,
2249 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2250 : : errmsg("wrong number of array subscripts")));
2251 : :
2252 [ + - + + ]: 12 : if (indx[0] < 0 || indx[0] >= arraytyplen / elmlen)
2253 [ + - ]: 4 : ereport(ERROR,
2254 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2255 : : errmsg("array subscript out of range")));
2256 : :
2257 [ - + ]: 8 : if (isNull)
2258 [ # # ]: 0 : ereport(ERROR,
2259 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
2260 : : errmsg("cannot assign null value to an element of a fixed-length array")));
2261 : :
2262 : 8 : resultarray = (char *) palloc(arraytyplen);
2263 : 8 : memcpy(resultarray, DatumGetPointer(arraydatum), arraytyplen);
2264 : 8 : elt_ptr = resultarray + indx[0] * elmlen;
2265 : 8 : ArrayCastAndSet(dataValue, elmlen, elmbyval, elmalignby, elt_ptr);
2266 : 8 : return PointerGetDatum(resultarray);
2267 : : }
2268 : :
2269 [ + - - + ]: 2646 : if (nSubscripts <= 0 || nSubscripts > MAXDIM)
2270 [ # # ]: 0 : ereport(ERROR,
2271 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2272 : : errmsg("wrong number of array subscripts")));
2273 : :
2274 : : /* make sure item to be inserted is not toasted */
2275 [ + + + + ]: 2646 : if (elmlen == -1 && !isNull)
2276 : 1580 : dataValue = PointerGetDatum(PG_DETOAST_DATUM(dataValue));
2277 : :
2278 [ + + ]: 2646 : if (VARATT_IS_EXTERNAL_EXPANDED(DatumGetPointer(arraydatum)))
2279 : : {
2280 : : /* expanded array: let's do this in a separate function */
2281 : 1361 : return array_set_element_expanded(arraydatum,
2282 : : nSubscripts,
2283 : : indx,
2284 : : dataValue,
2285 : : isNull,
2286 : : arraytyplen,
2287 : : elmlen,
2288 : : elmbyval,
2289 : : elmalign);
2290 : : }
2291 : :
2292 : : /* detoast input array if necessary */
2293 : 1285 : array = DatumGetArrayTypeP(arraydatum);
2294 : :
2295 : 1285 : ndim = ARR_NDIM(array);
2296 : :
2297 : : /*
2298 : : * if number of dims is zero, i.e. an empty array, create an array with
2299 : : * nSubscripts dimensions, and set the lower bounds to the supplied
2300 : : * subscripts
2301 : : */
2302 [ + + ]: 1285 : if (ndim == 0)
2303 : : {
2304 : 240 : Oid elmtype = ARR_ELEMTYPE(array);
2305 : :
2306 [ + + ]: 481 : for (i = 0; i < nSubscripts; i++)
2307 : : {
2308 : 241 : dim[i] = 1;
2309 : 241 : lb[i] = indx[i];
2310 : : }
2311 : :
2312 : 240 : return PointerGetDatum(construct_md_array(&dataValue, &isNull,
2313 : : nSubscripts, dim, lb,
2314 : : elmtype,
2315 : : elmlen, elmbyval, elmalign));
2316 : : }
2317 : :
2318 [ + + ]: 1045 : if (ndim != nSubscripts)
2319 [ + - ]: 4 : ereport(ERROR,
2320 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2321 : : errmsg("wrong number of array subscripts")));
2322 : :
2323 : : /* copy dim/lb since we may modify them */
2324 : 1041 : memcpy(dim, ARR_DIMS(array), ndim * sizeof(int));
2325 : 1041 : memcpy(lb, ARR_LBOUND(array), ndim * sizeof(int));
2326 : :
2327 [ + + + + ]: 1041 : newhasnulls = (ARR_HASNULL(array) || isNull);
2328 : 1041 : addedbefore = addedafter = 0;
2329 : :
2330 : : /*
2331 : : * Check subscripts. We assume the existing subscripts passed
2332 : : * ArrayCheckBounds, so that dim[i] + lb[i] can be computed without
2333 : : * overflow. But we must beware of other overflows in our calculations of
2334 : : * new dim[] values.
2335 : : */
2336 [ + + ]: 1041 : if (ndim == 1)
2337 : : {
2338 [ + + ]: 1037 : if (indx[0] < lb[0])
2339 : : {
2340 : : /* addedbefore = lb[0] - indx[0]; */
2341 : : /* dim[0] += addedbefore; */
2342 [ + - - + ]: 32 : if (pg_sub_s32_overflow(lb[0], indx[0], &addedbefore) ||
2343 : 16 : pg_add_s32_overflow(dim[0], addedbefore, &dim[0]))
2344 [ # # ]: 0 : ereport(ERROR,
2345 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
2346 : : errmsg("array size exceeds the maximum allowed (%zu)",
2347 : : MaxArraySize)));
2348 : 16 : lb[0] = indx[0];
2349 [ + + ]: 16 : if (addedbefore > 1)
2350 : 8 : newhasnulls = true; /* will insert nulls */
2351 : : }
2352 [ + + ]: 1037 : if (indx[0] >= (dim[0] + lb[0]))
2353 : : {
2354 : : /* addedafter = indx[0] - (dim[0] + lb[0]) + 1; */
2355 : : /* dim[0] += addedafter; */
2356 [ + + + - ]: 1586 : if (pg_sub_s32_overflow(indx[0], dim[0] + lb[0], &addedafter) ||
2357 [ - + ]: 1582 : pg_add_s32_overflow(addedafter, 1, &addedafter) ||
2358 : 791 : pg_add_s32_overflow(dim[0], addedafter, &dim[0]))
2359 [ + - ]: 4 : ereport(ERROR,
2360 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
2361 : : errmsg("array size exceeds the maximum allowed (%zu)",
2362 : : MaxArraySize)));
2363 [ + + ]: 791 : if (addedafter > 1)
2364 : 25 : newhasnulls = true; /* will insert nulls */
2365 : : }
2366 : : }
2367 : : else
2368 : : {
2369 : : /*
2370 : : * XXX currently we do not support extending multi-dimensional arrays
2371 : : * during assignment
2372 : : */
2373 [ + + ]: 12 : for (i = 0; i < ndim; i++)
2374 : : {
2375 [ + - ]: 8 : if (indx[i] < lb[i] ||
2376 [ - + ]: 8 : indx[i] >= (dim[i] + lb[i]))
2377 [ # # ]: 0 : ereport(ERROR,
2378 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2379 : : errmsg("array subscript out of range")));
2380 : : }
2381 : : }
2382 : :
2383 : : /* This checks for overflow of the array dimensions */
2384 : 1037 : newnitems = ArrayGetNItems(ndim, dim);
2385 : 1037 : ArrayCheckBounds(ndim, dim, lb);
2386 : :
2387 : : /*
2388 : : * Compute sizes of items and areas to copy
2389 : : */
2390 [ + + ]: 1037 : if (newhasnulls)
2391 : 90 : overheadlen = ARR_OVERHEAD_WITHNULLS(ndim, newnitems);
2392 : : else
2393 : 947 : overheadlen = ARR_OVERHEAD_NONULLS(ndim);
2394 : 1037 : oldnitems = ArrayGetNItems(ndim, ARR_DIMS(array));
2395 [ + + ]: 1037 : oldnullbitmap = ARR_NULLBITMAP(array);
2396 [ + + ]: 1037 : oldoverheadlen = ARR_DATA_OFFSET(array);
2397 : 1037 : olddatasize = ARR_SIZE(array) - oldoverheadlen;
2398 [ + + ]: 1037 : if (addedbefore)
2399 : : {
2400 : 16 : offset = 0;
2401 : 16 : lenbefore = 0;
2402 : 16 : olditemlen = 0;
2403 : 16 : lenafter = olddatasize;
2404 : : }
2405 [ + + ]: 1021 : else if (addedafter)
2406 : : {
2407 : 791 : offset = oldnitems;
2408 : 791 : lenbefore = olddatasize;
2409 : 791 : olditemlen = 0;
2410 : 791 : lenafter = 0;
2411 : : }
2412 : : else
2413 : : {
2414 : 230 : offset = ArrayGetOffset(nSubscripts, dim, lb, indx);
2415 [ + + ]: 230 : elt_ptr = array_seek(ARR_DATA_PTR(array), 0, oldnullbitmap, offset,
2416 : : elmlen, elmbyval, elmalign);
2417 [ + + ]: 230 : lenbefore = (int) (elt_ptr - ARR_DATA_PTR(array));
2418 [ + + ]: 230 : if (array_get_isnull(oldnullbitmap, offset))
2419 : 16 : olditemlen = 0;
2420 : : else
2421 : : {
2422 [ + + + - ]: 214 : olditemlen = att_addlength_pointer(0, elmlen, elt_ptr);
2423 : 214 : olditemlen = att_nominal_alignby(olditemlen, elmalignby);
2424 : : }
2425 : 230 : lenafter = olddatasize - lenbefore - olditemlen;
2426 : : }
2427 : :
2428 [ + + ]: 1037 : if (isNull)
2429 : 13 : newitemlen = 0;
2430 : : else
2431 : : {
2432 [ + + + - ]: 1024 : newitemlen = att_addlength_datum(0, elmlen, dataValue);
2433 : 1024 : newitemlen = att_nominal_alignby(newitemlen, elmalignby);
2434 : : }
2435 : :
2436 : 1037 : newsize = overheadlen + lenbefore + newitemlen + lenafter;
2437 : :
2438 : : /*
2439 : : * OK, create the new array and fill in header/dimensions
2440 : : */
2441 : 1037 : newarray = (ArrayType *) palloc0(newsize);
2442 : 1037 : SET_VARSIZE(newarray, newsize);
2443 : 1037 : newarray->ndim = ndim;
2444 [ + + ]: 1037 : newarray->dataoffset = newhasnulls ? overheadlen : 0;
2445 : 1037 : newarray->elemtype = ARR_ELEMTYPE(array);
2446 : 1037 : memcpy(ARR_DIMS(newarray), dim, ndim * sizeof(int));
2447 : 1037 : memcpy(ARR_LBOUND(newarray), lb, ndim * sizeof(int));
2448 : :
2449 : : /*
2450 : : * Fill in data
2451 : : */
2452 : 1037 : memcpy((char *) newarray + overheadlen,
2453 : : (char *) array + oldoverheadlen,
2454 : : lenbefore);
2455 [ + + ]: 1037 : if (!isNull)
2456 : 1024 : ArrayCastAndSet(dataValue, elmlen, elmbyval, elmalignby,
2457 : 1024 : (char *) newarray + overheadlen + lenbefore);
2458 : 1037 : memcpy((char *) newarray + overheadlen + lenbefore + newitemlen,
2459 : 1037 : (char *) array + oldoverheadlen + lenbefore + olditemlen,
2460 : : lenafter);
2461 : :
2462 : : /*
2463 : : * Fill in nulls bitmap if needed
2464 : : *
2465 : : * Note: it's possible we just replaced the last NULL with a non-NULL, and
2466 : : * could get rid of the bitmap. Seems not worth testing for though.
2467 : : */
2468 [ + + ]: 1037 : if (newhasnulls)
2469 : : {
2470 [ + - ]: 90 : uint8 *newnullbitmap = ARR_NULLBITMAP(newarray);
2471 : :
2472 : : /* palloc0 above already marked any inserted positions as nulls */
2473 : : /* Fix the inserted value */
2474 [ + + ]: 90 : if (addedafter)
2475 : 38 : array_set_isnull(newnullbitmap, newnitems - 1, isNull);
2476 : : else
2477 : 52 : array_set_isnull(newnullbitmap, offset, isNull);
2478 : : /* Fix the copied range(s) */
2479 [ + + ]: 90 : if (addedbefore)
2480 : 16 : array_bitmap_copy(newnullbitmap, addedbefore,
2481 : : oldnullbitmap, 0,
2482 : : oldnitems);
2483 : : else
2484 : : {
2485 : 74 : array_bitmap_copy(newnullbitmap, 0,
2486 : : oldnullbitmap, 0,
2487 : : offset);
2488 [ + + ]: 74 : if (addedafter == 0)
2489 : 36 : array_bitmap_copy(newnullbitmap, offset + 1,
2490 : : oldnullbitmap, offset + 1,
2491 : 36 : oldnitems - offset - 1);
2492 : : }
2493 : : }
2494 : :
2495 : 1037 : return PointerGetDatum(newarray);
2496 : : }
2497 : :
2498 : : /*
2499 : : * Implementation of array_set_element() for an expanded array
2500 : : *
2501 : : * Note: as with any operation on a read/write expanded object, we must
2502 : : * take pains not to leave the object in a corrupt state if we fail partway
2503 : : * through.
2504 : : */
2505 : : static Datum
2506 : 1361 : array_set_element_expanded(Datum arraydatum,
2507 : : int nSubscripts, int *indx,
2508 : : Datum dataValue, bool isNull,
2509 : : int arraytyplen,
2510 : : int elmlen, bool elmbyval, char elmalign)
2511 : : {
2512 : : ExpandedArrayHeader *eah;
2513 : : Datum *dvalues;
2514 : : bool *dnulls;
2515 : : int i,
2516 : : ndim,
2517 : : dim[MAXDIM],
2518 : : lb[MAXDIM],
2519 : : offset;
2520 : : bool dimschanged,
2521 : : newhasnulls;
2522 : : int addedbefore,
2523 : : addedafter;
2524 : : char *oldValue;
2525 : :
2526 : : /* Convert to R/W object if not so already */
2527 : 1361 : eah = DatumGetExpandedArray(arraydatum);
2528 : :
2529 : : /* Sanity-check caller's info against object; we don't use it otherwise */
2530 : : Assert(arraytyplen == -1);
2531 : : Assert(elmlen == eah->typlen);
2532 : : Assert(elmbyval == eah->typbyval);
2533 : : Assert(elmalign == eah->typalign);
2534 : :
2535 : : /*
2536 : : * Copy dimension info into local storage. This allows us to modify the
2537 : : * dimensions if needed, while not messing up the expanded value if we
2538 : : * fail partway through.
2539 : : */
2540 : 1361 : ndim = eah->ndims;
2541 : : Assert(ndim >= 0 && ndim <= MAXDIM);
2542 : 1361 : memcpy(dim, eah->dims, ndim * sizeof(int));
2543 : 1361 : memcpy(lb, eah->lbound, ndim * sizeof(int));
2544 : 1361 : dimschanged = false;
2545 : :
2546 : : /*
2547 : : * if number of dims is zero, i.e. an empty array, create an array with
2548 : : * nSubscripts dimensions, and set the lower bounds to the supplied
2549 : : * subscripts.
2550 : : */
2551 [ + + ]: 1361 : if (ndim == 0)
2552 : : {
2553 : : /*
2554 : : * Allocate adequate space for new dimension info. This is harmless
2555 : : * if we fail later.
2556 : : */
2557 : : Assert(nSubscripts > 0 && nSubscripts <= MAXDIM);
2558 : 271 : eah->dims = (int *) MemoryContextAllocZero(eah->hdr.eoh_context,
2559 : : nSubscripts * sizeof(int));
2560 : 271 : eah->lbound = (int *) MemoryContextAllocZero(eah->hdr.eoh_context,
2561 : : nSubscripts * sizeof(int));
2562 : :
2563 : : /* Update local copies of dimension info */
2564 : 271 : ndim = nSubscripts;
2565 [ + + ]: 542 : for (i = 0; i < nSubscripts; i++)
2566 : : {
2567 : 271 : dim[i] = 0;
2568 : 271 : lb[i] = indx[i];
2569 : : }
2570 : 271 : dimschanged = true;
2571 : : }
2572 [ - + ]: 1090 : else if (ndim != nSubscripts)
2573 [ # # ]: 0 : ereport(ERROR,
2574 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2575 : : errmsg("wrong number of array subscripts")));
2576 : :
2577 : : /*
2578 : : * Deconstruct array if we didn't already. (Someday maybe add a special
2579 : : * case path for fixed-length, no-nulls cases, where we can overwrite an
2580 : : * element in place without ever deconstructing. But today is not that
2581 : : * day.)
2582 : : */
2583 : 1361 : deconstruct_expanded_array(eah);
2584 : :
2585 : : /*
2586 : : * Copy new element into array's context, if needed (we assume it's
2587 : : * already detoasted, so no junk should be created). Doing this before
2588 : : * we've made any significant changes ensures that our behavior is sane
2589 : : * even when the source is a reference to some element of this same array.
2590 : : * If we fail further down, this memory is leaked, but that's reasonably
2591 : : * harmless.
2592 : : */
2593 [ + + + - ]: 1361 : if (!eah->typbyval && !isNull)
2594 : : {
2595 : 587 : MemoryContext oldcxt = MemoryContextSwitchTo(eah->hdr.eoh_context);
2596 : :
2597 : 587 : dataValue = datumCopy(dataValue, false, eah->typlen);
2598 : 587 : MemoryContextSwitchTo(oldcxt);
2599 : : }
2600 : :
2601 : 1361 : dvalues = eah->dvalues;
2602 : 1361 : dnulls = eah->dnulls;
2603 : :
2604 [ + - - + ]: 1361 : newhasnulls = ((dnulls != NULL) || isNull);
2605 : 1361 : addedbefore = addedafter = 0;
2606 : :
2607 : : /*
2608 : : * Check subscripts (this logic must match array_set_element). We assume
2609 : : * the existing subscripts passed ArrayCheckBounds, so that dim[i] + lb[i]
2610 : : * can be computed without overflow. But we must beware of other
2611 : : * overflows in our calculations of new dim[] values.
2612 : : */
2613 [ + - ]: 1361 : if (ndim == 1)
2614 : : {
2615 [ + + ]: 1361 : if (indx[0] < lb[0])
2616 : : {
2617 : : /* addedbefore = lb[0] - indx[0]; */
2618 : : /* dim[0] += addedbefore; */
2619 [ + - - + ]: 126 : if (pg_sub_s32_overflow(lb[0], indx[0], &addedbefore) ||
2620 : 63 : pg_add_s32_overflow(dim[0], addedbefore, &dim[0]))
2621 [ # # ]: 0 : ereport(ERROR,
2622 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
2623 : : errmsg("array size exceeds the maximum allowed (%zu)",
2624 : : MaxArraySize)));
2625 : 63 : lb[0] = indx[0];
2626 : 63 : dimschanged = true;
2627 [ - + ]: 63 : if (addedbefore > 1)
2628 : 0 : newhasnulls = true; /* will insert nulls */
2629 : : }
2630 [ + + ]: 1361 : if (indx[0] >= (dim[0] + lb[0]))
2631 : : {
2632 : : /* addedafter = indx[0] - (dim[0] + lb[0]) + 1; */
2633 : : /* dim[0] += addedafter; */
2634 [ + + + - ]: 2528 : if (pg_sub_s32_overflow(indx[0], dim[0] + lb[0], &addedafter) ||
2635 [ - + ]: 2524 : pg_add_s32_overflow(addedafter, 1, &addedafter) ||
2636 : 1262 : pg_add_s32_overflow(dim[0], addedafter, &dim[0]))
2637 [ + - ]: 4 : ereport(ERROR,
2638 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
2639 : : errmsg("array size exceeds the maximum allowed (%zu)",
2640 : : MaxArraySize)));
2641 : 1262 : dimschanged = true;
2642 [ - + ]: 1262 : if (addedafter > 1)
2643 : 0 : newhasnulls = true; /* will insert nulls */
2644 : : }
2645 : : }
2646 : : else
2647 : : {
2648 : : /*
2649 : : * XXX currently we do not support extending multi-dimensional arrays
2650 : : * during assignment
2651 : : */
2652 [ # # ]: 0 : for (i = 0; i < ndim; i++)
2653 : : {
2654 [ # # ]: 0 : if (indx[i] < lb[i] ||
2655 [ # # ]: 0 : indx[i] >= (dim[i] + lb[i]))
2656 [ # # ]: 0 : ereport(ERROR,
2657 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2658 : : errmsg("array subscript out of range")));
2659 : : }
2660 : : }
2661 : :
2662 : : /* Check for overflow of the array dimensions */
2663 [ + + ]: 1357 : if (dimschanged)
2664 : : {
2665 : 1325 : (void) ArrayGetNItems(ndim, dim);
2666 : 1325 : ArrayCheckBounds(ndim, dim, lb);
2667 : : }
2668 : :
2669 : : /* Now we can calculate linear offset of target item in array */
2670 : 1357 : offset = ArrayGetOffset(nSubscripts, dim, lb, indx);
2671 : :
2672 : : /* Physically enlarge existing dvalues/dnulls arrays if needed */
2673 [ + + ]: 1357 : if (dim[0] > eah->dvalueslen)
2674 : : {
2675 : : /* We want some extra space if we're enlarging */
2676 : 1317 : int newlen = dim[0] + dim[0] / 8;
2677 : :
2678 : 1317 : newlen = Max(newlen, dim[0]); /* integer overflow guard */
2679 : 1317 : eah->dvalues = dvalues = (Datum *)
2680 : 1317 : repalloc(dvalues, newlen * sizeof(Datum));
2681 [ - + ]: 1317 : if (dnulls)
2682 : 0 : eah->dnulls = dnulls = (bool *)
2683 : 0 : repalloc(dnulls, newlen * sizeof(bool));
2684 : 1317 : eah->dvalueslen = newlen;
2685 : : }
2686 : :
2687 : : /*
2688 : : * If we need a nulls bitmap and don't already have one, create it, being
2689 : : * sure to mark all existing entries as not null.
2690 : : */
2691 [ - + - - ]: 1357 : if (newhasnulls && dnulls == NULL)
2692 : 0 : eah->dnulls = dnulls = (bool *)
2693 : 0 : MemoryContextAllocZero(eah->hdr.eoh_context,
2694 : 0 : eah->dvalueslen * sizeof(bool));
2695 : :
2696 : : /*
2697 : : * We now have all the needed space allocated, so we're ready to make
2698 : : * irreversible changes. Be very wary of allowing failure below here.
2699 : : */
2700 : :
2701 : : /* Flattened value will no longer represent array accurately */
2702 : 1357 : eah->fvalue = NULL;
2703 : : /* And we don't know the flattened size either */
2704 : 1357 : eah->flat_size = 0;
2705 : :
2706 : : /* Update dimensionality info if needed */
2707 [ + + ]: 1357 : if (dimschanged)
2708 : : {
2709 : 1325 : eah->ndims = ndim;
2710 : 1325 : memcpy(eah->dims, dim, ndim * sizeof(int));
2711 : 1325 : memcpy(eah->lbound, lb, ndim * sizeof(int));
2712 : : }
2713 : :
2714 : : /* Reposition items if needed, and fill addedbefore items with nulls */
2715 [ + + ]: 1357 : if (addedbefore > 0)
2716 : : {
2717 : 63 : memmove(dvalues + addedbefore, dvalues, eah->nelems * sizeof(Datum));
2718 [ + + ]: 126 : for (i = 0; i < addedbefore; i++)
2719 : 63 : dvalues[i] = (Datum) 0;
2720 [ - + ]: 63 : if (dnulls)
2721 : : {
2722 : 0 : memmove(dnulls + addedbefore, dnulls, eah->nelems * sizeof(bool));
2723 [ # # ]: 0 : for (i = 0; i < addedbefore; i++)
2724 : 0 : dnulls[i] = true;
2725 : : }
2726 : 63 : eah->nelems += addedbefore;
2727 : : }
2728 : :
2729 : : /* fill addedafter items with nulls */
2730 [ + + ]: 1357 : if (addedafter > 0)
2731 : : {
2732 [ + + ]: 2524 : for (i = 0; i < addedafter; i++)
2733 : 1262 : dvalues[eah->nelems + i] = (Datum) 0;
2734 [ - + ]: 1262 : if (dnulls)
2735 : : {
2736 [ # # ]: 0 : for (i = 0; i < addedafter; i++)
2737 : 0 : dnulls[eah->nelems + i] = true;
2738 : : }
2739 : 1262 : eah->nelems += addedafter;
2740 : : }
2741 : :
2742 : : /* Grab old element value for pfree'ing, if needed. */
2743 [ + + - + : 1357 : if (!eah->typbyval && (dnulls == NULL || !dnulls[offset]))
- - ]
2744 : 587 : oldValue = (char *) DatumGetPointer(dvalues[offset]);
2745 : : else
2746 : 770 : oldValue = NULL;
2747 : :
2748 : : /* And finally we can insert the new element. */
2749 : 1357 : dvalues[offset] = dataValue;
2750 [ - + ]: 1357 : if (dnulls)
2751 : 0 : dnulls[offset] = isNull;
2752 : :
2753 : : /*
2754 : : * Free old element if needed; this keeps repeated element replacements
2755 : : * from bloating the array's storage. If the pfree somehow fails, it
2756 : : * won't corrupt the array.
2757 : : */
2758 [ + + ]: 1357 : if (oldValue)
2759 : : {
2760 : : /* Don't try to pfree a part of the original flat array */
2761 [ + - - + ]: 1 : if (oldValue < eah->fstartptr || oldValue >= eah->fendptr)
2762 : 0 : pfree(oldValue);
2763 : : }
2764 : :
2765 : : /* Done, return standard TOAST pointer for object */
2766 : 1357 : return EOHPGetRWDatum(&eah->hdr);
2767 : : }
2768 : :
2769 : : /*
2770 : : * array_set_slice :
2771 : : * This routine sets the value of a range of array locations (specified
2772 : : * by upper and lower subscript values) to new values passed as
2773 : : * another array.
2774 : : *
2775 : : * This handles both ordinary varlena arrays and fixed-length arrays.
2776 : : *
2777 : : * Inputs:
2778 : : * arraydatum: the initial array object (mustn't be NULL)
2779 : : * nSubscripts: number of subscripts supplied (must be same for upper/lower)
2780 : : * upperIndx[]: the upper subscript values
2781 : : * lowerIndx[]: the lower subscript values
2782 : : * upperProvided[]: true for provided upper subscript values
2783 : : * lowerProvided[]: true for provided lower subscript values
2784 : : * srcArrayDatum: the source for the inserted values
2785 : : * isNull: indicates whether srcArrayDatum is NULL
2786 : : * arraytyplen: pg_type.typlen for the array type
2787 : : * elmlen: pg_type.typlen for the array's element type
2788 : : * elmbyval: pg_type.typbyval for the array's element type
2789 : : * elmalign: pg_type.typalign for the array's element type
2790 : : *
2791 : : * Result:
2792 : : * A new array is returned, just like the old except for the
2793 : : * modified range. The original array object is not changed.
2794 : : *
2795 : : * Omitted upper and lower subscript values are replaced by the corresponding
2796 : : * array bound.
2797 : : *
2798 : : * For one-dimensional arrays only, we allow the array to be extended
2799 : : * by assigning to positions outside the existing subscript range; any
2800 : : * positions between the existing elements and the new ones are set to NULLs.
2801 : : * (XXX TODO: allow a corresponding behavior for multidimensional arrays)
2802 : : *
2803 : : * NOTE: we assume it is OK to scribble on the provided index arrays
2804 : : * lowerIndx[] and upperIndx[]; also, these arrays must be of size MAXDIM
2805 : : * even when nSubscripts is less. These are generally just temporaries.
2806 : : *
2807 : : * NOTE: For assignments, we throw an error for silly subscripts etc,
2808 : : * rather than returning a NULL or empty array as the fetch operations do.
2809 : : */
2810 : : Datum
2811 : 180 : array_set_slice(Datum arraydatum,
2812 : : int nSubscripts,
2813 : : int *upperIndx,
2814 : : int *lowerIndx,
2815 : : bool *upperProvided,
2816 : : bool *lowerProvided,
2817 : : Datum srcArrayDatum,
2818 : : bool isNull,
2819 : : int arraytyplen,
2820 : : int elmlen,
2821 : : bool elmbyval,
2822 : : char elmalign)
2823 : : {
2824 : : ArrayType *array;
2825 : : ArrayType *srcArray;
2826 : : ArrayType *newarray;
2827 : : int i,
2828 : : ndim,
2829 : : dim[MAXDIM],
2830 : : lb[MAXDIM],
2831 : : span[MAXDIM];
2832 : : bool newhasnulls;
2833 : : int nitems,
2834 : : nsrcitems,
2835 : : olddatasize,
2836 : : newsize,
2837 : : olditemsize,
2838 : : newitemsize,
2839 : : overheadlen,
2840 : : oldoverheadlen,
2841 : : addedbefore,
2842 : : addedafter,
2843 : : lenbefore,
2844 : : lenafter,
2845 : : itemsbefore,
2846 : : itemsafter,
2847 : : nolditems;
2848 : :
2849 : : /* Currently, assignment from a NULL source array is a no-op */
2850 [ - + ]: 180 : if (isNull)
2851 : 0 : return arraydatum;
2852 : :
2853 [ - + ]: 180 : if (arraytyplen > 0)
2854 : : {
2855 : : /*
2856 : : * fixed-length arrays -- not got round to doing this...
2857 : : */
2858 [ # # ]: 0 : ereport(ERROR,
2859 : : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2860 : : errmsg("updates on slices of fixed-length arrays not implemented")));
2861 : : }
2862 : :
2863 : : /* detoast arrays if necessary */
2864 : 180 : array = DatumGetArrayTypeP(arraydatum);
2865 : 180 : srcArray = DatumGetArrayTypeP(srcArrayDatum);
2866 : :
2867 : : /* note: we assume srcArray contains no toasted elements */
2868 : :
2869 : 180 : ndim = ARR_NDIM(array);
2870 : :
2871 : : /*
2872 : : * if number of dims is zero, i.e. an empty array, create an array with
2873 : : * nSubscripts dimensions, and set the upper and lower bounds to the
2874 : : * supplied subscripts
2875 : : */
2876 [ + + ]: 180 : if (ndim == 0)
2877 : : {
2878 : : Datum *dvalues;
2879 : : bool *dnulls;
2880 : : int nelems;
2881 : 43 : Oid elmtype = ARR_ELEMTYPE(array);
2882 : :
2883 : 43 : deconstruct_array(srcArray, elmtype, elmlen, elmbyval, elmalign,
2884 : : &dvalues, &dnulls, &nelems);
2885 : :
2886 [ + + ]: 89 : for (i = 0; i < nSubscripts; i++)
2887 : : {
2888 [ + + - + ]: 58 : if (!upperProvided[i] || !lowerProvided[i])
2889 [ + - ]: 4 : ereport(ERROR,
2890 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2891 : : errmsg("array slice subscript must provide both boundaries"),
2892 : : errdetail("When assigning to a slice of an empty array value,"
2893 : : " slice boundaries must be fully specified.")));
2894 : :
2895 : : /* compute "upperIndx[i] - lowerIndx[i] + 1", detecting overflow */
2896 [ + + + + ]: 104 : if (pg_sub_s32_overflow(upperIndx[i], lowerIndx[i], &dim[i]) ||
2897 : 50 : pg_add_s32_overflow(dim[i], 1, &dim[i]))
2898 [ + - ]: 8 : ereport(ERROR,
2899 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
2900 : : errmsg("array size exceeds the maximum allowed (%zu)",
2901 : : MaxArraySize)));
2902 : :
2903 : 46 : lb[i] = lowerIndx[i];
2904 : : }
2905 : :
2906 : : /* complain if too few source items; we ignore extras, however */
2907 [ - + ]: 31 : if (nelems < ArrayGetNItems(nSubscripts, dim))
2908 [ # # ]: 0 : ereport(ERROR,
2909 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2910 : : errmsg("source array too small")));
2911 : :
2912 : 31 : return PointerGetDatum(construct_md_array(dvalues, dnulls, nSubscripts,
2913 : : dim, lb, elmtype,
2914 : : elmlen, elmbyval, elmalign));
2915 : : }
2916 : :
2917 [ + - + - : 137 : if (ndim < nSubscripts || ndim <= 0 || ndim > MAXDIM)
- + ]
2918 [ # # ]: 0 : ereport(ERROR,
2919 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2920 : : errmsg("wrong number of array subscripts")));
2921 : :
2922 : : /* copy dim/lb since we may modify them */
2923 : 137 : memcpy(dim, ARR_DIMS(array), ndim * sizeof(int));
2924 : 137 : memcpy(lb, ARR_LBOUND(array), ndim * sizeof(int));
2925 : :
2926 [ + + - + ]: 137 : newhasnulls = (ARR_HASNULL(array) || ARR_HASNULL(srcArray));
2927 : 137 : addedbefore = addedafter = 0;
2928 : :
2929 : : /*
2930 : : * Check subscripts. We assume the existing subscripts passed
2931 : : * ArrayCheckBounds, so that dim[i] + lb[i] can be computed without
2932 : : * overflow. But we must beware of other overflows in our calculations of
2933 : : * new dim[] values.
2934 : : */
2935 [ + + ]: 137 : if (ndim == 1)
2936 : : {
2937 : : Assert(nSubscripts == 1);
2938 [ + + ]: 117 : if (!lowerProvided[0])
2939 : 24 : lowerIndx[0] = lb[0];
2940 [ + + ]: 117 : if (!upperProvided[0])
2941 : 28 : upperIndx[0] = dim[0] + lb[0] - 1;
2942 [ - + ]: 117 : if (lowerIndx[0] > upperIndx[0])
2943 [ # # ]: 0 : ereport(ERROR,
2944 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2945 : : errmsg("upper bound cannot be less than lower bound")));
2946 [ + + ]: 117 : if (lowerIndx[0] < lb[0])
2947 : : {
2948 : : /* addedbefore = lb[0] - lowerIndx[0]; */
2949 : : /* dim[0] += addedbefore; */
2950 [ + - - + ]: 64 : if (pg_sub_s32_overflow(lb[0], lowerIndx[0], &addedbefore) ||
2951 : 32 : pg_add_s32_overflow(dim[0], addedbefore, &dim[0]))
2952 [ # # ]: 0 : ereport(ERROR,
2953 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
2954 : : errmsg("array size exceeds the maximum allowed (%zu)",
2955 : : MaxArraySize)));
2956 : 32 : lb[0] = lowerIndx[0];
2957 [ + + ]: 32 : if (addedbefore > 1)
2958 : 24 : newhasnulls = true; /* will insert nulls */
2959 : : }
2960 [ + + ]: 117 : if (upperIndx[0] >= (dim[0] + lb[0]))
2961 : : {
2962 : : /* addedafter = upperIndx[0] - (dim[0] + lb[0]) + 1; */
2963 : : /* dim[0] += addedafter; */
2964 [ + + + - ]: 78 : if (pg_sub_s32_overflow(upperIndx[0], dim[0] + lb[0], &addedafter) ||
2965 [ - + ]: 74 : pg_add_s32_overflow(addedafter, 1, &addedafter) ||
2966 : 37 : pg_add_s32_overflow(dim[0], addedafter, &dim[0]))
2967 [ + - ]: 4 : ereport(ERROR,
2968 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
2969 : : errmsg("array size exceeds the maximum allowed (%zu)",
2970 : : MaxArraySize)));
2971 [ + + ]: 37 : if (addedafter > 1)
2972 : 24 : newhasnulls = true; /* will insert nulls */
2973 : : }
2974 : : }
2975 : : else
2976 : : {
2977 : : /*
2978 : : * XXX currently we do not support extending multi-dimensional arrays
2979 : : * during assignment
2980 : : */
2981 [ + + ]: 68 : for (i = 0; i < nSubscripts; i++)
2982 : : {
2983 [ + + ]: 48 : if (!lowerProvided[i])
2984 : 8 : lowerIndx[i] = lb[i];
2985 [ + + ]: 48 : if (!upperProvided[i])
2986 : 16 : upperIndx[i] = dim[i] + lb[i] - 1;
2987 [ - + ]: 48 : if (lowerIndx[i] > upperIndx[i])
2988 [ # # ]: 0 : ereport(ERROR,
2989 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2990 : : errmsg("upper bound cannot be less than lower bound")));
2991 [ + - ]: 48 : if (lowerIndx[i] < lb[i] ||
2992 [ - + ]: 48 : upperIndx[i] >= (dim[i] + lb[i]))
2993 [ # # ]: 0 : ereport(ERROR,
2994 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
2995 : : errmsg("array subscript out of range")));
2996 : : }
2997 : : /* fill any missing subscript positions with full array range */
2998 [ - + ]: 20 : for (; i < ndim; i++)
2999 : : {
3000 : 0 : lowerIndx[i] = lb[i];
3001 : 0 : upperIndx[i] = dim[i] + lb[i] - 1;
3002 [ # # ]: 0 : if (lowerIndx[i] > upperIndx[i])
3003 [ # # ]: 0 : ereport(ERROR,
3004 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
3005 : : errmsg("upper bound cannot be less than lower bound")));
3006 : : }
3007 : : }
3008 : :
3009 : : /* Do this mainly to check for overflow */
3010 : 133 : nitems = ArrayGetNItems(ndim, dim);
3011 : 133 : ArrayCheckBounds(ndim, dim, lb);
3012 : :
3013 : : /*
3014 : : * Make sure source array has enough entries. Note we ignore the shape of
3015 : : * the source array and just read entries serially.
3016 : : */
3017 : 133 : mda_get_range(ndim, span, lowerIndx, upperIndx);
3018 : 133 : nsrcitems = ArrayGetNItems(ndim, span);
3019 [ + + ]: 133 : if (nsrcitems > ArrayGetNItems(ARR_NDIM(srcArray), ARR_DIMS(srcArray)))
3020 [ + - ]: 4 : ereport(ERROR,
3021 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
3022 : : errmsg("source array too small")));
3023 : :
3024 : : /*
3025 : : * Compute space occupied by new entries, space occupied by replaced
3026 : : * entries, and required space for new array.
3027 : : */
3028 [ + + ]: 129 : if (newhasnulls)
3029 : 64 : overheadlen = ARR_OVERHEAD_WITHNULLS(ndim, nitems);
3030 : : else
3031 : 65 : overheadlen = ARR_OVERHEAD_NONULLS(ndim);
3032 [ + + ]: 129 : newitemsize = array_nelems_size(ARR_DATA_PTR(srcArray), 0,
3033 [ + + ]: 129 : ARR_NULLBITMAP(srcArray), nsrcitems,
3034 : : elmlen, elmbyval, elmalign);
3035 [ + + ]: 129 : oldoverheadlen = ARR_DATA_OFFSET(array);
3036 : 129 : olddatasize = ARR_SIZE(array) - oldoverheadlen;
3037 [ + + ]: 129 : if (ndim > 1)
3038 : : {
3039 : : /*
3040 : : * here we do not need to cope with extension of the array; it would
3041 : : * be a lot more complicated if we had to do so...
3042 : : */
3043 [ - + ]: 20 : olditemsize = array_slice_size(ARR_DATA_PTR(array),
3044 [ - + ]: 20 : ARR_NULLBITMAP(array),
3045 : : ndim, dim, lb,
3046 : : lowerIndx, upperIndx,
3047 : : elmlen, elmbyval, elmalign);
3048 : 20 : lenbefore = lenafter = 0; /* keep compiler quiet */
3049 : 20 : itemsbefore = itemsafter = nolditems = 0;
3050 : : }
3051 : : else
3052 : : {
3053 : : /*
3054 : : * here we must allow for possibility of slice larger than orig array
3055 : : * and/or not adjacent to orig array subscripts
3056 : : */
3057 : 109 : int oldlb = ARR_LBOUND(array)[0];
3058 : 109 : int oldub = oldlb + ARR_DIMS(array)[0] - 1;
3059 : 109 : int slicelb = Max(oldlb, lowerIndx[0]);
3060 : 109 : int sliceub = Min(oldub, upperIndx[0]);
3061 [ + + ]: 109 : char *oldarraydata = ARR_DATA_PTR(array);
3062 [ + + ]: 109 : uint8 *oldarraybitmap = ARR_NULLBITMAP(array);
3063 : :
3064 : : /* count/size of old array entries that will go before the slice */
3065 : 109 : itemsbefore = Min(slicelb, oldub + 1) - oldlb;
3066 : 109 : lenbefore = array_nelems_size(oldarraydata, 0, oldarraybitmap,
3067 : : itemsbefore,
3068 : : elmlen, elmbyval, elmalign);
3069 : : /* count/size of old array entries that will be replaced by slice */
3070 [ + + ]: 109 : if (slicelb > sliceub)
3071 : : {
3072 : 36 : nolditems = 0;
3073 : 36 : olditemsize = 0;
3074 : : }
3075 : : else
3076 : : {
3077 : 73 : nolditems = sliceub - slicelb + 1;
3078 : 73 : olditemsize = array_nelems_size(oldarraydata + lenbefore,
3079 : : itemsbefore, oldarraybitmap,
3080 : : nolditems,
3081 : : elmlen, elmbyval, elmalign);
3082 : : }
3083 : : /* count/size of old array entries that will go after the slice */
3084 : 109 : itemsafter = oldub + 1 - Max(sliceub + 1, oldlb);
3085 : 109 : lenafter = olddatasize - lenbefore - olditemsize;
3086 : : }
3087 : :
3088 : 129 : newsize = overheadlen + olddatasize - olditemsize + newitemsize;
3089 : :
3090 : 129 : newarray = (ArrayType *) palloc0(newsize);
3091 : 129 : SET_VARSIZE(newarray, newsize);
3092 : 129 : newarray->ndim = ndim;
3093 [ + + ]: 129 : newarray->dataoffset = newhasnulls ? overheadlen : 0;
3094 : 129 : newarray->elemtype = ARR_ELEMTYPE(array);
3095 : 129 : memcpy(ARR_DIMS(newarray), dim, ndim * sizeof(int));
3096 : 129 : memcpy(ARR_LBOUND(newarray), lb, ndim * sizeof(int));
3097 : :
3098 [ + + ]: 129 : if (ndim > 1)
3099 : : {
3100 : : /*
3101 : : * here we do not need to cope with extension of the array; it would
3102 : : * be a lot more complicated if we had to do so...
3103 : : */
3104 : 20 : array_insert_slice(newarray, array, srcArray,
3105 : : ndim, dim, lb,
3106 : : lowerIndx, upperIndx,
3107 : : elmlen, elmbyval, elmalign);
3108 : : }
3109 : : else
3110 : : {
3111 : : /* fill in data */
3112 : 109 : memcpy((char *) newarray + overheadlen,
3113 : : (char *) array + oldoverheadlen,
3114 : : lenbefore);
3115 : 218 : memcpy((char *) newarray + overheadlen + lenbefore,
3116 [ + + ]: 109 : ARR_DATA_PTR(srcArray),
3117 : : newitemsize);
3118 : 109 : memcpy((char *) newarray + overheadlen + lenbefore + newitemsize,
3119 : 109 : (char *) array + oldoverheadlen + lenbefore + olditemsize,
3120 : : lenafter);
3121 : : /* fill in nulls bitmap if needed */
3122 [ + + ]: 109 : if (newhasnulls)
3123 : : {
3124 [ + - ]: 64 : uint8 *newnullbitmap = ARR_NULLBITMAP(newarray);
3125 [ + - ]: 64 : uint8 *oldnullbitmap = ARR_NULLBITMAP(array);
3126 : :
3127 : : /* palloc0 above already marked any inserted positions as nulls */
3128 : 64 : array_bitmap_copy(newnullbitmap, addedbefore,
3129 : : oldnullbitmap, 0,
3130 : : itemsbefore);
3131 : 64 : array_bitmap_copy(newnullbitmap, lowerIndx[0] - lb[0],
3132 [ + + ]: 64 : ARR_NULLBITMAP(srcArray), 0,
3133 : : nsrcitems);
3134 : 64 : array_bitmap_copy(newnullbitmap, addedbefore + itemsbefore + nolditems,
3135 : : oldnullbitmap, itemsbefore + nolditems,
3136 : : itemsafter);
3137 : : }
3138 : : }
3139 : :
3140 : 129 : return PointerGetDatum(newarray);
3141 : : }
3142 : :
3143 : : /*
3144 : : * array_ref : backwards compatibility wrapper for array_get_element
3145 : : *
3146 : : * This only works for detoasted/flattened varlena arrays, since the array
3147 : : * argument is declared as "ArrayType *". However there's enough code like
3148 : : * that to justify preserving this API.
3149 : : */
3150 : : Datum
3151 : 28726 : array_ref(ArrayType *array, int nSubscripts, int *indx,
3152 : : int arraytyplen, int elmlen, bool elmbyval, char elmalign,
3153 : : bool *isNull)
3154 : : {
3155 : 28726 : return array_get_element(PointerGetDatum(array), nSubscripts, indx,
3156 : : arraytyplen, elmlen, elmbyval, elmalign,
3157 : : isNull);
3158 : : }
3159 : :
3160 : : /*
3161 : : * array_set : backwards compatibility wrapper for array_set_element
3162 : : *
3163 : : * This only works for detoasted/flattened varlena arrays, since the array
3164 : : * argument and result are declared as "ArrayType *". However there's enough
3165 : : * code like that to justify preserving this API.
3166 : : */
3167 : : ArrayType *
3168 : 606 : array_set(ArrayType *array, int nSubscripts, int *indx,
3169 : : Datum dataValue, bool isNull,
3170 : : int arraytyplen, int elmlen, bool elmbyval, char elmalign)
3171 : : {
3172 : 606 : return DatumGetArrayTypeP(array_set_element(PointerGetDatum(array),
3173 : : nSubscripts, indx,
3174 : : dataValue, isNull,
3175 : : arraytyplen,
3176 : : elmlen, elmbyval, elmalign));
3177 : : }
3178 : :
3179 : : /*
3180 : : * array_map()
3181 : : *
3182 : : * Map an array through an arbitrary expression. Return a new array with
3183 : : * the same dimensions and each source element transformed by the given,
3184 : : * already-compiled expression. Each source element is placed in the
3185 : : * innermost_caseval/innermost_casenull fields of the ExprState.
3186 : : *
3187 : : * Parameters are:
3188 : : * * arrayd: Datum representing array argument.
3189 : : * * exprstate: ExprState representing the per-element transformation.
3190 : : * * econtext: context for expression evaluation.
3191 : : * * retType: OID of element type of output array. This must be the same as,
3192 : : * or binary-compatible with, the result type of the expression. It might
3193 : : * be different from the input array's element type.
3194 : : * * amstate: workspace for array_map. Must be zeroed by caller before
3195 : : * first call, and not touched after that.
3196 : : *
3197 : : * It is legitimate to pass a freshly-zeroed ArrayMapState on each call,
3198 : : * but better performance can be had if the state can be preserved across
3199 : : * a series of calls.
3200 : : *
3201 : : * NB: caller must assure that input array is not NULL. NULL elements in
3202 : : * the array are OK however.
3203 : : * NB: caller should be running in econtext's per-tuple memory context.
3204 : : */
3205 : : Datum
3206 : 20619 : array_map(Datum arrayd,
3207 : : ExprState *exprstate, ExprContext *econtext,
3208 : : Oid retType, ArrayMapState *amstate)
3209 : : {
3210 : 20619 : AnyArrayType *v = DatumGetAnyArrayP(arrayd);
3211 : : ArrayType *result;
3212 : : Datum *values;
3213 : : bool *nulls;
3214 : : int *dim;
3215 : : int ndim;
3216 : : int nitems;
3217 : : int i;
3218 : 20619 : int32 nbytes = 0;
3219 : : int32 dataoffset;
3220 : : bool hasnulls;
3221 : : Oid inpType;
3222 : : int inp_typlen;
3223 : : bool inp_typbyval;
3224 : : char inp_typalign;
3225 : : int typlen;
3226 : : bool typbyval;
3227 : : char typalign;
3228 : : uint8 typalignby;
3229 : : array_iter iter;
3230 : : ArrayMetaState *inp_extra;
3231 : : ArrayMetaState *ret_extra;
3232 : 20619 : Datum *transform_source = exprstate->innermost_caseval;
3233 : 20619 : bool *transform_source_isnull = exprstate->innermost_casenull;
3234 : :
3235 [ - + ]: 20619 : inpType = AARR_ELEMTYPE(v);
3236 [ - + ]: 20619 : ndim = AARR_NDIM(v);
3237 [ - + ]: 20619 : dim = AARR_DIMS(v);
3238 : 20619 : nitems = ArrayGetNItems(ndim, dim);
3239 : :
3240 : : /* Check for empty array */
3241 [ + + ]: 20619 : if (nitems <= 0)
3242 : : {
3243 : : /* Return empty array */
3244 : 10 : return PointerGetDatum(construct_empty_array(retType));
3245 : : }
3246 : :
3247 : : /*
3248 : : * We arrange to look up info about input and return element types only
3249 : : * once per series of calls, assuming the element type doesn't change
3250 : : * underneath us.
3251 : : */
3252 : 20609 : inp_extra = &amstate->inp_extra;
3253 : 20609 : ret_extra = &amstate->ret_extra;
3254 : :
3255 [ + + ]: 20609 : if (inp_extra->element_type != inpType)
3256 : : {
3257 : 309 : get_typlenbyvalalign(inpType,
3258 : : &inp_extra->typlen,
3259 : : &inp_extra->typbyval,
3260 : : &inp_extra->typalign);
3261 : 309 : inp_extra->element_type = inpType;
3262 : : }
3263 : 20609 : inp_typlen = inp_extra->typlen;
3264 : 20609 : inp_typbyval = inp_extra->typbyval;
3265 : 20609 : inp_typalign = inp_extra->typalign;
3266 : :
3267 [ + + ]: 20609 : if (ret_extra->element_type != retType)
3268 : : {
3269 : 309 : get_typlenbyvalalign(retType,
3270 : : &ret_extra->typlen,
3271 : : &ret_extra->typbyval,
3272 : : &ret_extra->typalign);
3273 : 309 : ret_extra->element_type = retType;
3274 : : }
3275 : 20609 : typlen = ret_extra->typlen;
3276 : 20609 : typbyval = ret_extra->typbyval;
3277 : 20609 : typalign = ret_extra->typalign;
3278 : 20609 : typalignby = typalign_to_alignby(typalign);
3279 : :
3280 : : /* Allocate temporary arrays for new values */
3281 : 20609 : values = (Datum *) palloc(nitems * sizeof(Datum));
3282 : 20609 : nulls = (bool *) palloc(nitems * sizeof(bool));
3283 : :
3284 : : /* Loop over source data */
3285 : 20609 : array_iter_setup(&iter, v, inp_typlen, inp_typbyval, inp_typalign);
3286 : 20609 : hasnulls = false;
3287 : :
3288 [ + + ]: 231617 : for (i = 0; i < nitems; i++)
3289 : : {
3290 : : /* Get source element, checking for NULL */
3291 : 211028 : *transform_source =
3292 : 211028 : array_iter_next(&iter, transform_source_isnull, i);
3293 : :
3294 : : /* Apply the given expression to source element */
3295 : 211028 : values[i] = ExecEvalExpr(exprstate, econtext, &nulls[i]);
3296 : :
3297 [ + + ]: 211008 : if (nulls[i])
3298 : 10 : hasnulls = true;
3299 : : else
3300 : : {
3301 : : /* Ensure data is not toasted */
3302 [ + + ]: 210998 : if (typlen == -1)
3303 : 341 : values[i] = PointerGetDatum(PG_DETOAST_DATUM(values[i]));
3304 : : /* Update total result size */
3305 [ + + + - ]: 210998 : nbytes = att_addlength_datum(nbytes, typlen, values[i]);
3306 : 210998 : nbytes = att_nominal_alignby(nbytes, typalignby);
3307 : : /* check for overflow of total request */
3308 [ - + ]: 210998 : if (!AllocSizeIsValid(nbytes))
3309 [ # # ]: 0 : ereport(ERROR,
3310 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
3311 : : errmsg("array size exceeds the maximum allowed (%zu)",
3312 : : MaxAllocSize)));
3313 : : }
3314 : : }
3315 : :
3316 : : /* Allocate and fill the result array */
3317 [ + + ]: 20589 : if (hasnulls)
3318 : : {
3319 : 5 : dataoffset = ARR_OVERHEAD_WITHNULLS(ndim, nitems);
3320 : 5 : nbytes += dataoffset;
3321 : : }
3322 : : else
3323 : : {
3324 : 20584 : dataoffset = 0; /* marker for no null bitmap */
3325 : 20584 : nbytes += ARR_OVERHEAD_NONULLS(ndim);
3326 : : }
3327 : 20589 : result = (ArrayType *) palloc0(nbytes);
3328 : 20589 : SET_VARSIZE(result, nbytes);
3329 : 20589 : result->ndim = ndim;
3330 : 20589 : result->dataoffset = dataoffset;
3331 : 20589 : result->elemtype = retType;
3332 [ - + ]: 20589 : memcpy(ARR_DIMS(result), AARR_DIMS(v), ndim * sizeof(int));
3333 [ - + ]: 20589 : memcpy(ARR_LBOUND(result), AARR_LBOUND(v), ndim * sizeof(int));
3334 : :
3335 : 20589 : CopyArrayEls(result,
3336 : : values, nulls, nitems,
3337 : : typlen, typbyval, typalign,
3338 : : false);
3339 : :
3340 : : /*
3341 : : * Note: do not risk trying to pfree the results of the called expression
3342 : : */
3343 : 20589 : pfree(values);
3344 : 20589 : pfree(nulls);
3345 : :
3346 : 20589 : return PointerGetDatum(result);
3347 : : }
3348 : :
3349 : : /*
3350 : : * construct_array --- simple method for constructing an array object
3351 : : *
3352 : : * elems: array of Datum items to become the array contents
3353 : : * (NULL element values are not supported).
3354 : : * nelems: number of items
3355 : : * elmtype, elmlen, elmbyval, elmalign: info for the datatype of the items
3356 : : *
3357 : : * A palloc'd 1-D array object is constructed and returned. Note that
3358 : : * elem values will be copied into the object even if pass-by-ref type.
3359 : : * Also note the result will be 0-D not 1-D if nelems = 0.
3360 : : *
3361 : : * NOTE: it would be cleaner to look up the elmlen/elmbval/elmalign info
3362 : : * from the system catalogs, given the elmtype. However, the caller is
3363 : : * in a better position to cache this info across multiple uses, or even
3364 : : * to hard-wire values if the element type is hard-wired.
3365 : : */
3366 : : ArrayType *
3367 : 220854 : construct_array(Datum *elems, int nelems,
3368 : : Oid elmtype,
3369 : : int elmlen, bool elmbyval, char elmalign)
3370 : : {
3371 : : int dims[1];
3372 : : int lbs[1];
3373 : :
3374 : 220854 : dims[0] = nelems;
3375 : 220854 : lbs[0] = 1;
3376 : :
3377 : 220854 : return construct_md_array(elems, NULL, 1, dims, lbs,
3378 : : elmtype, elmlen, elmbyval, elmalign);
3379 : : }
3380 : :
3381 : : /*
3382 : : * Like construct_array(), where elmtype must be a built-in type, and
3383 : : * elmlen/elmbyval/elmalign is looked up from hardcoded data. This is often
3384 : : * useful when manipulating arrays from/for system catalogs.
3385 : : */
3386 : : ArrayType *
3387 : 153171 : construct_array_builtin(Datum *elems, int nelems, Oid elmtype)
3388 : : {
3389 : : int elmlen;
3390 : : bool elmbyval;
3391 : : char elmalign;
3392 : :
3393 [ + + + + : 153171 : switch (elmtype)
+ + + + +
+ + + - ]
3394 : : {
3395 : 1901 : case CHAROID:
3396 : 1901 : elmlen = 1;
3397 : 1901 : elmbyval = true;
3398 : 1901 : elmalign = TYPALIGN_CHAR;
3399 : 1901 : break;
3400 : :
3401 : 5354 : case CSTRINGOID:
3402 : 5354 : elmlen = -2;
3403 : 5354 : elmbyval = false;
3404 : 5354 : elmalign = TYPALIGN_CHAR;
3405 : 5354 : break;
3406 : :
3407 : 82651 : case FLOAT4OID:
3408 : 82651 : elmlen = sizeof(float4);
3409 : 82651 : elmbyval = true;
3410 : 82651 : elmalign = TYPALIGN_INT;
3411 : 82651 : break;
3412 : :
3413 : 40 : case FLOAT8OID:
3414 : 40 : elmlen = sizeof(float8);
3415 : 40 : elmbyval = true;
3416 : 40 : elmalign = TYPALIGN_DOUBLE;
3417 : 40 : break;
3418 : :
3419 : 39398 : case INT2OID:
3420 : 39398 : elmlen = sizeof(int16);
3421 : 39398 : elmbyval = true;
3422 : 39398 : elmalign = TYPALIGN_SHORT;
3423 : 39398 : break;
3424 : :
3425 : 4246 : case INT4OID:
3426 : 4246 : elmlen = sizeof(int32);
3427 : 4246 : elmbyval = true;
3428 : 4246 : elmalign = TYPALIGN_INT;
3429 : 4246 : break;
3430 : :
3431 : 2 : case INT8OID:
3432 : 2 : elmlen = sizeof(int64);
3433 : 2 : elmbyval = true;
3434 : 2 : elmalign = TYPALIGN_DOUBLE;
3435 : 2 : break;
3436 : :
3437 : 404 : case NAMEOID:
3438 : 404 : elmlen = NAMEDATALEN;
3439 : 404 : elmbyval = false;
3440 : 404 : elmalign = TYPALIGN_CHAR;
3441 : 404 : break;
3442 : :
3443 : 12126 : case OIDOID:
3444 : : case REGTYPEOID:
3445 : 12126 : elmlen = sizeof(Oid);
3446 : 12126 : elmbyval = true;
3447 : 12126 : elmalign = TYPALIGN_INT;
3448 : 12126 : break;
3449 : :
3450 : 7026 : case TEXTOID:
3451 : 7026 : elmlen = -1;
3452 : 7026 : elmbyval = false;
3453 : 7026 : elmalign = TYPALIGN_INT;
3454 : 7026 : break;
3455 : :
3456 : 21 : case TIDOID:
3457 : 21 : elmlen = sizeof(ItemPointerData);
3458 : 21 : elmbyval = false;
3459 : 21 : elmalign = TYPALIGN_SHORT;
3460 : 21 : break;
3461 : :
3462 : 2 : case XIDOID:
3463 : 2 : elmlen = sizeof(TransactionId);
3464 : 2 : elmbyval = true;
3465 : 2 : elmalign = TYPALIGN_INT;
3466 : 2 : break;
3467 : :
3468 : 0 : default:
3469 [ # # ]: 0 : elog(ERROR, "type %u not supported by construct_array_builtin()", elmtype);
3470 : : /* keep compiler quiet */
3471 : : elmlen = 0;
3472 : : elmbyval = false;
3473 : : elmalign = 0;
3474 : : }
3475 : :
3476 : 153171 : return construct_array(elems, nelems, elmtype, elmlen, elmbyval, elmalign);
3477 : : }
3478 : :
3479 : : /*
3480 : : * construct_md_array --- simple method for constructing an array object
3481 : : * with arbitrary dimensions and possible NULLs
3482 : : *
3483 : : * elems: array of Datum items to become the array contents
3484 : : * nulls: array of is-null flags (can be NULL if no nulls)
3485 : : * ndims: number of dimensions
3486 : : * dims: integer array with size of each dimension
3487 : : * lbs: integer array with lower bound of each dimension
3488 : : * elmtype, elmlen, elmbyval, elmalign: info for the datatype of the items
3489 : : *
3490 : : * A palloc'd ndims-D array object is constructed and returned. Note that
3491 : : * elem values will be copied into the object even if pass-by-ref type.
3492 : : * Also note the result will be 0-D not ndims-D if any dims[i] = 0.
3493 : : *
3494 : : * NOTE: it would be cleaner to look up the elmlen/elmbval/elmalign info
3495 : : * from the system catalogs, given the elmtype. However, the caller is
3496 : : * in a better position to cache this info across multiple uses, or even
3497 : : * to hard-wire values if the element type is hard-wired.
3498 : : */
3499 : : ArrayType *
3500 : 1024783 : construct_md_array(Datum *elems,
3501 : : bool *nulls,
3502 : : int ndims,
3503 : : int *dims,
3504 : : int *lbs,
3505 : : Oid elmtype, int elmlen, bool elmbyval, char elmalign)
3506 : : {
3507 : : ArrayType *result;
3508 : : bool hasnulls;
3509 : : int32 nbytes;
3510 : : int32 dataoffset;
3511 : : int i;
3512 : : int nelems;
3513 : 1024783 : uint8 elmalignby = typalign_to_alignby(elmalign);
3514 : :
3515 [ - + ]: 1024783 : if (ndims < 0) /* we do allow zero-dimension arrays */
3516 [ # # ]: 0 : ereport(ERROR,
3517 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3518 : : errmsg("invalid number of dimensions: %d", ndims)));
3519 [ - + ]: 1024783 : if (ndims > MAXDIM)
3520 [ # # ]: 0 : ereport(ERROR,
3521 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
3522 : : errmsg("number of array dimensions (%d) exceeds the maximum allowed (%d)",
3523 : : ndims, MAXDIM)));
3524 : :
3525 : : /* This checks for overflow of the array dimensions */
3526 : 1024783 : nelems = ArrayGetNItems(ndims, dims);
3527 : 1024783 : ArrayCheckBounds(ndims, dims, lbs);
3528 : :
3529 : : /* if ndims <= 0 or any dims[i] == 0, return empty array */
3530 [ + + ]: 1024783 : if (nelems <= 0)
3531 : 31318 : return construct_empty_array(elmtype);
3532 : :
3533 : : /* compute required space */
3534 : 993465 : nbytes = 0;
3535 : 993465 : hasnulls = false;
3536 [ + + ]: 7547641 : for (i = 0; i < nelems; i++)
3537 : : {
3538 [ + + + + ]: 6554176 : if (nulls && nulls[i])
3539 : : {
3540 : 22181 : hasnulls = true;
3541 : 22181 : continue;
3542 : : }
3543 : : /* make sure data is not toasted */
3544 [ + + ]: 6531995 : if (elmlen == -1)
3545 : 1566833 : elems[i] = PointerGetDatum(PG_DETOAST_DATUM(elems[i]));
3546 [ + + + + ]: 6531995 : nbytes = att_addlength_datum(nbytes, elmlen, elems[i]);
3547 : 6531995 : nbytes = att_nominal_alignby(nbytes, elmalignby);
3548 : : /* check for overflow of total request */
3549 [ - + ]: 6531995 : if (!AllocSizeIsValid(nbytes))
3550 [ # # ]: 0 : ereport(ERROR,
3551 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
3552 : : errmsg("array size exceeds the maximum allowed (%zu)",
3553 : : MaxAllocSize)));
3554 : : }
3555 : :
3556 : : /* Allocate and initialize result array */
3557 [ + + ]: 993465 : if (hasnulls)
3558 : : {
3559 : 11982 : dataoffset = ARR_OVERHEAD_WITHNULLS(ndims, nelems);
3560 : 11982 : nbytes += dataoffset;
3561 : : }
3562 : : else
3563 : : {
3564 : 981483 : dataoffset = 0; /* marker for no null bitmap */
3565 : 981483 : nbytes += ARR_OVERHEAD_NONULLS(ndims);
3566 : : }
3567 : 993465 : result = (ArrayType *) palloc0(nbytes);
3568 : 993465 : SET_VARSIZE(result, nbytes);
3569 : 993465 : result->ndim = ndims;
3570 : 993465 : result->dataoffset = dataoffset;
3571 : 993465 : result->elemtype = elmtype;
3572 : 993465 : memcpy(ARR_DIMS(result), dims, ndims * sizeof(int));
3573 : 993465 : memcpy(ARR_LBOUND(result), lbs, ndims * sizeof(int));
3574 : :
3575 : 993465 : CopyArrayEls(result,
3576 : : elems, nulls, nelems,
3577 : : elmlen, elmbyval, elmalign,
3578 : : false);
3579 : :
3580 : 993465 : return result;
3581 : : }
3582 : :
3583 : : /*
3584 : : * construct_empty_array --- make a zero-dimensional array of given type
3585 : : */
3586 : : ArrayType *
3587 : 1444111 : construct_empty_array(Oid elmtype)
3588 : : {
3589 : : ArrayType *result;
3590 : :
3591 : 1444111 : result = palloc0_object(ArrayType);
3592 : 1444111 : SET_VARSIZE(result, sizeof(ArrayType));
3593 : 1444111 : result->ndim = 0;
3594 : 1444111 : result->dataoffset = 0;
3595 : 1444111 : result->elemtype = elmtype;
3596 : 1444111 : return result;
3597 : : }
3598 : :
3599 : : /*
3600 : : * construct_empty_expanded_array: make an empty expanded array
3601 : : * given only type information. (metacache can be NULL if not needed.)
3602 : : */
3603 : : ExpandedArrayHeader *
3604 : 17 : construct_empty_expanded_array(Oid element_type,
3605 : : MemoryContext parentcontext,
3606 : : ArrayMetaState *metacache)
3607 : : {
3608 : 17 : ArrayType *array = construct_empty_array(element_type);
3609 : : Datum d;
3610 : :
3611 : 17 : d = expand_array(PointerGetDatum(array), parentcontext, metacache);
3612 : 17 : pfree(array);
3613 : 17 : return (ExpandedArrayHeader *) DatumGetEOHP(d);
3614 : : }
3615 : :
3616 : : /*
3617 : : * deconstruct_array --- simple method for extracting data from an array
3618 : : *
3619 : : * array: array object to examine (must not be NULL)
3620 : : * elmtype, elmlen, elmbyval, elmalign: info for the datatype of the items
3621 : : * elemsp: return value, set to point to palloc'd array of Datum values
3622 : : * nullsp: return value, set to point to palloc'd array of isnull markers
3623 : : * nelemsp: return value, set to number of extracted values
3624 : : *
3625 : : * The caller may pass nullsp == NULL if it does not support NULLs in the
3626 : : * array. Note that this produces a very uninformative error message,
3627 : : * so do it only in cases where a NULL is really not expected.
3628 : : *
3629 : : * If array elements are pass-by-ref data type, the returned Datums will
3630 : : * be pointers into the array object.
3631 : : *
3632 : : * NOTE: it would be cleaner to look up the elmlen/elmbval/elmalign info
3633 : : * from the system catalogs, given the elmtype. However, the caller is
3634 : : * in a better position to cache this info across multiple uses, or even
3635 : : * to hard-wire values if the element type is hard-wired.
3636 : : */
3637 : : void
3638 : 1985849 : deconstruct_array(const ArrayType *array,
3639 : : Oid elmtype,
3640 : : int elmlen, bool elmbyval, char elmalign,
3641 : : Datum **elemsp, bool **nullsp, int *nelemsp)
3642 : : {
3643 : : Datum *elems;
3644 : : bool *nulls;
3645 : : int nelems;
3646 : : char *p;
3647 : : uint8 *bitmap;
3648 : : int bitmask;
3649 : : int i;
3650 : 1985849 : uint8 elmalignby = typalign_to_alignby(elmalign);
3651 : :
3652 : : Assert(ARR_ELEMTYPE(array) == elmtype);
3653 : :
3654 : 1985849 : nelems = ArrayGetNItems(ARR_NDIM(array), ARR_DIMS(array));
3655 : 1985849 : *elemsp = elems = palloc_array(Datum, nelems);
3656 [ + + ]: 1985849 : if (nullsp)
3657 : 1138787 : *nullsp = nulls = palloc0_array(bool, nelems);
3658 : : else
3659 : 847062 : nulls = NULL;
3660 : 1985849 : *nelemsp = nelems;
3661 : :
3662 [ + + ]: 1985849 : p = ARR_DATA_PTR(array);
3663 [ + + ]: 1985849 : bitmap = ARR_NULLBITMAP(array);
3664 : 1985849 : bitmask = 1;
3665 : :
3666 [ + + ]: 33667613 : for (i = 0; i < nelems; i++)
3667 : : {
3668 : : /* Get source element, checking for NULL */
3669 [ + + + + ]: 31681764 : if (bitmap && (*bitmap & bitmask) == 0)
3670 : : {
3671 : 2386 : elems[i] = (Datum) 0;
3672 [ + - ]: 2386 : if (nulls)
3673 : 2386 : nulls[i] = true;
3674 : : else
3675 [ # # ]: 0 : ereport(ERROR,
3676 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
3677 : : errmsg("null array element not allowed in this context")));
3678 : : }
3679 : : else
3680 : : {
3681 : 31679378 : elems[i] = fetch_att(p, elmbyval, elmlen);
3682 [ + + + + ]: 31679378 : p = att_addlength_pointer(p, elmlen, p);
3683 : 31679378 : p = (char *) att_nominal_alignby(p, elmalignby);
3684 : : }
3685 : :
3686 : : /* advance bitmap pointer if any */
3687 [ + + ]: 31681764 : if (bitmap)
3688 : : {
3689 : 3771 : bitmask <<= 1;
3690 [ + + ]: 3771 : if (bitmask == 0x100)
3691 : : {
3692 : 52 : bitmap++;
3693 : 52 : bitmask = 1;
3694 : : }
3695 : : }
3696 : : }
3697 : 1985849 : }
3698 : :
3699 : : /*
3700 : : * Like deconstruct_array(), where elmtype must be a built-in type, and
3701 : : * elmlen/elmbyval/elmalign is looked up from hardcoded data. This is often
3702 : : * useful when manipulating arrays from/for system catalogs.
3703 : : */
3704 : : void
3705 : 305115 : deconstruct_array_builtin(const ArrayType *array,
3706 : : Oid elmtype,
3707 : : Datum **elemsp, bool **nullsp, int *nelemsp)
3708 : : {
3709 : : int elmlen;
3710 : : bool elmbyval;
3711 : : char elmalign;
3712 : :
3713 [ + + + + : 305115 : switch (elmtype)
+ + + +
- ]
3714 : : {
3715 : 14 : case CHAROID:
3716 : 14 : elmlen = 1;
3717 : 14 : elmbyval = true;
3718 : 14 : elmalign = TYPALIGN_CHAR;
3719 : 14 : break;
3720 : :
3721 : 7748 : case CSTRINGOID:
3722 : 7748 : elmlen = -2;
3723 : 7748 : elmbyval = false;
3724 : 7748 : elmalign = TYPALIGN_CHAR;
3725 : 7748 : break;
3726 : :
3727 : 20 : case FLOAT8OID:
3728 : 20 : elmlen = sizeof(float8);
3729 : 20 : elmbyval = true;
3730 : 20 : elmalign = TYPALIGN_DOUBLE;
3731 : 20 : break;
3732 : :
3733 : 10871 : case INT2OID:
3734 : 10871 : elmlen = sizeof(int16);
3735 : 10871 : elmbyval = true;
3736 : 10871 : elmalign = TYPALIGN_SHORT;
3737 : 10871 : break;
3738 : :
3739 : 200 : case INT4OID:
3740 : 200 : elmlen = sizeof(int32);
3741 : 200 : elmbyval = true;
3742 : 200 : elmalign = TYPALIGN_INT;
3743 : 200 : break;
3744 : :
3745 : 3124 : case OIDOID:
3746 : 3124 : elmlen = sizeof(Oid);
3747 : 3124 : elmbyval = true;
3748 : 3124 : elmalign = TYPALIGN_INT;
3749 : 3124 : break;
3750 : :
3751 : 283109 : case TEXTOID:
3752 : 283109 : elmlen = -1;
3753 : 283109 : elmbyval = false;
3754 : 283109 : elmalign = TYPALIGN_INT;
3755 : 283109 : break;
3756 : :
3757 : 29 : case TIDOID:
3758 : 29 : elmlen = sizeof(ItemPointerData);
3759 : 29 : elmbyval = false;
3760 : 29 : elmalign = TYPALIGN_SHORT;
3761 : 29 : break;
3762 : :
3763 : 0 : default:
3764 [ # # ]: 0 : elog(ERROR, "type %u not supported by deconstruct_array_builtin()", elmtype);
3765 : : /* keep compiler quiet */
3766 : : elmlen = 0;
3767 : : elmbyval = false;
3768 : : elmalign = 0;
3769 : : }
3770 : :
3771 : 305115 : deconstruct_array(array, elmtype, elmlen, elmbyval, elmalign, elemsp, nullsp, nelemsp);
3772 : 305115 : }
3773 : :
3774 : : /*
3775 : : * array_contains_nulls --- detect whether an array has any null elements
3776 : : *
3777 : : * This gives an accurate answer, whereas testing ARR_HASNULL only tells
3778 : : * if the array *might* contain a null.
3779 : : */
3780 : : bool
3781 : 40018 : array_contains_nulls(const ArrayType *array)
3782 : : {
3783 : : int nelems;
3784 : : uint8 *bitmap;
3785 : : int bitmask;
3786 : :
3787 : : /* Easy answer if there's no null bitmap */
3788 [ + + ]: 40018 : if (!ARR_HASNULL(array))
3789 : 39966 : return false;
3790 : :
3791 : 52 : nelems = ArrayGetNItems(ARR_NDIM(array), ARR_DIMS(array));
3792 : :
3793 [ + - ]: 52 : bitmap = ARR_NULLBITMAP(array);
3794 : :
3795 : : /* check whole bytes of the bitmap byte-at-a-time */
3796 [ + + ]: 52 : while (nelems >= 8)
3797 : : {
3798 [ + - ]: 14 : if (*bitmap != 0xFF)
3799 : 14 : return true;
3800 : 0 : bitmap++;
3801 : 0 : nelems -= 8;
3802 : : }
3803 : :
3804 : : /* check last partial byte */
3805 : 38 : bitmask = 1;
3806 [ + - ]: 93 : while (nelems > 0)
3807 : : {
3808 [ + + ]: 93 : if ((*bitmap & bitmask) == 0)
3809 : 38 : return true;
3810 : 55 : bitmask <<= 1;
3811 : 55 : nelems--;
3812 : : }
3813 : :
3814 : 0 : return false;
3815 : : }
3816 : :
3817 : :
3818 : : /*
3819 : : * array_eq :
3820 : : * compares two arrays for equality
3821 : : * result :
3822 : : * returns true if the arrays are equal, false otherwise.
3823 : : *
3824 : : * Note: we do not use array_cmp here, since equality may be meaningful in
3825 : : * datatypes that don't have a total ordering (and hence no btree support).
3826 : : */
3827 : : Datum
3828 : 152864 : array_eq(PG_FUNCTION_ARGS)
3829 : : {
3830 : 152864 : LOCAL_FCINFO(locfcinfo, 2);
3831 : 152864 : AnyArrayType *array1 = PG_GETARG_ANY_ARRAY_P(0);
3832 : 152864 : AnyArrayType *array2 = PG_GETARG_ANY_ARRAY_P(1);
3833 : 152864 : Oid collation = PG_GET_COLLATION();
3834 [ + + ]: 152864 : int ndims1 = AARR_NDIM(array1);
3835 [ + + ]: 152864 : int ndims2 = AARR_NDIM(array2);
3836 [ + + ]: 152864 : int *dims1 = AARR_DIMS(array1);
3837 [ + + ]: 152864 : int *dims2 = AARR_DIMS(array2);
3838 [ + + ]: 152864 : int *lbs1 = AARR_LBOUND(array1);
3839 [ + + ]: 152864 : int *lbs2 = AARR_LBOUND(array2);
3840 [ + + ]: 152864 : Oid element_type = AARR_ELEMTYPE(array1);
3841 : 152864 : bool result = true;
3842 : : int nitems;
3843 : : TypeCacheEntry *typentry;
3844 : : int typlen;
3845 : : bool typbyval;
3846 : : char typalign;
3847 : : array_iter it1;
3848 : : array_iter it2;
3849 : : int i;
3850 : :
3851 [ + + - + ]: 152864 : if (element_type != AARR_ELEMTYPE(array2))
3852 [ # # ]: 0 : ereport(ERROR,
3853 : : (errcode(ERRCODE_DATATYPE_MISMATCH),
3854 : : errmsg("cannot compare arrays of different element types")));
3855 : :
3856 : : /* fast path if the arrays do not have the same dimensionality */
3857 [ + + ]: 152864 : if (ndims1 != ndims2 ||
3858 [ + + ]: 145265 : memcmp(dims1, dims2, ndims1 * sizeof(int)) != 0 ||
3859 [ - + ]: 109937 : memcmp(lbs1, lbs2, ndims1 * sizeof(int)) != 0)
3860 : 42927 : result = false;
3861 : : else
3862 : : {
3863 : : /*
3864 : : * We arrange to look up the equality function only once per series of
3865 : : * calls, assuming the element type doesn't change underneath us. The
3866 : : * typcache is used so that we have no memory leakage when being used
3867 : : * as an index support function.
3868 : : */
3869 : 109937 : typentry = (TypeCacheEntry *) fcinfo->flinfo->fn_extra;
3870 [ + + ]: 109937 : if (typentry == NULL ||
3871 [ - + ]: 108295 : typentry->type_id != element_type)
3872 : : {
3873 : 1642 : typentry = lookup_type_cache(element_type,
3874 : : TYPECACHE_EQ_OPR_FINFO);
3875 [ - + ]: 1642 : if (!OidIsValid(typentry->eq_opr_finfo.fn_oid))
3876 [ # # ]: 0 : ereport(ERROR,
3877 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
3878 : : errmsg("could not identify an equality operator for type %s",
3879 : : format_type_be(element_type))));
3880 : 1642 : fcinfo->flinfo->fn_extra = typentry;
3881 : : }
3882 : 109937 : typlen = typentry->typlen;
3883 : 109937 : typbyval = typentry->typbyval;
3884 : 109937 : typalign = typentry->typalign;
3885 : :
3886 : : /*
3887 : : * apply the operator to each pair of array elements.
3888 : : */
3889 : 109937 : InitFunctionCallInfoData(*locfcinfo, &typentry->eq_opr_finfo, 2,
3890 : : collation, NULL, NULL);
3891 : :
3892 : : /* Loop over source data */
3893 : 109937 : nitems = ArrayGetNItems(ndims1, dims1);
3894 : 109937 : array_iter_setup(&it1, array1, typlen, typbyval, typalign);
3895 : 109937 : array_iter_setup(&it2, array2, typlen, typbyval, typalign);
3896 : :
3897 [ + + ]: 261122 : for (i = 0; i < nitems; i++)
3898 : : {
3899 : : Datum elt1;
3900 : : Datum elt2;
3901 : : bool isnull1;
3902 : : bool isnull2;
3903 : : bool oprresult;
3904 : :
3905 : : /* Get elements, checking for NULL */
3906 : 171671 : elt1 = array_iter_next(&it1, &isnull1, i);
3907 : 171671 : elt2 = array_iter_next(&it2, &isnull2, i);
3908 : :
3909 : : /*
3910 : : * We consider two NULLs equal; NULL and not-NULL are unequal.
3911 : : */
3912 [ + + + - ]: 171671 : if (isnull1 && isnull2)
3913 : 29 : continue;
3914 [ + - + + ]: 171642 : if (isnull1 || isnull2)
3915 : : {
3916 : 72 : result = false;
3917 : 20486 : break;
3918 : : }
3919 : :
3920 : : /*
3921 : : * Apply the operator to the element pair; treat NULL as false
3922 : : */
3923 : 171570 : locfcinfo->args[0].value = elt1;
3924 : 171570 : locfcinfo->args[0].isnull = false;
3925 : 171570 : locfcinfo->args[1].value = elt2;
3926 : 171570 : locfcinfo->args[1].isnull = false;
3927 : 171570 : locfcinfo->isnull = false;
3928 : 171570 : oprresult = DatumGetBool(FunctionCallInvoke(locfcinfo));
3929 [ + - + + ]: 171570 : if (locfcinfo->isnull || !oprresult)
3930 : : {
3931 : 20414 : result = false;
3932 : 20414 : break;
3933 : : }
3934 : : }
3935 : : }
3936 : :
3937 : : /* Avoid leaking memory when handed toasted input. */
3938 [ + + + + ]: 152864 : AARR_FREE_IF_COPY(array1, 0);
3939 [ + + + + ]: 152864 : AARR_FREE_IF_COPY(array2, 1);
3940 : :
3941 : 152864 : PG_RETURN_BOOL(result);
3942 : : }
3943 : :
3944 : :
3945 : : /*-----------------------------------------------------------------------------
3946 : : * array-array bool operators:
3947 : : * Given two arrays, iterate comparison operators
3948 : : * over the array. Uses logic similar to text comparison
3949 : : * functions, except element-by-element instead of
3950 : : * character-by-character.
3951 : : *----------------------------------------------------------------------------
3952 : : */
3953 : :
3954 : : Datum
3955 : 700 : array_ne(PG_FUNCTION_ARGS)
3956 : : {
3957 : 700 : PG_RETURN_BOOL(!DatumGetBool(array_eq(fcinfo)));
3958 : : }
3959 : :
3960 : : Datum
3961 : 3908 : array_lt(PG_FUNCTION_ARGS)
3962 : : {
3963 : 3908 : PG_RETURN_BOOL(array_cmp(fcinfo) < 0);
3964 : : }
3965 : :
3966 : : Datum
3967 : 12 : array_gt(PG_FUNCTION_ARGS)
3968 : : {
3969 : 12 : PG_RETURN_BOOL(array_cmp(fcinfo) > 0);
3970 : : }
3971 : :
3972 : : Datum
3973 : 12 : array_le(PG_FUNCTION_ARGS)
3974 : : {
3975 : 12 : PG_RETURN_BOOL(array_cmp(fcinfo) <= 0);
3976 : : }
3977 : :
3978 : : Datum
3979 : 12 : array_ge(PG_FUNCTION_ARGS)
3980 : : {
3981 : 12 : PG_RETURN_BOOL(array_cmp(fcinfo) >= 0);
3982 : : }
3983 : :
3984 : : Datum
3985 : 5459700 : btarraycmp(PG_FUNCTION_ARGS)
3986 : : {
3987 : 5459700 : PG_RETURN_INT32(array_cmp(fcinfo));
3988 : : }
3989 : :
3990 : : /*
3991 : : * array_cmp()
3992 : : * Internal comparison function for arrays.
3993 : : *
3994 : : * Returns -1, 0 or 1
3995 : : */
3996 : : static int
3997 : 5464008 : array_cmp(FunctionCallInfo fcinfo)
3998 : : {
3999 : 5464008 : LOCAL_FCINFO(locfcinfo, 2);
4000 : 5464008 : AnyArrayType *array1 = PG_GETARG_ANY_ARRAY_P(0);
4001 : 5464008 : AnyArrayType *array2 = PG_GETARG_ANY_ARRAY_P(1);
4002 : 5464008 : Oid collation = PG_GET_COLLATION();
4003 [ - + ]: 5464008 : int ndims1 = AARR_NDIM(array1);
4004 [ - + ]: 5464008 : int ndims2 = AARR_NDIM(array2);
4005 [ - + ]: 5464008 : int *dims1 = AARR_DIMS(array1);
4006 [ - + ]: 5464008 : int *dims2 = AARR_DIMS(array2);
4007 : 5464008 : int nitems1 = ArrayGetNItems(ndims1, dims1);
4008 : 5464008 : int nitems2 = ArrayGetNItems(ndims2, dims2);
4009 [ - + ]: 5464008 : Oid element_type = AARR_ELEMTYPE(array1);
4010 : 5464008 : int result = 0;
4011 : : TypeCacheEntry *typentry;
4012 : : int typlen;
4013 : : bool typbyval;
4014 : : char typalign;
4015 : : int min_nitems;
4016 : : array_iter it1;
4017 : : array_iter it2;
4018 : : int i;
4019 : :
4020 [ - + + + ]: 5464008 : if (element_type != AARR_ELEMTYPE(array2))
4021 [ + - ]: 4 : ereport(ERROR,
4022 : : (errcode(ERRCODE_DATATYPE_MISMATCH),
4023 : : errmsg("cannot compare arrays of different element types")));
4024 : :
4025 : : /*
4026 : : * We arrange to look up the comparison function only once per series of
4027 : : * calls, assuming the element type doesn't change underneath us. The
4028 : : * typcache is used so that we have no memory leakage when being used as
4029 : : * an index support function.
4030 : : */
4031 : 5464004 : typentry = (TypeCacheEntry *) fcinfo->flinfo->fn_extra;
4032 [ + + ]: 5464004 : if (typentry == NULL ||
4033 [ - + ]: 5462465 : typentry->type_id != element_type)
4034 : : {
4035 : 1539 : typentry = lookup_type_cache(element_type,
4036 : : TYPECACHE_CMP_PROC_FINFO);
4037 [ + + ]: 1539 : if (!OidIsValid(typentry->cmp_proc_finfo.fn_oid))
4038 [ + - ]: 4 : ereport(ERROR,
4039 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
4040 : : errmsg("could not identify a comparison function for type %s",
4041 : : format_type_be(element_type))));
4042 : 1535 : fcinfo->flinfo->fn_extra = typentry;
4043 : : }
4044 : 5464000 : typlen = typentry->typlen;
4045 : 5464000 : typbyval = typentry->typbyval;
4046 : 5464000 : typalign = typentry->typalign;
4047 : :
4048 : : /*
4049 : : * apply the operator to each pair of array elements.
4050 : : */
4051 : 5464000 : InitFunctionCallInfoData(*locfcinfo, &typentry->cmp_proc_finfo, 2,
4052 : : collation, NULL, NULL);
4053 : :
4054 : : /* Loop over source data */
4055 : 5464000 : min_nitems = Min(nitems1, nitems2);
4056 : 5464000 : array_iter_setup(&it1, array1, typlen, typbyval, typalign);
4057 : 5464000 : array_iter_setup(&it2, array2, typlen, typbyval, typalign);
4058 : :
4059 [ + + ]: 11385946 : for (i = 0; i < min_nitems; i++)
4060 : : {
4061 : : Datum elt1;
4062 : : Datum elt2;
4063 : : bool isnull1;
4064 : : bool isnull2;
4065 : : int32 cmpresult;
4066 : :
4067 : : /* Get elements, checking for NULL */
4068 : 9760431 : elt1 = array_iter_next(&it1, &isnull1, i);
4069 : 9760431 : elt2 = array_iter_next(&it2, &isnull2, i);
4070 : :
4071 : : /*
4072 : : * We consider two NULLs equal; NULL > not-NULL.
4073 : : */
4074 [ + + + + ]: 9760431 : if (isnull1 && isnull2)
4075 : 5921946 : continue;
4076 [ + + ]: 9760418 : if (isnull1)
4077 : : {
4078 : : /* arg1 is greater than arg2 */
4079 : 112 : result = 1;
4080 : 3838485 : break;
4081 : : }
4082 [ + + ]: 9760306 : if (isnull2)
4083 : : {
4084 : : /* arg1 is less than arg2 */
4085 : 170 : result = -1;
4086 : 170 : break;
4087 : : }
4088 : :
4089 : : /* Compare the pair of elements */
4090 : 9760136 : locfcinfo->args[0].value = elt1;
4091 : 9760136 : locfcinfo->args[0].isnull = false;
4092 : 9760136 : locfcinfo->args[1].value = elt2;
4093 : 9760136 : locfcinfo->args[1].isnull = false;
4094 : 9760136 : cmpresult = DatumGetInt32(FunctionCallInvoke(locfcinfo));
4095 : :
4096 : : /* We don't expect comparison support functions to return null */
4097 : : Assert(!locfcinfo->isnull);
4098 : :
4099 [ + + ]: 9760136 : if (cmpresult == 0)
4100 : 5921933 : continue; /* equal */
4101 : :
4102 [ + + ]: 3838203 : if (cmpresult < 0)
4103 : : {
4104 : : /* arg1 is less than arg2 */
4105 : 2191378 : result = -1;
4106 : 2191378 : break;
4107 : : }
4108 : : else
4109 : : {
4110 : : /* arg1 is greater than arg2 */
4111 : 1646825 : result = 1;
4112 : 1646825 : break;
4113 : : }
4114 : : }
4115 : :
4116 : : /*
4117 : : * If arrays contain same data (up to end of shorter one), apply
4118 : : * additional rules to sort by dimensionality. The relative significance
4119 : : * of the different bits of information is historical; mainly we just care
4120 : : * that we don't say "equal" for arrays of different dimensionality.
4121 : : */
4122 [ + + ]: 5464000 : if (result == 0)
4123 : : {
4124 [ + + ]: 1625515 : if (nitems1 != nitems2)
4125 [ + + ]: 149158 : result = (nitems1 < nitems2) ? -1 : 1;
4126 [ - + ]: 1476357 : else if (ndims1 != ndims2)
4127 [ # # ]: 0 : result = (ndims1 < ndims2) ? -1 : 1;
4128 : : else
4129 : : {
4130 [ + + ]: 2952687 : for (i = 0; i < ndims1; i++)
4131 : : {
4132 [ - + ]: 1476330 : if (dims1[i] != dims2[i])
4133 : : {
4134 [ # # ]: 0 : result = (dims1[i] < dims2[i]) ? -1 : 1;
4135 : 0 : break;
4136 : : }
4137 : : }
4138 [ + - ]: 1476357 : if (result == 0)
4139 : : {
4140 [ - + ]: 1476357 : int *lbound1 = AARR_LBOUND(array1);
4141 [ - + ]: 1476357 : int *lbound2 = AARR_LBOUND(array2);
4142 : :
4143 [ + + ]: 2952687 : for (i = 0; i < ndims1; i++)
4144 : : {
4145 [ - + ]: 1476330 : if (lbound1[i] != lbound2[i])
4146 : : {
4147 [ # # ]: 0 : result = (lbound1[i] < lbound2[i]) ? -1 : 1;
4148 : 0 : break;
4149 : : }
4150 : : }
4151 : : }
4152 : : }
4153 : : }
4154 : :
4155 : : /* Avoid leaking memory when handed toasted input. */
4156 [ + - + + ]: 5464000 : AARR_FREE_IF_COPY(array1, 0);
4157 [ + - + + ]: 5464000 : AARR_FREE_IF_COPY(array2, 1);
4158 : :
4159 : 5464000 : return result;
4160 : : }
4161 : :
4162 : :
4163 : : /*-----------------------------------------------------------------------------
4164 : : * array hashing
4165 : : * Hash the elements and combine the results.
4166 : : *----------------------------------------------------------------------------
4167 : : */
4168 : :
4169 : : Datum
4170 : 39891 : hash_array(PG_FUNCTION_ARGS)
4171 : : {
4172 : 39891 : LOCAL_FCINFO(locfcinfo, 1);
4173 : 39891 : AnyArrayType *array = PG_GETARG_ANY_ARRAY_P(0);
4174 [ + + ]: 39891 : int ndims = AARR_NDIM(array);
4175 [ + + ]: 39891 : int *dims = AARR_DIMS(array);
4176 [ + + ]: 39891 : Oid element_type = AARR_ELEMTYPE(array);
4177 : 39891 : uint32 result = 1;
4178 : : int nitems;
4179 : : TypeCacheEntry *typentry;
4180 : : int typlen;
4181 : : bool typbyval;
4182 : : char typalign;
4183 : : int i;
4184 : : array_iter iter;
4185 : :
4186 : : /*
4187 : : * We arrange to look up the hash function only once per series of calls,
4188 : : * assuming the element type doesn't change underneath us. The typcache
4189 : : * is used so that we have no memory leakage when being used as an index
4190 : : * support function.
4191 : : */
4192 : 39891 : typentry = (TypeCacheEntry *) fcinfo->flinfo->fn_extra;
4193 [ + + ]: 39891 : if (typentry == NULL ||
4194 [ - + ]: 39478 : typentry->type_id != element_type)
4195 : : {
4196 : 413 : typentry = lookup_type_cache(element_type,
4197 : : TYPECACHE_HASH_PROC_FINFO);
4198 [ + + + + ]: 413 : if (!OidIsValid(typentry->hash_proc_finfo.fn_oid) && element_type != RECORDOID)
4199 [ + - ]: 4 : ereport(ERROR,
4200 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
4201 : : errmsg("could not identify a hash function for type %s",
4202 : : format_type_be(element_type))));
4203 : :
4204 : : /*
4205 : : * The type cache doesn't believe that record is hashable (see
4206 : : * cache_record_field_properties()), but since we're here, we're
4207 : : * committed to hashing, so we can assume it does. Worst case, if any
4208 : : * components of the record don't support hashing, we will fail at
4209 : : * execution.
4210 : : */
4211 [ + + ]: 409 : if (element_type == RECORDOID)
4212 : : {
4213 : : MemoryContext oldcontext;
4214 : : TypeCacheEntry *record_typentry;
4215 : :
4216 : 12 : oldcontext = MemoryContextSwitchTo(fcinfo->flinfo->fn_mcxt);
4217 : :
4218 : : /*
4219 : : * Make fake type cache entry structure. Note that we can't just
4220 : : * modify typentry, since that points directly into the type
4221 : : * cache.
4222 : : */
4223 : 12 : record_typentry = palloc0_object(TypeCacheEntry);
4224 : 12 : record_typentry->type_id = element_type;
4225 : :
4226 : : /* fill in what we need below */
4227 : 12 : record_typentry->typlen = typentry->typlen;
4228 : 12 : record_typentry->typbyval = typentry->typbyval;
4229 : 12 : record_typentry->typalign = typentry->typalign;
4230 : 12 : fmgr_info(F_HASH_RECORD, &record_typentry->hash_proc_finfo);
4231 : :
4232 : 12 : MemoryContextSwitchTo(oldcontext);
4233 : :
4234 : 12 : typentry = record_typentry;
4235 : : }
4236 : :
4237 : 409 : fcinfo->flinfo->fn_extra = typentry;
4238 : : }
4239 : :
4240 : 39887 : typlen = typentry->typlen;
4241 : 39887 : typbyval = typentry->typbyval;
4242 : 39887 : typalign = typentry->typalign;
4243 : :
4244 : : /*
4245 : : * apply the hash function to each array element.
4246 : : */
4247 : 39887 : InitFunctionCallInfoData(*locfcinfo, &typentry->hash_proc_finfo, 1,
4248 : : PG_GET_COLLATION(), NULL, NULL);
4249 : :
4250 : : /* Loop over source data */
4251 : 39887 : nitems = ArrayGetNItems(ndims, dims);
4252 : 39887 : array_iter_setup(&iter, array, typlen, typbyval, typalign);
4253 : :
4254 [ + + ]: 105955 : for (i = 0; i < nitems; i++)
4255 : : {
4256 : : Datum elt;
4257 : : bool isnull;
4258 : : uint32 elthash;
4259 : :
4260 : : /* Get element, checking for NULL */
4261 : 66068 : elt = array_iter_next(&iter, &isnull, i);
4262 : :
4263 [ + + ]: 66068 : if (isnull)
4264 : : {
4265 : : /* Treat nulls as having hashvalue 0 */
4266 : 32 : elthash = 0;
4267 : : }
4268 : : else
4269 : : {
4270 : : /* Apply the hash function */
4271 : 66036 : locfcinfo->args[0].value = elt;
4272 : 66036 : locfcinfo->args[0].isnull = false;
4273 : 66036 : elthash = DatumGetUInt32(FunctionCallInvoke(locfcinfo));
4274 : : /* We don't expect hash functions to return null */
4275 : : Assert(!locfcinfo->isnull);
4276 : : }
4277 : :
4278 : : /*
4279 : : * Combine hash values of successive elements by multiplying the
4280 : : * current value by 31 and adding on the new element's hash value.
4281 : : *
4282 : : * The result is a sum in which each element's hash value is
4283 : : * multiplied by a different power of 31. This is modulo 2^32
4284 : : * arithmetic, and the powers of 31 modulo 2^32 form a cyclic group of
4285 : : * order 2^27. So for arrays of up to 2^27 elements, each element's
4286 : : * hash value is multiplied by a different (odd) number, resulting in
4287 : : * a good mixing of all the elements' hash values.
4288 : : */
4289 : 66068 : result = (result << 5) - result + elthash;
4290 : : }
4291 : :
4292 : : /* Avoid leaking memory when handed toasted input. */
4293 [ + + + + ]: 39887 : AARR_FREE_IF_COPY(array, 0);
4294 : :
4295 : 39887 : PG_RETURN_UINT32(result);
4296 : : }
4297 : :
4298 : : /*
4299 : : * Returns 64-bit value by hashing a value to a 64-bit value, with a seed.
4300 : : * Otherwise, similar to hash_array.
4301 : : */
4302 : : Datum
4303 : 100 : hash_array_extended(PG_FUNCTION_ARGS)
4304 : : {
4305 : 100 : LOCAL_FCINFO(locfcinfo, 2);
4306 : 100 : AnyArrayType *array = PG_GETARG_ANY_ARRAY_P(0);
4307 : 100 : uint64 seed = PG_GETARG_INT64(1);
4308 [ - + ]: 100 : int ndims = AARR_NDIM(array);
4309 [ - + ]: 100 : int *dims = AARR_DIMS(array);
4310 [ - + ]: 100 : Oid element_type = AARR_ELEMTYPE(array);
4311 : 100 : uint64 result = 1;
4312 : : int nitems;
4313 : : TypeCacheEntry *typentry;
4314 : : int typlen;
4315 : : bool typbyval;
4316 : : char typalign;
4317 : : int i;
4318 : : array_iter iter;
4319 : :
4320 : 100 : typentry = (TypeCacheEntry *) fcinfo->flinfo->fn_extra;
4321 [ + + ]: 100 : if (typentry == NULL ||
4322 [ - + ]: 56 : typentry->type_id != element_type)
4323 : : {
4324 : 44 : typentry = lookup_type_cache(element_type,
4325 : : TYPECACHE_HASH_EXTENDED_PROC_FINFO);
4326 [ + + ]: 44 : if (!OidIsValid(typentry->hash_extended_proc_finfo.fn_oid))
4327 [ + - ]: 4 : ereport(ERROR,
4328 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
4329 : : errmsg("could not identify an extended hash function for type %s",
4330 : : format_type_be(element_type))));
4331 : 40 : fcinfo->flinfo->fn_extra = typentry;
4332 : : }
4333 : 96 : typlen = typentry->typlen;
4334 : 96 : typbyval = typentry->typbyval;
4335 : 96 : typalign = typentry->typalign;
4336 : :
4337 : 96 : InitFunctionCallInfoData(*locfcinfo, &typentry->hash_extended_proc_finfo, 2,
4338 : : PG_GET_COLLATION(), NULL, NULL);
4339 : :
4340 : : /* Loop over source data */
4341 : 96 : nitems = ArrayGetNItems(ndims, dims);
4342 : 96 : array_iter_setup(&iter, array, typlen, typbyval, typalign);
4343 : :
4344 [ + + ]: 314 : for (i = 0; i < nitems; i++)
4345 : : {
4346 : : Datum elt;
4347 : : bool isnull;
4348 : : uint64 elthash;
4349 : :
4350 : : /* Get element, checking for NULL */
4351 : 218 : elt = array_iter_next(&iter, &isnull, i);
4352 : :
4353 [ - + ]: 218 : if (isnull)
4354 : : {
4355 : 0 : elthash = 0;
4356 : : }
4357 : : else
4358 : : {
4359 : : /* Apply the hash function */
4360 : 218 : locfcinfo->args[0].value = elt;
4361 : 218 : locfcinfo->args[0].isnull = false;
4362 : 218 : locfcinfo->args[1].value = Int64GetDatum(seed);
4363 : 218 : locfcinfo->args[1].isnull = false;
4364 : 218 : elthash = DatumGetUInt64(FunctionCallInvoke(locfcinfo));
4365 : : /* We don't expect hash functions to return null */
4366 : : Assert(!locfcinfo->isnull);
4367 : : }
4368 : :
4369 : 218 : result = (result << 5) - result + elthash;
4370 : : }
4371 : :
4372 [ + - - + ]: 96 : AARR_FREE_IF_COPY(array, 0);
4373 : :
4374 : 96 : PG_RETURN_UINT64(result);
4375 : : }
4376 : :
4377 : :
4378 : : /*-----------------------------------------------------------------------------
4379 : : * array overlap/containment comparisons
4380 : : * These use the same methods of comparing array elements as array_eq.
4381 : : * We consider only the elements of the arrays, ignoring dimensionality.
4382 : : *----------------------------------------------------------------------------
4383 : : */
4384 : :
4385 : : /*
4386 : : * array_contain_compare :
4387 : : * compares two arrays for overlap/containment
4388 : : *
4389 : : * When matchall is true, return true if all members of array1 are in array2.
4390 : : * When matchall is false, return true if any members of array1 are in array2.
4391 : : */
4392 : : static bool
4393 : 14883 : array_contain_compare(AnyArrayType *array1, AnyArrayType *array2, Oid collation,
4394 : : bool matchall, void **fn_extra)
4395 : : {
4396 : 14883 : LOCAL_FCINFO(locfcinfo, 2);
4397 : 14883 : bool result = matchall;
4398 [ + + ]: 14883 : Oid element_type = AARR_ELEMTYPE(array1);
4399 : : TypeCacheEntry *typentry;
4400 : : int nelems1;
4401 : : Datum *values2;
4402 : : bool *nulls2;
4403 : : int nelems2;
4404 : : int typlen;
4405 : : bool typbyval;
4406 : : char typalign;
4407 : : int i;
4408 : : int j;
4409 : : array_iter it1;
4410 : :
4411 [ + + - + ]: 14883 : if (element_type != AARR_ELEMTYPE(array2))
4412 [ # # ]: 0 : ereport(ERROR,
4413 : : (errcode(ERRCODE_DATATYPE_MISMATCH),
4414 : : errmsg("cannot compare arrays of different element types")));
4415 : :
4416 : : /*
4417 : : * We arrange to look up the equality function only once per series of
4418 : : * calls, assuming the element type doesn't change underneath us. The
4419 : : * typcache is used so that we have no memory leakage when being used as
4420 : : * an index support function.
4421 : : */
4422 : 14883 : typentry = (TypeCacheEntry *) *fn_extra;
4423 [ + + ]: 14883 : if (typentry == NULL ||
4424 [ - + ]: 14523 : typentry->type_id != element_type)
4425 : : {
4426 : 360 : typentry = lookup_type_cache(element_type,
4427 : : TYPECACHE_EQ_OPR_FINFO);
4428 [ - + ]: 360 : if (!OidIsValid(typentry->eq_opr_finfo.fn_oid))
4429 [ # # ]: 0 : ereport(ERROR,
4430 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
4431 : : errmsg("could not identify an equality operator for type %s",
4432 : : format_type_be(element_type))));
4433 : 360 : *fn_extra = typentry;
4434 : : }
4435 : 14883 : typlen = typentry->typlen;
4436 : 14883 : typbyval = typentry->typbyval;
4437 : 14883 : typalign = typentry->typalign;
4438 : :
4439 : : /*
4440 : : * Since we probably will need to scan array2 multiple times, it's
4441 : : * worthwhile to use deconstruct_array on it. We scan array1 the hard way
4442 : : * however, since we very likely won't need to look at all of it.
4443 : : */
4444 [ + + ]: 14883 : if (VARATT_IS_EXPANDED_HEADER(array2))
4445 : : {
4446 : : /* This should be safe even if input is read-only */
4447 : 3408 : deconstruct_expanded_array(&(array2->xpn));
4448 : 3408 : values2 = array2->xpn.dvalues;
4449 : 3408 : nulls2 = array2->xpn.dnulls;
4450 : 3408 : nelems2 = array2->xpn.nelems;
4451 : : }
4452 : : else
4453 : 11475 : deconstruct_array((ArrayType *) array2,
4454 : : element_type, typlen, typbyval, typalign,
4455 : : &values2, &nulls2, &nelems2);
4456 : :
4457 : : /*
4458 : : * Apply the comparison operator to each pair of array elements.
4459 : : */
4460 : 14883 : InitFunctionCallInfoData(*locfcinfo, &typentry->eq_opr_finfo, 2,
4461 : : collation, NULL, NULL);
4462 : :
4463 : : /* Loop over source data */
4464 [ + + + + ]: 14883 : nelems1 = ArrayGetNItems(AARR_NDIM(array1), AARR_DIMS(array1));
4465 : 14883 : array_iter_setup(&it1, array1, typlen, typbyval, typalign);
4466 : :
4467 [ + + ]: 280131 : for (i = 0; i < nelems1; i++)
4468 : : {
4469 : : Datum elt1;
4470 : : bool isnull1;
4471 : :
4472 : : /* Get element, checking for NULL */
4473 : 271459 : elt1 = array_iter_next(&it1, &isnull1, i);
4474 : :
4475 : : /*
4476 : : * We assume that the comparison operator is strict, so a NULL can't
4477 : : * match anything. XXX this diverges from the "NULL=NULL" behavior of
4478 : : * array_eq, should we act like that?
4479 : : */
4480 [ + + ]: 271459 : if (isnull1)
4481 : : {
4482 [ + + ]: 880 : if (matchall)
4483 : : {
4484 : 840 : result = false;
4485 : 6211 : break;
4486 : : }
4487 : 40 : continue;
4488 : : }
4489 : :
4490 [ + + ]: 12277284 : for (j = 0; j < nelems2; j++)
4491 : : {
4492 : 12251101 : Datum elt2 = values2[j];
4493 [ + + ]: 12251101 : bool isnull2 = nulls2 ? nulls2[j] : false;
4494 : : bool oprresult;
4495 : :
4496 [ + + ]: 12251101 : if (isnull2)
4497 : 4808 : continue; /* can't match */
4498 : :
4499 : : /*
4500 : : * Apply the operator to the element pair; treat NULL as false
4501 : : */
4502 : 12246293 : locfcinfo->args[0].value = elt1;
4503 : 12246293 : locfcinfo->args[0].isnull = false;
4504 : 12246293 : locfcinfo->args[1].value = elt2;
4505 : 12246293 : locfcinfo->args[1].isnull = false;
4506 : 12246293 : locfcinfo->isnull = false;
4507 : 12246293 : oprresult = DatumGetBool(FunctionCallInvoke(locfcinfo));
4508 [ + - + + ]: 12246293 : if (!locfcinfo->isnull && oprresult)
4509 : 244396 : break;
4510 : : }
4511 : :
4512 [ + + ]: 270579 : if (j < nelems2)
4513 : : {
4514 : : /* found a match for elt1 */
4515 [ + + ]: 244396 : if (!matchall)
4516 : : {
4517 : 152 : result = true;
4518 : 152 : break;
4519 : : }
4520 : : }
4521 : : else
4522 : : {
4523 : : /* no match for elt1 */
4524 [ + + ]: 26183 : if (matchall)
4525 : : {
4526 : 5219 : result = false;
4527 : 5219 : break;
4528 : : }
4529 : : }
4530 : : }
4531 : :
4532 : 14883 : return result;
4533 : : }
4534 : :
4535 : : Datum
4536 : 4080 : arrayoverlap(PG_FUNCTION_ARGS)
4537 : : {
4538 : 4080 : AnyArrayType *array1 = PG_GETARG_ANY_ARRAY_P(0);
4539 : 4080 : AnyArrayType *array2 = PG_GETARG_ANY_ARRAY_P(1);
4540 : 4080 : Oid collation = PG_GET_COLLATION();
4541 : : bool result;
4542 : :
4543 : 4080 : result = array_contain_compare(array1, array2, collation, false,
4544 : 4080 : &fcinfo->flinfo->fn_extra);
4545 : :
4546 : : /* Avoid leaking memory when handed toasted input. */
4547 [ + - + + ]: 4080 : AARR_FREE_IF_COPY(array1, 0);
4548 [ + - - + ]: 4080 : AARR_FREE_IF_COPY(array2, 1);
4549 : :
4550 : 4080 : PG_RETURN_BOOL(result);
4551 : : }
4552 : :
4553 : : Datum
4554 : 6459 : arraycontains(PG_FUNCTION_ARGS)
4555 : : {
4556 : 6459 : AnyArrayType *array1 = PG_GETARG_ANY_ARRAY_P(0);
4557 : 6459 : AnyArrayType *array2 = PG_GETARG_ANY_ARRAY_P(1);
4558 : 6459 : Oid collation = PG_GET_COLLATION();
4559 : : bool result;
4560 : :
4561 : 6459 : result = array_contain_compare(array2, array1, collation, true,
4562 : 6459 : &fcinfo->flinfo->fn_extra);
4563 : :
4564 : : /* Avoid leaking memory when handed toasted input. */
4565 [ + + + + ]: 6459 : AARR_FREE_IF_COPY(array1, 0);
4566 [ + + - + ]: 6459 : AARR_FREE_IF_COPY(array2, 1);
4567 : :
4568 : 6459 : PG_RETURN_BOOL(result);
4569 : : }
4570 : :
4571 : : Datum
4572 : 4344 : arraycontained(PG_FUNCTION_ARGS)
4573 : : {
4574 : 4344 : AnyArrayType *array1 = PG_GETARG_ANY_ARRAY_P(0);
4575 : 4344 : AnyArrayType *array2 = PG_GETARG_ANY_ARRAY_P(1);
4576 : 4344 : Oid collation = PG_GET_COLLATION();
4577 : : bool result;
4578 : :
4579 : 4344 : result = array_contain_compare(array1, array2, collation, true,
4580 : 4344 : &fcinfo->flinfo->fn_extra);
4581 : :
4582 : : /* Avoid leaking memory when handed toasted input. */
4583 [ + + + + ]: 4344 : AARR_FREE_IF_COPY(array1, 0);
4584 [ + + - + ]: 4344 : AARR_FREE_IF_COPY(array2, 1);
4585 : :
4586 : 4344 : PG_RETURN_BOOL(result);
4587 : : }
4588 : :
4589 : :
4590 : : /*-----------------------------------------------------------------------------
4591 : : * Array iteration functions
4592 : : * These functions are used to iterate efficiently through arrays
4593 : : *-----------------------------------------------------------------------------
4594 : : */
4595 : :
4596 : : /*
4597 : : * array_create_iterator --- set up to iterate through an array
4598 : : *
4599 : : * If slice_ndim is zero, we will iterate element-by-element; the returned
4600 : : * datums are of the array's element type.
4601 : : *
4602 : : * If slice_ndim is 1..ARR_NDIM(arr), we will iterate by slices: the
4603 : : * returned datums are of the same array type as 'arr', but of size
4604 : : * equal to the rightmost N dimensions of 'arr'.
4605 : : *
4606 : : * The passed-in array must remain valid for the lifetime of the iterator.
4607 : : */
4608 : : ArrayIterator
4609 : 370 : array_create_iterator(ArrayType *arr, int slice_ndim, ArrayMetaState *mstate)
4610 : : {
4611 : 370 : ArrayIterator iterator = palloc0_object(ArrayIteratorData);
4612 : :
4613 : : /*
4614 : : * Sanity-check inputs --- caller should have got this right already
4615 : : */
4616 : : Assert(arr);
4617 [ + - - + ]: 370 : if (slice_ndim < 0 || slice_ndim > ARR_NDIM(arr))
4618 [ # # ]: 0 : elog(ERROR, "invalid arguments to array_create_iterator");
4619 : :
4620 : : /*
4621 : : * Remember basic info about the array and its element type
4622 : : */
4623 : 370 : iterator->arr = arr;
4624 [ + + ]: 370 : iterator->nullbitmap = ARR_NULLBITMAP(arr);
4625 : 370 : iterator->nitems = ArrayGetNItems(ARR_NDIM(arr), ARR_DIMS(arr));
4626 : :
4627 [ + + ]: 370 : if (mstate != NULL)
4628 : : {
4629 : : Assert(mstate->element_type == ARR_ELEMTYPE(arr));
4630 : :
4631 : 261 : iterator->typlen = mstate->typlen;
4632 : 261 : iterator->typbyval = mstate->typbyval;
4633 : 261 : iterator->typalign = mstate->typalign;
4634 : : }
4635 : : else
4636 : 109 : get_typlenbyvalalign(ARR_ELEMTYPE(arr),
4637 : : &iterator->typlen,
4638 : : &iterator->typbyval,
4639 : : &iterator->typalign);
4640 : 370 : iterator->typalignby = typalign_to_alignby(iterator->typalign);
4641 : :
4642 : : /*
4643 : : * Remember the slicing parameters.
4644 : : */
4645 : 370 : iterator->slice_ndim = slice_ndim;
4646 : :
4647 [ + + ]: 370 : if (slice_ndim > 0)
4648 : : {
4649 : : /*
4650 : : * Get pointers into the array's dims and lbound arrays to represent
4651 : : * the dims/lbound arrays of a slice. These are the same as the
4652 : : * rightmost N dimensions of the array.
4653 : : */
4654 : 58 : iterator->slice_dims = ARR_DIMS(arr) + ARR_NDIM(arr) - slice_ndim;
4655 : 58 : iterator->slice_lbound = ARR_LBOUND(arr) + ARR_NDIM(arr) - slice_ndim;
4656 : :
4657 : : /*
4658 : : * Compute number of elements in a slice.
4659 : : */
4660 : 116 : iterator->slice_len = ArrayGetNItems(slice_ndim,
4661 : 58 : iterator->slice_dims);
4662 : :
4663 : : /*
4664 : : * Create workspace for building sub-arrays.
4665 : : */
4666 : 58 : iterator->slice_values = (Datum *)
4667 : 58 : palloc(iterator->slice_len * sizeof(Datum));
4668 : 58 : iterator->slice_nulls = (bool *)
4669 : 58 : palloc(iterator->slice_len * sizeof(bool));
4670 : : }
4671 : :
4672 : : /*
4673 : : * Initialize our data pointer and linear element number. These will
4674 : : * advance through the array during array_iterate().
4675 : : */
4676 [ + + ]: 370 : iterator->data_ptr = ARR_DATA_PTR(arr);
4677 : 370 : iterator->current_item = 0;
4678 : :
4679 : 370 : return iterator;
4680 : : }
4681 : :
4682 : : /*
4683 : : * Iterate through the array referenced by 'iterator'.
4684 : : *
4685 : : * As long as there is another element (or slice), return it into
4686 : : * *value / *isnull, and return true. Return false when no more data.
4687 : : */
4688 : : bool
4689 : 5223 : array_iterate(ArrayIterator iterator, Datum *value, bool *isnull)
4690 : : {
4691 : : /* Done if we have reached the end of the array */
4692 [ + + ]: 5223 : if (iterator->current_item >= iterator->nitems)
4693 : 261 : return false;
4694 : :
4695 [ + + ]: 4962 : if (iterator->slice_ndim == 0)
4696 : : {
4697 : : /*
4698 : : * Scalar case: return one element.
4699 : : */
4700 [ + + ]: 4843 : if (array_get_isnull(iterator->nullbitmap, iterator->current_item++))
4701 : : {
4702 : 55 : *isnull = true;
4703 : 55 : *value = (Datum) 0;
4704 : : }
4705 : : else
4706 : : {
4707 : : /* non-NULL, so fetch the individual Datum to return */
4708 : 4788 : char *p = iterator->data_ptr;
4709 : :
4710 : 4788 : *isnull = false;
4711 : 4788 : *value = fetch_att(p, iterator->typbyval, iterator->typlen);
4712 : :
4713 : : /* Move our data pointer forward to the next element */
4714 [ + + + - ]: 4788 : p = att_addlength_pointer(p, iterator->typlen, p);
4715 : 4788 : p = (char *) att_nominal_alignby(p, iterator->typalignby);
4716 : 4788 : iterator->data_ptr = p;
4717 : : }
4718 : : }
4719 : : else
4720 : : {
4721 : : /*
4722 : : * Slice case: build and return an array of the requested size.
4723 : : */
4724 : : ArrayType *result;
4725 : 119 : Datum *values = iterator->slice_values;
4726 : 119 : bool *nulls = iterator->slice_nulls;
4727 : 119 : char *p = iterator->data_ptr;
4728 : : int i;
4729 : :
4730 [ + + ]: 375 : for (i = 0; i < iterator->slice_len; i++)
4731 : : {
4732 [ - + ]: 256 : if (array_get_isnull(iterator->nullbitmap,
4733 : 256 : iterator->current_item++))
4734 : : {
4735 : 0 : nulls[i] = true;
4736 : 0 : values[i] = (Datum) 0;
4737 : : }
4738 : : else
4739 : : {
4740 : 256 : nulls[i] = false;
4741 : 256 : values[i] = fetch_att(p, iterator->typbyval, iterator->typlen);
4742 : :
4743 : : /* Move our data pointer forward to the next element */
4744 [ + + + - ]: 256 : p = att_addlength_pointer(p, iterator->typlen, p);
4745 : 256 : p = (char *) att_nominal_alignby(p, iterator->typalignby);
4746 : : }
4747 : : }
4748 : :
4749 : 119 : iterator->data_ptr = p;
4750 : :
4751 : 119 : result = construct_md_array(values,
4752 : : nulls,
4753 : : iterator->slice_ndim,
4754 : : iterator->slice_dims,
4755 : : iterator->slice_lbound,
4756 : 119 : ARR_ELEMTYPE(iterator->arr),
4757 : 119 : iterator->typlen,
4758 : 119 : iterator->typbyval,
4759 : 119 : iterator->typalign);
4760 : :
4761 : 119 : *isnull = false;
4762 : 119 : *value = PointerGetDatum(result);
4763 : : }
4764 : :
4765 : 4962 : return true;
4766 : : }
4767 : :
4768 : : /*
4769 : : * Release an ArrayIterator data structure
4770 : : */
4771 : : void
4772 : 261 : array_free_iterator(ArrayIterator iterator)
4773 : : {
4774 [ + + ]: 261 : if (iterator->slice_ndim > 0)
4775 : : {
4776 : 34 : pfree(iterator->slice_values);
4777 : 34 : pfree(iterator->slice_nulls);
4778 : : }
4779 : 261 : pfree(iterator);
4780 : 261 : }
4781 : :
4782 : :
4783 : : /***************************************************************************/
4784 : : /******************| Support Routines |*****************/
4785 : : /***************************************************************************/
4786 : :
4787 : : /*
4788 : : * Check whether a specific array element is NULL
4789 : : *
4790 : : * nullbitmap: pointer to array's null bitmap (NULL if none)
4791 : : * offset: 0-based linear element number of array element
4792 : : */
4793 : : static bool
4794 : 514954 : array_get_isnull(const uint8 *nullbitmap, int offset)
4795 : : {
4796 [ + + ]: 514954 : if (nullbitmap == NULL)
4797 : 514326 : return false; /* assume not null */
4798 [ + + ]: 628 : if (nullbitmap[offset / 8] & (1 << (offset % 8)))
4799 : 501 : return false; /* not null */
4800 : 127 : return true;
4801 : : }
4802 : :
4803 : : /*
4804 : : * Set a specific array element's null-bitmap entry
4805 : : *
4806 : : * nullbitmap: pointer to array's null bitmap (mustn't be NULL)
4807 : : * offset: 0-based linear element number of array element
4808 : : * isNull: null status to set
4809 : : */
4810 : : static void
4811 : 90 : array_set_isnull(uint8 *nullbitmap, int offset, bool isNull)
4812 : : {
4813 : : int bitmask;
4814 : :
4815 : 90 : nullbitmap += offset / 8;
4816 : 90 : bitmask = 1 << (offset % 8);
4817 [ + + ]: 90 : if (isNull)
4818 : 13 : *nullbitmap &= ~bitmask;
4819 : : else
4820 : 77 : *nullbitmap |= bitmask;
4821 : 90 : }
4822 : :
4823 : : /*
4824 : : * Fetch array element at pointer, converted correctly to a Datum
4825 : : *
4826 : : * Caller must have handled case of NULL element
4827 : : */
4828 : : static Datum
4829 : 509405 : ArrayCast(char *value, bool byval, int len)
4830 : : {
4831 : 509405 : return fetch_att(value, byval, len);
4832 : : }
4833 : :
4834 : : /*
4835 : : * Copy datum to *dest and return total space used (including align padding)
4836 : : *
4837 : : * Caller must have handled case of NULL element
4838 : : */
4839 : : static int
4840 : 9948637 : ArrayCastAndSet(Datum src,
4841 : : int typlen,
4842 : : bool typbyval,
4843 : : uint8 typalignby,
4844 : : char *dest)
4845 : : {
4846 : : int inc;
4847 : :
4848 [ + + ]: 9948637 : if (typlen > 0)
4849 : : {
4850 [ + + ]: 7972960 : if (typbyval)
4851 : 4896846 : store_att_byval(dest, src, typlen);
4852 : : else
4853 : 3076114 : memmove(dest, DatumGetPointer(src), typlen);
4854 : 7972960 : inc = att_nominal_alignby(typlen, typalignby);
4855 : : }
4856 : : else
4857 : : {
4858 : : Assert(!typbyval);
4859 [ + - + + ]: 1975677 : inc = att_addlength_datum(0, typlen, src);
4860 : 1975677 : memmove(dest, DatumGetPointer(src), inc);
4861 : 1975677 : inc = att_nominal_alignby(inc, typalignby);
4862 : : }
4863 : :
4864 : 9948637 : return inc;
4865 : : }
4866 : :
4867 : : /*
4868 : : * Advance ptr over nitems array elements
4869 : : *
4870 : : * ptr: starting location in array
4871 : : * offset: 0-based linear element number of first element (the one at *ptr)
4872 : : * nullbitmap: start of array's null bitmap, or NULL if none
4873 : : * nitems: number of array elements to advance over (>= 0)
4874 : : * typlen, typbyval, typalign: storage parameters of array element datatype
4875 : : *
4876 : : * It is caller's responsibility to ensure that nitems is within range
4877 : : */
4878 : : static char *
4879 : 511055 : array_seek(char *ptr, int offset, uint8 *nullbitmap, int nitems,
4880 : : int typlen, bool typbyval, char typalign)
4881 : : {
4882 : 511055 : uint8 typalignby = typalign_to_alignby(typalign);
4883 : : int bitmask;
4884 : : int i;
4885 : :
4886 : : /* easy if fixed-size elements and no NULLs */
4887 [ + + + + ]: 511055 : if (typlen > 0 && !nullbitmap)
4888 : 371805 : return ptr + nitems * ((Size) att_nominal_alignby(typlen, typalignby));
4889 : :
4890 : : /* seems worth having separate loops for NULL and no-NULLs cases */
4891 [ + + ]: 139250 : if (nullbitmap)
4892 : : {
4893 : 402 : nullbitmap += offset / 8;
4894 : 402 : bitmask = 1 << (offset % 8);
4895 : :
4896 [ + + ]: 1234 : for (i = 0; i < nitems; i++)
4897 : : {
4898 [ + + ]: 832 : if (*nullbitmap & bitmask)
4899 : : {
4900 [ + + + - ]: 592 : ptr = att_addlength_pointer(ptr, typlen, ptr);
4901 : 592 : ptr = (char *) att_nominal_alignby(ptr, typalignby);
4902 : : }
4903 : 832 : bitmask <<= 1;
4904 [ + + ]: 832 : if (bitmask == 0x100)
4905 : : {
4906 : 32 : nullbitmap++;
4907 : 32 : bitmask = 1;
4908 : : }
4909 : : }
4910 : : }
4911 : : else
4912 : : {
4913 [ + + ]: 612863 : for (i = 0; i < nitems; i++)
4914 : : {
4915 [ - + + - ]: 474015 : ptr = att_addlength_pointer(ptr, typlen, ptr);
4916 : 474015 : ptr = (char *) att_nominal_alignby(ptr, typalignby);
4917 : : }
4918 : : }
4919 : 139250 : return ptr;
4920 : : }
4921 : :
4922 : : /*
4923 : : * Compute total size of the nitems array elements starting at *ptr
4924 : : *
4925 : : * Parameters same as for array_seek
4926 : : */
4927 : : static int
4928 : 1105 : array_nelems_size(char *ptr, int offset, uint8 *nullbitmap, int nitems,
4929 : : int typlen, bool typbyval, char typalign)
4930 : : {
4931 : 1105 : return array_seek(ptr, offset, nullbitmap, nitems,
4932 : 1105 : typlen, typbyval, typalign) - ptr;
4933 : : }
4934 : :
4935 : : /*
4936 : : * Copy nitems array elements from srcptr to destptr
4937 : : *
4938 : : * destptr: starting destination location (must be enough room!)
4939 : : * nitems: number of array elements to copy (>= 0)
4940 : : * srcptr: starting location in source array
4941 : : * offset: 0-based linear element number of first element (the one at *srcptr)
4942 : : * nullbitmap: start of source array's null bitmap, or NULL if none
4943 : : * typlen, typbyval, typalign: storage parameters of array element datatype
4944 : : *
4945 : : * Returns number of bytes copied
4946 : : *
4947 : : * NB: this does not take care of setting up the destination's null bitmap!
4948 : : */
4949 : : static int
4950 : 794 : array_copy(char *destptr, int nitems,
4951 : : char *srcptr, int offset, uint8 *nullbitmap,
4952 : : int typlen, bool typbyval, char typalign)
4953 : : {
4954 : : int numbytes;
4955 : :
4956 : 794 : numbytes = array_nelems_size(srcptr, offset, nullbitmap, nitems,
4957 : : typlen, typbyval, typalign);
4958 : 794 : memcpy(destptr, srcptr, numbytes);
4959 : 794 : return numbytes;
4960 : : }
4961 : :
4962 : : /*
4963 : : * Copy nitems null-bitmap bits from source to destination
4964 : : *
4965 : : * destbitmap: start of destination array's null bitmap (mustn't be NULL)
4966 : : * destoffset: 0-based linear element number of first dest element
4967 : : * srcbitmap: start of source array's null bitmap, or NULL if none
4968 : : * srcoffset: 0-based linear element number of first source element
4969 : : * nitems: number of bits to copy (>= 0)
4970 : : *
4971 : : * If srcbitmap is NULL then we assume the source is all-non-NULL and
4972 : : * fill 1's into the destination bitmap. Note that only the specified
4973 : : * bits in the destination map are changed, not any before or after.
4974 : : *
4975 : : * Note: this could certainly be optimized using standard bitblt methods.
4976 : : * However, it's not clear that the typical Postgres array has enough elements
4977 : : * to make it worth worrying too much. For the moment, KISS.
4978 : : */
4979 : : void
4980 : 20696 : array_bitmap_copy(uint8 *destbitmap, int destoffset,
4981 : : const uint8 *srcbitmap, int srcoffset,
4982 : : int nitems)
4983 : : {
4984 : : int destbitmask,
4985 : : destbitval,
4986 : : srcbitmask,
4987 : : srcbitval;
4988 : :
4989 : : Assert(destbitmap);
4990 [ + + ]: 20696 : if (nitems <= 0)
4991 : 126 : return; /* don't risk fetch off end of memory */
4992 : 20570 : destbitmap += destoffset / 8;
4993 : 20570 : destbitmask = 1 << (destoffset % 8);
4994 : 20570 : destbitval = *destbitmap;
4995 [ + + ]: 20570 : if (srcbitmap)
4996 : : {
4997 : 10468 : srcbitmap += srcoffset / 8;
4998 : 10468 : srcbitmask = 1 << (srcoffset % 8);
4999 : 10468 : srcbitval = *srcbitmap;
5000 [ + + ]: 45145 : while (nitems-- > 0)
5001 : : {
5002 [ + + ]: 34677 : if (srcbitval & srcbitmask)
5003 : 12644 : destbitval |= destbitmask;
5004 : : else
5005 : 22033 : destbitval &= ~destbitmask;
5006 : 34677 : destbitmask <<= 1;
5007 [ + + ]: 34677 : if (destbitmask == 0x100)
5008 : : {
5009 : 3955 : *destbitmap++ = destbitval;
5010 : 3955 : destbitmask = 1;
5011 [ + + ]: 3955 : if (nitems > 0)
5012 : 2936 : destbitval = *destbitmap;
5013 : : }
5014 : 34677 : srcbitmask <<= 1;
5015 [ + + ]: 34677 : if (srcbitmask == 0x100)
5016 : : {
5017 : 2953 : srcbitmap++;
5018 : 2953 : srcbitmask = 1;
5019 [ + + ]: 2953 : if (nitems > 0)
5020 : 2908 : srcbitval = *srcbitmap;
5021 : : }
5022 : : }
5023 [ + + ]: 10468 : if (destbitmask != 1)
5024 : 9449 : *destbitmap = destbitval;
5025 : : }
5026 : : else
5027 : : {
5028 [ + + ]: 20412 : while (nitems-- > 0)
5029 : : {
5030 : 10310 : destbitval |= destbitmask;
5031 : 10310 : destbitmask <<= 1;
5032 [ + + ]: 10310 : if (destbitmask == 0x100)
5033 : : {
5034 : 1534 : *destbitmap++ = destbitval;
5035 : 1534 : destbitmask = 1;
5036 [ - + ]: 1534 : if (nitems > 0)
5037 : 0 : destbitval = *destbitmap;
5038 : : }
5039 : : }
5040 [ + + ]: 10102 : if (destbitmask != 1)
5041 : 8568 : *destbitmap = destbitval;
5042 : : }
5043 : : }
5044 : :
5045 : : /*
5046 : : * Compute space needed for a slice of an array
5047 : : *
5048 : : * We assume the caller has verified that the slice coordinates are valid.
5049 : : */
5050 : : static int
5051 : 208 : array_slice_size(char *arraydataptr, uint8 *arraynullsptr,
5052 : : int ndim, int *dim, int *lb,
5053 : : int *st, int *endp,
5054 : : int typlen, bool typbyval, char typalign)
5055 : : {
5056 : : int src_offset,
5057 : : span[MAXDIM],
5058 : : prod[MAXDIM],
5059 : : dist[MAXDIM],
5060 : : indx[MAXDIM];
5061 : : char *ptr;
5062 : : int i,
5063 : : j,
5064 : : inc;
5065 : 208 : int count = 0;
5066 : 208 : uint8 typalignby = typalign_to_alignby(typalign);
5067 : :
5068 : 208 : mda_get_range(ndim, span, st, endp);
5069 : :
5070 : : /* Pretty easy for fixed element length without nulls ... */
5071 [ + + + + ]: 208 : if (typlen > 0 && !arraynullsptr)
5072 : 156 : return ArrayGetNItems(ndim, span) * att_nominal_alignby(typlen, typalignby);
5073 : :
5074 : : /* Else gotta do it the hard way */
5075 : 52 : src_offset = ArrayGetOffset(ndim, dim, lb, st);
5076 : 52 : ptr = array_seek(arraydataptr, 0, arraynullsptr, src_offset,
5077 : : typlen, typbyval, typalign);
5078 : 52 : mda_get_prod(ndim, dim, prod);
5079 : 52 : mda_get_offset_values(ndim, dist, prod, span);
5080 [ + + ]: 132 : for (i = 0; i < ndim; i++)
5081 : 80 : indx[i] = 0;
5082 : 52 : j = ndim - 1;
5083 : : do
5084 : : {
5085 [ - + ]: 172 : if (dist[j])
5086 : : {
5087 : 0 : ptr = array_seek(ptr, src_offset, arraynullsptr, dist[j],
5088 : : typlen, typbyval, typalign);
5089 : 0 : src_offset += dist[j];
5090 : : }
5091 [ + + ]: 172 : if (!array_get_isnull(arraynullsptr, src_offset))
5092 : : {
5093 [ + + + - ]: 164 : inc = att_addlength_pointer(0, typlen, ptr);
5094 : 164 : inc = att_nominal_alignby(inc, typalignby);
5095 : 164 : ptr += inc;
5096 : 164 : count += inc;
5097 : : }
5098 : 172 : src_offset++;
5099 [ + + ]: 172 : } while ((j = mda_next_tuple(ndim, indx, span)) != -1);
5100 : 52 : return count;
5101 : : }
5102 : :
5103 : : /*
5104 : : * Extract a slice of an array into consecutive elements in the destination
5105 : : * array.
5106 : : *
5107 : : * We assume the caller has verified that the slice coordinates are valid,
5108 : : * allocated enough storage for the result, and initialized the header
5109 : : * of the new array.
5110 : : */
5111 : : static void
5112 : 188 : array_extract_slice(ArrayType *newarray,
5113 : : int ndim,
5114 : : int *dim,
5115 : : int *lb,
5116 : : char *arraydataptr,
5117 : : uint8 *arraynullsptr,
5118 : : int *st,
5119 : : int *endp,
5120 : : int typlen,
5121 : : bool typbyval,
5122 : : char typalign)
5123 : : {
5124 [ + + ]: 188 : char *destdataptr = ARR_DATA_PTR(newarray);
5125 [ + + ]: 188 : uint8 *destnullsptr = ARR_NULLBITMAP(newarray);
5126 : : char *srcdataptr;
5127 : : int src_offset,
5128 : : dest_offset,
5129 : : prod[MAXDIM],
5130 : : span[MAXDIM],
5131 : : dist[MAXDIM],
5132 : : indx[MAXDIM];
5133 : : int i,
5134 : : j,
5135 : : inc;
5136 : :
5137 : 188 : src_offset = ArrayGetOffset(ndim, dim, lb, st);
5138 : 188 : srcdataptr = array_seek(arraydataptr, 0, arraynullsptr, src_offset,
5139 : : typlen, typbyval, typalign);
5140 : 188 : mda_get_prod(ndim, dim, prod);
5141 : 188 : mda_get_range(ndim, span, st, endp);
5142 : 188 : mda_get_offset_values(ndim, dist, prod, span);
5143 [ + + ]: 476 : for (i = 0; i < ndim; i++)
5144 : 288 : indx[i] = 0;
5145 : 188 : dest_offset = 0;
5146 : 188 : j = ndim - 1;
5147 : : do
5148 : : {
5149 [ + + ]: 690 : if (dist[j])
5150 : : {
5151 : : /* skip unwanted elements */
5152 : 23 : srcdataptr = array_seek(srcdataptr, src_offset, arraynullsptr,
5153 : : dist[j],
5154 : : typlen, typbyval, typalign);
5155 : 23 : src_offset += dist[j];
5156 : : }
5157 : 690 : inc = array_copy(destdataptr, 1,
5158 : : srcdataptr, src_offset, arraynullsptr,
5159 : : typlen, typbyval, typalign);
5160 [ + + ]: 690 : if (destnullsptr)
5161 : 120 : array_bitmap_copy(destnullsptr, dest_offset,
5162 : : arraynullsptr, src_offset,
5163 : : 1);
5164 : 690 : destdataptr += inc;
5165 : 690 : srcdataptr += inc;
5166 : 690 : src_offset++;
5167 : 690 : dest_offset++;
5168 [ + + ]: 690 : } while ((j = mda_next_tuple(ndim, indx, span)) != -1);
5169 : 188 : }
5170 : :
5171 : : /*
5172 : : * Insert a slice into an array.
5173 : : *
5174 : : * ndim/dim[]/lb[] are dimensions of the original array. A new array with
5175 : : * those same dimensions is to be constructed. destArray must already
5176 : : * have been allocated and its header initialized.
5177 : : *
5178 : : * st[]/endp[] identify the slice to be replaced. Elements within the slice
5179 : : * volume are taken from consecutive elements of the srcArray; elements
5180 : : * outside it are copied from origArray.
5181 : : *
5182 : : * We assume the caller has verified that the slice coordinates are valid.
5183 : : */
5184 : : static void
5185 : 20 : array_insert_slice(ArrayType *destArray,
5186 : : ArrayType *origArray,
5187 : : ArrayType *srcArray,
5188 : : int ndim,
5189 : : int *dim,
5190 : : int *lb,
5191 : : int *st,
5192 : : int *endp,
5193 : : int typlen,
5194 : : bool typbyval,
5195 : : char typalign)
5196 : : {
5197 [ - + ]: 20 : char *destPtr = ARR_DATA_PTR(destArray);
5198 [ - + ]: 20 : char *origPtr = ARR_DATA_PTR(origArray);
5199 [ - + ]: 20 : char *srcPtr = ARR_DATA_PTR(srcArray);
5200 [ - + ]: 20 : uint8 *destBitmap = ARR_NULLBITMAP(destArray);
5201 [ - + ]: 20 : uint8 *origBitmap = ARR_NULLBITMAP(origArray);
5202 [ - + ]: 20 : uint8 *srcBitmap = ARR_NULLBITMAP(srcArray);
5203 : 20 : int orignitems = ArrayGetNItems(ARR_NDIM(origArray),
5204 : : ARR_DIMS(origArray));
5205 : : int dest_offset,
5206 : : orig_offset,
5207 : : src_offset,
5208 : : prod[MAXDIM],
5209 : : span[MAXDIM],
5210 : : dist[MAXDIM],
5211 : : indx[MAXDIM];
5212 : : int i,
5213 : : j,
5214 : : inc;
5215 : :
5216 : 20 : dest_offset = ArrayGetOffset(ndim, dim, lb, st);
5217 : : /* copy items before the slice start */
5218 : 20 : inc = array_copy(destPtr, dest_offset,
5219 : : origPtr, 0, origBitmap,
5220 : : typlen, typbyval, typalign);
5221 : 20 : destPtr += inc;
5222 : 20 : origPtr += inc;
5223 [ - + ]: 20 : if (destBitmap)
5224 : 0 : array_bitmap_copy(destBitmap, 0, origBitmap, 0, dest_offset);
5225 : 20 : orig_offset = dest_offset;
5226 : 20 : mda_get_prod(ndim, dim, prod);
5227 : 20 : mda_get_range(ndim, span, st, endp);
5228 : 20 : mda_get_offset_values(ndim, dist, prod, span);
5229 [ + + ]: 68 : for (i = 0; i < ndim; i++)
5230 : 48 : indx[i] = 0;
5231 : 20 : src_offset = 0;
5232 : 20 : j = ndim - 1;
5233 : : do
5234 : : {
5235 : : /* Copy/advance over elements between here and next part of slice */
5236 [ + + ]: 52 : if (dist[j])
5237 : : {
5238 : 12 : inc = array_copy(destPtr, dist[j],
5239 : : origPtr, orig_offset, origBitmap,
5240 : : typlen, typbyval, typalign);
5241 : 12 : destPtr += inc;
5242 : 12 : origPtr += inc;
5243 [ - + ]: 12 : if (destBitmap)
5244 : 0 : array_bitmap_copy(destBitmap, dest_offset,
5245 : : origBitmap, orig_offset,
5246 : : dist[j]);
5247 : 12 : dest_offset += dist[j];
5248 : 12 : orig_offset += dist[j];
5249 : : }
5250 : : /* Copy new element at this slice position */
5251 : 52 : inc = array_copy(destPtr, 1,
5252 : : srcPtr, src_offset, srcBitmap,
5253 : : typlen, typbyval, typalign);
5254 [ - + ]: 52 : if (destBitmap)
5255 : 0 : array_bitmap_copy(destBitmap, dest_offset,
5256 : : srcBitmap, src_offset,
5257 : : 1);
5258 : 52 : destPtr += inc;
5259 : 52 : srcPtr += inc;
5260 : 52 : dest_offset++;
5261 : 52 : src_offset++;
5262 : : /* Advance over old element at this slice position */
5263 : 52 : origPtr = array_seek(origPtr, orig_offset, origBitmap, 1,
5264 : : typlen, typbyval, typalign);
5265 : 52 : orig_offset++;
5266 [ + + ]: 52 : } while ((j = mda_next_tuple(ndim, indx, span)) != -1);
5267 : :
5268 : : /* don't miss any data at the end */
5269 : 20 : array_copy(destPtr, orignitems - orig_offset,
5270 : : origPtr, orig_offset, origBitmap,
5271 : : typlen, typbyval, typalign);
5272 [ - + ]: 20 : if (destBitmap)
5273 : 0 : array_bitmap_copy(destBitmap, dest_offset,
5274 : : origBitmap, orig_offset,
5275 : : orignitems - orig_offset);
5276 : 20 : }
5277 : :
5278 : : /*
5279 : : * initArrayResult - initialize an empty ArrayBuildState
5280 : : *
5281 : : * element_type is the array element type (must be a valid array element type)
5282 : : * rcontext is where to keep working state
5283 : : * subcontext is a flag determining whether to use a separate memory context
5284 : : *
5285 : : * Note: there are two common schemes for using accumArrayResult().
5286 : : * In the older scheme, you start with a NULL ArrayBuildState pointer, and
5287 : : * call accumArrayResult once per element. In this scheme you end up with
5288 : : * a NULL pointer if there were no elements, which you need to special-case.
5289 : : * In the newer scheme, call initArrayResult and then call accumArrayResult
5290 : : * once per element. In this scheme you always end with a non-NULL pointer
5291 : : * that you can pass to makeArrayResult; you get an empty array if there
5292 : : * were no elements. This is preferred if an empty array is what you want.
5293 : : *
5294 : : * It's possible to choose whether to create a separate memory context for the
5295 : : * array build state, or whether to allocate it directly within rcontext.
5296 : : *
5297 : : * When there are many concurrent small states (e.g. array_agg() using hash
5298 : : * aggregation of many small groups), using a separate memory context for each
5299 : : * one may result in severe memory bloat. In such cases, use the same memory
5300 : : * context to initialize all such array build states, and pass
5301 : : * subcontext=false.
5302 : : *
5303 : : * In cases when the array build states have different lifetimes, using a
5304 : : * single memory context is impractical. Instead, pass subcontext=true so that
5305 : : * the array build states can be freed individually.
5306 : : */
5307 : : ArrayBuildState *
5308 : 219732 : initArrayResult(Oid element_type, MemoryContext rcontext, bool subcontext)
5309 : : {
5310 : : /*
5311 : : * When using a subcontext, we can afford to start with a somewhat larger
5312 : : * initial array size. Without subcontexts, we'd better hope that most of
5313 : : * the states stay small ...
5314 : : */
5315 [ + + ]: 219732 : return initArrayResultWithSize(element_type, rcontext, subcontext,
5316 : : subcontext ? 64 : 8);
5317 : : }
5318 : :
5319 : : /*
5320 : : * initArrayResultWithSize
5321 : : * As initArrayResult, but allow the initial size of the allocated arrays
5322 : : * to be specified.
5323 : : */
5324 : : ArrayBuildState *
5325 : 219842 : initArrayResultWithSize(Oid element_type, MemoryContext rcontext,
5326 : : bool subcontext, int initsize)
5327 : : {
5328 : : ArrayBuildState *astate;
5329 : 219842 : MemoryContext arr_context = rcontext;
5330 : :
5331 : : /* Make a temporary context to hold all the junk */
5332 [ + + ]: 219842 : if (subcontext)
5333 : 143030 : arr_context = AllocSetContextCreate(rcontext,
5334 : : "accumArrayResult",
5335 : : ALLOCSET_DEFAULT_SIZES);
5336 : :
5337 : : astate = (ArrayBuildState *)
5338 : 219842 : MemoryContextAlloc(arr_context, sizeof(ArrayBuildState));
5339 : 219842 : astate->mcontext = arr_context;
5340 : 219842 : astate->private_cxt = subcontext;
5341 : 219842 : astate->alen = initsize;
5342 : 219842 : astate->dvalues = (Datum *)
5343 : 219842 : MemoryContextAlloc(arr_context, astate->alen * sizeof(Datum));
5344 : 219842 : astate->dnulls = (bool *)
5345 : 219842 : MemoryContextAlloc(arr_context, astate->alen * sizeof(bool));
5346 : 219842 : astate->nelems = 0;
5347 : 219842 : astate->element_type = element_type;
5348 : 219842 : get_typlenbyvalalign(element_type,
5349 : : &astate->typlen,
5350 : : &astate->typbyval,
5351 : : &astate->typalign);
5352 : :
5353 : 219842 : return astate;
5354 : : }
5355 : :
5356 : : /*
5357 : : * accumArrayResult - accumulate one (more) Datum for an array result
5358 : : *
5359 : : * astate is working state (can be NULL on first call)
5360 : : * dvalue/disnull represent the new Datum to append to the array
5361 : : * element_type is the Datum's type (must be a valid array element type)
5362 : : * rcontext is where to keep working state
5363 : : */
5364 : : ArrayBuildState *
5365 : 2161933 : accumArrayResult(ArrayBuildState *astate,
5366 : : Datum dvalue, bool disnull,
5367 : : Oid element_type,
5368 : : MemoryContext rcontext)
5369 : : {
5370 : : MemoryContext oldcontext;
5371 : :
5372 [ + + ]: 2161933 : if (astate == NULL)
5373 : : {
5374 : : /* First time through --- initialize */
5375 : 110904 : astate = initArrayResult(element_type, rcontext, true);
5376 : : }
5377 : : else
5378 : : {
5379 : : Assert(astate->element_type == element_type);
5380 : : }
5381 : :
5382 : 2161933 : oldcontext = MemoryContextSwitchTo(astate->mcontext);
5383 : :
5384 : : /* enlarge dvalues[]/dnulls[] if needed */
5385 [ + + ]: 2161933 : if (astate->nelems >= astate->alen)
5386 : : {
5387 : 46740 : astate->alen *= 2;
5388 : : /* give an array-related error if we go past MaxAllocSize */
5389 [ - + ]: 46740 : if (!AllocSizeIsValid(astate->alen * sizeof(Datum)))
5390 [ # # ]: 0 : ereport(ERROR,
5391 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
5392 : : errmsg("array size exceeds the maximum allowed (%zu)",
5393 : : MaxAllocSize)));
5394 : 46740 : astate->dvalues = (Datum *)
5395 : 46740 : repalloc(astate->dvalues, astate->alen * sizeof(Datum));
5396 : 46740 : astate->dnulls = (bool *)
5397 : 46740 : repalloc(astate->dnulls, astate->alen * sizeof(bool));
5398 : : }
5399 : :
5400 : : /*
5401 : : * Ensure pass-by-ref stuff is copied into mcontext; and detoast it too if
5402 : : * it's varlena. (You might think that detoasting is not needed here
5403 : : * because construct_md_array can detoast the array elements later.
5404 : : * However, we must not let construct_md_array modify the ArrayBuildState
5405 : : * because that would mean array_agg_finalfn damages its input, which is
5406 : : * verboten. Also, this way frequently saves one copying step.)
5407 : : */
5408 [ + + + + ]: 2161933 : if (!disnull && !astate->typbyval)
5409 : : {
5410 [ + + ]: 1425133 : if (astate->typlen == -1)
5411 : 1005240 : dvalue = PointerGetDatum(PG_DETOAST_DATUM_COPY(dvalue));
5412 : : else
5413 : 419893 : dvalue = datumCopy(dvalue, astate->typbyval, astate->typlen);
5414 : : }
5415 : :
5416 : 2161933 : astate->dvalues[astate->nelems] = dvalue;
5417 : 2161933 : astate->dnulls[astate->nelems] = disnull;
5418 : 2161933 : astate->nelems++;
5419 : :
5420 : 2161933 : MemoryContextSwitchTo(oldcontext);
5421 : :
5422 : 2161933 : return astate;
5423 : : }
5424 : :
5425 : : /*
5426 : : * makeArrayResult - produce 1-D final result of accumArrayResult
5427 : : *
5428 : : * Note: only releases astate if it was initialized within a separate memory
5429 : : * context (i.e. using subcontext=true when calling initArrayResult).
5430 : : *
5431 : : * astate is working state (must not be NULL)
5432 : : * rcontext is where to construct result
5433 : : */
5434 : : Datum
5435 : 111042 : makeArrayResult(ArrayBuildState *astate,
5436 : : MemoryContext rcontext)
5437 : : {
5438 : : int ndims;
5439 : : int dims[1];
5440 : : int lbs[1];
5441 : :
5442 : : /* If no elements were presented, we want to create an empty array */
5443 : 111042 : ndims = (astate->nelems > 0) ? 1 : 0;
5444 : 111042 : dims[0] = astate->nelems;
5445 : 111042 : lbs[0] = 1;
5446 : :
5447 : 222084 : return makeMdArrayResult(astate, ndims, dims, lbs, rcontext,
5448 : 111042 : astate->private_cxt);
5449 : : }
5450 : :
5451 : : /*
5452 : : * makeMdArrayResult - produce multi-D final result of accumArrayResult
5453 : : *
5454 : : * beware: no check that specified dimensions match the number of values
5455 : : * accumulated.
5456 : : *
5457 : : * Note: if the astate was not initialized within a separate memory context
5458 : : * (that is, initArrayResult was called with subcontext=false), then using
5459 : : * release=true is illegal. Instead, release astate along with the rest of its
5460 : : * context when appropriate.
5461 : : *
5462 : : * astate is working state (must not be NULL)
5463 : : * rcontext is where to construct result
5464 : : * release is true if okay to release working state
5465 : : */
5466 : : Datum
5467 : 218958 : makeMdArrayResult(ArrayBuildState *astate,
5468 : : int ndims,
5469 : : int *dims,
5470 : : int *lbs,
5471 : : MemoryContext rcontext,
5472 : : bool release)
5473 : : {
5474 : : ArrayType *result;
5475 : : MemoryContext oldcontext;
5476 : :
5477 : : /* Build the final array result in rcontext */
5478 : 218958 : oldcontext = MemoryContextSwitchTo(rcontext);
5479 : :
5480 : 218958 : result = construct_md_array(astate->dvalues,
5481 : : astate->dnulls,
5482 : : ndims,
5483 : : dims,
5484 : : lbs,
5485 : : astate->element_type,
5486 : 218958 : astate->typlen,
5487 : 218958 : astate->typbyval,
5488 : 218958 : astate->typalign);
5489 : :
5490 : 218958 : MemoryContextSwitchTo(oldcontext);
5491 : :
5492 : : /* Clean up all the junk */
5493 [ + + ]: 218958 : if (release)
5494 : : {
5495 : : Assert(astate->private_cxt);
5496 : 142630 : MemoryContextDelete(astate->mcontext);
5497 : : }
5498 : :
5499 : 218958 : return PointerGetDatum(result);
5500 : : }
5501 : :
5502 : : /*
5503 : : * The following three functions provide essentially the same API as
5504 : : * initArrayResult/accumArrayResult/makeArrayResult, but instead of accepting
5505 : : * inputs that are array elements, they accept inputs that are arrays and
5506 : : * produce an output array having N+1 dimensions. The inputs must all have
5507 : : * identical dimensionality as well as element type.
5508 : : */
5509 : :
5510 : : /*
5511 : : * initArrayResultArr - initialize an empty ArrayBuildStateArr
5512 : : *
5513 : : * array_type is the array type (must be a valid varlena array type)
5514 : : * element_type is the type of the array's elements (lookup if InvalidOid)
5515 : : * rcontext is where to keep working state
5516 : : * subcontext is a flag determining whether to use a separate memory context
5517 : : */
5518 : : ArrayBuildStateArr *
5519 : 408 : initArrayResultArr(Oid array_type, Oid element_type, MemoryContext rcontext,
5520 : : bool subcontext)
5521 : : {
5522 : : ArrayBuildStateArr *astate;
5523 : 408 : MemoryContext arr_context = rcontext; /* by default use the parent ctx */
5524 : :
5525 : : /* Lookup element type, unless element_type already provided */
5526 [ + + ]: 408 : if (!OidIsValid(element_type))
5527 : : {
5528 : 338 : element_type = get_element_type(array_type);
5529 : :
5530 [ - + ]: 338 : if (!OidIsValid(element_type))
5531 [ # # ]: 0 : ereport(ERROR,
5532 : : (errcode(ERRCODE_DATATYPE_MISMATCH),
5533 : : errmsg("data type %s is not an array type",
5534 : : format_type_be(array_type))));
5535 : : }
5536 : :
5537 : : /* Make a temporary context to hold all the junk */
5538 [ + + ]: 408 : if (subcontext)
5539 : 38 : arr_context = AllocSetContextCreate(rcontext,
5540 : : "accumArrayResultArr",
5541 : : ALLOCSET_DEFAULT_SIZES);
5542 : :
5543 : : /* Note we initialize all fields to zero */
5544 : : astate = (ArrayBuildStateArr *)
5545 : 408 : MemoryContextAllocZero(arr_context, sizeof(ArrayBuildStateArr));
5546 : 408 : astate->mcontext = arr_context;
5547 : 408 : astate->private_cxt = subcontext;
5548 : :
5549 : : /* Save relevant datatype information */
5550 : 408 : astate->array_type = array_type;
5551 : 408 : astate->element_type = element_type;
5552 : :
5553 : 408 : return astate;
5554 : : }
5555 : :
5556 : : /*
5557 : : * accumArrayResultArr - accumulate one (more) sub-array for an array result
5558 : : *
5559 : : * astate is working state (can be NULL on first call)
5560 : : * dvalue/disnull represent the new sub-array to append to the array
5561 : : * array_type is the array type (must be a valid varlena array type)
5562 : : * rcontext is where to keep working state
5563 : : */
5564 : : ArrayBuildStateArr *
5565 : 84000 : accumArrayResultArr(ArrayBuildStateArr *astate,
5566 : : Datum dvalue, bool disnull,
5567 : : Oid array_type,
5568 : : MemoryContext rcontext)
5569 : : {
5570 : : ArrayType *arg;
5571 : : MemoryContext oldcontext;
5572 : : int *dims,
5573 : : *lbs,
5574 : : ndims,
5575 : : nitems,
5576 : : ndatabytes;
5577 : : char *data;
5578 : : int i;
5579 : : int newnitems;
5580 : :
5581 : : /*
5582 : : * We disallow accumulating null subarrays. Another plausible definition
5583 : : * is to ignore them, but callers that want that can just skip calling
5584 : : * this function.
5585 : : */
5586 [ + + ]: 84000 : if (disnull)
5587 [ + - ]: 4 : ereport(ERROR,
5588 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5589 : : errmsg("cannot accumulate null arrays")));
5590 : :
5591 : : /* Detoast input array in caller's context */
5592 : 83996 : arg = DatumGetArrayTypeP(dvalue);
5593 : :
5594 [ - + ]: 83996 : if (astate == NULL)
5595 : 0 : astate = initArrayResultArr(array_type, InvalidOid, rcontext, true);
5596 : : else
5597 : : Assert(astate->array_type == array_type);
5598 : :
5599 : 83996 : oldcontext = MemoryContextSwitchTo(astate->mcontext);
5600 : :
5601 : : /* Collect this input's dimensions */
5602 : 83996 : ndims = ARR_NDIM(arg);
5603 : 83996 : dims = ARR_DIMS(arg);
5604 : 83996 : lbs = ARR_LBOUND(arg);
5605 [ + + ]: 83996 : data = ARR_DATA_PTR(arg);
5606 : 83996 : nitems = ArrayGetNItems(ndims, dims);
5607 [ + + ]: 83996 : ndatabytes = ARR_SIZE(arg) - ARR_DATA_OFFSET(arg);
5608 : :
5609 : : /* Check that the array doesn't grow too large */
5610 : 83996 : newnitems = astate->nitems + nitems;
5611 [ - + ]: 83996 : if (newnitems > MaxArraySize)
5612 [ # # ]: 0 : ereport(ERROR,
5613 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
5614 : : errmsg("array size exceeds the maximum allowed (%zu)",
5615 : : MaxArraySize)));
5616 : :
5617 [ + + ]: 83996 : if (astate->ndims == 0)
5618 : : {
5619 : : /* First input; check/save the dimensionality info */
5620 : :
5621 : : /* Should we allow empty inputs and just produce an empty output? */
5622 [ + + ]: 294 : if (ndims == 0)
5623 [ + - ]: 4 : ereport(ERROR,
5624 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
5625 : : errmsg("cannot accumulate empty arrays")));
5626 [ - + ]: 290 : if (ndims + 1 > MAXDIM)
5627 [ # # ]: 0 : ereport(ERROR,
5628 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
5629 : : errmsg("number of array dimensions (%d) exceeds the maximum allowed (%d)",
5630 : : ndims + 1, MAXDIM)));
5631 : :
5632 : : /*
5633 : : * The output array will have n+1 dimensions, with the ones after the
5634 : : * first matching the input's dimensions.
5635 : : */
5636 : 290 : astate->ndims = ndims + 1;
5637 : 290 : astate->dims[0] = 0;
5638 : 290 : memcpy(&astate->dims[1], dims, ndims * sizeof(int));
5639 : 290 : astate->lbs[0] = 1;
5640 : 290 : memcpy(&astate->lbs[1], lbs, ndims * sizeof(int));
5641 : :
5642 : : /* Allocate at least enough data space for this item */
5643 : 290 : astate->abytes = pg_nextpower2_32(Max(1024, ndatabytes + 1));
5644 : 290 : astate->data = (char *) palloc(astate->abytes);
5645 : : }
5646 : : else
5647 : : {
5648 : : /* Second or later input: must match first input's dimensionality */
5649 [ - + ]: 83702 : if (astate->ndims != ndims + 1)
5650 [ # # ]: 0 : ereport(ERROR,
5651 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
5652 : : errmsg("cannot accumulate arrays of different dimensionality")));
5653 [ + + ]: 167400 : for (i = 0; i < ndims; i++)
5654 : : {
5655 [ + + - + ]: 83702 : if (astate->dims[i + 1] != dims[i] || astate->lbs[i + 1] != lbs[i])
5656 [ + - ]: 4 : ereport(ERROR,
5657 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
5658 : : errmsg("cannot accumulate arrays of different dimensionality")));
5659 : : }
5660 : :
5661 : : /* Enlarge data space if needed */
5662 [ + + ]: 83698 : if (astate->nbytes + ndatabytes > astate->abytes)
5663 : : {
5664 : 111 : astate->abytes = Max(astate->abytes * 2,
5665 : : astate->nbytes + ndatabytes);
5666 : 111 : astate->data = (char *) repalloc(astate->data, astate->abytes);
5667 : : }
5668 : : }
5669 : :
5670 : : /*
5671 : : * Copy the data portion of the sub-array. Note we assume that the
5672 : : * advertised data length of the sub-array is properly aligned. We do not
5673 : : * have to worry about detoasting elements since whatever's in the
5674 : : * sub-array should be OK already.
5675 : : */
5676 : 83988 : memcpy(astate->data + astate->nbytes, data, ndatabytes);
5677 : 83988 : astate->nbytes += ndatabytes;
5678 : :
5679 : : /* Deal with null bitmap if needed */
5680 [ + + + + ]: 83988 : if (astate->nullbitmap || ARR_HASNULL(arg))
5681 : : {
5682 [ + + ]: 20064 : if (astate->nullbitmap == NULL)
5683 : : {
5684 : : /*
5685 : : * First input with nulls; we must retrospectively handle any
5686 : : * previous inputs by marking all their items non-null.
5687 : : */
5688 : 80 : astate->aitems = pg_nextpower2_32(Max(256, newnitems + 1));
5689 : 80 : astate->nullbitmap = (uint8 *) palloc((astate->aitems + 7) / 8);
5690 : 80 : array_bitmap_copy(astate->nullbitmap, 0,
5691 : : NULL, 0,
5692 : : astate->nitems);
5693 : : }
5694 [ + + ]: 19984 : else if (newnitems > astate->aitems)
5695 : : {
5696 : 40 : astate->aitems = Max(astate->aitems * 2, newnitems);
5697 : 40 : astate->nullbitmap = (uint8 *)
5698 : 40 : repalloc(astate->nullbitmap, (astate->aitems + 7) / 8);
5699 : : }
5700 : 20064 : array_bitmap_copy(astate->nullbitmap, astate->nitems,
5701 [ + + ]: 20064 : ARR_NULLBITMAP(arg), 0,
5702 : : nitems);
5703 : : }
5704 : :
5705 : 83988 : astate->nitems = newnitems;
5706 : 83988 : astate->dims[0] += 1;
5707 : :
5708 : 83988 : MemoryContextSwitchTo(oldcontext);
5709 : :
5710 : : /* Release detoasted copy if any */
5711 [ + + ]: 83988 : if (arg != DatumGetPointer(dvalue))
5712 : 3774 : pfree(arg);
5713 : :
5714 : 83988 : return astate;
5715 : : }
5716 : :
5717 : : /*
5718 : : * makeArrayResultArr - produce N+1-D final result of accumArrayResultArr
5719 : : *
5720 : : * astate is working state (must not be NULL)
5721 : : * rcontext is where to construct result
5722 : : * release is true if okay to release working state
5723 : : */
5724 : : Datum
5725 : 256 : makeArrayResultArr(ArrayBuildStateArr *astate,
5726 : : MemoryContext rcontext,
5727 : : bool release)
5728 : : {
5729 : : ArrayType *result;
5730 : : MemoryContext oldcontext;
5731 : :
5732 : : /* Build the final array result in rcontext */
5733 : 256 : oldcontext = MemoryContextSwitchTo(rcontext);
5734 : :
5735 [ - + ]: 256 : if (astate->ndims == 0)
5736 : : {
5737 : : /* No inputs, return empty array */
5738 : 0 : result = construct_empty_array(astate->element_type);
5739 : : }
5740 : : else
5741 : : {
5742 : : int dataoffset,
5743 : : nbytes;
5744 : :
5745 : : /* Check for overflow of the array dimensions */
5746 : 256 : (void) ArrayGetNItems(astate->ndims, astate->dims);
5747 : 256 : ArrayCheckBounds(astate->ndims, astate->dims, astate->lbs);
5748 : :
5749 : : /* Compute required space */
5750 : 256 : nbytes = astate->nbytes;
5751 [ + + ]: 256 : if (astate->nullbitmap != NULL)
5752 : : {
5753 : 65 : dataoffset = ARR_OVERHEAD_WITHNULLS(astate->ndims, astate->nitems);
5754 : 65 : nbytes += dataoffset;
5755 : : }
5756 : : else
5757 : : {
5758 : 191 : dataoffset = 0;
5759 : 191 : nbytes += ARR_OVERHEAD_NONULLS(astate->ndims);
5760 : : }
5761 : :
5762 : 256 : result = (ArrayType *) palloc0(nbytes);
5763 : 256 : SET_VARSIZE(result, nbytes);
5764 : 256 : result->ndim = astate->ndims;
5765 : 256 : result->dataoffset = dataoffset;
5766 : 256 : result->elemtype = astate->element_type;
5767 : :
5768 : 256 : memcpy(ARR_DIMS(result), astate->dims, astate->ndims * sizeof(int));
5769 : 256 : memcpy(ARR_LBOUND(result), astate->lbs, astate->ndims * sizeof(int));
5770 [ + + ]: 256 : memcpy(ARR_DATA_PTR(result), astate->data, astate->nbytes);
5771 : :
5772 [ + + ]: 256 : if (astate->nullbitmap != NULL)
5773 : 65 : array_bitmap_copy(ARR_NULLBITMAP(result), 0,
5774 [ + - ]: 65 : astate->nullbitmap, 0,
5775 : : astate->nitems);
5776 : : }
5777 : :
5778 : 256 : MemoryContextSwitchTo(oldcontext);
5779 : :
5780 : : /* Clean up all the junk */
5781 [ + + ]: 256 : if (release)
5782 : : {
5783 : : Assert(astate->private_cxt);
5784 : 38 : MemoryContextDelete(astate->mcontext);
5785 : : }
5786 : :
5787 : 256 : return PointerGetDatum(result);
5788 : : }
5789 : :
5790 : : /*
5791 : : * The following three functions provide essentially the same API as
5792 : : * initArrayResult/accumArrayResult/makeArrayResult, but can accept either
5793 : : * scalar or array inputs, invoking the appropriate set of functions above.
5794 : : */
5795 : :
5796 : : /*
5797 : : * initArrayResultAny - initialize an empty ArrayBuildStateAny
5798 : : *
5799 : : * input_type is the input datatype (either element or array type)
5800 : : * rcontext is where to keep working state
5801 : : * subcontext is a flag determining whether to use a separate memory context
5802 : : */
5803 : : ArrayBuildStateAny *
5804 : 30544 : initArrayResultAny(Oid input_type, MemoryContext rcontext, bool subcontext)
5805 : : {
5806 : : ArrayBuildStateAny *astate;
5807 : :
5808 : : /*
5809 : : * int2vector and oidvector will satisfy both get_element_type and
5810 : : * get_array_type. We prefer to treat them as scalars, to be consistent
5811 : : * with get_promoted_array_type. Hence, check get_array_type not
5812 : : * get_element_type.
5813 : : */
5814 [ + + ]: 30544 : if (!OidIsValid(get_array_type(input_type)))
5815 : : {
5816 : : /* Array case */
5817 : : ArrayBuildStateArr *arraystate;
5818 : :
5819 : 38 : arraystate = initArrayResultArr(input_type, InvalidOid, rcontext, subcontext);
5820 : : astate = (ArrayBuildStateAny *)
5821 : 38 : MemoryContextAlloc(arraystate->mcontext,
5822 : : sizeof(ArrayBuildStateAny));
5823 : 38 : astate->scalarstate = NULL;
5824 : 38 : astate->arraystate = arraystate;
5825 : : }
5826 : : else
5827 : : {
5828 : : /* Scalar case */
5829 : : ArrayBuildState *scalarstate;
5830 : :
5831 : 30506 : scalarstate = initArrayResult(input_type, rcontext, subcontext);
5832 : : astate = (ArrayBuildStateAny *)
5833 : 30506 : MemoryContextAlloc(scalarstate->mcontext,
5834 : : sizeof(ArrayBuildStateAny));
5835 : 30506 : astate->scalarstate = scalarstate;
5836 : 30506 : astate->arraystate = NULL;
5837 : : }
5838 : :
5839 : 30544 : return astate;
5840 : : }
5841 : :
5842 : : /*
5843 : : * accumArrayResultAny - accumulate one (more) input for an array result
5844 : : *
5845 : : * astate is working state (can be NULL on first call)
5846 : : * dvalue/disnull represent the new input to append to the array
5847 : : * input_type is the input datatype (either element or array type)
5848 : : * rcontext is where to keep working state
5849 : : */
5850 : : ArrayBuildStateAny *
5851 : 11128 : accumArrayResultAny(ArrayBuildStateAny *astate,
5852 : : Datum dvalue, bool disnull,
5853 : : Oid input_type,
5854 : : MemoryContext rcontext)
5855 : : {
5856 [ + + ]: 11128 : if (astate == NULL)
5857 : 99 : astate = initArrayResultAny(input_type, rcontext, true);
5858 : :
5859 [ + + ]: 11128 : if (astate->scalarstate)
5860 : 11021 : (void) accumArrayResult(astate->scalarstate,
5861 : : dvalue, disnull,
5862 : : input_type, rcontext);
5863 : : else
5864 : 107 : (void) accumArrayResultArr(astate->arraystate,
5865 : : dvalue, disnull,
5866 : : input_type, rcontext);
5867 : :
5868 : 11128 : return astate;
5869 : : }
5870 : :
5871 : : /*
5872 : : * makeArrayResultAny - produce final result of accumArrayResultAny
5873 : : *
5874 : : * astate is working state (must not be NULL)
5875 : : * rcontext is where to construct result
5876 : : * release is true if okay to release working state
5877 : : */
5878 : : Datum
5879 : 30544 : makeArrayResultAny(ArrayBuildStateAny *astate,
5880 : : MemoryContext rcontext, bool release)
5881 : : {
5882 : : Datum result;
5883 : :
5884 [ + + ]: 30544 : if (astate->scalarstate)
5885 : : {
5886 : : /* Must use makeMdArrayResult to support "release" parameter */
5887 : : int ndims;
5888 : : int dims[1];
5889 : : int lbs[1];
5890 : :
5891 : : /* If no elements were presented, we want to create an empty array */
5892 : 30506 : ndims = (astate->scalarstate->nelems > 0) ? 1 : 0;
5893 : 30506 : dims[0] = astate->scalarstate->nelems;
5894 : 30506 : lbs[0] = 1;
5895 : :
5896 : 30506 : result = makeMdArrayResult(astate->scalarstate, ndims, dims, lbs,
5897 : : rcontext, release);
5898 : : }
5899 : : else
5900 : : {
5901 : 38 : result = makeArrayResultArr(astate->arraystate,
5902 : : rcontext, release);
5903 : : }
5904 : 30544 : return result;
5905 : : }
5906 : :
5907 : :
5908 : : Datum
5909 : 192 : array_larger(PG_FUNCTION_ARGS)
5910 : : {
5911 [ + + ]: 192 : if (array_cmp(fcinfo) > 0)
5912 : 96 : PG_RETURN_DATUM(PG_GETARG_DATUM(0));
5913 : : else
5914 : 92 : PG_RETURN_DATUM(PG_GETARG_DATUM(1));
5915 : : }
5916 : :
5917 : : Datum
5918 : 172 : array_smaller(PG_FUNCTION_ARGS)
5919 : : {
5920 [ + + ]: 172 : if (array_cmp(fcinfo) < 0)
5921 : 116 : PG_RETURN_DATUM(PG_GETARG_DATUM(0));
5922 : : else
5923 : 56 : PG_RETURN_DATUM(PG_GETARG_DATUM(1));
5924 : : }
5925 : :
5926 : :
5927 : : typedef struct generate_subscripts_fctx
5928 : : {
5929 : : int32 lower;
5930 : : int32 upper;
5931 : : bool reverse;
5932 : : } generate_subscripts_fctx;
5933 : :
5934 : : /*
5935 : : * generate_subscripts(array anyarray, dim int [, reverse bool])
5936 : : * Returns all subscripts of the array for any dimension
5937 : : */
5938 : : Datum
5939 : 2630 : generate_subscripts(PG_FUNCTION_ARGS)
5940 : : {
5941 : : FuncCallContext *funcctx;
5942 : : MemoryContext oldcontext;
5943 : : generate_subscripts_fctx *fctx;
5944 : :
5945 : : /* stuff done only on the first call of the function */
5946 [ + + ]: 2630 : if (SRF_IS_FIRSTCALL())
5947 : : {
5948 : 1199 : AnyArrayType *v = PG_GETARG_ANY_ARRAY_P(0);
5949 : 1199 : int reqdim = PG_GETARG_INT32(1);
5950 : : int *lb,
5951 : : *dimv;
5952 : :
5953 : : /* create a function context for cross-call persistence */
5954 : 1199 : funcctx = SRF_FIRSTCALL_INIT();
5955 : :
5956 : : /* Sanity check: does it look like an array at all? */
5957 [ - + - - : 1199 : if (AARR_NDIM(v) <= 0 || AARR_NDIM(v) > MAXDIM)
+ + - + -
- - + ]
5958 : 5 : SRF_RETURN_DONE(funcctx);
5959 : :
5960 : : /* Sanity check: was the requested dim valid */
5961 [ + - - + : 1194 : if (reqdim <= 0 || reqdim > AARR_NDIM(v))
- + ]
5962 : 0 : SRF_RETURN_DONE(funcctx);
5963 : :
5964 : : /*
5965 : : * switch to memory context appropriate for multiple function calls
5966 : : */
5967 : 1194 : oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
5968 : 1194 : fctx = palloc_object(generate_subscripts_fctx);
5969 : :
5970 [ - + ]: 1194 : lb = AARR_LBOUND(v);
5971 [ - + ]: 1194 : dimv = AARR_DIMS(v);
5972 : :
5973 : 1194 : fctx->lower = lb[reqdim - 1];
5974 : 1194 : fctx->upper = dimv[reqdim - 1] + lb[reqdim - 1] - 1;
5975 [ - + - - ]: 1194 : fctx->reverse = (PG_NARGS() < 3) ? false : PG_GETARG_BOOL(2);
5976 : :
5977 : 1194 : funcctx->user_fctx = fctx;
5978 : :
5979 : 1194 : MemoryContextSwitchTo(oldcontext);
5980 : : }
5981 : :
5982 : 2625 : funcctx = SRF_PERCALL_SETUP();
5983 : :
5984 : 2625 : fctx = funcctx->user_fctx;
5985 : :
5986 [ + + ]: 2625 : if (fctx->lower <= fctx->upper)
5987 : : {
5988 [ + - ]: 1431 : if (!fctx->reverse)
5989 : 1431 : SRF_RETURN_NEXT(funcctx, Int32GetDatum(fctx->lower++));
5990 : : else
5991 : 0 : SRF_RETURN_NEXT(funcctx, Int32GetDatum(fctx->upper--));
5992 : : }
5993 : : else
5994 : : /* done when there are no more elements left */
5995 : 1194 : SRF_RETURN_DONE(funcctx);
5996 : : }
5997 : :
5998 : : /*
5999 : : * generate_subscripts_nodir
6000 : : * Implements the 2-argument version of generate_subscripts
6001 : : */
6002 : : Datum
6003 : 2630 : generate_subscripts_nodir(PG_FUNCTION_ARGS)
6004 : : {
6005 : : /* just call the other one -- it can handle both cases */
6006 : 2630 : return generate_subscripts(fcinfo);
6007 : : }
6008 : :
6009 : : /*
6010 : : * array_fill_with_lower_bounds
6011 : : * Create and fill array with defined lower bounds.
6012 : : */
6013 : : Datum
6014 : 51 : array_fill_with_lower_bounds(PG_FUNCTION_ARGS)
6015 : : {
6016 : : ArrayType *dims;
6017 : : ArrayType *lbs;
6018 : : ArrayType *result;
6019 : : Oid elmtype;
6020 : : Datum value;
6021 : : bool isnull;
6022 : :
6023 [ + + + + ]: 51 : if (PG_ARGISNULL(1) || PG_ARGISNULL(2))
6024 [ + - ]: 8 : ereport(ERROR,
6025 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6026 : : errmsg("dimension array or low bound array cannot be null")));
6027 : :
6028 : 43 : dims = PG_GETARG_ARRAYTYPE_P(1);
6029 : 43 : lbs = PG_GETARG_ARRAYTYPE_P(2);
6030 : :
6031 [ + + ]: 43 : if (!PG_ARGISNULL(0))
6032 : : {
6033 : 33 : value = PG_GETARG_DATUM(0);
6034 : 33 : isnull = false;
6035 : : }
6036 : : else
6037 : : {
6038 : 10 : value = 0;
6039 : 10 : isnull = true;
6040 : : }
6041 : :
6042 : 43 : elmtype = get_fn_expr_argtype(fcinfo->flinfo, 0);
6043 [ - + ]: 43 : if (!OidIsValid(elmtype))
6044 [ # # ]: 0 : elog(ERROR, "could not determine data type of input");
6045 : :
6046 : 43 : result = array_fill_internal(dims, lbs, value, isnull, elmtype, fcinfo);
6047 : 35 : PG_RETURN_ARRAYTYPE_P(result);
6048 : : }
6049 : :
6050 : : /*
6051 : : * array_fill
6052 : : * Create and fill array with default lower bounds.
6053 : : */
6054 : : Datum
6055 : 71 : array_fill(PG_FUNCTION_ARGS)
6056 : : {
6057 : : ArrayType *dims;
6058 : : ArrayType *result;
6059 : : Oid elmtype;
6060 : : Datum value;
6061 : : bool isnull;
6062 : :
6063 [ - + ]: 71 : if (PG_ARGISNULL(1))
6064 [ # # ]: 0 : ereport(ERROR,
6065 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6066 : : errmsg("dimension array or low bound array cannot be null")));
6067 : :
6068 : 71 : dims = PG_GETARG_ARRAYTYPE_P(1);
6069 : :
6070 [ + + ]: 71 : if (!PG_ARGISNULL(0))
6071 : : {
6072 : 61 : value = PG_GETARG_DATUM(0);
6073 : 61 : isnull = false;
6074 : : }
6075 : : else
6076 : : {
6077 : 10 : value = 0;
6078 : 10 : isnull = true;
6079 : : }
6080 : :
6081 : 71 : elmtype = get_fn_expr_argtype(fcinfo->flinfo, 0);
6082 [ - + ]: 71 : if (!OidIsValid(elmtype))
6083 [ # # ]: 0 : elog(ERROR, "could not determine data type of input");
6084 : :
6085 : 71 : result = array_fill_internal(dims, NULL, value, isnull, elmtype, fcinfo);
6086 : 63 : PG_RETURN_ARRAYTYPE_P(result);
6087 : : }
6088 : :
6089 : : static ArrayType *
6090 : 53 : create_array_envelope(int ndims, int *dimv, int *lbsv, int nbytes,
6091 : : Oid elmtype, int dataoffset)
6092 : : {
6093 : : ArrayType *result;
6094 : :
6095 : 53 : result = (ArrayType *) palloc0(nbytes);
6096 : 53 : SET_VARSIZE(result, nbytes);
6097 : 53 : result->ndim = ndims;
6098 : 53 : result->dataoffset = dataoffset;
6099 : 53 : result->elemtype = elmtype;
6100 : 53 : memcpy(ARR_DIMS(result), dimv, ndims * sizeof(int));
6101 : 53 : memcpy(ARR_LBOUND(result), lbsv, ndims * sizeof(int));
6102 : :
6103 : 53 : return result;
6104 : : }
6105 : :
6106 : : static ArrayType *
6107 : 114 : array_fill_internal(ArrayType *dims, ArrayType *lbs,
6108 : : Datum value, bool isnull, Oid elmtype,
6109 : : FunctionCallInfo fcinfo)
6110 : : {
6111 : : ArrayType *result;
6112 : : int *dimv;
6113 : : int *lbsv;
6114 : : int ndims;
6115 : : int nitems;
6116 : : int deflbs[MAXDIM];
6117 : : int16 elmlen;
6118 : : bool elmbyval;
6119 : : char elmalign;
6120 : : uint8 elmalignby;
6121 : : ArrayMetaState *my_extra;
6122 : :
6123 : : /*
6124 : : * Params checks
6125 : : */
6126 [ + + ]: 114 : if (ARR_NDIM(dims) > 1)
6127 [ + - ]: 4 : ereport(ERROR,
6128 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
6129 : : errmsg("wrong number of array subscripts"),
6130 : : errdetail("Dimension array must be one dimensional.")));
6131 : :
6132 [ + + ]: 110 : if (array_contains_nulls(dims))
6133 [ + - ]: 4 : ereport(ERROR,
6134 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6135 : : errmsg("dimension values cannot be null")));
6136 : :
6137 [ - + ]: 106 : dimv = (int *) ARR_DATA_PTR(dims);
6138 [ + + ]: 106 : ndims = (ARR_NDIM(dims) > 0) ? ARR_DIMS(dims)[0] : 0;
6139 : :
6140 [ - + ]: 106 : if (ndims < 0) /* we do allow zero-dimension arrays */
6141 [ # # ]: 0 : ereport(ERROR,
6142 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6143 : : errmsg("invalid number of dimensions: %d", ndims)));
6144 [ - + ]: 106 : if (ndims > MAXDIM)
6145 [ # # ]: 0 : ereport(ERROR,
6146 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
6147 : : errmsg("number of array dimensions (%d) exceeds the maximum allowed (%d)",
6148 : : ndims, MAXDIM)));
6149 : :
6150 [ + + ]: 106 : if (lbs != NULL)
6151 : : {
6152 [ - + ]: 43 : if (ARR_NDIM(lbs) > 1)
6153 [ # # ]: 0 : ereport(ERROR,
6154 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
6155 : : errmsg("wrong number of array subscripts"),
6156 : : errdetail("Dimension array must be one dimensional.")));
6157 : :
6158 [ - + ]: 43 : if (array_contains_nulls(lbs))
6159 [ # # ]: 0 : ereport(ERROR,
6160 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6161 : : errmsg("dimension values cannot be null")));
6162 : :
6163 [ + + + + ]: 43 : if (ndims != ((ARR_NDIM(lbs) > 0) ? ARR_DIMS(lbs)[0] : 0))
6164 [ + - ]: 8 : ereport(ERROR,
6165 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
6166 : : errmsg("wrong number of array subscripts"),
6167 : : errdetail("Low bound array has different size than dimensions array.")));
6168 : :
6169 [ - + ]: 35 : lbsv = (int *) ARR_DATA_PTR(lbs);
6170 : : }
6171 : : else
6172 : : {
6173 : : int i;
6174 : :
6175 [ + + ]: 441 : for (i = 0; i < MAXDIM; i++)
6176 : 378 : deflbs[i] = 1;
6177 : :
6178 : 63 : lbsv = deflbs;
6179 : : }
6180 : :
6181 : : /* This checks for overflow of the array dimensions */
6182 : 98 : nitems = ArrayGetNItems(ndims, dimv);
6183 : 98 : ArrayCheckBounds(ndims, dimv, lbsv);
6184 : :
6185 : : /* fast track for empty array */
6186 [ + + ]: 98 : if (nitems <= 0)
6187 : 45 : return construct_empty_array(elmtype);
6188 : :
6189 : : /*
6190 : : * We arrange to look up info about element type only once per series of
6191 : : * calls, assuming the element type doesn't change underneath us.
6192 : : */
6193 : 53 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
6194 [ + - ]: 53 : if (my_extra == NULL)
6195 : : {
6196 : 53 : fcinfo->flinfo->fn_extra = MemoryContextAlloc(fcinfo->flinfo->fn_mcxt,
6197 : : sizeof(ArrayMetaState));
6198 : 53 : my_extra = (ArrayMetaState *) fcinfo->flinfo->fn_extra;
6199 : 53 : my_extra->element_type = InvalidOid;
6200 : : }
6201 : :
6202 [ + - ]: 53 : if (my_extra->element_type != elmtype)
6203 : : {
6204 : : /* Get info about element type */
6205 : 53 : get_typlenbyvalalign(elmtype,
6206 : : &my_extra->typlen,
6207 : : &my_extra->typbyval,
6208 : : &my_extra->typalign);
6209 : 53 : my_extra->element_type = elmtype;
6210 : : }
6211 : :
6212 : 53 : elmlen = my_extra->typlen;
6213 : 53 : elmbyval = my_extra->typbyval;
6214 : 53 : elmalign = my_extra->typalign;
6215 : 53 : elmalignby = typalign_to_alignby(elmalign);
6216 : :
6217 : : /* compute required space */
6218 [ + + ]: 53 : if (!isnull)
6219 : : {
6220 : : int i;
6221 : : char *p;
6222 : : int nbytes;
6223 : : int totbytes;
6224 : :
6225 : : /* make sure data is not toasted */
6226 [ + + ]: 33 : if (elmlen == -1)
6227 : 10 : value = PointerGetDatum(PG_DETOAST_DATUM(value));
6228 : :
6229 [ + + + - ]: 33 : nbytes = att_addlength_datum(0, elmlen, value);
6230 : 33 : nbytes = att_nominal_alignby(nbytes, elmalignby);
6231 : : Assert(nbytes > 0);
6232 : :
6233 : 33 : totbytes = nbytes * nitems;
6234 : :
6235 : : /* check for overflow of multiplication or total request */
6236 [ + - ]: 33 : if (totbytes / nbytes != nitems ||
6237 [ - + ]: 33 : !AllocSizeIsValid(totbytes))
6238 [ # # ]: 0 : ereport(ERROR,
6239 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
6240 : : errmsg("array size exceeds the maximum allowed (%zu)",
6241 : : MaxAllocSize)));
6242 : :
6243 : : /*
6244 : : * This addition can't overflow, but it might cause us to go past
6245 : : * MaxAllocSize. We leave it to palloc to complain in that case.
6246 : : */
6247 : 33 : totbytes += ARR_OVERHEAD_NONULLS(ndims);
6248 : :
6249 : 33 : result = create_array_envelope(ndims, dimv, lbsv, totbytes,
6250 : : elmtype, 0);
6251 : :
6252 [ - + ]: 33 : p = ARR_DATA_PTR(result);
6253 [ + + ]: 2500245 : for (i = 0; i < nitems; i++)
6254 : 2500212 : p += ArrayCastAndSet(value, elmlen, elmbyval, elmalignby, p);
6255 : : }
6256 : : else
6257 : : {
6258 : : int nbytes;
6259 : : int dataoffset;
6260 : :
6261 : 20 : dataoffset = ARR_OVERHEAD_WITHNULLS(ndims, nitems);
6262 : 20 : nbytes = dataoffset;
6263 : :
6264 : 20 : result = create_array_envelope(ndims, dimv, lbsv, nbytes,
6265 : : elmtype, dataoffset);
6266 : :
6267 : : /* create_array_envelope already zeroed the bitmap, so we're done */
6268 : : }
6269 : :
6270 : 53 : return result;
6271 : : }
6272 : :
6273 : :
6274 : : /*
6275 : : * UNNEST
6276 : : */
6277 : : Datum
6278 : 338901 : array_unnest(PG_FUNCTION_ARGS)
6279 : : {
6280 : : typedef struct
6281 : : {
6282 : : array_iter iter;
6283 : : int nextelem;
6284 : : int numelems;
6285 : : } array_unnest_fctx;
6286 : :
6287 : : FuncCallContext *funcctx;
6288 : : array_unnest_fctx *fctx;
6289 : : MemoryContext oldcontext;
6290 : :
6291 : : /* stuff done only on the first call of the function */
6292 [ + + ]: 338901 : if (SRF_IS_FIRSTCALL())
6293 : : {
6294 : : AnyArrayType *arr;
6295 : : int16 elmlen;
6296 : : bool elmbyval;
6297 : : char elmalign;
6298 : :
6299 : : /* create a function context for cross-call persistence */
6300 : 57836 : funcctx = SRF_FIRSTCALL_INIT();
6301 : :
6302 : : /*
6303 : : * switch to memory context appropriate for multiple function calls
6304 : : */
6305 : 57836 : oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6306 : :
6307 : : /*
6308 : : * Get the array value and detoast if needed. We can't do this
6309 : : * earlier because if we have to detoast, we want the detoasted copy
6310 : : * to be in multi_call_memory_ctx, so it will go away when we're done
6311 : : * and not before. (If no detoast happens, we assume the originally
6312 : : * passed array will stick around till then.)
6313 : : */
6314 : 57836 : arr = PG_GETARG_ANY_ARRAY_P(0);
6315 : :
6316 : : /* allocate memory for user context */
6317 : 57836 : fctx = palloc_object(array_unnest_fctx);
6318 : :
6319 : : /* get element-type data */
6320 [ + + ]: 57836 : if (VARATT_IS_EXPANDED_HEADER(arr))
6321 : : {
6322 : : /* we can just grab the type data from expanded array */
6323 : 1 : elmlen = arr->xpn.typlen;
6324 : 1 : elmbyval = arr->xpn.typbyval;
6325 : 1 : elmalign = arr->xpn.typalign;
6326 : : }
6327 : : else
6328 [ - + ]: 57835 : get_typlenbyvalalign(AARR_ELEMTYPE(arr),
6329 : : &elmlen,
6330 : : &elmbyval,
6331 : : &elmalign);
6332 : :
6333 : : /* initialize state */
6334 : 57836 : array_iter_setup(&fctx->iter, arr, elmlen, elmbyval, elmalign);
6335 : 57836 : fctx->nextelem = 0;
6336 [ + + + + ]: 57836 : fctx->numelems = ArrayGetNItems(AARR_NDIM(arr), AARR_DIMS(arr));
6337 : :
6338 : 57836 : funcctx->user_fctx = fctx;
6339 : 57836 : MemoryContextSwitchTo(oldcontext);
6340 : : }
6341 : :
6342 : : /* stuff done on every call of the function */
6343 : 338901 : funcctx = SRF_PERCALL_SETUP();
6344 : 338901 : fctx = funcctx->user_fctx;
6345 : :
6346 [ + + ]: 338901 : if (fctx->nextelem < fctx->numelems)
6347 : : {
6348 : 281065 : int offset = fctx->nextelem++;
6349 : : Datum elem;
6350 : :
6351 : 281065 : elem = array_iter_next(&fctx->iter, &fcinfo->isnull, offset);
6352 : :
6353 : 281065 : SRF_RETURN_NEXT(funcctx, elem);
6354 : : }
6355 : : else
6356 : : {
6357 : : /* do when there is no more left */
6358 : 57836 : SRF_RETURN_DONE(funcctx);
6359 : : }
6360 : : }
6361 : :
6362 : : /*
6363 : : * Planner support function for array_unnest(anyarray)
6364 : : *
6365 : : * Note: this is now also used for information_schema._pg_expandarray(),
6366 : : * which is simply a wrapper around array_unnest().
6367 : : */
6368 : : Datum
6369 : 17080 : array_unnest_support(PG_FUNCTION_ARGS)
6370 : : {
6371 : 17080 : Node *rawreq = (Node *) PG_GETARG_POINTER(0);
6372 : 17080 : Node *ret = NULL;
6373 : :
6374 [ + + ]: 17080 : if (IsA(rawreq, SupportRequestRows))
6375 : : {
6376 : : /* Try to estimate the number of rows returned */
6377 : 4707 : SupportRequestRows *req = (SupportRequestRows *) rawreq;
6378 : :
6379 [ + + ]: 4707 : if (is_funcclause(req->node)) /* be paranoid */
6380 : : {
6381 : 4702 : List *args = ((FuncExpr *) req->node)->args;
6382 : : Node *arg1;
6383 : :
6384 : : /* We can use estimated argument values here */
6385 : 4702 : arg1 = estimate_expression_value(req->root, linitial(args));
6386 : :
6387 : 4702 : req->rows = estimate_array_length(req->root, arg1);
6388 : 4702 : ret = (Node *) req;
6389 : : }
6390 : : }
6391 : :
6392 : 17080 : PG_RETURN_POINTER(ret);
6393 : : }
6394 : :
6395 : :
6396 : : /*
6397 : : * array_replace/array_remove support
6398 : : *
6399 : : * Find all array entries matching (not distinct from) search/search_isnull,
6400 : : * and delete them if remove is true, else replace them with
6401 : : * replace/replace_isnull. Comparisons are done using the specified
6402 : : * collation. fcinfo is passed only for caching purposes.
6403 : : */
6404 : : static ArrayType *
6405 : 1800 : array_replace_internal(ArrayType *array,
6406 : : Datum search, bool search_isnull,
6407 : : Datum replace, bool replace_isnull,
6408 : : bool remove, Oid collation,
6409 : : FunctionCallInfo fcinfo)
6410 : : {
6411 : 1800 : LOCAL_FCINFO(locfcinfo, 2);
6412 : : ArrayType *result;
6413 : : Oid element_type;
6414 : : Datum *values;
6415 : : bool *nulls;
6416 : : int *dim;
6417 : : int ndim;
6418 : : int nitems,
6419 : : nresult;
6420 : : int i;
6421 : 1800 : int32 nbytes = 0;
6422 : : int32 dataoffset;
6423 : : bool hasnulls;
6424 : : int typlen;
6425 : : bool typbyval;
6426 : : char typalign;
6427 : : uint8 typalignby;
6428 : : char *arraydataptr;
6429 : : uint8 *bitmap;
6430 : : int bitmask;
6431 : 1800 : bool changed = false;
6432 : : TypeCacheEntry *typentry;
6433 : :
6434 : 1800 : element_type = ARR_ELEMTYPE(array);
6435 : 1800 : ndim = ARR_NDIM(array);
6436 : 1800 : dim = ARR_DIMS(array);
6437 : 1800 : nitems = ArrayGetNItems(ndim, dim);
6438 : :
6439 : : /* Return input array unmodified if it is empty */
6440 [ - + ]: 1800 : if (nitems <= 0)
6441 : 0 : return array;
6442 : :
6443 : : /*
6444 : : * We can't remove elements from multi-dimensional arrays, since the
6445 : : * result might not be rectangular.
6446 : : */
6447 [ + + + + ]: 1800 : if (remove && ndim > 1)
6448 [ + - ]: 4 : ereport(ERROR,
6449 : : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6450 : : errmsg("removing elements from multidimensional arrays is not supported")));
6451 : :
6452 : : /*
6453 : : * We arrange to look up the equality function only once per series of
6454 : : * calls, assuming the element type doesn't change underneath us.
6455 : : */
6456 : 1796 : typentry = (TypeCacheEntry *) fcinfo->flinfo->fn_extra;
6457 [ + + ]: 1796 : if (typentry == NULL ||
6458 [ - + ]: 1354 : typentry->type_id != element_type)
6459 : : {
6460 : 442 : typentry = lookup_type_cache(element_type,
6461 : : TYPECACHE_EQ_OPR_FINFO);
6462 [ - + ]: 442 : if (!OidIsValid(typentry->eq_opr_finfo.fn_oid))
6463 [ # # ]: 0 : ereport(ERROR,
6464 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
6465 : : errmsg("could not identify an equality operator for type %s",
6466 : : format_type_be(element_type))));
6467 : 442 : fcinfo->flinfo->fn_extra = typentry;
6468 : : }
6469 : 1796 : typlen = typentry->typlen;
6470 : 1796 : typbyval = typentry->typbyval;
6471 : 1796 : typalign = typentry->typalign;
6472 : 1796 : typalignby = typalign_to_alignby(typalign);
6473 : :
6474 : : /*
6475 : : * Detoast values if they are toasted. The replacement value must be
6476 : : * detoasted for insertion into the result array, while detoasting the
6477 : : * search value only once saves cycles.
6478 : : */
6479 [ + + ]: 1796 : if (typlen == -1)
6480 : : {
6481 [ + + ]: 1761 : if (!search_isnull)
6482 : 1756 : search = PointerGetDatum(PG_DETOAST_DATUM(search));
6483 [ + + ]: 1761 : if (!replace_isnull)
6484 : 10 : replace = PointerGetDatum(PG_DETOAST_DATUM(replace));
6485 : : }
6486 : :
6487 : : /* Prepare to apply the comparison operator */
6488 : 1796 : InitFunctionCallInfoData(*locfcinfo, &typentry->eq_opr_finfo, 2,
6489 : : collation, NULL, NULL);
6490 : :
6491 : : /* Allocate temporary arrays for new values */
6492 : 1796 : values = (Datum *) palloc(nitems * sizeof(Datum));
6493 : 1796 : nulls = (bool *) palloc(nitems * sizeof(bool));
6494 : :
6495 : : /* Loop over source data */
6496 [ + + ]: 1796 : arraydataptr = ARR_DATA_PTR(array);
6497 [ + + ]: 1796 : bitmap = ARR_NULLBITMAP(array);
6498 : 1796 : bitmask = 1;
6499 : 1796 : hasnulls = false;
6500 : 1796 : nresult = 0;
6501 : :
6502 [ + + ]: 3979 : for (i = 0; i < nitems; i++)
6503 : : {
6504 : : Datum elt;
6505 : : bool isNull;
6506 : : bool oprresult;
6507 : 2183 : bool skip = false;
6508 : :
6509 : : /* Get source element, checking for NULL */
6510 [ + + + + ]: 2183 : if (bitmap && (*bitmap & bitmask) == 0)
6511 : : {
6512 : 30 : isNull = true;
6513 : : /* If searching for NULL, we have a match */
6514 [ + - ]: 30 : if (search_isnull)
6515 : : {
6516 [ + + ]: 30 : if (remove)
6517 : : {
6518 : 10 : skip = true;
6519 : 10 : changed = true;
6520 : : }
6521 [ + + ]: 20 : else if (!replace_isnull)
6522 : : {
6523 : 15 : values[nresult] = replace;
6524 : 15 : isNull = false;
6525 : 15 : changed = true;
6526 : : }
6527 : : }
6528 : : }
6529 : : else
6530 : : {
6531 : 2153 : isNull = false;
6532 : 2153 : elt = fetch_att(arraydataptr, typbyval, typlen);
6533 [ + + + - ]: 2153 : arraydataptr = att_addlength_datum(arraydataptr, typlen, elt);
6534 : 2153 : arraydataptr = (char *) att_nominal_alignby(arraydataptr, typalignby);
6535 : :
6536 [ + + ]: 2153 : if (search_isnull)
6537 : : {
6538 : : /* no match possible, keep element */
6539 : 45 : values[nresult] = elt;
6540 : : }
6541 : : else
6542 : : {
6543 : : /*
6544 : : * Apply the operator to the element pair; treat NULL as false
6545 : : */
6546 : 2108 : locfcinfo->args[0].value = elt;
6547 : 2108 : locfcinfo->args[0].isnull = false;
6548 : 2108 : locfcinfo->args[1].value = search;
6549 : 2108 : locfcinfo->args[1].isnull = false;
6550 : 2108 : locfcinfo->isnull = false;
6551 : 2108 : oprresult = DatumGetBool(FunctionCallInvoke(locfcinfo));
6552 [ + - + + ]: 2108 : if (locfcinfo->isnull || !oprresult)
6553 : : {
6554 : : /* no match, keep element */
6555 : 2004 : values[nresult] = elt;
6556 : : }
6557 : : else
6558 : : {
6559 : : /* match, so replace or delete */
6560 : 104 : changed = true;
6561 [ + + ]: 104 : if (remove)
6562 : 84 : skip = true;
6563 : : else
6564 : : {
6565 : 20 : values[nresult] = replace;
6566 : 20 : isNull = replace_isnull;
6567 : : }
6568 : : }
6569 : : }
6570 : : }
6571 : :
6572 [ + + ]: 2183 : if (!skip)
6573 : : {
6574 : 2089 : nulls[nresult] = isNull;
6575 [ + + ]: 2089 : if (isNull)
6576 : 10 : hasnulls = true;
6577 : : else
6578 : : {
6579 : : /* Update total result size */
6580 [ + + + - ]: 2079 : nbytes = att_addlength_datum(nbytes, typlen, values[nresult]);
6581 : 2079 : nbytes = att_nominal_alignby(nbytes, typalignby);
6582 : : /* check for overflow of total request */
6583 [ - + ]: 2079 : if (!AllocSizeIsValid(nbytes))
6584 [ # # ]: 0 : ereport(ERROR,
6585 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
6586 : : errmsg("array size exceeds the maximum allowed (%zu)",
6587 : : MaxAllocSize)));
6588 : : }
6589 : 2089 : nresult++;
6590 : : }
6591 : :
6592 : : /* advance bitmap pointer if any */
6593 [ + + ]: 2183 : if (bitmap)
6594 : : {
6595 : 75 : bitmask <<= 1;
6596 [ - + ]: 75 : if (bitmask == 0x100)
6597 : : {
6598 : 0 : bitmap++;
6599 : 0 : bitmask = 1;
6600 : : }
6601 : : }
6602 : : }
6603 : :
6604 : : /*
6605 : : * If not changed just return the original array
6606 : : */
6607 [ + + ]: 1796 : if (!changed)
6608 : : {
6609 : 1697 : pfree(values);
6610 : 1697 : pfree(nulls);
6611 : 1697 : return array;
6612 : : }
6613 : :
6614 : : /* If all elements were removed return an empty array */
6615 [ + + ]: 99 : if (nresult == 0)
6616 : : {
6617 : 5 : pfree(values);
6618 : 5 : pfree(nulls);
6619 : 5 : return construct_empty_array(element_type);
6620 : : }
6621 : :
6622 : : /* Allocate and initialize the result array */
6623 [ + + ]: 94 : if (hasnulls)
6624 : : {
6625 : 5 : dataoffset = ARR_OVERHEAD_WITHNULLS(ndim, nresult);
6626 : 5 : nbytes += dataoffset;
6627 : : }
6628 : : else
6629 : : {
6630 : 89 : dataoffset = 0; /* marker for no null bitmap */
6631 : 89 : nbytes += ARR_OVERHEAD_NONULLS(ndim);
6632 : : }
6633 : 94 : result = (ArrayType *) palloc0(nbytes);
6634 : 94 : SET_VARSIZE(result, nbytes);
6635 : 94 : result->ndim = ndim;
6636 : 94 : result->dataoffset = dataoffset;
6637 : 94 : result->elemtype = element_type;
6638 : 94 : memcpy(ARR_DIMS(result), ARR_DIMS(array), ndim * sizeof(int));
6639 : 94 : memcpy(ARR_LBOUND(result), ARR_LBOUND(array), ndim * sizeof(int));
6640 : :
6641 [ + + ]: 94 : if (remove)
6642 : : {
6643 : : /* Adjust the result length */
6644 : 69 : ARR_DIMS(result)[0] = nresult;
6645 : : }
6646 : :
6647 : : /* Insert data into result array */
6648 : 94 : CopyArrayEls(result,
6649 : : values, nulls, nresult,
6650 : : typlen, typbyval, typalign,
6651 : : false);
6652 : :
6653 : 94 : pfree(values);
6654 : 94 : pfree(nulls);
6655 : :
6656 : 94 : return result;
6657 : : }
6658 : :
6659 : : /*
6660 : : * Remove any occurrences of an element from an array
6661 : : *
6662 : : * If used on a multi-dimensional array this will raise an error.
6663 : : */
6664 : : Datum
6665 : 110292 : array_remove(PG_FUNCTION_ARGS)
6666 : : {
6667 : : ArrayType *array;
6668 : 110292 : Datum search = PG_GETARG_DATUM(1);
6669 : 110292 : bool search_isnull = PG_ARGISNULL(1);
6670 : :
6671 [ + + ]: 110292 : if (PG_ARGISNULL(0))
6672 : 108522 : PG_RETURN_NULL();
6673 : 1770 : array = PG_GETARG_ARRAYTYPE_P(0);
6674 : :
6675 : 1770 : array = array_replace_internal(array,
6676 : : search, search_isnull,
6677 : : (Datum) 0, true,
6678 : : true, PG_GET_COLLATION(),
6679 : : fcinfo);
6680 : 1766 : PG_RETURN_ARRAYTYPE_P(array);
6681 : : }
6682 : :
6683 : : /*
6684 : : * Replace any occurrences of an element in an array
6685 : : */
6686 : : Datum
6687 : 30 : array_replace(PG_FUNCTION_ARGS)
6688 : : {
6689 : : ArrayType *array;
6690 : 30 : Datum search = PG_GETARG_DATUM(1);
6691 : 30 : bool search_isnull = PG_ARGISNULL(1);
6692 : 30 : Datum replace = PG_GETARG_DATUM(2);
6693 : 30 : bool replace_isnull = PG_ARGISNULL(2);
6694 : :
6695 [ - + ]: 30 : if (PG_ARGISNULL(0))
6696 : 0 : PG_RETURN_NULL();
6697 : 30 : array = PG_GETARG_ARRAYTYPE_P(0);
6698 : :
6699 : 30 : array = array_replace_internal(array,
6700 : : search, search_isnull,
6701 : : replace, replace_isnull,
6702 : : false, PG_GET_COLLATION(),
6703 : : fcinfo);
6704 : 30 : PG_RETURN_ARRAYTYPE_P(array);
6705 : : }
6706 : :
6707 : : /*
6708 : : * Implements width_bucket(anyelement, anyarray).
6709 : : *
6710 : : * 'thresholds' is an array containing lower bound values for each bucket;
6711 : : * these must be sorted from smallest to largest, or bogus results will be
6712 : : * produced. If N thresholds are supplied, the output is from 0 to N:
6713 : : * 0 is for inputs < first threshold, N is for inputs >= last threshold.
6714 : : */
6715 : : Datum
6716 : 542 : width_bucket_array(PG_FUNCTION_ARGS)
6717 : : {
6718 : 542 : Datum operand = PG_GETARG_DATUM(0);
6719 : 542 : ArrayType *thresholds = PG_GETARG_ARRAYTYPE_P(1);
6720 : 542 : Oid collation = PG_GET_COLLATION();
6721 : 542 : Oid element_type = ARR_ELEMTYPE(thresholds);
6722 : : int result;
6723 : :
6724 : : /* Check input */
6725 [ + + ]: 542 : if (ARR_NDIM(thresholds) > 1)
6726 [ + - ]: 4 : ereport(ERROR,
6727 : : (errcode(ERRCODE_ARRAY_SUBSCRIPT_ERROR),
6728 : : errmsg("thresholds must be one-dimensional array")));
6729 : :
6730 [ + + ]: 538 : if (array_contains_nulls(thresholds))
6731 [ + - ]: 4 : ereport(ERROR,
6732 : : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6733 : : errmsg("thresholds array must not contain NULLs")));
6734 : :
6735 : : /* We have a dedicated implementation for float8 data */
6736 [ + + ]: 534 : if (element_type == FLOAT8OID)
6737 : 244 : result = width_bucket_array_float8(operand, thresholds);
6738 : : else
6739 : : {
6740 : : TypeCacheEntry *typentry;
6741 : :
6742 : : /* Cache information about the input type */
6743 : 290 : typentry = (TypeCacheEntry *) fcinfo->flinfo->fn_extra;
6744 [ + + ]: 290 : if (typentry == NULL ||
6745 [ - + ]: 260 : typentry->type_id != element_type)
6746 : : {
6747 : 30 : typentry = lookup_type_cache(element_type,
6748 : : TYPECACHE_CMP_PROC_FINFO);
6749 [ - + ]: 30 : if (!OidIsValid(typentry->cmp_proc_finfo.fn_oid))
6750 [ # # ]: 0 : ereport(ERROR,
6751 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
6752 : : errmsg("could not identify a comparison function for type %s",
6753 : : format_type_be(element_type))));
6754 : 30 : fcinfo->flinfo->fn_extra = typentry;
6755 : : }
6756 : :
6757 : : /*
6758 : : * We have separate implementation paths for fixed- and variable-width
6759 : : * types, since indexing the array is a lot cheaper in the first case.
6760 : : */
6761 [ + + ]: 290 : if (typentry->typlen > 0)
6762 : 62 : result = width_bucket_array_fixed(operand, thresholds,
6763 : : collation, typentry);
6764 : : else
6765 : 228 : result = width_bucket_array_variable(operand, thresholds,
6766 : : collation, typentry);
6767 : : }
6768 : :
6769 : : /* Avoid leaking memory when handed toasted input. */
6770 [ - + ]: 534 : PG_FREE_IF_COPY(thresholds, 1);
6771 : :
6772 : 534 : PG_RETURN_INT32(result);
6773 : : }
6774 : :
6775 : : /*
6776 : : * width_bucket_array for float8 data.
6777 : : */
6778 : : static int
6779 : 244 : width_bucket_array_float8(Datum operand, ArrayType *thresholds)
6780 : : {
6781 : 244 : float8 op = DatumGetFloat8(operand);
6782 : : float8 *thresholds_data;
6783 : : int left;
6784 : : int right;
6785 : :
6786 : : /*
6787 : : * Since we know the array contains no NULLs, we can just index it
6788 : : * directly.
6789 : : */
6790 [ - + ]: 244 : thresholds_data = (float8 *) ARR_DATA_PTR(thresholds);
6791 : :
6792 : 244 : left = 0;
6793 : 244 : right = ArrayGetNItems(ARR_NDIM(thresholds), ARR_DIMS(thresholds));
6794 : :
6795 : : /*
6796 : : * If the probe value is a NaN, it's greater than or equal to all possible
6797 : : * threshold values (including other NaNs), so we need not search. Note
6798 : : * that this would give the same result as searching even if the array
6799 : : * contains multiple NaNs (as long as they're correctly sorted), since the
6800 : : * loop logic will find the rightmost of multiple equal threshold values.
6801 : : */
6802 [ + + ]: 244 : if (isnan(op))
6803 : 4 : return right;
6804 : :
6805 : : /* Find the bucket */
6806 [ + + ]: 756 : while (left < right)
6807 : : {
6808 : 516 : int mid = (left + right) / 2;
6809 : :
6810 [ + + + + ]: 516 : if (isnan(thresholds_data[mid]) || op < thresholds_data[mid])
6811 : 224 : right = mid;
6812 : : else
6813 : 292 : left = mid + 1;
6814 : : }
6815 : :
6816 : 240 : return left;
6817 : : }
6818 : :
6819 : : /*
6820 : : * width_bucket_array for generic fixed-width data types.
6821 : : */
6822 : : static int
6823 : 62 : width_bucket_array_fixed(Datum operand,
6824 : : ArrayType *thresholds,
6825 : : Oid collation,
6826 : : TypeCacheEntry *typentry)
6827 : : {
6828 : 62 : LOCAL_FCINFO(locfcinfo, 2);
6829 : : char *thresholds_data;
6830 : 62 : int typlen = typentry->typlen;
6831 : 62 : bool typbyval = typentry->typbyval;
6832 : : int left;
6833 : : int right;
6834 : :
6835 : : /*
6836 : : * Since we know the array contains no NULLs, we can just index it
6837 : : * directly.
6838 : : */
6839 [ - + ]: 62 : thresholds_data = (char *) ARR_DATA_PTR(thresholds);
6840 : :
6841 : 62 : InitFunctionCallInfoData(*locfcinfo, &typentry->cmp_proc_finfo, 2,
6842 : : collation, NULL, NULL);
6843 : :
6844 : : /* Find the bucket */
6845 : 62 : left = 0;
6846 : 62 : right = ArrayGetNItems(ARR_NDIM(thresholds), ARR_DIMS(thresholds));
6847 [ + + ]: 183 : while (left < right)
6848 : : {
6849 : 121 : int mid = (left + right) / 2;
6850 : : char *ptr;
6851 : : int32 cmpresult;
6852 : :
6853 : 121 : ptr = thresholds_data + mid * typlen;
6854 : :
6855 : 121 : locfcinfo->args[0].value = operand;
6856 : 121 : locfcinfo->args[0].isnull = false;
6857 : 121 : locfcinfo->args[1].value = fetch_att(ptr, typbyval, typlen);
6858 : 121 : locfcinfo->args[1].isnull = false;
6859 : :
6860 : 121 : cmpresult = DatumGetInt32(FunctionCallInvoke(locfcinfo));
6861 : :
6862 : : /* We don't expect comparison support functions to return null */
6863 : : Assert(!locfcinfo->isnull);
6864 : :
6865 [ + + ]: 121 : if (cmpresult < 0)
6866 : 60 : right = mid;
6867 : : else
6868 : 61 : left = mid + 1;
6869 : : }
6870 : :
6871 : 62 : return left;
6872 : : }
6873 : :
6874 : : /*
6875 : : * width_bucket_array for generic variable-width data types.
6876 : : */
6877 : : static int
6878 : 228 : width_bucket_array_variable(Datum operand,
6879 : : ArrayType *thresholds,
6880 : : Oid collation,
6881 : : TypeCacheEntry *typentry)
6882 : : {
6883 : 228 : LOCAL_FCINFO(locfcinfo, 2);
6884 : : char *thresholds_data;
6885 : 228 : int typlen = typentry->typlen;
6886 : 228 : bool typbyval = typentry->typbyval;
6887 : 228 : char typalign = typentry->typalign;
6888 : 228 : uint8 typalignby = typalign_to_alignby(typalign);
6889 : : int left;
6890 : : int right;
6891 : :
6892 [ - + ]: 228 : thresholds_data = (char *) ARR_DATA_PTR(thresholds);
6893 : :
6894 : 228 : InitFunctionCallInfoData(*locfcinfo, &typentry->cmp_proc_finfo, 2,
6895 : : collation, NULL, NULL);
6896 : :
6897 : : /* Find the bucket */
6898 : 228 : left = 0;
6899 : 228 : right = ArrayGetNItems(ARR_NDIM(thresholds), ARR_DIMS(thresholds));
6900 [ + + ]: 712 : while (left < right)
6901 : : {
6902 : 484 : int mid = (left + right) / 2;
6903 : : char *ptr;
6904 : : int i;
6905 : : int32 cmpresult;
6906 : :
6907 : : /* Locate mid'th array element by advancing from left element */
6908 : 484 : ptr = thresholds_data;
6909 [ + + ]: 828 : for (i = left; i < mid; i++)
6910 : : {
6911 [ - + + - ]: 344 : ptr = att_addlength_pointer(ptr, typlen, ptr);
6912 : 344 : ptr = (char *) att_nominal_alignby(ptr, typalignby);
6913 : : }
6914 : :
6915 : 484 : locfcinfo->args[0].value = operand;
6916 : 484 : locfcinfo->args[0].isnull = false;
6917 : 484 : locfcinfo->args[1].value = fetch_att(ptr, typbyval, typlen);
6918 : 484 : locfcinfo->args[1].isnull = false;
6919 : :
6920 : 484 : cmpresult = DatumGetInt32(FunctionCallInvoke(locfcinfo));
6921 : :
6922 : : /* We don't expect comparison support functions to return null */
6923 : : Assert(!locfcinfo->isnull);
6924 : :
6925 [ + + ]: 484 : if (cmpresult < 0)
6926 : 200 : right = mid;
6927 : : else
6928 : : {
6929 : 284 : left = mid + 1;
6930 : :
6931 : : /*
6932 : : * Move the thresholds pointer to match new "left" index, so we
6933 : : * don't have to seek over those elements again. This trick
6934 : : * ensures we do only O(N) array indexing work, not O(N^2).
6935 : : */
6936 [ - + + - ]: 284 : ptr = att_addlength_pointer(ptr, typlen, ptr);
6937 : 284 : thresholds_data = (char *) att_nominal_alignby(ptr, typalignby);
6938 : : }
6939 : : }
6940 : :
6941 : 228 : return left;
6942 : : }
6943 : :
6944 : : /*
6945 : : * Trim the last N elements from an array by building an appropriate slice.
6946 : : * Only the first dimension is trimmed.
6947 : : */
6948 : : Datum
6949 : 32 : trim_array(PG_FUNCTION_ARGS)
6950 : : {
6951 : 32 : ArrayType *v = PG_GETARG_ARRAYTYPE_P(0);
6952 : 32 : int n = PG_GETARG_INT32(1);
6953 [ + + ]: 32 : int array_length = (ARR_NDIM(v) > 0) ? ARR_DIMS(v)[0] : 0;
6954 : : int16 elmlen;
6955 : : bool elmbyval;
6956 : : char elmalign;
6957 : : int lower[MAXDIM];
6958 : : int upper[MAXDIM];
6959 : : bool lowerProvided[MAXDIM];
6960 : : bool upperProvided[MAXDIM];
6961 : : Datum result;
6962 : :
6963 : : /* Per spec, throw an error if out of bounds */
6964 [ + + + + ]: 32 : if (n < 0 || n > array_length)
6965 [ + - ]: 12 : ereport(ERROR,
6966 : : (errcode(ERRCODE_ARRAY_ELEMENT_ERROR),
6967 : : errmsg("number of elements to trim must be between 0 and %d",
6968 : : array_length)));
6969 : :
6970 : : /* Set all the bounds as unprovided except the first upper bound */
6971 : 20 : memset(lowerProvided, false, sizeof(lowerProvided));
6972 : 20 : memset(upperProvided, false, sizeof(upperProvided));
6973 [ + - ]: 20 : if (ARR_NDIM(v) > 0)
6974 : : {
6975 : 20 : upper[0] = ARR_LBOUND(v)[0] + array_length - n - 1;
6976 : 20 : upperProvided[0] = true;
6977 : : }
6978 : :
6979 : : /* Fetch the needed information about the element type */
6980 : 20 : get_typlenbyvalalign(ARR_ELEMTYPE(v), &elmlen, &elmbyval, &elmalign);
6981 : :
6982 : : /* Get the slice */
6983 : 20 : result = array_get_slice(PointerGetDatum(v), 1,
6984 : : upper, lower, upperProvided, lowerProvided,
6985 : : -1, elmlen, elmbyval, elmalign);
6986 : :
6987 : 20 : PG_RETURN_DATUM(result);
6988 : : }
|