lib/fastbuf.h

   1 /*
   2  *      UCW Library -- Fast Buffered I/O
   3  *
   4  *      (c) 1997--2004 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 #ifndef EOF
  15 #include <stdio.h>
  16 #endif
  17
  18 #include <string.h>
  19 #include <alloca.h>
  20
  21 #include "lib/unaligned.h"
  22 #include "lib/bbuf.h"
  23
  24 /*
  25  *  Generic buffered I/O. You supply hooks to be called for low-level operations
  26  *  (swapping of buffers, seeking and closing), we do the rest.
  27  *
  28  *  Buffer layout when reading:
  29  *
  30  *  +----------------+---------------------------+
  31  *  | read data      | free space                |
  32  *  +----------------+---------------------------+
  33  *  ^        ^        ^                           ^
  34  *  buffer   bptr     bstop                       bufend
  35  *
  36  *  After the last character is read, bptr == bstop and buffer refill
  37  *  is deferred to the next read attempt. This gives us an easy way
  38  *  how to implement bungetc().
  39  *
  40  *  When writing:
  41  *
  42  *  +--------+--------------+--------------------+
  43  *  | unused | written data | free space         |
  44  *  +--------+--------------+--------------------+
  45  *  ^         ^              ^                    ^
  46  *  buffer    bstop          bptr                 bufend
  47  *
  48  *  Dirty tricks:
  49  *
  50  *    - You can mix reads and writes on the same stream, but you must
  51  *      call bflush() in between and remember that the file position
  52  *      points after the flushed buffer which is not necessarily the same
  53  *      as after the data you've read.
  54  *    - The spout/refill hooks can change not only bptr and bstop, but also
  55  *      the location of the buffer; fb-mem.c takes advantage of it.
  56  *    - In some cases, the user of the bdirect interface can be allowed to modify
  57  *      the data in the buffer to avoid unnecessary copying. If the back-end
  58  *      allows such modifications, it can set can_overwrite_buffer accordingly:
  59  *              *  0 if no modification is allowed,
  60  *              *  1 if the user can modify the buffer on the condition that
  61  *                   the modifications will be undone before calling the next
  62  *                   fastbuf operation
  63  *              *  2 if the user is allowed to overwrite the data in the buffer
  64  *                   if bdirect_read_commit_modified() is called afterwards.
  65  *                   In this case, the back-end must be prepared for trimming
  66  *                   of the buffer which is done by the commit function.
  67  */
  68
  69 struct fastbuf {
  70   byte is_fastbuf[0];                   /* Dummy field for checking of type casts */
  71   byte *bptr, *bstop;                   /* Access pointers */
  72   byte *buffer, *bufend;                /* Start and end of the buffer */
  73   byte *name;                           /* File name for error messages */
  74   sh_off_t pos;                         /* Position of bstop in the file */
  75   int (*refill)(struct fastbuf *);      /* Get a buffer with new data */
  76   void (*spout)(struct fastbuf *);      /* Write buffer data to the file */
  77   void (*seek)(struct fastbuf *, sh_off_t, int);  /* Slow path for bseek(), buffer already flushed */
  78   void (*close)(struct fastbuf *);      /* Close the stream */
  79   int (*config)(struct fastbuf *, uns, int);    /* Configure the stream */
  80   int can_overwrite_buffer;             /* Can the buffer be altered? (see discussion above) 0=never, 1=temporarily, 2=permanently */
  81 };
  82
  83 /* FastIO on standard files (specify buffer size 0 to enable mmaping) */
  84
  85 struct fastbuf *bopen(byte *name, uns mode, uns buflen);
  86 struct fastbuf *bopen_try(byte *name, uns mode, uns buflen);
  87 struct fastbuf *bopen_tmp(uns buflen);
  88 struct fastbuf *bfdopen(int fd, uns buflen);
  89 struct fastbuf *bfdopen_shared(int fd, uns buflen);
  90 void bfilesync(struct fastbuf *b);
  91
  92 /* FastIO on in-memory streams */
  93
  94 struct fastbuf *fbmem_create(unsigned blocksize);       /* Create stream and return its writing fastbuf */
  95 struct fastbuf *fbmem_clone_read(struct fastbuf *);     /* Create reading fastbuf */
  96
  97 /* FastIO on memory mapped files */
  98
  99 struct fastbuf *bopen_mm(byte *name, uns mode);
 100
 101 /* FastI on file descriptors with limit */
 102
 103 struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit);
 104
 105 /* FastIO on static buffers */
 106
 107 void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size, uns can_overwrite);
 108 void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
 109 static inline uns
 110 fbbuf_count_written(struct fastbuf *f)
 111 {
 112   return f->bptr - f->bstop;
 113 }
 114
 115 /* FastIO on recyclable growing buffers */
 116
 117 struct fastbuf *fbgrow_create(unsigned basic_size);
 118 void fbgrow_reset(struct fastbuf *b);                   /* Reset stream and prepare for writing */
 119 void fbgrow_rewind(struct fastbuf *b);                  /* Prepare for reading */
 120
 121 /* Configuring stream parameters */
 122
 123 int bconfig(struct fastbuf *f, uns type, int data);
 124
 125 #define BCONFIG_IS_TEMP_FILE 0
 126
 127 /* Universal functions working on all fastbuf's */
 128
 129 void bclose(struct fastbuf *f);
 130 void bflush(struct fastbuf *f);
 131 void bseek(struct fastbuf *f, sh_off_t pos, int whence);
 132 void bsetpos(struct fastbuf *f, sh_off_t pos);
 133 void brewind(struct fastbuf *f);
 134 sh_off_t bfilesize(struct fastbuf *f);
 135
 136 static inline sh_off_t btell(struct fastbuf *f)
 137 {
 138   return f->pos + (f->bptr - f->bstop);
 139 }
 140
 141 int bgetc_slow(struct fastbuf *f);
 142 static inline int bgetc(struct fastbuf *f)
 143 {
 144   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
 145 }
 146
 147 int bpeekc_slow(struct fastbuf *f);
 148 static inline int bpeekc(struct fastbuf *f)
 149 {
 150   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
 151 }
 152
 153 static inline void bungetc(struct fastbuf *f)
 154 {
 155   f->bptr--;
 156 }
 157
 158 void bputc_slow(struct fastbuf *f, uns c);
 159 static inline void bputc(struct fastbuf *f, uns c)
 160 {
 161   if (f->bptr < f->bufend)
 162     *f->bptr++ = c;
 163   else
 164     bputc_slow(f, c);
 165 }
 166
 167 static inline uns
 168 bavailr(struct fastbuf *f)
 169 {
 170   return f->bstop - f->bptr;
 171 }
 172
 173 static inline uns
 174 bavailw(struct fastbuf *f)
 175 {
 176   return f->bufend - f->bptr;
 177 }
 178
 179 int bgetw_slow(struct fastbuf *f);
 180 static inline int bgetw(struct fastbuf *f)
 181 {
 182   int w;
 183   if (bavailr(f) >= 2)
 184     {
 185       w = GET_U16(f->bptr);
 186       f->bptr += 2;
 187       return w;
 188     }
 189   else
 190     return bgetw_slow(f);
 191 }
 192
 193 u32 bgetl_slow(struct fastbuf *f);
 194 static inline u32 bgetl(struct fastbuf *f)
 195 {
 196   u32 l;
 197   if (bavailr(f) >= 4)
 198     {
 199       l = GET_U32(f->bptr);
 200       f->bptr += 4;
 201       return l;
 202     }
 203   else
 204     return bgetl_slow(f);
 205 }
 206
 207 u64 bgetq_slow(struct fastbuf *f);
 208 static inline u64 bgetq(struct fastbuf *f)
 209 {
 210   u64 l;
 211   if (bavailr(f) >= 8)
 212     {
 213       l = GET_U64(f->bptr);
 214       f->bptr += 8;
 215       return l;
 216     }
 217   else
 218     return bgetq_slow(f);
 219 }
 220
 221 u64 bget5_slow(struct fastbuf *f);
 222 static inline u64 bget5(struct fastbuf *f)
 223 {
 224   u64 l;
 225   if (bavailr(f) >= 5)
 226     {
 227       l = GET_U40(f->bptr);
 228       f->bptr += 5;
 229       return l;
 230     }
 231   else
 232     return bget5_slow(f);
 233 }
 234
 235 void bputw_slow(struct fastbuf *f, uns w);
 236 static inline void bputw(struct fastbuf *f, uns w)
 237 {
 238   if (bavailw(f) >= 2)
 239     {
 240       PUT_U16(f->bptr, w);
 241       f->bptr += 2;
 242     }
 243   else
 244     bputw_slow(f, w);
 245 }
 246
 247 void bputl_slow(struct fastbuf *f, u32 l);
 248 static inline void bputl(struct fastbuf *f, u32 l)
 249 {
 250   if (bavailw(f) >= 4)
 251     {
 252       PUT_U32(f->bptr, l);
 253       f->bptr += 4;
 254     }
 255   else
 256     bputl_slow(f, l);
 257 }
 258
 259 void bputq_slow(struct fastbuf *f, u64 l);
 260 static inline void bputq(struct fastbuf *f, u64 l)
 261 {
 262   if (bavailw(f) >= 8)
 263     {
 264       PUT_U64(f->bptr, l);
 265       f->bptr += 8;
 266     }
 267   else
 268     bputq_slow(f, l);
 269 }
 270
 271 void bput5_slow(struct fastbuf *f, u64 l);
 272 static inline void bput5(struct fastbuf *f, u64 l)
 273 {
 274   if (bavailw(f) >= 5)
 275     {
 276       PUT_U40(f->bptr, l);
 277       f->bptr += 5;
 278     }
 279   else
 280     bput5_slow(f, l);
 281 }
 282
 283 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
 284 static inline uns bread(struct fastbuf *f, void *b, uns l)
 285 {
 286   if (bavailr(f) >= l)
 287     {
 288       memcpy(b, f->bptr, l);
 289       f->bptr += l;
 290       return l;
 291     }
 292   else
 293     return bread_slow(f, b, l, 0);
 294 }
 295
 296 static inline uns breadb(struct fastbuf *f, void *b, uns l)
 297 {
 298   if (bavailr(f) >= l)
 299     {
 300       memcpy(b, f->bptr, l);
 301       f->bptr += l;
 302       return l;
 303     }
 304   else
 305     return bread_slow(f, b, l, 1);
 306 }
 307
 308 void bwrite_slow(struct fastbuf *f, void *b, uns l);
 309 static inline void bwrite(struct fastbuf *f, void *b, uns l)
 310 {
 311   if (bavailw(f) >= l)
 312     {
 313       memcpy(f->bptr, b, l);
 314       f->bptr += l;
 315     }
 316   else
 317     bwrite_slow(f, b, l);
 318 }
 319
 320 byte *bgets(struct fastbuf *f, byte *b, uns l); /* Non-std */
 321 int bgets_nodie(struct fastbuf *f, byte *b, uns l);
 322 byte *bgets0(struct fastbuf *f, byte *b, uns l);
 323
 324 struct mempool;
 325 uns bgets_bb(struct fastbuf *f, bb_t *b);
 326 byte *bgets_mp(struct mempool *mp, struct fastbuf *f);
 327 int bgets_stk_step(struct fastbuf *f, byte *old_buf, byte *buf, uns len);
 328 #define bgets_stk(f) ({ struct fastbuf *_fb = (f); uns _l = 256; byte *_b, *_p = NULL; \
 329         while (bgets_stk_step(_fb, _p, _b = alloca(_l), _l)) _p = _b, _l *= 2; _b; })
 330
 331 static inline void
 332 bputs(struct fastbuf *f, byte *b)
 333 {
 334   bwrite(f, b, strlen(b));
 335 }
 336
 337 static inline void
 338 bputs0(struct fastbuf *f, byte *b)
 339 {
 340   bwrite(f, b, strlen(b)+1);
 341 }
 342
 343 static inline void
 344 bputsn(struct fastbuf *f, byte *b)
 345 {
 346   bputs(f, b);
 347   bputc(f, '\n');
 348 }
 349
 350 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
 351 static inline void
 352 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
 353 {
 354   if (bavailr(f) >= l && bavailw(t) >= l)
 355     {
 356       memcpy(t->bptr, f->bptr, l);
 357       t->bptr += l;
 358       f->bptr += l;
 359     }
 360   else
 361     bbcopy_slow(f, t, l);
 362 }
 363
 364 int bskip_slow(struct fastbuf *f, uns len);
 365 static inline int bskip(struct fastbuf *f, uns len)
 366 {
 367   if (bavailr(f) >= len)
 368     {
 369       f->bptr += len;
 370       return 1;
 371     }
 372   else
 373     return bskip_slow(f, len);
 374 }
 375
 376 /* I/O on addr_int_t */
 377
 378 #ifdef CPU_64BIT_POINTERS
 379 #define bputa(x,p) bputq(x,p)
 380 #define bgeta(x) bgetq(x)
 381 #else
 382 #define bputa(x,p) bputl(x,p)
 383 #define bgeta(x) bgetl(x)
 384 #endif
 385
 386 /* Direct I/O on buffers */
 387
 388 static inline uns
 389 bdirect_read_prepare(struct fastbuf *f, byte **buf)
 390 {
 391   if (f->bptr == f->bstop && !f->refill(f))
 392     {
 393       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
 394       return 0;
 395     }
 396   *buf = f->bptr;
 397   return bavailr(f);
 398 }
 399
 400 static inline void
 401 bdirect_read_commit(struct fastbuf *f, byte *pos)
 402 {
 403   f->bptr = pos;
 404 }
 405
 406 static inline void
 407 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
 408 {
 409   f->bptr = pos;
 410   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
 411 }
 412
 413 static inline uns
 414 bdirect_write_prepare(struct fastbuf *f, byte **buf)
 415 {
 416   if (f->bptr == f->bufend)
 417     f->spout(f);
 418   *buf = f->bptr;
 419   return bavailw(f);
 420 }
 421
 422 static inline void
 423 bdirect_write_commit(struct fastbuf *f, byte *pos)
 424 {
 425   f->bptr = pos;
 426 }
 427
 428 /* Formatted output */
 429
 430 int bprintf(struct fastbuf *b, char *msg, ...) FORMAT_CHECK(printf,2,3);
 431 int vbprintf(struct fastbuf *b, char *msg, va_list args);
 432
 433 #endif