rset/rsmultiandor.c

   1 /* $Id: rsmultiandor.c,v 1.18 2005-05-18 11:47:50 adam Exp $
   2    Copyright (C) 1995-2005
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23
  24 /*
  25  * This module implements the rsmulti_or and rsmulti_and result sets
  26  *
  27  * rsmultior is based on a heap, from which we find the next hit.
  28  *
  29  * rsmultiand is based on a simple array of rsets, and a linear
  30  * search to find the record that exists in all of those rsets.
  31  * To speed things up, the array is sorted so that the smallest
  32  * rsets come first, they are most likely to have the hits furthest
  33  * away, and thus forwarding to them makes the most sense.
  34  */
  35
  36
  37 #include <assert.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41
  42 #include <idzebra/util.h>
  43 #include <idzebra/isamc.h>
  44 #include <rset.h>
  45
  46 static RSFD r_open_and (RSET ct, int flag);
  47 static RSFD r_open_or (RSET ct, int flag);
  48 static void r_close (RSFD rfd);
  49 static void r_delete (RSET ct);
  50 static int r_read_and (RSFD rfd, void *buf, TERMID *term);
  51 static int r_read_or (RSFD rfd, void *buf, TERMID *term);
  52 static int r_write (RSFD rfd, const void *buf);
  53 static int r_forward_and(RSFD rfd, void *buf, TERMID *term,
  54                      const void *untilbuf);
  55 static int r_forward_or(RSFD rfd, void *buf, TERMID *term,
  56                      const void *untilbuf);
  57 static void r_pos (RSFD rfd, double *current, double *total);
  58 static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm);
  59
  60 static const struct rset_control control_or =
  61 {
  62     "multi-or",
  63     r_delete,
  64     r_get_terms,
  65     r_open_or,
  66     r_close,
  67     r_forward_or,
  68     r_pos,
  69     r_read_or,
  70     r_write,
  71 };
  72
  73 static const struct rset_control control_and =
  74 {
  75     "multi-and",
  76     r_delete,
  77     r_get_terms,
  78     r_open_and,
  79     r_close,
  80     r_forward_and,
  81     r_pos,
  82     r_read_and,
  83     r_write,
  84 };
  85
  86 /* The heap structure:
  87  * The rset contains a list or rsets we are ORing together
  88  * The rfd contains a heap of heap-items, which contain
  89  * a rfd opened to those rsets, and a buffer for one key.
  90  * They also contain a ptr to the rset list in the rset
  91  * itself, for practical reasons.
  92  */
  93
  94 struct heap_item {
  95     RSFD fd;
  96     void *buf;
  97     RSET rset;
  98     TERMID term;
  99 };
 100
 101 struct heap {
 102     int heapnum;
 103     int heapmax;
 104     const struct rset_key_control *kctrl;
 105     struct heap_item **heap; /* ptrs to the rfd */
 106 };
 107 typedef struct heap *HEAP;
 108
 109
 110 struct rset_private {
 111     int     no_rsets;
 112     RSET    *rsets;
 113 };
 114
 115
 116 struct rfd_private {
 117     int flag;
 118     struct heap_item *items; /* we alloc and free them here */
 119     HEAP h; /* and move around here */
 120     zint hits; /* returned so far */
 121     int eof; /* seen the end of it */
 122     int tailcount; /* how many items are tailing */
 123     char *tailbits;
 124 };
 125
 126 static int log_level = 0;
 127 static int log_level_initialized = 0;
 128
 129
 130 /* Heap functions ***********************/
 131
 132 #if 0
 133 static void heap_dump_item( HEAP h, int i, int level)
 134 {
 135     double cur,tot;
 136     if (i>h->heapnum)
 137         return;
 138     (void)rset_pos(h->heap[i]->rset,h->heap[i]->fd, &cur, &tot);
 139     yaz_log(log_level," %d %*s i=%p buf=%p %0.1f/%0.1f",i, level, "",
 140                     &(h->heap[i]), h->heap[i]->buf, cur,tot );
 141     heap_dump_item(h, 2*i, level+1);
 142     heap_dump_item(h, 2*i+1, level+1);
 143 }
 144 static void heap_dump( HEAP h,char *msg) {
 145     yaz_log(log_level, "heap dump: %s num=%d max=%d",msg, h->heapnum, h->heapmax);
 146     heap_dump_item(h,1,1);
 147 }
 148 #endif
 149
 150 static void heap_swap (HEAP h, int x, int y)
 151 {
 152     struct heap_item *swap;
 153     swap = h->heap[x];
 154     h->heap[x] = h->heap[y];
 155     h->heap[y] = swap;
 156 }
 157
 158 static int heap_cmp(HEAP h, int x, int y)
 159 {
 160     return (*h->kctrl->cmp)(h->heap[x]->buf,h->heap[y]->buf);
 161 }
 162
 163 static int heap_empty(HEAP h)
 164 {
 165     return ( 0==h->heapnum );
 166 }
 167
 168 static void heap_delete (HEAP h)
 169 { /* deletes the first item in the heap, and balances the rest */
 170     int cur = 1, child = 2;
 171     h->heap[1] = 0; /* been deleted */
 172     heap_swap (h, 1, h->heapnum--);
 173     while (child <= h->heapnum) {
 174         if (child < h->heapnum && heap_cmp(h,child,1+child)>0 )
 175             child++;
 176         if (heap_cmp(h,cur,child) > 0)
 177         {
 178             heap_swap (h, cur, child);
 179             cur = child;
 180             child = 2*cur;
 181         }
 182         else
 183             break;
 184     }
 185 }
 186
 187 static void heap_balance (HEAP h)
 188 { /* The heap root element has changed value (to bigger) */
 189   /* swap downwards until the heap is ordered again */
 190     int cur = 1, child = 2;
 191     while (child <= h->heapnum) {
 192         if (child < h->heapnum && heap_cmp(h,child,1+child)>0 )
 193             child++;
 194         if (heap_cmp(h,cur,child) > 0)
 195         {
 196             heap_swap (h, cur, child);
 197             cur = child;
 198             child = 2*cur;
 199         }
 200         else
 201             break;
 202     }
 203 }
 204
 205
 206 static void heap_insert (HEAP h, struct heap_item *hi)
 207 {
 208     int cur, parent;
 209
 210     cur = ++(h->heapnum);
 211     assert(cur <= h->heapmax);
 212     h->heap[cur] = hi;
 213     parent = cur/2;
 214     while (parent && (heap_cmp(h,parent,cur) > 0))
 215     {
 216         assert(parent>0);
 217         heap_swap (h, cur, parent);
 218         cur = parent;
 219         parent = cur/2;
 220     }
 221 }
 222
 223
 224 static
 225 HEAP heap_create (NMEM nmem, int size, const struct rset_key_control *kctrl)
 226 {
 227     HEAP h = (HEAP) nmem_malloc (nmem, sizeof(*h));
 228
 229     ++size; /* heap array starts at 1 */
 230     h->heapnum = 0;
 231     h->heapmax = size;
 232     h->kctrl = kctrl;
 233     h->heap = (struct heap_item**) nmem_malloc(nmem,size*sizeof(*h->heap));
 234     h->heap[0]=0; /* not used */
 235     return h;
 236 }
 237
 238 static void heap_clear( HEAP h)
 239 {
 240     assert(h);
 241     h->heapnum = 0;
 242 }
 243
 244 static void heap_destroy (HEAP h)
 245 {
 246     /* nothing to delete, all is nmem'd, and will go away in due time */
 247 }
 248
 249 int compare_ands(const void *x, const void *y)
 250 { /* used in qsort to get the multi-and args in optimal order */
 251   /* that is, those with fewest occurrences first */
 252     const struct heap_item *hx = x;
 253     const struct heap_item *hy = y;
 254     double cur, totx, toty;
 255     rset_pos(hx->fd, &cur, &totx);
 256     rset_pos(hy->fd, &cur, &toty);
 257     if ( totx > toty +0.5 )
 258         return 1;
 259     if ( totx < toty -0.5 )
 260         return -1;
 261     return 0;  /* return totx - toty, except for overflows and rounding */
 262 }
 263
 264 /* Creating and deleting rsets ***********************/
 265
 266 static RSET rsmulti_andor_create(NMEM nmem,
 267                                  struct rset_key_control *kcontrol,
 268                                  int scope, int no_rsets, RSET* rsets,
 269                                  const struct rset_control *ctrl)
 270 {
 271     RSET rnew = rset_create_base(ctrl, nmem, kcontrol, scope, 0);
 272     struct rset_private *info;
 273     if (!log_level_initialized)
 274     {
 275         log_level = yaz_log_module_level("rsmultiandor");
 276         log_level_initialized = 1;
 277     }
 278     yaz_log(log_level, "rsmultiand_andor_create scope=%d", scope);
 279     info = (struct rset_private *) nmem_malloc(rnew->nmem,sizeof(*info));
 280     info->no_rsets = no_rsets;
 281     info->rsets = (RSET*)nmem_malloc(rnew->nmem, no_rsets*sizeof(*rsets));
 282     memcpy(info->rsets,rsets,no_rsets*sizeof(*rsets));
 283     rnew->priv = info;
 284     return rnew;
 285 }
 286
 287 RSET rsmulti_or_create(NMEM nmem, struct rset_key_control *kcontrol,
 288                        int scope, int no_rsets, RSET* rsets)
 289 {
 290     return rsmulti_andor_create(nmem, kcontrol, scope,
 291                                 no_rsets, rsets, &control_or);
 292 }
 293
 294 RSET rsmulti_and_create(NMEM nmem, struct rset_key_control *kcontrol,
 295                         int scope, int no_rsets, RSET* rsets)
 296 {
 297     return rsmulti_andor_create(nmem, kcontrol, scope,
 298                                 no_rsets, rsets, &control_and);
 299 }
 300
 301 static void r_delete (RSET ct)
 302 {
 303     struct rset_private *info = (struct rset_private *) ct->priv;
 304     int i;
 305     for(i = 0; i<info->no_rsets; i++)
 306         rset_delete(info->rsets[i]);
 307 }
 308
 309
 310 /* Opening and closing fd's on them *********************/
 311
 312 static RSFD r_open_andor (RSET ct, int flag, int is_and)
 313 {
 314     RSFD rfd;
 315     struct rfd_private *p;
 316     struct rset_private *info = (struct rset_private *) ct->priv;
 317     const struct rset_key_control *kctrl = ct->keycontrol;
 318     int i;
 319
 320     if (flag & RSETF_WRITE)
 321     {
 322         yaz_log (YLOG_FATAL, "multiandor set type is read-only");
 323         return NULL;
 324     }
 325     rfd = rfd_create_base(ct);
 326     if (rfd->priv) {
 327         p = (struct rfd_private *)rfd->priv;
 328         if (!is_and)
 329             heap_clear(p->h);
 330         assert(p->items);
 331         /* all other pointers shouls already be allocated, in right sizes! */
 332     }
 333     else {
 334         p = (struct rfd_private *) nmem_malloc (ct->nmem,sizeof(*p));
 335         rfd->priv = p;
 336         p->h = 0;
 337         p->tailbits = 0;
 338         if (is_and)
 339             p->tailbits = nmem_malloc(ct->nmem, info->no_rsets*sizeof(char) );
 340         else
 341             p->h = heap_create( ct->nmem, info->no_rsets, kctrl);
 342         p->items=(struct heap_item *) nmem_malloc(ct->nmem,
 343                               info->no_rsets*sizeof(*p->items));
 344         for (i = 0; i<info->no_rsets; i++)
 345         {
 346             p->items[i].rset = info->rsets[i];
 347             p->items[i].buf = nmem_malloc(ct->nmem, kctrl->key_size);
 348         }
 349     }
 350     p->flag = flag;
 351     p->hits = 0;
 352     p->eof = 0;
 353     p->tailcount = 0;
 354     if (is_and)
 355     { /* read the array and sort it */
 356         for (i = 0; i<info->no_rsets; i++){
 357             p->items[i].fd = rset_open(info->rsets[i],RSETF_READ);
 358             if (!rset_read(p->items[i].fd, p->items[i].buf, &p->items[i].term))
 359                 p->eof = 1;
 360             p->tailbits[i] = 0;
 361         }
 362         qsort(p->items, info->no_rsets, sizeof(p->items[0]), compare_ands);
 363     } else
 364     { /* fill the heap for ORing */
 365         for (i = 0; i<info->no_rsets; i++){
 366             p->items[i].fd = rset_open(info->rsets[i],RSETF_READ);
 367             if ( rset_read(p->items[i].fd, p->items[i].buf, &p->items[i].term))
 368                 heap_insert(p->h, &(p->items[i]));
 369         }
 370     }
 371     return rfd;
 372 }
 373
 374 static RSFD r_open_or (RSET ct, int flag)
 375 {
 376     return r_open_andor(ct, flag, 0);
 377 }
 378
 379 static RSFD r_open_and (RSET ct, int flag)
 380 {
 381     return r_open_andor(ct, flag, 1);
 382 }
 383
 384
 385 static void r_close (RSFD rfd)
 386 {
 387     struct rset_private *info=
 388         (struct rset_private *)(rfd->rset->priv);
 389     struct rfd_private *p=(struct rfd_private *)(rfd->priv);
 390     int i;
 391
 392     if (p->h)
 393         heap_destroy (p->h);
 394     for (i = 0; i<info->no_rsets; i++)
 395         if (p->items[i].fd)
 396             rset_close(p->items[i].fd);
 397     rfd_delete_base(rfd);
 398 }
 399
 400
 401
 402 static int r_forward_or(RSFD rfd, void *buf,
 403                         TERMID *term,const void *untilbuf)
 404 { /* while heap head behind untilbuf, forward it and rebalance heap */
 405     struct rfd_private *p = rfd->priv;
 406     const struct rset_key_control *kctrl = rfd->rset->keycontrol;
 407     if (heap_empty(p->h))
 408         return 0;
 409     while ( (*kctrl->cmp)(p->h->heap[1]->buf,untilbuf) < -rfd->rset->scope )
 410     {
 411         if (rset_forward(p->h->heap[1]->fd,p->h->heap[1]->buf,
 412                          &p->h->heap[1]->term, untilbuf))
 413             heap_balance(p->h);
 414         else
 415         {
 416             heap_delete(p->h);
 417             if (heap_empty(p->h))
 418                 return 0;
 419         }
 420
 421     }
 422     return r_read_or(rfd,buf,term);
 423 }
 424
 425
 426 static int r_read_or (RSFD rfd, void *buf, TERMID *term)
 427 {
 428     struct rfd_private *mrfd = rfd->priv;
 429     const struct rset_key_control *kctrl = rfd->rset->keycontrol;
 430     struct heap_item *it;
 431     int rdres;
 432     if (heap_empty(mrfd->h))
 433         return 0;
 434     it = mrfd->h->heap[1];
 435     memcpy(buf,it->buf, kctrl->key_size);
 436     if (term)
 437         *term = it->term;
 438     (mrfd->hits)++;
 439     rdres = rset_read(it->fd, it->buf, &it->term);
 440     if ( rdres )
 441         heap_balance(mrfd->h);
 442     else
 443         heap_delete(mrfd->h);
 444     return 1;
 445
 446 }
 447
 448 static int r_read_and (RSFD rfd, void *buf, TERMID *term)
 449 { /* Has to return all hits where each item points to the */
 450   /* same sysno (scope), in order. Keep an extra key (hitkey) */
 451   /* as long as all records do not point to hitkey, forward */
 452   /* them, and update hitkey to be the highest seen so far. */
 453   /* (if any item eof's, mark eof, and return 0 thereafter) */
 454   /* Once a hit has been found, scan all items for the smallest */
 455   /* value. Mark all as being in the tail. Read next from that */
 456   /* item, and if not in the same record, clear its tail bit */
 457     struct rfd_private *p = rfd->priv;
 458     const struct rset_key_control *kctrl = rfd->rset->keycontrol;
 459     struct rset_private *info = rfd->rset->priv;
 460     int i, mintail;
 461     int cmp;
 462
 463     while (1) {
 464         if (p->tailcount)
 465         { /* we are tailing, find lowest tail and return it */
 466             mintail = 0;
 467             while ((mintail<info->no_rsets) && !p->tailbits[mintail])
 468                 mintail++; /* first tail */
 469             for (i = mintail+1; i<info->no_rsets; i++)
 470             {
 471                 if (p->tailbits[i])
 472                 {
 473                     cmp=(*kctrl->cmp)(p->items[i].buf,p->items[mintail].buf);
 474                     if (cmp<0)
 475                         mintail = i;
 476                 }
 477             }
 478             /* return the lowest tail */
 479             memcpy(buf, p->items[mintail].buf, kctrl->key_size);
 480             if (term)
 481                 *term = p->items[mintail].term;
 482             if (!rset_read(p->items[mintail].fd, p->items[mintail].buf,
 483                            &p->items[mintail].term))
 484             {
 485                 p->eof = 1; /* game over, once tails have been returned */
 486                 p->tailbits[mintail]=0;
 487                 (p->tailcount)--;
 488                 (p->hits)++;
 489                 return 1;
 490             }
 491             /* still a tail? */
 492             cmp=(*kctrl->cmp)(p->items[mintail].buf,buf);
 493             if (cmp >= rfd->rset->scope){
 494                 p->tailbits[mintail]=0;
 495                 (p->tailcount)--;
 496             }
 497             (p->hits)++;
 498             return 1;
 499         }
 500         /* not tailing, forward until all reocrds match, and set up */
 501         /* as tails. the earlier 'if' will then return the hits */
 502         if (p->eof)
 503             return 0; /* nothing more to see */
 504         i = 1; /* assume items[0] is highest up */
 505         while (i<info->no_rsets) {
 506             cmp=(*kctrl->cmp)(p->items[0].buf,p->items[i].buf);
 507             if (cmp<=-rfd->rset->scope) { /* [0] was behind, forward it */
 508                 if (!rset_forward(p->items[0].fd, p->items[0].buf,
 509                                   &p->items[0].term, p->items[i].buf))
 510                 {
 511                     p->eof = 1; /* game over */
 512                     return 0;
 513                 }
 514                 i = 0; /* start frowarding from scratch */
 515             } else if (cmp>=rfd->rset->scope)
 516             { /* [0] was ahead, forward i */
 517                 if (!rset_forward(p->items[i].fd, p->items[i].buf,
 518                                   &p->items[i].term, p->items[0].buf))
 519                 {
 520                     p->eof = 1; /* game over */
 521                     return 0;
 522                 }
 523             } else
 524                 i++;
 525         } /* while i */
 526         /* if we get this far, all rsets are now within +- scope of [0] */
 527         /* ergo, we have a hit. Mark them all as tailing, and let the */
 528         /* upper 'if' return the hits in right order */
 529         for (i = 0; i<info->no_rsets; i++)
 530             p->tailbits[i] = 1;
 531         p->tailcount = info->no_rsets;
 532     } /* while 1 */
 533 }
 534
 535
 536 static int r_forward_and(RSFD rfd, void *buf, TERMID *term,
 537                          const void *untilbuf)
 538 {
 539     struct rfd_private *p = rfd->priv;
 540     const struct rset_key_control *kctrl = rfd->rset->keycontrol;
 541     struct rset_private *info = rfd->rset->priv;
 542     int i;
 543     int cmp;
 544     int killtail = 0;
 545
 546     for (i = 0; i<info->no_rsets; i++)
 547     {
 548         cmp = (*kctrl->cmp)(p->items[i].buf,untilbuf);
 549         if (cmp <= -rfd->rset->scope)
 550         {
 551             killtail = 1; /* we are moving to a different hit */
 552             if (!rset_forward(p->items[i].fd, p->items[i].buf,
 553                               &p->items[i].term, untilbuf))
 554             {
 555                 p->eof = 1; /* game over */
 556                 p->tailcount = 0;
 557                 return 0;
 558             }
 559         }
 560     }
 561     if (killtail)
 562     {
 563         for (i = 0; i<info->no_rsets; i++)
 564             p->tailbits[i] = 0;
 565         p->tailcount = 0;
 566     }
 567     return r_read_and(rfd,buf,term);
 568 }
 569
 570 static void r_pos (RSFD rfd, double *current, double *total)
 571 {
 572     struct rset_private *info =
 573         (struct rset_private *)(rfd->rset->priv);
 574     struct rfd_private *mrfd =
 575         (struct rfd_private *)(rfd->priv);
 576     double cur, tot;
 577     double scur = 0.0, stot = 0.0;
 578     int i;
 579     for (i = 0; i<info->no_rsets; i++){
 580         rset_pos(mrfd->items[i].fd, &cur, &tot);
 581         yaz_log(log_level, "r_pos: %d %0.1f %0.1f", i, cur,tot);
 582         scur += cur;
 583         stot += tot;
 584     }
 585     if (stot < 1.0) { /* nothing there */
 586         *current = 0;
 587         *total = 0;
 588         yaz_log(log_level, "r_pos: NULL  %0.1f %0.1f",  *current, *total);
 589     }
 590     else
 591     {
 592         *current = (double) (mrfd->hits);
 593         *total = *current*stot/scur;
 594         yaz_log(log_level, "r_pos: =  %0.1f %0.1f",  *current, *total);
 595     }
 596 }
 597
 598 static int r_write (RSFD rfd, const void *buf)
 599 {
 600     yaz_log (YLOG_FATAL, "multior set type is read-only");
 601     return -1;
 602 }
 603
 604 static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm)
 605     /* Special case: Some multi-ors have all terms pointing to the same */
 606     /* term. We do not want to duplicate those. Other multiors (and ands) */
 607     /* have different terms under them. Those we want. */
 608 {
 609     struct rset_private *info =
 610         (struct rset_private *) ct->priv;
 611     int firstterm= *curterm;
 612     int i;
 613     for (i = 0; i<info->no_rsets; i++)
 614     {
 615         rset_getterms(info->rsets[i], terms, maxterms, curterm);
 616         if ( ( *curterm > firstterm+1 ) &&
 617              ( *curterm <= maxterms ) &&
 618              ( terms[(*curterm)-1] == terms[firstterm] )
 619             )
 620             (*curterm)--; /* forget the term, seen that before */
 621     }
 622 }
 623
 624