bfile/mfile.c

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