rset/rset.c

   1 /* $Id: rset.c,v 1.40 2004-11-19 10:27:14 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
  24
  25 #include <stdio.h>
  26 #include <string.h>
  27 #include <zebrautl.h>
  28 #include <assert.h>
  29 #include <yaz/nmem.h>
  30 #include <rset.h>
  31
  32 static int log_level=0;
  33 static int log_level_initialized=0;
  34
  35 /**
  36  * creates an rfd. Either allocates a new one, in which case the priv
  37  * pointer is null, and will have to be filled in, or picks up one
  38  * from the freelist, in which case the priv is already allocated,
  39  * and presumably everything that hangs from it as well
  40  */
  41
  42 RSFD rfd_create_base(RSET rs)
  43 {
  44     if (!log_level_initialized)
  45     {
  46         log_level=yaz_log_module_level("rset");
  47         log_level_initialized=1;
  48     }
  49
  50     RSFD rnew=rs->free_list;
  51     if (rnew)
  52     {
  53         rs->free_list=rnew->next;
  54         assert(rnew->rset==rs);
  55         yaz_log(log_level,"rfd-create_base (fl): rfd=%p rs=%p fl=%p priv=%p",
  56                        rnew, rs, rs->free_list, rnew->priv);
  57     } else {
  58         rnew=nmem_malloc(rs->nmem, sizeof(*rnew));
  59         rnew->priv=NULL;
  60         rnew->rset=rs;
  61         yaz_log(log_level,"rfd_create_base (new): rfd=%p rs=%p fl=%p priv=%p",
  62                        rnew, rs, rs->free_list, rnew->priv);
  63     }
  64     rnew->next=NULL; /* not part of any (free?) list */
  65     return rnew;
  66 }
  67
  68 /* puts an rfd into the freelist of the rset. Only when the rset gets */
  69 /* deleted, will all the nmem disappear */
  70 void rfd_delete_base(RSFD rfd)
  71 {
  72     RSET rs=rfd->rset;
  73     yaz_log(log_level,"rfd_delete_base: rfd=%p rs=%p priv=%p fl=%p",
  74             rfd, rs, rfd->priv, rs->free_list);
  75     assert(NULL == rfd->next);
  76     rfd->next=rs->free_list;
  77     rs->free_list=rfd;
  78 }
  79
  80
  81 RSET rset_create_base(const struct rset_control *sel,
  82                       NMEM nmem, const struct key_control *kcontrol,
  83                       int scope, TERMID term)
  84 {
  85     RSET rnew;
  86     NMEM M;
  87     /* assert(nmem); */ /* can not yet be used, api/t4 fails */
  88     if (nmem)
  89         M=nmem;
  90     else
  91         M=nmem_create();
  92     rnew = (RSET) nmem_malloc(M,sizeof(*rnew));
  93     yaz_log (log_level, "rs_create(%s) rs=%p (nm=%p)", sel->desc, rnew, nmem);
  94     rnew->nmem=M;
  95     if (nmem)
  96         rnew->my_nmem=0;
  97     else
  98         rnew->my_nmem=1;
  99     rnew->control = sel;
 100     rnew->count = 1; /* refcount! */
 101     rnew->priv = 0;
 102     rnew->free_list=NULL;
 103     rnew->keycontrol=kcontrol;
 104     rnew->scope=scope;
 105     rnew->term=term;
 106     if (term)
 107         term->rset=rnew;
 108     return rnew;
 109 }
 110
 111 void rset_delete (RSET rs)
 112 {
 113     (rs->count)--;
 114     yaz_log(log_level,"rs_delete(%s), rs=%p, count=%d",
 115             rs->control->desc, rs, rs->count);
 116     if (!rs->count)
 117     {
 118         (*rs->control->f_delete)(rs);
 119         if (rs->my_nmem)
 120             nmem_destroy(rs->nmem);
 121     }
 122 }
 123
 124 RSET rset_dup (RSET rs)
 125 {
 126     (rs->count)++;
 127     yaz_log(log_level,"rs_dup(%s), rs=%p, count=%d",
 128             rs->control->desc, rs, rs->count);
 129     return rs;
 130 }
 131
 132 int rset_default_forward(RSFD rfd, void *buf, TERMID *term,
 133                            const void *untilbuf)
 134 {
 135     int more=1;
 136     int cmp=rfd->rset->scope;
 137     if (log_level)
 138     {
 139         yaz_log (log_level, "rset_default_forward starting '%s' (ct=%p rfd=%p)",
 140                     rfd->rset->control->desc, rfd->rset, rfd);
 141         /* key_logdump(log_level, untilbuf); */
 142     }
 143     while ( (cmp>=rfd->rset->scope) && (more))
 144     {
 145         if (log_level)  /* time-critical, check first */
 146             yaz_log(log_level,"rset_default_forward looping m=%d c=%d",more,cmp);
 147         more=rset_read(rfd, buf, term);
 148         if (more)
 149             cmp=(rfd->rset->keycontrol->cmp)(untilbuf,buf);
 150 /*        if (more)
 151             key_logdump(log_level,buf); */
 152     }
 153     if (log_level)
 154         yaz_log (log_level, "rset_default_forward exiting m=%d c=%d",more,cmp);
 155
 156     return more;
 157 }
 158
 159 /**
 160  * rset_count uses rset_pos to get the total and returns that.
 161  * This is ok for rsisamb/c/s, and for some other rsets, but in case of
 162  * booleans etc it will give bad estimate, as nothing has been read
 163  * from that rset
 164  */
 165 zint rset_count(RSET rs)
 166 {
 167     double cur,tot;
 168     RSFD rfd=rset_open(rs,0);
 169     rset_pos(rfd,&cur,&tot);
 170     rset_close(rfd);
 171     return (zint)(tot);
 172 }
 173
 174
 175 /** rset_get_no_terms is a getterms function for those that don't have any */
 176 void rset_get_no_terms(RSET ct, TERMID *terms, int maxterms, int *curterm)
 177 {
 178     return;
 179 }
 180
 181 /* rset_get_one_term gets that one term from an rset. Used by rsisamX */
 182 void rset_get_one_term(RSET ct,TERMID *terms,int maxterms,int *curterm)
 183 {
 184     if (ct->term)
 185     {
 186         if (*curterm < maxterms)
 187             terms[*curterm]=ct->term;
 188         (*curterm)++;
 189     }
 190 }
 191
 192
 193 TERMID rset_term_create (const char *name, int length, const char *flags,
 194                                     int type, NMEM nmem)
 195
 196 {
 197     TERMID t;
 198     yaz_log (log_level, "term_create '%s' %d f=%s type=%d nmem=%p",
 199             name, length, flags, type, nmem);
 200     t= (TERMID) nmem_malloc (nmem, sizeof(*t));
 201     if (!name)
 202         t->name = NULL;
 203     else if (length == -1)
 204         t->name = nmem_strdup(nmem,name);
 205     else
 206     {
 207         t->name = (char*) nmem_malloc(nmem,length+1);
 208         memcpy (t->name, name, length);
 209         t->name[length] = '\0';
 210     }
 211     if (!flags)
 212         t->flags = NULL;
 213     else
 214         t->flags = nmem_strdup(nmem,flags);
 215     t->type = type;
 216     t->rankpriv=0;
 217     t->rset=0;
 218     return t;
 219 }
 220
 221