rset/rsbool.c

   1 /* $Id: rsbool.c,v 1.41 2004-08-24 15:00:16 heikki Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
   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 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <assert.h>
  27
  28 #include <zebrautl.h>
  29 #include <rset.h>
  30 #include <rsbool.h>
  31
  32 #ifndef RSET_DEBUG
  33 #define RSET_DEBUG 0
  34 #endif
  35
  36 static RSFD r_open (RSET ct, int flag);
  37 static void r_close (RSFD rfd);
  38 static void r_delete (RSET ct);
  39 static void r_rewind (RSFD rfd);
  40 static int r_forward(RSET ct, RSFD rfd, void *buf,
  41                      int (*cmpfunc)(const void *p1, const void *p2),
  42                      const void *untilbuf);
  43 static void r_pos (RSFD rfd, double *current, double *total);
  44 static int r_read_and (RSFD rfd, void *buf);
  45 static int r_read_or (RSFD rfd, void *buf);
  46 static int r_read_not (RSFD rfd, void *buf);
  47 static int r_write (RSFD rfd, const void *buf);
  48
  49 static const struct rset_control control_and =
  50 {
  51     "and",
  52     r_open,
  53     r_close,
  54     r_delete,
  55     r_rewind,
  56     r_forward,
  57     r_pos,
  58     r_read_and,
  59     r_write,
  60 };
  61
  62 static const struct rset_control control_or =
  63 {
  64     "or",
  65     r_open,
  66     r_close,
  67     r_delete,
  68     r_rewind,
  69     r_forward,
  70     r_pos,
  71     r_read_or,
  72     r_write,
  73 };
  74
  75 static const struct rset_control control_not =
  76 {
  77     "not",
  78     r_open,
  79     r_close,
  80     r_delete,
  81     r_rewind,
  82     r_forward,
  83     r_pos,
  84     r_read_not,
  85     r_write,
  86 };
  87
  88
  89 const struct rset_control *rset_kind_and = &control_and;
  90 const struct rset_control *rset_kind_or = &control_or;
  91 const struct rset_control *rset_kind_not = &control_not;
  92
  93 struct rset_bool_info {
  94     int key_size;
  95     RSET rset_l;
  96     RSET rset_r;
  97     int (*cmp)(const void *p1, const void *p2);
  98     void (*log_item)(int logmask, const void *p, const char *txt);
  99     struct rset_bool_rfd *rfd_list;
 100 };
 101
 102 struct rset_bool_rfd {
 103     zint hits;
 104     RSFD rfd_l;
 105     RSFD rfd_r;
 106     int  more_l;
 107     int  more_r;
 108     void *buf_l;
 109     void *buf_r;
 110     int tail;
 111     struct rset_bool_rfd *next;
 112     struct rset_bool_info *info;
 113 };
 114
 115 static RSET rsbool_create_base( const struct rset_control *ctrl,
 116             NMEM nmem, int key_size,
 117             int (*cmp)(const void *p1, const void *p2),
 118             RSET rset_l, RSET rset_r,
 119             void (*log_item)(int logmask, const void *p, const char *txt) )
 120 {
 121     RSET rnew=rset_create_base(ctrl, nmem);
 122     struct rset_bool_info *info;
 123     info = (struct rset_bool_info *) nmem_malloc(rnew->nmem,sizeof(*info));
 124     info->key_size = key_size;
 125     info->rset_l = rset_l;
 126     info->rset_r = rset_r;
 127     info->cmp = cmp;
 128     info->log_item = log_item;
 129     info->rfd_list = NULL;
 130
 131     rnew->priv=info;
 132     return rnew;
 133 }
 134
 135
 136 RSET rsbool_create_and( NMEM nmem, int key_size,
 137             int (*cmp)(const void *p1, const void *p2),
 138             RSET rset_l, RSET rset_r,
 139             void (*log_item)(int logmask, const void *p, const char *txt) )
 140 {
 141     return rsbool_create_base(rset_kind_and, nmem, key_size, cmp,
 142                               rset_l, rset_r, log_item);
 143 }
 144
 145 RSET rsbool_create_or( NMEM nmem, int key_size,
 146             int (*cmp)(const void *p1, const void *p2),
 147             RSET rset_l, RSET rset_r,
 148             void (*log_item)(int logmask, const void *p, const char *txt) )
 149 {
 150     return rsbool_create_base(rset_kind_or, nmem, key_size, cmp,
 151                               rset_l, rset_r, log_item);
 152 }
 153
 154 RSET rsbool_create_not( NMEM nmem, int key_size,
 155             int (*cmp)(const void *p1, const void *p2),
 156             RSET rset_l, RSET rset_r,
 157             void (*log_item)(int logmask, const void *p, const char *txt) )
 158 {
 159     return rsbool_create_base(rset_kind_not, nmem, key_size, cmp,
 160                               rset_l, rset_r, log_item);
 161 }
 162
 163 static void r_delete (RSET ct)
 164 {
 165     struct rset_bool_info *info = (struct rset_bool_info *) ct->priv;
 166
 167     assert (info->rfd_list == NULL);
 168     rset_delete (info->rset_l);
 169     rset_delete (info->rset_r);
 170 }
 171
 172 #if 0
 173 static void *r_create (RSET ct, const struct rset_control *sel, void *parms)
 174 {
 175     rset_bool_parms *bool_parms = (rset_bool_parms *) parms;
 176     struct rset_bool_info *info;
 177
 178     info = (struct rset_bool_info *) xmalloc (sizeof(*info));
 179     info->key_size = bool_parms->key_size;
 180     info->rset_l = bool_parms->rset_l;
 181     info->rset_r = bool_parms->rset_r;
 182     info->cmp = bool_parms->cmp;
 183     info->log_item = bool_parms->log_item;
 184     info->rfd_list = NULL;
 185
 186     return info;
 187 }
 188 #endif
 189
 190 static RSFD r_open (RSET ct, int flag)
 191 {
 192     struct rset_bool_info *info = (struct rset_bool_info *) ct->priv;
 193     struct rset_bool_rfd *rfd;
 194
 195     if (flag & RSETF_WRITE)
 196     {
 197         logf (LOG_FATAL, "bool set type is read-only");
 198         return NULL;
 199     }
 200     rfd = (struct rset_bool_rfd *) nmem_malloc(ct->nmem, sizeof(*rfd));
 201     logf(LOG_DEBUG,"rsbool (%s) open [%p]", ct->control->desc, rfd);
 202     rfd->next = info->rfd_list;
 203     info->rfd_list = rfd;
 204     rfd->info = info;
 205     rfd->hits=0;
 206
 207     rfd->buf_l = nmem_malloc(ct->nmem, info->key_size);
 208     rfd->buf_r = nmem_malloc(ct->nmem, info->key_size);
 209     rfd->rfd_l = rset_open (info->rset_l, RSETF_READ);
 210     rfd->rfd_r = rset_open (info->rset_r, RSETF_READ);
 211     rfd->more_l = rset_read (info->rset_l, rfd->rfd_l, rfd->buf_l);
 212     rfd->more_r = rset_read (info->rset_r, rfd->rfd_r, rfd->buf_r);
 213     rfd->tail = 0;
 214     return rfd;
 215 }
 216
 217 static void r_close (RSFD rfd)
 218 {
 219     struct rset_bool_info *info = ((struct rset_bool_rfd*)rfd)->info;
 220     struct rset_bool_rfd **rfdp;
 221
 222     for (rfdp = &info->rfd_list; *rfdp; rfdp = &(*rfdp)->next)
 223         if (*rfdp == rfd)
 224         {
 225             rset_close (info->rset_l, (*rfdp)->rfd_l);
 226             rset_close (info->rset_r, (*rfdp)->rfd_r);
 227             *rfdp = (*rfdp)->next;
 228             return;
 229         }
 230     logf (LOG_FATAL, "r_close but no rfd match!");
 231     assert (0);
 232 }
 233
 234
 235 static void r_rewind (RSFD rfd)
 236 {
 237     struct rset_bool_info *info = ((struct rset_bool_rfd*)rfd)->info;
 238     struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
 239
 240     logf (LOG_DEBUG, "rsbool_rewind");
 241     rset_rewind (info->rset_l, p->rfd_l);
 242     rset_rewind (info->rset_r, p->rfd_r);
 243     p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 244     p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 245     p->hits=0;
 246 }
 247
 248 static int r_forward (RSET ct, RSFD rfd, void *buf,
 249                      int (*cmpfunc)(const void *p1, const void *p2),
 250                      const void *untilbuf)
 251 {
 252     struct rset_bool_info *info = ((struct rset_bool_rfd*)rfd)->info;
 253     struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
 254     int rc;
 255
 256 #if RSET_DEBUG
 257     logf (LOG_DEBUG, "rsbool_forward (L) [%p] '%s' (ct=%p rfd=%p m=%d,%d)",
 258                       rfd, ct->control->desc, ct, rfd, p->more_l, p->more_r);
 259 #endif
 260     if ( p->more_l && ((cmpfunc)(untilbuf,p->buf_l)==2) )
 261         p->more_l = rset_forward(info->rset_l, p->rfd_l, p->buf_l,
 262                         info->cmp, untilbuf);
 263 #if RSET_DEBUG
 264     logf (LOG_DEBUG, "rsbool_forward (R) [%p] '%s' (ct=%p rfd=%p m=%d,%d)",
 265                       rfd, ct->control->desc, ct, rfd, p->more_l, p->more_r);
 266 #endif
 267     if ( p->more_r && ((cmpfunc)(untilbuf,p->buf_r)==2))
 268         p->more_r = rset_forward(info->rset_r, p->rfd_r, p->buf_r,
 269                         info->cmp, untilbuf);
 270 #if RSET_DEBUG
 271     logf (LOG_DEBUG, "rsbool_forward [%p] calling read, m=%d,%d t=%d",
 272                        rfd, p->more_l, p->more_r, p->tail);
 273 #endif
 274
 275     p->tail=0;
 276     rc = rset_read(ct,rfd,buf);
 277 #if RSET_DEBUG
 278     logf (LOG_DEBUG, "rsbool_forward returning [%p] %d m=%d,%d",
 279                        rfd, rc, p->more_l, p->more_r);
 280 #endif
 281     return rc;
 282 }
 283
 284
 285 /*
 286     1,1         1,3
 287     1,9         2,1
 288     1,11        3,1
 289     2,9
 290
 291   1,1     1,1
 292   1,3     1,3
 293           1,9
 294           1,11
 295   2,1     2,1
 296           2,9
 297           3,1
 298 */
 299
 300 static int r_read_and (RSFD rfd, void *buf)
 301 {
 302     struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
 303     struct rset_bool_info *info = p->info;
 304
 305     while (p->more_l || p->more_r)
 306     {
 307         int cmp;
 308
 309         if (p->more_l && p->more_r)
 310             cmp = (*info->cmp)(p->buf_l, p->buf_r);
 311         else if (p->more_l)
 312             cmp = -2;
 313         else
 314             cmp = 2;
 315 #if RSET_DEBUG
 316         logf (LOG_DEBUG, "r_read_and [%p] looping: m=%d/%d c=%d t=%d",
 317                         rfd, p->more_l, p->more_r, cmp, p->tail);
 318         (*info->log_item)(LOG_DEBUG, p->buf_l, "left ");
 319         (*info->log_item)(LOG_DEBUG, p->buf_r, "right ");
 320 #endif
 321         if (!cmp)
 322         {
 323             memcpy (buf, p->buf_l, info->key_size);
 324             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 325             p->tail = 1;
 326         }
 327         else if (cmp == 1)
 328         {
 329             memcpy (buf, p->buf_r, info->key_size);
 330             p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 331             p->tail = 1;
 332 #if RSET_DEBUG
 333             logf (LOG_DEBUG, "r_read_and [%p] returning R m=%d/%d c=%d",
 334                     rfd, p->more_l, p->more_r, cmp);
 335             key_logdump(LOG_DEBUG,buf);
 336             (*info->log_item)(LOG_DEBUG, buf, "");
 337 #endif
 338             p->hits++;
 339             return 1;
 340         }
 341         else if (cmp == -1)
 342         {
 343             memcpy (buf, p->buf_l, info->key_size);
 344             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 345             p->tail = 1;
 346 #if RSET_DEBUG
 347             logf (LOG_DEBUG, "r_read_and [%p] returning L m=%d/%d c=%d",
 348                     rfd, p->more_l, p->more_r, cmp);
 349             (*info->log_item)(LOG_DEBUG, buf, "");
 350 #endif
 351             p->hits++;
 352             return 1;
 353         }
 354         else if (cmp > 1)  /* cmp == 2 */
 355         {
 356 #define OLDCODE 0
 357 #if OLDCODE
 358             memcpy (buf, p->buf_r, info->key_size);
 359
 360             p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 361             if (p->tail)
 362             {
 363                 if (!p->more_r || (*info->cmp)(p->buf_r, buf) > 1)
 364                     p->tail = 0;
 365 #if RSET_DEBUG
 366                 logf (LOG_DEBUG, "r_read_and returning C m=%d/%d c=%d",
 367                         p->more_l, p->more_r, cmp);
 368                 (*info->log_item)(LOG_DEBUG, buf, "");
 369 #endif
 370                 p->hits++;
 371                 return 1;
 372             }
 373 #else
 374
 375             if (p->tail)
 376             {
 377                 memcpy (buf, p->buf_r, info->key_size);
 378                 p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 379                 if (!p->more_r || (*info->cmp)(p->buf_r, buf) > 1)
 380                     p->tail = 0;
 381 #if RSET_DEBUG
 382                 logf (LOG_DEBUG, "r_read_and [%p] returning R tail m=%d/%d c=%d",
 383                         rfd, p->more_l, p->more_r, cmp);
 384                 (*info->log_item)(LOG_DEBUG, buf, "");
 385 #endif
 386                 p->hits++;
 387                 return 1;
 388             }
 389             else
 390             {
 391 #if RSET_DEBUG
 392                 logf (LOG_DEBUG, "r_read_and [%p] about to forward R m=%d/%d c=%d",
 393                         rfd, p->more_l, p->more_r, cmp);
 394 #endif
 395                 if (p->more_r && p->more_l)
 396                     p->more_r = rset_forward( info->rset_r, p->rfd_r,
 397                                     p->buf_r, (info->cmp), p->buf_l);
 398                 else
 399                     return 0; /* no point in reading further */
 400             }
 401 #endif
 402         }
 403         else  /* cmp == -2 */
 404         {
 405 #if OLDCODE
 406              memcpy (buf, p->buf_l, info->key_size);
 407              p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 408              if (p->tail)
 409              {
 410                  if (!p->more_l || (*info->cmp)(p->buf_l, buf) > 1)
 411                      p->tail = 0;
 412 #if RSET_DEBUG
 413                  logf (LOG_DEBUG, "r_read_and [%p] returning R tail m=%d/%d c=%d",
 414                         rfd, p->more_l, p->more_r, cmp);
 415                  (*info->log_item)(LOG_DEBUG, buf, "");
 416 #endif
 417                  p->hits++;
 418                  return 1;
 419              }
 420 #else
 421             if (p->tail)
 422             {
 423                 memcpy (buf, p->buf_l, info->key_size);
 424                 p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 425                 if (!p->more_l || (*info->cmp)(p->buf_l, buf) > 1)
 426                     p->tail = 0;
 427 #if RSET_DEBUG
 428                 logf (LOG_DEBUG, "r_read_and [%p] returning L tail m=%d/%d c=%d",
 429                         rfd, p->more_l, p->more_r, cmp);
 430                 (*info->log_item)(LOG_DEBUG, buf, "");
 431 #endif
 432                 p->hits++;
 433                 return 1;
 434             }
 435             else
 436             {
 437 #if RSET_DEBUG
 438                 logf (LOG_DEBUG, "r_read_and [%p] about to forward L m=%d/%d c=%d",
 439                         rfd, p->more_l, p->more_r, cmp);
 440 #endif
 441                 if (p->more_r && p->more_l)
 442                     p->more_l = rset_forward(
 443                                     info->rset_l, p->rfd_l,
 444                                     p->buf_l, (info->cmp), p->buf_r);
 445                 else
 446                     return 0; /* no point in reading further */
 447             }
 448 #endif
 449         }
 450     }
 451 #if RSET_DEBUG
 452     logf (LOG_DEBUG, "r_read_and [%p] reached its end",rfd);
 453 #endif
 454     return 0;
 455 }
 456
 457 static int r_read_or (RSFD rfd, void *buf)
 458 {
 459     struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
 460     struct rset_bool_info *info = p->info;
 461
 462     while (p->more_l || p->more_r)
 463     {
 464         int cmp;
 465
 466         if (p->more_l && p->more_r)
 467             cmp = (*info->cmp)(p->buf_l, p->buf_r);
 468         else if (p->more_r)
 469             cmp = 2;
 470         else
 471             cmp = -2;
 472         if (!cmp)
 473         {
 474             memcpy (buf, p->buf_l, info->key_size);
 475             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 476             p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 477 #if RSET_DEBUG
 478             logf (LOG_DEBUG, "r_read_or returning A m=%d/%d c=%d",
 479                     p->more_l, p->more_r, cmp);
 480             (*info->log_item)(LOG_DEBUG, buf, "");
 481 #endif
 482             p->hits++;
 483             return 1;
 484         }
 485         else if (cmp > 0)
 486         {
 487             memcpy (buf, p->buf_r, info->key_size);
 488             p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 489 #if RSET_DEBUG
 490             logf (LOG_DEBUG, "r_read_or returning B m=%d/%d c=%d",
 491                     p->more_l, p->more_r, cmp);
 492             (*info->log_item)(LOG_DEBUG, buf, "");
 493 #endif
 494             p->hits++;
 495             return 1;
 496         }
 497         else
 498         {
 499             memcpy (buf, p->buf_l, info->key_size);
 500             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 501 #if RSET_DEBUG
 502             logf (LOG_DEBUG, "r_read_or returning C m=%d/%d c=%d",
 503                     p->more_l, p->more_r, cmp);
 504             (*info->log_item)(LOG_DEBUG, buf, "");
 505 #endif
 506             p->hits++;
 507             return 1;
 508         }
 509     }
 510     return 0;
 511 }
 512
 513 static int r_read_not (RSFD rfd, void *buf)
 514 {
 515     struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
 516     struct rset_bool_info *info = p->info;
 517
 518     while (p->more_l || p->more_r)
 519     {
 520         int cmp;
 521
 522         if (p->more_l && p->more_r)
 523             cmp = (*info->cmp)(p->buf_l, p->buf_r);
 524         else if (p->more_r)
 525             cmp = 2;
 526         else
 527             cmp = -2;
 528         if (cmp < -1)
 529         {
 530             memcpy (buf, p->buf_l, info->key_size);
 531             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 532             p->hits++;
 533             return 1;
 534         }
 535         else if (cmp > 1)
 536         {
 537                 p->more_r = rset_forward(
 538                     info->rset_r, p->rfd_r,
 539                     p->buf_r, (info->cmp), p->buf_l);
 540         }
 541         else
 542         {
 543             memcpy (buf, p->buf_l, info->key_size);
 544             do
 545             {
 546                 p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 547                 if (!p->more_l)
 548                     break;
 549                 cmp = (*info->cmp)(p->buf_l, buf);
 550             } while (cmp >= -1 && cmp <= 1);
 551             do
 552             {
 553                 p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 554                 if (!p->more_r)
 555                     break;
 556                 cmp = (*info->cmp)(p->buf_r, buf);
 557             } while (cmp >= -1 && cmp <= 1);
 558         }
 559     }
 560     return 0;
 561 }
 562
 563
 564 static int r_write (RSFD rfd, const void *buf)
 565 {
 566     logf (LOG_FATAL, "bool set type is read-only");
 567     return -1;
 568 }
 569
 570 static void r_pos (RSFD rfd, double *current, double *total)
 571 {
 572     struct rset_bool_rfd *p = (struct rset_bool_rfd *) rfd;
 573     struct rset_bool_info *info = p->info;
 574     double lcur,ltot;
 575     double rcur,rtot;
 576     double r;
 577     ltot=-1; rtot=-1;
 578     rset_pos(info->rset_l, p->rfd_l,  &lcur, &ltot);
 579     rset_pos(info->rset_r, p->rfd_r,  &rcur, &rtot);
 580     if ( (rtot<0) && (ltot<0)) { /*no position */
 581         *current=rcur;  /* return same as you got */
 582         *total=rtot;    /* probably -1 for not available */
 583     }
 584     if ( rtot<0) { rtot=0; rcur=0;} /* if only one useful, use it */
 585     if ( ltot<0) { ltot=0; lcur=0;}
 586     if ( rtot+ltot < 1 ) { /* empty rset */
 587         *current=0;
 588         *total=0;
 589         return;
 590     }
 591     r=1.0*(lcur+rcur)/(ltot+rtot); /* weighed average of l and r */
 592     *current=(double) (p->hits);
 593     *total=*current/r ;
 594 #if RSET_DEBUG
 595     yaz_log(LOG_DEBUG,"bool_pos: (%s/%s) %0.1f/%0.1f= %0.4f ",
 596                     info->rset_l->control->desc, info->rset_r->control->desc,
 597                     *current, *total, r);
 598 #endif
 599 }