git.pond.sub.org Git - empserver/blob - src/lib/common/file.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See files README, COPYING and CREDITS in the root of the source
  23  *  tree for related information and legal notices.  It is expected
  24  *  that future projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  file.c: Operations on Empire tables (`files' for historical reasons)
  29  *
  30  *  Known contributors to this file:
  31  *     Dave Pare, 1989
  32  *     Steve McClure, 2000
  33  *     Markus Armbruster, 2005-2008
  34  */
  35
  36 #include <config.h>
  37
  38 #include <errno.h>
  39 #include <fcntl.h>
  40 #include <sys/stat.h>
  41 #include <sys/types.h>
  42 #include <unistd.h>
  43 #include "file.h"
  44 #include "match.h"
  45 #include "misc.h"
  46 #include "nsc.h"
  47 #include "prototypes.h"
  48
  49 static int ef_realloc_cache(struct empfile *, int);
  50 static int fillcache(struct empfile *, int);
  51 static int do_write(struct empfile *, void *, int, int, time_t);
  52 static void do_blank(struct empfile *, void *, int, int);
  53
  54 /*
  55  * Open the file-backed table TYPE (EF_SECTOR, ...).
  56  * HOW are flags to control operation.  Naturally, immutable flags are
  57  * not permitted.
  58  * Return non-zero on success, zero on failure.
  59  * You must call ef_close() before the next ef_open().
  60  */
  61 int
  62 ef_open(int type, int how)
  63 {
  64     struct empfile *ep;
  65     struct flock lock;
  66     int oflags, fd, fsiz, nslots;
  67
  68     if (ef_check(type) < 0)
  69         return 0;
  70     if (CANT_HAPPEN(how & EFF_IMMUTABLE))
  71         how &= ~EFF_IMMUTABLE;
  72
  73     /* open file */
  74     ep = &empfile[type];
  75     if (CANT_HAPPEN(ep->fd >= 0))
  76         return 0;
  77     oflags = O_RDWR;
  78     if (how & EFF_PRIVATE)
  79         oflags = O_RDONLY;
  80     if (how & EFF_CREATE)
  81         oflags |= O_CREAT | O_TRUNC;
  82 #if defined(_WIN32)
  83     oflags |= O_BINARY;
  84 #endif
  85     if ((fd = open(ep->file, oflags, S_IRWUG)) < 0) {
  86         logerror("Can't open %s (%s)", ep->file, strerror(errno));
  87         return 0;
  88     }
  89
  90     lock.l_type = how & EFF_PRIVATE ? F_RDLCK : F_WRLCK;
  91     lock.l_whence = SEEK_SET;
  92     lock.l_start = lock.l_len = 0;
  93     if (fcntl(fd, F_SETLK, &lock) == -1) {
  94         logerror("Can't lock %s (%s)", ep->file, strerror(errno));
  95         close(fd);
  96         return 0;
  97     }
  98
  99     /* get file size */
 100     fsiz = fsize(fd);
 101     if (fsiz % ep->size) {
 102         logerror("Can't open %s (file size not a multiple of record size %d)",
 103                  ep->file, ep->size);
 104         close(fd);
 105         return 0;
 106     }
 107     ep->fids = fsiz / ep->size;
 108
 109     /* allocate cache */
 110     if (ep->flags & EFF_STATIC) {
 111         /* ep->cache already points to space for ep->csize elements */
 112         if (how & EFF_MEM) {
 113             if (ep->fids > ep->csize) {
 114                 logerror("Can't open %s: file larger than %d bytes",
 115                          ep->file, ep->fids * ep->size);
 116                 close(fd);
 117                 return 0;
 118             }
 119         }
 120     } else {
 121         if (CANT_HAPPEN(ep->cache))
 122             free(ep->cache);
 123         if (how & EFF_MEM)
 124             nslots = ep->fids;
 125         else
 126             nslots = blksize(fd) / ep->size;
 127         if (!ef_realloc_cache(ep, nslots)) {
 128             logerror("Can't map %s (%s)", ep->file, strerror(errno));
 129             close(fd);
 130             return 0;
 131         }
 132     }
 133     ep->baseid = 0;
 134     ep->cids = 0;
 135     ep->flags = (ep->flags & EFF_IMMUTABLE) | (how & ~EFF_CREATE);
 136     ep->fd = fd;
 137
 138     /* map file into cache */
 139     if ((how & EFF_MEM) && ep->fids) {
 140         if (fillcache(ep, 0) != ep->fids) {
 141             ep->cids = 0;       /* prevent cache flush */
 142             ep->flags &= EFF_IMMUTABLE; /* maintain invariant */
 143             ef_close(type);
 144             return 0;
 145         }
 146     }
 147
 148     return 1;
 149 }
 150
 151 /*
 152  * Reallocate cache for table EP to hold COUNT slots.
 153  * The table must not be allocated statically.
 154  * The cache may still be unmapped.
 155  * If reallocation succeeds, any pointers obtained from ef_ptr()
 156  * become invalid.
 157  * If it fails, the cache is unchanged, and errno is set.
 158  * Return non-zero on success, zero on failure.
 159  */
 160 static int
 161 ef_realloc_cache(struct empfile *ep, int count)
 162 {
 163     void *cache;
 164
 165     if (CANT_HAPPEN(ep->flags & EFF_STATIC))
 166         return 0;
 167     if (CANT_HAPPEN(count < 0))
 168         count = 0;
 169
 170     /*
 171      * Avoid zero slots, because that can lead to null cache, which
 172      * would be interpreted as unmapped cache.
 173      */
 174     if (count == 0)
 175         count++;
 176     cache = realloc(ep->cache, count * ep->size);
 177     if (!cache)
 178         return 0;
 179
 180     ep->cache = cache;
 181     ep->csize = count;
 182     return 1;
 183 }
 184
 185 /*
 186  * Close the file-backed table TYPE (EF_SECTOR, ...).
 187  * Return non-zero on success, zero on failure.
 188  */
 189 int
 190 ef_close(int type)
 191 {
 192     struct empfile *ep;
 193     int retval;
 194
 195     retval = ef_flush(type);
 196     ep = &empfile[type];
 197     ep->flags &= EFF_IMMUTABLE;
 198     if (!(ep->flags & EFF_STATIC)) {
 199         free(ep->cache);
 200         ep->cache = NULL;
 201     }
 202     if (close(ep->fd) < 0) {
 203         logerror("Error closing %s (%s)", ep->name, strerror(errno));
 204         retval = 0;
 205     }
 206     ep->fd = -1;
 207     return retval;
 208 }
 209
 210 /*
 211  * Flush table TYPE (EF_SECTOR, ...) to disk.
 212  * Does nothing if the table is privately mapped.
 213  * Return non-zero on success, zero on failure.
 214  */
 215 int
 216 ef_flush(int type)
 217 {
 218     struct empfile *ep;
 219
 220     if (ef_check(type) < 0)
 221         return 0;
 222     ep = &empfile[type];
 223     if (ep->flags & EFF_PRIVATE)
 224         return 1;               /* nothing to do */
 225     if (CANT_HAPPEN(ep->fd < 0))
 226         return 0;
 227     /*
 228      * We don't know which cache entries are dirty.  ef_write() writes
 229      * through, but direct updates through ef_ptr() don't.  They are
 230      * allowed only with EFF_MEM.  Assume the whole cash is dirty
 231      * then.
 232      */
 233     if (ep->flags & EFF_MEM) {
 234         if (do_write(ep, ep->cache, ep->baseid, ep->cids, time(NULL)) < 0)
 235             return 0;
 236     }
 237
 238     return 1;
 239 }
 240
 241 /*
 242  * Return pointer to element ID in table TYPE if it exists, else NULL.
 243  * The table must be fully cached, i.e. flags & EFF_MEM.
 244  * The caller is responsible for flushing changes he makes.
 245  */
 246 void *
 247 ef_ptr(int type, int id)
 248 {
 249     struct empfile *ep;
 250
 251     if (ef_check(type) < 0)
 252         return NULL;
 253     ep = &empfile[type];
 254     if (CANT_HAPPEN(!(ep->flags & EFF_MEM) || !ep->cache))
 255         return NULL;
 256     if (id < 0 || id >= ep->fids)
 257         return NULL;
 258     return ep->cache + ep->size * id;
 259 }
 260
 261 /*
 262  * Read element ID from table TYPE into buffer INTO.
 263  * FIXME pass buffer size!
 264  * Return non-zero on success, zero on failure.
 265  */
 266 int
 267 ef_read(int type, int id, void *into)
 268 {
 269     struct empfile *ep;
 270     void *from;
 271
 272     if (ef_check(type) < 0)
 273         return 0;
 274     ep = &empfile[type];
 275     if (CANT_HAPPEN(!ep->cache))
 276         return 0;
 277     if (id < 0 || id >= ep->fids)
 278         return 0;
 279
 280     if (ep->flags & EFF_MEM) {
 281         from = ep->cache + id * ep->size;
 282     } else {
 283         if (ep->baseid + ep->cids <= id || ep->baseid > id) {
 284             if (fillcache(ep, id) < 1)
 285                 return 0;
 286         }
 287         from = ep->cache + (id - ep->baseid) * ep->size;
 288     }
 289     memcpy(into, from, ep->size);
 290
 291     if (ep->postread)
 292         ep->postread(id, into);
 293     return 1;
 294 }
 295
 296 /*
 297  * Fill cache of EP with elements starting at ID.
 298  * If any were read, return their number.
 299  * Else return -1 and leave the cache unchanged.
 300  */
 301 static int
 302 fillcache(struct empfile *ep, int start)
 303 {
 304     int n, ret;
 305     char *p;
 306
 307     if (CANT_HAPPEN(ep->fd < 0 || !ep->cache))
 308         return -1;
 309
 310     if (lseek(ep->fd, start * ep->size, SEEK_SET) == (off_t)-1) {
 311         logerror("Error seeking %s (%s)", ep->file, strerror(errno));
 312         return -1;
 313     }
 314
 315     p = ep->cache;
 316     n = ep->csize * ep->size;
 317     while (n > 0) {
 318         ret = read(ep->fd, p, n);
 319         if (ret < 0) {
 320             if (errno != EAGAIN) {
 321                 logerror("Error reading %s (%s)", ep->file, strerror(errno));
 322                 break;
 323             }
 324         } else if (ret == 0) {
 325             break;
 326         } else {
 327             p += ret;
 328             n -= ret;
 329         }
 330     }
 331
 332     if (p == ep->cache)
 333         return -1;              /* nothing read, old cache still ok */
 334
 335     ep->baseid = start;
 336     ep->cids = (p - ep->cache) / ep->size;
 337     return ep->cids;
 338 }
 339
 340 /*
 341  * Write COUNT elements from BUF to EP, starting at ID.
 342  * Set the timestamp to NOW if the table has those.
 343  * Return 0 on success, -1 on error.
 344  */
 345 static int
 346 do_write(struct empfile *ep, void *buf, int id, int count, time_t now)
 347 {
 348     int i, n, ret;
 349     char *p;
 350     struct emptypedstr *elt;
 351
 352     if (CANT_HAPPEN(ep->fd < 0 || (ep->flags & EFF_PRIVATE)
 353                     || id < 0 || count < 0))
 354         return -1;
 355
 356     if (ep->flags & EFF_TYPED) {
 357         for (i = 0; i < count; i++) {
 358             /*
 359              * TODO Oopses here could be due to bad data corruption.
 360              * Fail instead of attempting to recover?
 361              */
 362             elt = (struct emptypedstr *)((char *)buf + i * ep->size);
 363             if (CANT_HAPPEN(elt->ef_type != ep->uid))
 364                 elt->ef_type = ep->uid;
 365             if (CANT_HAPPEN(elt->uid != id + i))
 366                 elt->uid = id + i;
 367             elt->timestamp = now;
 368         }
 369     }
 370
 371     if (lseek(ep->fd, id * ep->size, SEEK_SET) == (off_t)-1) {
 372         logerror("Error seeking %s (%s)", ep->file, strerror(errno));
 373         return -1;
 374     }
 375
 376     p = buf;
 377     n = count * ep->size;
 378     while (n > 0) {
 379         ret = write(ep->fd, p, n);
 380         if (ret < 0) {
 381             if (errno != EAGAIN) {
 382                 logerror("Error writing %s (%s)", ep->file, strerror(errno));
 383                 /* FIXME if this extended file, truncate back to old size */
 384                 return -1;
 385             }
 386         } else {
 387             p += ret;
 388             n -= ret;
 389         }
 390     }
 391
 392     return 0;
 393 }
 394
 395 /*
 396  * Write element ID into table TYPE from buffer FROM.
 397  * FIXME pass buffer size!
 398  * If table is file-backed and not privately mapped, write through
 399  * cache straight to disk.
 400  * Cannot write beyond the end of fully cached table (flags & EFF_MEM).
 401  * Can write at the end of partially cached table.
 402  * Return non-zero on success, zero on failure.
 403  */
 404 int
 405 ef_write(int type, int id, void *from)
 406 {
 407     struct empfile *ep;
 408     char *to;
 409
 410     if (ef_check(type) < 0)
 411         return 0;
 412     ep = &empfile[type];
 413     if (CANT_HAPPEN((ep->flags & (EFF_MEM | EFF_PRIVATE)) == EFF_PRIVATE))
 414         return 0;
 415     if (ep->prewrite)
 416         ep->prewrite(id, from);
 417     if (CANT_HAPPEN((ep->flags & EFF_MEM) ? id >= ep->fids : id > ep->fids))
 418         return 0;               /* not implemented */
 419     if (!(ep->flags & EFF_PRIVATE)) {
 420         if (do_write(ep, from, id, 1, time(NULL)) < 0)
 421             return 0;
 422     }
 423     if (id >= ep->baseid && id < ep->baseid + ep->cids) {
 424         /* update the cache if necessary */
 425         to = ep->cache + (id - ep->baseid) * ep->size;
 426         if (to != from)
 427             memcpy(to, from, ep->size);
 428     }
 429     if (id >= ep->fids) {
 430         /* write beyond end of file extends it, take note */
 431         ep->fids = id + 1;
 432     }
 433     return 1;
 434 }
 435
 436 /*
 437  * Extend table TYPE by COUNT elements.
 438  * Any pointers obtained from ef_ptr() become invalid.
 439  * Return non-zero on success, zero on failure.
 440  */
 441 int
 442 ef_extend(int type, int count)
 443 {
 444     struct empfile *ep;
 445     char *p;
 446     int i, id;
 447     time_t now = time(NULL);
 448
 449     if (ef_check(type) < 0)
 450         return 0;
 451     ep = &empfile[type];
 452     if (CANT_HAPPEN(count < 0))
 453         return 0;
 454
 455     id = ep->fids;
 456     if (ep->flags & EFF_MEM) {
 457         if (id + count > ep->csize) {
 458             if (ep->flags & EFF_STATIC) {
 459                 logerror("Can't extend %s beyond %d elements",
 460                          ep->file, ep->csize);
 461                 return 0;
 462             }
 463             if (!ef_realloc_cache(ep, id + count)) {
 464                 logerror("Can't extend %s to %d elements (%s)",
 465                          ep->file, id + count, strerror(errno));
 466                 return 0;
 467             }
 468         }
 469         p = ep->cache + id * ep->size;
 470         do_blank(ep, p, id, count);
 471         if (ep->fd >= 0 && !(ep->flags & EFF_PRIVATE)) {
 472             if (do_write(ep, p, id, count, now) < 0)
 473                 return 0;
 474         }
 475         ep->cids += count;
 476     } else {
 477         /* need a buffer, steal last cache slot */
 478         if (ep->cids == ep->csize)
 479             ep->cids--;
 480         p = ep->cache + ep->cids * ep->size;
 481         for (i = 0; i < count; i++) {
 482             do_blank(ep, p, id + i, 1);
 483             if (do_write(ep, p, id + i, 1, now) < 0)
 484                 return 0;
 485         }
 486     }
 487     ep->fids += count;
 488     return 1;
 489 }
 490
 491 /*
 492  * Initialize element ID for EP in BUF.
 493  * FIXME pass buffer size!
 494  */
 495 void
 496 ef_blank(int type, int id, void *buf)
 497 {
 498     if (ef_check(type) < 0)
 499         return;
 500     do_blank(&empfile[type], buf, id, 1);
 501 }
 502
 503 /*
 504  * Initialize COUNT elements of EP in BUF, starting with element ID.
 505  */
 506 static void
 507 do_blank(struct empfile *ep, void *buf, int id, int count)
 508 {
 509     int i;
 510     struct emptypedstr *elt;
 511
 512     memset(buf, 0, count * ep->size);
 513     if (ep->flags & EFF_TYPED) {
 514         for (i = 0; i < count; i++) {
 515             elt = (struct emptypedstr *)((char *)buf + i * ep->size);
 516             elt->ef_type = ep->uid;
 517             elt->uid = id + i;
 518         }
 519     }
 520 }
 521
 522 /*
 523  * Truncate table TYPE to COUNT elements.
 524  * Any pointers obtained from ef_ptr() become invalid.
 525  * Return non-zero on success, zero on failure.
 526  */
 527 int
 528 ef_truncate(int type, int count)
 529 {
 530     struct empfile *ep;
 531
 532     if (ef_check(type) < 0)
 533         return 0;
 534     ep = &empfile[type];
 535     if (CANT_HAPPEN(count < 0 || count > ep->fids))
 536         return 0;
 537
 538     if (ep->fd >= 0 && !(ep->flags & EFF_PRIVATE)) {
 539         if (ftruncate(ep->fd, count * ep->size) < 0) {
 540             logerror("Can't truncate %s to %d elements (%s)",
 541                      ep->file, count, strerror(errno));
 542             return 0;
 543         }
 544     }
 545     ep->fids = count;
 546
 547     if (ep->flags & EFF_MEM) {
 548         if (!(ep->flags & EFF_STATIC)) {
 549             if (!ef_realloc_cache(ep, count)) {
 550                 logerror("Can't shrink cache after truncate");
 551                 /* continue with unshrunk cache */
 552             }
 553         }
 554         ep->cids = count;
 555     } else {
 556         if (ep->baseid >= count)
 557             ep->cids = 0;
 558         else if (ep->cids > count - ep->baseid)
 559             ep->cids = count - ep->baseid;
 560     }
 561
 562     return 1;
 563 }
 564
 565 struct castr *
 566 ef_cadef(int type)
 567 {
 568     return empfile[type].cadef;
 569 }
 570
 571 int
 572 ef_nelem(int type)
 573 {
 574     return empfile[type].fids;
 575 }
 576
 577 int
 578 ef_flags(int type)
 579 {
 580     return empfile[type].flags;
 581 }
 582
 583 time_t
 584 ef_mtime(int type)
 585 {
 586     if (empfile[type].fd <= 0)
 587         return 0;
 588     return fdate(empfile[type].fd);
 589 }
 590
 591 /*
 592  * Search for a table matching NAME, return its table type.
 593  * Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
 594  * several.
 595  */
 596 int
 597 ef_byname(char *name)
 598 {
 599     return stmtch(name, empfile, offsetof(struct empfile, name),
 600                   sizeof(empfile[0]));
 601 }
 602
 603 /*
 604  * Search CHOICES[] for a table type matching NAME, return it.
 605  * Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
 606  * several.
 607  * CHOICES[] must be terminated with a negative value.
 608  */
 609 int
 610 ef_byname_from(char *name, int choices[])
 611 {
 612     int res;
 613     int *p;
 614
 615     res = M_NOTFOUND;
 616     for (p = choices; *p >= 0; p++) {
 617         if (ef_check(*p) < 0)
 618             continue;
 619         switch (mineq(name, empfile[*p].name)) {
 620         case ME_MISMATCH:
 621             break;
 622         case ME_PARTIAL:
 623             if (res >= 0)
 624                 return M_NOTUNIQUE;
 625             res = *p;
 626             break;
 627         case ME_EXACT:
 628             return *p;
 629         }
 630     }
 631     return res;
 632 }
 633
 634 char *
 635 ef_nameof(int type)
 636 {
 637     if (ef_check(type) < 0)
 638         return "bad ef_type";
 639     return empfile[type].name;
 640 }
 641
 642 int
 643 ef_check(int type)
 644 {
 645     if (CANT_HAPPEN((unsigned)type >= EF_MAX))
 646         return -1;
 647     return 0;
 648 }
 649
 650 /*
 651  * Ensure file-backed table contains ID.
 652  * If necessary, extend it in steps of COUNT elements.
 653  * Return non-zero on success, zero on failure.
 654  */
 655 int
 656 ef_ensure_space(int type, int id, int count)
 657 {
 658     if (ef_check(type) < 0)
 659         return 0;
 660     CANT_HAPPEN(id < 0);
 661
 662     while (id >= empfile[type].fids) {
 663         if (!ef_extend(type, count))
 664             return 0;
 665     }
 666     return 1;
 667 }