ucw/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   char *name;                           /* File name for error messages */
  67   ucw_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 *, ucw_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 several configurable back-ends */
  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 a description) */
  81   FB_MMAP                               /* Memory mapped files */
  82 };
  83
  84 struct fb_params {
  85   enum fb_type type;
  86   uns buffer_size;                      /* 0 for default size */
  87   uns keep_back_buf;                    /* FB_STD: optimize for bi-directional access */
  88   uns read_ahead;                       /* FB_DIRECT options */
  89   uns write_back;
  90   struct asio_queue *asio;
  91 };
  92
  93 struct cf_section;
  94 extern struct cf_section fbpar_cf;
  95 extern struct fb_params fbpar_def;
  96
  97 struct fastbuf *bopen_file(const char *name, int mode, struct fb_params *params);       /* Use params==NULL for defaults */
  98 struct fastbuf *bopen_file_try(const char *name, int mode, struct fb_params *params);
  99 struct fastbuf *bopen_tmp_file(struct fb_params *params);
 100 struct fastbuf *bopen_fd_name(int fd, struct fb_params *params, const char *name);
 101 static inline struct fastbuf *bopen_fd(int fd, struct fb_params *params)
 102 {
 103   return bopen_fd_name(fd, params, NULL);
 104 }
 105
 106 /* FastIO on standard files (shortcuts for FB_STD) */
 107
 108 struct fastbuf *bopen(const char *name, uns mode, uns buflen);
 109 struct fastbuf *bopen_try(const char *name, uns mode, uns buflen);
 110 struct fastbuf *bopen_tmp(uns buflen);
 111 struct fastbuf *bfdopen(int fd, uns buflen);
 112 struct fastbuf *bfdopen_shared(int fd, uns buflen);
 113 void bfilesync(struct fastbuf *b);
 114
 115 /* Temporary files */
 116
 117 #define TEMP_FILE_NAME_LEN 256
 118 void temp_file_name(char *name_buf, int *open_flags);
 119 void bfix_tmp_file(struct fastbuf *fb, const char *name);
 120 int open_tmp(char *name_buf, int open_flags, int mode);
 121
 122 /* Internal functions of some file back-ends */
 123
 124 struct fastbuf *bfdopen_internal(int fd, const char *name, uns buflen);
 125 struct fastbuf *bfmmopen_internal(int fd, const char *name, uns mode);
 126
 127 extern uns fbdir_cheat;
 128 struct asio_queue;
 129 struct fastbuf *fbdir_open_fd_internal(int fd, const char *name, struct asio_queue *io_queue, uns buffer_size, uns read_ahead, uns write_back);
 130
 131 void bclose_file_helper(struct fastbuf *f, int fd, int is_temp_file);
 132
 133 /* FastIO on in-memory streams */
 134
 135 struct fastbuf *fbmem_create(uns blocksize);            /* Create stream and return its writing fastbuf */
 136 struct fastbuf *fbmem_clone_read(struct fastbuf *);     /* Create reading fastbuf */
 137
 138 /* FastI on file descriptors with limit */
 139
 140 struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit);
 141
 142 /* FastIO on static buffers */
 143
 144 void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size, uns can_overwrite);
 145 void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
 146 static inline uns
 147 fbbuf_count_written(struct fastbuf *f)
 148 {
 149   return f->bptr - f->bstop;
 150 }
 151
 152 /* FastIO on recyclable growing buffers */
 153
 154 struct fastbuf *fbgrow_create(unsigned basic_size);
 155 void fbgrow_reset(struct fastbuf *b);                   /* Reset stream and prepare for writing */
 156 void fbgrow_rewind(struct fastbuf *b);                  /* Prepare for reading */
 157
 158 /* FastO on memory pools */
 159
 160 struct mempool;
 161 struct fbpool {
 162   struct fastbuf fb;
 163   struct mempool *mp;
 164 };
 165
 166 void fbpool_init(struct fbpool *fb);    /* Initialize a new fastbuf */
 167 void fbpool_start(struct fbpool *fb, struct mempool *mp, uns init_size);
 168                                         /* Start a new continuous block and prepare for writing (see mp_start()) */
 169 void *fbpool_end(struct fbpool *fb);    /* Close the block and return its address (see mp_end()).
 170                                            The length can be determined with mp_size(mp, ptr). */
 171
 172 /* FastO with atomic writes for multi-threaded programs */
 173
 174 struct fb_atomic {
 175   struct fastbuf fb;
 176   struct fb_atomic_file *af;
 177   byte *expected_max_bptr;
 178   uns slack_size;
 179 };
 180 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
 181
 182 struct fastbuf *fbatomic_open(const char *name, struct fastbuf *master, uns bufsize, int record_len);
 183 void fbatomic_internal_write(struct fastbuf *b);
 184
 185 static inline void
 186 fbatomic_commit(struct fastbuf *b)
 187 {
 188   if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
 189     fbatomic_internal_write(b);
 190 }
 191
 192 /* Configuring stream parameters */
 193
 194 enum bconfig_type {
 195   BCONFIG_IS_TEMP_FILE,                 /* 0=normal file, 1=temporary file, 2=shared fd */
 196   BCONFIG_KEEP_BACK_BUF,                /* Optimize for bi-directional access */
 197 };
 198
 199 int bconfig(struct fastbuf *f, uns type, int data);
 200
 201 /* Universal functions working on all fastbuf's */
 202
 203 void bclose(struct fastbuf *f);
 204 void bflush(struct fastbuf *f);
 205 void bseek(struct fastbuf *f, ucw_off_t pos, int whence);
 206 void bsetpos(struct fastbuf *f, ucw_off_t pos);
 207 void brewind(struct fastbuf *f);
 208 ucw_off_t bfilesize(struct fastbuf *f);         /* -1 if not seekable */
 209
 210 static inline ucw_off_t btell(struct fastbuf *f)
 211 {
 212   return f->pos + (f->bptr - f->bstop);
 213 }
 214
 215 int bgetc_slow(struct fastbuf *f);
 216 static inline int bgetc(struct fastbuf *f)
 217 {
 218   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
 219 }
 220
 221 int bpeekc_slow(struct fastbuf *f);
 222 static inline int bpeekc(struct fastbuf *f)
 223 {
 224   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
 225 }
 226
 227 static inline void bungetc(struct fastbuf *f)
 228 {
 229   f->bptr--;
 230 }
 231
 232 void bputc_slow(struct fastbuf *f, uns c);
 233 static inline void bputc(struct fastbuf *f, uns c)
 234 {
 235   if (f->bptr < f->bufend)
 236     *f->bptr++ = c;
 237   else
 238     bputc_slow(f, c);
 239 }
 240
 241 static inline uns
 242 bavailr(struct fastbuf *f)
 243 {
 244   return f->bstop - f->bptr;
 245 }
 246
 247 static inline uns
 248 bavailw(struct fastbuf *f)
 249 {
 250   return f->bufend - f->bptr;
 251 }
 252
 253 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
 254 static inline uns bread(struct fastbuf *f, void *b, uns l)
 255 {
 256   if (bavailr(f) >= l)
 257     {
 258       memcpy(b, f->bptr, l);
 259       f->bptr += l;
 260       return l;
 261     }
 262   else
 263     return bread_slow(f, b, l, 0);
 264 }
 265
 266 static inline uns breadb(struct fastbuf *f, void *b, uns l)
 267 {
 268   if (bavailr(f) >= l)
 269     {
 270       memcpy(b, f->bptr, l);
 271       f->bptr += l;
 272       return l;
 273     }
 274   else
 275     return bread_slow(f, b, l, 1);
 276 }
 277
 278 void bwrite_slow(struct fastbuf *f, const void *b, uns l);
 279 static inline void bwrite(struct fastbuf *f, const void *b, uns l)
 280 {
 281   if (bavailw(f) >= l)
 282     {
 283       memcpy(f->bptr, b, l);
 284       f->bptr += l;
 285     }
 286   else
 287     bwrite_slow(f, b, l);
 288 }
 289
 290 /*
 291  *  Functions for reading of strings:
 292  *
 293  *     bgets()          reads a line, strip the trailing '\n' and return a pointer
 294  *                      to the terminating 0 or NULL on EOF. Dies if the line is too long.
 295  *     bgets0()         does the same for 0-terminated strings.
 296  *     bgets_nodie()    a variant of bgets() which returns either the length of the
 297  *                      string (excluding the terminator) or -1 if the line does not fit
 298  *                      in the buffer. In such cases, it returns after reading exactly `l'
 299  *                      bytes of input.
 300  *     bgets_bb()       a variant of bgets() which allocates the string in a growing buffer
 301  *     bgets_mp()       the same, but in a mempool
 302  *     bgets_stk()      the same, but on the stack by alloca()
 303  */
 304
 305 char *bgets(struct fastbuf *f, char *b, uns l);
 306 char *bgets0(struct fastbuf *f, char *b, uns l);
 307 int bgets_nodie(struct fastbuf *f, char *b, uns l);
 308
 309 struct mempool;
 310 struct bb_t;
 311 uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
 312 char *bgets_mp(struct fastbuf *f, struct mempool *mp);
 313
 314 struct bgets_stk_struct {
 315   struct fastbuf *f;
 316   byte *old_buf, *cur_buf, *src;
 317   uns old_len, cur_len, src_len;
 318 };
 319 void bgets_stk_init(struct bgets_stk_struct *s);
 320 void bgets_stk_step(struct bgets_stk_struct *s);
 321 #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; })
 322
 323 static inline void
 324 bputs(struct fastbuf *f, const char *b)
 325 {
 326   bwrite(f, b, strlen(b));
 327 }
 328
 329 static inline void
 330 bputs0(struct fastbuf *f, const char *b)
 331 {
 332   bwrite(f, b, strlen(b)+1);
 333 }
 334
 335 static inline void
 336 bputsn(struct fastbuf *f, const char *b)
 337 {
 338   bputs(f, b);
 339   bputc(f, '\n');
 340 }
 341
 342 void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
 343 static inline void
 344 bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
 345 {
 346   if (bavailr(f) >= l && bavailw(t) >= l)
 347     {
 348       memcpy(t->bptr, f->bptr, l);
 349       t->bptr += l;
 350       f->bptr += l;
 351     }
 352   else
 353     bbcopy_slow(f, t, l);
 354 }
 355
 356 int bskip_slow(struct fastbuf *f, uns len);
 357 static inline int bskip(struct fastbuf *f, uns len)
 358 {
 359   if (bavailr(f) >= len)
 360     {
 361       f->bptr += len;
 362       return 1;
 363     }
 364   else
 365     return bskip_slow(f, len);
 366 }
 367
 368 /* Direct I/O on buffers */
 369
 370 static inline uns
 371 bdirect_read_prepare(struct fastbuf *f, byte **buf)
 372 {
 373   if (f->bptr == f->bstop && !f->refill(f))
 374     {
 375       *buf = NULL;  // This is not needed, but it helps to get rid of spurious warnings
 376       return 0;
 377     }
 378   *buf = f->bptr;
 379   return bavailr(f);
 380 }
 381
 382 static inline void
 383 bdirect_read_commit(struct fastbuf *f, byte *pos)
 384 {
 385   f->bptr = pos;
 386 }
 387
 388 static inline void
 389 bdirect_read_commit_modified(struct fastbuf *f, byte *pos)
 390 {
 391   f->bptr = pos;
 392   f->buffer = pos;      /* Avoid seeking backwards in the buffer */
 393 }
 394
 395 static inline uns
 396 bdirect_write_prepare(struct fastbuf *f, byte **buf)
 397 {
 398   if (f->bptr == f->bufend)
 399     f->spout(f);
 400   *buf = f->bptr;
 401   return bavailw(f);
 402 }
 403
 404 static inline void
 405 bdirect_write_commit(struct fastbuf *f, byte *pos)
 406 {
 407   f->bptr = pos;
 408 }
 409
 410 /* Formatted output */
 411
 412 int bprintf(struct fastbuf *b, const char *msg, ...) FORMAT_CHECK(printf,2,3);
 413 int vbprintf(struct fastbuf *b, const char *msg, va_list args);
 414
 415 #endif