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 on memory pools */
 148
 149 struct mempool;
 150 struct fbpool {
 151   struct fastbuf fb;
 152   struct mempool *mp;
 153 };
 154
 155 void fbpool_init(struct fbpool *fb);    /* Initialize a new fastbuf */
 156 void fbpool_start(struct fbpool *fb, struct mempool *mp, uns init_size);
 157                                         /* Start a new continuous block and prepare for writing (see mp_start()) */
 158 void *fbpool_end(struct fbpool *fb);    /* Close the block and return its address (see mp_end()).
 159                                            The length can be determined with mp_size(mp, ptr). */
 160
 161 /* FastO with atomic writes for multi-threaded programs */
 162
 163 struct fb_atomic {
 164   struct fastbuf fb;
 165   struct fb_atomic_file *af;
 166   byte *expected_max_bptr;
 167   uns slack_size;
 168 };
 169 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
 170
 171 struct fastbuf *fbatomic_open(byte *name, struct fastbuf *master, uns bufsize, int record_len);
 172 void fbatomic_internal_write(struct fastbuf *b);
 173
 174 static inline void
 175 fbatomic_commit(struct fastbuf *b)
 176 {
 177   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
 178     fbatomic_internal_write(b);
 179 }
 180
 181 /* Configuring stream parameters */
 182
 183 enum bconfig_type {
 184   BCONFIG_IS_TEMP_FILE,
 185   BCONFIG_KEEP_BACK_BUF,
 186 };
 187
 188 int bconfig(struct fastbuf *f, uns type, int data);
 189
 190 /* Universal functions working on all fastbuf's */
 191
 192 void bclose(struct fastbuf *f);
 193 void bflush(struct fastbuf *f);
 194 void bseek(struct fastbuf *f, sh_off_t pos, int whence);
 195 void bsetpos(struct fastbuf *f, sh_off_t pos);
 196 void brewind(struct fastbuf *f);
 197 sh_off_t bfilesize(struct fastbuf *f);          // -1 if not seekable
 198
 199 static inline sh_off_t btell(struct fastbuf *f)
 200 {
 201   return f->pos + (f->bptr - f->bstop);
 202 }
 203
 204 int bgetc_slow(struct fastbuf *f);
 205 static inline int bgetc(struct fastbuf *f)
 206 {
 207   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
 208 }
 209
 210 int bpeekc_slow(struct fastbuf *f);
 211 static inline int bpeekc(struct fastbuf *f)
 212 {
 213   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
 214 }
 215
 216 static inline void bungetc(struct fastbuf *f)
 217 {
 218   f->bptr--;
 219 }
 220
 221 void bputc_slow(struct fastbuf *f, uns c);
 222 static inline void bputc(struct fastbuf *f, uns c)
 223 {
 224   if (f->bptr < f->bufend)
 225     *f->bptr++ = c;
 226   else
 227     bputc_slow(f, c);
 228 }
 229
 230 static inline uns
 231 bavailr(struct fastbuf *f)
 232 {
 233   return f->bstop - f->bptr;
 234 }
 235
 236 static inline uns
 237 bavailw(struct fastbuf *f)
 238 {
 239   return f->bufend - f->bptr;
 240 }
 241
 242 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
 243 static inline uns bread(struct fastbuf *f, void *b, uns l)
 244 {
 245   if (bavailr(f) >= l)
 246     {
 247       memcpy(b, f->bptr, l);
 248       f->bptr += l;
 249       return l;
 250     }
 251   else
 252     return bread_slow(f, b, l, 0);
 253 }
 254
 255 static inline uns breadb(struct fastbuf *f, void *b, uns l)
 256 {
 257   if (bavailr(f) >= l)
 258     {
 259       memcpy(b, f->bptr, l);
 260       f->bptr += l;
 261       return l;
 262     }
 263   else
 264     return bread_slow(f, b, l, 1);
 265 }
 266
 267 void bwrite_slow(struct fastbuf *f, void *b, uns l);
 268 static inline void bwrite(struct fastbuf *f, void *b, uns l)
 269 {
 270   if (bavailw(f) >= l)
 271     {
 272       memcpy(f->bptr, b, l);
 273       f->bptr += l;
 274     }
 275   else
 276     bwrite_slow(f, b, l);
 277 }
 278
 279 byte *bgets(struct fastbuf *f, byte *b, uns l); /* Non-std */
 280 int bgets_nodie(struct fastbuf *f, byte *b, uns l);
 281 byte *bgets0(struct fastbuf *f, byte *b, uns l);
 282
 283 struct mempool;
 284 struct bb_t;
 285 uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
 286 byte *bgets_mp(struct fastbuf *f, struct mempool *mp);
 287
 288 struct bgets_stk_struct {
 289   struct fastbuf *f;
 290   byte *old_buf, *cur_buf, *src;
 291   uns old_len, cur_len, src_len;
 292 };
 293 void bgets_stk_init(struct bgets_stk_struct *s);
 294 void bgets_stk_step(struct bgets_stk_struct *s);
 295 #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; })
 296
 297 static inline void
 298 bputs(struct fastbuf *f, byte *b)
 299 {
 300   bwrite(f, b, strlen(b));
 301 }
 302
 303 static inline void
 304 bputs0(struct fastbuf *f, byte *b)
 305 {
 306   bwrite(f, b, strlen(b)+1);
 307 }
 308
 309 static inline void
 310 bputsn(struct fastbuf *f, byte *b)
 311 {
 312   bputs(f, b);
 313   bputc(f, '\n');
 314 }
 315
 316 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
 317 static inline void
 318 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
 319 {
 320   if (bavailr(f) >= l && bavailw(t) >= l)
 321     {
 322       memcpy(t->bptr, f->bptr, l);
 323       t->bptr += l;
 324       f->bptr += l;
 325     }
 326   else
 327     bbcopy_slow(f, t, l);
 328 }
 329
 330 int bskip_slow(struct fastbuf *f, uns len);
 331 static inline int bskip(struct fastbuf *f, uns len)
 332 {
 333   if (bavailr(f) >= len)
 334     {
 335       f->bptr += len;
 336       return 1;
 337     }
 338   else
 339     return bskip_slow(f, len);
 340 }
 341
 342 /* Direct I/O on buffers */
 343
 344 static inline uns
 345 bdirect_read_prepare(struct fastbuf *f, byte **buf)
 346 {
 347   if (f->bptr == f->bstop && !f->refill(f))
 348     {
 349       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
 350       return 0;
 351     }
 352   *buf = f->bptr;
 353   return bavailr(f);
 354 }
 355
 356 static inline void
 357 bdirect_read_commit(struct fastbuf *f, byte *pos)
 358 {
 359   f->bptr = pos;
 360 }
 361
 362 static inline void
 363 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
 364 {
 365   f->bptr = pos;
 366   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
 367 }
 368
 369 static inline uns
 370 bdirect_write_prepare(struct fastbuf *f, byte **buf)
 371 {
 372   if (f->bptr == f->bufend)
 373     f->spout(f);
 374   *buf = f->bptr;
 375   return bavailw(f);
 376 }
 377
 378 static inline void
 379 bdirect_write_commit(struct fastbuf *f, byte *pos)
 380 {
 381   f->bptr = pos;
 382 }
 383
 384 /* Formatted output */
 385
 386 int bprintf(struct fastbuf *b, char *msg, ...) FORMAT_CHECK(printf,2,3);
 387 int vbprintf(struct fastbuf *b, char *msg, va_list args);
 388
 389 #endif