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 standard files (specify buffer size 0 to enable mmaping) */
  77
  78 struct fastbuf *bopen(byte *name, uns mode, uns buflen);
  79 struct fastbuf *bopen_try(byte *name, uns mode, uns buflen);
  80 struct fastbuf *bopen_tmp(uns buflen);
  81 struct fastbuf *bfdopen(int fd, uns buflen);
  82 struct fastbuf *bfdopen_shared(int fd, uns buflen);
  83 void bfilesync(struct fastbuf *b);
  84
  85 #define TEMP_FILE_NAME_LEN 256
  86 void temp_file_name(byte *name);
  87
  88 /* FastIO on in-memory streams */
  89
  90 struct fastbuf *fbmem_create(unsigned blocksize);       /* Create stream and return its writing fastbuf */
  91 struct fastbuf *fbmem_clone_read(struct fastbuf *);     /* Create reading fastbuf */
  92
  93 /* FastIO on memory mapped files */
  94
  95 struct fastbuf *bopen_mm(byte *name, uns mode);
  96
  97 /* FastIO on files opened with O_DIRECT (see fb-direct.c for description) */
  98
  99 struct asio_queue;
 100 struct fastbuf *fbdir_open(byte *name, uns mode, struct asio_queue *io_queue);
 101 struct fastbuf *fbdir_open_try(byte *name, uns mode, struct asio_queue *io_queue);
 102 struct fastbuf *fbdir_open_fd(int fd, struct asio_queue *io_queue);
 103 struct fastbuf *fbdir_open_tmp(struct asio_queue *io_queue);
 104
 105 /* FastIO on files with run-time parametrization */
 106
 107 struct fb_params {
 108   // FIXME
 109   uns odirect;
 110   uns buffer_size;
 111 };
 112
 113 struct cf_section;
 114 extern struct cf_section fbpar_cf;
 115
 116 struct fastbuf *fbpar_open(byte *name, int mode, struct fb_params *params);
 117 struct fastbuf *fbpar_open_try(byte *name, int mode, struct fb_params *params);
 118 struct fastbuf *fbpar_open_fd(int fd, struct fb_params *params);
 119 struct fastbuf *fbpar_open_tmp(struct fb_params *params);
 120
 121 /* FastI on file descriptors with limit */
 122
 123 struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit);
 124
 125 /* FastIO on static buffers */
 126
 127 void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size, uns can_overwrite);
 128 void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
 129 static inline uns
 130 fbbuf_count_written(struct fastbuf *f)
 131 {
 132   return f->bptr - f->bstop;
 133 }
 134
 135 /* FastIO on recyclable growing buffers */
 136
 137 struct fastbuf *fbgrow_create(unsigned basic_size);
 138 void fbgrow_reset(struct fastbuf *b);                   /* Reset stream and prepare for writing */
 139 void fbgrow_rewind(struct fastbuf *b);                  /* Prepare for reading */
 140
 141 /* FastO with atomic writes for multi-threaded programs */
 142
 143 struct fb_atomic {
 144   struct fastbuf fb;
 145   struct fb_atomic_file *af;
 146   byte *expected_max_bptr;
 147   uns slack_size;
 148 };
 149 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
 150
 151 struct fastbuf *fbatomic_open(byte *name, struct fastbuf *master, uns bufsize, int record_len);
 152 void fbatomic_internal_write(struct fastbuf *b);
 153
 154 static inline void
 155 fbatomic_commit(struct fastbuf *b)
 156 {
 157   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
 158     fbatomic_internal_write(b);
 159 }
 160
 161 /* Configuring stream parameters */
 162
 163 int bconfig(struct fastbuf *f, uns type, int data);
 164
 165 #define BCONFIG_IS_TEMP_FILE 0
 166
 167 /* Universal functions working on all fastbuf's */
 168
 169 void bclose(struct fastbuf *f);
 170 void bflush(struct fastbuf *f);
 171 void bseek(struct fastbuf *f, sh_off_t pos, int whence);
 172 void bsetpos(struct fastbuf *f, sh_off_t pos);
 173 void brewind(struct fastbuf *f);
 174 sh_off_t bfilesize(struct fastbuf *f);          // -1 if not seekable
 175
 176 static inline sh_off_t btell(struct fastbuf *f)
 177 {
 178   return f->pos + (f->bptr - f->bstop);
 179 }
 180
 181 int bgetc_slow(struct fastbuf *f);
 182 static inline int bgetc(struct fastbuf *f)
 183 {
 184   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
 185 }
 186
 187 int bpeekc_slow(struct fastbuf *f);
 188 static inline int bpeekc(struct fastbuf *f)
 189 {
 190   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
 191 }
 192
 193 static inline void bungetc(struct fastbuf *f)
 194 {
 195   f->bptr--;
 196 }
 197
 198 void bputc_slow(struct fastbuf *f, uns c);
 199 static inline void bputc(struct fastbuf *f, uns c)
 200 {
 201   if (f->bptr < f->bufend)
 202     *f->bptr++ = c;
 203   else
 204     bputc_slow(f, c);
 205 }
 206
 207 static inline uns
 208 bavailr(struct fastbuf *f)
 209 {
 210   return f->bstop - f->bptr;
 211 }
 212
 213 static inline uns
 214 bavailw(struct fastbuf *f)
 215 {
 216   return f->bufend - f->bptr;
 217 }
 218
 219 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
 220 static inline uns bread(struct fastbuf *f, void *b, uns l)
 221 {
 222   if (bavailr(f) >= l)
 223     {
 224       memcpy(b, f->bptr, l);
 225       f->bptr += l;
 226       return l;
 227     }
 228   else
 229     return bread_slow(f, b, l, 0);
 230 }
 231
 232 static inline uns breadb(struct fastbuf *f, void *b, uns l)
 233 {
 234   if (bavailr(f) >= l)
 235     {
 236       memcpy(b, f->bptr, l);
 237       f->bptr += l;
 238       return l;
 239     }
 240   else
 241     return bread_slow(f, b, l, 1);
 242 }
 243
 244 void bwrite_slow(struct fastbuf *f, void *b, uns l);
 245 static inline void bwrite(struct fastbuf *f, void *b, uns l)
 246 {
 247   if (bavailw(f) >= l)
 248     {
 249       memcpy(f->bptr, b, l);
 250       f->bptr += l;
 251     }
 252   else
 253     bwrite_slow(f, b, l);
 254 }
 255
 256 byte *bgets(struct fastbuf *f, byte *b, uns l); /* Non-std */
 257 int bgets_nodie(struct fastbuf *f, byte *b, uns l);
 258 byte *bgets0(struct fastbuf *f, byte *b, uns l);
 259
 260 struct mempool;
 261 struct bb_t;
 262 uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
 263 byte *bgets_mp(struct fastbuf *f, struct mempool *mp);
 264
 265 struct bgets_stk_struct {
 266   struct fastbuf *f;
 267   byte *old_buf, *cur_buf, *src;
 268   uns old_len, cur_len, src_len;
 269 };
 270 void bgets_stk_init(struct bgets_stk_struct *s);
 271 void bgets_stk_step(struct bgets_stk_struct *s);
 272 #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; })
 273
 274 static inline void
 275 bputs(struct fastbuf *f, byte *b)
 276 {
 277   bwrite(f, b, strlen(b));
 278 }
 279
 280 static inline void
 281 bputs0(struct fastbuf *f, byte *b)
 282 {
 283   bwrite(f, b, strlen(b)+1);
 284 }
 285
 286 static inline void
 287 bputsn(struct fastbuf *f, byte *b)
 288 {
 289   bputs(f, b);
 290   bputc(f, '\n');
 291 }
 292
 293 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
 294 static inline void
 295 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
 296 {
 297   if (bavailr(f) >= l && bavailw(t) >= l)
 298     {
 299       memcpy(t->bptr, f->bptr, l);
 300       t->bptr += l;
 301       f->bptr += l;
 302     }
 303   else
 304     bbcopy_slow(f, t, l);
 305 }
 306
 307 int bskip_slow(struct fastbuf *f, uns len);
 308 static inline int bskip(struct fastbuf *f, uns len)
 309 {
 310   if (bavailr(f) >= len)
 311     {
 312       f->bptr += len;
 313       return 1;
 314     }
 315   else
 316     return bskip_slow(f, len);
 317 }
 318
 319 /* Direct I/O on buffers */
 320
 321 static inline uns
 322 bdirect_read_prepare(struct fastbuf *f, byte **buf)
 323 {
 324   if (f->bptr == f->bstop && !f->refill(f))
 325     {
 326       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
 327       return 0;
 328     }
 329   *buf = f->bptr;
 330   return bavailr(f);
 331 }
 332
 333 static inline void
 334 bdirect_read_commit(struct fastbuf *f, byte *pos)
 335 {
 336   f->bptr = pos;
 337 }
 338
 339 static inline void
 340 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
 341 {
 342   f->bptr = pos;
 343   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
 344 }
 345
 346 static inline uns
 347 bdirect_write_prepare(struct fastbuf *f, byte **buf)
 348 {
 349   if (f->bptr == f->bufend)
 350     f->spout(f);
 351   *buf = f->bptr;
 352   return bavailw(f);
 353 }
 354
 355 static inline void
 356 bdirect_write_commit(struct fastbuf *f, byte *pos)
 357 {
 358   f->bptr = pos;
 359 }
 360
 361 /* Formatted output */
 362
 363 int bprintf(struct fastbuf *b, char *msg, ...) FORMAT_CHECK(printf,2,3);
 364 int vbprintf(struct fastbuf *b, char *msg, va_list args);
 365
 366 #endif