X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=lib%2Ffastbuf.h;h=2ed05341dbcaa42b7268b09abd83de112024aba6;hb=e443a4773ae30fac352161cf3f9f6d97f229b8c3;hp=8195250e78e54c699d1c41079188c200dfb28a29;hpb=1641c17df8008adfb4720052ec01e427543cdd94;p=libucw.git

diff --git a/lib/fastbuf.h b/lib/fastbuf.h
index 8195250e..2ed05341 100644
--- a/lib/fastbuf.h
+++ b/lib/fastbuf.h
@@ -1,49 +1,138 @@
 /*
- *	Sherlock Library -- Fast File Buffering
+ *	Sherlock Library -- Fast Buffered I/O
  *
- *	(c) 1997 Martin Mares, <mj@atrey.karlin.mff.cuni.cz>
+ *	(c) 1997--2004 Martin Mares <mj@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
 
+#include <string.h>
+
+#include "lib/unaligned.h"
+
+/*
+ *  Generic buffered I/O. You supply hooks to be called for low-level operations
+ *  (swapping of buffers, seeking and closing), we do the rest.
+ *
+ *  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:
+ *
+ *  +--------+--------------+--------------------+
+ *  | unused | written data | free space         |
+ *  +--------+--------------+--------------------+
+ *  ^         ^              ^                    ^
+ *  buffer    bstop          bptr                 bufend
+ *
+ *  Dirty tricks:
+ *
+ *    - You can mix reads and writes on the same stream, but you must
+ *	call bflush() in between and remember that the file position
+ *	points after the flushed buffer which is not necessarily the same
+ *	as after the data you've read.
+ *    - The spout/refill hooks can change not only bptr and bstop, but also
+ *	the location of the buffer; fb-mem.c takes advantage of it.
+ */
+
 struct fastbuf {
+  byte is_fastbuf[0];			/* Dummy field for checking of type casts */
   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 */
+  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 */
+  void (*close)(struct fastbuf *);	/* Close the stream */
+  int (*config)(struct fastbuf *, uns, int);	/* Configure the stream */
 };
 
+/* FastIO on standard files (specify buffer size 0 to enable mmaping) */
+
 struct fastbuf *bopen(byte *name, uns mode, uns buffer);
+struct fastbuf *bopen_tmp(uns buffer);
 struct fastbuf *bfdopen(int fd, uns buffer);
+struct fastbuf *bfdopen_shared(int fd, uns buffer);
+
+/* 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 */
+
+/* FastIO on memory mapped files */
+
+struct fastbuf *bopen_mm(byte *name, uns mode);
+
+/* FastI on file descriptors with limit */
+
+struct fastbuf *bopen_limited_fd(int fd, uns bufsize, uns limit);
+
+/* FastIO on static buffers */
+
+void fbbuf_init_read(struct fastbuf *f, byte *buffer, uns size);
+void fbbuf_init_write(struct fastbuf *f, byte *buffer, uns size);
+static inline uns
+fbbuf_count_written(struct fastbuf *f)
+{
+  return f->bptr - f->bstop;
+}
+
+/* Configuring stream parameters */
+
+int bconfig(struct fastbuf *f, uns type, int data);
+
+#define BCONFIG_IS_TEMP_FILE 0
+
+/* 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 brewind(struct fastbuf *f);
 
-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);
+  return f->pos + (f->bptr - f->bstop);
 }
 
 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)
 {
-  *--f->bptr = c;
+  f->bptr--;
 }
 
-void bputc_slow(struct fastbuf *f, byte c);
-extern inline void bputc(struct fastbuf *f, byte c)
+void bputc_slow(struct fastbuf *f, uns c);
+static inline void bputc(struct fastbuf *f, uns c)
 {
   if (f->bptr < f->bufend)
     *f->bptr++ = c;
@@ -51,118 +140,137 @@ extern inline void bputc(struct fastbuf *f, byte 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
 }
 
-void bputw_slow(struct fastbuf *f, word w);
-extern inline void bputw(struct fastbuf *f, word w)
+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)
 {
-#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)
     {
@@ -173,41 +281,89 @@ extern inline void bwrite(struct fastbuf *f, void *b, uns l)
     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 */
+int bgets_nodie(struct fastbuf *f, byte *b, uns l);
+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');
 }
 
+void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
+static inline void
+bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
+{
+  if (f->bptr + l <= f->bstop &&
+      t->bptr + l <= t->bufend)
+    {
+      memcpy(t->bptr, f->bptr, l);
+      t->bptr += l;
+      f->bptr += l;
+    }
+  else
+    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
+
+/* Direct I/O on buffers */
+
+static inline uns
+bdirect_read_prepare(struct fastbuf *f, byte **buf)
+{
+  if (f->bptr == f->bstop && !f->refill(f))
+    return 0;
+  *buf = f->bptr;
+  return f->bstop - f->bptr;
+}
+
+static inline void
+bdirect_read_commit(struct fastbuf *f, byte *pos)
+{
+  f->bptr = pos;
+}
+
+static inline uns
+bdirect_write_prepare(struct fastbuf *f, byte **buf)
+{
+  if (f->bptr == f->bufend)
+    f->spout(f);
+  *buf = f->bptr;
+  return f->bufend - f->bptr;
+}
+
+static inline void
+bdirect_write_commit(struct fastbuf *f, byte *pos)
+{
+  f->bptr = pos;
+}
+
+/* Formatted output */
+
+int bprintf(struct fastbuf *b, byte *msg, ...);
+int vbprintf(struct fastbuf *b, byte *msg, va_list args);
+
+#endif