]> git.pond.sub.org Git - empserver/blobdiff - src/lib/common/file.c
Simplify how ef_write() handles write beyond end of file
[empserver] / src / lib / common / file.c
index b59e1ab529ca01e12ae44f36e35d2ebf3d9a93db..a200fca27bbc2e464e3920f5e2f59342b62c7f30 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2009, 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/>.
  *
  *  ---
  *
@@ -30,7 +29,7 @@
  *  Known contributors to this file:
  *     Dave Pare, 1989
  *     Steve McClure, 2000
- *     Markus Armbruster, 2005-2009
+ *     Markus Armbruster, 2005-2011
  */
 
 #include <config.h>
@@ -75,7 +74,7 @@ int
 ef_open(int type, int how, int nelt)
 {
     struct empfile *ep;
-    int oflags, fd, fsiz, nslots;
+    int oflags, fd, fsiz, fids, nslots;
 
     if (ef_check(type) < 0)
        return 0;
@@ -105,10 +104,10 @@ ef_open(int type, int how, int nelt)
        close(fd);
        return 0;
     }
-    ep->fids = fsiz / ep->size;
-    if (nelt >= 0 && nelt != ep->fids) {
+    fids = fsiz / ep->size;
+    if (nelt >= 0 && nelt != fids) {
        logerror("Can't open %s (got %d records instead of %d)",
-                ep->file, ep->fids, nelt);
+                ep->file, fids, nelt);
        close(fd);
        return 0;
     }
@@ -117,9 +116,9 @@ ef_open(int type, int how, int nelt)
     if (ep->flags & EFF_STATIC) {
        /* ep->cache already points to space for ep->csize elements */
        if (how & EFF_MEM) {
-           if (ep->fids > ep->csize) {
-               logerror("Can't open %s: file larger than %d bytes",
-                        ep->file, ep->fids * ep->size);
+           if (fids > ep->csize) {
+               logerror("Can't open %s (file larger than %d records)",
+                        ep->file, ep->csize);
                close(fd);
                return 0;
            }
@@ -128,7 +127,7 @@ ef_open(int type, int how, int nelt)
        if (CANT_HAPPEN(ep->cache))
            free(ep->cache);
        if (how & EFF_MEM)
-           nslots = ep->fids;
+           nslots = fids;
        else
            nslots = blksize(fd) / ep->size;
        if (!ef_realloc_cache(ep, nslots)) {
@@ -139,21 +138,21 @@ ef_open(int type, int how, int nelt)
     }
     ep->baseid = 0;
     ep->cids = 0;
+    ep->fids = fids;
     ep->flags = (ep->flags & EFF_IMMUTABLE) | (how & ~EFF_CREATE);
     ep->fd = fd;
 
     /* map file into cache */
-    if ((how & EFF_MEM) && ep->fids) {
-       if (fillcache(ep, 0) != ep->fids) {
+    if ((how & EFF_MEM) && fids) {
+       if (fillcache(ep, 0) != fids) {
            ep->cids = 0;       /* prevent cache flush */
-           ep->flags &= EFF_IMMUTABLE; /* maintain invariant */
            ef_close(type);
            return 0;
        }
     }
 
-    if (ep->onresize && ep->onresize(type) < 0)
-       return 0;
+    if (ep->onresize)
+       ep->onresize(type);
     return 1;
 }
 
@@ -247,7 +246,7 @@ ef_open_view(int type, int base)
 }
 
 /*
- * Close the file-backed table TYPE (EF_SECTOR, ...).
+ * Close the open table TYPE (EF_SECTOR, ...).
  * Return non-zero on success, zero on failure.
  */
 int
@@ -260,15 +259,16 @@ ef_close(int type)
        return 0;
     ep = &empfile[type];
 
-    if (EF_IS_VIEW(type))
+    if (EF_IS_VIEW(type)) {
        ep->cache = NULL;
-    else {
+       ep->csize = 0;
+    } else {
        if (!ef_flush(type))
            retval = 0;
-       ep->flags &= EFF_IMMUTABLE;
        if (!(ep->flags & EFF_STATIC)) {
            free(ep->cache);
            ep->cache = NULL;
+           ep->csize = 0;
        }
        if (close(ep->fd) < 0) {
            logerror("Error closing %s (%s)", ep->file, strerror(errno));
@@ -276,9 +276,10 @@ ef_close(int type)
        }
        ep->fd = -1;
     }
+    ep->flags &= EFF_IMMUTABLE;
     ep->baseid = ep->cids = ep->fids = 0;
-    if (ep->onresize && ep->onresize(type) < 0)
-       retval = 0;
+    if (ep->onresize)
+       ep->onresize(type);
     return retval;
 }
 
@@ -337,6 +338,7 @@ ef_ptr(int type, int id)
 /*
  * Read element ID from table TYPE into buffer INTO.
  * FIXME pass buffer size!
+ * INTO is marked fresh with ef_mark_fresh().
  * Return non-zero on success, zero on failure.
  */
 int
@@ -504,6 +506,7 @@ do_write(struct empfile *ep, void *buf, int id, int count)
  * cache straight to disk.
  * Cannot write beyond the end of fully cached table (flags & EFF_MEM).
  * Can write at the end of partially cached table.
+ * FROM must be fresh; see ef_make_stale().
  * Return non-zero on success, zero on failure.
  */
 int
@@ -517,14 +520,15 @@ ef_write(int type, int id, void *from)
     ep = &empfile[type];
     if (CANT_HAPPEN((ep->flags & (EFF_MEM | EFF_PRIVATE)) == EFF_PRIVATE))
        return 0;
-    if (CANT_HAPPEN((ep->flags & EFF_MEM) ? id >= ep->fids : id > ep->fids))
-       return 0;               /* not implemented */
     new_seqno(ep, from);
     if (id >= ep->fids) {
-       /* write beyond end of file extends it, take note */
+       /* beyond end of file */
+       if (CANT_HAPPEN((ep->flags & EFF_MEM) || id > ep->fids))
+           return 0;           /* not implemented */
+       /* write at end of file extends it */
        ep->fids = id + 1;
-       if (ep->onresize && ep->onresize(type) < 0)
-           return 0;
+       if (ep->onresize)
+           ep->onresize(type);
     }
     if (id >= ep->baseid && id < ep->baseid + ep->cids) {
        cachep = ep->cache + (id - ep->baseid) * ep->size;
@@ -599,6 +603,8 @@ get_seqno(struct empfile *ep, int id)
  * Increment sequence number in BUF, which is about to be written to EP.
  * Do nothing if table is not EFF_TYPED (it has no sequence number
  * then).
+ * Else, BUF's sequence number must match the one in EP's cache.  If
+ * it doesn't, we're about to clobber a previous write.
  */
 static void
 new_seqno(struct empfile *ep, void *buf)
@@ -613,12 +619,22 @@ new_seqno(struct empfile *ep, void *buf)
     elt->seqno = old_seqno + 1;
 }
 
+/*
+ * Make all copies stale.
+ * Only fresh copies may be written back to the cache.
+ * To be called by functions that may yield the processor.
+ * Writing an copy when there has been a yield since it was read is
+ * unsafe, because we could clobber another thread's write then.
+ * Robust code must assume the that any function that may yield does
+ * yield.  Marking copies stale there lets us catch unsafe writes.
+ */
 void
 ef_make_stale(void)
 {
     ef_generation++;
 }
 
+/* Mark copy of an element of table TYPE in BUF fresh.  */
 void
 ef_mark_fresh(int type, void *buf)
 {
@@ -696,14 +712,15 @@ ef_extend(int type, int count)
        }
     }
     ep->fids = id + count;
-    if (ep->onresize && ep->onresize(type) < 0)
-       return 0;
+    if (ep->onresize)
+       ep->onresize(type);
     return 1;
 }
 
 /*
- * Initialize element ID for EP in BUF.
+ * Initialize element ID for table TYPE in BUF.
  * FIXME pass buffer size!
+ * BUF is marked fresh with ef_mark_fresh().
  */
 void
 ef_blank(int type, int id, void *buf)
@@ -788,8 +805,8 @@ ef_truncate(int type, int count)
            ep->cids = count - ep->baseid;
     }
 
-    if (ep->onresize && ep->onresize(type) < 0)
-       return 0;
+    if (ep->onresize)
+       ep->onresize(type);
     return 1;
 }