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-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                Ken Stevens, Steve McClure, Markus Armbruster
   5  *
   6  *  Empire 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 3 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, see <http://www.gnu.org/licenses/>.
  18  *
  19  *  ---
  20  *
  21  *  See files README, COPYING and CREDITS in the root of the source
  22  *  tree for related information and legal notices.  It is expected
  23  *  that future projects/authors will amend these files as needed.
  24  *
  25  *  ---
  26  *
  27  *  file.c: Operations on Empire tables (`files' for historical reasons)
  28  *
  29  *  Known contributors to this file:
  30  *     Dave Pare, 1989
  31  *     Steve McClure, 2000
  32  *     Markus Armbruster, 2005-2011
  33  */
  34
  35 #include <config.h>
  36
  37 #include <errno.h>
  38 #include <fcntl.h>
  39 #include <sys/stat.h>
  40 #include <sys/types.h>
  41 #include <unistd.h>
  42 #ifdef _WIN32
  43 #include <io.h>
  44 #include <share.h>
  45 #endif
  46 #include "file.h"
  47 #include "match.h"
  48 #include "misc.h"
  49 #include "nsc.h"
  50 #include "prototypes.h"
  51
  52 static int open_locked(char *, int, mode_t);
  53 static int ef_realloc_cache(struct empfile *, int);
  54 static int fillcache(struct empfile *, int);
  55 static int do_read(struct empfile *, void *, int, int);
  56 static int do_write(struct empfile *, void *, int, int);
  57 static unsigned get_seqno(struct empfile *, int);
  58 static void new_seqno(struct empfile *, void *);
  59 static void must_be_fresh(struct empfile *, void *);
  60 static void do_blank(struct empfile *, void *, int, int);
  61 static int ef_check(int);
  62
  63 static unsigned ef_generation;
  64
  65 /*
  66  * Open the file-backed table TYPE (EF_SECTOR, ...).
  67  * HOW are flags to control operation.  Naturally, immutable flags are
  68  * not permitted.
  69  * If NELT is non-negative, the table must have that many elements.
  70  * Return non-zero on success, zero on failure.
  71  * You must call ef_close() before the next ef_open().
  72  */
  73 int
  74 ef_open(int type, int how, int nelt)
  75 {
  76     struct empfile *ep;
  77     int oflags, fd, fsiz, fids, nslots;
  78
  79     if (ef_check(type) < 0)
  80         return 0;
  81     if (CANT_HAPPEN(how & EFF_IMMUTABLE))
  82         how &= ~EFF_IMMUTABLE;
  83
  84     /* open file */
  85     ep = &empfile[type];
  86     if (CANT_HAPPEN(ep->fd >= 0))
  87         return 0;
  88     oflags = O_RDWR;
  89     if (how & EFF_PRIVATE)
  90         oflags = O_RDONLY;
  91     if (how & EFF_CREATE)
  92         oflags |= O_CREAT | O_TRUNC;
  93     fd = open_locked(ep->file, oflags, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
  94     if (fd < 0) {
  95         logerror("Can't open %s (%s)", ep->file, strerror(errno));
  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     fids = fsiz / ep->size;
 108     if (nelt >= 0 && nelt != fids) {
 109         logerror("Can't open %s (got %d records instead of %d)",
 110                  ep->file, fids, nelt);
 111         close(fd);
 112         return 0;
 113     }
 114
 115     /* allocate cache */
 116     if (ep->flags & EFF_STATIC) {
 117         /* ep->cache already points to space for ep->csize elements */
 118         if (how & EFF_MEM) {
 119             if (fids > ep->csize) {
 120                 logerror("Can't open %s (file larger than %d records)",
 121                          ep->file, ep->csize);
 122                 close(fd);
 123                 return 0;
 124             }
 125         }
 126     } else {
 127         if (CANT_HAPPEN(ep->cache))
 128             free(ep->cache);
 129         if (how & EFF_MEM)
 130             nslots = fids;
 131         else
 132             nslots = blksize(fd) / ep->size;
 133         if (!ef_realloc_cache(ep, nslots)) {
 134             logerror("Can't map %s (%s)", ep->file, strerror(errno));
 135             close(fd);
 136             return 0;
 137         }
 138     }
 139     ep->baseid = 0;
 140     ep->cids = 0;
 141     ep->fids = fids;
 142     ep->flags = (ep->flags & EFF_IMMUTABLE) | (how & ~EFF_CREATE);
 143     ep->fd = fd;
 144
 145     /* map file into cache */
 146     if ((how & EFF_MEM) && fids) {
 147         if (fillcache(ep, 0) != fids) {
 148             ep->cids = 0;       /* prevent cache flush */
 149             ef_close(type);
 150             return 0;
 151         }
 152     }
 153
 154     if (ep->onresize)
 155         ep->onresize(type);
 156     return 1;
 157 }
 158
 159 static int
 160 open_locked(char *name, int oflags, mode_t mode)
 161 {
 162     int rdlonly = (oflags & O_ACCMODE) == O_RDONLY;
 163     int fd;
 164
 165 #ifdef _WIN32
 166     fd = _sopen(name, oflags | O_BINARY, rdlonly ? SH_DENYNO : SH_DENYWR,
 167                 mode);
 168     if (fd < 0)
 169         return -1;
 170 #else  /* !_WIN32 */
 171     struct flock lock;
 172
 173     fd = open(name, oflags, mode);
 174     if (fd < 0)
 175         return -1;
 176
 177     lock.l_type = rdlonly ? F_RDLCK : F_WRLCK;
 178     lock.l_whence = SEEK_SET;
 179     lock.l_start = lock.l_len = 0;
 180     if (fcntl(fd, F_SETLK, &lock) == -1) {
 181         close(fd);
 182         return -1;
 183     }
 184 #endif  /* !_WIN32 */
 185     return fd;
 186 }
 187
 188 /*
 189  * Reallocate cache for table EP to hold COUNT slots.
 190  * The table must not be allocated statically.
 191  * The cache may still be unmapped.
 192  * If reallocation succeeds, any pointers obtained from ef_ptr()
 193  * become invalid.
 194  * If it fails, the cache is unchanged, and errno is set.
 195  * Return non-zero on success, zero on failure.
 196  */
 197 static int
 198 ef_realloc_cache(struct empfile *ep, int count)
 199 {
 200     void *cache;
 201
 202     if (CANT_HAPPEN(ep->flags & EFF_STATIC))
 203         return 0;
 204     if (CANT_HAPPEN(count < 0))
 205         count = 0;
 206
 207     /*
 208      * Avoid zero slots, because that can lead to null cache, which
 209      * would be interpreted as unmapped cache.
 210      */
 211     if (count == 0)
 212         count++;
 213     cache = realloc(ep->cache, count * ep->size);
 214     if (!cache)
 215         return 0;
 216
 217     ep->cache = cache;
 218     ep->csize = count;
 219     return 1;
 220 }
 221
 222 /*
 223  * Open the table TYPE as view of table BASE.
 224  * Return non-zero on success, zero on failure.
 225  * Beware: views work only as long as BASE doesn't change size!
 226  * You must call ef_close(TYPE) before closing BASE.
 227  */
 228 int
 229 ef_open_view(int type, int base)
 230 {
 231     struct empfile *ep;
 232
 233     if (CANT_HAPPEN(!EF_IS_VIEW(type)))
 234         return -1;
 235     ep = &empfile[type];
 236     if (CANT_HAPPEN(!(ef_flags(base) & EFF_MEM)))
 237         return -1;
 238
 239     ep->cache = empfile[base].cache;
 240     ep->csize = empfile[base].csize;
 241     ep->flags |= EFF_MEM;
 242     ep->baseid = empfile[base].baseid;
 243     ep->cids = empfile[base].cids;
 244     ep->fids = empfile[base].fids;
 245     return 0;
 246 }
 247
 248 /*
 249  * Close the open table TYPE (EF_SECTOR, ...).
 250  * Return non-zero on success, zero on failure.
 251  */
 252 int
 253 ef_close(int type)
 254 {
 255     struct empfile *ep;
 256     int retval = 1;
 257
 258     if (ef_check(type) < 0)
 259         return 0;
 260     ep = &empfile[type];
 261
 262     if (EF_IS_VIEW(type)) {
 263         ep->cache = NULL;
 264         ep->csize = 0;
 265     } else {
 266         if (!ef_flush(type))
 267             retval = 0;
 268         if (!(ep->flags & EFF_STATIC)) {
 269             free(ep->cache);
 270             ep->cache = NULL;
 271             ep->csize = 0;
 272         }
 273         if (close(ep->fd) < 0) {
 274             logerror("Error closing %s (%s)", ep->file, strerror(errno));
 275             retval = 0;
 276         }
 277         ep->fd = -1;
 278     }
 279     ep->flags &= EFF_IMMUTABLE;
 280     ep->baseid = ep->cids = ep->fids = 0;
 281     if (ep->onresize)
 282         ep->onresize(type);
 283     return retval;
 284 }
 285
 286 /*
 287  * Flush file-backed table TYPE (EF_SECTOR, ...) to its backing file.
 288  * Do nothing if the table is privately mapped.
 289  * Update timestamps of written elements if table is EFF_TYPED.
 290  * Return non-zero on success, zero on failure.
 291  */
 292 int
 293 ef_flush(int type)
 294 {
 295     struct empfile *ep;
 296
 297     if (ef_check(type) < 0)
 298         return 0;
 299     ep = &empfile[type];
 300     if (ep->flags & EFF_PRIVATE)
 301         return 1;               /* nothing to do */
 302     if (CANT_HAPPEN(ep->fd < 0))
 303         return 0;
 304     /*
 305      * We don't know which cache entries are dirty.  ef_write() writes
 306      * through, but direct updates through ef_ptr() don't.  They are
 307      * allowed only with EFF_MEM.  Assume the whole cash is dirty
 308      * then.
 309      */
 310     if (ep->flags & EFF_MEM) {
 311         if (do_write(ep, ep->cache, ep->baseid, ep->cids) < 0)
 312             return 0;
 313     }
 314
 315     return 1;
 316 }
 317
 318 /*
 319  * Return pointer to element ID in table TYPE if it exists, else NULL.
 320  * The table must be fully cached, i.e. flags & EFF_MEM.
 321  * The caller is responsible for flushing changes he makes.
 322  */
 323 void *
 324 ef_ptr(int type, int id)
 325 {
 326     struct empfile *ep;
 327
 328     if (ef_check(type) < 0)
 329         return NULL;
 330     ep = &empfile[type];
 331     if (CANT_HAPPEN(!(ep->flags & EFF_MEM) || !ep->cache))
 332         return NULL;
 333     if (id < 0 || id >= ep->fids)
 334         return NULL;
 335     return ep->cache + ep->size * id;
 336 }
 337
 338 /*
 339  * Read element ID from table TYPE into buffer INTO.
 340  * FIXME pass buffer size!
 341  * INTO is marked fresh with ef_mark_fresh().
 342  * Return non-zero on success, zero on failure.
 343  */
 344 int
 345 ef_read(int type, int id, void *into)
 346 {
 347     struct empfile *ep;
 348     void *cachep;
 349
 350     if (ef_check(type) < 0)
 351         return 0;
 352     ep = &empfile[type];
 353     if (CANT_HAPPEN(!ep->cache))
 354         return 0;
 355     if (id < 0 || id >= ep->fids)
 356         return 0;
 357
 358     if (ep->flags & EFF_MEM) {
 359         cachep = ep->cache + id * ep->size;
 360     } else {
 361         if (ep->baseid + ep->cids <= id || ep->baseid > id) {
 362             if (fillcache(ep, id) < 1)
 363                 return 0;
 364         }
 365         cachep = ep->cache + (id - ep->baseid) * ep->size;
 366     }
 367     memcpy(into, cachep, ep->size);
 368     ef_mark_fresh(type, into);
 369
 370     if (ep->postread)
 371         ep->postread(id, into);
 372     return 1;
 373 }
 374
 375 /*
 376  * Fill cache of file-backed EP with elements starting at ID.
 377  * If any were read, return their number.
 378  * Else return -1 and leave the cache unchanged.
 379  */
 380 static int
 381 fillcache(struct empfile *ep, int id)
 382 {
 383     int ret;
 384
 385     if (CANT_HAPPEN(!ep->cache))
 386         return -1;
 387
 388     ret = do_read(ep, ep->cache, id, MIN(ep->csize, ep->fids - id));
 389     if (ret >= 0) {
 390         /* cache changed */
 391         ep->baseid = id;
 392         ep->cids = ret;
 393     }
 394     return ret;
 395 }
 396
 397 static int
 398 do_read(struct empfile *ep, void *buf, int id, int count)
 399 {
 400     int n, ret;
 401     char *p;
 402
 403     if (CANT_HAPPEN(ep->fd < 0 || id < 0 || count < 0))
 404         return -1;
 405
 406     if (lseek(ep->fd, id * ep->size, SEEK_SET) == (off_t)-1) {
 407         logerror("Error seeking %s to elt %d (%s)",
 408                  ep->file, id, strerror(errno));
 409         return -1;
 410     }
 411
 412     p = buf;
 413     n = count * ep->size;
 414     while (n > 0) {
 415         ret = read(ep->fd, p, n);
 416         if (ret < 0) {
 417             if (errno != EINTR) {
 418                 logerror("Error reading %s elt %d (%s)",
 419                          ep->file,
 420                          id + (int)((p - (char *)buf) / ep->size),
 421                          strerror(errno));
 422                 break;
 423             }
 424         } else if (ret == 0) {
 425             logerror("Unexpected EOF reading %s elt %d",
 426                      ep->file, id + (int)((p - (char *)buf) / ep->size));
 427             break;
 428         } else {
 429             p += ret;
 430             n -= ret;
 431         }
 432     }
 433
 434     return (p - (char *)buf) / ep->size;
 435 }
 436
 437 /*
 438  * Write COUNT elements starting at ID from BUF to file-backed EP.
 439  * Update the timestamp if the table is EFF_TYPED.
 440  * Don't actually write if table is privately mapped.
 441  * Return 0 on success, -1 on error (file may be corrupt then).
 442  */
 443 static int
 444 do_write(struct empfile *ep, void *buf, int id, int count)
 445 {
 446     int i, n, ret;
 447     char *p;
 448     struct emptypedstr *elt;
 449     time_t now;
 450
 451     if (CANT_HAPPEN(ep->fd < 0 || id < 0 || count < 0))
 452         return -1;
 453
 454     if (ep->flags & EFF_TYPED) {
 455         now = ep->flags & EFF_NOTIME ? (time_t)-1 : time(NULL);
 456         for (i = 0; i < count; i++) {
 457             /*
 458              * TODO Oopses here could be due to bad data corruption.
 459              * Fail instead of attempting to recover?
 460              */
 461             elt = (struct emptypedstr *)((char *)buf + i * ep->size);
 462             if (CANT_HAPPEN(elt->ef_type != ep->uid))
 463                 elt->ef_type = ep->uid;
 464             if (CANT_HAPPEN(elt->uid != id + i))
 465                 elt->uid = id + i;
 466             if (now != (time_t)-1)
 467                 elt->timestamp = now;
 468         }
 469     }
 470
 471     if (ep->flags & EFF_PRIVATE)
 472         return 0;
 473
 474     if (lseek(ep->fd, id * ep->size, SEEK_SET) == (off_t)-1) {
 475         logerror("Error seeking %s to elt %d (%s)",
 476                  ep->file, id, strerror(errno));
 477         return -1;
 478     }
 479
 480     p = buf;
 481     n = count * ep->size;
 482     while (n > 0) {
 483         ret = write(ep->fd, p, n);
 484         if (ret < 0) {
 485             if (errno != EINTR) {
 486                 logerror("Error writing %s elt %d (%s)",
 487                          ep->file,
 488                          id + (int)((p - (char *)buf) / ep->size),
 489                          strerror(errno));
 490                 return -1;
 491             }
 492         } else {
 493             p += ret;
 494             n -= ret;
 495         }
 496     }
 497
 498     return 0;
 499 }
 500
 501 /*
 502  * Write element ID into table TYPE from buffer FROM.
 503  * FIXME pass buffer size!
 504  * Update timestamp in FROM if table is EFF_TYPED.
 505  * If table is file-backed and not privately mapped, write through
 506  * cache straight to disk.
 507  * Cannot write beyond the end of fully cached table (flags & EFF_MEM).
 508  * Can write at the end of partially cached table.
 509  * FROM must be fresh; see ef_make_stale().
 510  * Return non-zero on success, zero on failure.
 511  */
 512 int
 513 ef_write(int type, int id, void *from)
 514 {
 515     struct empfile *ep;
 516     char *cachep;
 517
 518     if (ef_check(type) < 0)
 519         return 0;
 520     ep = &empfile[type];
 521     if (CANT_HAPPEN((ep->flags & (EFF_MEM | EFF_PRIVATE)) == EFF_PRIVATE))
 522         return 0;
 523     if (CANT_HAPPEN((ep->flags & EFF_MEM) ? id >= ep->fids : id > ep->fids))
 524         return 0;               /* not implemented */
 525     new_seqno(ep, from);
 526     if (id >= ep->fids) {
 527         /* write beyond end of file extends it, take note */
 528         ep->fids = id + 1;
 529         if (ep->onresize)
 530             ep->onresize(type);
 531     }
 532     if (id >= ep->baseid && id < ep->baseid + ep->cids) {
 533         cachep = ep->cache + (id - ep->baseid) * ep->size;
 534         if (cachep != from)
 535             must_be_fresh(ep, from);
 536     } else
 537         cachep = NULL;
 538     if (ep->prewrite)
 539         ep->prewrite(id, cachep, from);
 540     if (ep->fd >= 0) {
 541         if (do_write(ep, from, id, 1) < 0)
 542             return 0;
 543     }
 544     if (cachep && cachep != from)       /* update the cache if necessary */
 545         memcpy(cachep, from, ep->size);
 546     return 1;
 547 }
 548
 549 /*
 550  * Change element id.
 551  * BUF is an element of table TYPE.
 552  * ID is its new element ID.
 553  * If table is EFF_TYPED, change id and sequence number stored in BUF.
 554  * Else do nothing.
 555  */
 556 void
 557 ef_set_uid(int type, void *buf, int uid)
 558 {
 559     struct emptypedstr *elt;
 560     struct empfile *ep;
 561
 562     if (ef_check(type) < 0)
 563         return;
 564     ep = &empfile[type];
 565     if (!(ep->flags & EFF_TYPED))
 566         return;
 567     elt = buf;
 568     if (elt->uid == uid)
 569         return;
 570     elt->uid = uid;
 571     elt->seqno = get_seqno(ep, uid);
 572 }
 573
 574 /*
 575  * Return sequence number of element ID in table EP.
 576  * Return zero if table is not EFF_TYPED (it has no sequence number
 577  * then).
 578  */
 579 static unsigned
 580 get_seqno(struct empfile *ep, int id)
 581 {
 582     struct emptypedstr *elt;
 583
 584     if (!(ep->flags & EFF_TYPED))
 585         return 0;
 586     if (id < 0 || id >= ep->fids)
 587         return 0;
 588     if (id >= ep->baseid && id < ep->baseid + ep->cids)
 589         elt = (void *)(ep->cache + (id - ep->baseid) * ep->size);
 590     else {
 591         /* need a buffer, steal last cache slot */
 592         if (ep->cids == ep->csize)
 593             ep->cids--;
 594         elt = (void *)(ep->cache + ep->cids * ep->size);
 595         if (do_read(ep, elt, id, 1) < 0)
 596             return 0;           /* deep trouble */
 597     }
 598     return elt->seqno;
 599 }
 600
 601 /*
 602  * Increment sequence number in BUF, which is about to be written to EP.
 603  * Do nothing if table is not EFF_TYPED (it has no sequence number
 604  * then).
 605  * Else, BUF's sequence number must match the one in EP's cache.  If
 606  * it doesn't, we're about to clobber a previous write.
 607  */
 608 static void
 609 new_seqno(struct empfile *ep, void *buf)
 610 {
 611     struct emptypedstr *elt = buf;
 612     unsigned old_seqno;
 613
 614     if (!(ep->flags & EFF_TYPED))
 615         return;
 616     old_seqno = get_seqno(ep, elt->uid);
 617     CANT_HAPPEN(old_seqno != elt->seqno);
 618     elt->seqno = old_seqno + 1;
 619 }
 620
 621 /*
 622  * Make all copies stale.
 623  * Only fresh copies may be written back to the cache.
 624  * To be called by functions that may yield the processor.
 625  * Writing an copy when there has been a yield since it was read is
 626  * unsafe, because we could clobber another thread's write then.
 627  * Robust code must assume the that any function that may yield does
 628  * yield.  Marking copies stale there lets us catch unsafe writes.
 629  */
 630 void
 631 ef_make_stale(void)
 632 {
 633     ef_generation++;
 634 }
 635
 636 /* Mark copy of an element of table TYPE in BUF fresh.  */
 637 void
 638 ef_mark_fresh(int type, void *buf)
 639 {
 640     struct empfile *ep;
 641
 642     if (ef_check(type) < 0)
 643         return;
 644     ep = &empfile[type];
 645     if (!(ep->flags & EFF_TYPED))
 646         return;
 647     ((struct emptypedstr *)buf)->generation = ef_generation;
 648 }
 649
 650 static void
 651 must_be_fresh(struct empfile *ep, void *buf)
 652 {
 653     struct emptypedstr *elt = buf;
 654
 655     if (!(ep->flags & EFF_TYPED))
 656         return;
 657     CANT_HAPPEN(elt->generation != (ef_generation & 0xfff));
 658 }
 659
 660 /*
 661  * Extend table TYPE by COUNT elements.
 662  * Any pointers obtained from ef_ptr() become invalid.
 663  * Return non-zero on success, zero on failure.
 664  */
 665 int
 666 ef_extend(int type, int count)
 667 {
 668     struct empfile *ep;
 669     char *p;
 670     int need_sentinel, i, id;
 671
 672     if (ef_check(type) < 0 || CANT_HAPPEN(EF_IS_VIEW(type)))
 673         return 0;
 674     ep = &empfile[type];
 675     if (CANT_HAPPEN(count < 0))
 676         return 0;
 677
 678     id = ep->fids;
 679     if (ep->flags & EFF_MEM) {
 680         need_sentinel = (ep->flags & EFF_SENTINEL) != 0;
 681         if (id + count + need_sentinel > ep->csize) {
 682             if (ep->flags & EFF_STATIC) {
 683                 logerror("Can't extend %s beyond %d elements",
 684                          ep->name, ep->csize - need_sentinel);
 685                 return 0;
 686             }
 687             if (!ef_realloc_cache(ep, id + count + need_sentinel)) {
 688                 logerror("Can't extend %s to %d elements (%s)",
 689                          ep->name, id + count, strerror(errno));
 690                 return 0;
 691             }
 692         }
 693         p = ep->cache + id * ep->size;
 694         do_blank(ep, p, id, count);
 695         if (ep->fd >= 0) {
 696             if (do_write(ep, p, id, count) < 0)
 697                 return 0;
 698         }
 699         if (need_sentinel)
 700             memset(ep->cache + (id + count) * ep->size, 0, ep->size);
 701         ep->cids = id + count;
 702     } else {
 703         /* need a buffer, steal last cache slot */
 704         if (ep->cids == ep->csize)
 705             ep->cids--;
 706         p = ep->cache + ep->cids * ep->size;
 707         for (i = 0; i < count; i++) {
 708             do_blank(ep, p, id + i, 1);
 709             if (do_write(ep, p, id + i, 1) < 0)
 710                 return 0;
 711         }
 712     }
 713     ep->fids = id + count;
 714     if (ep->onresize)
 715         ep->onresize(type);
 716     return 1;
 717 }
 718
 719 /*
 720  * Initialize element ID for table TYPE in BUF.
 721  * FIXME pass buffer size!
 722  * BUF is marked fresh with ef_mark_fresh().
 723  */
 724 void
 725 ef_blank(int type, int id, void *buf)
 726 {
 727     struct empfile *ep;
 728     struct emptypedstr *elt;
 729
 730     if (ef_check(type) < 0)
 731         return;
 732     ep = &empfile[type];
 733     do_blank(ep, buf, id, 1);
 734     if (ep->flags & EFF_TYPED) {
 735         elt = buf;
 736         elt->seqno = get_seqno(ep, elt->uid);
 737     }
 738     ef_mark_fresh(type, buf);
 739 }
 740
 741 /*
 742  * Initialize COUNT elements of EP in BUF, starting with element ID.
 743  */
 744 static void
 745 do_blank(struct empfile *ep, void *buf, int id, int count)
 746 {
 747     int i;
 748     struct emptypedstr *elt;
 749
 750     memset(buf, 0, count * ep->size);
 751     for (i = 0; i < count; i++) {
 752         elt = (struct emptypedstr *)((char *)buf + i * ep->size);
 753         if (ep->flags & EFF_TYPED) {
 754             elt->ef_type = ep->uid;
 755             elt->uid = id + i;
 756         }
 757         if (ep->oninit)
 758             ep->oninit(elt);
 759     }
 760 }
 761
 762 /*
 763  * Truncate table TYPE to COUNT elements.
 764  * Any pointers obtained from ef_ptr() become invalid.
 765  * Return non-zero on success, zero on failure.
 766  */
 767 int
 768 ef_truncate(int type, int count)
 769 {
 770     struct empfile *ep;
 771     int need_sentinel;
 772
 773     if (ef_check(type) < 0 || CANT_HAPPEN(EF_IS_VIEW(type)))
 774         return 0;
 775     ep = &empfile[type];
 776     if (CANT_HAPPEN(count < 0 || count > ep->fids))
 777         return 0;
 778
 779     if (ep->fd >= 0 && !(ep->flags & EFF_PRIVATE)) {
 780         if (ftruncate(ep->fd, count * ep->size) < 0) {
 781             logerror("Can't truncate %s to %d elements (%s)",
 782                      ep->file, count, strerror(errno));
 783             return 0;
 784         }
 785     }
 786     ep->fids = count;
 787
 788     if (ep->flags & EFF_MEM) {
 789         need_sentinel = (ep->flags & EFF_SENTINEL) != 0;
 790         if (!(ep->flags & EFF_STATIC)) {
 791             if (!ef_realloc_cache(ep, count + need_sentinel)) {
 792                 logerror("Can't shrink %s cache after truncate (%s)",
 793                          ep->name, strerror(errno));
 794                 /* continue with unshrunk cache */
 795             }
 796         }
 797         if (need_sentinel)
 798             memset(ep->cache + count * ep->size, 0, ep->size);
 799         ep->cids = count;
 800     } else {
 801         if (ep->baseid >= count)
 802             ep->cids = 0;
 803         else if (ep->cids > count - ep->baseid)
 804             ep->cids = count - ep->baseid;
 805     }
 806
 807     if (ep->onresize)
 808         ep->onresize(type);
 809     return 1;
 810 }
 811
 812 struct castr *
 813 ef_cadef(int type)
 814 {
 815     if (ef_check(type) < 0)
 816         return NULL;
 817     return empfile[type].cadef;
 818 }
 819
 820 int
 821 ef_nelem(int type)
 822 {
 823     if (ef_check(type) < 0)
 824         return 0;
 825     return empfile[type].fids;
 826 }
 827
 828 int
 829 ef_flags(int type)
 830 {
 831     if (ef_check(type) < 0)
 832         return 0;
 833     return empfile[type].flags;
 834 }
 835
 836 time_t
 837 ef_mtime(int type)
 838 {
 839     if (ef_check(type) < 0)
 840         return 0;
 841     if (empfile[type].fd <= 0)
 842         return 0;
 843     return fdate(empfile[type].fd);
 844 }
 845
 846 /*
 847  * Search for a table matching NAME, return its table type.
 848  * Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
 849  * several.
 850  */
 851 int
 852 ef_byname(char *name)
 853 {
 854     return stmtch(name, empfile, offsetof(struct empfile, name),
 855                   sizeof(empfile[0]));
 856 }
 857
 858 /*
 859  * Search CHOICES[] for a table type matching NAME, return it.
 860  * Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
 861  * several.
 862  * CHOICES[] must be terminated with a negative value.
 863  */
 864 int
 865 ef_byname_from(char *name, int choices[])
 866 {
 867     int res;
 868     int *p;
 869
 870     res = M_NOTFOUND;
 871     for (p = choices; *p >= 0; p++) {
 872         if (ef_check(*p) < 0)
 873             continue;
 874         switch (mineq(name, empfile[*p].name)) {
 875         case ME_MISMATCH:
 876             break;
 877         case ME_PARTIAL:
 878             if (res >= 0)
 879                 return M_NOTUNIQUE;
 880             res = *p;
 881             break;
 882         case ME_EXACT:
 883             return *p;
 884         }
 885     }
 886     return res;
 887 }
 888
 889 char *
 890 ef_nameof(int type)
 891 {
 892     if (ef_check(type) < 0)
 893         return "bad ef_type";
 894     return empfile[type].name;
 895 }
 896
 897 static int
 898 ef_check(int type)
 899 {
 900     if (CANT_HAPPEN((unsigned)type >= EF_MAX))
 901         return -1;
 902     return 0;
 903 }
 904
 905 /*
 906  * Ensure table contains element ID.
 907  * If necessary, extend it in steps of COUNT elements.
 908  * Return non-zero on success, zero on failure.
 909  */
 910 int
 911 ef_ensure_space(int type, int id, int count)
 912 {
 913     if (ef_check(type) < 0)
 914         return 0;
 915     CANT_HAPPEN(id < 0);
 916
 917     while (id >= empfile[type].fids) {
 918         if (!ef_extend(type, count))
 919             return 0;
 920     }
 921     return 1;
 922 }