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