/*
- * Sherlock Library -- Fast Buffered I/O
+ * UCW Library -- Fast Buffered I/O
*
- * (c) 1997--2004 Martin Mares <mj@ucw.cz>
+ * (c) 1997--2007 Martin Mares <mj@ucw.cz>
* (c) 2004 Robert Spalek <robert@ucw.cz>
*
* This software may be freely distributed and used according to the terms
* of the GNU Lesser General Public License.
*/
-#ifndef _SHERLOCK_FASTBUF_H
-#define _SHERLOCK_FASTBUF_H
-
-#ifndef EOF
-#include <stdio.h>
-#endif
+#ifndef _UCW_FASTBUF_H
+#define _UCW_FASTBUF_H
#include <string.h>
-
-#include "lib/unaligned.h"
+#include <alloca.h>
/*
* Generic buffered I/O. You supply hooks to be called for low-level operations
sh_off_t pos; /* Position of bstop in the file */
int (*refill)(struct fastbuf *); /* Get a buffer with new data */
void (*spout)(struct fastbuf *); /* Write buffer data to the file */
- void (*seek)(struct fastbuf *, sh_off_t, int); /* Slow path for bseek(), buffer already flushed */
+ int (*seek)(struct fastbuf *, sh_off_t, int); /* Slow path for bseek(), buffer already flushed; returns success */
void (*close)(struct fastbuf *); /* Close the stream */
int (*config)(struct fastbuf *, uns, int); /* Configure the stream */
int can_overwrite_buffer; /* Can the buffer be altered? (see discussion above) 0=never, 1=temporarily, 2=permanently */
/* FastIO on standard files (specify buffer size 0 to enable mmaping) */
struct fastbuf *bopen(byte *name, uns mode, uns buflen);
+struct fastbuf *bopen_try(byte *name, uns mode, uns buflen);
struct fastbuf *bopen_tmp(uns buflen);
struct fastbuf *bfdopen(int fd, uns buflen);
struct fastbuf *bfdopen_shared(int fd, uns buflen);
void bfilesync(struct fastbuf *b);
+#define TEMP_FILE_NAME_LEN 256
+void temp_file_name(byte *name);
+
/* FastIO on in-memory streams */
struct fastbuf *fbmem_create(unsigned blocksize); /* Create stream and return its writing fastbuf */
return f->bptr - f->bstop;
}
+/* FastIO on recyclable growing buffers */
+
+struct fastbuf *fbgrow_create(unsigned basic_size);
+void fbgrow_reset(struct fastbuf *b); /* Reset stream and prepare for writing */
+void fbgrow_rewind(struct fastbuf *b); /* Prepare for reading */
+
+/* FastO with atomic writes for multi-threaded programs */
+
+struct fb_atomic {
+ struct fastbuf fb;
+ struct fb_atomic_file *af;
+ byte *expected_max_bptr;
+ uns slack_size;
+};
+#define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
+
+struct fastbuf *fbatomic_open(byte *name, struct fastbuf *master, uns bufsize, int record_len);
+void fbatomic_internal_write(struct fastbuf *b);
+
+static inline void
+fbatomic_commit(struct fastbuf *b)
+{
+ if (b->bptr >= ((struct fb_atomic *)b)->expected_max_bptr)
+ fbatomic_internal_write(b);
+}
+
/* Configuring stream parameters */
int bconfig(struct fastbuf *f, uns type, int data);
void bseek(struct fastbuf *f, sh_off_t pos, int whence);
void bsetpos(struct fastbuf *f, sh_off_t pos);
void brewind(struct fastbuf *f);
-void bskip(struct fastbuf *f, uns len);
-sh_off_t bfilesize(struct fastbuf *f);
+sh_off_t bfilesize(struct fastbuf *f); // -1 if not seekable
static inline sh_off_t btell(struct fastbuf *f)
{
bputc_slow(f, c);
}
-int bgetw_slow(struct fastbuf *f);
-static inline int bgetw(struct fastbuf *f)
-{
- int w;
- if (f->bptr + 2 <= f->bstop)
- {
- w = GET_U16(f->bptr);
- f->bptr += 2;
- return w;
- }
- else
- return bgetw_slow(f);
-}
-
-u32 bgetl_slow(struct fastbuf *f);
-static inline u32 bgetl(struct fastbuf *f)
-{
- u32 l;
- if (f->bptr + 4 <= f->bstop)
- {
- l = GET_U32(f->bptr);
- f->bptr += 4;
- return l;
- }
- else
- return bgetl_slow(f);
-}
-
-u64 bgetq_slow(struct fastbuf *f);
-static inline u64 bgetq(struct fastbuf *f)
-{
- u64 l;
- if (f->bptr + 8 <= f->bstop)
- {
- l = GET_U64(f->bptr);
- f->bptr += 8;
- return l;
- }
- else
- return bgetq_slow(f);
-}
-
-u64 bget5_slow(struct fastbuf *f);
-static inline u64 bget5(struct fastbuf *f)
-{
- u64 l;
- if (f->bptr + 5 <= f->bstop)
- {
- l = GET_U40(f->bptr);
- f->bptr += 5;
- return l;
- }
- else
- return bget5_slow(f);
-}
-
-void bputw_slow(struct fastbuf *f, uns w);
-static inline void bputw(struct fastbuf *f, uns w)
-{
- if (f->bptr + 2 <= f->bufend)
- {
- PUT_U16(f->bptr, w);
- f->bptr += 2;
- }
- else
- bputw_slow(f, w);
-}
-
-void bputl_slow(struct fastbuf *f, u32 l);
-static inline void bputl(struct fastbuf *f, u32 l)
-{
- if (f->bptr + 4 <= f->bufend)
- {
- PUT_U32(f->bptr, l);
- f->bptr += 4;
- }
- else
- bputl_slow(f, l);
-}
-
-void bputq_slow(struct fastbuf *f, u64 l);
-static inline void bputq(struct fastbuf *f, u64 l)
+static inline uns
+bavailr(struct fastbuf *f)
{
- if (f->bptr + 8 <= f->bufend)
- {
- PUT_U64(f->bptr, l);
- f->bptr += 8;
- }
- else
- bputq_slow(f, l);
+ return f->bstop - f->bptr;
}
-void bput5_slow(struct fastbuf *f, u64 l);
-static inline void bput5(struct fastbuf *f, u64 l)
+static inline uns
+bavailw(struct fastbuf *f)
{
- if (f->bptr + 5 <= f->bufend)
- {
- PUT_U40(f->bptr, l);
- f->bptr += 5;
- }
- else
- bput5_slow(f, l);
+ return f->bufend - f->bptr;
}
uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
static inline uns bread(struct fastbuf *f, void *b, uns l)
{
- if (f->bptr + l <= f->bstop)
+ if (bavailr(f) >= l)
{
memcpy(b, f->bptr, l);
f->bptr += l;
static inline uns breadb(struct fastbuf *f, void *b, uns l)
{
- if (f->bptr + l <= f->bstop)
+ if (bavailr(f) >= l)
{
memcpy(b, f->bptr, l);
f->bptr += l;
void bwrite_slow(struct fastbuf *f, void *b, uns l);
static inline void bwrite(struct fastbuf *f, void *b, uns l)
{
- if (f->bptr + l <= f->bufend)
+ if (bavailw(f) >= l)
{
memcpy(f->bptr, b, l);
f->bptr += l;
int bgets_nodie(struct fastbuf *f, byte *b, uns l);
byte *bgets0(struct fastbuf *f, byte *b, uns l);
+struct mempool;
+struct bb_t;
+uns bgets_bb(struct fastbuf *f, struct bb_t *b, uns limit);
+byte *bgets_mp(struct fastbuf *f, struct mempool *mp);
+
+struct bgets_stk_struct {
+ struct fastbuf *f;
+ byte *old_buf, *cur_buf, *src;
+ uns old_len, cur_len, src_len;
+};
+void bgets_stk_init(struct bgets_stk_struct *s);
+void bgets_stk_step(struct bgets_stk_struct *s);
+#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; })
+
static inline void
bputs(struct fastbuf *f, byte *b)
{
static inline void
bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
{
- if (f->bptr + l <= f->bstop &&
- t->bptr + l <= t->bufend)
+ if (bavailr(f) >= l && bavailw(t) >= l)
{
memcpy(t->bptr, f->bptr, l);
t->bptr += l;
bbcopy_slow(f, t, l);
}
-/* I/O on addr_int_t */
-
-#ifdef CPU_64BIT_POINTERS
-#define bputa(x,p) bputq(x,p)
-#define bgeta(x) bgetq(x)
-#else
-#define bputa(x,p) bputl(x,p)
-#define bgeta(x) bgetl(x)
-#endif
+int bskip_slow(struct fastbuf *f, uns len);
+static inline int bskip(struct fastbuf *f, uns len)
+{
+ if (bavailr(f) >= len)
+ {
+ f->bptr += len;
+ return 1;
+ }
+ else
+ return bskip_slow(f, len);
+}
/* Direct I/O on buffers */
bdirect_read_prepare(struct fastbuf *f, byte **buf)
{
if (f->bptr == f->bstop && !f->refill(f))
- return 0;
+ {
+ *buf = NULL; // This is not needed, but it helps to get rid of spurious warnings
+ return 0;
+ }
*buf = f->bptr;
- return f->bstop - f->bptr;
+ return bavailr(f);
}
static inline void
if (f->bptr == f->bufend)
f->spout(f);
*buf = f->bptr;
- return f->bufend - f->bptr;
+ return bavailw(f);
}
static inline void
/* Formatted output */
-int bprintf(struct fastbuf *b, byte *msg, ...);
-int vbprintf(struct fastbuf *b, byte *msg, va_list args);
+int bprintf(struct fastbuf *b, char *msg, ...) FORMAT_CHECK(printf,2,3);
+int vbprintf(struct fastbuf *b, char *msg, va_list args);
#endif
projects / libucw.git / blobdiff