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