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