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.44 2002-04-11 20:09:08 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 && (mf->files[c].fd = open(mf->files[c].path,
 137         mf->wr ? (O_BINARY|O_RDWR|O_CREAT) : (O_BINARY|O_RDONLY), 0666)) < 0)
 138     {
 139         if (!mf->wr && errno == ENOENT && off == 0)
 140             return -2;
 141         logf (LOG_WARN|LOG_ERRNO, "Failed to open %s", mf->files[c].path);
 142         return -1;
 143     }
 144     if (lseek(mf->files[c].fd, (ps = pos - off) * mf->blocksize + offset,
 145         SEEK_SET) < 0)
 146     {
 147         logf (LOG_WARN|LOG_ERRNO, "Failed to seek in %s", mf->files[c].path);
 148         return -1;
 149     }
 150     mf->cur_file = c;
 151     return ps;
 152 }
 153
 154 static int cmp_part_file(const void *p1, const void *p2)
 155 {
 156     return ((part_file *)p1)->number - ((part_file *)p2)->number;
 157 }
 158
 159 /*
 160  * Create a new area, cotaining metafiles in directories.
 161  * Find the part-files in each directory, and inventory the existing metafiles.
 162  */
 163 MFile_area mf_init(const char *name, const char *spec, const char *base)
 164 {
 165     MFile_area ma = (MFile_area) xmalloc(sizeof(*ma));
 166     mf_dir *dirp;
 167     meta_file *meta_f;
 168     part_file *part_f = 0;
 169     DIR *dd;
 170     struct dirent *dent;
 171     int fd, number;
 172     char metaname[FILENAME_MAX+1], tmpnam[FILENAME_MAX+1];
 173
 174     logf (LOG_DEBUG, "mf_init(%s)", name);
 175     strcpy(ma->name, name);
 176     ma->mfiles = 0;
 177     ma->dirs = 0;
 178     if (scan_areadef(ma, spec, base) < 0)
 179     {
 180         logf (LOG_WARN, "Failed to access description of '%s'", name);
 181         return 0;
 182     }
 183     /* look at each directory */
 184     for (dirp = ma->dirs; dirp; dirp = dirp->next)
 185     {
 186         if (!(dd = opendir(dirp->name)))
 187         {
 188             logf (LOG_WARN|LOG_ERRNO, "Failed to open directory %s",
 189                                      dirp->name);
 190             return 0;
 191         }
 192         /* look at each file */
 193         while ((dent = readdir(dd)))
 194         {
 195             int len = strlen(dent->d_name);
 196             const char *cp = strrchr (dent->d_name, '-');
 197             if (strchr (".-", *dent->d_name))
 198                 continue;
 199             if (len < 5 || !cp || strcmp (dent->d_name + len - 3, ".mf"))
 200                 continue;
 201             number = atoi(cp+1);
 202             memcpy (metaname, dent->d_name, cp - dent->d_name);
 203             metaname[ cp - dent->d_name] = '\0';
 204
 205             for (meta_f = ma->mfiles; meta_f; meta_f = meta_f->next)
 206             {
 207                 /* known metafile */
 208                 if (!strcmp(meta_f->name, metaname))
 209                 {
 210                     part_f = &meta_f->files[meta_f->no_files++];
 211                     break;
 212                 }
 213             }
 214             /* new metafile */
 215             if (!meta_f)
 216             {
 217                 meta_f = (meta_file *) xmalloc(sizeof(*meta_f));
 218                 zebra_mutex_init (&meta_f->mutex);
 219                 meta_f->ma = ma;
 220                 meta_f->next = ma->mfiles;
 221                 meta_f->open = 0;
 222                 meta_f->cur_file = -1;
 223                 ma->mfiles = meta_f;
 224                 strcpy(meta_f->name, metaname);
 225                 part_f = &meta_f->files[0];
 226                 meta_f->no_files = 1;
 227             }
 228             part_f->number = number;
 229             part_f->dir = dirp;
 230             part_f->fd = -1;
 231             sprintf(tmpnam, "%s/%s", dirp->name, dent->d_name);
 232             part_f->path = xstrdup(tmpnam);
 233             /* get size */
 234             if ((fd = open(part_f->path, O_BINARY|O_RDONLY)) < 0)
 235             {
 236                 logf (LOG_FATAL|LOG_ERRNO, "Failed to access %s",
 237                       dent->d_name);
 238                 return 0;
 239             }
 240             if ((part_f->bytes = lseek(fd, 0, SEEK_END)) < 0)
 241             {
 242                 logf (LOG_FATAL|LOG_ERRNO, "Failed to seek in %s",
 243                       dent->d_name);
 244                 return 0;
 245             }
 246             close(fd);
 247             if (dirp->max_bytes >= 0)
 248                 dirp->avail_bytes -= part_f->bytes;
 249         }
 250         closedir(dd);
 251     }
 252     for (meta_f = ma->mfiles; meta_f; meta_f = meta_f->next)
 253     {
 254         logf (LOG_DEBUG, "mf_init: %s consists of %d part(s)", meta_f->name,
 255               meta_f->no_files);
 256         qsort(meta_f->files, meta_f->no_files, sizeof(part_file),
 257               cmp_part_file);
 258     }
 259     return ma;
 260 }
 261
 262 void mf_destroy(MFile_area ma)
 263 {
 264     mf_dir *dp;
 265     meta_file *meta_f;
 266
 267     if (!ma)
 268         return;
 269     dp = ma->dirs;
 270     while (dp)
 271     {
 272         mf_dir *d = dp;
 273         dp = dp->next;
 274         xfree (d);
 275     }
 276     meta_f = ma->mfiles;
 277     while (meta_f)
 278     {
 279         int i;
 280         meta_file *m = meta_f;
 281
 282         for (i = 0; i<m->no_files; i++)
 283         {
 284             xfree (m->files[i].path);
 285         }
 286         zebra_mutex_destroy (&meta_f->mutex);
 287         meta_f = meta_f->next;
 288         xfree (m);
 289     }
 290     xfree (ma);
 291 }
 292
 293 void mf_reset(MFile_area ma)
 294 {
 295     meta_file *meta_f;
 296
 297     if (!ma)
 298         return;
 299     meta_f = ma->mfiles;
 300     while (meta_f)
 301     {
 302         int i;
 303         meta_file *m = meta_f;
 304
 305         assert (!m->open);
 306         for (i = 0; i<m->no_files; i++)
 307         {
 308             unlink (m->files[i].path);
 309             xfree (m->files[i].path);
 310         }
 311         meta_f = meta_f->next;
 312         xfree (m);
 313     }
 314     ma->mfiles = 0;
 315 }
 316
 317 /*
 318  * Open a metafile.
 319  * If !ma, Use MF_DEFAULT_AREA.
 320  */
 321 MFile mf_open(MFile_area ma, const char *name, int block_size, int wflag)
 322 {
 323     meta_file *mnew;
 324     int i;
 325     char tmp[FILENAME_MAX+1];
 326     mf_dir *dp;
 327
 328     logf(LOG_DEBUG, "mf_open(%s bs=%d, %s)", name, block_size,
 329          wflag ? "RW" : "RDONLY");
 330     assert (ma);
 331     for (mnew = ma->mfiles; mnew; mnew = mnew->next)
 332         if (!strcmp(name, mnew->name))
 333         {
 334             if (mnew->open)
 335                 abort();
 336             else
 337                 break;
 338         }
 339     if (!mnew)
 340     {
 341         mnew = (meta_file *) xmalloc(sizeof(*mnew));
 342         strcpy(mnew->name, name);
 343         /* allocate one, empty file */
 344         zebra_mutex_init (&mnew->mutex);
 345         mnew->no_files = 1;
 346         mnew->files[0].bytes = 0;
 347         mnew->files[0].blocks = 0;
 348         mnew->files[0].top = -1;
 349         mnew->files[0].number = 0;
 350         mnew->files[0].fd = -1;
 351         mnew->min_bytes_creat = MF_MIN_BLOCKS_CREAT * block_size;
 352         for (dp = ma->dirs; dp && dp->max_bytes >= 0 && dp->avail_bytes <
 353             mnew->min_bytes_creat; dp = dp->next);
 354         if (!dp)
 355         {
 356             logf (LOG_FATAL, "Insufficient space for new mfile.");
 357             return 0;
 358         }
 359         mnew->files[0].dir = dp;
 360         sprintf(tmp, "%s/%s-%d.mf", dp->name, mnew->name, 0);
 361         mnew->files[0].path = xstrdup(tmp);
 362         mnew->ma = ma;
 363         mnew->next = ma->mfiles;
 364         ma->mfiles = mnew;
 365     }
 366     else
 367     {
 368         for (i = 0; i < mnew->no_files; i++)
 369         {
 370             if (mnew->files[i].bytes % block_size)
 371                 mnew->files[i].bytes += block_size - mnew->files[i].bytes %
 372                     block_size;
 373             mnew->files[i].blocks = mnew->files[i].bytes / block_size;
 374         }
 375         assert(!mnew->open);
 376     }
 377     mnew->blocksize = block_size;
 378     mnew->min_bytes_creat = MF_MIN_BLOCKS_CREAT * block_size;
 379     mnew->wr=wflag;
 380     mnew->cur_file = 0;
 381     mnew->open = 1;
 382
 383     for (i = 0; i < mnew->no_files; i++)
 384     {
 385         mnew->files[i].blocks = mnew->files[i].bytes / mnew->blocksize;
 386         if (i == mnew->no_files - 1)
 387             mnew->files[i].top = -1;
 388         else
 389             mnew->files[i].top =
 390                 i ? (mnew->files[i-1].top + mnew->files[i].blocks)
 391                 : (mnew->files[i].blocks - 1);
 392     }
 393     return mnew;
 394 }
 395
 396 /*
 397  * Close a metafile.
 398  */
 399 int mf_close(MFile mf)
 400 {
 401     int i;
 402
 403     logf (LOG_DEBUG, "mf_close(%s)", mf->name);
 404     assert(mf->open);
 405     for (i = 0; i < mf->no_files; i++)
 406         if (mf->files[i].fd >= 0)
 407         {
 408             close(mf->files[i].fd);
 409             mf->files[i].fd = -1;
 410         }
 411     mf->open = 0;
 412     return 0;
 413 }
 414
 415 /*
 416  * Read one block from a metafile. Interface mirrors bfile.
 417  */
 418 int mf_read(MFile mf, int no, int offset, int nbytes, void *buf)
 419 {
 420     int rd, toread;
 421
 422     zebra_mutex_lock (&mf->mutex);
 423     if ((rd = file_position(mf, no, offset)) < 0)
 424     {
 425         if (rd == -2)
 426         {
 427             zebra_mutex_unlock (&mf->mutex);
 428             return 0;
 429         }
 430         else
 431             exit(1);
 432     }
 433     toread = nbytes ? nbytes : mf->blocksize;
 434     if ((rd = read(mf->files[mf->cur_file].fd, buf, toread)) < 0)
 435     {
 436         logf (LOG_FATAL|LOG_ERRNO, "mf_read: Read failed (%s)",
 437               mf->files[mf->cur_file].path);
 438         exit(1);
 439     }
 440     zebra_mutex_unlock (&mf->mutex);
 441     if (rd < toread)
 442         return 0;
 443     else
 444         return 1;
 445 }
 446
 447 /*
 448  * Write.
 449  */
 450 int mf_write(MFile mf, int no, int offset, int nbytes, const void *buf)
 451 {
 452     int ps, nblocks, towrite;
 453     mf_dir *dp;
 454     char tmp[FILENAME_MAX+1];
 455     unsigned char dummych = '\xff';
 456
 457     zebra_mutex_lock (&mf->mutex);
 458     if ((ps = file_position(mf, no, offset)) < 0)
 459         exit(1);
 460     /* file needs to grow */
 461     while (ps >= mf->files[mf->cur_file].blocks)
 462     {
 463         /* file overflow - allocate new file */
 464         if (mf->files[mf->cur_file].dir->max_bytes >= 0 &&
 465             (ps - mf->files[mf->cur_file].blocks + 1) * mf->blocksize >
 466             mf->files[mf->cur_file].dir->avail_bytes)
 467         {
 468             /* cap off file? */
 469             if ((nblocks = mf->files[mf->cur_file].dir->avail_bytes /
 470                 mf->blocksize) > 0)
 471             {
 472                 logf (LOG_DEBUG, "Capping off file %s at pos %d",
 473                     mf->files[mf->cur_file].path, nblocks);
 474                 if ((ps = file_position(mf,
 475                     (mf->cur_file ? mf->files[mf->cur_file-1].top : 0) +
 476                     mf->files[mf->cur_file].blocks + nblocks - 1, 0)) < 0)
 477                         exit(1);
 478                 logf (LOG_DEBUG, "ps = %d", ps);
 479                 if (write(mf->files[mf->cur_file].fd, &dummych, 1) < 1)
 480                 {
 481                     logf (LOG_ERRNO|LOG_FATAL, "write dummy");
 482                     exit(1);
 483                 }
 484                 mf->files[mf->cur_file].blocks += nblocks;
 485                 mf->files[mf->cur_file].bytes += nblocks * mf->blocksize;
 486                 mf->files[mf->cur_file].dir->avail_bytes -= nblocks *
 487                     mf->blocksize;
 488             }
 489             /* get other bit */
 490             logf (LOG_DEBUG, "Creating new file.");
 491             for (dp = mf->ma->dirs; dp && dp->max_bytes >= 0 &&
 492                 dp->avail_bytes < mf->min_bytes_creat; dp = dp->next);
 493             if (!dp)
 494             {
 495                 logf (LOG_FATAL, "Cannot allocate more space for %s",
 496                       mf->name);
 497                 exit(1);
 498             }
 499             mf->files[mf->cur_file].top = (mf->cur_file ?
 500                 mf->files[mf->cur_file-1].top : -1) +
 501                 mf->files[mf->cur_file].blocks;
 502             mf->files[++(mf->cur_file)].top = -1;
 503             mf->files[mf->cur_file].dir = dp;
 504             mf->files[mf->cur_file].number =
 505                 mf->files[mf->cur_file-1].number + 1;
 506             mf->files[mf->cur_file].blocks =
 507                 mf->files[mf->cur_file].bytes = 0;
 508             mf->files[mf->cur_file].fd = -1;
 509             sprintf(tmp, "%s/%s-%d.mf", dp->name, mf->name,
 510                 mf->files[mf->cur_file].number);
 511             mf->files[mf->cur_file].path = xstrdup(tmp);
 512             mf->no_files++;
 513             /* open new file and position at beginning */
 514             if ((ps = file_position(mf, no, offset)) < 0)
 515                 exit(1);
 516         }
 517         else
 518         {
 519             nblocks = ps - mf->files[mf->cur_file].blocks + 1;
 520             mf->files[mf->cur_file].blocks += nblocks;
 521             mf->files[mf->cur_file].bytes += nblocks * mf->blocksize;
 522             if (mf->files[mf->cur_file].dir->max_bytes >= 0)
 523                 mf->files[mf->cur_file].dir->avail_bytes -=
 524                 nblocks * mf->blocksize;
 525         }
 526     }
 527     towrite = nbytes ? nbytes : mf->blocksize;
 528     if (write(mf->files[mf->cur_file].fd, buf, towrite) < towrite)
 529     {
 530         logf (LOG_FATAL|LOG_ERRNO, "Write failed for file %s part %d",
 531                 mf->name, mf->cur_file);
 532         exit(1);
 533     }
 534     zebra_mutex_unlock (&mf->mutex);
 535     return 0;
 536 }
 537
 538 /*
 539  * Destroy a metafile, unlinking component files. File must be open.
 540  */
 541 int mf_unlink(MFile mf)
 542 {
 543     int i;
 544
 545     for (i = 0; i < mf->no_files; i++)
 546         unlink (mf->files[i].path);
 547     return 0;
 548 }
 549
 550 /*
 551  * Unlink the file by name, rather than MFile-handle. File should be closed.
 552  */
 553 int mf_unlink_name(MFile_area ma, const char *name)
 554 {
 555     abort();
 556     return 0;
 557 }