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 /* FastO with atomic writes for multi-threaded programs */
 122
 123 struct fb_atomic {
 124   struct fastbuf fb;
 125   struct fb_atomic_file *af;
 126   byte *expected_max_bptr;
 127   uns slack_size;
 128 };
 129 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
 130
 131 struct fastbuf *fbatomic_open(byte *name, struct fastbuf *master, uns bufsize, int record_len);
 132 void fbatomic_internal_write(struct fastbuf *b);
 133
 134 static inline void
 135 fbatomic_commit(struct fastbuf *b)
 136 {
 137   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
 138     fbatomic_internal_write(b);
 139 }
 140
 141 /* Configuring stream parameters */
 142
 143 int bconfig(struct fastbuf *f, uns type, int data);
 144
 145 #define BCONFIG_IS_TEMP_FILE 0
 146
 147 /* Universal functions working on all fastbuf's */
 148
 149 void bclose(struct fastbuf *f);
 150 void bflush(struct fastbuf *f);
 151 void bseek(struct fastbuf *f, sh_off_t pos, int whence);
 152 void bsetpos(struct fastbuf *f, sh_off_t pos);
 153 void brewind(struct fastbuf *f);
 154 sh_off_t bfilesize(struct fastbuf *f);
 155
 156 static inline sh_off_t btell(struct fastbuf *f)
 157 {
 158   return f->pos + (f->bptr - f->bstop);
 159 }
 160
 161 int bgetc_slow(struct fastbuf *f);
 162 static inline int bgetc(struct fastbuf *f)
 163 {
 164   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
 165 }
 166
 167 int bpeekc_slow(struct fastbuf *f);
 168 static inline int bpeekc(struct fastbuf *f)
 169 {
 170   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
 171 }
 172
 173 static inline void bungetc(struct fastbuf *f)
 174 {
 175   f->bptr--;
 176 }
 177
 178 void bputc_slow(struct fastbuf *f, uns c);
 179 static inline void bputc(struct fastbuf *f, uns c)
 180 {
 181   if (f->bptr < f->bufend)
 182     *f->bptr++ = c;
 183   else
 184     bputc_slow(f, c);
 185 }
 186
 187 static inline uns
 188 bavailr(struct fastbuf *f)
 189 {
 190   return f->bstop - f->bptr;
 191 }
 192
 193 static inline uns
 194 bavailw(struct fastbuf *f)
 195 {
 196   return f->bufend - f->bptr;
 197 }
 198
 199 int bgetw_slow(struct fastbuf *f);
 200 static inline int bgetw(struct fastbuf *f)
 201 {
 202   int w;
 203   if (bavailr(f) >= 2)
 204     {
 205       w = GET_U16(f->bptr);
 206       f->bptr += 2;
 207       return w;
 208     }
 209   else
 210     return bgetw_slow(f);
 211 }
 212
 213 u32 bgetl_slow(struct fastbuf *f);
 214 static inline u32 bgetl(struct fastbuf *f)
 215 {
 216   u32 l;
 217   if (bavailr(f) >= 4)
 218     {
 219       l = GET_U32(f->bptr);
 220       f->bptr += 4;
 221       return l;
 222     }
 223   else
 224     return bgetl_slow(f);
 225 }
 226
 227 u64 bgetq_slow(struct fastbuf *f);
 228 static inline u64 bgetq(struct fastbuf *f)
 229 {
 230   u64 l;
 231   if (bavailr(f) >= 8)
 232     {
 233       l = GET_U64(f->bptr);
 234       f->bptr += 8;
 235       return l;
 236     }
 237   else
 238     return bgetq_slow(f);
 239 }
 240
 241 u64 bget5_slow(struct fastbuf *f);
 242 static inline u64 bget5(struct fastbuf *f)
 243 {
 244   u64 l;
 245   if (bavailr(f) >= 5)
 246     {
 247       l = GET_U40(f->bptr);
 248       f->bptr += 5;
 249       return l;
 250     }
 251   else
 252     return bget5_slow(f);
 253 }
 254
 255 void bputw_slow(struct fastbuf *f, uns w);
 256 static inline void bputw(struct fastbuf *f, uns w)
 257 {
 258   if (bavailw(f) >= 2)
 259     {
 260       PUT_U16(f->bptr, w);
 261       f->bptr += 2;
 262     }
 263   else
 264     bputw_slow(f, w);
 265 }
 266
 267 void bputl_slow(struct fastbuf *f, u32 l);
 268 static inline void bputl(struct fastbuf *f, u32 l)
 269 {
 270   if (bavailw(f) >= 4)
 271     {
 272       PUT_U32(f->bptr, l);
 273       f->bptr += 4;
 274     }
 275   else
 276     bputl_slow(f, l);
 277 }
 278
 279 void bputq_slow(struct fastbuf *f, u64 l);
 280 static inline void bputq(struct fastbuf *f, u64 l)
 281 {
 282   if (bavailw(f) >= 8)
 283     {
 284       PUT_U64(f->bptr, l);
 285       f->bptr += 8;
 286     }
 287   else
 288     bputq_slow(f, l);
 289 }
 290
 291 void bput5_slow(struct fastbuf *f, u64 l);
 292 static inline void bput5(struct fastbuf *f, u64 l)
 293 {
 294   if (bavailw(f) >= 5)
 295     {
 296       PUT_U40(f->bptr, l);
 297       f->bptr += 5;
 298     }
 299   else
 300     bput5_slow(f, l);
 301 }
 302
 303 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
 304 static inline uns bread(struct fastbuf *f, void *b, uns l)
 305 {
 306   if (bavailr(f) >= l)
 307     {
 308       memcpy(b, f->bptr, l);
 309       f->bptr += l;
 310       return l;
 311     }
 312   else
 313     return bread_slow(f, b, l, 0);
 314 }
 315
 316 static inline uns breadb(struct fastbuf *f, void *b, uns l)
 317 {
 318   if (bavailr(f) >= l)
 319     {
 320       memcpy(b, f->bptr, l);
 321       f->bptr += l;
 322       return l;
 323     }
 324   else
 325     return bread_slow(f, b, l, 1);
 326 }
 327
 328 void bwrite_slow(struct fastbuf *f, void *b, uns l);
 329 static inline void bwrite(struct fastbuf *f, void *b, uns l)
 330 {
 331   if (bavailw(f) >= l)
 332     {
 333       memcpy(f->bptr, b, l);
 334       f->bptr += l;
 335     }
 336   else
 337     bwrite_slow(f, b, l);
 338 }
 339
 340 byte *bgets(struct fastbuf *f, byte *b, uns l); /* Non-std */
 341 int bgets_nodie(struct fastbuf *f, byte *b, uns l);
 342 byte *bgets0(struct fastbuf *f, byte *b, uns l);
 343
 344 struct mempool;
 345 uns bgets_bb(struct fastbuf *f, bb_t *b, uns limit);
 346 byte *bgets_mp(struct fastbuf *f, struct mempool *mp);
 347
 348 struct bgets_stk_struct {
 349   struct fastbuf *f;
 350   byte *old_buf, *cur_buf, *src;
 351   uns old_len, cur_len, src_len;
 352 };
 353 void bgets_stk_init(struct bgets_stk_struct *s);
 354 void bgets_stk_step(struct bgets_stk_struct *s);
 355 #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; })
 356
 357 static inline void
 358 bputs(struct fastbuf *f, byte *b)
 359 {
 360   bwrite(f, b, strlen(b));
 361 }
 362
 363 static inline void
 364 bputs0(struct fastbuf *f, byte *b)
 365 {
 366   bwrite(f, b, strlen(b)+1);
 367 }
 368
 369 static inline void
 370 bputsn(struct fastbuf *f, byte *b)
 371 {
 372   bputs(f, b);
 373   bputc(f, '\n');
 374 }
 375
 376 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
 377 static inline void
 378 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
 379 {
 380   if (bavailr(f) >= l && bavailw(t) >= l)
 381     {
 382       memcpy(t->bptr, f->bptr, l);
 383       t->bptr += l;
 384       f->bptr += l;
 385     }
 386   else
 387     bbcopy_slow(f, t, l);
 388 }
 389
 390 int bskip_slow(struct fastbuf *f, uns len);
 391 static inline int bskip(struct fastbuf *f, uns len)
 392 {
 393   if (bavailr(f) >= len)
 394     {
 395       f->bptr += len;
 396       return 1;
 397     }
 398   else
 399     return bskip_slow(f, len);
 400 }
 401
 402 /* I/O on addr_int_t */
 403
 404 #ifdef CPU_64BIT_POINTERS
 405 #define bputa(x,p) bputq(x,p)
 406 #define bgeta(x) bgetq(x)
 407 #else
 408 #define bputa(x,p) bputl(x,p)
 409 #define bgeta(x) bgetl(x)
 410 #endif
 411
 412 /* Direct I/O on buffers */
 413
 414 static inline uns
 415 bdirect_read_prepare(struct fastbuf *f, byte **buf)
 416 {
 417   if (f->bptr == f->bstop && !f->refill(f))
 418     {
 419       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
 420       return 0;
 421     }
 422   *buf = f->bptr;
 423   return bavailr(f);
 424 }
 425
 426 static inline void
 427 bdirect_read_commit(struct fastbuf *f, byte *pos)
 428 {
 429   f->bptr = pos;
 430 }
 431
 432 static inline void
 433 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
 434 {
 435   f->bptr = pos;
 436   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
 437 }
 438
 439 static inline uns
 440 bdirect_write_prepare(struct fastbuf *f, byte **buf)
 441 {
 442   if (f->bptr == f->bufend)
 443     f->spout(f);
 444   *buf = f->bptr;
 445   return bavailw(f);
 446 }
 447
 448 static inline void
 449 bdirect_write_commit(struct fastbuf *f, byte *pos)
 450 {
 451   f->bptr = pos;
 452 }
 453
 454 /* Formatted output */
 455
 456 int bprintf(struct fastbuf *b, char *msg, ...) FORMAT_CHECK(printf,2,3);
 457 int vbprintf(struct fastbuf *b, char *msg, va_list args);
 458
 459 #endif