bfile/mfile.c

   1 /* $Id: mfile.c,v 1.51 2003-03-25 23:47:23 adam Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003
   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         mfile_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 (mfile_seek(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                 meta_f->unlink_flag = 0;
 245                 ma->mfiles = meta_f;
 246                 strcpy(meta_f->name, metaname);
 247                 part_f = &meta_f->files[0];
 248                 meta_f->no_files = 1;
 249             }
 250             part_f->number = number;
 251             part_f->dir = dirp;
 252             part_f->fd = -1;
 253             sprintf(tmpnam, "%s/%s", dirp->name, dent->d_name);
 254             part_f->path = xstrdup(tmpnam);
 255             /* get size */
 256             if ((fd = open(part_f->path, O_BINARY|O_RDONLY)) < 0)
 257             {
 258                 logf (LOG_FATAL|LOG_ERRNO, "Failed to access %s",
 259                       dent->d_name);
 260                 return 0;
 261             }
 262             if ((part_f->bytes = mfile_seek(fd, 0, SEEK_END)) < 0)
 263             {
 264                 logf (LOG_FATAL|LOG_ERRNO, "Failed to seek in %s",
 265                       dent->d_name);
 266                 return 0;
 267             }
 268 #ifndef WIN32
 269             fsync(fd);
 270 #endif
 271             close(fd);
 272             if (dirp->max_bytes >= 0)
 273                 dirp->avail_bytes -= part_f->bytes;
 274         }
 275         closedir(dd);
 276     }
 277     for (meta_f = ma->mfiles; meta_f; meta_f = meta_f->next)
 278     {
 279         logf (LOG_DEBUG, "mf_init: %s consists of %d part(s)", meta_f->name,
 280               meta_f->no_files);
 281         qsort(meta_f->files, meta_f->no_files, sizeof(part_file),
 282               cmp_part_file);
 283     }
 284     return ma;
 285 }
 286
 287 void mf_destroy(MFile_area ma)
 288 {
 289     mf_dir *dp;
 290     meta_file *meta_f;
 291
 292     if (!ma)
 293         return;
 294     dp = ma->dirs;
 295     while (dp)
 296     {
 297         mf_dir *d = dp;
 298         dp = dp->next;
 299         xfree (d);
 300     }
 301     meta_f = ma->mfiles;
 302     while (meta_f)
 303     {
 304         int i;
 305         meta_file *m = meta_f;
 306
 307         for (i = 0; i<m->no_files; i++)
 308         {
 309             xfree (m->files[i].path);
 310         }
 311         zebra_mutex_destroy (&meta_f->mutex);
 312         meta_f = meta_f->next;
 313         xfree (m);
 314     }
 315     xfree (ma);
 316 }
 317
 318 void mf_reset(MFile_area ma)
 319 {
 320     meta_file *meta_f;
 321
 322     if (!ma)
 323         return;
 324     meta_f = ma->mfiles;
 325     while (meta_f)
 326     {
 327         int i;
 328         meta_file *m = meta_f;
 329
 330         assert (!m->open);
 331         for (i = 0; i<m->no_files; i++)
 332         {
 333             unlink (m->files[i].path);
 334             xfree (m->files[i].path);
 335         }
 336         meta_f = meta_f->next;
 337         xfree (m);
 338     }
 339     ma->mfiles = 0;
 340 }
 341
 342 /*
 343  * Open a metafile.
 344  * If !ma, Use MF_DEFAULT_AREA.
 345  */
 346 MFile mf_open(MFile_area ma, const char *name, int block_size, int wflag)
 347 {
 348     meta_file *mnew;
 349     int i;
 350     char tmp[FILENAME_MAX+1];
 351     mf_dir *dp;
 352
 353     logf(LOG_DEBUG, "mf_open(%s bs=%d, %s)", name, block_size,
 354          wflag ? "RW" : "RDONLY");
 355     assert (ma);
 356     for (mnew = ma->mfiles; mnew; mnew = mnew->next)
 357         if (!strcmp(name, mnew->name))
 358         {
 359             if (mnew->open)
 360                 abort();
 361             else
 362                 break;
 363         }
 364     if (!mnew)
 365     {
 366         mnew = (meta_file *) xmalloc(sizeof(*mnew));
 367         strcpy(mnew->name, name);
 368         /* allocate one, empty file */
 369         zebra_mutex_init (&mnew->mutex);
 370         mnew->no_files = 1;
 371         mnew->files[0].bytes = 0;
 372         mnew->files[0].blocks = 0;
 373         mnew->files[0].top = -1;
 374         mnew->files[0].number = 0;
 375         mnew->files[0].fd = -1;
 376         mnew->unlink_flag = 0;
 377         mnew->min_bytes_creat = MF_MIN_BLOCKS_CREAT * block_size;
 378         for (dp = ma->dirs; dp && dp->max_bytes >= 0 && dp->avail_bytes <
 379             mnew->min_bytes_creat; dp = dp->next);
 380         if (!dp)
 381         {
 382             logf (LOG_FATAL, "Insufficient space for new mfile.");
 383             return 0;
 384         }
 385         mnew->files[0].dir = dp;
 386         sprintf(tmp, "%s/%s-%d.mf", dp->name, mnew->name, 0);
 387         mnew->files[0].path = xstrdup(tmp);
 388         mnew->ma = ma;
 389         mnew->next = ma->mfiles;
 390         ma->mfiles = mnew;
 391     }
 392     else
 393     {
 394         for (i = 0; i < mnew->no_files; i++)
 395         {
 396             if (mnew->files[i].bytes % block_size)
 397                 mnew->files[i].bytes += block_size - mnew->files[i].bytes %
 398                     block_size;
 399             mnew->files[i].blocks = (int) (mnew->files[i].bytes / block_size);
 400         }
 401         assert(!mnew->open);
 402     }
 403     mnew->blocksize = block_size;
 404     mnew->min_bytes_creat = MF_MIN_BLOCKS_CREAT * block_size;
 405     mnew->wr=wflag;
 406     mnew->cur_file = 0;
 407     mnew->open = 1;
 408
 409     for (i = 0; i < mnew->no_files; i++)
 410     {
 411         mnew->files[i].blocks = (int)(mnew->files[i].bytes / mnew->blocksize);
 412         if (i == mnew->no_files - 1)
 413             mnew->files[i].top = -1;
 414         else
 415             mnew->files[i].top =
 416                 i ? (mnew->files[i-1].top + mnew->files[i].blocks)
 417                 : (mnew->files[i].blocks - 1);
 418     }
 419     return mnew;
 420 }
 421
 422 /*
 423  * Close a metafile.
 424  */
 425 int mf_close(MFile mf)
 426 {
 427     int i;
 428
 429     logf (LOG_DEBUG, "mf_close(%s)", mf->name);
 430     assert(mf->open);
 431     for (i = 0; i < mf->no_files; i++)
 432     {
 433         if (mf->files[i].fd >= 0)
 434         {
 435 #ifndef WIN32
 436             fsync(mf->files[i].fd);
 437 #endif
 438             close(mf->files[i].fd);
 439             mf->files[i].fd = -1;
 440         }
 441         if (mf->unlink_flag)
 442             unlink(mf->files[i].path);
 443     }
 444     mf->open = 0;
 445     return 0;
 446 }
 447
 448 /*
 449  * Read one block from a metafile. Interface mirrors bfile.
 450  */
 451 int mf_read(MFile mf, int no, int offset, int nbytes, void *buf)
 452 {
 453     int rd, toread;
 454
 455     zebra_mutex_lock (&mf->mutex);
 456     if ((rd = file_position(mf, no, offset)) < 0)
 457     {
 458         if (rd == -2)
 459         {
 460             zebra_mutex_unlock (&mf->mutex);
 461             return 0;
 462         }
 463         else
 464         {
 465             yaz_log (LOG_FATAL, "mf_read %s internal error", mf->name);
 466             exit(1);
 467         }
 468     }
 469     toread = nbytes ? nbytes : mf->blocksize;
 470     if ((rd = read(mf->files[mf->cur_file].fd, buf, toread)) < 0)
 471     {
 472         logf (LOG_FATAL|LOG_ERRNO, "mf_read: Read failed (%s)",
 473               mf->files[mf->cur_file].path);
 474         exit(1);
 475     }
 476     zebra_mutex_unlock (&mf->mutex);
 477     if (rd < toread)
 478         return 0;
 479     else
 480         return 1;
 481 }
 482
 483 /*
 484  * Write.
 485  */
 486 int mf_write(MFile mf, int no, int offset, int nbytes, const void *buf)
 487 {
 488     int ps, nblocks, towrite;
 489     mf_dir *dp;
 490     char tmp[FILENAME_MAX+1];
 491     unsigned char dummych = '\xff';
 492
 493     zebra_mutex_lock (&mf->mutex);
 494     if ((ps = file_position(mf, no, offset)) < 0)
 495     {
 496         yaz_log (LOG_FATAL, "mf_write %s internal error (1)", mf->name);
 497         exit(1);
 498     }
 499     /* file needs to grow */
 500     while (ps >= mf->files[mf->cur_file].blocks)
 501     {
 502         mfile_off_t needed = (ps - mf->files[mf->cur_file].blocks + 1) *
 503                        mf->blocksize;
 504         /* file overflow - allocate new file */
 505         if (mf->files[mf->cur_file].dir->max_bytes >= 0 &&
 506             needed > mf->files[mf->cur_file].dir->avail_bytes)
 507         {
 508             /* cap off file? */
 509             if ((nblocks = (int) (mf->files[mf->cur_file].dir->avail_bytes /
 510                 mf->blocksize)) > 0)
 511             {
 512                 logf (LOG_DEBUG, "Capping off file %s at pos %d",
 513                     mf->files[mf->cur_file].path, nblocks);
 514                 if ((ps = file_position(mf,
 515                     (mf->cur_file ? mf->files[mf->cur_file-1].top : 0) +
 516                     mf->files[mf->cur_file].blocks + nblocks - 1, 0)) < 0)
 517                 {
 518                     yaz_log (LOG_FATAL, "mf_write %s internal error (2)",
 519                                  mf->name);
 520                     exit(1);
 521                 }
 522                 logf (LOG_DEBUG, "ps = %d", ps);
 523                 if (write(mf->files[mf->cur_file].fd, &dummych, 1) < 1)
 524                 {
 525                     logf (LOG_ERRNO|LOG_FATAL, "mf_write %s internal error (3)",
 526                                       mf->name);
 527                     exit(1);
 528                 }
 529                 mf->files[mf->cur_file].blocks += nblocks;
 530                 mf->files[mf->cur_file].bytes += nblocks * mf->blocksize;
 531                 mf->files[mf->cur_file].dir->avail_bytes -= nblocks *
 532                     mf->blocksize;
 533             }
 534             /* get other bit */
 535             logf (LOG_DEBUG, "Creating new file.");
 536             for (dp = mf->ma->dirs; dp && dp->max_bytes >= 0 &&
 537                 dp->avail_bytes < needed; dp = dp->next);
 538             if (!dp)
 539             {
 540                 logf (LOG_FATAL, "Cannot allocate more space for %s",
 541                       mf->name);
 542                 exit(1);
 543             }
 544             mf->files[mf->cur_file].top = (mf->cur_file ?
 545                 mf->files[mf->cur_file-1].top : -1) +
 546                 mf->files[mf->cur_file].blocks;
 547             mf->files[++(mf->cur_file)].top = -1;
 548             mf->files[mf->cur_file].dir = dp;
 549             mf->files[mf->cur_file].number =
 550                 mf->files[mf->cur_file-1].number + 1;
 551             mf->files[mf->cur_file].blocks = 0;
 552             mf->files[mf->cur_file].bytes = 0;
 553             mf->files[mf->cur_file].fd = -1;
 554             sprintf(tmp, "%s/%s-%d.mf", dp->name, mf->name,
 555                 mf->files[mf->cur_file].number);
 556             mf->files[mf->cur_file].path = xstrdup(tmp);
 557             mf->no_files++;
 558             /* open new file and position at beginning */
 559             if ((ps = file_position(mf, no, offset)) < 0)
 560             {
 561                 yaz_log (LOG_FATAL, "mf_write %s internal error (4)",
 562                                  mf->name);
 563                 exit(1);
 564             }
 565         }
 566         else
 567         {
 568             nblocks = ps - mf->files[mf->cur_file].blocks + 1;
 569             mf->files[mf->cur_file].blocks += nblocks;
 570             mf->files[mf->cur_file].bytes += nblocks * mf->blocksize;
 571             if (mf->files[mf->cur_file].dir->max_bytes >= 0)
 572                 mf->files[mf->cur_file].dir->avail_bytes -=
 573                 nblocks * mf->blocksize;
 574         }
 575     }
 576     towrite = nbytes ? nbytes : mf->blocksize;
 577     if (write(mf->files[mf->cur_file].fd, buf, towrite) < towrite)
 578     {
 579         logf (LOG_FATAL|LOG_ERRNO, "Write failed for file %s part %d",
 580                 mf->name, mf->cur_file);
 581         exit(1);
 582     }
 583     zebra_mutex_unlock (&mf->mutex);
 584     return 0;
 585 }
 586
 587 /*
 588  * Destroy a metafile, unlinking component files. File must be open.
 589  */
 590 int mf_unlink(MFile mf)
 591 {
 592     if (mf->open)
 593         mf->unlink_flag = 1;
 594     else
 595     {
 596         int i;
 597         for (i = 0; i<mf->no_files; i++)
 598             unlink(mf->files[i].path);
 599     }
 600     return 0;
 601 }
 602
 603 /*
 604  * Unlink the file by name, rather than MFile-handle. File should be closed.
 605  */
 606 int mf_unlink_name(MFile_area ma, const char *name)
 607 {
 608     abort();
 609     return 0;
 610 }