1 /* $Id: rsmultiandor.c,v 1.6 2004-10-15 10:07:34 heikki Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
5 This file is part of the Zebra server.
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
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
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
25 * This module implements the rsmultior and rsmultiand result sets
27 * rsmultior is based on a heap, from which we find the next hit.
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.
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);
59 static const struct rset_control control_or =
70 static const struct rset_control control_and =
82 const struct rset_control *rset_kind_multior = &control_or;
83 const struct rset_control *rset_kind_multiand = &control_and;
85 /* The heap structure:
86 * The rset contains a list or rsets we are ORing together
87 * The rfd contains a heap of heap-items, which contain
88 * a rfd opened to those rsets, and a buffer for one key.
89 * They also contain a ptr to the rset list in the rset
90 * itself, for practical reasons.
103 const struct key_control *kctrl;
104 struct heap_item **heap; /* ptrs to the rfd */
106 typedef struct heap *HEAP;
109 struct rset_multiandor_info {
115 struct rset_multiandor_rfd {
117 struct heap_item *items; /* we alloc and free them here */
118 HEAP h; /* and move around here */
119 zint hits; /* returned so far */
120 int eof; /* seen the end of it */
121 int tailcount; /* how many items are tailing */
125 /* Heap functions ***********************/
128 static void heap_dump_item( HEAP h, int i, int level) {
132 (void)rset_pos(h->heap[i]->rset,h->heap[i]->fd, &cur, &tot);
133 logf(LOG_LOG," %d %*s i=%p buf=%p %0.1f/%0.1f",i, level, "",
134 &(h->heap[i]), h->heap[i]->buf, cur,tot );
135 heap_dump_item(h, 2*i, level+1);
136 heap_dump_item(h, 2*i+1, level+1);
138 static void heap_dump( HEAP h,char *msg) {
139 logf(LOG_LOG, "heap dump: %s num=%d max=%d",msg, h->heapnum, h->heapmax);
140 heap_dump_item(h,1,1);
144 static void heap_swap (HEAP h, int x, int y)
146 struct heap_item *swap;
148 h->heap[x]=h->heap[y];
152 static int heap_cmp(HEAP h, int x, int y)
154 return (*h->kctrl->cmp)(h->heap[x]->buf,h->heap[y]->buf);
157 static int heap_empty(HEAP h)
159 return ( 0==h->heapnum );
162 static void heap_delete (HEAP h)
163 { /* deletes the first item in the heap, and balances the rest */
164 int cur = 1, child = 2;
165 h->heap[1]=0; /* been deleted */
166 heap_swap (h, 1, h->heapnum--);
167 while (child <= h->heapnum) {
168 if (child < h->heapnum && heap_cmp(h,child,1+child)>0 )
170 if (heap_cmp(h,cur,child) > 0)
172 heap_swap (h, cur, child);
181 static void heap_balance (HEAP h)
182 { /* The heap root element has changed value (to bigger) */
183 /* swap downwards until the heap is ordered again */
184 int cur = 1, child = 2;
185 while (child <= h->heapnum) {
186 if (child < h->heapnum && heap_cmp(h,child,1+child)>0 )
188 if (heap_cmp(h,cur,child) > 0)
190 heap_swap (h, cur, child);
200 static void heap_insert (HEAP h, struct heap_item *hi)
204 cur = ++(h->heapnum);
205 assert(cur <= h->heapmax);
208 while (parent && (heap_cmp(h,parent,cur) > 0))
211 heap_swap (h, cur, parent);
219 HEAP heap_create (NMEM nmem, int size, const struct key_control *kctrl)
221 HEAP h = (HEAP) nmem_malloc (nmem, sizeof(*h));
223 ++size; /* heap array starts at 1 */
227 h->heap = (struct heap_item**) nmem_malloc(nmem,size*sizeof(*h->heap));
228 h->heap[0]=0; /* not used */
232 static void heap_clear( HEAP h)
238 static void heap_destroy (HEAP h)
240 /* nothing to delete, all is nmem'd, and will go away in due time */
243 int compare_ands(const void *x, const void *y)
244 { /* used in qsort to get the multi-and args in optimal order */
245 /* that is, those with fewest occurrences first */
246 const struct heap_item *hx=x;
247 const struct heap_item *hy=y;
248 double cur, totx, toty;
249 rset_pos(hx->fd, &cur, &totx);
250 rset_pos(hy->fd, &cur, &toty);
251 if ( totx > toty +0.5 ) return 1;
252 if ( totx < toty -0.5 ) return -1;
253 return 0; /* return totx - toty, except for overflows and rounding */
256 /* Creating and deleting rsets ***********************/
258 static RSET rsmulti_andor_create( NMEM nmem, const struct key_control *kcontrol,
259 int scope, int no_rsets, RSET* rsets,
260 const struct rset_control *ctrl)
262 RSET rnew=rset_create_base(ctrl, nmem,kcontrol, scope,0);
263 struct rset_multiandor_info *info;
264 info = (struct rset_multiandor_info *) nmem_malloc(rnew->nmem,sizeof(*info));
265 info->no_rsets=no_rsets;
266 info->rsets=(RSET*)nmem_malloc(rnew->nmem, no_rsets*sizeof(*rsets));
267 memcpy(info->rsets,rsets,no_rsets*sizeof(*rsets));
272 RSET rsmultior_create( NMEM nmem, const struct key_control *kcontrol, int scope,
273 int no_rsets, RSET* rsets)
275 return rsmulti_andor_create(nmem, kcontrol, scope,
276 no_rsets, rsets, &control_or);
279 RSET rsmultiand_create( NMEM nmem, const struct key_control *kcontrol, int scope,
280 int no_rsets, RSET* rsets)
282 return rsmulti_andor_create(nmem, kcontrol, scope,
283 no_rsets, rsets, &control_and);
286 static void r_delete (RSET ct)
288 struct rset_multiandor_info *info = (struct rset_multiandor_info *) ct->priv;
290 for(i=0;i<info->no_rsets;i++)
291 rset_delete(info->rsets[i]);
295 /* Opening and closing fd's on them *********************/
297 static RSFD r_open_andor (RSET ct, int flag, int is_and)
300 struct rset_multiandor_rfd *p;
301 struct rset_multiandor_info *info = (struct rset_multiandor_info *) ct->priv;
302 const struct key_control *kctrl = ct->keycontrol;
305 if (flag & RSETF_WRITE)
307 logf (LOG_FATAL, "multiandor set type is read-only");
310 rfd=rfd_create_base(ct);
312 p=(struct rset_multiandor_rfd *)rfd->priv;
316 /* all other pointers shouls already be allocated, in right sizes! */
319 p = (struct rset_multiandor_rfd *) nmem_malloc (ct->nmem,sizeof(*p));
324 p->tailbits=nmem_malloc(ct->nmem, info->no_rsets*sizeof(char) );
326 p->h = heap_create( ct->nmem, info->no_rsets, kctrl);
327 p->items=(struct heap_item *) nmem_malloc(ct->nmem,
328 info->no_rsets*sizeof(*p->items));
329 for (i=0; i<info->no_rsets; i++){
330 p->items[i].rset=info->rsets[i];
331 p->items[i].buf=nmem_malloc(ct->nmem,kctrl->key_size);
339 { /* read the array and sort it */
340 for (i=0; i<info->no_rsets; i++){
341 p->items[i].fd=rset_open(info->rsets[i],RSETF_READ);
342 if (!rset_read(p->items[i].fd, p->items[i].buf, &p->items[i].term))
346 qsort(p->items, info->no_rsets, sizeof(p->items[0]), compare_ands);
348 { /* fill the heap for ORing */
349 for (i=0; i<info->no_rsets; i++){
350 p->items[i].fd=rset_open(info->rsets[i],RSETF_READ);
351 if ( rset_read(p->items[i].fd, p->items[i].buf, &p->items[i].term))
352 heap_insert(p->h, &(p->items[i]));
358 static RSFD r_open_or (RSET ct, int flag)
360 return r_open_andor(ct, flag, 0);
363 static RSFD r_open_and (RSET ct, int flag)
365 return r_open_andor(ct, flag, 1);
369 static void r_close (RSFD rfd)
371 struct rset_multiandor_info *info=
372 (struct rset_multiandor_info *)(rfd->rset->priv);
373 struct rset_multiandor_rfd *p=(struct rset_multiandor_rfd *)(rfd->priv);
378 for (i = 0; i<info->no_rsets; i++)
380 rset_close(p->items[i].fd);
381 rfd_delete_base(rfd);
386 static int r_forward_or(RSFD rfd, void *buf,
387 TERMID *term,const void *untilbuf)
388 { /* while heap head behind untilbuf, forward it and rebalance heap */
389 struct rset_multiandor_rfd *p=rfd->priv;
390 const struct key_control *kctrl=rfd->rset->keycontrol;
391 if (heap_empty(p->h))
393 while ( (*kctrl->cmp)(p->h->heap[1]->buf,untilbuf) < -rfd->rset->scope )
395 if (rset_forward(p->h->heap[1]->fd,p->h->heap[1]->buf,
396 &p->h->heap[1]->term, untilbuf))
401 if (heap_empty(p->h))
406 return r_read_or(rfd,buf,term);
410 static int r_read_or (RSFD rfd, void *buf, TERMID *term)
412 struct rset_multiandor_rfd *mrfd=rfd->priv;
413 const struct key_control *kctrl=rfd->rset->keycontrol;
414 struct heap_item *it;
416 if (heap_empty(mrfd->h))
418 it = mrfd->h->heap[1];
419 memcpy(buf,it->buf, kctrl->key_size);
423 rdres=rset_read(it->fd, it->buf, &it->term);
425 heap_balance(mrfd->h);
427 heap_delete(mrfd->h);
432 static int r_read_and (RSFD rfd, void *buf, TERMID *term)
433 { /* Has to return all hits where each item points to the */
434 /* same sysno (scope), in order. Keep an extra key (hitkey) */
435 /* as long as all records do not point to hitkey, forward */
436 /* them, and update hitkey to be the highest seen so far. */
437 /* (if any item eof's, mark eof, and return 0 thereafter) */
438 /* Once a hit has been found, scan all items for the smallest */
439 /* value. Mark all as being in the tail. Read next from that */
440 /* item, and if not in the same record, clear its tail bit */
441 struct rset_multiandor_rfd *p=rfd->priv;
442 const struct key_control *kctrl=rfd->rset->keycontrol;
443 struct rset_multiandor_info *info=rfd->rset->priv;
449 { /* we are tailing, find lowest tail and return it */
451 while ((mintail<info->no_rsets) && !p->tailbits[mintail])
452 mintail++; /* first tail */
453 for (i=mintail+1;i<info->no_rsets;i++)
457 cmp=(*kctrl->cmp)(p->items[i].buf,p->items[mintail].buf);
462 /* return the lowest tail */
463 memcpy(buf, p->items[mintail].buf, kctrl->key_size);
465 *term=p->items[mintail].term;
466 if (!rset_read(p->items[mintail].fd, p->items[mintail].buf,
467 &p->items[mintail].term))
469 p->eof=1; /* game over, once tails have been returned */
470 p->tailbits[mintail]=0;
475 cmp=(*kctrl->cmp)(p->items[mintail].buf,buf);
476 if (cmp >= rfd->rset->scope){
477 p->tailbits[mintail]=0;
482 /* not tailing, forward until all reocrds match, and set up */
483 /* as tails. the earlier 'if' will then return the hits */
485 return 0; /* nothing more to see */
486 i=1; /* assume items[0] is highest up */
487 while (i<info->no_rsets) {
488 cmp=(*kctrl->cmp)(p->items[0].buf,p->items[i].buf);
489 if (cmp<=-rfd->rset->scope) { /* [0] was behind, forward it */
490 if (!rset_forward(p->items[0].fd, p->items[0].buf,
491 &p->items[0].term, p->items[i].buf))
493 p->eof=1; /* game over */
496 i=0; /* start frowarding from scratch */
497 } else if (cmp>=rfd->rset->scope)
498 { /* [0] was ahead, forward i */
499 if (!rset_forward(p->items[i].fd, p->items[i].buf,
500 &p->items[i].term, p->items[0].buf))
502 p->eof=1; /* game over */
508 /* if we get this far, all rsets are now within +- scope of [0] */
509 /* ergo, we have a hit. Mark them all as tailing, and let the */
510 /* upper 'if' return the hits in right order */
511 for (i=0; i<info->no_rsets;i++)
513 p->tailcount=info->no_rsets;
518 static int r_forward_and(RSFD rfd, void *buf, TERMID *term,
519 const void *untilbuf)
521 struct rset_multiandor_rfd *p=rfd->priv;
522 const struct key_control *kctrl=rfd->rset->keycontrol;
523 struct rset_multiandor_info *info=rfd->rset->priv;
528 for (i=0; i<info->no_rsets;i++)
530 cmp=(*kctrl->cmp)(p->items[i].buf,untilbuf);
531 if ( cmp <= -rfd->rset->scope )
533 killtail=1; /* we are moving to a different hit */
534 if (!rset_forward(p->items[i].fd, p->items[i].buf,
535 &p->items[i].term, untilbuf))
537 p->eof=1; /* game over */
545 for (i=0; i<info->no_rsets;i++)
549 return r_read_and(rfd,buf,term);
552 static void r_pos (RSFD rfd, double *current, double *total)
554 struct rset_multiandor_info *info=
555 (struct rset_multiandor_info *)(rfd->rset->priv);
556 struct rset_multiandor_rfd *mrfd=(struct rset_multiandor_rfd *)(rfd->priv);
558 double scur=0.0, stot=0.0;
560 for (i=0; i<info->no_rsets; i++){
561 rset_pos(mrfd->items[i].fd, &cur, &tot);
562 logf(LOG_DEBUG, "r_pos: %d %0.1f %0.1f", i, cur,tot);
566 if (stot <1.0) { /* nothing there */
572 *total=*current*stot/scur;
577 static int r_write (RSFD rfd, const void *buf)
579 logf (LOG_FATAL, "multior set type is read-only");