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