]> git.pond.sub.org Git - empserver/blobdiff - src/lib/common/path.c
Permit disabling of A* path cache at compile-time
[empserver] / src / lib / common / path.c
index 99b667a52efb74cbe4921dbd31f1806338d13740..f36d48289645b0885664a4c90033678cf2b2d698 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2005, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *  Copyright (C) 1986-2010, Dave Pare, Jeff Bailey, Thomas Ruschak,
  *                           Ken Stevens, Steve McClure
  *
  *  This program is free software; you can redistribute it and/or modify
  *
  *  ---
  *
- *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
- *  related information and legal notices. It is expected that any future
- *  projects/authors will amend these files as needed.
+ *  See files README, COPYING and CREDITS in the root of the source
+ *  tree for related information and legal notices.  It is expected
+ *  that future projects/authors will amend these files as needed.
  *
  *  ---
  *
  *  path.c: Empire/A* Interface code.
- *          Define AS_STATS for A* statistics.
- * 
+ *
  *  Known contributors to this file:
  *     Phil Lapsley, 1991
  *     Dave Pare, 1991
  *     Steve McClure, 1997
  */
 
+/*
+ * Define AS_STATS for A* statistics on stderr.
+ *
+ * Define AS_NO_PATH_CACHE to disable the path cache.  The path cache
+ * saves a lot of work, but uses lots of memory.  It should be a
+ * significant net win, unless you run out of memory.
+ */
+
+#include <config.h>
+
 #include <stdio.h>
-#include <stdlib.h>
 #include "../as/as.h"
+#include "file.h"
 #include "misc.h"
+#include "optlist.h"
 #include "path.h"
-#include "xy.h"
+#include "prototypes.h"
 #include "sect.h"
-#include "file.h"
-#include "common.h"
-#include "gen.h"
-#include "optlist.h"
+#include "xy.h"
 
-#define        BP_ASHASHSIZE   128     /* A* queue hash table size */
-#define        BP_NEIGHBORS    6       /* max number of neighbors */
+#define BP_ASHASHSIZE  128     /* A* queue hash table size */
+#define BP_NEIGHBORS   6       /* max number of neighbors */
 
 struct bestp {
-    int sctcache_hits;
-    int sctcache_misses;
     int bp_mobtype;
     struct as_data *adp;
 };
 
-static int bp_path(struct as_path *pp, s_char *buf);
-static int bp_neighbors(struct as_coord c, struct as_coord *cp,
-                       s_char *pp);
-static double bp_lbcost(struct as_coord from, struct as_coord to,
-                       s_char *pp);
-static double bp_realcost(struct as_coord from, struct as_coord to,
-                         s_char *pp);
-static double bp_seccost(struct as_coord from, struct as_coord to,
-                        s_char *pp);
+static int bp_path(struct as_path *pp, char *buf);
+static int bp_neighbors(struct as_coord c, struct as_coord *cp, void *);
+static double bp_lbcost(struct as_coord from, struct as_coord to, void *);
+static double bp_realcost(struct as_coord from, struct as_coord to, void *);
+static double bp_seccost(struct as_coord from, struct as_coord to, void *);
 static int bp_coord_hash(struct as_coord c);
 
-struct empfile *ep;
-
 /* We use this for caching neighbors.  It never changes except
  * at reboot time (maybe) so we never need to free it */
-struct sctstr **neighsects = (struct sctstr **)0;
+static struct sctstr **neighsects;
 
-static s_char *
+static struct bestp *
 bp_init(void)
 {
     struct bestp *bp;
 
-    ep = &empfile[EF_SECTOR];
-
-    bp = (struct bestp *)malloc(sizeof(*bp));
+    bp = malloc(sizeof(*bp));
     memset(bp, 0, sizeof(*bp));
     bp->adp = as_init(BP_NEIGHBORS, BP_ASHASHSIZE, bp_coord_hash,
                      bp_neighbors, bp_lbcost, bp_realcost,
-                     bp_seccost, (s_char *)bp);
+                     bp_seccost, bp);
 
     if (bp->adp == NULL)
        return NULL;
 
-    if (neighsects == (struct sctstr **)0)
-       neighsects = (struct sctstr **)calloc(1, (sizeof(struct sctstr *) *
-                                                 ((WORLD_X * WORLD_Y) /
-                                                  2) * 6));
+    if (neighsects == NULL)
+       neighsects = calloc(WORLD_SZ() * 6, sizeof(struct sctstr *));
 
-    return (s_char *)bp;
+    return bp;
 }
 
 /*
  * Find the best path from sector to to sector, and put the Empire movement
  * string in path.  Return 0 on success, -1 on error.
+ * FIXME unsafe by design: assumes path[] has space; buffer overrun
+ * when path gets long!
  */
 static int
-best_path(struct sctstr *from, struct sctstr *to, s_char *path,
-         int mob_type)
+best_path(struct sctstr *from, struct sctstr *to, char *path, int mob_type)
 {
     static struct bestp *mybestpath;
     struct as_data *adp;
     struct as_path *ap;
+    int res;
 
-    if (mybestpath == 0)
-       mybestpath = (struct bestp *)bp_init();
+    if (!mybestpath)
+       mybestpath = bp_init();
     adp = mybestpath->adp;
+#ifdef AS_NO_PATH_CACHE
+    ap = NULL;
+#else
     ap = as_find_cachepath(from->sct_x, from->sct_y, to->sct_x, to->sct_y);
+#endif
     if (ap == NULL) {
        adp->from.x = from->sct_x;
        adp->from.y = from->sct_y;
@@ -121,22 +122,19 @@ best_path(struct sctstr *from, struct sctstr *to, s_char *path,
        adp->to.y = to->sct_y;
        mybestpath->bp_mobtype = mob_type;
 
-       if (as_search(adp) < 0)
+       res = as_search(adp);
+#ifdef AS_STATS
+       as_stats(adp, stderr);
+       fprintf(stderr, "neighbor cache %zu bytes\n",
+               WORLD_SZ() * 6 * sizeof(struct sctstr *));
+#endif
+       if (res < 0)
            return -1;
        ap = adp->path;
     }
 
     if (bp_path(ap, path) < 0)
        return -1;
-
-#ifdef AS_STATS
-    as_stats(adp, stderr);
-#endif /* AS_STATS */
-#ifdef BP_STATS
-    fprintf(stderr, "best path %s\n", path);
-    fprintf(stderr, "cache hits/misses: %d/%d\n",
-           bp->sctcache_hits, bp->sctcache_misses);
-#endif /* BP_STATS */
     return 0;
 }
 
@@ -145,10 +143,10 @@ best_path(struct sctstr *from, struct sctstr *to, s_char *path,
  * success, -1 on failure.
  */
 static int
-bp_path(struct as_path *pp, s_char *buf)
+bp_path(struct as_path *pp, char *buf)
 {
     struct as_path *np;
-    s_char *cp = buf;
+    char *cp = buf;
     int dx, dy;
     int n;
 
@@ -186,36 +184,38 @@ bp_path(struct as_path *pp, s_char *buf)
  * XXX need to check ownership, sector types, etc.
  */
 static int
-bp_neighbors(struct as_coord c, struct as_coord *cp, s_char *pp)
+bp_neighbors(struct as_coord c, struct as_coord *cp, void *pp)
 {
+    struct sctstr *sectp = (void *)empfile[EF_SECTOR].cache;
+    struct bestp *bp = pp;
     coord x, y;
     coord nx, ny;
-    int n = 0, q;
+    int n = 0, i;
     struct sctstr *sp, *from, **ssp;
     /* Six pointers, just in case our cache isn't there */
-    struct sctstr *tsp[] = { 0, 0, 0, 0, 0, 0 };
+    struct sctstr *tsp[] = { NULL, NULL, NULL, NULL, NULL, NULL };
     int sx, sy, offset;
 
     x = c.x;
     y = c.y;
     sx = XNORM(x);
     sy = YNORM(y);
-    offset = (sy * WORLD_X + sx) / 2;
-    from = (struct sctstr *)(ep->cache + ep->size * offset);
+    offset = XYOFFSET(sx, sy);
+    from = &sectp[offset];
 
-    if (neighsects == (struct sctstr **)0)
+    if (neighsects == NULL)
        ssp = (struct sctstr **)&tsp[0];
     else
        ssp = (struct sctstr **)&neighsects[offset * 6];
-    for (q = 1; q <= 6; q++, ssp++) {
-       if (*ssp == (struct sctstr *)0) {
+    for (i = 1; i <= 6; i++, ssp++) {
+       if (*ssp == NULL) {
            /* We haven't cached this neighbor yet */
-           nx = x + diroff[q][0];
-           ny = y + diroff[q][1];
+           nx = x + diroff[i][0];
+           ny = y + diroff[i][1];
            sx = XNORM(nx);
            sy = YNORM(ny);
-           offset = (sy * WORLD_X + sx) / 2;
-           sp = (struct sctstr *)(ep->cache + ep->size * offset);
+           offset = XYOFFSET(sx, sy);
+           sp = &sectp[offset];
            *ssp = sp;
        } else {
            sp = *ssp;
@@ -224,7 +224,9 @@ bp_neighbors(struct as_coord c, struct as_coord *cp, s_char *pp)
        }
        /* No need to calculate cost each time, just make sure we can
           move through it.  We calculate it later. */
-       if (dchr[sp->sct_type].d_mcst == 0)
+       if (dchr[sp->sct_type].d_mob0 < 0)
+           continue;
+       if (bp->bp_mobtype == MOB_RAIL && !SCT_HAS_RAIL(sp))
            continue;
        if (sp->sct_own != from->sct_own)
            continue;
@@ -232,7 +234,7 @@ bp_neighbors(struct as_coord c, struct as_coord *cp, s_char *pp)
        cp[n].y = sy;
        n++;
     }
-    return (n);
+    return n;
 }
 
 /*
@@ -240,30 +242,27 @@ bp_neighbors(struct as_coord c, struct as_coord *cp, s_char *pp)
  */
 /*ARGSUSED*/
 static double
-bp_lbcost(struct as_coord from, struct as_coord to, s_char *pp)
+bp_lbcost(struct as_coord from, struct as_coord to, void *pp)
 {
-    struct bestp *bp = (struct bestp *)pp;
-    struct sctstr *ts;
-    float cost;
+    struct sctstr *sectp = (void *)empfile[EF_SECTOR].cache;
+    struct bestp *bp = pp;
     int x, y, sx, sy, offset;
 
     x = to.x;
     y = to.y;
     sx = XNORM(x);
     sy = YNORM(y);
-    offset = (sy * WORLD_X + sx) / 2;
-    ts = (struct sctstr *)(ep->cache + ep->size * offset);
-    cost = sector_mcost(ts, bp->bp_mobtype);
-    return (cost);
+    offset = XYOFFSET(sx, sy);
+    return sector_mcost(&sectp[offset], bp->bp_mobtype);
 }
 
 /*
  * Compute the real cost to move from "from" to "to".
  */
 static double
-bp_realcost(struct as_coord from, struct as_coord to, s_char *pp)
+bp_realcost(struct as_coord from, struct as_coord to, void *pp)
 {
-    return (bp_lbcost(from, to, pp));
+    return bp_lbcost(from, to, pp);
 }
 
 /*
@@ -272,10 +271,10 @@ bp_realcost(struct as_coord from, struct as_coord to, s_char *pp)
  */
 /*ARGSUSED*/
 static double
-bp_seccost(struct as_coord from, struct as_coord to, s_char *pp)
+bp_seccost(struct as_coord from, struct as_coord to, void *pp)
 {
-    return ((double)mapdist((coord)from.x, (coord)from.y,
-                           (coord)to.x, (coord)to.y));
+    return mapdist((coord)from.x, (coord)from.y,
+                  (coord)to.x, (coord)to.y);
 }
 
 /*
@@ -290,26 +289,34 @@ bp_coord_hash(struct as_coord c)
 void
 bp_enable_cachepath(void)
 {
+#ifndef AS_NO_PATH_CACHE
     as_enable_cachepath();
+#endif
 }
 
 void
 bp_disable_cachepath(void)
 {
+#ifndef AS_NO_PATH_CACHE
     as_disable_cachepath();
+#endif
 }
 
 void
 bp_clear_cachepath(void)
 {
+#ifndef AS_NO_PATH_CACHE
     as_clear_cachepath();
+#endif
 }
 
 double
-pathcost(struct sctstr *start, s_char *path, int mob_type)
+pathcost(struct sctstr *start, char *path, int mob_type)
 {
-    register int o;
-    register int cx, cy;
+    struct sctstr *sectp = (void *)empfile[EF_SECTOR].cache;
+    unsigned i;
+    int o;
+    int cx, cy;
     double cost = 0.0;
     struct sctstr *sp;
     int sx, sy, offset;
@@ -322,13 +329,18 @@ pathcost(struct sctstr *start, s_char *path, int mob_type)
            path++;
            continue;
        }
-       o = dirindex[(int)((*path) - 'a')];
+       i = *path - 'a';
+       if (CANT_HAPPEN(i >= sizeof(dirindex) / sizeof(*dirindex)))
+           break;
+       o = dirindex[i];
+       if (CANT_HAPPEN(o < 0))
+           break;
        cx += diroff[o][0];
        cy += diroff[o][1];
        sx = XNORM(cx);
        sy = YNORM(cy);
-       offset = (sy * WORLD_X + sx) / 2;
-       sp = (struct sctstr *)(ep->cache + ep->size * offset);
+       offset = XYOFFSET(sx, sy);
+       sp = &sectp[offset];
        cost += sector_mcost(sp, mob_type);
        path++;
     }
@@ -336,16 +348,16 @@ pathcost(struct sctstr *start, s_char *path, int mob_type)
     return cost;
 }
 
-s_char *
-BestDistPath(s_char *path,
+char *
+BestDistPath(char *path,
             struct sctstr *from,
-            struct sctstr *to, double *cost, int mob_type)
+            struct sctstr *to, double *cost)
 {
-    return BestLandPath(path, from, to, cost, mob_type);
+    return BestLandPath(path, from, to, cost, MOB_MOVE);
 }
 
-s_char *
-BestLandPath(s_char *path,
+char *
+BestLandPath(char *path,
             struct sctstr *from,
             struct sctstr *to, double *cost, int mob_type)
 {
@@ -354,7 +366,7 @@ BestLandPath(s_char *path,
     *path = 0;
     *cost = 0.0;
     if (best_path(from, to, path, mob_type) < 0)
-       return (s_char *)0;
+       return NULL;
     *cost = pathcost(from, path, mob_type);
     length = strlen(path);
     path[length] = 'h';
@@ -362,20 +374,19 @@ BestLandPath(s_char *path,
     return path;
 }
 
-s_char *
-BestShipPath(s_char *path, int fx, int fy, int tx, int ty, int owner)
+char *
+BestShipPath(char *path, int fx, int fy, int tx, int ty, int owner)
 {
-    s_char *map;
+    char *map;
 
-    /* need to make sector database available to bestpath */
     map = ef_ptr(EF_BMAP, owner);
-
-    return (bestownedpath(path, map, fx, fy, tx, ty, ".=h", owner));
+    if (!map)
+       return NULL;
+    return bestownedpath(path, map, fx, fy, tx, ty, owner);
 }
 
-s_char *
-BestAirPath(s_char *path, int fx, int fy, int tx, int ty)
+char *
+BestAirPath(char *path, int fx, int fy, int tx, int ty)
 {
-    return (bestownedpath(path, 0, fx, fy, tx, ty, "", -1));
-    /*    return (bestpath(path, fx, fy, tx, ty, "")); */
+    return bestownedpath(path, NULL, fx, fy, tx, ty, -1);
 }