]> git.pond.sub.org Git - empserver/blobdiff - src/lib/common/file.c
License upgrade to GPL version 3 or later
[empserver] / src / lib / common / file.c
index 81b0b97d8e2987f06712b3b148bc259bbee2cf0b..804f8b28b429453a1163598e656b372766fe297b 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
- *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1986-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                Ken Stevens, Steve McClure, Markus Armbruster
  *
- *  This program is free software; you can redistribute it and/or modify
+ *  Empire is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
+ *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
  *
  *  This program is distributed in the hope that it will be useful,
@@ -14,8 +14,7 @@
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  *  ---
  *
  *  ---
  *
  *  file.c: Operations on Empire tables (`files' for historical reasons)
- * 
+ *
  *  Known contributors to this file:
  *     Dave Pare, 1989
  *     Steve McClure, 2000
- *     Markus Armbruster, 2005-2008
+ *     Markus Armbruster, 2005-2009
  */
 
 #include <config.h>
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <unistd.h>
+#ifdef _WIN32
+#include <io.h>
+#include <share.h>
+#endif
 #include "file.h"
 #include "match.h"
 #include "misc.h"
 #include "nsc.h"
 #include "prototypes.h"
 
+static int open_locked(char *, int, mode_t);
 static int ef_realloc_cache(struct empfile *, int);
 static int fillcache(struct empfile *, int);
 static int do_read(struct empfile *, void *, int, int);
 static int do_write(struct empfile *, void *, int, int);
 static unsigned get_seqno(struct empfile *, int);
 static void new_seqno(struct empfile *, void *);
+static void must_be_fresh(struct empfile *, void *);
 static void do_blank(struct empfile *, void *, int, int);
 static int ef_check(int);
 
+static unsigned ef_generation;
+
 /*
  * Open the file-backed table TYPE (EF_SECTOR, ...).
  * HOW are flags to control operation.  Naturally, immutable flags are
@@ -67,7 +74,6 @@ int
 ef_open(int type, int how, int nelt)
 {
     struct empfile *ep;
-    struct flock lock;
     int oflags, fd, fsiz, nslots;
 
     if (ef_check(type) < 0)
@@ -84,23 +90,12 @@ ef_open(int type, int how, int nelt)
        oflags = O_RDONLY;
     if (how & EFF_CREATE)
        oflags |= O_CREAT | O_TRUNC;
-#if defined(_WIN32)
-    oflags |= O_BINARY;
-#endif
-    if ((fd = open(ep->file, oflags, S_IRWUG)) < 0) {
+    fd = open_locked(ep->file, oflags, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
+    if (fd < 0) {
        logerror("Can't open %s (%s)", ep->file, strerror(errno));
        return 0;
     }
 
-    lock.l_type = how & EFF_PRIVATE ? F_RDLCK : F_WRLCK;
-    lock.l_whence = SEEK_SET;
-    lock.l_start = lock.l_len = 0;
-    if (fcntl(fd, F_SETLK, &lock) == -1) {
-       logerror("Can't lock %s (%s)", ep->file, strerror(errno));
-       close(fd);
-       return 0;
-    }
-
     /* get file size */
     fsiz = fsize(fd);
     if (fsiz % ep->size) {
@@ -156,9 +151,40 @@ ef_open(int type, int how, int nelt)
        }
     }
 
+    if (ep->onresize && ep->onresize(type) < 0)
+       return 0;
     return 1;
 }
 
+static int
+open_locked(char *name, int oflags, mode_t mode)
+{
+    int rdlonly = (oflags & O_ACCMODE) == O_RDONLY;
+    int fd;
+
+#ifdef _WIN32
+    fd = _sopen(name, oflags | O_BINARY, rdlonly ? SH_DENYNO : SH_DENYWR,
+               mode);
+    if (fd < 0)
+       return -1;
+#else  /* !_WIN32 */
+    struct flock lock;
+
+    fd = open(name, oflags, mode);
+    if (fd < 0)
+       return -1;
+
+    lock.l_type = rdlonly ? F_RDLCK : F_WRLCK;
+    lock.l_whence = SEEK_SET;
+    lock.l_start = lock.l_len = 0;
+    if (fcntl(fd, F_SETLK, &lock) == -1) {
+       close(fd);
+       return -1;
+    }
+#endif /* !_WIN32 */
+    return fd;
+}
+
 /*
  * Reallocate cache for table EP to hold COUNT slots.
  * The table must not be allocated statically.
@@ -193,6 +219,32 @@ ef_realloc_cache(struct empfile *ep, int count)
     return 1;
 }
 
+/*
+ * Open the table TYPE as view of table BASE.
+ * Return non-zero on success, zero on failure.
+ * Beware: views work only as long as BASE doesn't change size!
+ * You must call ef_close(TYPE) before closing BASE.
+ */
+int
+ef_open_view(int type, int base)
+{
+    struct empfile *ep;
+
+    if (CANT_HAPPEN(!EF_IS_VIEW(type)))
+       return -1;
+    ep = &empfile[type];
+    if (CANT_HAPPEN(!(ef_flags(base) & EFF_MEM)))
+       return -1;
+
+    ep->cache = empfile[base].cache;
+    ep->csize = empfile[base].csize;
+    ep->flags |= EFF_MEM;
+    ep->baseid = empfile[base].baseid;
+    ep->cids = empfile[base].cids;
+    ep->fids = empfile[base].fids;
+    return 0;
+}
+
 /*
  * Close the file-backed table TYPE (EF_SECTOR, ...).
  * Return non-zero on success, zero on failure.
@@ -201,25 +253,36 @@ int
 ef_close(int type)
 {
     struct empfile *ep;
-    int retval;
+    int retval = 1;
 
-    retval = ef_flush(type);
+    if (ef_check(type) < 0)
+       return 0;
     ep = &empfile[type];
-    ep->flags &= EFF_IMMUTABLE;
-    if (!(ep->flags & EFF_STATIC)) {
-       free(ep->cache);
+
+    if (EF_IS_VIEW(type))
        ep->cache = NULL;
+    else {
+       if (!ef_flush(type))
+           retval = 0;
+       ep->flags &= EFF_IMMUTABLE;
+       if (!(ep->flags & EFF_STATIC)) {
+           free(ep->cache);
+           ep->cache = NULL;
+       }
+       if (close(ep->fd) < 0) {
+           logerror("Error closing %s (%s)", ep->file, strerror(errno));
+           retval = 0;
+       }
+       ep->fd = -1;
     }
-    if (close(ep->fd) < 0) {
-       logerror("Error closing %s (%s)", ep->file, strerror(errno));
+    ep->baseid = ep->cids = ep->fids = 0;
+    if (ep->onresize && ep->onresize(type) < 0)
        retval = 0;
-    }
-    ep->fd = -1;
     return retval;
 }
 
 /*
- * Flush table TYPE (EF_SECTOR, ...) to disk.
+ * Flush file-backed table TYPE (EF_SECTOR, ...) to its backing file.
  * Do nothing if the table is privately mapped.
  * Update timestamps of written elements if table is EFF_TYPED.
  * Return non-zero on success, zero on failure.
@@ -279,7 +342,7 @@ int
 ef_read(int type, int id, void *into)
 {
     struct empfile *ep;
-    void *from;
+    void *cachep;
 
     if (ef_check(type) < 0)
        return 0;
@@ -290,15 +353,16 @@ ef_read(int type, int id, void *into)
        return 0;
 
     if (ep->flags & EFF_MEM) {
-       from = ep->cache + id * ep->size;
+       cachep = ep->cache + id * ep->size;
     } else {
        if (ep->baseid + ep->cids <= id || ep->baseid > id) {
            if (fillcache(ep, id) < 1)
                return 0;
        }
-       from = ep->cache + (id - ep->baseid) * ep->size;
+       cachep = ep->cache + (id - ep->baseid) * ep->size;
     }
-    memcpy(into, from, ep->size);
+    memcpy(into, cachep, ep->size);
+    ef_mark_fresh(type, into);
 
     if (ep->postread)
        ep->postread(id, into);
@@ -445,32 +509,36 @@ int
 ef_write(int type, int id, void *from)
 {
     struct empfile *ep;
-    char *to;
+    char *cachep;
 
     if (ef_check(type) < 0)
        return 0;
     ep = &empfile[type];
     if (CANT_HAPPEN((ep->flags & (EFF_MEM | EFF_PRIVATE)) == EFF_PRIVATE))
        return 0;
-    if (ep->prewrite)
-       ep->prewrite(id, from);
     if (CANT_HAPPEN((ep->flags & EFF_MEM) ? id >= ep->fids : id > ep->fids))
        return 0;               /* not implemented */
     new_seqno(ep, from);
-    if (ep->fd >= 0) {
-       if (do_write(ep, from, id, 1) < 0)
-           return 0;
-    }
-    if (id >= ep->baseid && id < ep->baseid + ep->cids) {
-       /* update the cache if necessary */
-       to = ep->cache + (id - ep->baseid) * ep->size;
-       if (to != from)
-           memcpy(to, from, ep->size);
-    }
     if (id >= ep->fids) {
        /* write beyond end of file extends it, take note */
        ep->fids = id + 1;
+       if (ep->onresize && ep->onresize(type) < 0)
+           return 0;
     }
+    if (id >= ep->baseid && id < ep->baseid + ep->cids) {
+       cachep = ep->cache + (id - ep->baseid) * ep->size;
+       if (cachep != from)
+           must_be_fresh(ep, from);
+    } else
+       cachep = NULL;
+    if (ep->prewrite)
+       ep->prewrite(id, cachep, from);
+    if (ep->fd >= 0) {
+       if (do_write(ep, from, id, 1) < 0)
+           return 0;
+    }
+    if (cachep && cachep != from)      /* update the cache if necessary */
+       memcpy(cachep, from, ep->size);
     return 1;
 }
 
@@ -540,11 +608,39 @@ new_seqno(struct empfile *ep, void *buf)
     if (!(ep->flags & EFF_TYPED))
        return;
     old_seqno = get_seqno(ep, elt->uid);
-    if (CANT_HAPPEN(old_seqno != elt->seqno))
-       old_seqno = MAX(old_seqno, elt->seqno);
+    CANT_HAPPEN(old_seqno != elt->seqno);
     elt->seqno = old_seqno + 1;
 }
 
+void
+ef_make_stale(void)
+{
+    ef_generation++;
+}
+
+void
+ef_mark_fresh(int type, void *buf)
+{
+    struct empfile *ep;
+
+    if (ef_check(type) < 0)
+       return;
+    ep = &empfile[type];
+    if (!(ep->flags & EFF_TYPED))
+       return;
+    ((struct emptypedstr *)buf)->generation = ef_generation;
+}
+
+static void
+must_be_fresh(struct empfile *ep, void *buf)
+{
+    struct emptypedstr *elt = buf;
+
+    if (!(ep->flags & EFF_TYPED))
+       return;
+    CANT_HAPPEN(elt->generation != (ef_generation & 0xfff));
+}
+
 /*
  * Extend table TYPE by COUNT elements.
  * Any pointers obtained from ef_ptr() become invalid.
@@ -557,7 +653,7 @@ ef_extend(int type, int count)
     char *p;
     int need_sentinel, i, id;
 
-    if (ef_check(type) < 0)
+    if (ef_check(type) < 0 || CANT_HAPPEN(EF_IS_VIEW(type)))
        return 0;
     ep = &empfile[type];
     if (CANT_HAPPEN(count < 0))
@@ -599,6 +695,8 @@ ef_extend(int type, int count)
        }
     }
     ep->fids = id + count;
+    if (ep->onresize && ep->onresize(type) < 0)
+       return 0;
     return 1;
 }
 
@@ -620,6 +718,7 @@ ef_blank(int type, int id, void *buf)
        elt = buf;
        elt->seqno = get_seqno(ep, elt->uid);
     }
+    ef_mark_fresh(type, buf);
 }
 
 /*
@@ -632,12 +731,14 @@ do_blank(struct empfile *ep, void *buf, int id, int count)
     struct emptypedstr *elt;
 
     memset(buf, 0, count * ep->size);
-    if (ep->flags & EFF_TYPED) {
-       for (i = 0; i < count; i++) {
-           elt = (struct emptypedstr *)((char *)buf + i * ep->size);
+    for (i = 0; i < count; i++) {
+       elt = (struct emptypedstr *)((char *)buf + i * ep->size);
+       if (ep->flags & EFF_TYPED) {
            elt->ef_type = ep->uid;
            elt->uid = id + i;
        }
+       if (ep->oninit)
+           ep->oninit(elt);
     }
 }
 
@@ -652,7 +753,7 @@ ef_truncate(int type, int count)
     struct empfile *ep;
     int need_sentinel;
 
-    if (ef_check(type) < 0)
+    if (ef_check(type) < 0 || CANT_HAPPEN(EF_IS_VIEW(type)))
        return 0;
     ep = &empfile[type];
     if (CANT_HAPPEN(count < 0 || count > ep->fids))
@@ -686,6 +787,8 @@ ef_truncate(int type, int count)
            ep->cids = count - ep->baseid;
     }
 
+    if (ep->onresize && ep->onresize(type) < 0)
+       return 0;
     return 1;
 }