rset/rstemp.c

   1 /* $Id: rstemp.c,v 1.64 2005-05-24 11:35:43 adam Exp $
   2    Copyright (C) 1995-2005
   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 <assert.h>
  24 #include <fcntl.h>
  25 #include <stdlib.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28 #ifdef WIN32
  29 #include <io.h>
  30 #else
  31 #include <unistd.h>
  32 #endif
  33 #include <sys/types.h>
  34
  35 #include <idzebra/util.h>
  36 #include <rset.h>
  37
  38 static RSFD r_open(RSET ct, int flag);
  39 static void r_close(RSFD rfd);
  40 static void r_delete(RSET ct);
  41 static int r_read(RSFD rfd, void *buf, TERMID *term);
  42 static int r_write(RSFD rfd, const void *buf);
  43 static void r_pos(RSFD rfd, double *current, double  *total);
  44 static void r_flush(RSFD rfd, int mk);
  45 static void r_reread(RSFD rfd);
  46
  47 static const struct rset_control control =
  48 {
  49     "temp",
  50     r_delete,
  51     rset_get_one_term,
  52     r_open,
  53     r_close,
  54     0, /* no forward */
  55     r_pos,
  56     r_read,
  57     r_write,
  58 };
  59
  60 struct rset_private {
  61     int     fd;            /* file descriptor for temp file */
  62     char   *fname;         /* name of temp file */
  63     char   *buf_mem;       /* window buffer */
  64     size_t  buf_size;      /* size of window */
  65     size_t  pos_end;       /* last position in set */
  66     size_t  pos_buf;       /* position of first byte in window */
  67     size_t  pos_border;    /* position of last byte+1 in window */
  68     int     dirty;         /* window is dirty */
  69     zint    hits;          /* no of hits */
  70     char   *temp_path;
  71 };
  72
  73 struct rfd_private {
  74     void *buf;
  75     size_t  pos_cur;       /* current position in set */
  76                            /* FIXME - term pos or what ??  */
  77     zint cur; /* number of the current hit */
  78 };
  79
  80 static int log_level = 0;
  81 static int log_level_initialized = 0;
  82
  83 RSET rstemp_create(NMEM nmem, struct rset_key_control *kcontrol,
  84                    int scope, const char *temp_path, TERMID term)
  85 {
  86     RSET rnew = rset_create_base(&control, nmem, kcontrol, scope, term,
  87                                  0, 0);
  88     struct rset_private *info;
  89     if (!log_level_initialized)
  90     {
  91         log_level = yaz_log_module_level("rstemp");
  92         log_level_initialized = 1;
  93     }
  94     info = (struct rset_private *) nmem_malloc(rnew->nmem, sizeof(*info));
  95     info->fd = -1;
  96     info->fname = NULL;
  97     info->buf_size = 4096;
  98     info->buf_mem = (char *) nmem_malloc(rnew->nmem, info->buf_size);
  99     info->pos_end = 0;
 100     info->pos_buf = 0;
 101     info->dirty = 0;
 102     info->hits = 0;
 103
 104     if (!temp_path)
 105         info->temp_path = NULL;
 106     else
 107         info->temp_path = nmem_strdup(rnew->nmem, temp_path);
 108     rnew->priv = info;
 109     return rnew;
 110 } /* rstemp_create */
 111
 112 static void r_delete(RSET ct)
 113 {
 114     struct rset_private *info = (struct rset_private*) ct->priv;
 115
 116     yaz_log(log_level, "r_delete: set size %ld", (long) info->pos_end);
 117     if (info->fname)
 118     {
 119         yaz_log(log_level, "r_delete: unlink %s", info->fname);
 120         unlink(info->fname);
 121     }
 122 }
 123
 124 static RSFD r_open(RSET ct, int flag)
 125 {
 126     struct rset_private *info = (struct rset_private *) ct->priv;
 127     RSFD rfd;
 128     struct rfd_private *prfd;
 129
 130     if (info->fd == -1 && info->fname)
 131     {
 132         if (flag & RSETF_WRITE)
 133             info->fd = open(info->fname, O_BINARY|O_RDWR|O_CREAT, 0666);
 134         else
 135             info->fd = open(info->fname, O_BINARY|O_RDONLY);
 136         if (info->fd == -1)
 137         {
 138             yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: open failed %s", info->fname);
 139             exit(1);
 140         }
 141     }
 142     rfd = rfd_create_base(ct);
 143     if (!rfd->priv)
 144     {
 145         prfd = (struct rfd_private *) nmem_malloc(ct->nmem, sizeof(*prfd));
 146         rfd->priv = (void *)prfd;
 147         prfd->buf = nmem_malloc(ct->nmem,ct->keycontrol->key_size);
 148     }
 149     else
 150         prfd= rfd->priv;
 151     r_flush(rfd, 0);
 152     prfd->pos_cur = 0;
 153     info->pos_buf = 0;
 154     r_reread(rfd);
 155     prfd->cur = 0;
 156     return rfd;
 157 }
 158
 159 /* r_flush:
 160       flush current window to file if file is assocated with set
 161  */
 162 static void r_flush(RSFD rfd, int mk)
 163 {
 164     struct rset_private *info = rfd->rset->priv;
 165
 166     if (!info->fname && mk)
 167     {
 168 #if HAVE_MKSTEMP
 169         char template[1024];
 170         if (info->temp_path)
 171             sprintf(template, "%s/zrsXXXXXX", info->temp_path);
 172         else
 173             sprintf(template, "zrsXXXXXX");
 174
 175         info->fd = mkstemp(template);
 176
 177         if (info->fd == -1)
 178         {
 179             yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: mkstemp %s", template);
 180             exit(1);
 181         }
 182         info->fname = nmem_strdup(rfd->rset->nmem, template);
 183 #else
 184         char *s = (char*) tempnam(info->temp_path, "zrs");
 185         info->fname= nmem_strdup(rfd->rset->nmem, s);
 186
 187         yaz_log(log_level, "creating tempfile %s", info->fname);
 188         info->fd = open(info->fname, O_BINARY|O_RDWR|O_CREAT, 0666);
 189         if (info->fd == -1)
 190         {
 191             yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: open %s", info->fname);
 192             exit(1);
 193         }
 194 #endif
 195     }
 196     if (info->fname && info->fd != -1 && info->dirty)
 197     {
 198         size_t count;
 199         int r;
 200
 201         if (lseek(info->fd, info->pos_buf, SEEK_SET) == -1)
 202         {
 203             yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: lseek (1) %s", info->fname);
 204             exit(1);
 205         }
 206         count = info->buf_size;
 207         if (count > info->pos_end - info->pos_buf)
 208             count = info->pos_end - info->pos_buf;
 209         if ((r = write(info->fd, info->buf_mem, count)) < (int) count)
 210         {
 211             if (r == -1)
 212                 yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: write %s", info->fname);
 213             else
 214                 yaz_log(YLOG_FATAL, "rstemp: write of %ld but got %ld",
 215                       (long) count, (long) r);
 216             exit(1);
 217         }
 218         info->dirty = 0;
 219     }
 220 }
 221
 222 static void r_close(RSFD rfd)
 223 {
 224     struct rset_private *info = (struct rset_private *)rfd->rset->priv;
 225     if (rfd_is_last(rfd))
 226     {
 227         r_flush(rfd, 0);
 228         if (info->fname && info->fd != -1)
 229         {
 230             close(info->fd);
 231             info->fd = -1;
 232         }
 233     }
 234 }
 235
 236
 237 /* r_reread:
 238       read from file to window if file is assocated with set -
 239       indicated by fname
 240  */
 241 static void r_reread(RSFD rfd)
 242 {
 243     struct rfd_private *mrfd = (struct rfd_private*) rfd->priv;
 244     struct rset_private *info = (struct rset_private *)rfd->rset->priv;
 245
 246     if (info->fname)
 247     {
 248         size_t count;
 249         int r;
 250
 251         info->pos_border = mrfd->pos_cur +
 252             info->buf_size;
 253         if (info->pos_border > info->pos_end)
 254             info->pos_border = info->pos_end;
 255         count = info->pos_border - info->pos_buf;
 256         if (count > 0)
 257         {
 258             if (lseek(info->fd, info->pos_buf, SEEK_SET) == -1)
 259             {
 260                 yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: lseek (2) %s fd=%d", info->fname, info->fd);
 261                 exit(1);
 262             }
 263             if ((r = read(info->fd, info->buf_mem, count)) < (int) count)
 264             {
 265                 if (r == -1)
 266                     yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: read %s", info->fname);
 267                 else
 268                     yaz_log(YLOG_FATAL, "read of %ld but got %ld",
 269                           (long) count, (long) r);
 270                 exit(1);
 271             }
 272         }
 273     }
 274     else
 275         info->pos_border = info->pos_end;
 276 }
 277
 278 static int r_read(RSFD rfd, void *buf, TERMID *term)
 279 {
 280     struct rfd_private *mrfd = (struct rfd_private*) rfd->priv;
 281     struct rset_private *info = (struct rset_private *)rfd->rset->priv;
 282
 283     size_t nc = mrfd->pos_cur + rfd->rset->keycontrol->key_size;
 284
 285     if (mrfd->pos_cur < info->pos_buf || nc > info->pos_border)
 286     {
 287         if (nc > info->pos_end)
 288             return 0;
 289         r_flush(rfd, 0);
 290         info->pos_buf = mrfd->pos_cur;
 291         r_reread(rfd);
 292     }
 293     memcpy(buf, info->buf_mem + (mrfd->pos_cur - info->pos_buf),
 294             rfd->rset->keycontrol->key_size);
 295     if (term)
 296         *term = rfd->rset->term;
 297         /* FIXME - should we store and return terms ?? */
 298     mrfd->pos_cur = nc;
 299     mrfd->cur++;
 300     return 1;
 301 }
 302
 303 static int r_write(RSFD rfd, const void *buf)
 304 {
 305     struct rfd_private *mrfd = (struct rfd_private*) rfd->priv;
 306     struct rset_private *info = (struct rset_private *)rfd->rset->priv;
 307
 308     size_t nc = mrfd->pos_cur + rfd->rset->keycontrol->key_size;
 309
 310     if (nc > info->pos_buf + info->buf_size)
 311     {
 312         r_flush(rfd, 1);
 313         info->pos_buf = mrfd->pos_cur;
 314         if (info->pos_buf < info->pos_end)
 315             r_reread(rfd);
 316     }
 317     info->dirty = 1;
 318     memcpy(info->buf_mem + (mrfd->pos_cur - info->pos_buf), buf,
 319             rfd->rset->keycontrol->key_size);
 320     mrfd->pos_cur = nc;
 321     if (nc > info->pos_end)
 322         info->pos_border = info->pos_end = nc;
 323     info->hits++;
 324     return 1;
 325 }
 326
 327 static void r_pos(RSFD rfd, double  *current, double  *total)
 328 {
 329     struct rfd_private *mrfd = (struct rfd_private*) rfd->priv;
 330     struct rset_private *info = (struct rset_private *)rfd->rset->priv;
 331
 332     *current = (double) mrfd->cur;
 333     *total = (double) info->hits;
 334 }