bfile/mfile.c

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