2 * contrib/btree_gist/btree_utils_var.c
6 #include "btree_gist.h"
12 #include "btree_utils_var.h"
13 #include "utils/pg_locale.h"
14 #include "utils/builtins.h"
15 #include "utils/rel.h"
17 /* used for key sorting */
26 const gbtree_vinfo *tinfo;
32 PG_FUNCTION_INFO_V1(gbt_var_decompress);
33 PG_FUNCTION_INFO_V1(gbt_var_fetch);
37 gbt_var_decompress(PG_FUNCTION_ARGS)
39 GISTENTRY *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
40 GBT_VARKEY *key = (GBT_VARKEY *) DatumGetPointer(PG_DETOAST_DATUM(entry->key));
42 if (key != (GBT_VARKEY *) DatumGetPointer(entry->key))
44 GISTENTRY *retval = (GISTENTRY *) palloc(sizeof(GISTENTRY));
46 gistentryinit(*retval, PointerGetDatum(key),
47 entry->rel, entry->page,
48 entry->offset, FALSE);
50 PG_RETURN_POINTER(retval);
53 PG_RETURN_POINTER(entry);
56 /* Returns a better readable representation of variable key ( sets pointer ) */
58 gbt_var_key_readable(const GBT_VARKEY *k)
62 r.lower = (bytea *) &(((char *) k)[VARHDRSZ]);
63 if (VARSIZE(k) > (VARHDRSZ + (VARSIZE(r.lower))))
64 r.upper = (bytea *) &(((char *) k)[VARHDRSZ + INTALIGN(VARSIZE(r.lower))]);
72 * Create a leaf-entry to store in the index, from a single Datum.
75 gbt_var_key_from_datum(const struct varlena *u)
77 int32 lowersize = VARSIZE(u);
80 r = (GBT_VARKEY *) palloc(lowersize + VARHDRSZ);
81 memcpy(VARDATA(r), u, lowersize);
82 SET_VARSIZE(r, lowersize + VARHDRSZ);
88 * Create an entry to store in the index, from lower and upper bound.
91 gbt_var_key_copy(const GBT_VARKEY_R *u)
93 int32 lowersize = VARSIZE(u->lower);
94 int32 uppersize = VARSIZE(u->upper);
97 r = (GBT_VARKEY *) palloc0(INTALIGN(lowersize) + uppersize + VARHDRSZ);
98 memcpy(VARDATA(r), u->lower, lowersize);
99 memcpy(VARDATA(r) + INTALIGN(lowersize), u->upper, uppersize);
100 SET_VARSIZE(r, INTALIGN(lowersize) + uppersize + VARHDRSZ);
107 gbt_var_leaf2node(GBT_VARKEY *leaf, const gbtree_vinfo *tinfo, FmgrInfo *flinfo)
109 GBT_VARKEY *out = leaf;
112 out = (*tinfo->f_l2n) (leaf, flinfo);
119 * returns the common prefix length of a node key
122 gbt_var_node_cp_len(const GBT_VARKEY *node, const gbtree_vinfo *tinfo)
124 GBT_VARKEY_R r = gbt_var_key_readable(node);
127 int32 t1len = VARSIZE(r.lower) - VARHDRSZ;
128 int32 t2len = VARSIZE(r.upper) - VARHDRSZ;
129 int32 ml = Min(t1len, t2len);
130 char *p1 = VARDATA(r.lower);
131 char *p2 = VARDATA(r.upper);
138 if (tinfo->eml > 1 && l == 0)
140 if ((l = pg_mblen(p1)) != pg_mblen(p2))
162 return (ml); /* lower == upper */
167 * returns true, if query matches prefix ( common prefix )
170 gbt_bytea_pf_match(const bytea *pf, const bytea *query, const gbtree_vinfo *tinfo)
173 int32 qlen = VARSIZE(query) - VARHDRSZ;
174 int32 nlen = VARSIZE(pf) - VARHDRSZ;
178 char *q = VARDATA(query);
179 char *n = VARDATA(pf);
181 out = (memcmp(q, n, nlen) == 0);
189 * returns true, if query matches node using common prefix
192 gbt_var_node_pf_match(const GBT_VARKEY_R *node, const bytea *query, const gbtree_vinfo *tinfo)
194 return (tinfo->trnc && (
195 gbt_bytea_pf_match(node->lower, query, tinfo) ||
196 gbt_bytea_pf_match(node->upper, query, tinfo)
202 * truncates / compresses the node key
203 * cpf_length .. common prefix length
206 gbt_var_node_truncate(const GBT_VARKEY *node, int32 cpf_length, const gbtree_vinfo *tinfo)
208 GBT_VARKEY *out = NULL;
209 GBT_VARKEY_R r = gbt_var_key_readable(node);
210 int32 len1 = VARSIZE(r.lower) - VARHDRSZ;
211 int32 len2 = VARSIZE(r.upper) - VARHDRSZ;
215 len1 = Min(len1, (cpf_length + 1));
216 len2 = Min(len2, (cpf_length + 1));
218 si = 2 * VARHDRSZ + INTALIGN(len1 + VARHDRSZ) + len2;
219 out = (GBT_VARKEY *) palloc0(si);
220 SET_VARSIZE(out, si);
222 memcpy(VARDATA(out), r.lower, len1 + VARHDRSZ);
223 SET_VARSIZE(VARDATA(out), len1 + VARHDRSZ);
225 out2 = VARDATA(out) + INTALIGN(len1 + VARHDRSZ);
226 memcpy(out2, r.upper, len2 + VARHDRSZ);
227 SET_VARSIZE(out2, len2 + VARHDRSZ);
235 gbt_var_bin_union(Datum *u, GBT_VARKEY *e, Oid collation,
236 const gbtree_vinfo *tinfo, FmgrInfo *flinfo)
238 GBT_VARKEY_R eo = gbt_var_key_readable(e);
241 if (eo.lower == eo.upper) /* leaf */
245 tmp = gbt_var_leaf2node(e, tinfo, flinfo);
247 eo = gbt_var_key_readable(tmp);
250 if (DatumGetPointer(*u))
252 GBT_VARKEY_R ro = gbt_var_key_readable((GBT_VARKEY *) DatumGetPointer(*u));
258 if ((*tinfo->f_cmp) (ro.lower, eo.lower, collation, flinfo) > 0)
264 if ((*tinfo->f_cmp) (ro.upper, eo.upper, collation, flinfo) < 0)
271 *u = PointerGetDatum(gbt_var_key_copy(&nr));
277 *u = PointerGetDatum(gbt_var_key_copy(&nr));
283 gbt_var_compress(GISTENTRY *entry, const gbtree_vinfo *tinfo)
289 struct varlena *leaf = PG_DETOAST_DATUM(entry->key);
292 r = gbt_var_key_from_datum(leaf);
294 retval = palloc(sizeof(GISTENTRY));
295 gistentryinit(*retval, PointerGetDatum(r),
296 entry->rel, entry->page,
297 entry->offset, TRUE);
307 gbt_var_fetch(PG_FUNCTION_ARGS)
309 GISTENTRY *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
310 GBT_VARKEY *key = (GBT_VARKEY *) DatumGetPointer(PG_DETOAST_DATUM(entry->key));
311 GBT_VARKEY_R r = gbt_var_key_readable(key);
314 retval = palloc(sizeof(GISTENTRY));
315 gistentryinit(*retval, PointerGetDatum(r.lower),
316 entry->rel, entry->page,
317 entry->offset, TRUE);
319 PG_RETURN_POINTER(retval);
324 gbt_var_union(const GistEntryVector *entryvec, int32 *size, Oid collation,
325 const gbtree_vinfo *tinfo, FmgrInfo *flinfo)
328 numranges = entryvec->n;
333 *size = sizeof(GBT_VARKEY);
335 cur = (GBT_VARKEY *) DatumGetPointer(entryvec->vector[0].key);
336 rk = gbt_var_key_readable(cur);
337 out = PointerGetDatum(gbt_var_key_copy(&rk));
339 for (i = 1; i < numranges; i++)
341 cur = (GBT_VARKEY *) DatumGetPointer(entryvec->vector[i].key);
342 gbt_var_bin_union(&out, cur, collation, tinfo, flinfo);
346 /* Truncate (=compress) key */
350 GBT_VARKEY *trc = NULL;
352 plen = gbt_var_node_cp_len((GBT_VARKEY *) DatumGetPointer(out), tinfo);
353 trc = gbt_var_node_truncate((GBT_VARKEY *) DatumGetPointer(out), plen + 1, tinfo);
355 out = PointerGetDatum(trc);
358 return ((GBT_VARKEY *) DatumGetPointer(out));
363 gbt_var_same(Datum d1, Datum d2, Oid collation,
364 const gbtree_vinfo *tinfo, FmgrInfo *flinfo)
366 GBT_VARKEY *t1 = (GBT_VARKEY *) DatumGetPointer(d1);
367 GBT_VARKEY *t2 = (GBT_VARKEY *) DatumGetPointer(d2);
371 r1 = gbt_var_key_readable(t1);
372 r2 = gbt_var_key_readable(t2);
374 return ((*tinfo->f_cmp) (r1.lower, r2.lower, collation, flinfo) == 0 &&
375 (*tinfo->f_cmp) (r1.upper, r2.upper, collation, flinfo) == 0);
380 gbt_var_penalty(float *res, const GISTENTRY *o, const GISTENTRY *n,
381 Oid collation, const gbtree_vinfo *tinfo, FmgrInfo *flinfo)
383 GBT_VARKEY *orge = (GBT_VARKEY *) DatumGetPointer(o->key);
384 GBT_VARKEY *newe = (GBT_VARKEY *) DatumGetPointer(n->key);
390 nk = gbt_var_key_readable(newe);
391 if (nk.lower == nk.upper) /* leaf */
395 tmp = gbt_var_leaf2node(newe, tinfo, flinfo);
397 nk = gbt_var_key_readable(tmp);
399 ok = gbt_var_key_readable(orge);
401 if ((VARSIZE(ok.lower) - VARHDRSZ) == 0 && (VARSIZE(ok.upper) - VARHDRSZ) == 0)
403 else if (!(((*tinfo->f_cmp) (nk.lower, ok.lower, collation, flinfo) >= 0 ||
404 gbt_bytea_pf_match(ok.lower, nk.lower, tinfo)) &&
405 ((*tinfo->f_cmp) (nk.upper, ok.upper, collation, flinfo) <= 0 ||
406 gbt_bytea_pf_match(ok.upper, nk.upper, tinfo))))
408 Datum d = PointerGetDatum(0);
413 gbt_var_bin_union(&d, orge, collation, tinfo, flinfo);
414 ol = gbt_var_node_cp_len((GBT_VARKEY *) DatumGetPointer(d), tinfo);
415 gbt_var_bin_union(&d, newe, collation, tinfo, flinfo);
416 ul = gbt_var_node_cp_len((GBT_VARKEY *) DatumGetPointer(d), tinfo);
420 dres = (ol - ul); /* reduction of common prefix len */
424 GBT_VARKEY_R uk = gbt_var_key_readable((GBT_VARKEY *) DatumGetPointer(d));
425 unsigned char tmp[4];
427 tmp[0] = (unsigned char) (((VARSIZE(ok.lower) - VARHDRSZ) <= ul) ? 0 : (VARDATA(ok.lower)[ul]));
428 tmp[1] = (unsigned char) (((VARSIZE(uk.lower) - VARHDRSZ) <= ul) ? 0 : (VARDATA(uk.lower)[ul]));
429 tmp[2] = (unsigned char) (((VARSIZE(ok.upper) - VARHDRSZ) <= ul) ? 0 : (VARDATA(ok.upper)[ul]));
430 tmp[3] = (unsigned char) (((VARSIZE(uk.upper) - VARHDRSZ) <= ul) ? 0 : (VARDATA(uk.upper)[ul]));
431 dres = Abs(tmp[0] - tmp[1]) + Abs(tmp[3] - tmp[2]);
436 *res += (float) (dres / ((double) (ol + 1)));
437 *res *= (FLT_MAX / (o->rel->rd_att->natts + 1));
445 gbt_vsrt_cmp(const void *a, const void *b, void *arg)
447 GBT_VARKEY_R ar = gbt_var_key_readable(((const Vsrt *) a)->t);
448 GBT_VARKEY_R br = gbt_var_key_readable(((const Vsrt *) b)->t);
449 const gbt_vsrt_arg *varg = (const gbt_vsrt_arg *) arg;
452 res = (*varg->tinfo->f_cmp) (ar.lower, br.lower, varg->collation, varg->flinfo);
454 return (*varg->tinfo->f_cmp) (ar.upper, br.upper, varg->collation, varg->flinfo);
460 gbt_var_picksplit(const GistEntryVector *entryvec, GIST_SPLITVEC *v,
461 Oid collation, const gbtree_vinfo *tinfo, FmgrInfo *flinfo)
464 maxoff = entryvec->n - 1;
469 GBT_VARKEY **sv = NULL;
472 arr = (Vsrt *) palloc((maxoff + 1) * sizeof(Vsrt));
473 nbytes = (maxoff + 2) * sizeof(OffsetNumber);
474 v->spl_left = (OffsetNumber *) palloc(nbytes);
475 v->spl_right = (OffsetNumber *) palloc(nbytes);
476 v->spl_ldatum = PointerGetDatum(0);
477 v->spl_rdatum = PointerGetDatum(0);
481 sv = palloc(sizeof(bytea *) * (maxoff + 1));
485 for (i = FirstOffsetNumber; i <= maxoff; i = OffsetNumberNext(i))
489 cur = (char *) DatumGetPointer(entryvec->vector[i].key);
490 ro = gbt_var_key_readable((GBT_VARKEY *) cur);
491 if (ro.lower == ro.upper) /* leaf */
493 sv[svcntr] = gbt_var_leaf2node((GBT_VARKEY *) cur, tinfo, flinfo);
494 arr[i].t = sv[svcntr];
495 if (sv[svcntr] != (GBT_VARKEY *) cur)
499 arr[i].t = (GBT_VARKEY *) cur;
505 varg.collation = collation;
506 varg.flinfo = flinfo;
507 qsort_arg((void *) &arr[FirstOffsetNumber],
508 maxoff - FirstOffsetNumber + 1,
513 /* We do simply create two parts */
515 for (i = FirstOffsetNumber; i <= maxoff; i = OffsetNumberNext(i))
517 if (i <= (maxoff - FirstOffsetNumber + 1) / 2)
519 gbt_var_bin_union(&v->spl_ldatum, arr[i].t, collation, tinfo, flinfo);
520 v->spl_left[v->spl_nleft] = arr[i].i;
525 gbt_var_bin_union(&v->spl_rdatum, arr[i].t, collation, tinfo, flinfo);
526 v->spl_right[v->spl_nright] = arr[i].i;
531 /* Truncate (=compress) key */
534 int32 ll = gbt_var_node_cp_len((GBT_VARKEY *) DatumGetPointer(v->spl_ldatum), tinfo);
535 int32 lr = gbt_var_node_cp_len((GBT_VARKEY *) DatumGetPointer(v->spl_rdatum), tinfo);
542 dl = gbt_var_node_truncate((GBT_VARKEY *) DatumGetPointer(v->spl_ldatum), ll, tinfo);
543 dr = gbt_var_node_truncate((GBT_VARKEY *) DatumGetPointer(v->spl_rdatum), ll, tinfo);
544 v->spl_ldatum = PointerGetDatum(dl);
545 v->spl_rdatum = PointerGetDatum(dr);
553 * The GiST consistent method
556 gbt_var_consistent(GBT_VARKEY_R *key,
558 StrategyNumber strategy,
561 const gbtree_vinfo *tinfo,
568 case BTLessEqualStrategyNumber:
570 retval = (*tinfo->f_ge) (query, key->lower, collation, flinfo);
572 retval = (*tinfo->f_cmp) (query, key->lower, collation, flinfo) >= 0
573 || gbt_var_node_pf_match(key, query, tinfo);
575 case BTLessStrategyNumber:
577 retval = (*tinfo->f_gt) (query, key->lower, collation, flinfo);
579 retval = (*tinfo->f_cmp) (query, key->lower, collation, flinfo) >= 0
580 || gbt_var_node_pf_match(key, query, tinfo);
582 case BTEqualStrategyNumber:
584 retval = (*tinfo->f_eq) (query, key->lower, collation, flinfo);
587 ((*tinfo->f_cmp) (key->lower, query, collation, flinfo) <= 0 &&
588 (*tinfo->f_cmp) (query, key->upper, collation, flinfo) <= 0) ||
589 gbt_var_node_pf_match(key, query, tinfo);
591 case BTGreaterStrategyNumber:
593 retval = (*tinfo->f_lt) (query, key->upper, collation, flinfo);
595 retval = (*tinfo->f_cmp) (query, key->upper, collation, flinfo) <= 0
596 || gbt_var_node_pf_match(key, query, tinfo);
598 case BTGreaterEqualStrategyNumber:
600 retval = (*tinfo->f_le) (query, key->upper, collation, flinfo);
602 retval = (*tinfo->f_cmp) (query, key->upper, collation, flinfo) <= 0
603 || gbt_var_node_pf_match(key, query, tinfo);
605 case BtreeGistNotEqualStrategyNumber:
606 retval = !((*tinfo->f_eq) (query, key->lower, collation, flinfo) &&
607 (*tinfo->f_eq) (query, key->upper, collation, flinfo));