Added a library module for distributing work between threads.

[libucw.git] / lib / fastbuf.h

diff --git a/lib/fastbuf.h b/lib/fastbuf.h
index 851a1a0c1ec2342cd869d47eecdb1baa17edf28f..922798ff183515a3d102191c6e614569373088e1 100644 (file)
--- a/lib/fastbuf.h
+++ b/lib/fastbuf.h
@@ -1,5 +1,5 @@
 /*
 /*

- *     Sherlock Library -- Fast Buffered I/O
+ *     UCW Library -- Fast Buffered I/O

  *
  *     (c) 1997--2004 Martin Mares <mj@ucw.cz>
  *     (c) 2004 Robert Spalek <robert@ucw.cz>
  *
  *     (c) 1997--2004 Martin Mares <mj@ucw.cz>
  *     (c) 2004 Robert Spalek <robert@ucw.cz>


@@ -8,14 +8,15 @@
  *     of the GNU Lesser General Public License.
  */
 
  *     of the GNU Lesser General Public License.
  */
 

-#ifndef _SHERLOCK_FASTBUF_H
-#define _SHERLOCK_FASTBUF_H
+#ifndef _UCW_FASTBUF_H
+#define _UCW_FASTBUF_H

 
 #ifndef EOF
 #include <stdio.h>
 #endif
 
 #include <string.h>
 
 #ifndef EOF
 #include <stdio.h>
 #endif
 
 #include <string.h>

+#include <alloca.h>

 
 #include "lib/unaligned.h"
 
 
 #include "lib/unaligned.h"
 


@@ -81,6 +82,7 @@ struct fastbuf {
 /* FastIO on standard files (specify buffer size 0 to enable mmaping) */
 
 struct fastbuf *bopen(byte *name, uns mode, uns buflen);
 /* 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);
 struct fastbuf *bopen_tmp(uns buflen);
 struct fastbuf *bfdopen(int fd, uns buflen);
 struct fastbuf *bfdopen_shared(int fd, uns buflen);


@@ -109,6 +111,32 @@ fbbuf_count_written(struct fastbuf *f)
   return f->bptr - f->bstop;
 }
 
   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);
 /* Configuring stream parameters */
 
 int bconfig(struct fastbuf *f, uns type, int data);


@@ -122,7 +150,6 @@ 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, 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);
 
 static inline sh_off_t btell(struct fastbuf *f)
 sh_off_t bfilesize(struct fastbuf *f);
 
 static inline sh_off_t btell(struct fastbuf *f)


@@ -156,11 +183,23 @@ static inline void bputc(struct fastbuf *f, uns c)
     bputc_slow(f, c);
 }
 
     bputc_slow(f, c);
 }
 

+static inline uns
+bavailr(struct fastbuf *f)
+{
+  return f->bstop - f->bptr;
+}
+
+static inline uns
+bavailw(struct fastbuf *f)
+{
+  return f->bufend - f->bptr;
+}
+

 int bgetw_slow(struct fastbuf *f);
 static inline int bgetw(struct fastbuf *f)
 {
   int w;
 int bgetw_slow(struct fastbuf *f);
 static inline int bgetw(struct fastbuf *f)
 {
   int w;

-  if (f->bptr + 2 <= f->bstop)
+  if (bavailr(f) >= 2)

     {
       w = GET_U16(f->bptr);
       f->bptr += 2;
     {
       w = GET_U16(f->bptr);
       f->bptr += 2;


@@ -174,7 +213,7 @@ u32 bgetl_slow(struct fastbuf *f);
 static inline u32 bgetl(struct fastbuf *f)
 {
   u32 l;
 static inline u32 bgetl(struct fastbuf *f)
 {
   u32 l;

-  if (f->bptr + 4 <= f->bstop)
+  if (bavailr(f) >= 4)

     {
       l = GET_U32(f->bptr);
       f->bptr += 4;
     {
       l = GET_U32(f->bptr);
       f->bptr += 4;


@@ -188,7 +227,7 @@ u64 bgetq_slow(struct fastbuf *f);
 static inline u64 bgetq(struct fastbuf *f)
 {
   u64 l;
 static inline u64 bgetq(struct fastbuf *f)
 {
   u64 l;

-  if (f->bptr + 8 <= f->bstop)
+  if (bavailr(f) >= 8)

     {
       l = GET_U64(f->bptr);
       f->bptr += 8;
     {
       l = GET_U64(f->bptr);
       f->bptr += 8;


@@ -202,7 +241,7 @@ u64 bget5_slow(struct fastbuf *f);
 static inline u64 bget5(struct fastbuf *f)
 {
   u64 l;
 static inline u64 bget5(struct fastbuf *f)
 {
   u64 l;

-  if (f->bptr + 5 <= f->bstop)
+  if (bavailr(f) >= 5)

     {
       l = GET_U40(f->bptr);
       f->bptr += 5;
     {
       l = GET_U40(f->bptr);
       f->bptr += 5;


@@ -215,7 +254,7 @@ static inline u64 bget5(struct fastbuf *f)
 void bputw_slow(struct fastbuf *f, uns w);
 static inline void bputw(struct fastbuf *f, uns w)
 {
 void bputw_slow(struct fastbuf *f, uns w);
 static inline void bputw(struct fastbuf *f, uns w)
 {

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

     {
       PUT_U16(f->bptr, w);
       f->bptr += 2;
     {
       PUT_U16(f->bptr, w);
       f->bptr += 2;


@@ -227,7 +266,7 @@ static inline void bputw(struct fastbuf *f, uns w)
 void bputl_slow(struct fastbuf *f, u32 l);
 static inline void bputl(struct fastbuf *f, u32 l)
 {
 void bputl_slow(struct fastbuf *f, u32 l);
 static inline void bputl(struct fastbuf *f, u32 l)
 {

-  if (f->bptr + 4 <= f->bufend)
+  if (bavailw(f) >= 4)

     {
       PUT_U32(f->bptr, l);
       f->bptr += 4;
     {
       PUT_U32(f->bptr, l);
       f->bptr += 4;


@@ -239,7 +278,7 @@ static inline void bputl(struct fastbuf *f, u32 l)
 void bputq_slow(struct fastbuf *f, u64 l);
 static inline void bputq(struct fastbuf *f, u64 l)
 {
 void bputq_slow(struct fastbuf *f, u64 l);
 static inline void bputq(struct fastbuf *f, u64 l)
 {

-  if (f->bptr + 8 <= f->bufend)
+  if (bavailw(f) >= 8)

     {
       PUT_U64(f->bptr, l);
       f->bptr += 8;
     {
       PUT_U64(f->bptr, l);
       f->bptr += 8;


@@ -251,7 +290,7 @@ static inline void bputq(struct fastbuf *f, u64 l)
 void bput5_slow(struct fastbuf *f, u64 l);
 static inline void bput5(struct fastbuf *f, u64 l)
 {
 void bput5_slow(struct fastbuf *f, u64 l);
 static inline void bput5(struct fastbuf *f, u64 l)
 {

-  if (f->bptr + 5 <= f->bufend)
+  if (bavailw(f) >= 5)

     {
       PUT_U40(f->bptr, l);
       f->bptr += 5;
     {
       PUT_U40(f->bptr, l);
       f->bptr += 5;


@@ -263,7 +302,7 @@ static inline void bput5(struct fastbuf *f, u64 l)
 uns bread_slow(struct fastbuf *f, void *b, uns l, uns check);
 static inline uns bread(struct fastbuf *f, void *b, uns 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)
+  if (bavailr(f) >= l)

     {
       memcpy(b, f->bptr, l);
       f->bptr += l;
     {
       memcpy(b, f->bptr, l);
       f->bptr += l;


@@ -275,7 +314,7 @@ static inline uns bread(struct fastbuf *f, void *b, uns l)
 
 static inline uns breadb(struct fastbuf *f, void *b, uns 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;
     {
       memcpy(b, f->bptr, l);
       f->bptr += l;


@@ -288,7 +327,7 @@ static inline uns breadb(struct fastbuf *f, void *b, uns l)
 void bwrite_slow(struct fastbuf *f, void *b, uns l);
 static inline void bwrite(struct fastbuf *f, void *b, uns 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;
     {
       memcpy(f->bptr, b, l);
       f->bptr += l;


@@ -301,6 +340,20 @@ 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);
 
 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
 bputs(struct fastbuf *f, byte *b)
 {


@@ -324,8 +377,7 @@ void bbcopy_slow(struct fastbuf *f, struct fastbuf *t, uns l);
 static inline void
 bbcopy(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)
+  if (bavailr(f) >= l && bavailw(t) >= l)

     {
       memcpy(t->bptr, f->bptr, l);
       t->bptr += l;
     {
       memcpy(t->bptr, f->bptr, l);
       t->bptr += l;


@@ -335,6 +387,18 @@ bbcopy(struct fastbuf *f, struct fastbuf *t, uns l)
     bbcopy_slow(f, t, l);
 }
 
     bbcopy_slow(f, t, l);
 }
 

+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);
+}
+

 /* I/O on addr_int_t */
 
 #ifdef CPU_64BIT_POINTERS
 /* I/O on addr_int_t */
 
 #ifdef CPU_64BIT_POINTERS


@@ -351,9 +415,12 @@ static inline uns
 bdirect_read_prepare(struct fastbuf *f, byte **buf)
 {
   if (f->bptr == f->bstop && !f->refill(f))
 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;
   *buf = f->bptr;

-  return f->bstop - f->bptr;
+  return bavailr(f);

 }
 
 static inline void
 }
 
 static inline void


@@ -375,7 +442,7 @@ bdirect_write_prepare(struct fastbuf *f, byte **buf)
   if (f->bptr == f->bufend)
     f->spout(f);
   *buf = f->bptr;
   if (f->bptr == f->bufend)
     f->spout(f);
   *buf = f->bptr;

-  return f->bufend - f->bptr;
+  return bavailw(f);

 }
 
 static inline void
 }
 
 static inline void


@@ -386,7 +453,7 @@ bdirect_write_commit(struct fastbuf *f, byte *pos)
 
 /* Formatted output */
 
 
 /* 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
 
 #endif