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