Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * multirangetypes.c
4 : * I/O functions, operators, and support functions for multirange types.
5 : *
6 : * The stored (serialized) format of a multirange value is:
7 : *
8 : * 12 bytes: MultirangeType struct including varlena header, multirange
9 : * type's OID and the number of ranges in the multirange.
10 : * 4 * (rangesCount - 1) bytes: 32-bit items pointing to the each range
11 : * in the multirange starting from
12 : * the second one.
13 : * 1 * rangesCount bytes : 8-bit flags for each range in the multirange
14 : * The rest of the multirange are range bound values pointed by multirange
15 : * items.
16 : *
17 : * Majority of items contain lengths of corresponding range bound values.
18 : * Thanks to that items are typically low numbers. This makes multiranges
19 : * compression-friendly. Every MULTIRANGE_ITEM_OFFSET_STRIDE item contains
20 : * an offset of the corresponding range bound values. That allows fast lookups
21 : * for a particular range index. Offsets are counted starting from the end of
22 : * flags aligned to the bound type.
23 : *
24 : * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
25 : * Portions Copyright (c) 1994, Regents of the University of California
26 : *
27 : *
28 : * IDENTIFICATION
29 : * src/backend/utils/adt/multirangetypes.c
30 : *
31 : *-------------------------------------------------------------------------
32 : */
33 : #include "postgres.h"
34 :
35 : #include "access/tupmacs.h"
36 : #include "common/hashfn.h"
37 : #include "funcapi.h"
38 : #include "lib/stringinfo.h"
39 : #include "libpq/pqformat.h"
40 : #include "miscadmin.h"
41 : #include "port/pg_bitutils.h"
42 : #include "utils/builtins.h"
43 : #include "utils/lsyscache.h"
44 : #include "utils/rangetypes.h"
45 : #include "utils/multirangetypes.h"
46 : #include "utils/array.h"
47 : #include "utils/memutils.h"
48 :
49 : /* fn_extra cache entry for one of the range I/O functions */
50 : typedef struct MultirangeIOData
51 : {
52 : TypeCacheEntry *typcache; /* multirange type's typcache entry */
53 : FmgrInfo typioproc; /* range type's I/O proc */
54 : Oid typioparam; /* range type's I/O parameter */
55 : } MultirangeIOData;
56 :
57 : typedef enum
58 : {
59 : MULTIRANGE_BEFORE_RANGE,
60 : MULTIRANGE_IN_RANGE,
61 : MULTIRANGE_IN_RANGE_ESCAPED,
62 : MULTIRANGE_IN_RANGE_QUOTED,
63 : MULTIRANGE_IN_RANGE_QUOTED_ESCAPED,
64 : MULTIRANGE_AFTER_RANGE,
65 : MULTIRANGE_FINISHED,
66 : } MultirangeParseState;
67 :
68 : /*
69 : * Macros for accessing past MultirangeType parts of multirange: items, flags
70 : * and boundaries.
71 : */
72 : #define MultirangeGetItemsPtr(mr) ((uint32 *) ((Pointer) (mr) + \
73 : sizeof(MultirangeType)))
74 : #define MultirangeGetFlagsPtr(mr) ((uint8 *) ((Pointer) (mr) + \
75 : sizeof(MultirangeType) + ((mr)->rangeCount - 1) * sizeof(uint32)))
76 : #define MultirangeGetBoundariesPtr(mr, align) ((Pointer) (mr) + \
77 : att_align_nominal(sizeof(MultirangeType) + \
78 : ((mr)->rangeCount - 1) * sizeof(uint32) + \
79 : (mr)->rangeCount * sizeof(uint8), (align)))
80 :
81 : #define MULTIRANGE_ITEM_OFF_BIT 0x80000000
82 : #define MULTIRANGE_ITEM_GET_OFFLEN(item) ((item) & 0x7FFFFFFF)
83 : #define MULTIRANGE_ITEM_HAS_OFF(item) ((item) & MULTIRANGE_ITEM_OFF_BIT)
84 : #define MULTIRANGE_ITEM_OFFSET_STRIDE 4
85 :
86 : typedef int (*multirange_bsearch_comparison) (TypeCacheEntry *typcache,
87 : RangeBound *lower,
88 : RangeBound *upper,
89 : void *key,
90 : bool *match);
91 :
92 : static MultirangeIOData *get_multirange_io_data(FunctionCallInfo fcinfo,
93 : Oid mltrngtypid,
94 : IOFuncSelector func);
95 : static int32 multirange_canonicalize(TypeCacheEntry *rangetyp,
96 : int32 input_range_count,
97 : RangeType **ranges);
98 :
99 : /*
100 : *----------------------------------------------------------
101 : * I/O FUNCTIONS
102 : *----------------------------------------------------------
103 : */
104 :
105 : /*
106 : * Converts string to multirange.
107 : *
108 : * We expect curly brackets to bound the list, with zero or more ranges
109 : * separated by commas. We accept whitespace anywhere: before/after our
110 : * brackets and around the commas. Ranges can be the empty literal or some
111 : * stuff inside parens/brackets. Mostly we delegate parsing the individual
112 : * range contents to range_in, but we have to detect quoting and
113 : * backslash-escaping which can happen for range bounds. Backslashes can
114 : * escape something inside or outside a quoted string, and a quoted string
115 : * can escape quote marks with either backslashes or double double-quotes.
116 : */
117 : Datum
118 1314 : multirange_in(PG_FUNCTION_ARGS)
119 : {
120 1314 : char *input_str = PG_GETARG_CSTRING(0);
121 1314 : Oid mltrngtypoid = PG_GETARG_OID(1);
122 1314 : Oid typmod = PG_GETARG_INT32(2);
123 1314 : Node *escontext = fcinfo->context;
124 : TypeCacheEntry *rangetyp;
125 1314 : int32 ranges_seen = 0;
126 1314 : int32 range_count = 0;
127 1314 : int32 range_capacity = 8;
128 : RangeType *range;
129 1314 : RangeType **ranges = palloc(range_capacity * sizeof(RangeType *));
130 : MultirangeIOData *cache;
131 : MultirangeType *ret;
132 : MultirangeParseState parse_state;
133 1314 : const char *ptr = input_str;
134 1314 : const char *range_str_begin = NULL;
135 : int32 range_str_len;
136 : char *range_str;
137 : Datum range_datum;
138 :
139 1314 : cache = get_multirange_io_data(fcinfo, mltrngtypoid, IOFunc_input);
140 1314 : rangetyp = cache->typcache->rngtype;
141 :
142 : /* consume whitespace */
143 1338 : while (*ptr != '\0' && isspace((unsigned char) *ptr))
144 24 : ptr++;
145 :
146 1314 : if (*ptr == '{')
147 1308 : ptr++;
148 : else
149 6 : ereturn(escontext, (Datum) 0,
150 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
151 : errmsg("malformed multirange literal: \"%s\"",
152 : input_str),
153 : errdetail("Missing left brace.")));
154 :
155 : /* consume ranges */
156 1308 : parse_state = MULTIRANGE_BEFORE_RANGE;
157 13056 : for (; parse_state != MULTIRANGE_FINISHED; ptr++)
158 : {
159 11844 : char ch = *ptr;
160 :
161 11844 : if (ch == '\0')
162 18 : ereturn(escontext, (Datum) 0,
163 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
164 : errmsg("malformed multirange literal: \"%s\"",
165 : input_str),
166 : errdetail("Unexpected end of input.")));
167 :
168 : /* skip whitespace */
169 11826 : if (isspace((unsigned char) ch))
170 576 : continue;
171 :
172 11250 : switch (parse_state)
173 : {
174 1788 : case MULTIRANGE_BEFORE_RANGE:
175 1788 : if (ch == '[' || ch == '(')
176 : {
177 1500 : range_str_begin = ptr;
178 1500 : parse_state = MULTIRANGE_IN_RANGE;
179 : }
180 288 : else if (ch == '}' && ranges_seen == 0)
181 246 : parse_state = MULTIRANGE_FINISHED;
182 42 : else if (pg_strncasecmp(ptr, RANGE_EMPTY_LITERAL,
183 : strlen(RANGE_EMPTY_LITERAL)) == 0)
184 : {
185 18 : ranges_seen++;
186 : /* nothing to do with an empty range */
187 18 : ptr += strlen(RANGE_EMPTY_LITERAL) - 1;
188 18 : parse_state = MULTIRANGE_AFTER_RANGE;
189 : }
190 : else
191 24 : ereturn(escontext, (Datum) 0,
192 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
193 : errmsg("malformed multirange literal: \"%s\"",
194 : input_str),
195 : errdetail("Expected range start.")));
196 1764 : break;
197 7818 : case MULTIRANGE_IN_RANGE:
198 7818 : if (ch == ']' || ch == ')')
199 : {
200 1494 : range_str_len = ptr - range_str_begin + 1;
201 1494 : range_str = pnstrdup(range_str_begin, range_str_len);
202 1494 : if (range_capacity == range_count)
203 : {
204 0 : range_capacity *= 2;
205 : ranges = (RangeType **)
206 0 : repalloc(ranges, range_capacity * sizeof(RangeType *));
207 : }
208 1494 : ranges_seen++;
209 1494 : if (!InputFunctionCallSafe(&cache->typioproc,
210 : range_str,
211 : cache->typioparam,
212 : typmod,
213 : escontext,
214 : &range_datum))
215 12 : PG_RETURN_NULL();
216 1458 : range = DatumGetRangeTypeP(range_datum);
217 1458 : if (!RangeIsEmpty(range))
218 1428 : ranges[range_count++] = range;
219 1458 : parse_state = MULTIRANGE_AFTER_RANGE;
220 : }
221 : else
222 : {
223 6324 : if (ch == '"')
224 78 : parse_state = MULTIRANGE_IN_RANGE_QUOTED;
225 6246 : else if (ch == '\\')
226 6 : parse_state = MULTIRANGE_IN_RANGE_ESCAPED;
227 :
228 : /*
229 : * We will include this character into range_str once we
230 : * find the end of the range value.
231 : */
232 : }
233 7782 : break;
234 6 : case MULTIRANGE_IN_RANGE_ESCAPED:
235 :
236 : /*
237 : * We will include this character into range_str once we find
238 : * the end of the range value.
239 : */
240 6 : parse_state = MULTIRANGE_IN_RANGE;
241 6 : break;
242 156 : case MULTIRANGE_IN_RANGE_QUOTED:
243 156 : if (ch == '"')
244 78 : if (*(ptr + 1) == '"')
245 : {
246 : /* two quote marks means an escaped quote mark */
247 6 : ptr++;
248 : }
249 : else
250 72 : parse_state = MULTIRANGE_IN_RANGE;
251 78 : else if (ch == '\\')
252 18 : parse_state = MULTIRANGE_IN_RANGE_QUOTED_ESCAPED;
253 :
254 : /*
255 : * We will include this character into range_str once we find
256 : * the end of the range value.
257 : */
258 156 : break;
259 1464 : case MULTIRANGE_AFTER_RANGE:
260 1464 : if (ch == ',')
261 480 : parse_state = MULTIRANGE_BEFORE_RANGE;
262 984 : else if (ch == '}')
263 966 : parse_state = MULTIRANGE_FINISHED;
264 : else
265 18 : ereturn(escontext, (Datum) 0,
266 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
267 : errmsg("malformed multirange literal: \"%s\"",
268 : input_str),
269 : errdetail("Expected comma or end of multirange.")));
270 1446 : break;
271 18 : case MULTIRANGE_IN_RANGE_QUOTED_ESCAPED:
272 :
273 : /*
274 : * We will include this character into range_str once we find
275 : * the end of the range value.
276 : */
277 18 : parse_state = MULTIRANGE_IN_RANGE_QUOTED;
278 18 : break;
279 0 : default:
280 0 : elog(ERROR, "unknown parse state: %d", parse_state);
281 : }
282 : }
283 :
284 : /* consume whitespace */
285 1236 : while (*ptr != '\0' && isspace((unsigned char) *ptr))
286 24 : ptr++;
287 :
288 1212 : if (*ptr != '\0')
289 6 : ereturn(escontext, (Datum) 0,
290 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
291 : errmsg("malformed multirange literal: \"%s\"",
292 : input_str),
293 : errdetail("Junk after closing right brace.")));
294 :
295 1206 : ret = make_multirange(mltrngtypoid, rangetyp, range_count, ranges);
296 1206 : PG_RETURN_MULTIRANGE_P(ret);
297 : }
298 :
299 : Datum
300 2200 : multirange_out(PG_FUNCTION_ARGS)
301 : {
302 2200 : MultirangeType *multirange = PG_GETARG_MULTIRANGE_P(0);
303 2200 : Oid mltrngtypoid = MultirangeTypeGetOid(multirange);
304 : MultirangeIOData *cache;
305 : StringInfoData buf;
306 : RangeType *range;
307 : char *rangeStr;
308 : int32 range_count;
309 : int32 i;
310 : RangeType **ranges;
311 :
312 2200 : cache = get_multirange_io_data(fcinfo, mltrngtypoid, IOFunc_output);
313 :
314 2200 : initStringInfo(&buf);
315 :
316 2200 : appendStringInfoChar(&buf, '{');
317 :
318 2200 : multirange_deserialize(cache->typcache->rngtype, multirange, &range_count, &ranges);
319 4156 : for (i = 0; i < range_count; i++)
320 : {
321 1956 : if (i > 0)
322 266 : appendStringInfoChar(&buf, ',');
323 1956 : range = ranges[i];
324 1956 : rangeStr = OutputFunctionCall(&cache->typioproc, RangeTypePGetDatum(range));
325 1956 : appendStringInfoString(&buf, rangeStr);
326 : }
327 :
328 2200 : appendStringInfoChar(&buf, '}');
329 :
330 2200 : PG_RETURN_CSTRING(buf.data);
331 : }
332 :
333 : /*
334 : * Binary representation: First a int32-sized count of ranges, followed by
335 : * ranges in their native binary representation.
336 : */
337 : Datum
338 0 : multirange_recv(PG_FUNCTION_ARGS)
339 : {
340 0 : StringInfo buf = (StringInfo) PG_GETARG_POINTER(0);
341 0 : Oid mltrngtypoid = PG_GETARG_OID(1);
342 0 : int32 typmod = PG_GETARG_INT32(2);
343 : MultirangeIOData *cache;
344 : uint32 range_count;
345 : RangeType **ranges;
346 : MultirangeType *ret;
347 : StringInfoData tmpbuf;
348 :
349 0 : cache = get_multirange_io_data(fcinfo, mltrngtypoid, IOFunc_receive);
350 :
351 0 : range_count = pq_getmsgint(buf, 4);
352 0 : ranges = palloc(range_count * sizeof(RangeType *));
353 :
354 0 : initStringInfo(&tmpbuf);
355 0 : for (int i = 0; i < range_count; i++)
356 : {
357 0 : uint32 range_len = pq_getmsgint(buf, 4);
358 0 : const char *range_data = pq_getmsgbytes(buf, range_len);
359 :
360 0 : resetStringInfo(&tmpbuf);
361 0 : appendBinaryStringInfo(&tmpbuf, range_data, range_len);
362 :
363 0 : ranges[i] = DatumGetRangeTypeP(ReceiveFunctionCall(&cache->typioproc,
364 : &tmpbuf,
365 : cache->typioparam,
366 : typmod));
367 : }
368 0 : pfree(tmpbuf.data);
369 :
370 0 : pq_getmsgend(buf);
371 :
372 0 : ret = make_multirange(mltrngtypoid, cache->typcache->rngtype,
373 : range_count, ranges);
374 0 : PG_RETURN_MULTIRANGE_P(ret);
375 : }
376 :
377 : Datum
378 0 : multirange_send(PG_FUNCTION_ARGS)
379 : {
380 0 : MultirangeType *multirange = PG_GETARG_MULTIRANGE_P(0);
381 0 : Oid mltrngtypoid = MultirangeTypeGetOid(multirange);
382 0 : StringInfo buf = makeStringInfo();
383 : RangeType **ranges;
384 : int32 range_count;
385 : MultirangeIOData *cache;
386 :
387 0 : cache = get_multirange_io_data(fcinfo, mltrngtypoid, IOFunc_send);
388 :
389 : /* construct output */
390 0 : pq_begintypsend(buf);
391 :
392 0 : pq_sendint32(buf, multirange->rangeCount);
393 :
394 0 : multirange_deserialize(cache->typcache->rngtype, multirange, &range_count, &ranges);
395 0 : for (int i = 0; i < range_count; i++)
396 : {
397 : Datum range;
398 :
399 0 : range = RangeTypePGetDatum(ranges[i]);
400 0 : range = PointerGetDatum(SendFunctionCall(&cache->typioproc, range));
401 :
402 0 : pq_sendint32(buf, VARSIZE(range) - VARHDRSZ);
403 0 : pq_sendbytes(buf, VARDATA(range), VARSIZE(range) - VARHDRSZ);
404 : }
405 :
406 0 : PG_RETURN_BYTEA_P(pq_endtypsend(buf));
407 : }
408 :
409 : /*
410 : * get_multirange_io_data: get cached information needed for multirange type I/O
411 : *
412 : * The multirange I/O functions need a bit more cached info than other multirange
413 : * functions, so they store a MultirangeIOData struct in fn_extra, not just a
414 : * pointer to a type cache entry.
415 : */
416 : static MultirangeIOData *
417 3514 : get_multirange_io_data(FunctionCallInfo fcinfo, Oid mltrngtypid, IOFuncSelector func)
418 : {
419 3514 : MultirangeIOData *cache = (MultirangeIOData *) fcinfo->flinfo->fn_extra;
420 :
421 3514 : if (cache == NULL || cache->typcache->type_id != mltrngtypid)
422 : {
423 : Oid typiofunc;
424 : int16 typlen;
425 : bool typbyval;
426 : char typalign;
427 : char typdelim;
428 :
429 2378 : cache = (MultirangeIOData *) MemoryContextAlloc(fcinfo->flinfo->fn_mcxt,
430 : sizeof(MultirangeIOData));
431 2378 : cache->typcache = lookup_type_cache(mltrngtypid, TYPECACHE_MULTIRANGE_INFO);
432 2378 : if (cache->typcache->rngtype == NULL)
433 0 : elog(ERROR, "type %u is not a multirange type", mltrngtypid);
434 :
435 : /* get_type_io_data does more than we need, but is convenient */
436 2378 : get_type_io_data(cache->typcache->rngtype->type_id,
437 : func,
438 : &typlen,
439 : &typbyval,
440 : &typalign,
441 : &typdelim,
442 : &cache->typioparam,
443 : &typiofunc);
444 :
445 2378 : if (!OidIsValid(typiofunc))
446 : {
447 : /* this could only happen for receive or send */
448 0 : if (func == IOFunc_receive)
449 0 : ereport(ERROR,
450 : (errcode(ERRCODE_UNDEFINED_FUNCTION),
451 : errmsg("no binary input function available for type %s",
452 : format_type_be(cache->typcache->rngtype->type_id))));
453 : else
454 0 : ereport(ERROR,
455 : (errcode(ERRCODE_UNDEFINED_FUNCTION),
456 : errmsg("no binary output function available for type %s",
457 : format_type_be(cache->typcache->rngtype->type_id))));
458 : }
459 2378 : fmgr_info_cxt(typiofunc, &cache->typioproc,
460 2378 : fcinfo->flinfo->fn_mcxt);
461 :
462 2378 : fcinfo->flinfo->fn_extra = (void *) cache;
463 : }
464 :
465 3514 : return cache;
466 : }
467 :
468 : /*
469 : * Converts a list of arbitrary ranges into a list that is sorted and merged.
470 : * Changes the contents of `ranges`.
471 : *
472 : * Returns the number of slots actually used, which may be less than
473 : * input_range_count but never more.
474 : *
475 : * We assume that no input ranges are null, but empties are okay.
476 : */
477 : static int32
478 23388 : multirange_canonicalize(TypeCacheEntry *rangetyp, int32 input_range_count,
479 : RangeType **ranges)
480 : {
481 23388 : RangeType *lastRange = NULL;
482 : RangeType *currentRange;
483 : int32 i;
484 23388 : int32 output_range_count = 0;
485 :
486 : /* Sort the ranges so we can find the ones that overlap/meet. */
487 23388 : qsort_arg(ranges, input_range_count, sizeof(RangeType *), range_compare,
488 : rangetyp);
489 :
490 : /* Now merge where possible: */
491 72594 : for (i = 0; i < input_range_count; i++)
492 : {
493 49206 : currentRange = ranges[i];
494 49206 : if (RangeIsEmpty(currentRange))
495 186 : continue;
496 :
497 49020 : if (lastRange == NULL)
498 : {
499 22500 : ranges[output_range_count++] = lastRange = currentRange;
500 22500 : continue;
501 : }
502 :
503 : /*
504 : * range_adjacent_internal gives true if *either* A meets B or B meets
505 : * A, which is not quite want we want, but we rely on the sorting
506 : * above to rule out B meets A ever happening.
507 : */
508 26520 : if (range_adjacent_internal(rangetyp, lastRange, currentRange))
509 : {
510 : /* The two ranges touch (without overlap), so merge them: */
511 1260 : ranges[output_range_count - 1] = lastRange =
512 1260 : range_union_internal(rangetyp, lastRange, currentRange, false);
513 : }
514 25260 : else if (range_before_internal(rangetyp, lastRange, currentRange))
515 : {
516 : /* There's a gap, so make a new entry: */
517 25140 : lastRange = ranges[output_range_count] = currentRange;
518 25140 : output_range_count++;
519 : }
520 : else
521 : {
522 : /* They must overlap, so merge them: */
523 120 : ranges[output_range_count - 1] = lastRange =
524 120 : range_union_internal(rangetyp, lastRange, currentRange, true);
525 : }
526 : }
527 :
528 23388 : return output_range_count;
529 : }
530 :
531 : /*
532 : *----------------------------------------------------------
533 : * SUPPORT FUNCTIONS
534 : *
535 : * These functions aren't in pg_proc, but are useful for
536 : * defining new generic multirange functions in C.
537 : *----------------------------------------------------------
538 : */
539 :
540 : /*
541 : * multirange_get_typcache: get cached information about a multirange type
542 : *
543 : * This is for use by multirange-related functions that follow the convention
544 : * of using the fn_extra field as a pointer to the type cache entry for
545 : * the multirange type. Functions that need to cache more information than
546 : * that must fend for themselves.
547 : */
548 : TypeCacheEntry *
549 1250406 : multirange_get_typcache(FunctionCallInfo fcinfo, Oid mltrngtypid)
550 : {
551 1250406 : TypeCacheEntry *typcache = (TypeCacheEntry *) fcinfo->flinfo->fn_extra;
552 :
553 1250406 : if (typcache == NULL ||
554 1244970 : typcache->type_id != mltrngtypid)
555 : {
556 5436 : typcache = lookup_type_cache(mltrngtypid, TYPECACHE_MULTIRANGE_INFO);
557 5436 : if (typcache->rngtype == NULL)
558 0 : elog(ERROR, "type %u is not a multirange type", mltrngtypid);
559 5436 : fcinfo->flinfo->fn_extra = (void *) typcache;
560 : }
561 :
562 1250406 : return typcache;
563 : }
564 :
565 :
566 : /*
567 : * Estimate size occupied by serialized multirange.
568 : */
569 : static Size
570 23388 : multirange_size_estimate(TypeCacheEntry *rangetyp, int32 range_count,
571 : RangeType **ranges)
572 : {
573 23388 : char elemalign = rangetyp->rngelemtype->typalign;
574 : Size size;
575 : int32 i;
576 :
577 : /*
578 : * Count space for MultirangeType struct, items and flags.
579 : */
580 23388 : size = att_align_nominal(sizeof(MultirangeType) +
581 : Max(range_count - 1, 0) * sizeof(uint32) +
582 : range_count * sizeof(uint8), elemalign);
583 :
584 : /* Count space for range bounds */
585 71028 : for (i = 0; i < range_count; i++)
586 47640 : size += att_align_nominal(VARSIZE(ranges[i]) -
587 : sizeof(RangeType) -
588 : sizeof(char), elemalign);
589 :
590 23388 : return size;
591 : }
592 :
593 : /*
594 : * Write multirange data into pre-allocated space.
595 : */
596 : static void
597 23388 : write_multirange_data(MultirangeType *multirange, TypeCacheEntry *rangetyp,
598 : int32 range_count, RangeType **ranges)
599 : {
600 : uint32 *items;
601 23388 : uint32 prev_offset = 0;
602 : uint8 *flags;
603 : int32 i;
604 : Pointer begin,
605 : ptr;
606 23388 : char elemalign = rangetyp->rngelemtype->typalign;
607 :
608 23388 : items = MultirangeGetItemsPtr(multirange);
609 23388 : flags = MultirangeGetFlagsPtr(multirange);
610 23388 : ptr = begin = MultirangeGetBoundariesPtr(multirange, elemalign);
611 71028 : for (i = 0; i < range_count; i++)
612 : {
613 : uint32 len;
614 :
615 47640 : if (i > 0)
616 : {
617 : /*
618 : * Every range, except the first one, has an item. Every
619 : * MULTIRANGE_ITEM_OFFSET_STRIDE item contains an offset, others
620 : * contain lengths.
621 : */
622 25140 : items[i - 1] = ptr - begin;
623 25140 : if ((i % MULTIRANGE_ITEM_OFFSET_STRIDE) != 0)
624 25140 : items[i - 1] -= prev_offset;
625 : else
626 0 : items[i - 1] |= MULTIRANGE_ITEM_OFF_BIT;
627 25140 : prev_offset = ptr - begin;
628 : }
629 47640 : flags[i] = *((Pointer) ranges[i] + VARSIZE(ranges[i]) - sizeof(char));
630 47640 : len = VARSIZE(ranges[i]) - sizeof(RangeType) - sizeof(char);
631 47640 : memcpy(ptr, (Pointer) (ranges[i] + 1), len);
632 47640 : ptr += att_align_nominal(len, elemalign);
633 : }
634 23388 : }
635 :
636 :
637 : /*
638 : * This serializes the multirange from a list of non-null ranges. It also
639 : * sorts the ranges and merges any that touch. The ranges should already be
640 : * detoasted, and there should be no NULLs. This should be used by most
641 : * callers.
642 : *
643 : * Note that we may change the `ranges` parameter (the pointers, but not
644 : * any already-existing RangeType contents).
645 : */
646 : MultirangeType *
647 23388 : make_multirange(Oid mltrngtypoid, TypeCacheEntry *rangetyp, int32 range_count,
648 : RangeType **ranges)
649 : {
650 : MultirangeType *multirange;
651 : Size size;
652 :
653 : /* Sort and merge input ranges. */
654 23388 : range_count = multirange_canonicalize(rangetyp, range_count, ranges);
655 :
656 : /* Note: zero-fill is required here, just as in heap tuples */
657 23388 : size = multirange_size_estimate(rangetyp, range_count, ranges);
658 23388 : multirange = palloc0(size);
659 23388 : SET_VARSIZE(multirange, size);
660 :
661 : /* Now fill in the datum */
662 23388 : multirange->multirangetypid = mltrngtypoid;
663 23388 : multirange->rangeCount = range_count;
664 :
665 23388 : write_multirange_data(multirange, rangetyp, range_count, ranges);
666 :
667 23388 : return multirange;
668 : }
669 :
670 : /*
671 : * Get offset of bounds values of the i'th range in the multirange.
672 : */
673 : static uint32
674 1615452 : multirange_get_bounds_offset(const MultirangeType *multirange, int32 i)
675 : {
676 1615452 : uint32 *items = MultirangeGetItemsPtr(multirange);
677 1615452 : uint32 offset = 0;
678 :
679 : /*
680 : * Summarize lengths till we meet an offset.
681 : */
682 2620320 : while (i > 0)
683 : {
684 1004868 : offset += MULTIRANGE_ITEM_GET_OFFLEN(items[i - 1]);
685 1004868 : if (MULTIRANGE_ITEM_HAS_OFF(items[i - 1]))
686 0 : break;
687 1004868 : i--;
688 : }
689 1615452 : return offset;
690 : }
691 :
692 : /*
693 : * Fetch the i'th range from the multirange.
694 : */
695 : RangeType *
696 2790 : multirange_get_range(TypeCacheEntry *rangetyp,
697 : const MultirangeType *multirange, int i)
698 : {
699 : uint32 offset;
700 : uint8 flags;
701 : Pointer begin,
702 : ptr;
703 2790 : int16 typlen = rangetyp->rngelemtype->typlen;
704 2790 : char typalign = rangetyp->rngelemtype->typalign;
705 : uint32 len;
706 : RangeType *range;
707 :
708 : Assert(i < multirange->rangeCount);
709 :
710 2790 : offset = multirange_get_bounds_offset(multirange, i);
711 2790 : flags = MultirangeGetFlagsPtr(multirange)[i];
712 2790 : ptr = begin = MultirangeGetBoundariesPtr(multirange, typalign) + offset;
713 :
714 : /*
715 : * Calculate the size of bound values. In principle, we could get offset
716 : * of the next range bound values and calculate accordingly. But range
717 : * bound values are aligned, so we have to walk the values to get the
718 : * exact size.
719 : */
720 2790 : if (RANGE_HAS_LBOUND(flags))
721 2142 : ptr = (Pointer) att_addlength_pointer(ptr, typlen, ptr);
722 2790 : if (RANGE_HAS_UBOUND(flags))
723 : {
724 2106 : ptr = (Pointer) att_align_pointer(ptr, typalign, typlen, ptr);
725 2106 : ptr = (Pointer) att_addlength_pointer(ptr, typlen, ptr);
726 : }
727 2790 : len = (ptr - begin) + sizeof(RangeType) + sizeof(uint8);
728 :
729 2790 : range = palloc0(len);
730 2790 : SET_VARSIZE(range, len);
731 2790 : range->rangetypid = rangetyp->type_id;
732 :
733 2790 : memcpy(range + 1, begin, ptr - begin);
734 2790 : *((uint8 *) (range + 1) + (ptr - begin)) = flags;
735 :
736 2790 : return range;
737 : }
738 :
739 : /*
740 : * Fetch bounds from the i'th range of the multirange. This is the shortcut for
741 : * doing the same thing as multirange_get_range() + range_deserialize(), but
742 : * performing fewer operations.
743 : */
744 : void
745 1612662 : multirange_get_bounds(TypeCacheEntry *rangetyp,
746 : const MultirangeType *multirange,
747 : uint32 i, RangeBound *lower, RangeBound *upper)
748 : {
749 : uint32 offset;
750 : uint8 flags;
751 : Pointer ptr;
752 1612662 : int16 typlen = rangetyp->rngelemtype->typlen;
753 1612662 : char typalign = rangetyp->rngelemtype->typalign;
754 1612662 : bool typbyval = rangetyp->rngelemtype->typbyval;
755 : Datum lbound;
756 : Datum ubound;
757 :
758 : Assert(i < multirange->rangeCount);
759 :
760 1612662 : offset = multirange_get_bounds_offset(multirange, i);
761 1612662 : flags = MultirangeGetFlagsPtr(multirange)[i];
762 1612662 : ptr = MultirangeGetBoundariesPtr(multirange, typalign) + offset;
763 :
764 : /* multirange can't contain empty ranges */
765 : Assert((flags & RANGE_EMPTY) == 0);
766 :
767 : /* fetch lower bound, if any */
768 1612662 : if (RANGE_HAS_LBOUND(flags))
769 : {
770 : /* att_align_pointer cannot be necessary here */
771 1595082 : lbound = fetch_att(ptr, typbyval, typlen);
772 1595082 : ptr = (Pointer) att_addlength_pointer(ptr, typlen, ptr);
773 : }
774 : else
775 17580 : lbound = (Datum) 0;
776 :
777 : /* fetch upper bound, if any */
778 1612662 : if (RANGE_HAS_UBOUND(flags))
779 : {
780 1596654 : ptr = (Pointer) att_align_pointer(ptr, typalign, typlen, ptr);
781 1596654 : ubound = fetch_att(ptr, typbyval, typlen);
782 : /* no need for att_addlength_pointer */
783 : }
784 : else
785 16008 : ubound = (Datum) 0;
786 :
787 : /* emit results */
788 1612662 : lower->val = lbound;
789 1612662 : lower->infinite = (flags & RANGE_LB_INF) != 0;
790 1612662 : lower->inclusive = (flags & RANGE_LB_INC) != 0;
791 1612662 : lower->lower = true;
792 :
793 1612662 : upper->val = ubound;
794 1612662 : upper->infinite = (flags & RANGE_UB_INF) != 0;
795 1612662 : upper->inclusive = (flags & RANGE_UB_INC) != 0;
796 1612662 : upper->lower = false;
797 1612662 : }
798 :
799 : /*
800 : * Construct union range from the multirange.
801 : */
802 : RangeType *
803 22200 : multirange_get_union_range(TypeCacheEntry *rangetyp,
804 : const MultirangeType *mr)
805 : {
806 : RangeBound lower,
807 : upper,
808 : tmp;
809 :
810 22200 : if (MultirangeIsEmpty(mr))
811 3000 : return make_empty_range(rangetyp);
812 :
813 19200 : multirange_get_bounds(rangetyp, mr, 0, &lower, &tmp);
814 19200 : multirange_get_bounds(rangetyp, mr, mr->rangeCount - 1, &tmp, &upper);
815 :
816 19200 : return make_range(rangetyp, &lower, &upper, false, NULL);
817 : }
818 :
819 :
820 : /*
821 : * multirange_deserialize: deconstruct a multirange value
822 : *
823 : * NB: the given multirange object must be fully detoasted; it cannot have a
824 : * short varlena header.
825 : */
826 : void
827 2914 : multirange_deserialize(TypeCacheEntry *rangetyp,
828 : const MultirangeType *multirange, int32 *range_count,
829 : RangeType ***ranges)
830 : {
831 2914 : *range_count = multirange->rangeCount;
832 :
833 : /* Convert each ShortRangeType into a RangeType */
834 2914 : if (*range_count > 0)
835 : {
836 : int i;
837 :
838 2284 : *ranges = palloc(*range_count * sizeof(RangeType *));
839 5014 : for (i = 0; i < *range_count; i++)
840 2730 : (*ranges)[i] = multirange_get_range(rangetyp, multirange, i);
841 : }
842 : else
843 : {
844 630 : *ranges = NULL;
845 : }
846 2914 : }
847 :
848 : MultirangeType *
849 18 : make_empty_multirange(Oid mltrngtypoid, TypeCacheEntry *rangetyp)
850 : {
851 18 : return make_multirange(mltrngtypoid, rangetyp, 0, NULL);
852 : }
853 :
854 : /*
855 : * Similar to range_overlaps_internal(), but takes range bounds instead of
856 : * ranges as arguments.
857 : */
858 : static bool
859 57924 : range_bounds_overlaps(TypeCacheEntry *typcache,
860 : RangeBound *lower1, RangeBound *upper1,
861 : RangeBound *lower2, RangeBound *upper2)
862 : {
863 113826 : if (range_cmp_bounds(typcache, lower1, lower2) >= 0 &&
864 55902 : range_cmp_bounds(typcache, lower1, upper2) <= 0)
865 690 : return true;
866 :
867 59256 : if (range_cmp_bounds(typcache, lower2, lower1) >= 0 &&
868 2022 : range_cmp_bounds(typcache, lower2, upper1) <= 0)
869 2022 : return true;
870 :
871 55212 : return false;
872 : }
873 :
874 : /*
875 : * Similar to range_contains_internal(), but takes range bounds instead of
876 : * ranges as arguments.
877 : */
878 : static bool
879 95850 : range_bounds_contains(TypeCacheEntry *typcache,
880 : RangeBound *lower1, RangeBound *upper1,
881 : RangeBound *lower2, RangeBound *upper2)
882 : {
883 126384 : if (range_cmp_bounds(typcache, lower1, lower2) <= 0 &&
884 30534 : range_cmp_bounds(typcache, upper1, upper2) >= 0)
885 8574 : return true;
886 :
887 87276 : return false;
888 : }
889 :
890 : /*
891 : * Check if the given key matches any range in multirange using binary search.
892 : * If the required range isn't found, that counts as a mismatch. When the
893 : * required range is found, the comparison function can still report this as
894 : * either match or mismatch. For instance, if we search for containment, we can
895 : * found a range, which is overlapping but not containing the key range, and
896 : * that would count as a mismatch.
897 : */
898 : static bool
899 156628 : multirange_bsearch_match(TypeCacheEntry *typcache, const MultirangeType *mr,
900 : void *key, multirange_bsearch_comparison cmp_func)
901 : {
902 : uint32 l,
903 : u,
904 : idx;
905 : int comparison;
906 156628 : bool match = false;
907 :
908 156628 : l = 0;
909 156628 : u = mr->rangeCount;
910 415380 : while (l < u)
911 : {
912 : RangeBound lower,
913 : upper;
914 :
915 278810 : idx = (l + u) / 2;
916 278810 : multirange_get_bounds(typcache, mr, idx, &lower, &upper);
917 278810 : comparison = (*cmp_func) (typcache, &lower, &upper, key, &match);
918 :
919 278810 : if (comparison < 0)
920 93778 : u = idx;
921 185032 : else if (comparison > 0)
922 164974 : l = idx + 1;
923 : else
924 20058 : return match;
925 : }
926 :
927 136570 : return false;
928 : }
929 :
930 : /*
931 : *----------------------------------------------------------
932 : * GENERIC FUNCTIONS
933 : *----------------------------------------------------------
934 : */
935 :
936 : /*
937 : * Construct multirange value from zero or more ranges. Since this is a
938 : * variadic function we get passed an array. The array must contain ranges
939 : * that match our return value, and there must be no NULLs.
940 : */
941 : Datum
942 13806 : multirange_constructor2(PG_FUNCTION_ARGS)
943 : {
944 13806 : Oid mltrngtypid = get_fn_expr_rettype(fcinfo->flinfo);
945 : Oid rngtypid;
946 : TypeCacheEntry *typcache;
947 : TypeCacheEntry *rangetyp;
948 : ArrayType *rangeArray;
949 : int range_count;
950 : Datum *elements;
951 : bool *nulls;
952 : RangeType **ranges;
953 : int dims;
954 : int i;
955 :
956 13806 : typcache = multirange_get_typcache(fcinfo, mltrngtypid);
957 13806 : rangetyp = typcache->rngtype;
958 :
959 : /*
960 : * A no-arg invocation should call multirange_constructor0 instead, but
961 : * returning an empty range is what that does.
962 : */
963 :
964 13806 : if (PG_NARGS() == 0)
965 0 : PG_RETURN_MULTIRANGE_P(make_multirange(mltrngtypid, rangetyp, 0, NULL));
966 :
967 : /*
968 : * This check should be guaranteed by our signature, but let's do it just
969 : * in case.
970 : */
971 :
972 13806 : if (PG_ARGISNULL(0))
973 0 : elog(ERROR,
974 : "multirange values cannot contain null members");
975 :
976 13806 : rangeArray = PG_GETARG_ARRAYTYPE_P(0);
977 :
978 13806 : dims = ARR_NDIM(rangeArray);
979 13806 : if (dims > 1)
980 0 : ereport(ERROR,
981 : (errcode(ERRCODE_CARDINALITY_VIOLATION),
982 : errmsg("multiranges cannot be constructed from multidimensional arrays")));
983 :
984 13806 : rngtypid = ARR_ELEMTYPE(rangeArray);
985 13806 : if (rngtypid != rangetyp->type_id)
986 0 : elog(ERROR, "type %u does not match constructor type", rngtypid);
987 :
988 : /*
989 : * Be careful: we can still be called with zero ranges, like this:
990 : * `int4multirange(variadic '{}'::int4range[])
991 : */
992 13806 : if (dims == 0)
993 : {
994 6 : range_count = 0;
995 6 : ranges = NULL;
996 : }
997 : else
998 : {
999 13800 : deconstruct_array(rangeArray, rngtypid, rangetyp->typlen, rangetyp->typbyval,
1000 13800 : rangetyp->typalign, &elements, &nulls, &range_count);
1001 :
1002 13800 : ranges = palloc0(range_count * sizeof(RangeType *));
1003 53412 : for (i = 0; i < range_count; i++)
1004 : {
1005 39612 : if (nulls[i])
1006 0 : ereport(ERROR,
1007 : (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
1008 : errmsg("multirange values cannot contain null members")));
1009 :
1010 : /* make_multirange will do its own copy */
1011 39612 : ranges[i] = DatumGetRangeTypeP(elements[i]);
1012 : }
1013 : }
1014 :
1015 13806 : PG_RETURN_MULTIRANGE_P(make_multirange(mltrngtypid, rangetyp, range_count, ranges));
1016 : }
1017 :
1018 : /*
1019 : * Construct multirange value from a single range. It'd be nice if we could
1020 : * just use multirange_constructor2 for this case, but we need a non-variadic
1021 : * single-arg function to let us define a CAST from a range to its multirange.
1022 : */
1023 : Datum
1024 7374 : multirange_constructor1(PG_FUNCTION_ARGS)
1025 : {
1026 7374 : Oid mltrngtypid = get_fn_expr_rettype(fcinfo->flinfo);
1027 : Oid rngtypid;
1028 : TypeCacheEntry *typcache;
1029 : TypeCacheEntry *rangetyp;
1030 : RangeType *range;
1031 :
1032 7374 : typcache = multirange_get_typcache(fcinfo, mltrngtypid);
1033 7374 : rangetyp = typcache->rngtype;
1034 :
1035 : /*
1036 : * This check should be guaranteed by our signature, but let's do it just
1037 : * in case.
1038 : */
1039 :
1040 7374 : if (PG_ARGISNULL(0))
1041 0 : elog(ERROR,
1042 : "multirange values cannot contain null members");
1043 :
1044 7374 : range = PG_GETARG_RANGE_P(0);
1045 :
1046 : /* Make sure the range type matches. */
1047 7374 : rngtypid = RangeTypeGetOid(range);
1048 7374 : if (rngtypid != rangetyp->type_id)
1049 0 : elog(ERROR, "type %u does not match constructor type", rngtypid);
1050 :
1051 7374 : PG_RETURN_MULTIRANGE_P(make_multirange(mltrngtypid, rangetyp, 1, &range));
1052 : }
1053 :
1054 : /*
1055 : * Constructor just like multirange_constructor1, but opr_sanity gets angry
1056 : * if the same internal function handles multiple functions with different arg
1057 : * counts.
1058 : */
1059 : Datum
1060 372 : multirange_constructor0(PG_FUNCTION_ARGS)
1061 : {
1062 : Oid mltrngtypid;
1063 : TypeCacheEntry *typcache;
1064 : TypeCacheEntry *rangetyp;
1065 :
1066 : /* This should always be called without arguments */
1067 372 : if (PG_NARGS() != 0)
1068 0 : elog(ERROR,
1069 : "niladic multirange constructor must not receive arguments");
1070 :
1071 372 : mltrngtypid = get_fn_expr_rettype(fcinfo->flinfo);
1072 372 : typcache = multirange_get_typcache(fcinfo, mltrngtypid);
1073 372 : rangetyp = typcache->rngtype;
1074 :
1075 372 : PG_RETURN_MULTIRANGE_P(make_multirange(mltrngtypid, rangetyp, 0, NULL));
1076 : }
1077 :
1078 :
1079 : /* multirange, multirange -> multirange type functions */
1080 :
1081 : /* multirange union */
1082 : Datum
1083 54 : multirange_union(PG_FUNCTION_ARGS)
1084 : {
1085 54 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
1086 54 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
1087 : TypeCacheEntry *typcache;
1088 : int32 range_count1;
1089 : int32 range_count2;
1090 : int32 range_count3;
1091 : RangeType **ranges1;
1092 : RangeType **ranges2;
1093 : RangeType **ranges3;
1094 :
1095 54 : if (MultirangeIsEmpty(mr1))
1096 12 : PG_RETURN_MULTIRANGE_P(mr2);
1097 42 : if (MultirangeIsEmpty(mr2))
1098 6 : PG_RETURN_MULTIRANGE_P(mr1);
1099 :
1100 36 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
1101 :
1102 36 : multirange_deserialize(typcache->rngtype, mr1, &range_count1, &ranges1);
1103 36 : multirange_deserialize(typcache->rngtype, mr2, &range_count2, &ranges2);
1104 :
1105 36 : range_count3 = range_count1 + range_count2;
1106 36 : ranges3 = palloc0(range_count3 * sizeof(RangeType *));
1107 36 : memcpy(ranges3, ranges1, range_count1 * sizeof(RangeType *));
1108 36 : memcpy(ranges3 + range_count1, ranges2, range_count2 * sizeof(RangeType *));
1109 36 : PG_RETURN_MULTIRANGE_P(make_multirange(typcache->type_id, typcache->rngtype,
1110 : range_count3, ranges3));
1111 : }
1112 :
1113 : /* multirange minus */
1114 : Datum
1115 120 : multirange_minus(PG_FUNCTION_ARGS)
1116 : {
1117 120 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
1118 120 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
1119 120 : Oid mltrngtypoid = MultirangeTypeGetOid(mr1);
1120 : TypeCacheEntry *typcache;
1121 : TypeCacheEntry *rangetyp;
1122 : int32 range_count1;
1123 : int32 range_count2;
1124 : RangeType **ranges1;
1125 : RangeType **ranges2;
1126 :
1127 120 : typcache = multirange_get_typcache(fcinfo, mltrngtypoid);
1128 120 : rangetyp = typcache->rngtype;
1129 :
1130 120 : if (MultirangeIsEmpty(mr1) || MultirangeIsEmpty(mr2))
1131 24 : PG_RETURN_MULTIRANGE_P(mr1);
1132 :
1133 96 : multirange_deserialize(typcache->rngtype, mr1, &range_count1, &ranges1);
1134 96 : multirange_deserialize(typcache->rngtype, mr2, &range_count2, &ranges2);
1135 :
1136 96 : PG_RETURN_MULTIRANGE_P(multirange_minus_internal(mltrngtypoid,
1137 : rangetyp,
1138 : range_count1,
1139 : ranges1,
1140 : range_count2,
1141 : ranges2));
1142 : }
1143 :
1144 : MultirangeType *
1145 96 : multirange_minus_internal(Oid mltrngtypoid, TypeCacheEntry *rangetyp,
1146 : int32 range_count1, RangeType **ranges1,
1147 : int32 range_count2, RangeType **ranges2)
1148 : {
1149 : RangeType *r1;
1150 : RangeType *r2;
1151 : RangeType **ranges3;
1152 : int32 range_count3;
1153 : int32 i1;
1154 : int32 i2;
1155 :
1156 : /*
1157 : * Worst case: every range in ranges1 makes a different cut to some range
1158 : * in ranges2.
1159 : */
1160 96 : ranges3 = palloc0((range_count1 + range_count2) * sizeof(RangeType *));
1161 96 : range_count3 = 0;
1162 :
1163 : /*
1164 : * For each range in mr1, keep subtracting until it's gone or the ranges
1165 : * in mr2 have passed it. After a subtraction we assign what's left back
1166 : * to r1. The parallel progress through mr1 and mr2 is similar to
1167 : * multirange_overlaps_multirange_internal.
1168 : */
1169 96 : r2 = ranges2[0];
1170 234 : for (i1 = 0, i2 = 0; i1 < range_count1; i1++)
1171 : {
1172 138 : r1 = ranges1[i1];
1173 :
1174 : /* Discard r2s while r2 << r1 */
1175 156 : while (r2 != NULL && range_before_internal(rangetyp, r2, r1))
1176 : {
1177 18 : r2 = ++i2 >= range_count2 ? NULL : ranges2[i2];
1178 : }
1179 :
1180 174 : while (r2 != NULL)
1181 : {
1182 132 : if (range_split_internal(rangetyp, r1, r2, &ranges3[range_count3], &r1))
1183 : {
1184 : /*
1185 : * If r2 takes a bite out of the middle of r1, we need two
1186 : * outputs
1187 : */
1188 18 : range_count3++;
1189 18 : r2 = ++i2 >= range_count2 ? NULL : ranges2[i2];
1190 : }
1191 114 : else if (range_overlaps_internal(rangetyp, r1, r2))
1192 : {
1193 : /*
1194 : * If r2 overlaps r1, replace r1 with r1 - r2.
1195 : */
1196 66 : r1 = range_minus_internal(rangetyp, r1, r2);
1197 :
1198 : /*
1199 : * If r2 goes past r1, then we need to stay with it, in case
1200 : * it hits future r1s. Otherwise we need to keep r1, in case
1201 : * future r2s hit it. Since we already subtracted, there's no
1202 : * point in using the overright/overleft calls.
1203 : */
1204 66 : if (RangeIsEmpty(r1) || range_before_internal(rangetyp, r1, r2))
1205 : break;
1206 : else
1207 18 : r2 = ++i2 >= range_count2 ? NULL : ranges2[i2];
1208 : }
1209 : else
1210 : {
1211 : /*
1212 : * This and all future r2s are past r1, so keep them. Also
1213 : * assign whatever is left of r1 to the result.
1214 : */
1215 48 : break;
1216 : }
1217 : }
1218 :
1219 : /*
1220 : * Nothing else can remove anything from r1, so keep it. Even if r1 is
1221 : * empty here, make_multirange will remove it.
1222 : */
1223 138 : ranges3[range_count3++] = r1;
1224 : }
1225 :
1226 96 : return make_multirange(mltrngtypoid, rangetyp, range_count3, ranges3);
1227 : }
1228 :
1229 : /* multirange intersection */
1230 : Datum
1231 84 : multirange_intersect(PG_FUNCTION_ARGS)
1232 : {
1233 84 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
1234 84 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
1235 84 : Oid mltrngtypoid = MultirangeTypeGetOid(mr1);
1236 : TypeCacheEntry *typcache;
1237 : TypeCacheEntry *rangetyp;
1238 : int32 range_count1;
1239 : int32 range_count2;
1240 : RangeType **ranges1;
1241 : RangeType **ranges2;
1242 :
1243 84 : typcache = multirange_get_typcache(fcinfo, mltrngtypoid);
1244 84 : rangetyp = typcache->rngtype;
1245 :
1246 84 : if (MultirangeIsEmpty(mr1) || MultirangeIsEmpty(mr2))
1247 18 : PG_RETURN_MULTIRANGE_P(make_empty_multirange(mltrngtypoid, rangetyp));
1248 :
1249 66 : multirange_deserialize(rangetyp, mr1, &range_count1, &ranges1);
1250 66 : multirange_deserialize(rangetyp, mr2, &range_count2, &ranges2);
1251 :
1252 66 : PG_RETURN_MULTIRANGE_P(multirange_intersect_internal(mltrngtypoid,
1253 : rangetyp,
1254 : range_count1,
1255 : ranges1,
1256 : range_count2,
1257 : ranges2));
1258 : }
1259 :
1260 : MultirangeType *
1261 162 : multirange_intersect_internal(Oid mltrngtypoid, TypeCacheEntry *rangetyp,
1262 : int32 range_count1, RangeType **ranges1,
1263 : int32 range_count2, RangeType **ranges2)
1264 : {
1265 : RangeType *r1;
1266 : RangeType *r2;
1267 : RangeType **ranges3;
1268 : int32 range_count3;
1269 : int32 i1;
1270 : int32 i2;
1271 :
1272 162 : if (range_count1 == 0 || range_count2 == 0)
1273 60 : return make_multirange(mltrngtypoid, rangetyp, 0, NULL);
1274 :
1275 : /*-----------------------------------------------
1276 : * Worst case is a stitching pattern like this:
1277 : *
1278 : * mr1: --- --- --- ---
1279 : * mr2: --- --- ---
1280 : * mr3: - - - - - -
1281 : *
1282 : * That seems to be range_count1 + range_count2 - 1,
1283 : * but one extra won't hurt.
1284 : *-----------------------------------------------
1285 : */
1286 102 : ranges3 = palloc0((range_count1 + range_count2) * sizeof(RangeType *));
1287 102 : range_count3 = 0;
1288 :
1289 : /*
1290 : * For each range in mr1, keep intersecting until the ranges in mr2 have
1291 : * passed it. The parallel progress through mr1 and mr2 is similar to
1292 : * multirange_minus_multirange_internal, but we don't have to assign back
1293 : * to r1.
1294 : */
1295 102 : r2 = ranges2[0];
1296 228 : for (i1 = 0, i2 = 0; i1 < range_count1; i1++)
1297 : {
1298 138 : r1 = ranges1[i1];
1299 :
1300 : /* Discard r2s while r2 << r1 */
1301 150 : while (r2 != NULL && range_before_internal(rangetyp, r2, r1))
1302 : {
1303 12 : r2 = ++i2 >= range_count2 ? NULL : ranges2[i2];
1304 : }
1305 :
1306 186 : while (r2 != NULL)
1307 : {
1308 174 : if (range_overlaps_internal(rangetyp, r1, r2))
1309 : {
1310 : /* Keep the overlapping part */
1311 156 : ranges3[range_count3++] = range_intersect_internal(rangetyp, r1, r2);
1312 :
1313 : /* If we "used up" all of r2, go to the next one... */
1314 156 : if (range_overleft_internal(rangetyp, r2, r1))
1315 48 : r2 = ++i2 >= range_count2 ? NULL : ranges2[i2];
1316 :
1317 : /* ...otherwise go to the next r1 */
1318 : else
1319 108 : break;
1320 : }
1321 : else
1322 : /* We're past r1, so move to the next one */
1323 18 : break;
1324 : }
1325 :
1326 : /* If we're out of r2s, there can be no more intersections */
1327 138 : if (r2 == NULL)
1328 12 : break;
1329 : }
1330 :
1331 102 : return make_multirange(mltrngtypoid, rangetyp, range_count3, ranges3);
1332 : }
1333 :
1334 : /*
1335 : * range_agg_transfn: combine adjacent/overlapping ranges.
1336 : *
1337 : * All we do here is gather the input ranges into an array
1338 : * so that the finalfn can sort and combine them.
1339 : */
1340 : Datum
1341 114 : range_agg_transfn(PG_FUNCTION_ARGS)
1342 : {
1343 : MemoryContext aggContext;
1344 : Oid rngtypoid;
1345 : ArrayBuildState *state;
1346 :
1347 114 : if (!AggCheckCallContext(fcinfo, &aggContext))
1348 0 : elog(ERROR, "range_agg_transfn called in non-aggregate context");
1349 :
1350 114 : rngtypoid = get_fn_expr_argtype(fcinfo->flinfo, 1);
1351 114 : if (!type_is_range(rngtypoid))
1352 0 : elog(ERROR, "range_agg must be called with a range");
1353 :
1354 114 : if (PG_ARGISNULL(0))
1355 54 : state = initArrayResult(rngtypoid, aggContext, false);
1356 : else
1357 60 : state = (ArrayBuildState *) PG_GETARG_POINTER(0);
1358 :
1359 : /* skip NULLs */
1360 114 : if (!PG_ARGISNULL(1))
1361 90 : accumArrayResult(state, PG_GETARG_DATUM(1), false, rngtypoid, aggContext);
1362 :
1363 114 : PG_RETURN_POINTER(state);
1364 : }
1365 :
1366 : /*
1367 : * range_agg_finalfn: use our internal array to merge touching ranges.
1368 : *
1369 : * Shared by range_agg_finalfn(anyrange) and
1370 : * multirange_agg_finalfn(anymultirange).
1371 : */
1372 : Datum
1373 114 : range_agg_finalfn(PG_FUNCTION_ARGS)
1374 : {
1375 : MemoryContext aggContext;
1376 : Oid mltrngtypoid;
1377 : TypeCacheEntry *typcache;
1378 : ArrayBuildState *state;
1379 : int32 range_count;
1380 : RangeType **ranges;
1381 : int i;
1382 :
1383 114 : if (!AggCheckCallContext(fcinfo, &aggContext))
1384 0 : elog(ERROR, "range_agg_finalfn called in non-aggregate context");
1385 :
1386 114 : state = PG_ARGISNULL(0) ? NULL : (ArrayBuildState *) PG_GETARG_POINTER(0);
1387 114 : if (state == NULL)
1388 : /* This shouldn't be possible, but just in case.... */
1389 6 : PG_RETURN_NULL();
1390 :
1391 : /* Also return NULL if we had zero inputs, like other aggregates */
1392 108 : range_count = state->nelems;
1393 108 : if (range_count == 0)
1394 18 : PG_RETURN_NULL();
1395 :
1396 90 : mltrngtypoid = get_fn_expr_rettype(fcinfo->flinfo);
1397 90 : typcache = multirange_get_typcache(fcinfo, mltrngtypoid);
1398 :
1399 90 : ranges = palloc0(range_count * sizeof(RangeType *));
1400 318 : for (i = 0; i < range_count; i++)
1401 228 : ranges[i] = DatumGetRangeTypeP(state->dvalues[i]);
1402 :
1403 90 : PG_RETURN_MULTIRANGE_P(make_multirange(mltrngtypoid, typcache->rngtype, range_count, ranges));
1404 : }
1405 :
1406 : /*
1407 : * multirange_agg_transfn: combine adjacent/overlapping multiranges.
1408 : *
1409 : * All we do here is gather the input multiranges' ranges into an array so
1410 : * that the finalfn can sort and combine them.
1411 : */
1412 : Datum
1413 192 : multirange_agg_transfn(PG_FUNCTION_ARGS)
1414 : {
1415 : MemoryContext aggContext;
1416 : Oid mltrngtypoid;
1417 : TypeCacheEntry *typcache;
1418 : TypeCacheEntry *rngtypcache;
1419 : ArrayBuildState *state;
1420 :
1421 192 : if (!AggCheckCallContext(fcinfo, &aggContext))
1422 0 : elog(ERROR, "multirange_agg_transfn called in non-aggregate context");
1423 :
1424 192 : mltrngtypoid = get_fn_expr_argtype(fcinfo->flinfo, 1);
1425 192 : if (!type_is_multirange(mltrngtypoid))
1426 0 : elog(ERROR, "range_agg must be called with a multirange");
1427 :
1428 192 : typcache = multirange_get_typcache(fcinfo, mltrngtypoid);
1429 192 : rngtypcache = typcache->rngtype;
1430 :
1431 192 : if (PG_ARGISNULL(0))
1432 54 : state = initArrayResult(rngtypcache->type_id, aggContext, false);
1433 : else
1434 138 : state = (ArrayBuildState *) PG_GETARG_POINTER(0);
1435 :
1436 : /* skip NULLs */
1437 192 : if (!PG_ARGISNULL(1))
1438 : {
1439 : MultirangeType *current;
1440 : int32 range_count;
1441 : RangeType **ranges;
1442 :
1443 126 : current = PG_GETARG_MULTIRANGE_P(1);
1444 126 : multirange_deserialize(rngtypcache, current, &range_count, &ranges);
1445 126 : if (range_count == 0)
1446 : {
1447 : /*
1448 : * Add an empty range so we get an empty result (not a null
1449 : * result).
1450 : */
1451 42 : accumArrayResult(state,
1452 42 : RangeTypePGetDatum(make_empty_range(rngtypcache)),
1453 : false, rngtypcache->type_id, aggContext);
1454 : }
1455 : else
1456 : {
1457 180 : for (int32 i = 0; i < range_count; i++)
1458 96 : accumArrayResult(state, RangeTypePGetDatum(ranges[i]), false, rngtypcache->type_id, aggContext);
1459 : }
1460 : }
1461 :
1462 192 : PG_RETURN_POINTER(state);
1463 : }
1464 :
1465 : Datum
1466 96 : multirange_intersect_agg_transfn(PG_FUNCTION_ARGS)
1467 : {
1468 : MemoryContext aggContext;
1469 : Oid mltrngtypoid;
1470 : TypeCacheEntry *typcache;
1471 : MultirangeType *result;
1472 : MultirangeType *current;
1473 : int32 range_count1;
1474 : int32 range_count2;
1475 : RangeType **ranges1;
1476 : RangeType **ranges2;
1477 :
1478 96 : if (!AggCheckCallContext(fcinfo, &aggContext))
1479 0 : elog(ERROR, "multirange_intersect_agg_transfn called in non-aggregate context");
1480 :
1481 96 : mltrngtypoid = get_fn_expr_argtype(fcinfo->flinfo, 1);
1482 96 : if (!type_is_multirange(mltrngtypoid))
1483 0 : elog(ERROR, "range_intersect_agg must be called with a multirange");
1484 :
1485 96 : typcache = multirange_get_typcache(fcinfo, mltrngtypoid);
1486 :
1487 : /* strictness ensures these are non-null */
1488 96 : result = PG_GETARG_MULTIRANGE_P(0);
1489 96 : current = PG_GETARG_MULTIRANGE_P(1);
1490 :
1491 96 : multirange_deserialize(typcache->rngtype, result, &range_count1, &ranges1);
1492 96 : multirange_deserialize(typcache->rngtype, current, &range_count2, &ranges2);
1493 :
1494 96 : result = multirange_intersect_internal(mltrngtypoid,
1495 96 : typcache->rngtype,
1496 : range_count1,
1497 : ranges1,
1498 : range_count2,
1499 : ranges2);
1500 96 : PG_RETURN_MULTIRANGE_P(result);
1501 : }
1502 :
1503 :
1504 : /* multirange -> element type functions */
1505 :
1506 : /* extract lower bound value */
1507 : Datum
1508 132 : multirange_lower(PG_FUNCTION_ARGS)
1509 : {
1510 132 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1511 : TypeCacheEntry *typcache;
1512 : RangeBound lower;
1513 : RangeBound upper;
1514 :
1515 132 : if (MultirangeIsEmpty(mr))
1516 24 : PG_RETURN_NULL();
1517 :
1518 108 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1519 :
1520 108 : multirange_get_bounds(typcache->rngtype, mr, 0,
1521 : &lower, &upper);
1522 :
1523 108 : if (!lower.infinite)
1524 90 : PG_RETURN_DATUM(lower.val);
1525 : else
1526 18 : PG_RETURN_NULL();
1527 : }
1528 :
1529 : /* extract upper bound value */
1530 : Datum
1531 138 : multirange_upper(PG_FUNCTION_ARGS)
1532 : {
1533 138 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1534 : TypeCacheEntry *typcache;
1535 : RangeBound lower;
1536 : RangeBound upper;
1537 :
1538 138 : if (MultirangeIsEmpty(mr))
1539 24 : PG_RETURN_NULL();
1540 :
1541 114 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1542 :
1543 114 : multirange_get_bounds(typcache->rngtype, mr, mr->rangeCount - 1,
1544 : &lower, &upper);
1545 :
1546 114 : if (!upper.infinite)
1547 96 : PG_RETURN_DATUM(upper.val);
1548 : else
1549 18 : PG_RETURN_NULL();
1550 : }
1551 :
1552 :
1553 : /* multirange -> bool functions */
1554 :
1555 : /* is multirange empty? */
1556 : Datum
1557 66 : multirange_empty(PG_FUNCTION_ARGS)
1558 : {
1559 66 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1560 :
1561 66 : PG_RETURN_BOOL(MultirangeIsEmpty(mr));
1562 : }
1563 :
1564 : /* is lower bound inclusive? */
1565 : Datum
1566 66 : multirange_lower_inc(PG_FUNCTION_ARGS)
1567 : {
1568 66 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1569 : TypeCacheEntry *typcache;
1570 : RangeBound lower;
1571 : RangeBound upper;
1572 :
1573 66 : if (MultirangeIsEmpty(mr))
1574 24 : PG_RETURN_BOOL(false);
1575 :
1576 42 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1577 42 : multirange_get_bounds(typcache->rngtype, mr, 0,
1578 : &lower, &upper);
1579 :
1580 42 : PG_RETURN_BOOL(lower.inclusive);
1581 : }
1582 :
1583 : /* is upper bound inclusive? */
1584 : Datum
1585 66 : multirange_upper_inc(PG_FUNCTION_ARGS)
1586 : {
1587 66 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1588 : TypeCacheEntry *typcache;
1589 : RangeBound lower;
1590 : RangeBound upper;
1591 :
1592 66 : if (MultirangeIsEmpty(mr))
1593 24 : PG_RETURN_BOOL(false);
1594 :
1595 42 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1596 42 : multirange_get_bounds(typcache->rngtype, mr, mr->rangeCount - 1,
1597 : &lower, &upper);
1598 :
1599 42 : PG_RETURN_BOOL(upper.inclusive);
1600 : }
1601 :
1602 : /* is lower bound infinite? */
1603 : Datum
1604 66 : multirange_lower_inf(PG_FUNCTION_ARGS)
1605 : {
1606 66 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1607 : TypeCacheEntry *typcache;
1608 : RangeBound lower;
1609 : RangeBound upper;
1610 :
1611 66 : if (MultirangeIsEmpty(mr))
1612 24 : PG_RETURN_BOOL(false);
1613 :
1614 42 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1615 42 : multirange_get_bounds(typcache->rngtype, mr, 0,
1616 : &lower, &upper);
1617 :
1618 42 : PG_RETURN_BOOL(lower.infinite);
1619 : }
1620 :
1621 : /* is upper bound infinite? */
1622 : Datum
1623 66 : multirange_upper_inf(PG_FUNCTION_ARGS)
1624 : {
1625 66 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1626 : TypeCacheEntry *typcache;
1627 : RangeBound lower;
1628 : RangeBound upper;
1629 :
1630 66 : if (MultirangeIsEmpty(mr))
1631 24 : PG_RETURN_BOOL(false);
1632 :
1633 42 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1634 42 : multirange_get_bounds(typcache->rngtype, mr, mr->rangeCount - 1,
1635 : &lower, &upper);
1636 :
1637 42 : PG_RETURN_BOOL(upper.infinite);
1638 : }
1639 :
1640 :
1641 :
1642 : /* multirange, element -> bool functions */
1643 :
1644 : /* contains? */
1645 : Datum
1646 23142 : multirange_contains_elem(PG_FUNCTION_ARGS)
1647 : {
1648 23142 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1649 23142 : Datum val = PG_GETARG_DATUM(1);
1650 : TypeCacheEntry *typcache;
1651 :
1652 23142 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1653 :
1654 23142 : PG_RETURN_BOOL(multirange_contains_elem_internal(typcache->rngtype, mr, val));
1655 : }
1656 :
1657 : /* contained by? */
1658 : Datum
1659 144 : elem_contained_by_multirange(PG_FUNCTION_ARGS)
1660 : {
1661 144 : Datum val = PG_GETARG_DATUM(0);
1662 144 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
1663 : TypeCacheEntry *typcache;
1664 :
1665 144 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1666 :
1667 144 : PG_RETURN_BOOL(multirange_contains_elem_internal(typcache->rngtype, mr, val));
1668 : }
1669 :
1670 : /*
1671 : * Comparison function for checking if any range of multirange contains given
1672 : * key element using binary search.
1673 : */
1674 : static int
1675 32226 : multirange_elem_bsearch_comparison(TypeCacheEntry *typcache,
1676 : RangeBound *lower, RangeBound *upper,
1677 : void *key, bool *match)
1678 : {
1679 32226 : Datum val = *((Datum *) key);
1680 : int cmp;
1681 :
1682 32226 : if (!lower->infinite)
1683 : {
1684 30936 : cmp = DatumGetInt32(FunctionCall2Coll(&typcache->rng_cmp_proc_finfo,
1685 : typcache->rng_collation,
1686 : lower->val, val));
1687 30936 : if (cmp > 0 || (cmp == 0 && !lower->inclusive))
1688 30546 : return -1;
1689 : }
1690 :
1691 1680 : if (!upper->infinite)
1692 : {
1693 1590 : cmp = DatumGetInt32(FunctionCall2Coll(&typcache->rng_cmp_proc_finfo,
1694 : typcache->rng_collation,
1695 : upper->val, val));
1696 1590 : if (cmp < 0 || (cmp == 0 && !upper->inclusive))
1697 96 : return 1;
1698 : }
1699 :
1700 1584 : *match = true;
1701 1584 : return 0;
1702 : }
1703 :
1704 : /*
1705 : * Test whether multirange mr contains a specific element value.
1706 : */
1707 : bool
1708 23286 : multirange_contains_elem_internal(TypeCacheEntry *rangetyp,
1709 : const MultirangeType *mr, Datum val)
1710 : {
1711 23286 : if (MultirangeIsEmpty(mr))
1712 3120 : return false;
1713 :
1714 20166 : return multirange_bsearch_match(rangetyp, mr, &val,
1715 : multirange_elem_bsearch_comparison);
1716 : }
1717 :
1718 : /* multirange, range -> bool functions */
1719 :
1720 : /* contains? */
1721 : Datum
1722 89754 : multirange_contains_range(PG_FUNCTION_ARGS)
1723 : {
1724 89754 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1725 89754 : RangeType *r = PG_GETARG_RANGE_P(1);
1726 : TypeCacheEntry *typcache;
1727 :
1728 89754 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1729 :
1730 89754 : PG_RETURN_BOOL(multirange_contains_range_internal(typcache->rngtype, mr, r));
1731 : }
1732 :
1733 : Datum
1734 74490 : range_contains_multirange(PG_FUNCTION_ARGS)
1735 : {
1736 74490 : RangeType *r = PG_GETARG_RANGE_P(0);
1737 74490 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
1738 : TypeCacheEntry *typcache;
1739 :
1740 74490 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1741 :
1742 74490 : PG_RETURN_BOOL(range_contains_multirange_internal(typcache->rngtype, r, mr));
1743 : }
1744 :
1745 : /* contained by? */
1746 : Datum
1747 37428 : range_contained_by_multirange(PG_FUNCTION_ARGS)
1748 : {
1749 37428 : RangeType *r = PG_GETARG_RANGE_P(0);
1750 37428 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
1751 : TypeCacheEntry *typcache;
1752 :
1753 37428 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1754 :
1755 37428 : PG_RETURN_BOOL(multirange_contains_range_internal(typcache->rngtype, mr, r));
1756 : }
1757 :
1758 : Datum
1759 50490 : multirange_contained_by_range(PG_FUNCTION_ARGS)
1760 : {
1761 50490 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1762 50490 : RangeType *r = PG_GETARG_RANGE_P(1);
1763 : TypeCacheEntry *typcache;
1764 :
1765 50490 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1766 :
1767 50490 : PG_RETURN_BOOL(range_contains_multirange_internal(typcache->rngtype, r, mr));
1768 : }
1769 :
1770 : /*
1771 : * Comparison function for checking if any range of multirange contains given
1772 : * key range using binary search.
1773 : */
1774 : static int
1775 122154 : multirange_range_contains_bsearch_comparison(TypeCacheEntry *typcache,
1776 : RangeBound *lower, RangeBound *upper,
1777 : void *key, bool *match)
1778 : {
1779 122154 : RangeBound *keyLower = (RangeBound *) key;
1780 122154 : RangeBound *keyUpper = (RangeBound *) key + 1;
1781 :
1782 : /* Check if key range is strictly in the left or in the right */
1783 122154 : if (range_cmp_bounds(typcache, keyUpper, lower) < 0)
1784 31776 : return -1;
1785 90378 : if (range_cmp_bounds(typcache, keyLower, upper) > 0)
1786 80298 : return 1;
1787 :
1788 : /*
1789 : * At this point we found overlapping range. But we have to check if it
1790 : * really contains the key range. Anyway, we have to stop our search
1791 : * here, because multirange contains only non-overlapping ranges.
1792 : */
1793 10080 : *match = range_bounds_contains(typcache, lower, upper, keyLower, keyUpper);
1794 :
1795 10080 : return 0;
1796 : }
1797 :
1798 : /*
1799 : * Test whether multirange mr contains a specific range r.
1800 : */
1801 : bool
1802 161484 : multirange_contains_range_internal(TypeCacheEntry *rangetyp,
1803 : const MultirangeType *mr,
1804 : const RangeType *r)
1805 : {
1806 : RangeBound bounds[2];
1807 : bool empty;
1808 :
1809 : /*
1810 : * Every multirange contains an infinite number of empty ranges, even an
1811 : * empty one.
1812 : */
1813 161484 : if (RangeIsEmpty(r))
1814 90612 : return true;
1815 :
1816 70872 : if (MultirangeIsEmpty(mr))
1817 3096 : return false;
1818 :
1819 67776 : range_deserialize(rangetyp, r, &bounds[0], &bounds[1], &empty);
1820 : Assert(!empty);
1821 :
1822 67776 : return multirange_bsearch_match(rangetyp, mr, bounds,
1823 : multirange_range_contains_bsearch_comparison);
1824 : }
1825 :
1826 : /*
1827 : * Test whether range r contains a multirange mr.
1828 : */
1829 : bool
1830 278734 : range_contains_multirange_internal(TypeCacheEntry *rangetyp,
1831 : const RangeType *r,
1832 : const MultirangeType *mr)
1833 : {
1834 : RangeBound lower1,
1835 : upper1,
1836 : lower2,
1837 : upper2,
1838 : tmp;
1839 : bool empty;
1840 :
1841 : /*
1842 : * Every range contains an infinite number of empty multiranges, even an
1843 : * empty one.
1844 : */
1845 278734 : if (MultirangeIsEmpty(mr))
1846 191086 : return true;
1847 :
1848 87648 : if (RangeIsEmpty(r))
1849 25272 : return false;
1850 :
1851 : /* Range contains multirange iff it contains its union range. */
1852 62376 : range_deserialize(rangetyp, r, &lower1, &upper1, &empty);
1853 : Assert(!empty);
1854 62376 : multirange_get_bounds(rangetyp, mr, 0, &lower2, &tmp);
1855 62376 : multirange_get_bounds(rangetyp, mr, mr->rangeCount - 1, &tmp, &upper2);
1856 :
1857 62376 : return range_bounds_contains(rangetyp, &lower1, &upper1, &lower2, &upper2);
1858 : }
1859 :
1860 :
1861 : /* multirange, multirange -> bool functions */
1862 :
1863 : /* equality (internal version) */
1864 : bool
1865 47754 : multirange_eq_internal(TypeCacheEntry *rangetyp,
1866 : const MultirangeType *mr1,
1867 : const MultirangeType *mr2)
1868 : {
1869 : int32 range_count_1;
1870 : int32 range_count_2;
1871 : int32 i;
1872 : RangeBound lower1,
1873 : upper1,
1874 : lower2,
1875 : upper2;
1876 :
1877 : /* Different types should be prevented by ANYMULTIRANGE matching rules */
1878 47754 : if (MultirangeTypeGetOid(mr1) != MultirangeTypeGetOid(mr2))
1879 0 : elog(ERROR, "multirange types do not match");
1880 :
1881 47754 : range_count_1 = mr1->rangeCount;
1882 47754 : range_count_2 = mr2->rangeCount;
1883 :
1884 47754 : if (range_count_1 != range_count_2)
1885 29490 : return false;
1886 :
1887 18396 : for (i = 0; i < range_count_1; i++)
1888 : {
1889 12168 : multirange_get_bounds(rangetyp, mr1, i, &lower1, &upper1);
1890 12168 : multirange_get_bounds(rangetyp, mr2, i, &lower2, &upper2);
1891 :
1892 12318 : if (range_cmp_bounds(rangetyp, &lower1, &lower2) != 0 ||
1893 150 : range_cmp_bounds(rangetyp, &upper1, &upper2) != 0)
1894 12036 : return false;
1895 : }
1896 :
1897 6228 : return true;
1898 : }
1899 :
1900 : /* equality */
1901 : Datum
1902 47622 : multirange_eq(PG_FUNCTION_ARGS)
1903 : {
1904 47622 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
1905 47622 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
1906 : TypeCacheEntry *typcache;
1907 :
1908 47622 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
1909 :
1910 47622 : PG_RETURN_BOOL(multirange_eq_internal(typcache->rngtype, mr1, mr2));
1911 : }
1912 :
1913 : /* inequality (internal version) */
1914 : bool
1915 132 : multirange_ne_internal(TypeCacheEntry *rangetyp,
1916 : const MultirangeType *mr1,
1917 : const MultirangeType *mr2)
1918 : {
1919 132 : return (!multirange_eq_internal(rangetyp, mr1, mr2));
1920 : }
1921 :
1922 : /* inequality */
1923 : Datum
1924 132 : multirange_ne(PG_FUNCTION_ARGS)
1925 : {
1926 132 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
1927 132 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
1928 : TypeCacheEntry *typcache;
1929 :
1930 132 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
1931 :
1932 132 : PG_RETURN_BOOL(multirange_ne_internal(typcache->rngtype, mr1, mr2));
1933 : }
1934 :
1935 : /* overlaps? */
1936 : Datum
1937 37344 : range_overlaps_multirange(PG_FUNCTION_ARGS)
1938 : {
1939 37344 : RangeType *r = PG_GETARG_RANGE_P(0);
1940 37344 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
1941 : TypeCacheEntry *typcache;
1942 :
1943 37344 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1944 :
1945 37344 : PG_RETURN_BOOL(range_overlaps_multirange_internal(typcache->rngtype, r, mr));
1946 : }
1947 :
1948 : Datum
1949 45390 : multirange_overlaps_range(PG_FUNCTION_ARGS)
1950 : {
1951 45390 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
1952 45390 : RangeType *r = PG_GETARG_RANGE_P(1);
1953 : TypeCacheEntry *typcache;
1954 :
1955 45390 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
1956 :
1957 45390 : PG_RETURN_BOOL(range_overlaps_multirange_internal(typcache->rngtype, r, mr));
1958 : }
1959 :
1960 : Datum
1961 46044 : multirange_overlaps_multirange(PG_FUNCTION_ARGS)
1962 : {
1963 46044 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
1964 46044 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
1965 : TypeCacheEntry *typcache;
1966 :
1967 46044 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
1968 :
1969 46044 : PG_RETURN_BOOL(multirange_overlaps_multirange_internal(typcache->rngtype, mr1, mr2));
1970 : }
1971 :
1972 : /*
1973 : * Comparison function for checking if any range of multirange overlaps given
1974 : * key range using binary search.
1975 : */
1976 : static int
1977 124430 : multirange_range_overlaps_bsearch_comparison(TypeCacheEntry *typcache,
1978 : RangeBound *lower, RangeBound *upper,
1979 : void *key, bool *match)
1980 : {
1981 124430 : RangeBound *keyLower = (RangeBound *) key;
1982 124430 : RangeBound *keyUpper = (RangeBound *) key + 1;
1983 :
1984 124430 : if (range_cmp_bounds(typcache, keyUpper, lower) < 0)
1985 31456 : return -1;
1986 92974 : if (range_cmp_bounds(typcache, keyLower, upper) > 0)
1987 84580 : return 1;
1988 :
1989 8394 : *match = true;
1990 8394 : return 0;
1991 : }
1992 :
1993 : bool
1994 100382 : range_overlaps_multirange_internal(TypeCacheEntry *rangetyp,
1995 : const RangeType *r,
1996 : const MultirangeType *mr)
1997 : {
1998 : RangeBound bounds[2];
1999 : bool empty;
2000 :
2001 : /*
2002 : * Empties never overlap, even with empties. (This seems strange since
2003 : * they *do* contain each other, but we want to follow how ranges work.)
2004 : */
2005 100382 : if (RangeIsEmpty(r) || MultirangeIsEmpty(mr))
2006 31696 : return false;
2007 :
2008 68686 : range_deserialize(rangetyp, r, &bounds[0], &bounds[1], &empty);
2009 : Assert(!empty);
2010 :
2011 68686 : return multirange_bsearch_match(rangetyp, mr, bounds,
2012 : multirange_range_overlaps_bsearch_comparison);
2013 : }
2014 :
2015 : bool
2016 46044 : multirange_overlaps_multirange_internal(TypeCacheEntry *rangetyp,
2017 : const MultirangeType *mr1,
2018 : const MultirangeType *mr2)
2019 : {
2020 : int32 range_count1;
2021 : int32 range_count2;
2022 : int32 i1;
2023 : int32 i2;
2024 : RangeBound lower1,
2025 : upper1,
2026 : lower2,
2027 : upper2;
2028 :
2029 : /*
2030 : * Empties never overlap, even with empties. (This seems strange since
2031 : * they *do* contain each other, but we want to follow how ranges work.)
2032 : */
2033 46044 : if (MultirangeIsEmpty(mr1) || MultirangeIsEmpty(mr2))
2034 25314 : return false;
2035 :
2036 20730 : range_count1 = mr1->rangeCount;
2037 20730 : range_count2 = mr2->rangeCount;
2038 :
2039 : /*
2040 : * Every range in mr1 gets a chance to overlap with the ranges in mr2, but
2041 : * we can use their ordering to avoid O(n^2). This is similar to
2042 : * range_overlaps_multirange where r1 : r2 :: mrr : r, but there if we
2043 : * don't find an overlap with r we're done, and here if we don't find an
2044 : * overlap with r2 we try the next r2.
2045 : */
2046 20730 : i1 = 0;
2047 20730 : multirange_get_bounds(rangetyp, mr1, i1, &lower1, &upper1);
2048 75942 : for (i1 = 0, i2 = 0; i2 < range_count2; i2++)
2049 : {
2050 58026 : multirange_get_bounds(rangetyp, mr2, i2, &lower2, &upper2);
2051 :
2052 : /* Discard r1s while r1 << r2 */
2053 58158 : while (range_cmp_bounds(rangetyp, &upper1, &lower2) < 0)
2054 : {
2055 234 : if (++i1 >= range_count1)
2056 102 : return false;
2057 132 : multirange_get_bounds(rangetyp, mr1, i1, &lower1, &upper1);
2058 : }
2059 :
2060 : /*
2061 : * If r1 && r2, we're done, otherwise we failed to find an overlap for
2062 : * r2, so go to the next one.
2063 : */
2064 57924 : if (range_bounds_overlaps(rangetyp, &lower1, &upper1, &lower2, &upper2))
2065 2712 : return true;
2066 : }
2067 :
2068 : /* We looked through all of mr2 without finding an overlap */
2069 17916 : return false;
2070 : }
2071 :
2072 : /* does not extend to right of? */
2073 : bool
2074 74998 : range_overleft_multirange_internal(TypeCacheEntry *rangetyp,
2075 : const RangeType *r,
2076 : const MultirangeType *mr)
2077 : {
2078 : RangeBound lower1,
2079 : upper1,
2080 : lower2,
2081 : upper2;
2082 : bool empty;
2083 :
2084 74998 : if (RangeIsEmpty(r) || MultirangeIsEmpty(mr))
2085 6012 : PG_RETURN_BOOL(false);
2086 :
2087 :
2088 68986 : range_deserialize(rangetyp, r, &lower1, &upper1, &empty);
2089 : Assert(!empty);
2090 68986 : multirange_get_bounds(rangetyp, mr, mr->rangeCount - 1,
2091 : &lower2, &upper2);
2092 :
2093 68986 : PG_RETURN_BOOL(range_cmp_bounds(rangetyp, &upper1, &upper2) <= 0);
2094 : }
2095 :
2096 : Datum
2097 37242 : range_overleft_multirange(PG_FUNCTION_ARGS)
2098 : {
2099 37242 : RangeType *r = PG_GETARG_RANGE_P(0);
2100 37242 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
2101 : TypeCacheEntry *typcache;
2102 :
2103 37242 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2104 :
2105 37242 : PG_RETURN_BOOL(range_overleft_multirange_internal(typcache->rngtype, r, mr));
2106 : }
2107 :
2108 : Datum
2109 47286 : multirange_overleft_range(PG_FUNCTION_ARGS)
2110 : {
2111 47286 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2112 47286 : RangeType *r = PG_GETARG_RANGE_P(1);
2113 : TypeCacheEntry *typcache;
2114 : RangeBound lower1,
2115 : upper1,
2116 : lower2,
2117 : upper2;
2118 : bool empty;
2119 :
2120 47286 : if (MultirangeIsEmpty(mr) || RangeIsEmpty(r))
2121 25212 : PG_RETURN_BOOL(false);
2122 :
2123 22074 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2124 :
2125 22074 : multirange_get_bounds(typcache->rngtype, mr, mr->rangeCount - 1,
2126 : &lower1, &upper1);
2127 22074 : range_deserialize(typcache->rngtype, r, &lower2, &upper2, &empty);
2128 : Assert(!empty);
2129 :
2130 22074 : PG_RETURN_BOOL(range_cmp_bounds(typcache->rngtype, &upper1, &upper2) <= 0);
2131 : }
2132 :
2133 : Datum
2134 47292 : multirange_overleft_multirange(PG_FUNCTION_ARGS)
2135 : {
2136 47292 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2137 47292 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2138 : TypeCacheEntry *typcache;
2139 : RangeBound lower1,
2140 : upper1,
2141 : lower2,
2142 : upper2;
2143 :
2144 47292 : if (MultirangeIsEmpty(mr1) || MultirangeIsEmpty(mr2))
2145 25218 : PG_RETURN_BOOL(false);
2146 :
2147 22074 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2148 :
2149 22074 : multirange_get_bounds(typcache->rngtype, mr1, mr1->rangeCount - 1,
2150 : &lower1, &upper1);
2151 22074 : multirange_get_bounds(typcache->rngtype, mr2, mr2->rangeCount - 1,
2152 : &lower2, &upper2);
2153 :
2154 22074 : PG_RETURN_BOOL(range_cmp_bounds(typcache->rngtype, &upper1, &upper2) <= 0);
2155 : }
2156 :
2157 : /* does not extend to left of? */
2158 : bool
2159 119340 : range_overright_multirange_internal(TypeCacheEntry *rangetyp,
2160 : const RangeType *r,
2161 : const MultirangeType *mr)
2162 : {
2163 : RangeBound lower1,
2164 : upper1,
2165 : lower2,
2166 : upper2;
2167 : bool empty;
2168 :
2169 119340 : if (RangeIsEmpty(r) || MultirangeIsEmpty(mr))
2170 6012 : PG_RETURN_BOOL(false);
2171 :
2172 113328 : range_deserialize(rangetyp, r, &lower1, &upper1, &empty);
2173 : Assert(!empty);
2174 113328 : multirange_get_bounds(rangetyp, mr, 0, &lower2, &upper2);
2175 :
2176 113328 : return (range_cmp_bounds(rangetyp, &lower1, &lower2) >= 0);
2177 : }
2178 :
2179 : Datum
2180 37242 : range_overright_multirange(PG_FUNCTION_ARGS)
2181 : {
2182 37242 : RangeType *r = PG_GETARG_RANGE_P(0);
2183 37242 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
2184 : TypeCacheEntry *typcache;
2185 :
2186 37242 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2187 :
2188 37242 : PG_RETURN_BOOL(range_overright_multirange_internal(typcache->rngtype, r, mr));
2189 : }
2190 :
2191 : Datum
2192 61800 : multirange_overright_range(PG_FUNCTION_ARGS)
2193 : {
2194 61800 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2195 61800 : RangeType *r = PG_GETARG_RANGE_P(1);
2196 : TypeCacheEntry *typcache;
2197 : RangeBound lower1,
2198 : upper1,
2199 : lower2,
2200 : upper2;
2201 : bool empty;
2202 :
2203 61800 : if (MultirangeIsEmpty(mr) || RangeIsEmpty(r))
2204 25212 : PG_RETURN_BOOL(false);
2205 :
2206 36588 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2207 :
2208 36588 : multirange_get_bounds(typcache->rngtype, mr, 0, &lower1, &upper1);
2209 36588 : range_deserialize(typcache->rngtype, r, &lower2, &upper2, &empty);
2210 : Assert(!empty);
2211 :
2212 36588 : PG_RETURN_BOOL(range_cmp_bounds(typcache->rngtype, &lower1, &lower2) >= 0);
2213 : }
2214 :
2215 : Datum
2216 61806 : multirange_overright_multirange(PG_FUNCTION_ARGS)
2217 : {
2218 61806 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2219 61806 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2220 : TypeCacheEntry *typcache;
2221 : RangeBound lower1,
2222 : upper1,
2223 : lower2,
2224 : upper2;
2225 :
2226 61806 : if (MultirangeIsEmpty(mr1) || MultirangeIsEmpty(mr2))
2227 25218 : PG_RETURN_BOOL(false);
2228 :
2229 36588 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2230 :
2231 36588 : multirange_get_bounds(typcache->rngtype, mr1, 0, &lower1, &upper1);
2232 36588 : multirange_get_bounds(typcache->rngtype, mr2, 0, &lower2, &upper2);
2233 :
2234 36588 : PG_RETURN_BOOL(range_cmp_bounds(typcache->rngtype, &lower1, &lower2) >= 0);
2235 : }
2236 :
2237 : /* contains? */
2238 : Datum
2239 156312 : multirange_contains_multirange(PG_FUNCTION_ARGS)
2240 : {
2241 156312 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2242 156312 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2243 : TypeCacheEntry *typcache;
2244 :
2245 156312 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2246 :
2247 156312 : PG_RETURN_BOOL(multirange_contains_multirange_internal(typcache->rngtype, mr1, mr2));
2248 : }
2249 :
2250 : /* contained by? */
2251 : Datum
2252 50598 : multirange_contained_by_multirange(PG_FUNCTION_ARGS)
2253 : {
2254 50598 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2255 50598 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2256 : TypeCacheEntry *typcache;
2257 :
2258 50598 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2259 :
2260 50598 : PG_RETURN_BOOL(multirange_contains_multirange_internal(typcache->rngtype, mr2, mr1));
2261 : }
2262 :
2263 : /*
2264 : * Test whether multirange mr1 contains every range from another multirange mr2.
2265 : */
2266 : bool
2267 206910 : multirange_contains_multirange_internal(TypeCacheEntry *rangetyp,
2268 : const MultirangeType *mr1,
2269 : const MultirangeType *mr2)
2270 : {
2271 206910 : int32 range_count1 = mr1->rangeCount;
2272 206910 : int32 range_count2 = mr2->rangeCount;
2273 : int i1,
2274 : i2;
2275 : RangeBound lower1,
2276 : upper1,
2277 : lower2,
2278 : upper2;
2279 :
2280 : /*
2281 : * We follow the same logic for empties as ranges: - an empty multirange
2282 : * contains an empty range/multirange. - an empty multirange can't contain
2283 : * any other range/multirange. - an empty multirange is contained by any
2284 : * other range/multirange.
2285 : */
2286 :
2287 206910 : if (range_count2 == 0)
2288 145212 : return true;
2289 61698 : if (range_count1 == 0)
2290 22296 : return false;
2291 :
2292 : /*
2293 : * Every range in mr2 must be contained by some range in mr1. To avoid
2294 : * O(n^2) we walk through both ranges in tandem.
2295 : */
2296 39402 : i1 = 0;
2297 39402 : multirange_get_bounds(rangetyp, mr1, i1, &lower1, &upper1);
2298 42516 : for (i2 = 0; i2 < range_count2; i2++)
2299 : {
2300 41040 : multirange_get_bounds(rangetyp, mr2, i2, &lower2, &upper2);
2301 :
2302 : /* Discard r1s while r1 << r2 */
2303 77334 : while (range_cmp_bounds(rangetyp, &upper1, &lower2) < 0)
2304 : {
2305 53940 : if (++i1 >= range_count1)
2306 17646 : return false;
2307 36294 : multirange_get_bounds(rangetyp, mr1, i1, &lower1, &upper1);
2308 : }
2309 :
2310 : /*
2311 : * If r1 @> r2, go to the next r2, otherwise return false (since every
2312 : * r1[n] and r1[n+1] must have a gap). Note this will give weird
2313 : * answers if you don't canonicalize, e.g. with a custom
2314 : * int2multirange {[1,1], [2,2]} there is a "gap". But that is
2315 : * consistent with other range operators, e.g. '[1,1]'::int2range -|-
2316 : * '[2,2]'::int2range is false.
2317 : */
2318 23394 : if (!range_bounds_contains(rangetyp, &lower1, &upper1,
2319 : &lower2, &upper2))
2320 20280 : return false;
2321 : }
2322 :
2323 : /* All ranges in mr2 are satisfied */
2324 1476 : return true;
2325 : }
2326 :
2327 : /* strictly left of? */
2328 : Datum
2329 37230 : range_before_multirange(PG_FUNCTION_ARGS)
2330 : {
2331 37230 : RangeType *r = PG_GETARG_RANGE_P(0);
2332 37230 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
2333 : TypeCacheEntry *typcache;
2334 :
2335 37230 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2336 :
2337 37230 : PG_RETURN_BOOL(range_before_multirange_internal(typcache->rngtype, r, mr));
2338 : }
2339 :
2340 : Datum
2341 44760 : multirange_before_range(PG_FUNCTION_ARGS)
2342 : {
2343 44760 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2344 44760 : RangeType *r = PG_GETARG_RANGE_P(1);
2345 : TypeCacheEntry *typcache;
2346 :
2347 44760 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2348 :
2349 44760 : PG_RETURN_BOOL(range_after_multirange_internal(typcache->rngtype, r, mr));
2350 : }
2351 :
2352 : Datum
2353 44766 : multirange_before_multirange(PG_FUNCTION_ARGS)
2354 : {
2355 44766 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2356 44766 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2357 : TypeCacheEntry *typcache;
2358 :
2359 44766 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2360 :
2361 44766 : PG_RETURN_BOOL(multirange_before_multirange_internal(typcache->rngtype, mr1, mr2));
2362 : }
2363 :
2364 : /* strictly right of? */
2365 : Datum
2366 37236 : range_after_multirange(PG_FUNCTION_ARGS)
2367 : {
2368 37236 : RangeType *r = PG_GETARG_RANGE_P(0);
2369 37236 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
2370 : TypeCacheEntry *typcache;
2371 :
2372 37236 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2373 :
2374 37236 : PG_RETURN_BOOL(range_after_multirange_internal(typcache->rngtype, r, mr));
2375 : }
2376 :
2377 : Datum
2378 56748 : multirange_after_range(PG_FUNCTION_ARGS)
2379 : {
2380 56748 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2381 56748 : RangeType *r = PG_GETARG_RANGE_P(1);
2382 : TypeCacheEntry *typcache;
2383 :
2384 56748 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2385 :
2386 56748 : PG_RETURN_BOOL(range_before_multirange_internal(typcache->rngtype, r, mr));
2387 : }
2388 :
2389 : Datum
2390 56760 : multirange_after_multirange(PG_FUNCTION_ARGS)
2391 : {
2392 56760 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2393 56760 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2394 : TypeCacheEntry *typcache;
2395 :
2396 56760 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2397 :
2398 56760 : PG_RETURN_BOOL(multirange_before_multirange_internal(typcache->rngtype, mr2, mr1));
2399 : }
2400 :
2401 : /* strictly left of? (internal version) */
2402 : bool
2403 112160 : range_before_multirange_internal(TypeCacheEntry *rangetyp,
2404 : const RangeType *r,
2405 : const MultirangeType *mr)
2406 : {
2407 : RangeBound lower1,
2408 : upper1,
2409 : lower2,
2410 : upper2;
2411 : bool empty;
2412 :
2413 112160 : if (RangeIsEmpty(r) || MultirangeIsEmpty(mr))
2414 31224 : return false;
2415 :
2416 80936 : range_deserialize(rangetyp, r, &lower1, &upper1, &empty);
2417 : Assert(!empty);
2418 :
2419 80936 : multirange_get_bounds(rangetyp, mr, 0, &lower2, &upper2);
2420 :
2421 80936 : return (range_cmp_bounds(rangetyp, &upper1, &lower2) < 0);
2422 : }
2423 :
2424 : bool
2425 101526 : multirange_before_multirange_internal(TypeCacheEntry *rangetyp,
2426 : const MultirangeType *mr1,
2427 : const MultirangeType *mr2)
2428 : {
2429 : RangeBound lower1,
2430 : upper1,
2431 : lower2,
2432 : upper2;
2433 :
2434 101526 : if (MultirangeIsEmpty(mr1) || MultirangeIsEmpty(mr2))
2435 50436 : return false;
2436 :
2437 51090 : multirange_get_bounds(rangetyp, mr1, mr1->rangeCount - 1,
2438 : &lower1, &upper1);
2439 51090 : multirange_get_bounds(rangetyp, mr2, 0,
2440 : &lower2, &upper2);
2441 :
2442 51090 : return (range_cmp_bounds(rangetyp, &upper1, &lower2) < 0);
2443 : }
2444 :
2445 : /* strictly right of? (internal version) */
2446 : bool
2447 155336 : range_after_multirange_internal(TypeCacheEntry *rangetyp,
2448 : const RangeType *r,
2449 : const MultirangeType *mr)
2450 : {
2451 : RangeBound lower1,
2452 : upper1,
2453 : lower2,
2454 : upper2;
2455 : bool empty;
2456 : int32 range_count;
2457 :
2458 155336 : if (RangeIsEmpty(r) || MultirangeIsEmpty(mr))
2459 31224 : return false;
2460 :
2461 124112 : range_deserialize(rangetyp, r, &lower1, &upper1, &empty);
2462 : Assert(!empty);
2463 :
2464 124112 : range_count = mr->rangeCount;
2465 124112 : multirange_get_bounds(rangetyp, mr, range_count - 1,
2466 : &lower2, &upper2);
2467 :
2468 124112 : return (range_cmp_bounds(rangetyp, &lower1, &upper2) > 0);
2469 : }
2470 :
2471 : bool
2472 94210 : range_adjacent_multirange_internal(TypeCacheEntry *rangetyp,
2473 : const RangeType *r,
2474 : const MultirangeType *mr)
2475 : {
2476 : RangeBound lower1,
2477 : upper1,
2478 : lower2,
2479 : upper2;
2480 : bool empty;
2481 : int32 range_count;
2482 :
2483 94210 : if (RangeIsEmpty(r) || MultirangeIsEmpty(mr))
2484 6012 : return false;
2485 :
2486 88198 : range_deserialize(rangetyp, r, &lower1, &upper1, &empty);
2487 : Assert(!empty);
2488 :
2489 88198 : range_count = mr->rangeCount;
2490 88198 : multirange_get_bounds(rangetyp, mr, 0,
2491 : &lower2, &upper2);
2492 :
2493 88198 : if (bounds_adjacent(rangetyp, upper1, lower2))
2494 72 : return true;
2495 :
2496 88126 : if (range_count > 1)
2497 80914 : multirange_get_bounds(rangetyp, mr, range_count - 1,
2498 : &lower2, &upper2);
2499 :
2500 88126 : if (bounds_adjacent(rangetyp, upper2, lower1))
2501 84 : return true;
2502 :
2503 88042 : return false;
2504 : }
2505 :
2506 : /* adjacent to? */
2507 : Datum
2508 37224 : range_adjacent_multirange(PG_FUNCTION_ARGS)
2509 : {
2510 37224 : RangeType *r = PG_GETARG_RANGE_P(0);
2511 37224 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(1);
2512 : TypeCacheEntry *typcache;
2513 :
2514 37224 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2515 :
2516 37224 : PG_RETURN_BOOL(range_adjacent_multirange_internal(typcache->rngtype, r, mr));
2517 : }
2518 :
2519 : Datum
2520 44442 : multirange_adjacent_range(PG_FUNCTION_ARGS)
2521 : {
2522 44442 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2523 44442 : RangeType *r = PG_GETARG_RANGE_P(1);
2524 : TypeCacheEntry *typcache;
2525 :
2526 44442 : if (RangeIsEmpty(r) || MultirangeIsEmpty(mr))
2527 25212 : return false;
2528 :
2529 19230 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2530 :
2531 19230 : PG_RETURN_BOOL(range_adjacent_multirange_internal(typcache->rngtype, r, mr));
2532 : }
2533 :
2534 : Datum
2535 44472 : multirange_adjacent_multirange(PG_FUNCTION_ARGS)
2536 : {
2537 44472 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2538 44472 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2539 : TypeCacheEntry *typcache;
2540 : int32 range_count1;
2541 : int32 range_count2;
2542 : RangeBound lower1,
2543 : upper1,
2544 : lower2,
2545 : upper2;
2546 :
2547 44472 : if (MultirangeIsEmpty(mr1) || MultirangeIsEmpty(mr2))
2548 25218 : return false;
2549 :
2550 19254 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2551 :
2552 19254 : range_count1 = mr1->rangeCount;
2553 19254 : range_count2 = mr2->rangeCount;
2554 19254 : multirange_get_bounds(typcache->rngtype, mr1, range_count1 - 1,
2555 : &lower1, &upper1);
2556 19254 : multirange_get_bounds(typcache->rngtype, mr2, 0,
2557 : &lower2, &upper2);
2558 19254 : if (bounds_adjacent(typcache->rngtype, upper1, lower2))
2559 30 : PG_RETURN_BOOL(true);
2560 :
2561 19224 : if (range_count1 > 1)
2562 12012 : multirange_get_bounds(typcache->rngtype, mr1, 0,
2563 : &lower1, &upper1);
2564 19224 : if (range_count2 > 1)
2565 19206 : multirange_get_bounds(typcache->rngtype, mr2, range_count2 - 1,
2566 : &lower2, &upper2);
2567 19224 : if (bounds_adjacent(typcache->rngtype, upper2, lower1))
2568 24 : PG_RETURN_BOOL(true);
2569 19200 : PG_RETURN_BOOL(false);
2570 : }
2571 :
2572 : /* Btree support */
2573 :
2574 : /* btree comparator */
2575 : Datum
2576 804 : multirange_cmp(PG_FUNCTION_ARGS)
2577 : {
2578 804 : MultirangeType *mr1 = PG_GETARG_MULTIRANGE_P(0);
2579 804 : MultirangeType *mr2 = PG_GETARG_MULTIRANGE_P(1);
2580 : int32 range_count_1;
2581 : int32 range_count_2;
2582 : int32 range_count_max;
2583 : int32 i;
2584 : TypeCacheEntry *typcache;
2585 804 : int cmp = 0; /* If both are empty we'll use this. */
2586 :
2587 : /* Different types should be prevented by ANYMULTIRANGE matching rules */
2588 804 : if (MultirangeTypeGetOid(mr1) != MultirangeTypeGetOid(mr2))
2589 0 : elog(ERROR, "multirange types do not match");
2590 :
2591 804 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr1));
2592 :
2593 804 : range_count_1 = mr1->rangeCount;
2594 804 : range_count_2 = mr2->rangeCount;
2595 :
2596 : /* Loop over source data */
2597 804 : range_count_max = Max(range_count_1, range_count_2);
2598 858 : for (i = 0; i < range_count_max; i++)
2599 : {
2600 : RangeBound lower1,
2601 : upper1,
2602 : lower2,
2603 : upper2;
2604 :
2605 : /*
2606 : * If one multirange is shorter, it's as if it had empty ranges at the
2607 : * end to extend its length. An empty range compares earlier than any
2608 : * other range, so the shorter multirange comes before the longer.
2609 : * This is the same behavior as in other types, e.g. in strings 'aaa'
2610 : * < 'aaaaaa'.
2611 : */
2612 702 : if (i >= range_count_1)
2613 : {
2614 120 : cmp = -1;
2615 648 : break;
2616 : }
2617 582 : if (i >= range_count_2)
2618 : {
2619 138 : cmp = 1;
2620 138 : break;
2621 : }
2622 :
2623 444 : multirange_get_bounds(typcache->rngtype, mr1, i, &lower1, &upper1);
2624 444 : multirange_get_bounds(typcache->rngtype, mr2, i, &lower2, &upper2);
2625 :
2626 444 : cmp = range_cmp_bounds(typcache->rngtype, &lower1, &lower2);
2627 444 : if (cmp == 0)
2628 78 : cmp = range_cmp_bounds(typcache->rngtype, &upper1, &upper2);
2629 444 : if (cmp != 0)
2630 390 : break;
2631 : }
2632 :
2633 804 : PG_FREE_IF_COPY(mr1, 0);
2634 804 : PG_FREE_IF_COPY(mr2, 1);
2635 :
2636 804 : PG_RETURN_INT32(cmp);
2637 : }
2638 :
2639 : /* inequality operators using the multirange_cmp function */
2640 : Datum
2641 168 : multirange_lt(PG_FUNCTION_ARGS)
2642 : {
2643 168 : int cmp = multirange_cmp(fcinfo);
2644 :
2645 168 : PG_RETURN_BOOL(cmp < 0);
2646 : }
2647 :
2648 : Datum
2649 96 : multirange_le(PG_FUNCTION_ARGS)
2650 : {
2651 96 : int cmp = multirange_cmp(fcinfo);
2652 :
2653 96 : PG_RETURN_BOOL(cmp <= 0);
2654 : }
2655 :
2656 : Datum
2657 72 : multirange_ge(PG_FUNCTION_ARGS)
2658 : {
2659 72 : int cmp = multirange_cmp(fcinfo);
2660 :
2661 72 : PG_RETURN_BOOL(cmp >= 0);
2662 : }
2663 :
2664 : Datum
2665 114 : multirange_gt(PG_FUNCTION_ARGS)
2666 : {
2667 114 : int cmp = multirange_cmp(fcinfo);
2668 :
2669 114 : PG_RETURN_BOOL(cmp > 0);
2670 : }
2671 :
2672 : /* multirange -> range functions */
2673 :
2674 : /* Find the smallest range that includes everything in the multirange */
2675 : Datum
2676 36 : range_merge_from_multirange(PG_FUNCTION_ARGS)
2677 : {
2678 36 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2679 36 : Oid mltrngtypoid = MultirangeTypeGetOid(mr);
2680 : TypeCacheEntry *typcache;
2681 : RangeType *result;
2682 :
2683 36 : typcache = multirange_get_typcache(fcinfo, mltrngtypoid);
2684 :
2685 36 : if (MultirangeIsEmpty(mr))
2686 : {
2687 6 : result = make_empty_range(typcache->rngtype);
2688 : }
2689 30 : else if (mr->rangeCount == 1)
2690 : {
2691 12 : result = multirange_get_range(typcache->rngtype, mr, 0);
2692 : }
2693 : else
2694 : {
2695 : RangeBound firstLower,
2696 : firstUpper,
2697 : lastLower,
2698 : lastUpper;
2699 :
2700 18 : multirange_get_bounds(typcache->rngtype, mr, 0,
2701 : &firstLower, &firstUpper);
2702 18 : multirange_get_bounds(typcache->rngtype, mr, mr->rangeCount - 1,
2703 : &lastLower, &lastUpper);
2704 :
2705 18 : result = make_range(typcache->rngtype, &firstLower, &lastUpper,
2706 : false, NULL);
2707 : }
2708 :
2709 36 : PG_RETURN_RANGE_P(result);
2710 : }
2711 :
2712 : /* Turn multirange into a set of ranges */
2713 : Datum
2714 72 : multirange_unnest(PG_FUNCTION_ARGS)
2715 : {
2716 : typedef struct
2717 : {
2718 : MultirangeType *mr;
2719 : TypeCacheEntry *typcache;
2720 : int index;
2721 : } multirange_unnest_fctx;
2722 :
2723 : FuncCallContext *funcctx;
2724 : multirange_unnest_fctx *fctx;
2725 : MemoryContext oldcontext;
2726 :
2727 : /* stuff done only on the first call of the function */
2728 72 : if (SRF_IS_FIRSTCALL())
2729 : {
2730 : MultirangeType *mr;
2731 :
2732 : /* create a function context for cross-call persistence */
2733 24 : funcctx = SRF_FIRSTCALL_INIT();
2734 :
2735 : /*
2736 : * switch to memory context appropriate for multiple function calls
2737 : */
2738 24 : oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
2739 :
2740 : /*
2741 : * Get the multirange value and detoast if needed. We can't do this
2742 : * earlier because if we have to detoast, we want the detoasted copy
2743 : * to be in multi_call_memory_ctx, so it will go away when we're done
2744 : * and not before. (If no detoast happens, we assume the originally
2745 : * passed multirange will stick around till then.)
2746 : */
2747 24 : mr = PG_GETARG_MULTIRANGE_P(0);
2748 :
2749 : /* allocate memory for user context */
2750 24 : fctx = (multirange_unnest_fctx *) palloc(sizeof(multirange_unnest_fctx));
2751 :
2752 : /* initialize state */
2753 24 : fctx->mr = mr;
2754 24 : fctx->index = 0;
2755 24 : fctx->typcache = lookup_type_cache(MultirangeTypeGetOid(mr),
2756 : TYPECACHE_MULTIRANGE_INFO);
2757 :
2758 24 : funcctx->user_fctx = fctx;
2759 24 : MemoryContextSwitchTo(oldcontext);
2760 : }
2761 :
2762 : /* stuff done on every call of the function */
2763 72 : funcctx = SRF_PERCALL_SETUP();
2764 72 : fctx = funcctx->user_fctx;
2765 :
2766 72 : if (fctx->index < fctx->mr->rangeCount)
2767 : {
2768 : RangeType *range;
2769 :
2770 48 : range = multirange_get_range(fctx->typcache->rngtype,
2771 48 : fctx->mr,
2772 : fctx->index);
2773 48 : fctx->index++;
2774 :
2775 48 : SRF_RETURN_NEXT(funcctx, RangeTypePGetDatum(range));
2776 : }
2777 : else
2778 : {
2779 : /* do when there is no more left */
2780 24 : SRF_RETURN_DONE(funcctx);
2781 : }
2782 : }
2783 :
2784 : /* Hash support */
2785 :
2786 : /* hash a multirange value */
2787 : Datum
2788 306 : hash_multirange(PG_FUNCTION_ARGS)
2789 : {
2790 306 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2791 306 : uint32 result = 1;
2792 : TypeCacheEntry *typcache,
2793 : *scache;
2794 : int32 range_count,
2795 : i;
2796 :
2797 306 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2798 306 : scache = typcache->rngtype->rngelemtype;
2799 306 : if (!OidIsValid(scache->hash_proc_finfo.fn_oid))
2800 : {
2801 6 : scache = lookup_type_cache(scache->type_id,
2802 : TYPECACHE_HASH_PROC_FINFO);
2803 6 : if (!OidIsValid(scache->hash_proc_finfo.fn_oid))
2804 0 : ereport(ERROR,
2805 : (errcode(ERRCODE_UNDEFINED_FUNCTION),
2806 : errmsg("could not identify a hash function for type %s",
2807 : format_type_be(scache->type_id))));
2808 : }
2809 :
2810 306 : range_count = mr->rangeCount;
2811 546 : for (i = 0; i < range_count; i++)
2812 : {
2813 : RangeBound lower,
2814 : upper;
2815 240 : uint8 flags = MultirangeGetFlagsPtr(mr)[i];
2816 : uint32 lower_hash;
2817 : uint32 upper_hash;
2818 : uint32 range_hash;
2819 :
2820 240 : multirange_get_bounds(typcache->rngtype, mr, i, &lower, &upper);
2821 :
2822 240 : if (RANGE_HAS_LBOUND(flags))
2823 180 : lower_hash = DatumGetUInt32(FunctionCall1Coll(&scache->hash_proc_finfo,
2824 180 : typcache->rngtype->rng_collation,
2825 : lower.val));
2826 : else
2827 60 : lower_hash = 0;
2828 :
2829 240 : if (RANGE_HAS_UBOUND(flags))
2830 186 : upper_hash = DatumGetUInt32(FunctionCall1Coll(&scache->hash_proc_finfo,
2831 186 : typcache->rngtype->rng_collation,
2832 : upper.val));
2833 : else
2834 54 : upper_hash = 0;
2835 :
2836 : /* Merge hashes of flags and bounds */
2837 240 : range_hash = hash_uint32((uint32) flags);
2838 240 : range_hash ^= lower_hash;
2839 240 : range_hash = pg_rotate_left32(range_hash, 1);
2840 240 : range_hash ^= upper_hash;
2841 :
2842 : /*
2843 : * Use the same approach as hash_array to combine the individual
2844 : * elements' hash values:
2845 : */
2846 240 : result = (result << 5) - result + range_hash;
2847 : }
2848 :
2849 306 : PG_FREE_IF_COPY(mr, 0);
2850 :
2851 306 : PG_RETURN_UINT32(result);
2852 : }
2853 :
2854 : /*
2855 : * Returns 64-bit value by hashing a value to a 64-bit value, with a seed.
2856 : * Otherwise, similar to hash_multirange.
2857 : */
2858 : Datum
2859 60 : hash_multirange_extended(PG_FUNCTION_ARGS)
2860 : {
2861 60 : MultirangeType *mr = PG_GETARG_MULTIRANGE_P(0);
2862 60 : Datum seed = PG_GETARG_DATUM(1);
2863 60 : uint64 result = 1;
2864 : TypeCacheEntry *typcache,
2865 : *scache;
2866 : int32 range_count,
2867 : i;
2868 :
2869 60 : typcache = multirange_get_typcache(fcinfo, MultirangeTypeGetOid(mr));
2870 60 : scache = typcache->rngtype->rngelemtype;
2871 60 : if (!OidIsValid(scache->hash_extended_proc_finfo.fn_oid))
2872 : {
2873 0 : scache = lookup_type_cache(scache->type_id,
2874 : TYPECACHE_HASH_EXTENDED_PROC_FINFO);
2875 0 : if (!OidIsValid(scache->hash_extended_proc_finfo.fn_oid))
2876 0 : ereport(ERROR,
2877 : (errcode(ERRCODE_UNDEFINED_FUNCTION),
2878 : errmsg("could not identify a hash function for type %s",
2879 : format_type_be(scache->type_id))));
2880 : }
2881 :
2882 60 : range_count = mr->rangeCount;
2883 120 : for (i = 0; i < range_count; i++)
2884 : {
2885 : RangeBound lower,
2886 : upper;
2887 60 : uint8 flags = MultirangeGetFlagsPtr(mr)[i];
2888 : uint64 lower_hash;
2889 : uint64 upper_hash;
2890 : uint64 range_hash;
2891 :
2892 60 : multirange_get_bounds(typcache->rngtype, mr, i, &lower, &upper);
2893 :
2894 60 : if (RANGE_HAS_LBOUND(flags))
2895 60 : lower_hash = DatumGetUInt64(FunctionCall2Coll(&scache->hash_extended_proc_finfo,
2896 60 : typcache->rngtype->rng_collation,
2897 : lower.val,
2898 : seed));
2899 : else
2900 0 : lower_hash = 0;
2901 :
2902 60 : if (RANGE_HAS_UBOUND(flags))
2903 60 : upper_hash = DatumGetUInt64(FunctionCall2Coll(&scache->hash_extended_proc_finfo,
2904 60 : typcache->rngtype->rng_collation,
2905 : upper.val,
2906 : seed));
2907 : else
2908 0 : upper_hash = 0;
2909 :
2910 : /* Merge hashes of flags and bounds */
2911 60 : range_hash = DatumGetUInt64(hash_uint32_extended((uint32) flags,
2912 60 : DatumGetInt64(seed)));
2913 60 : range_hash ^= lower_hash;
2914 60 : range_hash = ROTATE_HIGH_AND_LOW_32BITS(range_hash);
2915 60 : range_hash ^= upper_hash;
2916 :
2917 : /*
2918 : * Use the same approach as hash_array to combine the individual
2919 : * elements' hash values:
2920 : */
2921 60 : result = (result << 5) - result + range_hash;
2922 : }
2923 :
2924 60 : PG_FREE_IF_COPY(mr, 0);
2925 :
2926 60 : PG_RETURN_UINT64(result);
2927 : }
|
