X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=rset%2Frset.c;h=bec6da4b43c5c4d11a51541a0d5917321c3c4987;hp=26ba709bc9d6cfc9b1599be9ec6054a1b6b3f578;hb=aeea139423b8eaf28a4de53b3d7b2ad1f22284e7;hpb=deff57cfa9d9b39c4a4f1c9b82a64c6e61d821a4 diff --git a/rset/rset.c b/rset/rset.c index 26ba709..bec6da4 100644 --- a/rset/rset.c +++ b/rset/rset.c @@ -1,8 +1,5 @@ -/* $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. +/* This file is part of the Zebra server. + Copyright (C) 1994-2011 Index Data 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 @@ -15,11 +12,14 @@ 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. +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ +#if HAVE_CONFIG_H +#include +#endif #include #include #include @@ -30,47 +30,49 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 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 - */ + +/** + \brief Common constuctor for RFDs + \param rs Result set handle. + + 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) + 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); - } + 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->counted_buf = nmem_malloc(rs->nmem, rs->keycontrol->key_size); + rnew->priv = 0; 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); + 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; + rnew->counted_items = 0; 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) +static void rset_close_int(RSET rs, RSFD rfd) { RSFD *pfd; - RSET rs = rfd->rset; + (*rs->control->f_close)(rfd); + yaz_log(log_level, "rfd_delete_base: rfd=%p rs=%p priv=%p fl=%p", - rfd, rs, rfd->priv, rs->free_list); + rfd, rs, rfd->priv, rs->free_list); for (pfd = &rs->use_list; *pfd; pfd = &(*pfd)->next) if (*pfd == rfd) { @@ -83,59 +85,160 @@ void rfd_delete_base(RSFD rfd) rs->control->desc); } -RSET rset_create_base(const struct rset_control *sel, - NMEM nmem, const struct key_control *kcontrol, - int scope, TERMID term) +void rset_set_hits_limit(RSET rs, zint l) +{ + yaz_log(log_level, "rset_set_hits_limit %p l=" ZINT_FORMAT, rs, l); + rs->hits_limit = l; +} + +/** + \brief Closes a result set RFD handle + \param rfd the RFD handle. +*/ +void rset_close(RSFD rfd) +{ + RSET rs = rfd->rset; + + if (rs->hits_count == 0) + { + TERMID termid; + char buf[100]; + + while (rfd->counted_items <= rs->hits_limit + && rset_default_read(rfd, buf, &termid)) + ; + + rs->hits_count = rfd->counted_items; + yaz_log(log_level, "rset_close rset=%p hits_count=" ZINT_FORMAT + " hits_limit=" ZINT_FORMAT, + rs, rs->hits_count, rs->hits_limit); + rs->hits_approx = 0; + if (rs->hits_count > rs->hits_limit && rs->hits_limit > 0) + { + double cur, tot; + zint est; + rset_pos(rfd, &cur, &tot); + if (tot > 0) { + int i; + double ratio = cur/tot; + est = (zint)(0.5 + rs->hits_count / ratio); + yaz_log(log_level, "Estimating hits (%s) " + "%0.1f->" ZINT_FORMAT + "; %0.1f->" ZINT_FORMAT, + rs->control->desc, + cur, rs->hits_count, + tot, est); + i = 0; /* round to significant digits */ + while (est > rs->hits_round) { + est /= 10; + i++; + } + while (i--) + est *= 10; + rs->hits_count = est; + rs->hits_approx = 1; + } + } + yaz_log(log_level, "rset_close(%s) p=%p count=" ZINT_FORMAT, + rs->control->desc, rs, + rs->hits_count); + } + rset_close_int(rs, rfd); +} + +/** + \brief Common constuctor for RSETs + \param sel The interface control handle + \param nmem The memory handle for it. + \param kcontrol Key control info (decode, encode, comparison etc) + \param scope scope for set + \param term Information about term for it (NULL for none). + \param no_children number of child rsets (0 for none) + \param children child rsets (NULL for none). + + 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 +*/ +RSET rset_create_base(const struct rset_control *sel, + NMEM nmem, struct rset_key_control *kcontrol, + int scope, TERMID term, + int no_children, RSET *children) { - RSET rnew; - NMEM M; - /* assert(nmem); */ /* can not yet be used, api/t4 fails */ - if (!log_level_initialized) + RSET rset; + assert(nmem); + if (!log_level_initialized) { log_level = yaz_log_module_level("rset"); log_level_initialized = 1; } - 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->count = 1; /* refcount! */ - rnew->priv = 0; - rnew->free_list = NULL; - rnew->use_list = NULL; - rnew->keycontrol = kcontrol; - rnew->scope = scope; - rnew->term = term; + rset = (RSET) nmem_malloc(nmem, sizeof(*rset)); + yaz_log(log_level, "rs_create(%s) rs=%p (nm=%p)", sel->desc, rset, nmem); + yaz_log(log_level, " ref_id=%s", + (term && term->ref_id ? term->ref_id : "null")); + rset->nmem = nmem; + rset->control = sel; + rset->refcount = 1; + rset->priv = 0; + rset->free_list = NULL; + rset->use_list = NULL; + rset->hits_count = 0; + rset->hits_limit = 0; + rset->hits_round = 1000; + rset->keycontrol = kcontrol; + + (*kcontrol->inc)(kcontrol); + rset->scope = scope; + rset->term = term; if (term) - term->rset = rnew; - return rnew; + { + term->rset = rset; + rset->hits_limit = term->hits_limit; + } + rset->no_children = no_children; + rset->children = 0; + if (no_children) + { + rset->children = (RSET*) + nmem_malloc(rset->nmem, no_children*sizeof(RSET *)); + memcpy(rset->children, children, no_children*sizeof(RSET *)); + } + return rset; } -void rset_delete (RSET rs) +/** + \brief Destructor RSETs + \param rs Handle for result set. + + Destroys a result set and all its children. + The f_delete method of control is called for the result set. +*/ +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->refcount)--; + yaz_log(log_level, "rs_delete(%s), rs=%p, refcount=%d", + rs->control->desc, rs, rs->refcount); + if (!rs->refcount) { + int i; if (rs->use_list) yaz_log(YLOG_WARN, "rs_delete(%s) still has RFDs in use", rs->control->desc); + for (i = 0; ino_children; i++) + rset_delete(rs->children[i]); (*rs->control->f_delete)(rs); - if (rs->my_nmem) - nmem_destroy(rs->nmem); + (*rs->keycontrol->dec)(rs->keycontrol); } } +/** + \brief Test for last use of RFD + \param rfd RFD handle. + + Returns 1 if this RFD is the last reference to it; 0 otherwise. +*/ int rfd_is_last(RSFD rfd) { if (rfd->rset->use_list == rfd && rfd->next == 0) @@ -143,77 +246,101 @@ int rfd_is_last(RSFD rfd) return 0; } +/** + \brief Duplicate an RSET + \param rs Handle for result set. + + Duplicates a result set by incrementing the reference count to it. +*/ RSET rset_dup (RSET rs) { - (rs->count)++; - yaz_log(log_level, "rs_dup(%s), rs=%p, count=%d", - rs->control->desc, rs, rs->count); + (rs->refcount)++; + yaz_log(log_level, "rs_dup(%s), rs=%p, refcount=%d", + rs->control->desc, rs, rs->refcount); return rs; } -int rset_default_forward(RSFD rfd, void *buf, TERMID *term, - const void *untilbuf) -{ - 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; -} +/** + \brief Estimates hit count for result set. + \param rs Result Set. -/** - * 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 - */ + 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) { double cur, tot; RSFD rfd = rset_open(rs, 0); rset_pos(rfd, &cur, &tot); - rset_close(rfd); + rset_close_int(rs, rfd); return (zint) tot; } +/** + \brief is a getterms function for those that don't have any + \param ct result set handle + \param terms array of terms (0..maxterms-1) + \param maxterms length of terms array + \param curterm current size of terms array -/** 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) -{ - 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 there is a term associated with rset the term is appeneded; otherwise + the terms array is untouched but curterm is incremented anyway. +*/ +void rset_get_one_term(RSET ct, TERMID *terms, int maxterms, int *curterm) { if (ct->term) { if (*curterm < maxterms) terms[*curterm] = ct->term; - (*curterm)++; + (*curterm)++; } } +struct ord_list *ord_list_create(NMEM nmem) +{ + return 0; +} -TERMID rset_term_create (const char *name, int length, const char *flags, - int type, NMEM nmem) +struct ord_list *ord_list_append(NMEM nmem, struct ord_list *list, + int ord) +{ + struct ord_list *n = nmem_malloc(nmem, sizeof(*n)); + n->ord = ord; + n->next = list; + return n; +} + +struct ord_list *ord_list_dup(NMEM nmem, struct ord_list *list) +{ + struct ord_list *n = ord_list_create(nmem); + for (; list; list = list->next) + n = ord_list_append(nmem, n, list->ord); + return n; +} + +void ord_list_print(struct ord_list *list) +{ + for (; list; list = list->next) + yaz_log(YLOG_LOG, "ord_list %d", list->ord); +} +/** + \brief Creates a TERMID entry. + \param name Term/Name buffer with given length + \param length of term + \param flags for term + \param type Term Type, Z_Term_general, Z_Term_characterString,.. + \param nmem memory for term. + \param ol ord list + \param reg_type register type + \param hits_limit limit before counting stops and gets approximate + \param ref_id supplied ID for term that can be used to identify this +*/ +TERMID rset_term_create(const char *name, int length, const char *flags, + int type, NMEM nmem, struct ord_list *ol, + int reg_type, + zint hits_limit, const char *ref_id) { TERMID t; @@ -225,17 +352,90 @@ TERMID rset_term_create (const char *name, int length, const char *flags, else if (length == -1) t->name = nmem_strdup(nmem, name); else - { - t->name = (char*) nmem_malloc(nmem, length+1); - memcpy (t->name, name, length); - t->name[length] = '\0'; - } + t->name = nmem_strdupn(nmem, name, length); + if (!ref_id) + t->ref_id = 0; + else + t->ref_id = nmem_strdup(nmem, ref_id); if (!flags) t->flags = NULL; else t->flags = nmem_strdup(nmem, flags); + t->hits_limit = hits_limit; t->type = type; + t->reg_type = reg_type; t->rankpriv = 0; t->rset = 0; + t->ol = ord_list_dup(nmem, ol); return t; } + +int rset_default_read(RSFD rfd, void *buf, TERMID *term) +{ + RSET rset = rfd->rset; + int rc = (*rset->control->f_read)(rfd, buf, term); + if (rc > 0) + { + int got_scope; + if (rfd->counted_items == 0) + got_scope = rset->scope+1; + else + got_scope = rset->keycontrol->cmp(buf, rfd->counted_buf); + +#if 0 + key_logdump_txt(YLOG_LOG, buf, "rset_default_read"); + yaz_log(YLOG_LOG, "rset_scope=%d got_scope=%d", rset->scope, got_scope); +#endif + if (got_scope > rset->scope) + { + memcpy(rfd->counted_buf, buf, rset->keycontrol->key_size); + rfd->counted_items++; + } + } + return rc; +} + +int rset_default_forward(RSFD rfd, void *buf, TERMID *term, + const void *untilbuf) +{ + RSET rset = rfd->rset; + int more; + + if (rset->control->f_forward && + rfd->counted_items >= rset->hits_limit) + { + assert (rset->control->f_forward != rset_default_forward); + return rset->control->f_forward(rfd, buf, term, untilbuf); + } + + while ((more = rset_read(rfd, buf, term)) > 0) + { + if ((rfd->rset->keycontrol->cmp)(untilbuf, buf) < rset->scope) + break; + } + if (log_level) + yaz_log(log_level, "rset_default_forward exiting rfd=%p scope=%d m=%d c=%d", + rfd, rset->scope, more, rset->scope); + + return more; +} + +void rset_visit(RSET rset, int level) +{ + int i; + yaz_log(YLOG_LOG, "%*s%c " ZINT_FORMAT, level, "", + rset->hits_approx ? '~' : '=', + rset->hits_count); + for (i = 0; ino_children; i++) + rset_visit(rset->children[i], level+1); +} + +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +