bfile/mfile.c

   1 /* $Id: mfile.c,v 1.49 2002-08-02 19:26:55 adam Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
   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
  26  /*
  27   * TODO: The size estimates in init may not be accurate due to
  28   * only partially written final blocks.
  29   */
  30
  31 #include <sys/types.h>
  32 #include <fcntl.h>
  33 #ifdef WIN32
  34 #include <io.h>
  35 #else
  36 #include <unistd.h>
  37 #endif
  38 #include <direntz.h>
  39 #include <string.h>
  40 #include <stdlib.h>
  41 #include <stdio.h>
  42 #include <assert.h>
  43 #include <errno.h>
  44
  45 #include <zebra-lock.h>
  46 #include <zebrautl.h>
  47 #include <mfile.h>
  48
  49 static int scan_areadef(MFile_area ma, const char *ad, const char *base)
  50 {
  51     /*
  52      * If no definition is given, use current directory, unlimited.
  53      */
  54     char dirname[FILENAME_MAX+1];
  55     mf_dir **dp = &ma->dirs, *dir = *dp;
  56
  57     if (!ad)
  58         ad = ".:-1b";
  59     for (;;)
  60     {
  61         const char *ad0 = ad;
  62         int i = 0, fact = 1, multi;
  63         off_t size = 0;
  64
  65         while (*ad == ' ' || *ad == '\t')
  66             ad++;
  67         if (!*ad)
  68             break;
  69         if (!yaz_is_abspath(ad) && base)
  70         {
  71             strcpy (dirname, base);
  72             i = strlen(dirname);
  73             dirname[i++] = '/';
  74         }
  75         while (*ad)
  76         {
  77             if (*ad == ':' && strchr ("+-0123456789", ad[1]))
  78                 break;
  79             if (i < FILENAME_MAX)
  80                 dirname[i++] = *ad;
  81             ad++;
  82         }
  83         dirname[i] = '\0';
  84         if (*ad++ != ':')
  85         {
  86             logf (LOG_WARN, "Missing colon after path: %s", ad0);
  87             return -1;
  88         }
  89         if (i == 0)
  90         {
  91             logf (LOG_WARN, "Empty path: %s", ad0);
  92             return -1;
  93         }
  94         while (*ad == ' ' || *ad == '\t')
  95             ad++;
  96         if (*ad == '-')
  97         {
  98             fact = -1;
  99             ad++;
 100         }
 101         else if (*ad == '+')
 102             ad++;
 103         size = 0;
 104         if (*ad < '0' || *ad > '9')
 105         {
 106             logf (LOG_FATAL, "Missing size after path: %s", ad0);
 107             return -1;
 108         }
 109         size = 0;
 110         while (*ad >= '0' && *ad <= '9')
 111             size = size*10 + (*ad++ - '0');
 112         switch (*ad)
 113         {
 114         case 'B': case 'b': multi = 1; break;
 115         case 'K': case 'k': multi = 1024; break;
 116         case 'M': case 'm': multi = 1048576; break;
 117         case 'G': case 'g': multi = 1073741824; break;
 118         case '\0':
 119             logf (LOG_FATAL, "Missing unit: %s", ad0);
 120             return -1;
 121         default:
 122             logf (LOG_FATAL, "Illegal unit: %c in %s", *ad, ad0);
 123             return -1;
 124         }
 125         ad++;
 126         *dp = dir = (mf_dir *) xmalloc(sizeof(mf_dir));
 127         dir->next = 0;
 128         strcpy(dir->name, dirname);
 129         dir->max_bytes = dir->avail_bytes = fact * size * multi;
 130         dp = &dir->next;
 131     }
 132     return 0;
 133 }
 134
 135 static int file_position(MFile mf, int pos, int offset)
 136 {
 137     int off = 0, c = mf->cur_file, ps;
 138
 139     if ((c > 0 && pos <= mf->files[c-1].top) ||
 140         (c < mf->no_files -1 && pos > mf->files[c].top))
 141     {
 142         c = 0;
 143         while (c + 1 < mf->no_files && mf->files[c].top < pos)
 144         {
 145             off += mf->files[c].blocks;
 146             c++;
 147         }
 148         assert(c < mf->no_files);
 149     }
 150     else
 151         off = c ? (mf->files[c-1].top + 1) : 0;
 152     if (mf->files[c].fd < 0)
 153     {
 154         if ((mf->files[c].fd = open(mf->files[c].path,
 155                                     mf->wr ?
 156                                         (O_BINARY|O_RDWR|O_CREAT) :
 157                                         (O_BINARY|O_RDONLY), 0666)) < 0)
 158         {
 159             if (!mf->wr && errno == ENOENT && off == 0)
 160                 return -2;
 161             logf (LOG_WARN|LOG_ERRNO, "Failed to open %s", mf->files[c].path);
 162              return -1;
 163         }
 164     }
 165     if (lseek(mf->files[c].fd, (ps = pos - off) * mf->blocksize + offset,
 166         SEEK_SET) < 0)
 167     {
 168         logf (LOG_WARN|LOG_ERRNO, "Failed to seek in %s", mf->files[c].path);
 169         return -1;
 170     }
 171     mf->cur_file = c;
 172     return ps;
 173 }
 174
 175 static int cmp_part_file(const void *p1, const void *p2)
 176 {
 177     return ((part_file *)p1)->number - ((part_file *)p2)->number;
 178 }
 179
 180 /*
 181  * Create a new area, cotaining metafiles in directories.
 182  * Find the part-files in each directory, and inventory the existing metafiles.
 183  */
 184 MFile_area mf_init(const char *name, const char *spec, const char *base)
 185 {
 186     MFile_area ma = (MFile_area) xmalloc(sizeof(*ma));
 187     mf_dir *dirp;
 188     meta_file *meta_f;
 189     part_file *part_f = 0;
 190     DIR *dd;
 191     struct dirent *dent;
 192     int fd, number;
 193     char metaname[FILENAME_MAX+1], tmpnam[FILENAME_MAX+1];
 194
 195     logf (LOG_DEBUG, "mf_init(%s)", name);
 196     strcpy(ma->name, name);
 197     ma->mfiles = 0;
 198     ma->dirs = 0;
 199     if (scan_areadef(ma, spec, base) < 0)
 200     {
 201         logf (LOG_WARN, "Failed to access description of '%s'", name);
 202         return 0;
 203     }
 204     /* look at each directory */
 205     for (dirp = ma->dirs; dirp; dirp = dirp->next)
 206     {
 207         if (!(dd = opendir(dirp->name)))
 208         {
 209             logf (LOG_WARN|LOG_ERRNO, "Failed to open directory %s",
 210                                      dirp->name);
 211             return 0;
 212         }
 213         /* look at each file */
 214         while ((dent = readdir(dd)))
 215         {
 216             int len = strlen(dent->d_name);
 217             const char *cp = strrchr (dent->d_name, '-');
 218             if (strchr (".-", *dent->d_name))
 219                 continue;
 220             if (len < 5 || !cp || strcmp (dent->d_name + len - 3, ".mf"))
 221                 continue;
 222             number = atoi(cp+1);
 223             memcpy (metaname, dent->d_name, cp - dent->d_name);
 224             metaname[ cp - dent->d_name] = '\0';
 225
 226             for (meta_f = ma->mfiles; meta_f; meta_f = meta_f->next)
 227             {
 228                 /* known metafile */
 229                 if (!strcmp(meta_f->name, metaname))
 230                 {
 231                     part_f = &meta_f->files[meta_f->no_files++];
 232                     break;
 233                 }
 234             }
 235             /* new metafile */
 236             if (!meta_f)
 237             {
 238                 meta_f = (meta_file *) xmalloc(sizeof(*meta_f));
 239                 zebra_mutex_init (&meta_f->mutex);
 240                 meta_f->ma = ma;
 241                 meta_f->next = ma->mfiles;
 242                 meta_f->open = 0;
 243                 meta_f->cur_file = -1;
 244                 ma->mfiles = meta_f;
 245                 strcpy(meta_f->name, metaname);
 246                 part_f = &meta_f->files[0];
 247                 meta_f->no_files = 1;
 248             }
 249             part_f->number = number;
 250             part_f->dir = dirp;
 251             part_f->fd = -1;
 252             sprintf(tmpnam, "%s/%s", dirp->name, dent->d_name);
 253             part_f->path = xstrdup(tmpnam);
 254             /* get size */
 255             if ((fd = open(part_f->path, O_BINARY|O_RDONLY)) < 0)
 256             {
 257                 logf (LOG_FATAL|LOG_ERRNO, "Failed to access %s",
 258                       dent->d_name);
 259                 return 0;
 260             }
 261             if ((part_f->bytes = lseek(fd, 0, SEEK_END)) < 0)
 262             {
 263                 logf (LOG_FATAL|LOG_ERRNO, "Failed to seek in %s",
 264                       dent->d_name);
 265                 return 0;
 266             }
 267 #ifndef WIN32
 268             fsync(fd);
 269 #endif
 270             close(fd);
 271             if (dirp->max_bytes >= 0)
 272                 dirp->avail_bytes -= part_f->bytes;
 273         }
 274         closedir(dd);
 275     }
 276     for (meta_f = ma->mfiles; meta_f; meta_f = meta_f->next)
 277     {
 278         logf (LOG_DEBUG, "mf_init: %s consists of %d part(s)", meta_f->name,
 279               meta_f->no_files);
 280         qsort(meta_f->files, meta_f->no_files, sizeof(part_file),
 281               cmp_part_file);
 282     }
 283     return ma;
 284 }
 285
 286 void mf_destroy(MFile_area ma)
 287 {
 288     mf_dir *dp;
 289     meta_file *meta_f;
 290
 291     if (!ma)
 292         return;
 293     dp = ma->dirs;
 294     while (dp)
 295     {
 296         mf_dir *d = dp;
 297         dp = dp->next;
 298         xfree (d);
 299     }
 300     meta_f = ma->mfiles;
 301     while (meta_f)
 302     {
 303         int i;
 304         meta_file *m = meta_f;
 305
 306         for (i = 0; i<m->no_files; i++)
 307         {
 308             xfree (m->files[i].path);
 309         }
 310         zebra_mutex_destroy (&meta_f->mutex);
 311         meta_f = meta_f->next;
 312         xfree (m);
 313     }
 314     xfree (ma);
 315 }
 316
 317 void mf_reset(MFile_area ma)
 318 {
 319     meta_file *meta_f;
 320
 321     if (!ma)
 322         return;
 323     meta_f = ma->mfiles;
 324     while (meta_f)
 325     {
 326         int i;
 327         meta_file *m = meta_f;
 328
 329         assert (!m->open);
 330         for (i = 0; i<m->no_files; i++)
 331         {
 332             unlink (m->files[i].path);
 333             xfree (m->files[i].path);
 334         }
 335         meta_f = meta_f->next;
 336         xfree (m);
 337     }
 338     ma->mfiles = 0;
 339 }
 340
 341 /*
 342  * Open a metafile.
 343  * If !ma, Use MF_DEFAULT_AREA.
 344  */
 345 MFile mf_open(MFile_area ma, const char *name, int block_size, int wflag)
 346 {
 347     meta_file *mnew;
 348     int i;
 349     char tmp[FILENAME_MAX+1];
 350     mf_dir *dp;
 351
 352     logf(LOG_DEBUG, "mf_open(%s bs=%d, %s)", name, block_size,
 353          wflag ? "RW" : "RDONLY");
 354     assert (ma);
 355     for (mnew = ma->mfiles; mnew; mnew = mnew->next)
 356         if (!strcmp(name, mnew->name))
 357         {
 358             if (mnew->open)
 359                 abort();
 360             else
 361                 break;
 362         }
 363     if (!mnew)
 364     {
 365         mnew = (meta_file *) xmalloc(sizeof(*mnew));
 366         strcpy(mnew->name, name);
 367         /* allocate one, empty file */
 368         zebra_mutex_init (&mnew->mutex);
 369         mnew->no_files = 1;
 370         mnew->files[0].bytes = 0;
 371         mnew->files[0].blocks = 0;
 372         mnew->files[0].top = -1;
 373         mnew->files[0].number = 0;
 374         mnew->files[0].fd = -1;
 375         mnew->min_bytes_creat = MF_MIN_BLOCKS_CREAT * block_size;
 376         for (dp = ma->dirs; dp && dp->max_bytes >= 0 && dp->avail_bytes <
 377             mnew->min_bytes_creat; dp = dp->next);
 378         if (!dp)
 379         {
 380             logf (LOG_FATAL, "Insufficient space for new mfile.");
 381             return 0;
 382         }
 383         mnew->files[0].dir = dp;
 384         sprintf(tmp, "%s/%s-%d.mf", dp->name, mnew->name, 0);
 385         mnew->files[0].path = xstrdup(tmp);
 386         mnew->ma = ma;
 387         mnew->next = ma->mfiles;
 388         ma->mfiles = mnew;
 389     }
 390     else
 391     {
 392         for (i = 0; i < mnew->no_files; i++)
 393         {
 394             if (mnew->files[i].bytes % block_size)
 395                 mnew->files[i].bytes += block_size - mnew->files[i].bytes %
 396                     block_size;
 397             mnew->files[i].blocks = mnew->files[i].bytes / block_size;
 398         }
 399         assert(!mnew->open);
 400     }
 401     mnew->blocksize = block_size;
 402     mnew->min_bytes_creat = MF_MIN_BLOCKS_CREAT * block_size;
 403     mnew->wr=wflag;
 404     mnew->cur_file = 0;
 405     mnew->open = 1;
 406
 407     for (i = 0; i < mnew->no_files; i++)
 408     {
 409         mnew->files[i].blocks = mnew->files[i].bytes / mnew->blocksize;
 410         if (i == mnew->no_files - 1)
 411             mnew->files[i].top = -1;
 412         else
 413             mnew->files[i].top =
 414                 i ? (mnew->files[i-1].top + mnew->files[i].blocks)
 415                 : (mnew->files[i].blocks - 1);
 416     }
 417     return mnew;
 418 }
 419
 420 /*
 421  * Close a metafile.
 422  */
 423 int mf_close(MFile mf)
 424 {
 425     int i;
 426
 427     logf (LOG_DEBUG, "mf_close(%s)", mf->name);
 428     assert(mf->open);
 429     for (i = 0; i < mf->no_files; i++)
 430         if (mf->files[i].fd >= 0)
 431         {
 432 #ifndef WIN32
 433             fsync(mf->files[i].fd);
 434 #endif
 435             close(mf->files[i].fd);
 436             mf->files[i].fd = -1;
 437         }
 438     mf->open = 0;
 439     return 0;
 440 }
 441
 442 /*
 443  * Read one block from a metafile. Interface mirrors bfile.
 444  */
 445 int mf_read(MFile mf, int no, int offset, int nbytes, void *buf)
 446 {
 447     int rd, toread;
 448
 449     zebra_mutex_lock (&mf->mutex);
 450     if ((rd = file_position(mf, no, offset)) < 0)
 451     {
 452         if (rd == -2)
 453         {
 454             zebra_mutex_unlock (&mf->mutex);
 455             return 0;
 456         }
 457         else
 458         {
 459             yaz_log (LOG_FATAL, "mf_read %s internal error", mf->name);
 460             exit(1);
 461         }
 462     }
 463     toread = nbytes ? nbytes : mf->blocksize;
 464     if ((rd = read(mf->files[mf->cur_file].fd, buf, toread)) < 0)
 465     {
 466         logf (LOG_FATAL|LOG_ERRNO, "mf_read: Read failed (%s)",
 467               mf->files[mf->cur_file].path);
 468         exit(1);
 469     }
 470     zebra_mutex_unlock (&mf->mutex);
 471     if (rd < toread)
 472         return 0;
 473     else
 474         return 1;
 475 }
 476
 477 /*
 478  * Write.
 479  */
 480 int mf_write(MFile mf, int no, int offset, int nbytes, const void *buf)
 481 {
 482     int ps, nblocks, towrite;
 483     mf_dir *dp;
 484     char tmp[FILENAME_MAX+1];
 485     unsigned char dummych = '\xff';
 486
 487     zebra_mutex_lock (&mf->mutex);
 488     if ((ps = file_position(mf, no, offset)) < 0)
 489     {
 490         yaz_log (LOG_FATAL, "mf_write %s internal error (1)", mf->name);
 491         exit(1);
 492     }
 493     /* file needs to grow */
 494     while (ps >= mf->files[mf->cur_file].blocks)
 495     {
 496         off_t needed = (ps - mf->files[mf->cur_file].blocks + 1) *
 497                        mf->blocksize;
 498         /* file overflow - allocate new file */
 499         if (mf->files[mf->cur_file].dir->max_bytes >= 0 &&
 500             needed > mf->files[mf->cur_file].dir->avail_bytes)
 501         {
 502             /* cap off file? */
 503             if ((nblocks = mf->files[mf->cur_file].dir->avail_bytes /
 504                 mf->blocksize) > 0)
 505             {
 506                 logf (LOG_DEBUG, "Capping off file %s at pos %d",
 507                     mf->files[mf->cur_file].path, nblocks);
 508                 if ((ps = file_position(mf,
 509                     (mf->cur_file ? mf->files[mf->cur_file-1].top : 0) +
 510                     mf->files[mf->cur_file].blocks + nblocks - 1, 0)) < 0)
 511                 {
 512                     yaz_log (LOG_FATAL, "mf_write %s internal error (2)",
 513                                  mf->name);
 514                     exit(1);
 515                 }
 516                 logf (LOG_DEBUG, "ps = %d", ps);
 517                 if (write(mf->files[mf->cur_file].fd, &dummych, 1) < 1)
 518                 {
 519                     logf (LOG_ERRNO|LOG_FATAL, "mf_write %s internal error (3)",
 520                                       mf->name);
 521                     exit(1);
 522                 }
 523                 mf->files[mf->cur_file].blocks += nblocks;
 524                 mf->files[mf->cur_file].bytes += nblocks * mf->blocksize;
 525                 mf->files[mf->cur_file].dir->avail_bytes -= nblocks *
 526                     mf->blocksize;
 527             }
 528             /* get other bit */
 529             logf (LOG_DEBUG, "Creating new file.");
 530             for (dp = mf->ma->dirs; dp && dp->max_bytes >= 0 &&
 531                 dp->avail_bytes < needed; dp = dp->next);
 532             if (!dp)
 533             {
 534                 logf (LOG_FATAL, "Cannot allocate more space for %s",
 535                       mf->name);
 536                 exit(1);
 537             }
 538             mf->files[mf->cur_file].top = (mf->cur_file ?
 539                 mf->files[mf->cur_file-1].top : -1) +
 540                 mf->files[mf->cur_file].blocks;
 541             mf->files[++(mf->cur_file)].top = -1;
 542             mf->files[mf->cur_file].dir = dp;
 543             mf->files[mf->cur_file].number =
 544                 mf->files[mf->cur_file-1].number + 1;
 545             mf->files[mf->cur_file].blocks =
 546                 mf->files[mf->cur_file].bytes = 0;
 547             mf->files[mf->cur_file].fd = -1;
 548             sprintf(tmp, "%s/%s-%d.mf", dp->name, mf->name,
 549                 mf->files[mf->cur_file].number);
 550             mf->files[mf->cur_file].path = xstrdup(tmp);
 551             mf->no_files++;
 552             /* open new file and position at beginning */
 553             if ((ps = file_position(mf, no, offset)) < 0)
 554             {
 555                 yaz_log (LOG_FATAL, "mf_write %s internal error (4)",
 556                                  mf->name);
 557                 exit(1);
 558             }
 559         }
 560         else
 561         {
 562             nblocks = ps - mf->files[mf->cur_file].blocks + 1;
 563             mf->files[mf->cur_file].blocks += nblocks;
 564             mf->files[mf->cur_file].bytes += nblocks * mf->blocksize;
 565             if (mf->files[mf->cur_file].dir->max_bytes >= 0)
 566                 mf->files[mf->cur_file].dir->avail_bytes -=
 567                 nblocks * mf->blocksize;
 568         }
 569     }
 570     towrite = nbytes ? nbytes : mf->blocksize;
 571     if (write(mf->files[mf->cur_file].fd, buf, towrite) < towrite)
 572     {
 573         logf (LOG_FATAL|LOG_ERRNO, "Write failed for file %s part %d",
 574                 mf->name, mf->cur_file);
 575         exit(1);
 576     }
 577     zebra_mutex_unlock (&mf->mutex);
 578     return 0;
 579 }
 580
 581 /*
 582  * Destroy a metafile, unlinking component files. File must be open.
 583  */
 584 int mf_unlink(MFile mf)
 585 {
 586     int i;
 587
 588     for (i = 0; i < mf->no_files; i++)
 589         unlink (mf->files[i].path);
 590     return 0;
 591 }
 592
 593 /*
 594  * Unlink the file by name, rather than MFile-handle. File should be closed.
 595  */
 596 int mf_unlink_name(MFile_area ma, const char *name)
 597 {
 598     abort();
 599     return 0;
 600 }