Added the local copy of the regex library back.

[libucw.git] / lib / fastbuf.h

diff --git a/lib/fastbuf.h b/lib/fastbuf.h
index 70e95336fb6d27b38ffd85d678e6baccecd760ea..920d83ebd2a3728e0d215dfeaf85a0dacf0a86ef 100644 (file)
--- a/lib/fastbuf.h
+++ b/lib/fastbuf.h
@@ -63,7 +63,7 @@ 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 */
+  char *name;                          /* File name for error messages */
   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 */
@@ -73,21 +73,19 @@ struct fastbuf {
   int can_overwrite_buffer;            /* Can the buffer be altered? (see discussion above) 0=never, 1=temporarily, 2=permanently */
 };
 
-/* FastIO on files with run-time parametrization */
+/* FastIO on files with several configurable back-ends */
 
 enum fb_type {                         /* Which back-end you want to use */
   FB_STD,                              /* Standard buffered I/O */
-  FB_DIRECT,                           /* Direct I/O bypassing system caches (see fb-direct.c for description) */
+  FB_DIRECT,                           /* Direct I/O bypassing system caches (see fb-direct.c for a description) */
   FB_MMAP                              /* Memory mapped files */
 };
 
 struct fb_params {
   enum fb_type type;
-  uns buffer_size;
-  /* FB_STD only */
-  uns keep_back_buf;
-  /* FB_DIRECT only */
-  uns read_ahead;                      
+  uns buffer_size;                     /* 0 for default size */
+  uns keep_back_buf;                   /* FB_STD: optimize for bi-directional access */
+  uns read_ahead;                      /* FB_DIRECT options */
   uns write_back;
   struct asio_queue *asio;
 };
@@ -96,35 +94,40 @@ struct cf_section;
 extern struct cf_section fbpar_cf;
 extern struct fb_params fbpar_def;
 
-struct fastbuf *bopen_file(const byte *name, int mode, struct fb_params *params);      /* Use params==NULL for defaults */
-struct fastbuf *bopen_file_try(const byte *name, int mode, struct fb_params *params);
+struct fastbuf *bopen_file(const char *name, int mode, struct fb_params *params);      /* Use params==NULL for defaults */
+struct fastbuf *bopen_file_try(const char *name, int mode, struct fb_params *params);
 struct fastbuf *bopen_tmp_file(struct fb_params *params);
 struct fastbuf *bopen_fd(int fd, struct fb_params *params);
 
-/* FastIO on standard files (specify buffer size 0 to enable mmaping) */
+/* FastIO on standard files (shortcuts for FB_STD) */
 
-struct fastbuf *bfdopen_internal(int fd, const byte *name, uns buflen);
-struct fastbuf *bopen(const byte *name, uns mode, uns buflen);
-struct fastbuf *bopen_try(const byte *name, uns mode, uns buflen);
+struct fastbuf *bopen(const char *name, uns mode, uns buflen);
+struct fastbuf *bopen_try(const char *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);
 
+/* Temporary files */
+
 #define TEMP_FILE_NAME_LEN 256
-void temp_file_name(byte *name);
+void temp_file_name(char *name);
+void bfix_tmp_file(struct fastbuf *fb, const char *name);
 
 /* Internal functions of some file back-ends */
 
-struct fastbuf *bfmmopen_internal(int fd, const byte *name, uns mode);
+struct fastbuf *bfdopen_internal(int fd, const char *name, uns buflen);
+struct fastbuf *bfmmopen_internal(int fd, const char *name, uns mode);
 
 extern uns fbdir_cheat;
 struct asio_queue;
-struct fastbuf *fbdir_open_fd_internal(int fd, const byte *name, struct asio_queue *io_queue, uns buffer_size, uns read_ahead, uns write_back);
+struct fastbuf *fbdir_open_fd_internal(int fd, const char *name, struct asio_queue *io_queue, uns buffer_size, uns read_ahead, uns write_back);
+
+void bclose_file_helper(struct fastbuf *f, int fd, int is_temp_file);
 
 /* FastIO on in-memory streams */
 
-struct fastbuf *fbmem_create(unsigned blocksize);      /* Create stream and return its writing fastbuf */
+struct fastbuf *fbmem_create(uns blocksize);           /* Create stream and return its writing fastbuf */
 struct fastbuf *fbmem_clone_read(struct fastbuf *);    /* Create reading fastbuf */
 
 /* FastI on file descriptors with limit */
@@ -171,7 +174,7 @@ struct fb_atomic {
 };
 #define FB_ATOMIC(f) ((struct fb_atomic *)(f)->is_fastbuf)
 
-struct fastbuf *fbatomic_open(const byte *name, struct fastbuf *master, uns bufsize, int record_len);
+struct fastbuf *fbatomic_open(const char *name, struct fastbuf *master, uns bufsize, int record_len);
 void fbatomic_internal_write(struct fastbuf *b);
 
 static inline void
@@ -184,8 +187,8 @@ fbatomic_commit(struct fastbuf *b)
 /* Configuring stream parameters */
 
 enum bconfig_type {
-  BCONFIG_IS_TEMP_FILE,
-  BCONFIG_KEEP_BACK_BUF,
+  BCONFIG_IS_TEMP_FILE,                        /* 0=normal file, 1=temporary file, 2=shared fd */
+  BCONFIG_KEEP_BACK_BUF,               /* Optimize for bi-directional access */
 };
 
 int bconfig(struct fastbuf *f, uns type, int data);
@@ -197,7 +200,7 @@ 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);
-sh_off_t bfilesize(struct fastbuf *f);         // -1 if not seekable
+sh_off_t bfilesize(struct fastbuf *f);         /* -1 if not seekable */
 
 static inline sh_off_t btell(struct fastbuf *f)
 {
@@ -294,14 +297,14 @@ static inline void bwrite(struct fastbuf *f, const void *b, uns l)
  *     bgets_stk()     the same, but on the stack by alloca()
  */
 
-byte *bgets(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);
+char *bgets(struct fastbuf *f, char *b, uns l);
+char *bgets0(struct fastbuf *f, char *b, uns l);
+int bgets_nodie(struct fastbuf *f, char *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);
+char *bgets_mp(struct fastbuf *f, struct mempool *mp);
 
 struct bgets_stk_struct {
   struct fastbuf *f;
@@ -313,19 +316,19 @@ 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, const byte *b)
+bputs(struct fastbuf *f, const char *b)
 {
   bwrite(f, b, strlen(b));
 }
 
 static inline void
-bputs0(struct fastbuf *f, const byte *b)
+bputs0(struct fastbuf *f, const char *b)
 {
   bwrite(f, b, strlen(b)+1);
 }
 
 static inline void
-bputsn(struct fastbuf *f, const byte *b)
+bputsn(struct fastbuf *f, const char *b)
 {
   bputs(f, b);
   bputc(f, '\n');