Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * spgscan.c
4 : * routines for scanning SP-GiST indexes
5 : *
6 : *
7 : * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
8 : * Portions Copyright (c) 1994, Regents of the University of California
9 : *
10 : * IDENTIFICATION
11 : * src/backend/access/spgist/spgscan.c
12 : *
13 : *-------------------------------------------------------------------------
14 : */
15 :
16 : #include "postgres.h"
17 :
18 : #include "access/genam.h"
19 : #include "access/relscan.h"
20 : #include "access/spgist_private.h"
21 : #include "miscadmin.h"
22 : #include "pgstat.h"
23 : #include "storage/bufmgr.h"
24 : #include "utils/datum.h"
25 : #include "utils/float.h"
26 : #include "utils/lsyscache.h"
27 : #include "utils/memutils.h"
28 : #include "utils/rel.h"
29 :
30 : typedef void (*storeRes_func) (SpGistScanOpaque so, ItemPointer heapPtr,
31 : Datum leafValue, bool isNull,
32 : SpGistLeafTuple leafTuple, bool recheck,
33 : bool recheckDistances, double *distances);
34 :
35 : /*
36 : * Pairing heap comparison function for the SpGistSearchItem queue.
37 : * KNN-searches currently only support NULLS LAST. So, preserve this logic
38 : * here.
39 : */
40 : static int
41 4391592 : pairingheap_SpGistSearchItem_cmp(const pairingheap_node *a,
42 : const pairingheap_node *b, void *arg)
43 : {
44 4391592 : const SpGistSearchItem *sa = (const SpGistSearchItem *) a;
45 4391592 : const SpGistSearchItem *sb = (const SpGistSearchItem *) b;
46 4391592 : SpGistScanOpaque so = (SpGistScanOpaque) arg;
47 : int i;
48 :
49 4391592 : if (sa->isNull)
50 : {
51 560 : if (!sb->isNull)
52 518 : return -1;
53 : }
54 4391032 : else if (sb->isNull)
55 : {
56 478 : return 1;
57 : }
58 : else
59 : {
60 : /* Order according to distance comparison */
61 4628250 : for (i = 0; i < so->numberOfNonNullOrderBys; i++)
62 : {
63 4031938 : if (isnan(sa->distances[i]) && isnan(sb->distances[i]))
64 0 : continue; /* NaN == NaN */
65 4031938 : if (isnan(sa->distances[i]))
66 0 : return -1; /* NaN > number */
67 4031938 : if (isnan(sb->distances[i]))
68 0 : return 1; /* number < NaN */
69 4031938 : if (sa->distances[i] != sb->distances[i])
70 3794242 : return (sa->distances[i] < sb->distances[i]) ? 1 : -1;
71 : }
72 : }
73 :
74 : /* Leaf items go before inner pages, to ensure a depth-first search */
75 596354 : if (sa->isLeaf && !sb->isLeaf)
76 4222 : return 1;
77 592132 : if (!sa->isLeaf && sb->isLeaf)
78 4768 : return -1;
79 :
80 587364 : return 0;
81 : }
82 :
83 : static void
84 458272 : spgFreeSearchItem(SpGistScanOpaque so, SpGistSearchItem *item)
85 : {
86 : /* value is of type attType if isLeaf, else of type attLeafType */
87 : /* (no, that is not backwards; yes, it's confusing) */
88 458272 : if (!(item->isLeaf ? so->state.attType.attbyval :
89 916544 : so->state.attLeafType.attbyval) &&
90 458272 : DatumGetPointer(item->value) != NULL)
91 289098 : pfree(DatumGetPointer(item->value));
92 :
93 458272 : if (item->leafTuple)
94 60 : pfree(item->leafTuple);
95 :
96 458272 : if (item->traversalValue)
97 44372 : pfree(item->traversalValue);
98 :
99 458272 : pfree(item);
100 458272 : }
101 :
102 : /*
103 : * Add SpGistSearchItem to queue
104 : *
105 : * Called in queue context
106 : */
107 : static void
108 461052 : spgAddSearchItemToQueue(SpGistScanOpaque so, SpGistSearchItem *item)
109 : {
110 461052 : pairingheap_add(so->scanQueue, &item->phNode);
111 461052 : }
112 :
113 : static SpGistSearchItem *
114 461052 : spgAllocSearchItem(SpGistScanOpaque so, bool isnull, double *distances)
115 : {
116 : /* allocate distance array only for non-NULL items */
117 : SpGistSearchItem *item =
118 461052 : palloc(SizeOfSpGistSearchItem(isnull ? 0 : so->numberOfNonNullOrderBys));
119 :
120 461052 : item->isNull = isnull;
121 :
122 461052 : if (!isnull && so->numberOfNonNullOrderBys > 0)
123 377922 : memcpy(item->distances, distances,
124 377922 : sizeof(item->distances[0]) * so->numberOfNonNullOrderBys);
125 :
126 461052 : return item;
127 : }
128 :
129 : static void
130 982 : spgAddStartItem(SpGistScanOpaque so, bool isnull)
131 : {
132 : SpGistSearchItem *startEntry =
133 982 : spgAllocSearchItem(so, isnull, so->zeroDistances);
134 :
135 982 : ItemPointerSet(&startEntry->heapPtr,
136 : isnull ? SPGIST_NULL_BLKNO : SPGIST_ROOT_BLKNO,
137 : FirstOffsetNumber);
138 982 : startEntry->isLeaf = false;
139 982 : startEntry->level = 0;
140 982 : startEntry->value = (Datum) 0;
141 982 : startEntry->leafTuple = NULL;
142 982 : startEntry->traversalValue = NULL;
143 982 : startEntry->recheck = false;
144 982 : startEntry->recheckDistances = false;
145 :
146 982 : spgAddSearchItemToQueue(so, startEntry);
147 982 : }
148 :
149 : /*
150 : * Initialize queue to search the root page, resetting
151 : * any previously active scan
152 : */
153 : static void
154 928 : resetSpGistScanOpaque(SpGistScanOpaque so)
155 : {
156 : MemoryContext oldCtx;
157 :
158 928 : MemoryContextReset(so->traversalCxt);
159 :
160 928 : oldCtx = MemoryContextSwitchTo(so->traversalCxt);
161 :
162 : /* initialize queue only for distance-ordered scans */
163 928 : so->scanQueue = pairingheap_allocate(pairingheap_SpGistSearchItem_cmp, so);
164 :
165 928 : if (so->searchNulls)
166 : /* Add a work item to scan the null index entries */
167 66 : spgAddStartItem(so, true);
168 :
169 928 : if (so->searchNonNulls)
170 : /* Add a work item to scan the non-null index entries */
171 916 : spgAddStartItem(so, false);
172 :
173 928 : MemoryContextSwitchTo(oldCtx);
174 :
175 928 : if (so->numberOfOrderBys > 0)
176 : {
177 : /* Must pfree distances to avoid memory leak */
178 : int i;
179 :
180 90 : for (i = 0; i < so->nPtrs; i++)
181 12 : if (so->distances[i])
182 12 : pfree(so->distances[i]);
183 : }
184 :
185 928 : if (so->want_itup)
186 : {
187 : /* Must pfree reconstructed tuples to avoid memory leak */
188 : int i;
189 :
190 90 : for (i = 0; i < so->nPtrs; i++)
191 66 : pfree(so->reconTups[i]);
192 : }
193 928 : so->iPtr = so->nPtrs = 0;
194 928 : }
195 :
196 : /*
197 : * Prepare scan keys in SpGistScanOpaque from caller-given scan keys
198 : *
199 : * Sets searchNulls, searchNonNulls, numberOfKeys, keyData fields of *so.
200 : *
201 : * The point here is to eliminate null-related considerations from what the
202 : * opclass consistent functions need to deal with. We assume all SPGiST-
203 : * indexable operators are strict, so any null RHS value makes the scan
204 : * condition unsatisfiable. We also pull out any IS NULL/IS NOT NULL
205 : * conditions; their effect is reflected into searchNulls/searchNonNulls.
206 : */
207 : static void
208 928 : spgPrepareScanKeys(IndexScanDesc scan)
209 : {
210 928 : SpGistScanOpaque so = (SpGistScanOpaque) scan->opaque;
211 : bool qual_ok;
212 : bool haveIsNull;
213 : bool haveNotNull;
214 : int nkeys;
215 : int i;
216 :
217 928 : so->numberOfOrderBys = scan->numberOfOrderBys;
218 928 : so->orderByData = scan->orderByData;
219 :
220 928 : if (so->numberOfOrderBys <= 0)
221 850 : so->numberOfNonNullOrderBys = 0;
222 : else
223 : {
224 78 : int j = 0;
225 :
226 : /*
227 : * Remove all NULL keys, but remember their offsets in the original
228 : * array.
229 : */
230 174 : for (i = 0; i < scan->numberOfOrderBys; i++)
231 : {
232 96 : ScanKey skey = &so->orderByData[i];
233 :
234 96 : if (skey->sk_flags & SK_ISNULL)
235 6 : so->nonNullOrderByOffsets[i] = -1;
236 : else
237 : {
238 90 : if (i != j)
239 6 : so->orderByData[j] = *skey;
240 :
241 90 : so->nonNullOrderByOffsets[i] = j++;
242 : }
243 : }
244 :
245 78 : so->numberOfNonNullOrderBys = j;
246 : }
247 :
248 928 : if (scan->numberOfKeys <= 0)
249 : {
250 : /* If no quals, whole-index scan is required */
251 54 : so->searchNulls = true;
252 54 : so->searchNonNulls = true;
253 54 : so->numberOfKeys = 0;
254 54 : return;
255 : }
256 :
257 : /* Examine the given quals */
258 874 : qual_ok = true;
259 874 : haveIsNull = haveNotNull = false;
260 874 : nkeys = 0;
261 1752 : for (i = 0; i < scan->numberOfKeys; i++)
262 : {
263 878 : ScanKey skey = &scan->keyData[i];
264 :
265 878 : if (skey->sk_flags & SK_SEARCHNULL)
266 12 : haveIsNull = true;
267 866 : else if (skey->sk_flags & SK_SEARCHNOTNULL)
268 24 : haveNotNull = true;
269 842 : else if (skey->sk_flags & SK_ISNULL)
270 : {
271 : /* ordinary qual with null argument - unsatisfiable */
272 0 : qual_ok = false;
273 0 : break;
274 : }
275 : else
276 : {
277 : /* ordinary qual, propagate into so->keyData */
278 842 : so->keyData[nkeys++] = *skey;
279 : /* this effectively creates a not-null requirement */
280 842 : haveNotNull = true;
281 : }
282 : }
283 :
284 : /* IS NULL in combination with something else is unsatisfiable */
285 874 : if (haveIsNull && haveNotNull)
286 0 : qual_ok = false;
287 :
288 : /* Emit results */
289 874 : if (qual_ok)
290 : {
291 874 : so->searchNulls = haveIsNull;
292 874 : so->searchNonNulls = haveNotNull;
293 874 : so->numberOfKeys = nkeys;
294 : }
295 : else
296 : {
297 0 : so->searchNulls = false;
298 0 : so->searchNonNulls = false;
299 0 : so->numberOfKeys = 0;
300 : }
301 : }
302 :
303 : IndexScanDesc
304 904 : spgbeginscan(Relation rel, int keysz, int orderbysz)
305 : {
306 : IndexScanDesc scan;
307 : SpGistScanOpaque so;
308 : int i;
309 :
310 904 : scan = RelationGetIndexScan(rel, keysz, orderbysz);
311 :
312 904 : so = (SpGistScanOpaque) palloc0(sizeof(SpGistScanOpaqueData));
313 904 : if (keysz > 0)
314 862 : so->keyData = (ScanKey) palloc(sizeof(ScanKeyData) * keysz);
315 : else
316 42 : so->keyData = NULL;
317 904 : initSpGistState(&so->state, scan->indexRelation);
318 :
319 904 : so->tempCxt = AllocSetContextCreate(CurrentMemoryContext,
320 : "SP-GiST search temporary context",
321 : ALLOCSET_DEFAULT_SIZES);
322 904 : so->traversalCxt = AllocSetContextCreate(CurrentMemoryContext,
323 : "SP-GiST traversal-value context",
324 : ALLOCSET_DEFAULT_SIZES);
325 :
326 : /*
327 : * Set up reconTupDesc and xs_hitupdesc in case it's an index-only scan,
328 : * making sure that the key column is shown as being of type attType.
329 : * (It's rather annoying to do this work when it might be wasted, but for
330 : * most opclasses we can re-use the index reldesc instead of making one.)
331 : */
332 904 : so->reconTupDesc = scan->xs_hitupdesc =
333 904 : getSpGistTupleDesc(rel, &so->state.attType);
334 :
335 : /* Allocate various arrays needed for order-by scans */
336 904 : if (scan->numberOfOrderBys > 0)
337 : {
338 : /* This will be filled in spgrescan, but allocate the space here */
339 66 : so->orderByTypes = (Oid *)
340 66 : palloc(sizeof(Oid) * scan->numberOfOrderBys);
341 66 : so->nonNullOrderByOffsets = (int *)
342 66 : palloc(sizeof(int) * scan->numberOfOrderBys);
343 :
344 : /* These arrays have constant contents, so we can fill them now */
345 66 : so->zeroDistances = (double *)
346 66 : palloc(sizeof(double) * scan->numberOfOrderBys);
347 66 : so->infDistances = (double *)
348 66 : palloc(sizeof(double) * scan->numberOfOrderBys);
349 :
350 138 : for (i = 0; i < scan->numberOfOrderBys; i++)
351 : {
352 72 : so->zeroDistances[i] = 0.0;
353 72 : so->infDistances[i] = get_float8_infinity();
354 : }
355 :
356 66 : scan->xs_orderbyvals = (Datum *)
357 66 : palloc0(sizeof(Datum) * scan->numberOfOrderBys);
358 66 : scan->xs_orderbynulls = (bool *)
359 66 : palloc(sizeof(bool) * scan->numberOfOrderBys);
360 66 : memset(scan->xs_orderbynulls, true,
361 66 : sizeof(bool) * scan->numberOfOrderBys);
362 : }
363 :
364 904 : fmgr_info_copy(&so->innerConsistentFn,
365 : index_getprocinfo(rel, 1, SPGIST_INNER_CONSISTENT_PROC),
366 : CurrentMemoryContext);
367 :
368 904 : fmgr_info_copy(&so->leafConsistentFn,
369 : index_getprocinfo(rel, 1, SPGIST_LEAF_CONSISTENT_PROC),
370 : CurrentMemoryContext);
371 :
372 904 : so->indexCollation = rel->rd_indcollation[0];
373 :
374 904 : scan->opaque = so;
375 :
376 904 : return scan;
377 : }
378 :
379 : void
380 928 : spgrescan(IndexScanDesc scan, ScanKey scankey, int nscankeys,
381 : ScanKey orderbys, int norderbys)
382 : {
383 928 : SpGistScanOpaque so = (SpGistScanOpaque) scan->opaque;
384 :
385 : /* copy scankeys into local storage */
386 928 : if (scankey && scan->numberOfKeys > 0)
387 874 : memcpy(scan->keyData, scankey, scan->numberOfKeys * sizeof(ScanKeyData));
388 :
389 : /* initialize order-by data if needed */
390 928 : if (orderbys && scan->numberOfOrderBys > 0)
391 : {
392 : int i;
393 :
394 78 : memcpy(scan->orderByData, orderbys, scan->numberOfOrderBys * sizeof(ScanKeyData));
395 :
396 174 : for (i = 0; i < scan->numberOfOrderBys; i++)
397 : {
398 96 : ScanKey skey = &scan->orderByData[i];
399 :
400 : /*
401 : * Look up the datatype returned by the original ordering
402 : * operator. SP-GiST always uses a float8 for the distance
403 : * function, but the ordering operator could be anything else.
404 : *
405 : * XXX: The distance function is only allowed to be lossy if the
406 : * ordering operator's result type is float4 or float8. Otherwise
407 : * we don't know how to return the distance to the executor. But
408 : * we cannot check that here, as we won't know if the distance
409 : * function is lossy until it returns *recheck = true for the
410 : * first time.
411 : */
412 96 : so->orderByTypes[i] = get_func_rettype(skey->sk_func.fn_oid);
413 : }
414 : }
415 :
416 : /* preprocess scankeys, set up the representation in *so */
417 928 : spgPrepareScanKeys(scan);
418 :
419 : /* set up starting queue entries */
420 928 : resetSpGistScanOpaque(so);
421 :
422 : /* count an indexscan for stats */
423 928 : pgstat_count_index_scan(scan->indexRelation);
424 928 : if (scan->instrument)
425 928 : scan->instrument->nsearches++;
426 928 : }
427 :
428 : void
429 904 : spgendscan(IndexScanDesc scan)
430 : {
431 904 : SpGistScanOpaque so = (SpGistScanOpaque) scan->opaque;
432 :
433 904 : MemoryContextDelete(so->tempCxt);
434 904 : MemoryContextDelete(so->traversalCxt);
435 :
436 904 : if (so->keyData)
437 862 : pfree(so->keyData);
438 :
439 904 : if (so->state.leafTupDesc &&
440 904 : so->state.leafTupDesc != RelationGetDescr(so->state.index))
441 8 : FreeTupleDesc(so->state.leafTupDesc);
442 :
443 904 : if (so->state.deadTupleStorage)
444 904 : pfree(so->state.deadTupleStorage);
445 :
446 904 : if (scan->numberOfOrderBys > 0)
447 : {
448 66 : pfree(so->orderByTypes);
449 66 : pfree(so->nonNullOrderByOffsets);
450 66 : pfree(so->zeroDistances);
451 66 : pfree(so->infDistances);
452 66 : pfree(scan->xs_orderbyvals);
453 66 : pfree(scan->xs_orderbynulls);
454 : }
455 :
456 904 : pfree(so);
457 904 : }
458 :
459 : /*
460 : * Leaf SpGistSearchItem constructor, called in queue context
461 : */
462 : static SpGistSearchItem *
463 365924 : spgNewHeapItem(SpGistScanOpaque so, int level, SpGistLeafTuple leafTuple,
464 : Datum leafValue, bool recheck, bool recheckDistances,
465 : bool isnull, double *distances)
466 : {
467 365924 : SpGistSearchItem *item = spgAllocSearchItem(so, isnull, distances);
468 :
469 365924 : item->level = level;
470 365924 : item->heapPtr = leafTuple->heapPtr;
471 :
472 : /*
473 : * If we need the reconstructed value, copy it to queue cxt out of tmp
474 : * cxt. Caution: the leaf_consistent method may not have supplied a value
475 : * if we didn't ask it to, and mildly-broken methods might supply one of
476 : * the wrong type. The correct leafValue type is attType not leafType.
477 : */
478 365924 : if (so->want_itup)
479 : {
480 279368 : item->value = isnull ? (Datum) 0 :
481 279332 : datumCopy(leafValue, so->state.attType.attbyval,
482 279332 : so->state.attType.attlen);
483 :
484 : /*
485 : * If we're going to need to reconstruct INCLUDE attributes, store the
486 : * whole leaf tuple so we can get the INCLUDE attributes out of it.
487 : */
488 279368 : if (so->state.leafTupDesc->natts > 1)
489 : {
490 218 : item->leafTuple = palloc(leafTuple->size);
491 218 : memcpy(item->leafTuple, leafTuple, leafTuple->size);
492 : }
493 : else
494 279150 : item->leafTuple = NULL;
495 : }
496 : else
497 : {
498 86556 : item->value = (Datum) 0;
499 86556 : item->leafTuple = NULL;
500 : }
501 365924 : item->traversalValue = NULL;
502 365924 : item->isLeaf = true;
503 365924 : item->recheck = recheck;
504 365924 : item->recheckDistances = recheckDistances;
505 :
506 365924 : return item;
507 : }
508 :
509 : /*
510 : * Test whether a leaf tuple satisfies all the scan keys
511 : *
512 : * *reportedSome is set to true if:
513 : * the scan is not ordered AND the item satisfies the scankeys
514 : */
515 : static bool
516 2545052 : spgLeafTest(SpGistScanOpaque so, SpGistSearchItem *item,
517 : SpGistLeafTuple leafTuple, bool isnull,
518 : bool *reportedSome, storeRes_func storeRes)
519 : {
520 : Datum leafValue;
521 : double *distances;
522 : bool result;
523 : bool recheck;
524 : bool recheckDistances;
525 :
526 2545052 : if (isnull)
527 : {
528 : /* Should not have arrived on a nulls page unless nulls are wanted */
529 : Assert(so->searchNulls);
530 120 : leafValue = (Datum) 0;
531 120 : distances = NULL;
532 120 : recheck = false;
533 120 : recheckDistances = false;
534 120 : result = true;
535 : }
536 : else
537 : {
538 : spgLeafConsistentIn in;
539 : spgLeafConsistentOut out;
540 :
541 : /* use temp context for calling leaf_consistent */
542 2544932 : MemoryContext oldCxt = MemoryContextSwitchTo(so->tempCxt);
543 :
544 2544932 : in.scankeys = so->keyData;
545 2544932 : in.nkeys = so->numberOfKeys;
546 2544932 : in.orderbys = so->orderByData;
547 2544932 : in.norderbys = so->numberOfNonNullOrderBys;
548 : Assert(!item->isLeaf); /* else reconstructedValue would be wrong type */
549 2544932 : in.reconstructedValue = item->value;
550 2544932 : in.traversalValue = item->traversalValue;
551 2544932 : in.level = item->level;
552 2544932 : in.returnData = so->want_itup;
553 2544932 : in.leafDatum = SGLTDATUM(leafTuple, &so->state);
554 :
555 2544932 : out.leafValue = (Datum) 0;
556 2544932 : out.recheck = false;
557 2544932 : out.distances = NULL;
558 2544932 : out.recheckDistances = false;
559 :
560 2544932 : result = DatumGetBool(FunctionCall2Coll(&so->leafConsistentFn,
561 : so->indexCollation,
562 : PointerGetDatum(&in),
563 : PointerGetDatum(&out)));
564 2544932 : recheck = out.recheck;
565 2544932 : recheckDistances = out.recheckDistances;
566 2544932 : leafValue = out.leafValue;
567 2544932 : distances = out.distances;
568 :
569 2544932 : MemoryContextSwitchTo(oldCxt);
570 : }
571 :
572 2545052 : if (result)
573 : {
574 : /* item passes the scankeys */
575 2061258 : if (so->numberOfNonNullOrderBys > 0)
576 : {
577 : /* the scan is ordered -> add the item to the queue */
578 365924 : MemoryContext oldCxt = MemoryContextSwitchTo(so->traversalCxt);
579 365924 : SpGistSearchItem *heapItem = spgNewHeapItem(so, item->level,
580 : leafTuple,
581 : leafValue,
582 : recheck,
583 : recheckDistances,
584 : isnull,
585 : distances);
586 :
587 365924 : spgAddSearchItemToQueue(so, heapItem);
588 :
589 365924 : MemoryContextSwitchTo(oldCxt);
590 : }
591 : else
592 : {
593 : /* non-ordered scan, so report the item right away */
594 : Assert(!recheckDistances);
595 1695334 : storeRes(so, &leafTuple->heapPtr, leafValue, isnull,
596 : leafTuple, recheck, false, NULL);
597 1695334 : *reportedSome = true;
598 : }
599 : }
600 :
601 2545052 : return result;
602 : }
603 :
604 : /* A bundle initializer for inner_consistent methods */
605 : static void
606 24466 : spgInitInnerConsistentIn(spgInnerConsistentIn *in,
607 : SpGistScanOpaque so,
608 : SpGistSearchItem *item,
609 : SpGistInnerTuple innerTuple)
610 : {
611 24466 : in->scankeys = so->keyData;
612 24466 : in->orderbys = so->orderByData;
613 24466 : in->nkeys = so->numberOfKeys;
614 24466 : in->norderbys = so->numberOfNonNullOrderBys;
615 : Assert(!item->isLeaf); /* else reconstructedValue would be wrong type */
616 24466 : in->reconstructedValue = item->value;
617 24466 : in->traversalMemoryContext = so->traversalCxt;
618 24466 : in->traversalValue = item->traversalValue;
619 24466 : in->level = item->level;
620 24466 : in->returnData = so->want_itup;
621 24466 : in->allTheSame = innerTuple->allTheSame;
622 24466 : in->hasPrefix = (innerTuple->prefixSize > 0);
623 24466 : in->prefixDatum = SGITDATUM(innerTuple, &so->state);
624 24466 : in->nNodes = innerTuple->nNodes;
625 24466 : in->nodeLabels = spgExtractNodeLabels(&so->state, innerTuple);
626 24466 : }
627 :
628 : static SpGistSearchItem *
629 94146 : spgMakeInnerItem(SpGistScanOpaque so,
630 : SpGistSearchItem *parentItem,
631 : SpGistNodeTuple tuple,
632 : spgInnerConsistentOut *out, int i, bool isnull,
633 : double *distances)
634 : {
635 94146 : SpGistSearchItem *item = spgAllocSearchItem(so, isnull, distances);
636 :
637 94146 : item->heapPtr = tuple->t_tid;
638 230256 : item->level = out->levelAdds ? parentItem->level + out->levelAdds[i]
639 94146 : : parentItem->level;
640 :
641 : /* Must copy value out of temp context */
642 : /* (recall that reconstructed values are of type leafType) */
643 188292 : item->value = out->reconstructedValues
644 12336 : ? datumCopy(out->reconstructedValues[i],
645 12336 : so->state.attLeafType.attbyval,
646 12336 : so->state.attLeafType.attlen)
647 94146 : : (Datum) 0;
648 :
649 94146 : item->leafTuple = NULL;
650 :
651 : /*
652 : * Elements of out.traversalValues should be allocated in
653 : * in.traversalMemoryContext, which is actually a long lived context of
654 : * index scan.
655 : */
656 94146 : item->traversalValue =
657 94146 : out->traversalValues ? out->traversalValues[i] : NULL;
658 :
659 94146 : item->isLeaf = false;
660 94146 : item->recheck = false;
661 94146 : item->recheckDistances = false;
662 :
663 94146 : return item;
664 : }
665 :
666 : static void
667 24466 : spgInnerTest(SpGistScanOpaque so, SpGistSearchItem *item,
668 : SpGistInnerTuple innerTuple, bool isnull)
669 : {
670 24466 : MemoryContext oldCxt = MemoryContextSwitchTo(so->tempCxt);
671 : spgInnerConsistentOut out;
672 24466 : int nNodes = innerTuple->nNodes;
673 : int i;
674 :
675 24466 : memset(&out, 0, sizeof(out));
676 :
677 24466 : if (!isnull)
678 : {
679 : spgInnerConsistentIn in;
680 :
681 24466 : spgInitInnerConsistentIn(&in, so, item, innerTuple);
682 :
683 : /* use user-defined inner consistent method */
684 24466 : FunctionCall2Coll(&so->innerConsistentFn,
685 : so->indexCollation,
686 : PointerGetDatum(&in),
687 : PointerGetDatum(&out));
688 : }
689 : else
690 : {
691 : /* force all children to be visited */
692 0 : out.nNodes = nNodes;
693 0 : out.nodeNumbers = (int *) palloc(sizeof(int) * nNodes);
694 0 : for (i = 0; i < nNodes; i++)
695 0 : out.nodeNumbers[i] = i;
696 : }
697 :
698 : /* If allTheSame, they should all or none of them match */
699 24466 : if (innerTuple->allTheSame && out.nNodes != 0 && out.nNodes != nNodes)
700 0 : elog(ERROR, "inconsistent inner_consistent results for allTheSame inner tuple");
701 :
702 24466 : if (out.nNodes)
703 : {
704 : /* collect node pointers */
705 : SpGistNodeTuple node;
706 24466 : SpGistNodeTuple *nodes = (SpGistNodeTuple *) palloc(sizeof(SpGistNodeTuple) * nNodes);
707 :
708 226380 : SGITITERATE(innerTuple, i, node)
709 : {
710 201914 : nodes[i] = node;
711 : }
712 :
713 24466 : MemoryContextSwitchTo(so->traversalCxt);
714 :
715 185660 : for (i = 0; i < out.nNodes; i++)
716 : {
717 161194 : int nodeN = out.nodeNumbers[i];
718 : SpGistSearchItem *innerItem;
719 : double *distances;
720 :
721 : Assert(nodeN >= 0 && nodeN < nNodes);
722 :
723 161194 : node = nodes[nodeN];
724 :
725 161194 : if (!ItemPointerIsValid(&node->t_tid))
726 67048 : continue;
727 :
728 : /*
729 : * Use infinity distances if innerConsistentFn() failed to return
730 : * them or if is a NULL item (their distances are really unused).
731 : */
732 94146 : distances = out.distances ? out.distances[i] : so->infDistances;
733 :
734 94146 : innerItem = spgMakeInnerItem(so, item, node, &out, i, isnull,
735 : distances);
736 :
737 94146 : spgAddSearchItemToQueue(so, innerItem);
738 : }
739 : }
740 :
741 24466 : MemoryContextSwitchTo(oldCxt);
742 24466 : }
743 :
744 : /* Returns a next item in an (ordered) scan or null if the index is exhausted */
745 : static SpGistSearchItem *
746 459158 : spgGetNextQueueItem(SpGistScanOpaque so)
747 : {
748 459158 : if (pairingheap_is_empty(so->scanQueue))
749 886 : return NULL; /* Done when both heaps are empty */
750 :
751 : /* Return item; caller is responsible to pfree it */
752 458272 : return (SpGistSearchItem *) pairingheap_remove_first(so->scanQueue);
753 : }
754 :
755 : enum SpGistSpecialOffsetNumbers
756 : {
757 : SpGistBreakOffsetNumber = InvalidOffsetNumber,
758 : SpGistRedirectOffsetNumber = MaxOffsetNumber + 1,
759 : SpGistErrorOffsetNumber = MaxOffsetNumber + 2,
760 : };
761 :
762 : static OffsetNumber
763 2545052 : spgTestLeafTuple(SpGistScanOpaque so,
764 : SpGistSearchItem *item,
765 : Page page, OffsetNumber offset,
766 : bool isnull, bool isroot,
767 : bool *reportedSome,
768 : storeRes_func storeRes)
769 : {
770 : SpGistLeafTuple leafTuple = (SpGistLeafTuple)
771 2545052 : PageGetItem(page, PageGetItemId(page, offset));
772 :
773 2545052 : if (leafTuple->tupstate != SPGIST_LIVE)
774 : {
775 0 : if (!isroot) /* all tuples on root should be live */
776 : {
777 0 : if (leafTuple->tupstate == SPGIST_REDIRECT)
778 : {
779 : /* redirection tuple should be first in chain */
780 : Assert(offset == ItemPointerGetOffsetNumber(&item->heapPtr));
781 : /* transfer attention to redirect point */
782 0 : item->heapPtr = ((SpGistDeadTuple) leafTuple)->pointer;
783 : Assert(ItemPointerGetBlockNumber(&item->heapPtr) != SPGIST_METAPAGE_BLKNO);
784 0 : return SpGistRedirectOffsetNumber;
785 : }
786 :
787 0 : if (leafTuple->tupstate == SPGIST_DEAD)
788 : {
789 : /* dead tuple should be first in chain */
790 : Assert(offset == ItemPointerGetOffsetNumber(&item->heapPtr));
791 : /* No live entries on this page */
792 : Assert(SGLT_GET_NEXTOFFSET(leafTuple) == InvalidOffsetNumber);
793 0 : return SpGistBreakOffsetNumber;
794 : }
795 : }
796 :
797 : /* We should not arrive at a placeholder */
798 0 : elog(ERROR, "unexpected SPGiST tuple state: %d", leafTuple->tupstate);
799 : return SpGistErrorOffsetNumber;
800 : }
801 :
802 : Assert(ItemPointerIsValid(&leafTuple->heapPtr));
803 :
804 2545052 : spgLeafTest(so, item, leafTuple, isnull, reportedSome, storeRes);
805 :
806 2545052 : return SGLT_GET_NEXTOFFSET(leafTuple);
807 : }
808 :
809 : /*
810 : * Walk the tree and report all tuples passing the scan quals to the storeRes
811 : * subroutine.
812 : *
813 : * If scanWholeIndex is true, we'll do just that. If not, we'll stop at the
814 : * next page boundary once we have reported at least one tuple.
815 : */
816 : static void
817 377312 : spgWalk(Relation index, SpGistScanOpaque so, bool scanWholeIndex,
818 : storeRes_func storeRes)
819 : {
820 377312 : Buffer buffer = InvalidBuffer;
821 377312 : bool reportedSome = false;
822 :
823 835584 : while (scanWholeIndex || !reportedSome)
824 : {
825 459158 : SpGistSearchItem *item = spgGetNextQueueItem(so);
826 :
827 459158 : if (item == NULL)
828 886 : break; /* No more items in queue -> done */
829 :
830 458272 : redirect:
831 : /* Check for interrupts, just in case of infinite loop */
832 458272 : CHECK_FOR_INTERRUPTS();
833 :
834 458272 : if (item->isLeaf)
835 : {
836 : /* We store heap items in the queue only in case of ordered search */
837 : Assert(so->numberOfNonNullOrderBys > 0);
838 363354 : storeRes(so, &item->heapPtr, item->value, item->isNull,
839 363354 : item->leafTuple, item->recheck,
840 363354 : item->recheckDistances, item->distances);
841 363354 : reportedSome = true;
842 : }
843 : else
844 : {
845 94918 : BlockNumber blkno = ItemPointerGetBlockNumber(&item->heapPtr);
846 94918 : OffsetNumber offset = ItemPointerGetOffsetNumber(&item->heapPtr);
847 : Page page;
848 : bool isnull;
849 :
850 94918 : if (buffer == InvalidBuffer)
851 : {
852 19854 : buffer = ReadBuffer(index, blkno);
853 19854 : LockBuffer(buffer, BUFFER_LOCK_SHARE);
854 : }
855 75064 : else if (blkno != BufferGetBlockNumber(buffer))
856 : {
857 51962 : UnlockReleaseBuffer(buffer);
858 51962 : buffer = ReadBuffer(index, blkno);
859 51962 : LockBuffer(buffer, BUFFER_LOCK_SHARE);
860 : }
861 :
862 : /* else new pointer points to the same page, no work needed */
863 :
864 94918 : page = BufferGetPage(buffer);
865 :
866 94918 : isnull = SpGistPageStoresNulls(page) ? true : false;
867 :
868 94918 : if (SpGistPageIsLeaf(page))
869 : {
870 : /* Page is a leaf - that is, all its tuples are heap items */
871 70452 : OffsetNumber max = PageGetMaxOffsetNumber(page);
872 :
873 70452 : if (SpGistBlockIsRoot(blkno))
874 : {
875 : /* When root is a leaf, examine all its tuples */
876 6126 : for (offset = FirstOffsetNumber; offset <= max; offset++)
877 5928 : (void) spgTestLeafTuple(so, item, page, offset,
878 : isnull, true,
879 : &reportedSome, storeRes);
880 : }
881 : else
882 : {
883 : /* Normal case: just examine the chain we arrived at */
884 2609378 : while (offset != InvalidOffsetNumber)
885 : {
886 : Assert(offset >= FirstOffsetNumber && offset <= max);
887 2539124 : offset = spgTestLeafTuple(so, item, page, offset,
888 : isnull, false,
889 : &reportedSome, storeRes);
890 2539124 : if (offset == SpGistRedirectOffsetNumber)
891 0 : goto redirect;
892 : }
893 : }
894 : }
895 : else /* page is inner */
896 : {
897 : SpGistInnerTuple innerTuple = (SpGistInnerTuple)
898 24466 : PageGetItem(page, PageGetItemId(page, offset));
899 :
900 24466 : if (innerTuple->tupstate != SPGIST_LIVE)
901 : {
902 0 : if (innerTuple->tupstate == SPGIST_REDIRECT)
903 : {
904 : /* transfer attention to redirect point */
905 0 : item->heapPtr = ((SpGistDeadTuple) innerTuple)->pointer;
906 : Assert(ItemPointerGetBlockNumber(&item->heapPtr) !=
907 : SPGIST_METAPAGE_BLKNO);
908 0 : goto redirect;
909 : }
910 0 : elog(ERROR, "unexpected SPGiST tuple state: %d",
911 : innerTuple->tupstate);
912 : }
913 :
914 24466 : spgInnerTest(so, item, innerTuple, isnull);
915 : }
916 : }
917 :
918 : /* done with this scan item */
919 458272 : spgFreeSearchItem(so, item);
920 : /* clear temp context before proceeding to the next one */
921 458272 : MemoryContextReset(so->tempCxt);
922 : }
923 :
924 377312 : if (buffer != InvalidBuffer)
925 19854 : UnlockReleaseBuffer(buffer);
926 377312 : }
927 :
928 :
929 : /* storeRes subroutine for getbitmap case */
930 : static void
931 1052214 : storeBitmap(SpGistScanOpaque so, ItemPointer heapPtr,
932 : Datum leafValue, bool isnull,
933 : SpGistLeafTuple leafTuple, bool recheck,
934 : bool recheckDistances, double *distances)
935 : {
936 : Assert(!recheckDistances && !distances);
937 1052214 : tbm_add_tuples(so->tbm, heapPtr, 1, recheck);
938 1052214 : so->ntids++;
939 1052214 : }
940 :
941 : int64
942 348 : spggetbitmap(IndexScanDesc scan, TIDBitmap *tbm)
943 : {
944 348 : SpGistScanOpaque so = (SpGistScanOpaque) scan->opaque;
945 :
946 : /* Copy want_itup to *so so we don't need to pass it around separately */
947 348 : so->want_itup = false;
948 :
949 348 : so->tbm = tbm;
950 348 : so->ntids = 0;
951 :
952 348 : spgWalk(scan->indexRelation, so, true, storeBitmap);
953 :
954 348 : return so->ntids;
955 : }
956 :
957 : /* storeRes subroutine for gettuple case */
958 : static void
959 1006474 : storeGettuple(SpGistScanOpaque so, ItemPointer heapPtr,
960 : Datum leafValue, bool isnull,
961 : SpGistLeafTuple leafTuple, bool recheck,
962 : bool recheckDistances, double *nonNullDistances)
963 : {
964 : Assert(so->nPtrs < MaxIndexTuplesPerPage);
965 1006474 : so->heapPtrs[so->nPtrs] = *heapPtr;
966 1006474 : so->recheck[so->nPtrs] = recheck;
967 1006474 : so->recheckDistances[so->nPtrs] = recheckDistances;
968 :
969 1006474 : if (so->numberOfOrderBys > 0)
970 : {
971 363354 : if (isnull || so->numberOfNonNullOrderBys <= 0)
972 48 : so->distances[so->nPtrs] = NULL;
973 : else
974 : {
975 : IndexOrderByDistance *distances =
976 363306 : palloc(sizeof(distances[0]) * so->numberOfOrderBys);
977 : int i;
978 :
979 726630 : for (i = 0; i < so->numberOfOrderBys; i++)
980 : {
981 363324 : int offset = so->nonNullOrderByOffsets[i];
982 :
983 363324 : if (offset >= 0)
984 : {
985 : /* Copy non-NULL distance value */
986 363318 : distances[i].value = nonNullDistances[offset];
987 363318 : distances[i].isnull = false;
988 : }
989 : else
990 : {
991 : /* Set distance's NULL flag. */
992 6 : distances[i].value = 0.0;
993 6 : distances[i].isnull = true;
994 : }
995 : }
996 :
997 363306 : so->distances[so->nPtrs] = distances;
998 : }
999 : }
1000 :
1001 1006474 : if (so->want_itup)
1002 : {
1003 : /*
1004 : * Reconstruct index data. We have to copy the datum out of the temp
1005 : * context anyway, so we may as well create the tuple here.
1006 : */
1007 : Datum leafDatums[INDEX_MAX_KEYS];
1008 : bool leafIsnulls[INDEX_MAX_KEYS];
1009 :
1010 : /* We only need to deform the old tuple if it has INCLUDE attributes */
1011 919438 : if (so->state.leafTupDesc->natts > 1)
1012 112 : spgDeformLeafTuple(leafTuple, so->state.leafTupDesc,
1013 : leafDatums, leafIsnulls, isnull);
1014 :
1015 919438 : leafDatums[spgKeyColumn] = leafValue;
1016 919438 : leafIsnulls[spgKeyColumn] = isnull;
1017 :
1018 919438 : so->reconTups[so->nPtrs] = heap_form_tuple(so->reconTupDesc,
1019 : leafDatums,
1020 : leafIsnulls);
1021 : }
1022 1006474 : so->nPtrs++;
1023 1006474 : }
1024 :
1025 : bool
1026 1006916 : spggettuple(IndexScanDesc scan, ScanDirection dir)
1027 : {
1028 1006916 : SpGistScanOpaque so = (SpGistScanOpaque) scan->opaque;
1029 :
1030 1006916 : if (dir != ForwardScanDirection)
1031 0 : elog(ERROR, "SP-GiST only supports forward scan direction");
1032 :
1033 : /* Copy want_itup to *so so we don't need to pass it around separately */
1034 1006916 : so->want_itup = scan->xs_want_itup;
1035 :
1036 : for (;;)
1037 : {
1038 1383342 : if (so->iPtr < so->nPtrs)
1039 : {
1040 : /* continuing to return reported tuples */
1041 1006378 : scan->xs_heaptid = so->heapPtrs[so->iPtr];
1042 1006378 : scan->xs_recheck = so->recheck[so->iPtr];
1043 1006378 : scan->xs_hitup = so->reconTups[so->iPtr];
1044 :
1045 1006378 : if (so->numberOfOrderBys > 0)
1046 363354 : index_store_float8_orderby_distances(scan, so->orderByTypes,
1047 363354 : so->distances[so->iPtr],
1048 363354 : so->recheckDistances[so->iPtr]);
1049 1006378 : so->iPtr++;
1050 1006378 : return true;
1051 : }
1052 :
1053 376964 : if (so->numberOfOrderBys > 0)
1054 : {
1055 : /* Must pfree distances to avoid memory leak */
1056 : int i;
1057 :
1058 726738 : for (i = 0; i < so->nPtrs; i++)
1059 363330 : if (so->distances[i])
1060 363282 : pfree(so->distances[i]);
1061 : }
1062 :
1063 376964 : if (so->want_itup)
1064 : {
1065 : /* Must pfree reconstructed tuples to avoid memory leak */
1066 : int i;
1067 :
1068 1209552 : for (i = 0; i < so->nPtrs; i++)
1069 919300 : pfree(so->reconTups[i]);
1070 : }
1071 376964 : so->iPtr = so->nPtrs = 0;
1072 :
1073 376964 : spgWalk(scan->indexRelation, so, false, storeGettuple);
1074 :
1075 376964 : if (so->nPtrs == 0)
1076 538 : break; /* must have completed scan */
1077 : }
1078 :
1079 538 : return false;
1080 : }
1081 :
1082 : bool
1083 1854 : spgcanreturn(Relation index, int attno)
1084 : {
1085 : SpGistCache *cache;
1086 :
1087 : /* INCLUDE attributes can always be fetched for index-only scans */
1088 1854 : if (attno > 1)
1089 28 : return true;
1090 :
1091 : /* We can do it if the opclass config function says so */
1092 1826 : cache = spgGetCache(index);
1093 :
1094 1826 : return cache->config.canReturnData;
1095 : }
|
