]> mj.ucw.cz Git - libucw.git/blob - lib/fastbuf.h
Cleaned up the fastbuf interfaces.
[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   byte *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   uns read_ahead;                       /* The next three fields are used for FB_DIRECT files */
88   uns write_back;
89   struct asio_queue *asio;
90 };
91
92 struct cf_section;
93 extern struct cf_section fbpar_cf;
94 extern struct fb_params fbpar_def;
95
96 struct fastbuf *bopen_file(byte *name, int mode, struct fb_params *params);             /* Use params==NULL for defaults */
97 struct fastbuf *bopen_file_try(byte *name, int mode, struct fb_params *params);
98 struct fastbuf *bopen_tmp_file(struct fb_params *params);
99 struct fastbuf *bopen_fd(int fd, struct fb_params *params);
100
101 /* FastIO on standard files (specify buffer size 0 to enable mmaping) */
102
103 struct fastbuf *bfdopen_internal(int fd, byte *name, uns buflen);
104 struct fastbuf *bopen(byte *name, uns mode, uns buflen);
105 struct fastbuf *bopen_try(byte *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 #define TEMP_FILE_NAME_LEN 256
112 void temp_file_name(byte *name);
113
114 /* Internal functions of some file back-ends */
115
116 struct fastbuf *bfmmopen_internal(int fd, byte *name, uns mode);
117
118 extern uns fbdir_cheat;
119 struct asio_queue;
120 struct fastbuf *fbdir_open_fd_internal(int fd, byte *name, struct asio_queue *io_queue, uns buffer_size, uns read_ahead, uns write_back);
121
122 /* FastIO on in-memory streams */
123
124 struct fastbuf *fbmem_create(unsigned blocksize);       /* Create stream and return its writing fastbuf */
125 struct fastbuf *fbmem_clone_read(struct fastbuf *);     /* Create reading fastbuf */
126
127 /* FastI on file descriptors with limit */
128
129 struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit);
130
131 /* FastIO on static buffers */
132
133 void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size, uns can_overwrite);
134 void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
135 static inline uns
136 fbbuf_count_written(struct fastbuf *f)
137 {
138   return f->bptr - f->bstop;
139 }
140
141 /* FastIO on recyclable growing buffers */
142
143 struct fastbuf *fbgrow_create(unsigned basic_size);
144 void fbgrow_reset(struct fastbuf *b);                   /* Reset stream and prepare for writing */
145 void fbgrow_rewind(struct fastbuf *b);                  /* Prepare for reading */
146
147 /* FastO with atomic writes for multi-threaded programs */
148
149 struct fb_atomic {
150   struct fastbuf fb;
151   struct fb_atomic_file *af;
152   byte *expected_max_bptr;
153   uns slack_size;
154 };
155 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
156
157 struct fastbuf *fbatomic_open(byte *name, struct fastbuf *master, uns bufsize, int record_len);
158 void fbatomic_internal_write(struct fastbuf *b);
159
160 static inline void
161 fbatomic_commit(struct fastbuf *b)
162 {
163   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
164     fbatomic_internal_write(b);
165 }
166
167 /* Configuring stream parameters */
168
169 int bconfig(struct fastbuf *f, uns type, int data);
170
171 #define BCONFIG_IS_TEMP_FILE 0
172
173 /* Universal functions working on all fastbuf's */
174
175 void bclose(struct fastbuf *f);
176 void bflush(struct fastbuf *f);
177 void bseek(struct fastbuf *f, sh_off_t pos, int whence);
178 void bsetpos(struct fastbuf *f, sh_off_t pos);
179 void brewind(struct fastbuf *f);
180 sh_off_t bfilesize(struct fastbuf *f);          // -1 if not seekable
181
182 static inline sh_off_t btell(struct fastbuf *f)
183 {
184   return f->pos + (f->bptr - f->bstop);
185 }
186
187 int bgetc_slow(struct fastbuf *f);
188 static inline int bgetc(struct fastbuf *f)
189 {
190   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
191 }
192
193 int bpeekc_slow(struct fastbuf *f);
194 static inline int bpeekc(struct fastbuf *f)
195 {
196   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
197 }
198
199 static inline void bungetc(struct fastbuf *f)
200 {
201   f->bptr--;
202 }
203
204 void bputc_slow(struct fastbuf *f, uns c);
205 static inline void bputc(struct fastbuf *f, uns c)
206 {
207   if (f->bptr < f->bufend)
208     *f->bptr++ = c;
209   else
210     bputc_slow(f, c);
211 }
212
213 static inline uns
214 bavailr(struct fastbuf *f)
215 {
216   return f->bstop - f->bptr;
217 }
218
219 static inline uns
220 bavailw(struct fastbuf *f)
221 {
222   return f->bufend - f->bptr;
223 }
224
225 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
226 static inline uns bread(struct fastbuf *f, void *b, uns l)
227 {
228   if (bavailr(f) >= l)
229     {
230       memcpy(b, f->bptr, l);
231       f->bptr += l;
232       return l;
233     }
234   else
235     return bread_slow(f, b, l, 0);
236 }
237
238 static inline uns breadb(struct fastbuf *f, void *b, uns l)
239 {
240   if (bavailr(f) >= l)
241     {
242       memcpy(b, f->bptr, l);
243       f->bptr += l;
244       return l;
245     }
246   else
247     return bread_slow(f, b, l, 1);
248 }
249
250 void bwrite_slow(struct fastbuf *f, void *b, uns l);
251 static inline void bwrite(struct fastbuf *f, void *b, uns l)
252 {
253   if (bavailw(f) >= l)
254     {
255       memcpy(f->bptr, b, l);
256       f->bptr += l;
257     }
258   else
259     bwrite_slow(f, b, l);
260 }
261
262 byte *bgets(struct fastbuf *f, byte *b, uns l); /* Non-std */
263 int bgets_nodie(struct fastbuf *f, byte *b, uns l);
264 byte *bgets0(struct fastbuf *f, byte *b, uns l);
265
266 struct mempool;
267 struct bb_t;
268 uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
269 byte *bgets_mp(struct fastbuf *f, struct mempool *mp);
270
271 struct bgets_stk_struct {
272   struct fastbuf *f;
273   byte *old_buf, *cur_buf, *src;
274   uns old_len, cur_len, src_len;
275 };
276 void bgets_stk_init(struct bgets_stk_struct *s);
277 void bgets_stk_step(struct bgets_stk_struct *s);
278 #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; })
279
280 static inline void
281 bputs(struct fastbuf *f, byte *b)
282 {
283   bwrite(f, b, strlen(b));
284 }
285
286 static inline void
287 bputs0(struct fastbuf *f, byte *b)
288 {
289   bwrite(f, b, strlen(b)+1);
290 }
291
292 static inline void
293 bputsn(struct fastbuf *f, byte *b)
294 {
295   bputs(f, b);
296   bputc(f, '\n');
297 }
298
299 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
300 static inline void
301 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
302 {
303   if (bavailr(f) >= l && bavailw(t) >= l)
304     {
305       memcpy(t->bptr, f->bptr, l);
306       t->bptr += l;
307       f->bptr += l;
308     }
309   else
310     bbcopy_slow(f, t, l);
311 }
312
313 int bskip_slow(struct fastbuf *f, uns len);
314 static inline int bskip(struct fastbuf *f, uns len)
315 {
316   if (bavailr(f) >= len)
317     {
318       f->bptr += len;
319       return 1;
320     }
321   else
322     return bskip_slow(f, len);
323 }
324
325 /* Direct I/O on buffers */
326
327 static inline uns
328 bdirect_read_prepare(struct fastbuf *f, byte **buf)
329 {
330   if (f->bptr == f->bstop && !f->refill(f))
331     {
332       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
333       return 0;
334     }
335   *buf = f->bptr;
336   return bavailr(f);
337 }
338
339 static inline void
340 bdirect_read_commit(struct fastbuf *f, byte *pos)
341 {
342   f->bptr = pos;
343 }
344
345 static inline void
346 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
347 {
348   f->bptr = pos;
349   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
350 }
351
352 static inline uns
353 bdirect_write_prepare(struct fastbuf *f, byte **buf)
354 {
355   if (f->bptr == f->bufend)
356     f->spout(f);
357   *buf = f->bptr;
358   return bavailw(f);
359 }
360
361 static inline void
362 bdirect_write_commit(struct fastbuf *f, byte *pos)
363 {
364   f->bptr = pos;
365 }
366
367 /* Formatted output */
368
369 int bprintf(struct fastbuf *b, char *msg, ...) FORMAT_CHECK(printf,2,3);
370 int vbprintf(struct fastbuf *b, char *msg, va_list args);
371
372 #endif