]> mj.ucw.cz Git - libucw.git/blob - ucw/fastbuf.h
Doc: Updated the rules for fastbuf back-ends.
[libucw.git] / ucw / fastbuf.h
1 /*
2  *      UCW Library -- Fast Buffered I/O
3  *
4  *      (c) 1997--2008 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  * === Internal structure [[internal]]
19  *
20  * Generally speaking, a fastbuf consists of a buffer and a set of callbacks.
21  * All front-end functions operate on the buffer and if the buffer becomes
22  * empty or fills up, they ask the corresponding callback to handle the
23  * situation. Back-ends then differ just in the definition of the callbacks.
24  *
25  * The state of the fastbuf is represented by a <<struct_fastbuf,`struct fastbuf`>>,
26  * which is a simple structure describing the state of the buffer (the pointers
27  * `buffer`, `bufend`), the front-end cursor (`bptr`), the back-end cursor (`bstop`),
28  * position of the back-end cursor in the file (`pos`), some flags (`flags`)
29  * and pointers to the callback functions.
30  *
31  * The buffer can be in one of the following states:
32  *
33  * 1. Flushed:
34  *
35  *    +------------------------------------+---------------------------+
36  *    | unused                             | free space                |
37  *    +------------------------------------+---------------------------+
38  *    ^              ^                     ^                           ^
39  *    buffer      <= bstop (BE pos)     <= bptr (FE pos)            <= bufend
40  *
41  *   * This schema describes a fastbuf after its initialization or bflush().
42  *   * There is no cached data and we are ready for any read or write operation
43  *     (well, only if the back-end supports it).
44  *   * The interval `[bptr, bufend]` can be used by front-ends
45  *     for writing. If it is empty, the `spout` callback gets called
46  *     upon the first write attempt to allocate a new buffer. Otherwise
47  *     the fastbuf silently comes to the writing mode.
48  *   * When a front-end needs to read something, it calls the `refill` callback.
49  *   * The pointers can be either all non-`NULL` or all NULL.
50  *   * `bstop == bptr` in most back-ends, but it is not necessary. Some
51  *     in-memory streams take advantage of this.
52  *
53  * 2. Reading:
54  *
55  *    +------------------------------------+---------------------------+
56  *    | read data                          | unused                    |
57  *    +------------------------------------+---------------------------+
58  *    ^               ^                    ^                           ^
59  *    buffer       <= bptr (FE pos)     <= bstop (BE pos)           <= bufend
60  *
61  *   * If we try to read something, we get to the reading mode.
62  *   * No writing is allowed until a flush operation. But note that @bflush()
63  *     will simply set `bptr` to `bstop` before `spout`
64  *     and it breaks the position of the front-end's cursor,
65  *     so the user should seek afwards.
66  *   * The interval `[buffer, bstop]` contains a block of data read by the back-end.
67  *     `bptr` is the front-end's cursor which points to the next character to be read.
68  *     After the last character is read, `bptr == bstop` and the `refill` callback
69  *     gets called upon the next read attempt to bring further data.
70  *     This gives us an easy way how to implement @bungetc().
71  *
72  * 3. Writing:
73  *
74  *    +-----------------------+----------------+-----------------------+
75  *    | unused                | written data   | free space            |
76  *    +-----------------------+----------------+-----------------------+
77  *    ^            ^                           ^                       ^
78  *    buffer    <= bstop (BE pos)            < bptr (FE pos)        <= bufend
79  *
80  *   * This schema corresponds to the situation after a write attempt.
81  *   * No reading is allowed until a flush operation.
82  *   * The `bptr` points at the position where the next character
83  *     will be written to. When we want to write, but `bptr == bufend`, we call
84  *     the `spout` hook to flush the witten data and get an empty buffer.
85  *   * `bstop` usually points at the beginning of the written data,
86  *     but it is not necessary.
87  *
88  *
89  * Rules for back-ends:
90  *
91  *   - Front-ends are only allowed to change the value of `bptr`, some flags
92  *     and if a fatal error occurs, then also `bstop`. Back-ends can rely on it.
93  *   - `buffer <= bstop <= bufend` and `buffer <= bptr <= bufend`.
94  *   - `pos` should be the real position in the file corresponding to the location of `bstop` in the buffer.
95  *     It can be modified by any back-end's callback, but the position of `bptr` (`pos + (bptr - bstop)`)
96  *     must stay unchanged (except the `seek` callback of course).
97  *   - Failed callbacks (except `close`) should use @bthrow().
98  *   - Any callback pointer may be NULL in case the callback is not implemented.
99  *   - Callbacks can change not only `bptr` and `bstop`, but also the location and size of the buffer;
100  *     the fb-mem back-end takes advantage of it.
101  *
102  *   - Initialization:
103  *     * out: `buffer <= bstop <= bptr <= bufend` (flushed).
104  *
105  *   - `refill`:
106  *     * in: `buffer <= bstop <= bptr <= bufend` (reading or flushed).
107  *     * out: `buffer <= bptr <= bstop <= bufend` (reading).
108  *     * Resulting `bptr == bstop` signals the end of file.
109  *       The next reading attempt will again call `refill` which can succeed this time.
110  *     * The callback must also return zero on EOF (iff `bptr == bstop`).
111  *
112  *   - `spout`:
113  *     * in: `buffer <= bstop <= bptr <= bufend` (writing or flushed).
114  *     * out: `buffer <= bstop <= bptr < bufend` (flushed).
115  *
116  *   - `seek`:
117  *     * in: `buffer <= bstop <= bptr <= bufend` (flushed).
118  *     * in: `(ofs >= 0 && whence == SEEK_SET) || (ofs <= 0 && whence == SEEK_END)`.
119  *     * out: `buffer <= bstop <= bptr <= bufend` (flushed).
120  *
121  *   - `close`:
122  *     * in: `buffer <= bstop <= bptr <= bufend` (flushed or after @bthrow()).
123  *     * `close` must always free all internal structures, even when it throws an exception.
124  ***/
125
126 /**
127  * This structure contains the state of the fastbuf. See the discussion above
128  * for how it works.
129  **/
130 struct fastbuf {
131   byte is_fastbuf[0];                           /* Dummy field for checking of type casts */
132   byte *bptr, *bstop;                           /* State of the buffer */
133   byte *buffer, *bufend;                        /* Start and end of the buffer */
134   char *name;                                   /* File name (used for error messages) */
135   ucw_off_t pos;                                /* Position of bstop in the file */
136   int (*refill)(struct fastbuf *);              /* Get a buffer with new data, returns 0 on EOF */
137   void (*spout)(struct fastbuf *);              /* Write buffer data to the file */
138   int (*seek)(struct fastbuf *, ucw_off_t, int);/* Slow path for @bseek(), buffer already flushed; returns success */
139   void (*close)(struct fastbuf *);              /* Close the stream */
140   int (*config)(struct fastbuf *, uns, int);    /* Configure the stream */
141   int can_overwrite_buffer;                     /* Can the buffer be altered? 0=never, 1=temporarily, 2=permanently */
142 };
143
144 /***
145  * === Fastbuf on files [[fbparam]]
146  *
147  * If you want to use fastbufs to access files, you can choose one of several
148  * back-ends and set their parameters.
149  ***/
150
151 /**
152  * Back-end types
153  */
154 enum fb_type {
155   FB_STD,                               /* Standard buffered I/O */
156   FB_DIRECT,                            /* Direct I/O bypassing system caches (see fb-direct.c for a description) */
157   FB_MMAP                               /* Memory mapped files */
158 };
159
160 /**
161  * When you open a file fastbuf, you can use this structure to select a back-end
162  * and set its parameters. If you want just an "ordinary" file stream, you can
163  * happily pass NULL instead and the defaults from the configuration file (or
164  * hard-wired defaults if no config file has been read) will be used.
165  */
166 struct fb_params {
167   enum fb_type type;                    /* The chosen back-end */
168   uns buffer_size;                      /* 0 for default size */
169   uns keep_back_buf;                    /* FB_STD: optimize for bi-directional access */
170   uns read_ahead;                       /* FB_DIRECT options */
171   uns write_back;
172   struct asio_queue *asio;
173 };
174
175 struct cf_section;
176 extern struct cf_section fbpar_cf;      /** Configuration section with which you can fill the `fb_params` **/
177 extern struct fb_params fbpar_def;      /** The default `fb_params` **/
178
179 /**
180  * Opens a file with file mode @mode (see the man page of open()).
181  * Use @params to select the fastbuf back-end and its parameters or
182  * pass NULL if you are fine with defaults.
183  *
184  * Dies if the file does not exist.
185  **/
186 struct fastbuf *bopen_file(const char *name, int mode, struct fb_params *params);
187 struct fastbuf *bopen_file_try(const char *name, int mode, struct fb_params *params); /** Like bopen_file(), but returns NULL on failure. **/
188
189 /**
190  * Opens a temporary file.
191  * It is placed with other temp files and it is deleted when closed.
192  * Again, use NULL for @params if you want the defaults.
193  **/
194 struct fastbuf *bopen_tmp_file(struct fb_params *params);
195
196 /**
197  * Creates a fastbuf from a file descriptor @fd and sets its filename
198  * to @name (the name is used only in error messages).
199  * When the fastbuf is closed, the fd is closed as well. You can override
200  * this behavior by calling @bconfig().
201  */
202 struct fastbuf *bopen_fd_name(int fd, struct fb_params *params, const char *name);
203 static inline struct fastbuf *bopen_fd(int fd, struct fb_params *params) /** Same as above, but with an auto-generated filename. **/
204 {
205   return bopen_fd_name(fd, params, NULL);
206 }
207
208 /**
209  * Flushes all buffers and makes sure that they are written to the disk.
210  **/
211 void bfilesync(struct fastbuf *b);
212
213 /***
214  * === Fastbufs on regular files [[fbfile]]
215  *
216  * If you want to use the `FB_STD` back-end and not worry about setting
217  * up any parameters, there is a couple of shortcuts.
218  ***/
219
220 struct fastbuf *bopen(const char *name, uns mode, uns buflen);          /** Equivalent to @bopen_file() with `FB_STD` back-end. **/
221 struct fastbuf *bopen_try(const char *name, uns mode, uns buflen);      /** Equivalent to @bopen_file_try() with `FB_STD` back-end. **/
222 struct fastbuf *bopen_tmp(uns buflen);                                  /** Equivalent to @bopen_tmp_file() with `FB_STD` back-end. **/
223 struct fastbuf *bfdopen(int fd, uns buflen);                            /** Equivalent to @bopen_fd() with `FB_STD` back-end. **/
224 struct fastbuf *bfdopen_shared(int fd, uns buflen);                     /** Like @bfdopen(), but it does not close the @fd on @bclose(). **/
225
226 /***
227  * === Temporary files [[fbtemp]]
228  *
229  * Usually, @bopen_tmp_file() is the best way how to come to a temporary file.
230  * However, in some specific cases you can need more, so there is also a set
231  * of more general functions.
232  ***/
233
234 #define TEMP_FILE_NAME_LEN 256
235
236 /**
237  * Generates a temporary filename and stores it to the @name_buf (of size
238  * at least * `TEMP_FILE_NAME_LEN`). If @open_flags are not NULL, flags that
239  * should be OR-ed with other flags to open() will be stored there.
240  *
241  * The location and style of temporary files is controlled by the configuration.
242  * By default, the system temp directory (`$TMPDIR` or `/tmp`) is used.
243  *
244  * If the location is a publicly writeable directory (like `/tmp`), the
245  * generated filename cannot be guaranteed to be unique, so @open_flags
246  * will include `O_EXCL` and you have to check the result of open() and
247  * iterate if needed.
248  *
249  * This function is not specific to fastbufs, it can be used separately.
250  **/
251 void temp_file_name(char *name_buf, int *open_flags);
252
253 /**
254  * Opens a temporary file and returns its file descriptor.
255  * You specify the file @mode and @open_flags passed to open().
256  *
257  * If the @name_buf (of at last `TEMP_FILE_NAME_LEN` chars) is not NULL,
258  * the filename is also stored in it.
259  *
260  * This function is not specific to fastbufs, it can be used separately.
261  */
262 int open_tmp(char *name_buf, int open_flags, int mode);
263
264 /**
265  * Sometimes, a file is created as temporary and then moved to a stable
266  * location. This function takes a fastbuf created by @bopen_tmp_file()
267  * or @bopen_tmp(), marks it as permanent, closes it and renames it to
268  * @name.
269  *
270  * Please note that it assumes that the temporary file and the @name
271  * are on the same volume (otherwise, rename() fails), so you might
272  * want to configure a special location for the temporary files
273  * beforehand.
274  */
275 void bfix_tmp_file(struct fastbuf *fb, const char *name);
276
277 /* Internal functions of some file back-ends */
278
279 struct fastbuf *bfdopen_internal(int fd, const char *name, uns buflen);
280 struct fastbuf *bfmmopen_internal(int fd, const char *name, uns mode);
281
282 extern uns fbdir_cheat;
283 struct asio_queue;
284 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);
285
286 void bclose_file_helper(struct fastbuf *f, int fd, int is_temp_file);
287
288 /***
289  * === Fastbufs on file fragments [[fblim]]
290  *
291  * The `fblim` back-end reads from a file handle, but at most a given
292  * number of bytes. This is frequently used for reading from sockets.
293  ***/
294
295 struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit); /** Create a fastbuf which reads at most @limit bytes from @fd. **/
296
297 /***
298  * === Fastbufs on in-memory streams [[fbmem]]
299  *
300  * The `fbmem` back-end keeps the whole contents of the stream
301  * in memory (as a linked list of memory blocks, so address space
302  * fragmentation is avoided).
303  *
304  * First, you use @fbmem_create() to create the stream and the fastbuf
305  * used for writing to it. Then you can call @fbmem_clone_read() to get
306  * an arbitrary number of fastbuf for reading from the stream.
307  ***/
308
309 struct fastbuf *fbmem_create(uns blocksize);            /** Create stream and return its writing fastbuf. **/
310 struct fastbuf *fbmem_clone_read(struct fastbuf *f);    /** Given a writing fastbuf, create a new reading fastbuf. **/
311
312 /***
313  * === Fastbufs on static buffers [[fbbuf]]
314  *
315  * The `fbbuf` back-end stores the stream in a given block of memory.
316  * This is useful for parsing and generating of complex data structures.
317  ***/
318
319 /**
320  * Creates a read-only fastbuf that takes its data from a given buffer.
321  * The fastbuf structure is allocated by the caller and pointed to by @f.
322  * The @buffer and @size specify the location and size of the buffer.
323  *
324  * In some cases, the front-ends can take advantage of rewriting the contents
325  * of the buffer temporarily. In this case, set @can_overwrite as described
326  * in <<internal,Internals>>. If you do not care, keep @can_overwrite zero.
327  *
328  * It is not possible to close this fastbuf.
329  */
330 void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size, uns can_overwrite);
331
332 /**
333  * Creates a write-only fastbuf which writes into a provided memory buffer.
334  * The fastbuf structure is allocated by the caller and pointed to by @f.
335  * An attempt to write behind the end of the buffer dies.
336  *
337  * Data are written directly into the buffer, so it is not necessary to call @bflush()
338  * at any moment.
339  *
340  * It is not possible to close this fastbuf.
341  */
342 void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
343
344 static inline uns fbbuf_count_written(struct fastbuf *f) /** Calculates, how many bytes were already written into the buffer. **/
345 {
346   return f->bptr - f->bstop;
347 }
348
349 /***
350  * === Fastbuf on recyclable growing buffers [[fbgrow]]
351  *
352  * The `fbgrow` back-end keeps the stream in a contiguous buffer stored in the
353  * main memory, but unlike <<fbmem,`fbmem`>>, the buffer does not have a fixed
354  * size and it is expanded to accomodate all data.
355  *
356  * At every moment, you can use `fastbuf->buffer` to gain access to the stream.
357  ***/
358
359 struct fastbuf *fbgrow_create(unsigned basic_size);     /** Create the growing buffer pre-allocated to @basic_size bytes. **/
360 void fbgrow_reset(struct fastbuf *b);                   /** Reset stream and prepare for writing. **/
361 void fbgrow_rewind(struct fastbuf *b);                  /** Prepare for reading (of already written data). **/
362
363 /***
364  * === Fastbuf on memory pools [[fbpool]]
365  *
366  * The write-only `fbpool` back-end also keeps the stream in a contiguous
367  * buffer, but this time the buffer is allocated from within a memory pool.
368  ***/
369
370 struct mempool;
371 struct fbpool { /** Structure for fastbufs & mempools. **/
372   struct fastbuf fb;
373   struct mempool *mp;
374 };
375
376 /**
377  * Initialize a new `fbpool`. The structure is allocated by the caller.
378  **/
379 void fbpool_init(struct fbpool *fb);    /** Initialize a new mempool fastbuf. **/
380 /**
381  * Start a new continuous block and prepare for writing (see <<mempool:mp_start()>>).
382  * Provide the memory pool you want to use for this block as @mp.
383  **/
384 void fbpool_start(struct fbpool *fb, struct mempool *mp, uns init_size);
385 /**
386  * Close the block and return the address of its start (see <<mempool:mp_end()>>).
387  * The length can be determined by calling <<mempool:mp_size(mp, ptr)>>.
388  **/
389 void *fbpool_end(struct fbpool *fb);
390
391 /***
392  * === Atomic files for multi-threaded programs [[fbatomic]]
393  *
394  * This fastbuf backend is designed for cases when several threads
395  * of a single program append records to a common file and while the
396  * record can mix in an arbitrary way, the bytes inside a single
397  * record must remain uninterrupted.
398  *
399  * In case of files with fixed record size, we just allocate the
400  * buffer to hold a whole number of records and take advantage
401  * of the atomicity of the write() system call.
402  *
403  * With variable-sized records, we need another solution: when
404  * writing a record, we keep the fastbuf in a locked state, which
405  * prevents buffer flushing (and if the buffer becomes full, we extend it),
406  * and we wait for an explicit commit operation which write()s the buffer
407  * if the free space in the buffer falls below the expected maximum record
408  * length.
409  *
410  * Please note that initialization of the clones is not thread-safe,
411  * so you have to serialize it yourself.
412  ***/
413
414 struct fb_atomic {
415   struct fastbuf fb;
416   struct fb_atomic_file *af;
417   byte *expected_max_bptr;
418   uns slack_size;
419 };
420 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
421
422 /**
423  * Open an atomic fastbuf.
424  * If @master is NULL, the file @name is opened. If it is non-null,
425  * a new clone of an existing atomic fastbuf is created.
426  *
427  * If the file has fixed record length, just set @record_len to it.
428  * Otherwise set @record_len to the expected maximum record length
429  * with a negative sign (you need not fit in this length, but as long
430  * as you do, the fastbuf is more efficient) and call @fbatomic_commit()
431  * after each record.
432  *
433  * You can specify @record_len, if it is known (for optimisations).
434  *
435  * The file is closed when all fastbufs using it are closed.
436  **/
437 struct fastbuf *fbatomic_open(const char *name, struct fastbuf *master, uns bufsize, int record_len);
438 void fbatomic_internal_write(struct fastbuf *b);
439
440 /**
441  * Declare that you have finished writing a record. This is required only
442  * if a fixed record size was not specified.
443  **/
444 static inline void fbatomic_commit(struct fastbuf *b)
445 {
446   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
447     fbatomic_internal_write(b);
448 }
449
450 /*** === Configuring stream parameters [[bconfig]] ***/
451
452 enum bconfig_type {                     /** Parameters that could be configured. **/
453   BCONFIG_IS_TEMP_FILE,                 /* 0=normal file, 1=temporary file, 2=shared fd */
454   BCONFIG_KEEP_BACK_BUF,                /* Optimize for bi-directional access */
455 };
456
457 int bconfig(struct fastbuf *f, uns type, int data); /** Configure a fastbuf. Returns previous value. **/
458
459 /*** === Universal functions working on all fastbuf's [[ffbasic]] ***/
460
461 /**
462  * Close and free fastbuf.
463  * Can not be used for fastbufs not returned from function (initialized in a parameter, for example the one from `fbbuf_init_read`).
464  */
465 void bclose(struct fastbuf *f);
466 void bflush(struct fastbuf *f);                                 /** Write data (if it makes any sense, do not use for in-memory buffers). **/
467 void bseek(struct fastbuf *f, ucw_off_t pos, int whence);       /** Seek in the buffer. See `man fseek` for description of @whence. Only for seekable fastbufs. **/
468 void bsetpos(struct fastbuf *f, ucw_off_t pos);                 /** Set position to @pos bytes from beginning. Only for seekable fastbufs. **/
469 void brewind(struct fastbuf *f);                                /** Go to the beginning of the fastbuf. Only for seekable ones. **/
470 ucw_off_t bfilesize(struct fastbuf *f);                         /** How large is the file? -1 if not seekable. **/
471
472 static inline ucw_off_t btell(struct fastbuf *f)                /** Where am I (from the beginning)? **/
473 {
474   return f->pos + (f->bptr - f->bstop);
475 }
476
477 int bgetc_slow(struct fastbuf *f);
478 static inline int bgetc(struct fastbuf *f)                      /** Return next character from the buffer. **/
479 {
480   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
481 }
482
483 int bpeekc_slow(struct fastbuf *f);
484 static inline int bpeekc(struct fastbuf *f)                     /** Return next character from the buffer, but keep the current position. **/
485 {
486   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
487 }
488
489 static inline void bungetc(struct fastbuf *f)                   /** Return last read character back. Only one back is guaranteed to work. **/
490 {
491   f->bptr--;
492 }
493
494 void bputc_slow(struct fastbuf *f, uns c);
495 static inline void bputc(struct fastbuf *f, uns c)              /** Write a single character. **/
496 {
497   if (f->bptr < f->bufend)
498     *f->bptr++ = c;
499   else
500     bputc_slow(f, c);
501 }
502
503 static inline uns bavailr(struct fastbuf *f)                    /** Return the length of the cached data to be read. Do not use directly. **/
504 {
505   return f->bstop - f->bptr;
506 }
507
508 static inline uns bavailw(struct fastbuf *f)                    /** Return the length of the buffer available for writing. Do not use directly. **/
509 {
510   return f->bufend - f->bptr;
511 }
512
513 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
514 /**
515  * Read at most @l bytes of data into @b.
516  * Returns number of bytes read.
517  * 0 means end of file.
518  */
519 static inline uns bread(struct fastbuf *f, void *b, uns l)
520 {
521   if (bavailr(f) >= l)
522     {
523       memcpy(b, f->bptr, l);
524       f->bptr += l;
525       return l;
526     }
527   else
528     return bread_slow(f, b, l, 0);
529 }
530
531 /**
532  * Reads exactly @l bytes of data into @b.
533  * If at the end of file, it returns 0.
534  * If there are data, but less than @l, it dies.
535  */
536 static inline uns breadb(struct fastbuf *f, void *b, uns l)
537 {
538   if (bavailr(f) >= l)
539     {
540       memcpy(b, f->bptr, l);
541       f->bptr += l;
542       return l;
543     }
544   else
545     return bread_slow(f, b, l, 1);
546 }
547
548 void bwrite_slow(struct fastbuf *f, const void *b, uns l);
549 static inline void bwrite(struct fastbuf *f, const void *b, uns l) /** Writes buffer @b of length @l into fastbuf. **/
550 {
551   if (bavailw(f) >= l)
552     {
553       memcpy(f->bptr, b, l);
554       f->bptr += l;
555     }
556   else
557     bwrite_slow(f, b, l);
558 }
559
560 /**
561  * Reads a line into @b and strips trailing `\n`.
562  * Returns pointer to the terminating 0 or NULL on `EOF`.
563  * Dies if the line is longer than @l.
564  **/
565 char *bgets(struct fastbuf *f, char *b, uns l);
566 char *bgets0(struct fastbuf *f, char *b, uns l);        /** The same as @bgets(), but for 0-terminated strings. **/
567 /**
568  * Returns either length of read string (excluding the terminator) or -1 if it is too long.
569  * In such cases exactly @l bytes are read.
570  */
571 int bgets_nodie(struct fastbuf *f, char *b, uns l);
572
573 struct mempool;
574 struct bb_t;
575 /**
576  * Read a string, strip the trailing `\n` and store it into growing buffer @b.
577  * Dies if the line is longer than @limit.
578  **/
579 uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
580 /**
581  * Read a string, strip the trailing `\n` and store it into buffer allocated from a memory pool.
582  **/
583 char *bgets_mp(struct fastbuf *f, struct mempool *mp);
584
585 struct bgets_stk_struct {
586   struct fastbuf *f;
587   byte *old_buf, *cur_buf, *src;
588   uns old_len, cur_len, src_len;
589 };
590 void bgets_stk_init(struct bgets_stk_struct *s);
591 void bgets_stk_step(struct bgets_stk_struct *s);
592
593 /**
594  * Read a string, strip the trailing `\n` and store it on the stack (allocated using alloca()).
595  **/
596 #define bgets_stk(fb) \
597   ({ 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; })
598
599 /**
600  * Write a string, without 0 or `\n` at the end.
601  **/
602 static inline void bputs(struct fastbuf *f, const char *b)
603 {
604   bwrite(f, b, strlen(b));
605 }
606
607 /**
608  * Write string, including terminating 0.
609  **/
610 static inline void bputs0(struct fastbuf *f, const char *b)
611 {
612   bwrite(f, b, strlen(b)+1);
613 }
614
615 /**
616  * Write string and append a newline to the end.
617  **/
618 static inline void bputsn(struct fastbuf *f, const char *b)
619 {
620   bputs(f, b);
621   bputc(f, '\n');
622 }
623
624 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
625 /**
626  * Copy @l bytes of data from fastbuf @f to fastbuf @t.
627  * `UINT_MAX` (`~0U`) means all data, even if more than `UINT_MAX` bytes remain.
628  **/
629 static inline void bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
630 {
631   if (bavailr(f) >= l && bavailw(t) >= l)
632     {
633       memcpy(t->bptr, f->bptr, l);
634       t->bptr += l;
635       f->bptr += l;
636     }
637   else
638     bbcopy_slow(f, t, l);
639 }
640
641 int bskip_slow(struct fastbuf *f, uns len);
642 static inline int bskip(struct fastbuf *f, uns len) /** Skip @len bytes without reading them. **/
643 {
644   if (bavailr(f) >= len)
645     {
646       f->bptr += len;
647       return 1;
648     }
649   else
650     return bskip_slow(f, len);
651 }
652
653 /*** === Direct I/O on buffers ***/
654
655 /**
656  * Begin direct reading from fastbuf's internal buffer to avoid unnecessary copying.
657  * The function returns a buffer @buf together with its length in bytes (zero means EOF)
658  * with cached data to be read.
659  *
660  * Some back-ends allow the user to modify the data in the returned buffer to avoid unnecessary.
661  * If the back-end allows such modifications, it can set `f->can_overwrite_buffer` accordingly:
662  *
663  *   - 0 if no modification is allowed,
664  *   - 1 if the user can modify the buffer on the condition that
665  *       the modifications will be undone before calling the next
666  *       fastbuf operation
667  *   - 2 if the user is allowed to overwrite the data in the buffer
668  *       if @bdirect_read_commit_modified() is called afterwards.
669  *       In this case, the back-end must be prepared for trimming
670  *       of the buffer which is done by the commit function.
671  *
672  * The reading must be ended by @bdirect_read_commit() or @bdirect_read_commit_modified(),
673  * unless the user did not read or modify anything.
674  **/
675 static inline uns bdirect_read_prepare(struct fastbuf *f, byte **buf)
676 {
677   if (f->bptr == f->bstop && !f->refill(f))
678     {
679       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
680       return 0;
681     }
682   *buf = f->bptr;
683   return bavailr(f);
684 }
685
686 /**
687  * End direct reading started by @bdirect_read_prepare() and move the cursor at @pos.
688  * Data in the returned buffer must be same as after @bdirect_read_prepare() and
689  * @pos must point somewhere inside the buffer.
690  **/
691 static inline void bdirect_read_commit(struct fastbuf *f, byte *pos)
692 {
693   f->bptr = pos;
694 }
695
696 /**
697  * Similar to @bdirect_read_commit(), but accepts also modified data before @pos.
698  * Note that such modifications are supported only if `f->can_overwrite_buffer == 2`.
699  **/
700 static inline void bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
701 {
702   f->bptr = pos;
703   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
704 }
705
706 /**
707  * Start direct writing to fastbuf's internal buffer to avoid copy overhead.
708  * The function returns the length of the buffer in @buf (at least one byte)
709  * where we can write to. The operation must be ended by @bdirect_write_commit(),
710  * unless nothing is written.
711  **/
712 static inline uns bdirect_write_prepare(struct fastbuf *f, byte **buf)
713 {
714   if (f->bptr == f->bufend)
715     f->spout(f);
716   *buf = f->bptr;
717   return bavailw(f);
718 }
719
720 /**
721  * Commit the data written to the buffer returned by @bdirect_write_prepare().
722  * The length is specified by @pos which must point just after the written data.
723  * Also moves the cursor to @pos.
724  **/
725 static inline void bdirect_write_commit(struct fastbuf *f, byte *pos)
726 {
727   f->bptr = pos;
728 }
729
730 /*** === Formatted output ***/
731
732 /**
733  * printf into a fastbuf.
734  **/
735 int bprintf(struct fastbuf *b, const char *msg, ...)
736   FORMAT_CHECK(printf,2,3);
737 int vbprintf(struct fastbuf *b, const char *msg, va_list args); /** vprintf into a fastbuf. **/
738
739 #endif