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