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