]> mj.ucw.cz Git - libucw.git/blob - lib/fastbuf.h
Merge with git+ssh://git.ucw.cz/projects/sherlock/GIT/sherlock.git
[libucw.git] / lib / fastbuf.h
1 /*
2  *      UCW Library -- Fast Buffered I/O
3  *
4  *      (c) 1997--2007 Martin Mares <mj@ucw.cz>
5  *      (c) 2004 Robert Spalek <robert@ucw.cz>
6  *
7  *      This software may be freely distributed and used according to the terms
8  *      of the GNU Lesser General Public License.
9  */
10
11 #ifndef _UCW_FASTBUF_H
12 #define _UCW_FASTBUF_H
13
14 #include <string.h>
15 #include <alloca.h>
16
17 /*
18  *  Generic buffered I/O. You supply hooks to be called for low-level operations
19  *  (swapping of buffers, seeking and closing), we do the rest.
20  *
21  *  Buffer layout when reading:
22  *
23  *  +----------------+---------------------------+
24  *  | read data      | free space                |
25  *  +----------------+---------------------------+
26  *  ^        ^        ^                           ^
27  *  buffer   bptr     bstop                       bufend
28  *
29  *  After the last character is read, bptr == bstop and buffer refill
30  *  is deferred to the next read attempt. This gives us an easy way
31  *  how to implement bungetc().
32  *
33  *  When writing:
34  *
35  *  +--------+--------------+--------------------+
36  *  | unused | written data | free space         |
37  *  +--------+--------------+--------------------+
38  *  ^         ^              ^                    ^
39  *  buffer    bstop          bptr                 bufend
40  *
41  *  Dirty tricks:
42  *
43  *    - You can mix reads and writes on the same stream, but you must
44  *      call bflush() in between and remember that the file position
45  *      points after the flushed buffer which is not necessarily the same
46  *      as after the data you've read.
47  *    - The spout/refill hooks can change not only bptr and bstop, but also
48  *      the location of the buffer; fb-mem.c takes advantage of it.
49  *    - In some cases, the user of the bdirect interface can be allowed to modify
50  *      the data in the buffer to avoid unnecessary copying. If the back-end
51  *      allows such modifications, it can set can_overwrite_buffer accordingly:
52  *              *  0 if no modification is allowed,
53  *              *  1 if the user can modify the buffer on the condition that
54  *                   the modifications will be undone before calling the next
55  *                   fastbuf operation
56  *              *  2 if the user is allowed to overwrite the data in the buffer
57  *                   if bdirect_read_commit_modified() is called afterwards.
58  *                   In this case, the back-end must be prepared for trimming
59  *                   of the buffer which is done by the commit function.
60  */
61
62 struct fastbuf {
63   byte is_fastbuf[0];                   /* Dummy field for checking of type casts */
64   byte *bptr, *bstop;                   /* Access pointers */
65   byte *buffer, *bufend;                /* Start and end of the buffer */
66   char *name;                           /* File name for error messages */
67   sh_off_t pos;                         /* Position of bstop in the file */
68   int (*refill)(struct fastbuf *);      /* Get a buffer with new data */
69   void (*spout)(struct fastbuf *);      /* Write buffer data to the file */
70   int (*seek)(struct fastbuf *, sh_off_t, int);  /* Slow path for bseek(), buffer already flushed; returns success */
71   void (*close)(struct fastbuf *);      /* Close the stream */
72   int (*config)(struct fastbuf *, uns, int);    /* Configure the stream */
73   int can_overwrite_buffer;             /* Can the buffer be altered? (see discussion above) 0=never, 1=temporarily, 2=permanently */
74 };
75
76 /* FastIO on files with run-time parametrization */
77
78 enum fb_type {                          /* Which back-end you want to use */
79   FB_STD,                               /* Standard buffered I/O */
80   FB_DIRECT,                            /* Direct I/O bypassing system caches (see fb-direct.c for description) */
81   FB_MMAP                               /* Memory mapped files */
82 };
83
84 struct fb_params {
85   enum fb_type type;
86   uns buffer_size;
87   /* FB_STD only */
88   uns keep_back_buf;
89   /* FB_DIRECT only */
90   uns read_ahead;                       
91   uns write_back;
92   struct asio_queue *asio;
93 };
94
95 struct cf_section;
96 extern struct cf_section fbpar_cf;
97 extern struct fb_params fbpar_def;
98
99 struct fastbuf *bopen_file(const char *name, int mode, struct fb_params *params);       /* Use params==NULL for defaults */
100 struct fastbuf *bopen_file_try(const char *name, int mode, struct fb_params *params);
101 struct fastbuf *bopen_tmp_file(struct fb_params *params);
102 struct fastbuf *bopen_fd(int fd, struct fb_params *params);
103
104 /* FastIO on standard files (specify buffer size 0 to enable mmaping) */
105
106 struct fastbuf *bfdopen_internal(int fd, const char *name, uns buflen);
107 struct fastbuf *bopen(const char *name, uns mode, uns buflen);
108 struct fastbuf *bopen_try(const char *name, uns mode, uns buflen);
109 struct fastbuf *bopen_tmp(uns buflen);
110 struct fastbuf *bfdopen(int fd, uns buflen);
111 struct fastbuf *bfdopen_shared(int fd, uns buflen);
112 void bfilesync(struct fastbuf *b);
113
114 #define TEMP_FILE_NAME_LEN 256
115 void temp_file_name(char *name);
116
117 /* Internal functions of some file back-ends */
118
119 struct fastbuf *bfmmopen_internal(int fd, const char *name, uns mode);
120
121 extern uns fbdir_cheat;
122 struct asio_queue;
123 struct fastbuf *fbdir_open_fd_internal(int fd, const char *name, struct asio_queue *io_queue, uns buffer_size, uns read_ahead, uns write_back);
124
125 /* FastIO on in-memory streams */
126
127 struct fastbuf *fbmem_create(uns blocksize);            /* Create stream and return its writing fastbuf */
128 struct fastbuf *fbmem_clone_read(struct fastbuf *);     /* Create reading fastbuf */
129
130 /* FastI on file descriptors with limit */
131
132 struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit);
133
134 /* FastIO on static buffers */
135
136 void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size, uns can_overwrite);
137 void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
138 static inline uns
139 fbbuf_count_written(struct fastbuf *f)
140 {
141   return f->bptr - f->bstop;
142 }
143
144 /* FastIO on recyclable growing buffers */
145
146 struct fastbuf *fbgrow_create(unsigned basic_size);
147 void fbgrow_reset(struct fastbuf *b);                   /* Reset stream and prepare for writing */
148 void fbgrow_rewind(struct fastbuf *b);                  /* Prepare for reading */
149
150 /* FastO on memory pools */
151
152 struct mempool;
153 struct fbpool {
154   struct fastbuf fb;
155   struct mempool *mp;
156 };
157
158 void fbpool_init(struct fbpool *fb);    /* Initialize a new fastbuf */
159 void fbpool_start(struct fbpool *fb, struct mempool *mp, uns init_size);
160                                         /* Start a new continuous block and prepare for writing (see mp_start()) */
161 void *fbpool_end(struct fbpool *fb);    /* Close the block and return its address (see mp_end()).
162                                            The length can be determined with mp_size(mp, ptr). */
163
164 /* FastO with atomic writes for multi-threaded programs */
165
166 struct fb_atomic {
167   struct fastbuf fb;
168   struct fb_atomic_file *af;
169   byte *expected_max_bptr;
170   uns slack_size;
171 };
172 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
173
174 struct fastbuf *fbatomic_open(const char *name, struct fastbuf *master, uns bufsize, int record_len);
175 void fbatomic_internal_write(struct fastbuf *b);
176
177 static inline void
178 fbatomic_commit(struct fastbuf *b)
179 {
180   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
181     fbatomic_internal_write(b);
182 }
183
184 /* Configuring stream parameters */
185
186 enum bconfig_type {
187   BCONFIG_IS_TEMP_FILE,
188   BCONFIG_KEEP_BACK_BUF,
189 };
190
191 int bconfig(struct fastbuf *f, uns type, int data);
192
193 /* Universal functions working on all fastbuf's */
194
195 void bclose(struct fastbuf *f);
196 void bflush(struct fastbuf *f);
197 void bseek(struct fastbuf *f, sh_off_t pos, int whence);
198 void bsetpos(struct fastbuf *f, sh_off_t pos);
199 void brewind(struct fastbuf *f);
200 sh_off_t bfilesize(struct fastbuf *f);          // -1 if not seekable
201
202 static inline sh_off_t btell(struct fastbuf *f)
203 {
204   return f->pos + (f->bptr - f->bstop);
205 }
206
207 int bgetc_slow(struct fastbuf *f);
208 static inline int bgetc(struct fastbuf *f)
209 {
210   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
211 }
212
213 int bpeekc_slow(struct fastbuf *f);
214 static inline int bpeekc(struct fastbuf *f)
215 {
216   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
217 }
218
219 static inline void bungetc(struct fastbuf *f)
220 {
221   f->bptr--;
222 }
223
224 void bputc_slow(struct fastbuf *f, uns c);
225 static inline void bputc(struct fastbuf *f, uns c)
226 {
227   if (f->bptr < f->bufend)
228     *f->bptr++ = c;
229   else
230     bputc_slow(f, c);
231 }
232
233 static inline uns
234 bavailr(struct fastbuf *f)
235 {
236   return f->bstop - f->bptr;
237 }
238
239 static inline uns
240 bavailw(struct fastbuf *f)
241 {
242   return f->bufend - f->bptr;
243 }
244
245 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
246 static inline uns bread(struct fastbuf *f, void *b, uns l)
247 {
248   if (bavailr(f) >= l)
249     {
250       memcpy(b, f->bptr, l);
251       f->bptr += l;
252       return l;
253     }
254   else
255     return bread_slow(f, b, l, 0);
256 }
257
258 static inline uns breadb(struct fastbuf *f, void *b, uns l)
259 {
260   if (bavailr(f) >= l)
261     {
262       memcpy(b, f->bptr, l);
263       f->bptr += l;
264       return l;
265     }
266   else
267     return bread_slow(f, b, l, 1);
268 }
269
270 void bwrite_slow(struct fastbuf *f, const void *b, uns l);
271 static inline void bwrite(struct fastbuf *f, const void *b, uns l)
272 {
273   if (bavailw(f) >= l)
274     {
275       memcpy(f->bptr, b, l);
276       f->bptr += l;
277     }
278   else
279     bwrite_slow(f, b, l);
280 }
281
282 /*
283  *  Functions for reading of strings:
284  *
285  *     bgets()          reads a line, strip the trailing '\n' and return a pointer
286  *                      to the terminating 0 or NULL on EOF. Dies if the line is too long.
287  *     bgets0()         does the same for 0-terminated strings.
288  *     bgets_nodie()    a variant of bgets() which returns either the length of the
289  *                      string (excluding the terminator) or -1 if the line does not fit
290  *                      in the buffer. In such cases, it returns after reading exactly `l'
291  *                      bytes of input.
292  *     bgets_bb()       a variant of bgets() which allocates the string in a growing buffer
293  *     bgets_mp()       the same, but in a mempool
294  *     bgets_stk()      the same, but on the stack by alloca()
295  */
296
297 char *bgets(struct fastbuf *f, char *b, uns l);
298 char *bgets0(struct fastbuf *f, char *b, uns l);
299 int bgets_nodie(struct fastbuf *f, char *b, uns l);
300
301 struct mempool;
302 struct bb_t;
303 uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
304 char *bgets_mp(struct fastbuf *f, struct mempool *mp);
305
306 struct bgets_stk_struct {
307   struct fastbuf *f;
308   byte *old_buf, *cur_buf, *src;
309   uns old_len, cur_len, src_len;
310 };
311 void bgets_stk_init(struct bgets_stk_struct *s);
312 void bgets_stk_step(struct bgets_stk_struct *s);
313 #define bgets_stk(fb) ({ struct bgets_stk_struct _s; _s.f = (fb); for (bgets_stk_init(&_s); _s.cur_len; _s.cur_buf = alloca(_s.cur_len), bgets_stk_step(&_s)); _s.cur_buf; })
314
315 static inline void
316 bputs(struct fastbuf *f, const char *b)
317 {
318   bwrite(f, b, strlen(b));
319 }
320
321 static inline void
322 bputs0(struct fastbuf *f, const char *b)
323 {
324   bwrite(f, b, strlen(b)+1);
325 }
326
327 static inline void
328 bputsn(struct fastbuf *f, const char *b)
329 {
330   bputs(f, b);
331   bputc(f, '\n');
332 }
333
334 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
335 static inline void
336 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
337 {
338   if (bavailr(f) >= l && bavailw(t) >= l)
339     {
340       memcpy(t->bptr, f->bptr, l);
341       t->bptr += l;
342       f->bptr += l;
343     }
344   else
345     bbcopy_slow(f, t, l);
346 }
347
348 int bskip_slow(struct fastbuf *f, uns len);
349 static inline int bskip(struct fastbuf *f, uns len)
350 {
351   if (bavailr(f) >= len)
352     {
353       f->bptr += len;
354       return 1;
355     }
356   else
357     return bskip_slow(f, len);
358 }
359
360 /* Direct I/O on buffers */
361
362 static inline uns
363 bdirect_read_prepare(struct fastbuf *f, byte **buf)
364 {
365   if (f->bptr == f->bstop && !f->refill(f))
366     {
367       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
368       return 0;
369     }
370   *buf = f->bptr;
371   return bavailr(f);
372 }
373
374 static inline void
375 bdirect_read_commit(struct fastbuf *f, byte *pos)
376 {
377   f->bptr = pos;
378 }
379
380 static inline void
381 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
382 {
383   f->bptr = pos;
384   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
385 }
386
387 static inline uns
388 bdirect_write_prepare(struct fastbuf *f, byte **buf)
389 {
390   if (f->bptr == f->bufend)
391     f->spout(f);
392   *buf = f->bptr;
393   return bavailw(f);
394 }
395
396 static inline void
397 bdirect_write_commit(struct fastbuf *f, byte *pos)
398 {
399   f->bptr = pos;
400 }
401
402 /* Formatted output */
403
404 int bprintf(struct fastbuf *b, const char *msg, ...) FORMAT_CHECK(printf,2,3);
405 int vbprintf(struct fastbuf *b, const char *msg, va_list args);
406
407 #endif