Defined a GET_TAGGED_CHAR macro to read our internal representation

[libucw.git] / lib / fastbuf.h

diff --git a/lib/fastbuf.h b/lib/fastbuf.h
index ba9c42c51322519ac28ee106adba71eae718c8df..d831ed36153a877f27d0cf5f9cb85d90ac615604 100644 (file)
--- a/lib/fastbuf.h
+++ b/lib/fastbuf.h
@@ -1,55 +1,99 @@
 /*
 /*

- *     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
 
 #ifndef EOF
 #include <stdio.h>
 #endif
 

+/*
+ *  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 */
 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);
 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 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);
 {
   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);
 }
 
 int bpeekc_slow(struct fastbuf *f);
 {
   return (f->bptr < f->bstop) ? (int) *f->bptr++ : bgetc_slow(f);
 }
 
 int bpeekc_slow(struct fastbuf *f);

-extern inline int bpeekc(struct fastbuf *f)
+static inline int bpeekc(struct fastbuf *f)

 {
   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
 }
 
 {
   return (f->bptr < f->bstop) ? (int) *f->bptr : bpeekc_slow(f);
 }
 

-extern inline void bungetc(struct fastbuf *f, byte c)
+static inline void bungetc(struct fastbuf *f, byte c)

 {
   *--f->bptr = c;
 }
 
 void bputc_slow(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;
 {
   if (f->bptr < f->bufend)
     *f->bptr++ = c;


@@ -58,7 +102,7 @@ extern inline void bputc(struct fastbuf *f, byte c)
 }
 
 word bgetw_slow(struct fastbuf *f);
 }
 
 word bgetw_slow(struct fastbuf *f);

-extern inline word bgetw(struct fastbuf *f)
+static inline word bgetw(struct fastbuf *f)

 {
   word w;
   if (f->bptr + 2 <= f->bstop)
 {
   word w;
   if (f->bptr + 2 <= f->bstop)


@@ -80,15 +124,15 @@ extern inline word bgetw(struct fastbuf *f)
     return bgetw_slow(f);
 }
 
     return bgetw_slow(f);
 }
 

-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)

 {
 {

-  ulg l;
+  u32 l;

   if (f->bptr + 4 <= f->bstop)
     {
       byte *p = f->bptr;
 #ifdef CPU_CAN_DO_UNALIGNED_LONGS
   if (f->bptr + 4 <= f->bstop)
     {
       byte *p = f->bptr;
 #ifdef CPU_CAN_DO_UNALIGNED_LONGS

-      l = * ((ulg *) p);
+      l = * ((u32 *) p);

 #else
 #ifdef CPU_BIG_ENDIAN
       l = (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];
 #else
 #ifdef CPU_BIG_ENDIAN
       l = (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];


@@ -103,8 +147,41 @@ extern inline ulg bgetl(struct fastbuf *f)
     return bgetl_slow(f);
 }
 
     return bgetl_slow(f);
 }
 

+u64 bgetq_slow(struct fastbuf *f);
+static inline u64 bgetq(struct fastbuf *f)
+{
+  if (f->bptr + 8 <= f->bstop)
+    {
+      u64 l;
+      memcpy(&l, f->bptr, 8);
+      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)
+    {
+      byte *p = f->bptr;
+#ifdef CPU_BIG_ENDIAN
+      l = ((u64)p[0] << 32) | (u32)((p[1] << 24) | (p[2] << 16) | (p[3] << 8) | p[4]);
+#else
+      l = ((u64)p[4] << 32) | (u32)((p[3] << 24) | (p[2] << 16) | (p[1] << 8) | p[0]);
+#endif
+      f->bptr += 5;
+      return l;
+    }
+  else
+    return bget5_slow(f);
+}
+

 void bputw_slow(struct fastbuf *f, word w);
 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)

 {
   if (f->bptr + 2 <= f->bufend)
     {
 {
   if (f->bptr + 2 <= f->bufend)
     {


@@ -126,14 +203,14 @@ extern inline void bputw(struct fastbuf *f, word w)
     bputw_slow(f, w);
 }
 
     bputw_slow(f, w);
 }
 

-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)

 {
   if (f->bptr + 4 <= f->bufend)
     {
       byte *p = f->bptr;
 #ifdef CPU_CAN_DO_UNALIGNED_LONGS
 {
   if (f->bptr + 4 <= f->bufend)
     {
       byte *p = f->bptr;
 #ifdef CPU_CAN_DO_UNALIGNED_LONGS

-      * ((ulg *) p) = l;
+      * ((u32 *) p) = l;

 #else
 #ifdef CPU_BIG_ENDIAN
       p[0] = l >> 24U;
 #else
 #ifdef CPU_BIG_ENDIAN
       p[0] = l >> 24U;


@@ -153,20 +230,71 @@ extern inline void bputl(struct fastbuf *f, ulg l)
     bputl_slow(f, l);
 }
 
     bputl_slow(f, l);
 }
 

-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)
+    {
+      memcpy(f->bptr, &l, 8);
+      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)
+    {
+      byte *p = f->bptr;
+      u32 low = l;
+#ifdef CPU_BIG_ENDIAN
+      p[0] = l >> 32U;
+      p[1] = low >> 24U;
+      p[2] = low >> 16U;
+      p[3] = low >> 8U;
+      p[4] = low;
+#else
+      p[4] = l >> 32U;
+      p[3] = low >> 24U;
+      p[2] = low >> 16U;
+      p[1] = low >> 8U;
+      p[0] = low;
+#endif
+      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
+    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;
 {
   if (f->bptr + l <= f->bstop)
     {
       memcpy(b, f->bptr, l);
       f->bptr += l;

+      return l;

     }
   else
     }
   else

-    bread_slow(f, b, l);
+    return bread_slow(f, b, l, 1);

 }
 
 void bwrite_slow(struct fastbuf *f, void *b, uns l);
 }
 
 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)
     {
 {
   if (f->bptr + l <= f->bufend)
     {


@@ -177,19 +305,46 @@ extern inline void bwrite(struct fastbuf *f, void *b, uns l)
     bwrite_slow(f, b, 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 */
 byte *bgets(struct fastbuf *f, byte *b, uns l);        /* Non-std */

+byte *bgets0(struct fastbuf *f, byte *b, uns l);

 
 

-extern inline void
+static inline void

 bputs(struct fastbuf *f, byte *b)
 {
   bwrite(f, b, strlen(b));
 }
 
 bputs(struct fastbuf *f, byte *b)
 {
   bwrite(f, b, strlen(b));
 }
 

-extern inline void
+static inline void
+bputs0(struct fastbuf *f, byte *b)
+{
+  bwrite(f, b, strlen(b)+1);
+}
+
+static inline void

 bputsn(struct fastbuf *f, byte *b)
 {
   bputs(f, b);
   bputc(f, '\n');
 }
 
 bputsn(struct fastbuf *f, byte *b)
 {
   bputs(f, b);
   bputc(f, '\n');
 }
 

+/* 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);
+
+/* Depending on compile-time configuration, we select the right function for reading/writing of file offsets */
+
+#ifdef SHERLOCK_CONFIG_LARGE_DB
+#define bgeto(f) bget5(f)
+#define bputo(f,l) bput5(f,l)
+#define bgetp(f) bgetq(f)
+#define bputp(f,l) bputq(f,l)
+#else
+#define bgeto(f) bgetl(f)
+#define bputo(f,l) bputl(f,l)
+#define bgetp(f) bgetl(f)
+#define bputp(f,l) bputl(f,l)
+#endif
+
+#endif