bfile/mfile.c

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