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