]> mj.ucw.cz Git - libucw.git/blob - ucw/fastbuf.h
The big move. Step #1: Move whole lib/ to ucw/.
[libucw.git] / ucw / 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 several configurable back-ends */
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 a description) */
81   FB_MMAP                               /* Memory mapped files */
82 };
83
84 struct fb_params {
85   enum fb_type type;
86   uns buffer_size;                      /* 0 for default size */
87   uns keep_back_buf;                    /* FB_STD: optimize for bi-directional access */
88   uns read_ahead;                       /* FB_DIRECT options */
89   uns write_back;
90   struct asio_queue *asio;
91 };
92
93 struct cf_section;
94 extern struct cf_section fbpar_cf;
95 extern struct fb_params fbpar_def;
96
97 struct fastbuf *bopen_file(const char *name, int mode, struct fb_params *params);       /* Use params==NULL for defaults */
98 struct fastbuf *bopen_file_try(const char *name, int mode, struct fb_params *params);
99 struct fastbuf *bopen_tmp_file(struct fb_params *params);
100 struct fastbuf *bopen_fd(int fd, struct fb_params *params);
101
102 /* FastIO on standard files (shortcuts for FB_STD) */
103
104 struct fastbuf *bopen(const char *name, uns mode, uns buflen);
105 struct fastbuf *bopen_try(const char *name, uns mode, uns buflen);
106 struct fastbuf *bopen_tmp(uns buflen);
107 struct fastbuf *bfdopen(int fd, uns buflen);
108 struct fastbuf *bfdopen_shared(int fd, uns buflen);
109 void bfilesync(struct fastbuf *b);
110
111 /* Temporary files */
112
113 #define TEMP_FILE_NAME_LEN 256
114 void temp_file_name(char *name);
115 void bfix_tmp_file(struct fastbuf *fb, const char *name);
116
117 /* Internal functions of some file back-ends */
118
119 struct fastbuf *bfdopen_internal(int fd, const char *name, uns buflen);
120 struct fastbuf *bfmmopen_internal(int fd, const char *name, uns mode);
121
122 extern uns fbdir_cheat;
123 struct asio_queue;
124 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);
125
126 void bclose_file_helper(struct fastbuf *f, int fd, int is_temp_file);
127
128 /* FastIO on in-memory streams */
129
130 struct fastbuf *fbmem_create(uns blocksize);            /* Create stream and return its writing fastbuf */
131 struct fastbuf *fbmem_clone_read(struct fastbuf *);     /* Create reading fastbuf */
132
133 /* FastI on file descriptors with limit */
134
135 struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit);
136
137 /* FastIO on static buffers */
138
139 void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size, uns can_overwrite);
140 void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
141 static inline uns
142 fbbuf_count_written(struct fastbuf *f)
143 {
144   return f->bptr - f->bstop;
145 }
146
147 /* FastIO on recyclable growing buffers */
148
149 struct fastbuf *fbgrow_create(unsigned basic_size);
150 void fbgrow_reset(struct fastbuf *b);                   /* Reset stream and prepare for writing */
151 void fbgrow_rewind(struct fastbuf *b);                  /* Prepare for reading */
152
153 /* FastO on memory pools */
154
155 struct mempool;
156 struct fbpool {
157   struct fastbuf fb;
158   struct mempool *mp;
159 };
160
161 void fbpool_init(struct fbpool *fb);    /* Initialize a new fastbuf */
162 void fbpool_start(struct fbpool *fb, struct mempool *mp, uns init_size);
163                                         /* Start a new continuous block and prepare for writing (see mp_start()) */
164 void *fbpool_end(struct fbpool *fb);    /* Close the block and return its address (see mp_end()).
165                                            The length can be determined with mp_size(mp, ptr). */
166
167 /* FastO with atomic writes for multi-threaded programs */
168
169 struct fb_atomic {
170   struct fastbuf fb;
171   struct fb_atomic_file *af;
172   byte *expected_max_bptr;
173   uns slack_size;
174 };
175 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
176
177 struct fastbuf *fbatomic_open(const char *name, struct fastbuf *master, uns bufsize, int record_len);
178 void fbatomic_internal_write(struct fastbuf *b);
179
180 static inline void
181 fbatomic_commit(struct fastbuf *b)
182 {
183   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
184     fbatomic_internal_write(b);
185 }
186
187 /* Configuring stream parameters */
188
189 enum bconfig_type {
190   BCONFIG_IS_TEMP_FILE,                 /* 0=normal file, 1=temporary file, 2=shared fd */
191   BCONFIG_KEEP_BACK_BUF,                /* Optimize for bi-directional access */
192 };
193
194 int bconfig(struct fastbuf *f, uns type, int data);
195
196 /* Universal functions working on all fastbuf's */
197
198 void bclose(struct fastbuf *f);
199 void bflush(struct fastbuf *f);
200 void bseek(struct fastbuf *f, sh_off_t pos, int whence);
201 void bsetpos(struct fastbuf *f, sh_off_t pos);
202 void brewind(struct fastbuf *f);
203 sh_off_t bfilesize(struct fastbuf *f);          /* -1 if not seekable */
204
205 static inline sh_off_t btell(struct fastbuf *f)
206 {
207   return f->pos + (f->bptr - f->bstop);
208 }
209
210 int bgetc_slow(struct fastbuf *f);
211 static inline int bgetc(struct fastbuf *f)
212 {
213   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
214 }
215
216 int bpeekc_slow(struct fastbuf *f);
217 static inline int bpeekc(struct fastbuf *f)
218 {
219   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
220 }
221
222 static inline void bungetc(struct fastbuf *f)
223 {
224   f->bptr--;
225 }
226
227 void bputc_slow(struct fastbuf *f, uns c);
228 static inline void bputc(struct fastbuf *f, uns c)
229 {
230   if (f->bptr < f->bufend)
231     *f->bptr++ = c;
232   else
233     bputc_slow(f, c);
234 }
235
236 static inline uns
237 bavailr(struct fastbuf *f)
238 {
239   return f->bstop - f->bptr;
240 }
241
242 static inline uns
243 bavailw(struct fastbuf *f)
244 {
245   return f->bufend - f->bptr;
246 }
247
248 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
249 static inline uns bread(struct fastbuf *f, void *b, uns l)
250 {
251   if (bavailr(f) >= l)
252     {
253       memcpy(b, f->bptr, l);
254       f->bptr += l;
255       return l;
256     }
257   else
258     return bread_slow(f, b, l, 0);
259 }
260
261 static inline uns breadb(struct fastbuf *f, void *b, uns l)
262 {
263   if (bavailr(f) >= l)
264     {
265       memcpy(b, f->bptr, l);
266       f->bptr += l;
267       return l;
268     }
269   else
270     return bread_slow(f, b, l, 1);
271 }
272
273 void bwrite_slow(struct fastbuf *f, const void *b, uns l);
274 static inline void bwrite(struct fastbuf *f, const void *b, uns l)
275 {
276   if (bavailw(f) >= l)
277     {
278       memcpy(f->bptr, b, l);
279       f->bptr += l;
280     }
281   else
282     bwrite_slow(f, b, l);
283 }
284
285 /*
286  *  Functions for reading of strings:
287  *
288  *     bgets()          reads a line, strip the trailing '\n' and return a pointer
289  *                      to the terminating 0 or NULL on EOF. Dies if the line is too long.
290  *     bgets0()         does the same for 0-terminated strings.
291  *     bgets_nodie()    a variant of bgets() which returns either the length of the
292  *                      string (excluding the terminator) or -1 if the line does not fit
293  *                      in the buffer. In such cases, it returns after reading exactly `l'
294  *                      bytes of input.
295  *     bgets_bb()       a variant of bgets() which allocates the string in a growing buffer
296  *     bgets_mp()       the same, but in a mempool
297  *     bgets_stk()      the same, but on the stack by alloca()
298  */
299
300 char *bgets(struct fastbuf *f, char *b, uns l);
301 char *bgets0(struct fastbuf *f, char *b, uns l);
302 int bgets_nodie(struct fastbuf *f, char *b, uns l);
303
304 struct mempool;
305 struct bb_t;
306 uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
307 char *bgets_mp(struct fastbuf *f, struct mempool *mp);
308
309 struct bgets_stk_struct {
310   struct fastbuf *f;
311   byte *old_buf, *cur_buf, *src;
312   uns old_len, cur_len, src_len;
313 };
314 void bgets_stk_init(struct bgets_stk_struct *s);
315 void bgets_stk_step(struct bgets_stk_struct *s);
316 #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; })
317
318 static inline void
319 bputs(struct fastbuf *f, const char *b)
320 {
321   bwrite(f, b, strlen(b));
322 }
323
324 static inline void
325 bputs0(struct fastbuf *f, const char *b)
326 {
327   bwrite(f, b, strlen(b)+1);
328 }
329
330 static inline void
331 bputsn(struct fastbuf *f, const char *b)
332 {
333   bputs(f, b);
334   bputc(f, '\n');
335 }
336
337 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
338 static inline void
339 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
340 {
341   if (bavailr(f) >= l && bavailw(t) >= l)
342     {
343       memcpy(t->bptr, f->bptr, l);
344       t->bptr += l;
345       f->bptr += l;
346     }
347   else
348     bbcopy_slow(f, t, l);
349 }
350
351 int bskip_slow(struct fastbuf *f, uns len);
352 static inline int bskip(struct fastbuf *f, uns len)
353 {
354   if (bavailr(f) >= len)
355     {
356       f->bptr += len;
357       return 1;
358     }
359   else
360     return bskip_slow(f, len);
361 }
362
363 /* Direct I/O on buffers */
364
365 static inline uns
366 bdirect_read_prepare(struct fastbuf *f, byte **buf)
367 {
368   if (f->bptr == f->bstop && !f->refill(f))
369     {
370       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
371       return 0;
372     }
373   *buf = f->bptr;
374   return bavailr(f);
375 }
376
377 static inline void
378 bdirect_read_commit(struct fastbuf *f, byte *pos)
379 {
380   f->bptr = pos;
381 }
382
383 static inline void
384 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
385 {
386   f->bptr = pos;
387   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
388 }
389
390 static inline uns
391 bdirect_write_prepare(struct fastbuf *f, byte **buf)
392 {
393   if (f->bptr == f->bufend)
394     f->spout(f);
395   *buf = f->bptr;
396   return bavailw(f);
397 }
398
399 static inline void
400 bdirect_write_commit(struct fastbuf *f, byte *pos)
401 {
402   f->bptr = pos;
403 }
404
405 /* Formatted output */
406
407 int bprintf(struct fastbuf *b, const char *msg, ...) FORMAT_CHECK(printf,2,3);
408 int vbprintf(struct fastbuf *b, const char *msg, va_list args);
409
410 #endif