rset/rsmultiandor.c

   1 /* $Id: rsmultiandor.c,v 1.22 2006-07-04 10:25:22 adam Exp $
   2    Copyright (C) 1995-2006
   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  * \file rsmultiandor.c
  26  * \brief This module implements the rsmulti_or and rsmulti_and result sets
  27  *
  28  * rsmultior is based on a heap, from which we find the next hit.
  29  *
  30  * rsmultiand is based on a simple array of rsets, and a linear
  31  * search to find the record that exists in all of those rsets.
  32  * To speed things up, the array is sorted so that the smallest
  33  * rsets come first, they are most likely to have the hits furthest
  34  * away, and thus forwarding to them makes the most sense.
  35  */
  36
  37
  38 #include <assert.h>
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42
  43 #include <idzebra/util.h>
  44 #include <idzebra/isamc.h>
  45 #include <rset.h>
  46
  47 static RSFD r_open_and (RSET ct, int flag);
  48 static RSFD r_open_or (RSET ct, int flag);
  49 static void r_close (RSFD rfd);
  50 static void r_delete (RSET ct);
  51 static int r_read_and (RSFD rfd, void *buf, TERMID *term);
  52 static int r_read_or (RSFD rfd, void *buf, TERMID *term);
  53 static int r_write (RSFD rfd, const void *buf);
  54 static int r_forward_and(RSFD rfd, void *buf, TERMID *term,
  55                      const void *untilbuf);
  56 static int r_forward_or(RSFD rfd, void *buf, TERMID *term,
  57                      const void *untilbuf);
  58 static void r_pos (RSFD rfd, double *current, double *total);
  59 static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm);
  60
  61 static const struct rset_control control_or =
  62 {
  63     "multi-or",
  64     r_delete,
  65     r_get_terms,
  66     r_open_or,
  67     r_close,
  68     r_forward_or,
  69     r_pos,
  70     r_read_or,
  71     r_write,
  72 };
  73
  74 static const struct rset_control control_and =
  75 {
  76     "multi-and",
  77     r_delete,
  78     r_get_terms,
  79     r_open_and,
  80     r_close,
  81     r_forward_and,
  82     r_pos,
  83     r_read_and,
  84     r_write,
  85 };
  86
  87 /* The heap structure:
  88  * The rset contains a list or rsets we are ORing together
  89  * The rfd contains a heap of heap-items, which contain
  90  * a rfd opened to those rsets, and a buffer for one key.
  91  * They also contain a ptr to the rset list in the rset
  92  * itself, for practical reasons.
  93  */
  94
  95 struct heap_item {
  96     RSFD fd;
  97     void *buf;
  98     RSET rset;
  99     TERMID term;
 100 };
 101
 102 struct heap {
 103     int heapnum;
 104     int heapmax;
 105     const struct rset_key_control *kctrl;
 106     struct heap_item **heap; /* ptrs to the rfd */
 107 };
 108 typedef struct heap *HEAP;
 109
 110
 111 struct rset_private {
 112     int dummy;
 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 /** \brief deletes the first item in the heap, and balances the rest
 169  */
 170 static void heap_delete (HEAP h)
 171 {
 172     int cur = 1, child = 2;
 173     h->heap[1] = 0; /* been deleted */
 174     heap_swap (h, 1, h->heapnum--);
 175     while (child <= h->heapnum) {
 176         if (child < h->heapnum && heap_cmp(h,child,1+child)>0 )
 177             child++;
 178         if (heap_cmp(h,cur,child) > 0)
 179         {
 180             heap_swap (h, cur, child);
 181             cur = child;
 182             child = 2*cur;
 183         }
 184         else
 185             break;
 186     }
 187 }
 188
 189 /** \brief puts item into heap.
 190     The heap root element has changed value (to bigger)
 191     Swap downwards until the heap is ordered again
 192 */
 193 static void heap_balance (HEAP h)
 194 {
 195     int cur = 1, child = 2;
 196     while (child <= h->heapnum) {
 197         if (child < h->heapnum && heap_cmp(h,child,1+child)>0 )
 198             child++;
 199         if (heap_cmp(h,cur,child) > 0)
 200         {
 201             heap_swap (h, cur, child);
 202             cur = child;
 203             child = 2*cur;
 204         }
 205         else
 206             break;
 207     }
 208 }
 209
 210
 211 static void heap_insert (HEAP h, struct heap_item *hi)
 212 {
 213     int cur, parent;
 214
 215     cur = ++(h->heapnum);
 216     assert(cur <= h->heapmax);
 217     h->heap[cur] = hi;
 218     parent = cur/2;
 219     while (parent && (heap_cmp(h,parent,cur) > 0))
 220     {
 221         assert(parent>0);
 222         heap_swap (h, cur, parent);
 223         cur = parent;
 224         parent = cur/2;
 225     }
 226 }
 227
 228
 229 static
 230 HEAP heap_create (NMEM nmem, int size, const struct rset_key_control *kctrl)
 231 {
 232     HEAP h = (HEAP) nmem_malloc (nmem, sizeof(*h));
 233
 234     ++size; /* heap array starts at 1 */
 235     h->heapnum = 0;
 236     h->heapmax = size;
 237     h->kctrl = kctrl;
 238     h->heap = (struct heap_item**) nmem_malloc(nmem,size*sizeof(*h->heap));
 239     h->heap[0]=0; /* not used */
 240     return h;
 241 }
 242
 243 static void heap_clear( HEAP h)
 244 {
 245     assert(h);
 246     h->heapnum = 0;
 247 }
 248
 249 static void heap_destroy (HEAP h)
 250 {
 251     /* nothing to delete, all is nmem'd, and will go away in due time */
 252 }
 253
 254 /** \brief compare and items for quicksort
 255     used in qsort to get the multi-and args in optimal order
 256     that is, those with fewest occurrences first
 257 */
 258 int compare_ands(const void *x, const void *y)
 259 {   const struct heap_item *hx = x;
 260     const struct heap_item *hy = y;
 261     double cur, totx, toty;
 262     rset_pos(hx->fd, &cur, &totx);
 263     rset_pos(hy->fd, &cur, &toty);
 264     if ( totx > toty +0.5 )
 265         return 1;
 266     if ( totx < toty -0.5 )
 267         return -1;
 268     return 0;  /* return totx - toty, except for overflows and rounding */
 269 }
 270
 271 static RSET rsmulti_andor_create(NMEM nmem,
 272                                  struct rset_key_control *kcontrol,
 273                                  int scope, TERMID termid,
 274                                  int no_rsets, RSET* rsets,
 275                                  const struct rset_control *ctrl)
 276 {
 277     RSET rnew = rset_create_base(ctrl, nmem, kcontrol, scope, termid,
 278                                  no_rsets, rsets);
 279     struct rset_private *info;
 280     if (!log_level_initialized)
 281     {
 282         log_level = yaz_log_module_level("rsmultiandor");
 283         log_level_initialized = 1;
 284     }
 285     yaz_log(log_level, "rsmultiand_andor_create scope=%d", scope);
 286     info = (struct rset_private *) nmem_malloc(rnew->nmem, sizeof(*info));
 287     rnew->priv = info;
 288     return rnew;
 289 }
 290
 291 RSET rset_create_or(NMEM nmem, struct rset_key_control *kcontrol,
 292                     int scope, TERMID termid, int no_rsets, RSET* rsets)
 293 {
 294     return rsmulti_andor_create(nmem, kcontrol, scope, termid,
 295                                 no_rsets, rsets, &control_or);
 296 }
 297
 298 RSET rset_create_and(NMEM nmem, struct rset_key_control *kcontrol,
 299                      int scope, int no_rsets, RSET* rsets)
 300 {
 301     return rsmulti_andor_create(nmem, kcontrol, scope, 0,
 302                                 no_rsets, rsets, &control_and);
 303 }
 304
 305 static void r_delete (RSET ct)
 306 {
 307 }
 308
 309 static RSFD r_open_andor (RSET ct, int flag, int is_and)
 310 {
 311     RSFD rfd;
 312     struct rfd_private *p;
 313     const struct rset_key_control *kctrl = ct->keycontrol;
 314     int i;
 315
 316     if (flag & RSETF_WRITE)
 317     {
 318         yaz_log (YLOG_FATAL, "multiandor set type is read-only");
 319         return NULL;
 320     }
 321     rfd = rfd_create_base(ct);
 322     if (rfd->priv) {
 323         p = (struct rfd_private *)rfd->priv;
 324         if (!is_and)
 325             heap_clear(p->h);
 326         assert(p->items);
 327         /* all other pointers shouls already be allocated, in right sizes! */
 328     }
 329     else
 330     {
 331         p = (struct rfd_private *) nmem_malloc (ct->nmem,sizeof(*p));
 332         rfd->priv = p;
 333         p->h = 0;
 334         p->tailbits = 0;
 335         if (is_and)
 336             p->tailbits = nmem_malloc(ct->nmem, ct->no_children*sizeof(char) );
 337         else
 338             p->h = heap_create( ct->nmem, ct->no_children, kctrl);
 339         p->items = (struct heap_item *)
 340             nmem_malloc(ct->nmem, ct->no_children*sizeof(*p->items));
 341         for (i = 0; i<ct->no_children; i++)
 342         {
 343             p->items[i].rset = ct->children[i];
 344             p->items[i].buf = nmem_malloc(ct->nmem, kctrl->key_size);
 345         }
 346     }
 347     p->flag = flag;
 348     p->hits = 0;
 349     p->eof = 0;
 350     p->tailcount = 0;
 351     if (is_and)
 352     { /* read the array and sort it */
 353         for (i = 0; i<ct->no_children; i++){
 354             p->items[i].fd = rset_open(ct->children[i], RSETF_READ);
 355             if (!rset_read(p->items[i].fd, p->items[i].buf, &p->items[i].term))
 356                 p->eof = 1;
 357             p->tailbits[i] = 0;
 358         }
 359         qsort(p->items, ct->no_children, sizeof(p->items[0]), compare_ands);
 360     }
 361     else
 362     { /* fill the heap for ORing */
 363         for (i = 0; i<ct->no_children; i++){
 364             p->items[i].fd = rset_open(ct->children[i],RSETF_READ);
 365             if ( rset_read(p->items[i].fd, p->items[i].buf, &p->items[i].term))
 366                 heap_insert(p->h, &(p->items[i]));
 367         }
 368     }
 369     return rfd;
 370 }
 371
 372 static RSFD r_open_or (RSET ct, int flag)
 373 {
 374     return r_open_andor(ct, flag, 0);
 375 }
 376
 377 static RSFD r_open_and (RSET ct, int flag)
 378 {
 379     return r_open_andor(ct, flag, 1);
 380 }
 381
 382
 383 static void r_close (RSFD rfd)
 384 {
 385     struct rfd_private *p=(struct rfd_private *)(rfd->priv);
 386     int i;
 387
 388     if (p->h)
 389         heap_destroy (p->h);
 390     for (i = 0; i<rfd->rset->no_children; i++)
 391         if (p->items[i].fd)
 392             rset_close(p->items[i].fd);
 393 }
 394
 395 static int r_forward_or(RSFD rfd, void *buf,
 396                         TERMID *term, const void *untilbuf)
 397 { /* while heap head behind untilbuf, forward it and rebalance heap */
 398     struct rfd_private *p = rfd->priv;
 399     const struct rset_key_control *kctrl = rfd->rset->keycontrol;
 400     if (heap_empty(p->h))
 401         return 0;
 402     while ( (*kctrl->cmp)(p->h->heap[1]->buf,untilbuf) < -rfd->rset->scope )
 403     {
 404         if (rset_forward(p->h->heap[1]->fd,p->h->heap[1]->buf,
 405                          &p->h->heap[1]->term, untilbuf))
 406             heap_balance(p->h);
 407         else
 408         {
 409             heap_delete(p->h);
 410             if (heap_empty(p->h))
 411                 return 0;
 412         }
 413
 414     }
 415     return r_read_or(rfd, buf, term);
 416 }
 417
 418
 419 /** \brief reads one item key from an 'or' set
 420     \param rfd set handle
 421     \param buf resulting item buffer
 422     \param term resulting term
 423     \retval 0 EOF
 424     \retval 1 item could be read
 425 */
 426 static int r_read_or (RSFD rfd, void *buf, TERMID *term)
 427 {
 428     RSET rset = rfd->rset;
 429     struct rfd_private *mrfd = rfd->priv;
 430     const struct rset_key_control *kctrl = rset->keycontrol;
 431     struct heap_item *it;
 432     int rdres;
 433     if (heap_empty(mrfd->h))
 434         return 0;
 435     it = mrfd->h->heap[1];
 436     memcpy(buf, it->buf, kctrl->key_size);
 437     if (term)
 438     {
 439         if (rset->term)
 440             *term = rset->term;
 441         else
 442             *term = it->term;
 443         assert(*term);
 444     }
 445     (mrfd->hits)++;
 446     rdres = rset_read(it->fd, it->buf, &it->term);
 447     if ( rdres )
 448         heap_balance(mrfd->h);
 449     else
 450         heap_delete(mrfd->h);
 451     return 1;
 452
 453 }
 454
 455 /** \brief reads one item key from an 'and' set
 456     \param rfd set handle
 457     \param buf resulting item buffer
 458     \param term resulting term
 459     \retval 0 EOF
 460     \retval 1 item could be read
 461
 462     Has to return all hits where each item points to the
 463     same sysno (scope), in order. Keep an extra key (hitkey)
 464     as long as all records do not point to hitkey, forward
 465     them, and update hitkey to be the highest seen so far.
 466     (if any item eof's, mark eof, and return 0 thereafter)
 467     Once a hit has been found, scan all items for the smallest
 468     value. Mark all as being in the tail. Read next from that
 469     item, and if not in the same record, clear its tail bit
 470 */
 471 static int r_read_and (RSFD rfd, void *buf, TERMID *term)
 472 {   struct rfd_private *p = rfd->priv;
 473     RSET ct = rfd->rset;
 474     const struct rset_key_control *kctrl = ct->keycontrol;
 475     int i, mintail;
 476     int cmp;
 477
 478     while (1) {
 479         if (p->tailcount)
 480         { /* we are tailing, find lowest tail and return it */
 481             mintail = 0;
 482             while ((mintail<ct->no_children) && !p->tailbits[mintail])
 483                 mintail++; /* first tail */
 484             for (i = mintail+1; i<ct->no_children; i++)
 485             {
 486                 if (p->tailbits[i])
 487                 {
 488                     cmp=(*kctrl->cmp)(p->items[i].buf,p->items[mintail].buf);
 489                     if (cmp<0)
 490                         mintail = i;
 491                 }
 492             }
 493             /* return the lowest tail */
 494             memcpy(buf, p->items[mintail].buf, kctrl->key_size);
 495             if (term)
 496                 *term = p->items[mintail].term;
 497             if (!rset_read(p->items[mintail].fd, p->items[mintail].buf,
 498                            &p->items[mintail].term))
 499             {
 500                 p->eof = 1; /* game over, once tails have been returned */
 501                 p->tailbits[mintail] = 0;
 502                 (p->tailcount)--;
 503                 (p->hits)++;
 504                 return 1;
 505             }
 506             /* still a tail? */
 507             cmp = (*kctrl->cmp)(p->items[mintail].buf,buf);
 508             if (cmp >= rfd->rset->scope){
 509                 p->tailbits[mintail] = 0;
 510                 (p->tailcount)--;
 511             }
 512             (p->hits)++;
 513             return 1;
 514         }
 515         /* not tailing, forward until all reocrds match, and set up */
 516         /* as tails. the earlier 'if' will then return the hits */
 517         if (p->eof)
 518             return 0; /* nothing more to see */
 519         i = 1; /* assume items[0] is highest up */
 520         while (i<ct->no_children) {
 521             cmp = (*kctrl->cmp)(p->items[0].buf, p->items[i].buf);
 522             if (cmp <= -rfd->rset->scope) { /* [0] was behind, forward it */
 523                 if (!rset_forward(p->items[0].fd, p->items[0].buf,
 524                                   &p->items[0].term, p->items[i].buf))
 525                 {
 526                     p->eof = 1; /* game over */
 527                     return 0;
 528                 }
 529                 i = 0; /* start frowarding from scratch */
 530             }
 531             else if (cmp>=rfd->rset->scope)
 532             { /* [0] was ahead, forward i */
 533                 if (!rset_forward(p->items[i].fd, p->items[i].buf,
 534                                   &p->items[i].term, p->items[0].buf))
 535                 {
 536                     p->eof = 1; /* game over */
 537                     return 0;
 538                 }
 539             }
 540             else
 541                 i++;
 542         } /* while i */
 543         /* if we get this far, all rsets are now within +- scope of [0] */
 544         /* ergo, we have a hit. Mark them all as tailing, and let the */
 545         /* upper 'if' return the hits in right order */
 546         for (i = 0; i<ct->no_children; i++)
 547             p->tailbits[i] = 1;
 548         p->tailcount = ct->no_children;
 549     } /* while 1 */
 550 }
 551
 552
 553 static int r_forward_and(RSFD rfd, void *buf, TERMID *term,
 554                          const void *untilbuf)
 555 {
 556     struct rfd_private *p = rfd->priv;
 557     RSET ct = rfd->rset;
 558     const struct rset_key_control *kctrl = ct->keycontrol;
 559     int i;
 560     int cmp;
 561     int killtail = 0;
 562
 563     for (i = 0; i<ct->no_children; i++)
 564     {
 565         cmp = (*kctrl->cmp)(p->items[i].buf,untilbuf);
 566         if (cmp <= -rfd->rset->scope)
 567         {
 568             killtail = 1; /* we are moving to a different hit */
 569             if (!rset_forward(p->items[i].fd, p->items[i].buf,
 570                               &p->items[i].term, untilbuf))
 571             {
 572                 p->eof = 1; /* game over */
 573                 p->tailcount = 0;
 574                 return 0;
 575             }
 576         }
 577     }
 578     if (killtail)
 579     {
 580         for (i = 0; i<ct->no_children; i++)
 581             p->tailbits[i] = 0;
 582         p->tailcount = 0;
 583     }
 584     return r_read_and(rfd,buf,term);
 585 }
 586
 587 static void r_pos (RSFD rfd, double *current, double *total)
 588 {
 589     RSET ct = rfd->rset;
 590     struct rfd_private *mrfd =
 591         (struct rfd_private *)(rfd->priv);
 592     double cur, tot;
 593     double scur = 0.0, stot = 0.0;
 594     int i;
 595     for (i = 0; i<ct->no_children; i++){
 596         rset_pos(mrfd->items[i].fd, &cur, &tot);
 597         yaz_log(log_level, "r_pos: %d %0.1f %0.1f", i, cur,tot);
 598         scur += cur;
 599         stot += tot;
 600     }
 601     if (stot < 1.0) { /* nothing there */
 602         *current = 0;
 603         *total = 0;
 604         yaz_log(log_level, "r_pos: NULL  %0.1f %0.1f",  *current, *total);
 605     }
 606     else
 607     {
 608         *current = (double) (mrfd->hits);
 609         *total = *current*stot/scur;
 610         yaz_log(log_level, "r_pos: =  %0.1f %0.1f",  *current, *total);
 611     }
 612 }
 613
 614 static int r_write (RSFD rfd, const void *buf)
 615 {
 616     yaz_log (YLOG_FATAL, "multior set type is read-only");
 617     return -1;
 618 }
 619
 620 static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm)
 621 {
 622     if (ct->term)
 623         rset_get_one_term(ct, terms, maxterms, curterm);
 624     else
 625     {
 626         /* Special case: Some multi-ors have all terms pointing to the same
 627            term. We do not want to duplicate those. Other multiors (and ands)
 628            have different terms under them. Those we want.
 629         */
 630         int firstterm= *curterm;
 631         int i;
 632
 633         for (i = 0; i<ct->no_children; i++)
 634         {
 635             rset_getterms(ct->children[i], terms, maxterms, curterm);
 636             if ( ( *curterm > firstterm+1 ) &&
 637                  ( *curterm <= maxterms ) &&
 638                  ( terms[(*curterm)-1] == terms[firstterm] )
 639                 )
 640                 (*curterm)--; /* forget the term, seen that before */
 641         }
 642     }
 643 }
 644
 645
 646 /*
 647  * Local variables:
 648  * c-basic-offset: 4
 649  * indent-tabs-mode: nil
 650  * End:
 651  * vim: shiftwidth=4 tabstop=8 expandtab
 652  */
 653