/*
- * Sherlock Library -- Fast File Buffering
+ * Sherlock Library -- Fast Buffered I/O
*
- * (c) 1997 Martin Mares, <mj@atrey.karlin.mff.cuni.cz>
+ * (c) 1997--2000 Martin Mares <mj@ucw.cz>
*/
+#ifndef _SHERLOCK_FASTBUF_H
+#define _SHERLOCK_FASTBUF_H
+
#ifndef EOF
#include <stdio.h>
#endif
+#include "lib/unaligned.h"
+
+/*
+ * Generic buffered I/O on a top of buffer swapping functions.
+ *
+ * Buffer layout when reading:
+ *
+ * +----------------+---------------------------+
+ * | read data | free space |
+ * +----------------+---------------------------+
+ * ^ ^ ^ ^
+ * buffer bptr bstop bufend
+ *
+ * After the last character is read, bptr == bstop and buffer refill
+ * is deferred to the next read attempt. This gives us an easy way
+ * how to implement bungetc().
+ *
+ * When writing:
+ *
+ * +----------------+---------------------------+
+ * | written data | free space |
+ * +----------------+---------------------------+
+ * ^ ^ ^
+ * buffer=bstop bptr bufend
+ */
+
struct fastbuf {
byte *bptr, *bstop; /* Access pointers */
byte *buffer, *bufend; /* Start and end of the buffer */
byte *name; /* File name for error messages */
- uns buflen; /* Size of standard portion of the buffer */
- uns pos; /* Position of bptr in the file */
- uns fdpos; /* Current position in the file */
- int fd; /* File descriptor */
+ uns buflen; /* Size of the buffer */
+ sh_off_t pos; /* Position of buffer start in the file */
+ sh_off_t fdpos; /* Current position in the non-buffered file */
+ int fd; /* File descriptor, -1 if not a real file */
+ int is_temp_file; /* Is a temporary file, delete on close */
+ void *lldata; /* Data private to access functions below */
+ void *llpos; /* ... continued ... */
+ 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 */
+ void (*close)(struct fastbuf *); /* Close the stream */
};
+/* FastIO on standard files */
+
struct fastbuf *bopen(byte *name, uns mode, uns buffer);
struct fastbuf *bfdopen(int fd, uns buffer);
+void bbcopy(struct fastbuf *f, struct fastbuf *t, uns l);
+
+/* FastIO on in-memory streams */
+
+struct fastbuf *fbmem_create(unsigned blocksize); /* Create stream and return its writing fastbuf */
+struct fastbuf *fbmem_clone_read(struct fastbuf *); /* Create reading fastbuf */
+
+/* Universal functions working on all fastbuf's */
+
void bclose(struct fastbuf *f);
void bflush(struct fastbuf *f);
+void bseek(struct fastbuf *f, sh_off_t pos, int whence);
+void bsetpos(struct fastbuf *f, sh_off_t pos);
-void bseek(struct fastbuf *f, uns pos, int whence);
-void bsetpos(struct fastbuf *f, uns pos);
-
-extern inline uns btell(struct fastbuf *f)
+static inline sh_off_t btell(struct fastbuf *f)
{
return f->pos + (f->bptr - f->buffer);
}
int bgetc_slow(struct fastbuf *f);
-extern inline int bgetc(struct fastbuf *f)
+static inline int bgetc(struct fastbuf *f)
{
return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
}
-extern inline void bungetc(struct fastbuf *f, byte c)
+int bpeekc_slow(struct fastbuf *f);
+static inline int bpeekc(struct fastbuf *f)
+{
+ return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
+}
+
+static inline void bungetc(struct fastbuf *f, byte c)
{
*--f->bptr = c;
}
void bputc_slow(struct fastbuf *f, byte c);
-extern inline void bputc(struct fastbuf *f, byte c)
+static inline void bputc(struct fastbuf *f, byte c)
{
if (f->bptr < f->bufend)
*f->bptr++ = c;
bputc_slow(f, c);
}
-word bgetw_slow(struct fastbuf *f);
-extern inline word bgetw(struct fastbuf *f)
+int bgetw_slow(struct fastbuf *f);
+static inline int bgetw(struct fastbuf *f)
{
-#ifdef CPU_CAN_DO_UNALIGNED_WORDS
- word w;
+ int w;
if (f->bptr + 2 <= f->bstop)
{
- w = * ((word *) f->bptr);
+ w = GET_U16(f->bptr);
f->bptr += 2;
return w;
}
else
return bgetw_slow(f);
-#else
- word w = bgetc(f);
-#ifdef CPU_BIG_ENDIAN
- return (w << 8) | bgetc(f);
-#else
- return w | (bgetc(f) << 8);
-#endif
-#endif
}
-ulg bgetl_slow(struct fastbuf *f);
-extern inline ulg bgetl(struct fastbuf *f)
+u32 bgetl_slow(struct fastbuf *f);
+static inline u32 bgetl(struct fastbuf *f)
{
-#ifdef CPU_CAN_DO_UNALIGNED_LONGS
- ulg l;
+ u32 l;
if (f->bptr + 4 <= f->bstop)
{
- l = * ((ulg *) f->bptr);
+ l = GET_U32(f->bptr);
f->bptr += 4;
return l;
}
else
return bgetl_slow(f);
-#else
- ulg l = bgetc(f);
-#ifdef CPU_BIG_ENDIAN
- l = (l << 8) | bgetc(f);
- l = (l << 8) | bgetc(f);
- return (l << 8) | bgetc(f);
-#else
- l = (bgetc(f) << 8) | l;
- l = (bgetc(f) << 16) | l;
- return (bgetc(f) << 24) | l;
-#endif
-#endif
+}
+
+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, word w);
-extern inline void bputw(struct fastbuf *f, word w)
+static inline void bputw(struct fastbuf *f, word w)
{
-#ifdef CPU_CAN_DO_UNALIGNED_WORDS
if (f->bptr + 2 <= f->bufend)
{
- * ((word *) f->bptr) = w;
+ PUT_U16(f->bptr, w);
f->bptr += 2;
}
else
bputw_slow(f, w);
-#else
-#ifdef CPU_BIG_ENDIAN
- bputc(f, w >> 8);
- bputc(f, w);
-#else
- bputc(f, w);
- bputc(f, w >> 8);
-#endif
-#endif
}
-void bputl_slow(struct fastbuf *f, ulg l);
-extern inline void bputl(struct fastbuf *f, ulg l)
+void bputl_slow(struct fastbuf *f, u32 l);
+static inline void bputl(struct fastbuf *f, u32 l)
{
-#ifdef CPU_CAN_DO_UNALIGNED_LONGS
if (f->bptr + 4 <= f->bufend)
{
- * ((ulg *) f->bptr) = l;
+ PUT_U32(f->bptr, l);
f->bptr += 4;
}
else
bputl_slow(f, l);
-#else
-#ifdef CPU_BIG_ENDIAN
- bputc(f, l >> 24);
- bputc(f, l >> 16);
- bputc(f, l >> 8);
- bputc(f, l);
-#else
- bputc(f, l);
- bputc(f, l >> 8);
- bputc(f, l >> 16);
- bputc(f, l >> 24);
-#endif
-#endif
}
-void bread_slow(struct fastbuf *f, void *b, uns l);
-extern inline void bread(struct fastbuf *f, void *b, uns l)
+void bputq_slow(struct fastbuf *f, u64 l);
+static inline void bputq(struct fastbuf *f, u64 l)
+{
+ if (f->bptr + 8 <= f->bufend)
+ {
+ PUT_U64(f->bptr, l);
+ f->bptr += 8;
+ }
+ else
+ bputq_slow(f, l);
+}
+
+void bput5_slow(struct fastbuf *f, u64 l);
+static inline void bput5(struct fastbuf *f, u64 l)
+{
+ if (f->bptr + 5 <= f->bufend)
+ {
+ PUT_U40(f->bptr, l);
+ f->bptr += 5;
+ }
+ else
+ bput5_slow(f, l);
+}
+
+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)
{
memcpy(b, f->bptr, l);
f->bptr += l;
+ return l;
}
else
- bread_slow(f, b, l);
+ return bread_slow(f, b, l, 0);
+}
+
+static inline uns breadb(struct fastbuf *f, void *b, uns l)
+{
+ if (f->bptr + l <= f->bstop)
+ {
+ memcpy(b, f->bptr, l);
+ f->bptr += l;
+ return l;
+ }
+ else
+ return bread_slow(f, b, l, 1);
}
void bwrite_slow(struct fastbuf *f, void *b, uns l);
-extern inline void bwrite(struct fastbuf *f, void *b, uns l)
+static inline void bwrite(struct fastbuf *f, void *b, uns l)
{
if (f->bptr + l <= f->bufend)
{
bwrite_slow(f, b, l);
}
-void bbcopy(struct fastbuf *f, struct fastbuf *t, uns l);
+byte *bgets(struct fastbuf *f, byte *b, uns l); /* Non-std */
+byte *bgets0(struct fastbuf *f, byte *b, uns l);
-extern inline byte * /* Non-standard */
-bgets(struct fastbuf *f, byte *b, uns l)
+static inline void
+bputs(struct fastbuf *f, byte *b)
{
- byte *e = b + l - 1;
- int k;
-
- k = bgetc(f);
- if (k == EOF)
- return NULL;
- while (b < e)
- {
- if (k == '\n' || k == EOF)
- {
- *b = 0;
- return b;
- }
- *b++ = k;
- k = bgetc(f);
- }
- die("%s: Line too long", f->name);
+ bwrite(f, b, strlen(b));
}
-extern inline void
-bputs(struct fastbuf *f, byte *b)
+static inline void
+bputs0(struct fastbuf *f, byte *b)
{
- while (*b)
- bputc(f, *b++);
+ bwrite(f, b, strlen(b)+1);
}
-extern inline void
+static inline void
bputsn(struct fastbuf *f, byte *b)
{
bputs(f, b);
bputc(f, '\n');
}
+/* 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
+
+/* Direct I/O on buffers */
+
+int bdirect_read(struct fastbuf *f, byte **buf);
+int bdirect_write_prepare(struct fastbuf *f, byte **buf);
+void bdirect_write_commit(struct fastbuf *f, byte *pos);
+
+#endif