lib/fb-mmap.c

   1 /*
   2  *      Sherlock Library -- Fast Buffered I/O on Memory-Mapped Files
   3  *
   4  *      (c) 2002 Martin Mares <mj@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #include "lib/lib.h"
  11 #include "lib/fastbuf.h"
  12 #include "lib/lfs.h"
  13 #include "lib/conf.h"
  14
  15 #include <stdlib.h>
  16 #include <string.h>
  17 #include <fcntl.h>
  18 #include <unistd.h>
  19 #include <sys/mman.h>
  20 #include <sys/user.h>
  21
  22 static uns mmap_window_size = 16*PAGE_SIZE;
  23 static uns mmap_extend_size = 4*PAGE_SIZE;
  24
  25 static struct cfitem fbmm_config[] = {
  26   { "FBMMap",           CT_SECTION,     NULL },
  27   { "WindowSize",       CT_INT,         &mmap_window_size },
  28   { "ExtendSize",       CT_INT,         &mmap_extend_size },
  29   { NULL,               CT_STOP,        NULL }
  30 };
  31
  32 static void CONSTRUCTOR fbmm_init_config(void)
  33 {
  34   cf_register(fbmm_config);
  35 }
  36
  37 struct fb_mmap {
  38   struct fastbuf fb;
  39   int fd;
  40   int is_temp_file;
  41   sh_off_t file_size;
  42   sh_off_t file_extend;
  43   sh_off_t window_pos;
  44   int mode;
  45 };
  46 #define FB_MMAP(f) ((struct fb_mmap *)(f)->is_fastbuf)
  47
  48 static void
  49 bfmm_map_window(struct fastbuf *f)
  50 {
  51   struct fb_mmap *F = FB_MMAP(f);
  52   sh_off_t pos0 = f->pos & ~(sh_off_t)(PAGE_SIZE-1);
  53   int l = MIN((sh_off_t)mmap_window_size, F->file_extend - pos0);
  54   uns ll = ALIGN(l, PAGE_SIZE);
  55   uns oll = ALIGN(f->bufend - f->buffer, PAGE_SIZE);
  56   int prot = ((F->mode & O_ACCMODE) == O_RDONLY) ? PROT_READ : (PROT_READ | PROT_WRITE);
  57
  58   DBG(" ... Mapping %x(%x)+%x(%x) len=%x extend=%x", (int)pos0, (int)f->pos, ll, l, (int)F->file_size, (int)F->file_extend);
  59   if (ll != oll && f->buffer)
  60     {
  61       munmap(f->buffer, oll);
  62       f->buffer = NULL;
  63     }
  64   if (!f->buffer)
  65     f->buffer = sh_mmap(NULL, ll, prot, MAP_SHARED, F->fd, pos0);
  66   else
  67     f->buffer = sh_mmap(f->buffer, ll, prot, MAP_SHARED | MAP_FIXED, F->fd, pos0);
  68   if (f->buffer == (byte *) MAP_FAILED)
  69     die("mmap(%s): %m", f->name);
  70 #ifdef MADV_SEQUENTIAL
  71   if (ll > PAGE_SIZE)
  72     madvise(f->buffer, ll, MADV_SEQUENTIAL);
  73 #endif
  74   f->bufend = f->buffer + l;
  75   f->bptr = f->buffer + (f->pos - pos0);
  76   F->window_pos = pos0;
  77 }
  78
  79 static int
  80 bfmm_refill(struct fastbuf *f)
  81 {
  82   struct fb_mmap *F = FB_MMAP(f);
  83
  84   DBG("Refill <- %p %p %p %p", f->buffer, f->bptr, f->bstop, f->bufend);
  85   if (f->pos >= F->file_size)
  86     return 0;
  87   if (f->bstop >= f->bufend)
  88     bfmm_map_window(f);
  89   if (F->window_pos + (f->bufend - f->buffer) > F->file_size)
  90     f->bstop = f->buffer + (F->file_size - F->window_pos);
  91   else
  92     f->bstop = f->bufend;
  93   f->pos = F->window_pos + (f->bstop - f->buffer);
  94   DBG(" -> %p %p %p(%x) %p", f->buffer, f->bptr, f->bstop, (int)f->pos, f->bufend);
  95   return 1;
  96 }
  97
  98 static void
  99 bfmm_spout(struct fastbuf *f)
 100 {
 101   struct fb_mmap *F = FB_MMAP(f);
 102   sh_off_t end = f->pos + (f->bptr - f->bstop);
 103
 104   DBG("Spout <- %p %p %p %p", f->buffer, f->bptr, f->bstop, f->bufend);
 105   if (end > F->file_size)
 106     F->file_size = end;
 107   if (f->bptr < f->bufend)
 108     return;
 109   f->pos = end;
 110   if (f->pos >= F->file_extend)
 111     {
 112       F->file_extend = ALIGN(F->file_extend + mmap_extend_size, (sh_off_t)PAGE_SIZE);
 113       if (sh_ftruncate(F->fd, F->file_extend))
 114         die("ftruncate(%s): %m", f->name);
 115     }
 116   bfmm_map_window(f);
 117   f->bstop = f->bptr;
 118   DBG(" -> %p %p %p(%x) %p", f->buffer, f->bptr, f->bstop, (int)f->pos, f->bufend);
 119 }
 120
 121 static void
 122 bfmm_seek(struct fastbuf *f, sh_off_t pos, int whence)
 123 {
 124   if (whence == SEEK_END)
 125     pos += FB_MMAP(f)->file_size;
 126   else
 127     ASSERT(whence == SEEK_SET);
 128   ASSERT(pos >= 0 && pos <= FB_MMAP(f)->file_size);
 129   f->pos = pos;
 130   f->bptr = f->bstop = f->bufend;       /* force refill/spout call */
 131   DBG("Seek -> %p %p %p(%x) %p", f->buffer, f->bptr, f->bstop, (int)f->pos, f->bufend);
 132 }
 133
 134 static void
 135 bfmm_close(struct fastbuf *f)
 136 {
 137   struct fb_mmap *F = FB_MMAP(f);
 138
 139   if (f->buffer)
 140     munmap(f->buffer, ALIGN(f->bufend-f->buffer, PAGE_SIZE));
 141   if (F->file_extend > F->file_size &&
 142       sh_ftruncate(F->fd, F->file_size))
 143     die("ftruncate(%s): %m", f->name);
 144   switch (F->is_temp_file)
 145     {
 146     case 1:
 147       if (unlink(f->name) < 0)
 148         log(L_ERROR, "unlink(%s): %m", f->name);
 149     case 0:
 150       close(F->fd);
 151     }
 152   xfree(f);
 153 }
 154
 155 static int
 156 bfmm_config(struct fastbuf *f, uns item, int value)
 157 {
 158   switch (item)
 159     {
 160     case BCONFIG_IS_TEMP_FILE:
 161       FB_MMAP(f)->is_temp_file = value;
 162       return 0;
 163     case BCONFIG_CAN_OVERWRITE:
 164       return 0;                         /* cannot use 1, because the pages would become dirty */
 165     default:
 166       return -1;
 167     }
 168 }
 169
 170 static struct fastbuf *
 171 bfmmopen_internal(int fd, byte *name, uns mode)
 172 {
 173   int namelen = strlen(name) + 1;
 174   struct fb_mmap *F = xmalloc(sizeof(struct fb_mmap) + namelen);
 175   struct fastbuf *f = &F->fb;
 176
 177   bzero(F, sizeof(*F));
 178   f->name = (byte *)(F+1);
 179   memcpy(f->name, name, namelen);
 180   F->fd = fd;
 181   F->file_extend = F->file_size = sh_seek(fd, 0, SEEK_END);
 182   if (mode & O_APPEND)
 183     f->pos = F->file_size;
 184   F->mode = mode;
 185
 186   f->refill = bfmm_refill;
 187   f->spout = bfmm_spout;
 188   f->seek = bfmm_seek;
 189   f->close = bfmm_close;
 190   f->config = bfmm_config;
 191   return f;
 192 }
 193
 194 struct fastbuf *
 195 bopen_mm(byte *name, uns mode)
 196 {
 197   int fd;
 198
 199   if ((mode & O_ACCMODE) == O_WRONLY)
 200     mode = (mode & ~O_ACCMODE) | O_RDWR;
 201   fd = sh_open(name, mode, 0666);
 202   if (fd < 0)
 203     die("Unable to %s file %s: %m",
 204         (mode & O_CREAT) ? "create" : "open", name);
 205   return bfmmopen_internal(fd, name, mode);
 206 }
 207
 208 #ifdef TEST
 209
 210 int main(int argc, char **argv)
 211 {
 212   struct fastbuf *f = bopen_mm(argv[1], O_RDONLY);
 213   struct fastbuf *g = bopen_mm(argv[2], O_RDWR | O_CREAT | O_TRUNC);
 214   int c;
 215
 216   DBG("Copying");
 217   while ((c = bgetc(f)) >= 0)
 218     bputc(g, c);
 219   bclose(f);
 220   DBG("Seek inside last block");
 221   bsetpos(g, btell(g)-1333);
 222   bputc(g, 13);
 223   DBG("Seek to the beginning & write");
 224   bsetpos(g, 1333);
 225   bputc(g, 13);
 226   DBG("flush");
 227   bflush(g);
 228   bputc(g, 13);
 229   bflush(g);
 230   DBG("Seek nearby & read");
 231   bsetpos(g, 133);
 232   bgetc(g);
 233   DBG("Seek far & read");
 234   bsetpos(g, 133333);
 235   bgetc(g);
 236   DBG("Closing");
 237   bclose(g);
 238
 239   return 0;
 240 }
 241
 242 #endif