Moved zebrautl.h to idzebra/util.h.
[idzebra-moved-to-github.git] / rset / rset.c
index 93fe8df..26ba709 100644 (file)
-/*
- * Copyright (C) 1994-1999, Index Data
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: rset.c,v $
- * Revision 1.15  2002-03-20 20:24:30  adam
- * Hits per term. Returned in SearchResult-1
- *
- * Revision 1.14  1999/05/26 07:49:14  adam
- * C++ compilation.
- *
- * Revision 1.13  1999/02/02 14:51:33  adam
- * Updated WIN32 code specific sections. Changed header.
- *
- * Revision 1.12  1998/04/26 10:56:57  adam
- * Added include of string.h.
- *
- * Revision 1.11  1998/03/05 08:36:28  adam
- * New result set model.
- *
- * Revision 1.10  1998/02/10 11:56:46  adam
- * Implemented rset_dup.
- *
- * Revision 1.9  1996/10/29 13:55:21  adam
- * Include of zebrautl.h instead of alexutil.h.
- *
- * Revision 1.8  1995/12/11 09:15:23  adam
- * New set types: sand/sor/snot - ranked versions of and/or/not in
- * ranked/semi-ranked result sets.
- * Note: the snot not finished yet.
- * New rset member: flag.
- * Bug fix: r_delete in rsrel.c did free bad memory block.
- *
- * Revision 1.7  1995/10/12  12:41:56  adam
- * Private info (buf) moved from struct rset_control to struct rset.
- * Bug fixes in relevance.
- *
- * Revision 1.6  1995/09/08  14:52:41  adam
- * Work on relevance feedback.
- *
- * Revision 1.5  1995/09/07  13:58:43  adam
- * New parameter: result-set file descriptor (RSFD) to support multiple
- * positions within the same result-set.
- * Boolean operators: and, or, not implemented.
- *
- * Revision 1.4  1995/09/06  16:11:56  adam
- * More work on boolean sets.
- *
- * Revision 1.3  1995/09/04  15:20:39  adam
- * More work on temp sets. is_open member removed.
- *
- * Revision 1.2  1995/09/04  12:33:56  adam
- * Various cleanup. YAZ util used instead.
- *
- * Revision 1.1  1994/11/04  13:21:28  quinn
- * Working.
- *
- */
+/* $Id: rset.c,v 1.44 2005-03-30 09:25:24 adam Exp $
+   Copyright (C) 1995-2005
+   Index Data ApS
+
+This file is part of the Zebra server.
+
+Zebra is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with Zebra; see the file LICENSE.zebra.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+*/
 
 #include <stdio.h>
 #include <string.h>
-#include <zebrautl.h>
-
+#include <idzebra/util.h>
+#include <assert.h>
+#include <yaz/nmem.h>
 #include <rset.h>
 
-RSET rset_create(const struct rset_control *sel, void *parms)
+static int log_level = 0;
+static int log_level_initialized = 0;
+
+/** \fn rfd_create_base(RSET rs)
+ *
+ * creates an rfd. Either allocates a new one, in which case the priv 
+ * pointer is null, and will have to be filled in, or picks up one 
+ * from the freelist, in which case the priv is already allocated,
+ * and presumably everything that hangs from it as well 
+ */
+RSFD rfd_create_base(RSET rs)
+{
+    RSFD rnew = rs->free_list;
+
+    if (rnew) 
+    {
+        rs->free_list = rnew->next;
+        assert(rnew->rset==rs);
+        yaz_log(log_level, "rfd_create_base (fl): rfd=%p rs=%p fl=%p priv=%p", 
+               rnew, rs, rs->free_list, rnew->priv); 
+    } 
+    else
+    {
+        rnew = nmem_malloc(rs->nmem, sizeof(*rnew));
+        rnew->priv = NULL;
+        rnew->rset = rs;
+        yaz_log(log_level, "rfd_create_base (new): rfd=%p rs=%p fl=%p priv=%p", 
+               rnew, rs, rs->free_list, rnew->priv); 
+    }
+    rnew->next = rs->use_list;
+    rs->use_list = rnew;
+    return rnew;
+}
+
+/** \fn rfd_delete_base
+ *
+ * puts an rfd into the freelist of the rset. Only when the rset gets
+ * deleted, will all the nmem disappear */
+void rfd_delete_base(RSFD rfd) 
+{
+    RSFD *pfd;
+    RSET rs = rfd->rset;
+    yaz_log(log_level, "rfd_delete_base: rfd=%p rs=%p priv=%p fl=%p",
+            rfd, rs, rfd->priv, rs->free_list); 
+    for (pfd = &rs->use_list; *pfd; pfd = &(*pfd)->next)
+       if (*pfd == rfd)
+       {
+           *pfd = (*pfd)->next;
+           rfd->next = rs->free_list;
+           rs->free_list = rfd;
+           return;
+       }
+    yaz_log(YLOG_WARN, "rset_close handle not found. type=%s",
+           rs->control->desc);
+}
+
+RSET rset_create_base(const struct rset_control *sel, 
+                      NMEM nmem, const struct key_control *kcontrol,
+                      int scope, TERMID term)
 {
     RSET rnew;
-    int i;
+    NMEM M;
+    /* assert(nmem); */ /* can not yet be used, api/t4 fails */
+    if (!log_level_initialized) 
+    {
+        log_level = yaz_log_module_level("rset");
+        log_level_initialized = 1;
+    }
 
-    logf (LOG_DEBUG, "rs_create(%s)", sel->desc);
-    rnew = (RSET) xmalloc(sizeof(*rnew));
+    if (nmem) 
+        M = nmem;
+    else
+        M = nmem_create();
+    rnew = (RSET) nmem_malloc(M, sizeof(*rnew));
+    yaz_log(log_level, "rs_create(%s) rs=%p (nm=%p)", sel->desc, rnew, nmem); 
+    rnew->nmem = M;
+    if (nmem)
+        rnew->my_nmem = 0;
+    else 
+        rnew->my_nmem = 1;
     rnew->control = sel;
-    rnew->flags = 0;
-    rnew->count = 1;
-    rnew->rset_terms = NULL;
-    rnew->no_rset_terms = 0;
-    rnew->buf = (*sel->f_create)(rnew, sel, parms);
-    logf (LOG_DEBUG, "no_rset_terms: %d", rnew->no_rset_terms);
-    for (i = 0; i<rnew->no_rset_terms; i++)
-       logf (LOG_DEBUG, " %s", rnew->rset_terms[i]->name);
+    rnew->count = 1; /* refcount! */
+    rnew->priv = 0;
+    rnew->free_list = NULL;
+    rnew->use_list = NULL;
+    rnew->keycontrol = kcontrol;
+    rnew->scope = scope;
+    rnew->term = term;
+    if (term)
+        term->rset = rnew;
     return rnew;
 }
 
 void rset_delete (RSET rs)
 {
     (rs->count)--;
+    yaz_log(log_level, "rs_delete(%s), rs=%p, count=%d",
+            rs->control->desc, rs, rs->count); 
     if (!rs->count)
     {
-       (*rs->control->f_delete)(rs);
-       xfree(rs);
+       if (rs->use_list)
+           yaz_log(YLOG_WARN, "rs_delete(%s) still has RFDs in use",
+                   rs->control->desc);
+        (*rs->control->f_delete)(rs);
+        if (rs->my_nmem)
+            nmem_destroy(rs->nmem);
     }
 }
 
+int rfd_is_last(RSFD rfd)
+{
+    if (rfd->rset->use_list == rfd && rfd->next == 0)
+       return 1;
+    return 0;
+}
+
 RSET rset_dup (RSET rs)
 {
     (rs->count)++;
+    yaz_log(log_level, "rs_dup(%s), rs=%p, count=%d",
+            rs->control->desc, rs, rs->count); 
     return rs;
 }
 
-RSET_TERM *rset_terms(RSET rs, int *no)
+int rset_default_forward(RSFD rfd, void *buf, TERMID *term,
+                        const void *untilbuf)
 {
-    *no = rs->no_rset_terms;
-    return rs->rset_terms;
+    int more = 1;
+    int cmp = rfd->rset->scope;
+    if (log_level)
+    {
+        yaz_log (log_level, "rset_default_forward starting '%s' (ct=%p rfd=%p)",
+                    rfd->rset->control->desc, rfd->rset, rfd);
+        /* key_logdump(log_level, untilbuf); */
+    }
+    while (cmp>=rfd->rset->scope && more)
+    {
+        if (log_level)  /* time-critical, check first */
+            yaz_log(log_level, "rset_default_forward looping m=%d c=%d",
+                   more, cmp);
+        more = rset_read(rfd, buf, term);
+        if (more)
+            cmp = (rfd->rset->keycontrol->cmp)(untilbuf, buf);
+    }
+    if (log_level)
+        yaz_log (log_level, "rset_default_forward exiting m=%d c=%d",
+                more, cmp);
+
+    return more;
 }
 
-RSET_TERM rset_term_create (const char *name, int length, const char *flags)
+/** 
+ * rset_count uses rset_pos to get the total and returns that.
+ * This is ok for rsisamb/c/s, and for some other rsets, but in case of
+ * booleans etc it will give bad estimate, as nothing has been read
+ * from that rset
+ */
+zint rset_count(RSET rs)
 {
-    RSET_TERM t = (RSET_TERM) xmalloc (sizeof(*t));
-    if (!name)
-       t->name = NULL;
-    else if (length == -1)
-       t->name = xstrdup (name);
-    else
-    {
-       t->name = (char*) xmalloc (length+1);
-       memcpy (t->name, name, length);
-       t->name[length] = '\0';
-    }
-    if (!flags)
-       t->flags = NULL;
-    else
-       t->flags = xstrdup (flags);
-    t->nn = -1;
-    t->count = 0;
-    return t;
+    double cur, tot;
+    RSFD rfd = rset_open(rs, 0);
+    rset_pos(rfd, &cur, &tot);
+    rset_close(rfd);
+    return (zint) tot;
 }
 
-void rset_term_destroy (RSET_TERM t)
+
+/** rset_get_no_terms is a getterms function for those that don't have any */
+void rset_get_no_terms(RSET ct, TERMID *terms, int maxterms, int *curterm)
 {
-    xfree (t->name);
-    xfree (t->flags);
-    xfree (t);
+    return;
+}
+
+/* rset_get_one_term gets that one term from an rset. Used by rsisamX */
+void rset_get_one_term(RSET ct,TERMID *terms,int maxterms,int *curterm)
+{
+    if (ct->term)
+    {
+        if (*curterm < maxterms)
+            terms[*curterm] = ct->term;
+        (*curterm)++;
+    }
 }
 
-RSET_TERM rset_term_dup (RSET_TERM t)
+
+TERMID rset_term_create (const char *name, int length, const char *flags,
+                                    int type, NMEM nmem)
+
 {
-    RSET_TERM nt = (RSET_TERM) xmalloc (sizeof(*nt));
-    if (t->name)
-       nt->name = xstrdup (t->name);
+    TERMID t;
+    yaz_log (log_level, "term_create '%s' %d f=%s type=%d nmem=%p",
+            name, length, flags, type, nmem);
+    t= (TERMID) nmem_malloc(nmem, sizeof(*t));
+    if (!name)
+        t->name = NULL;
+    else if (length == -1)
+        t->name = nmem_strdup(nmem, name);
     else
-       nt->name = NULL;
-    if (t->flags)
-       nt->flags = xstrdup (t->flags);
+    {
+        t->name = (char*) nmem_malloc(nmem, length+1);
+        memcpy (t->name, name, length);
+        t->name[length] = '\0';
+    }
+    if (!flags)
+        t->flags = NULL;
     else
-       nt->flags = NULL;
-    nt->nn = t->nn;
-    return nt;
+        t->flags = nmem_strdup(nmem, flags);
+    t->type = type;
+    t->rankpriv = 0;
+    t->rset = 0;
+    return t;
 }