src/edu/berkeley/sbp/GSS.java

   1 package edu.berkeley.sbp;
   2 import edu.berkeley.sbp.*;
   3 import edu.berkeley.sbp.*;
   4 import edu.berkeley.sbp.*;
   5 import edu.berkeley.sbp.util.*;
   6 import java.io.*;
   7 import java.util.*;
   8 import java.lang.reflect.*;
   9
  10 //////////////////////////////////////////////////////////////////////////////
  11 // TODO:
  12 //
  13 //  - fix public/package/private status
  14 //
  15
  16 //////////////////////////////////////////////////////////////////////////////
  17 // Optimizations to add
  18 //
  19 // ** NOTE: not all of these are appropriate for this class -- it is
  20 //          simply a list of optimizations not implemented.  This
  21 //          class is meant to remain simple and easy to understand;
  22 //          optimizations which obscure that do not belong here (they
  23 //          should go into the compiled version instead)
  24 //
  25 // - most of our time is now spent creating and storing Reduct instances
  26 // - we should be able to perform Reduct's immediately after creating them...
  27 //
  28
  29 /** implements Tomita's Graph Structured Stack */
  30 class GSS {
  31
  32     public GSS() { }
  33
  34     /** corresponds to a positions <i>between tokens</i> the input stream; same as Tomita's U_i's */
  35     public class Phase {
  36
  37         /** the token immediately after this phase */
  38         public  final Token token;
  39
  40         /** currently this is necessary only for the code() hack -- it doesn't actually correspond to the input */
  41         private final int pos;
  42
  43         /** FIXME */
  44         public  Forest.Ref finalResult = null;
  45
  46         /** all reductions (pending and completed) */
  47         private HashSet<Phase.Reduct> reductions = new HashSet<Phase.Reduct>();     /* ALLOC */
  48
  49         /** all nodes, keyed by the value returned by code() */
  50         private HashMap<Long,Phase.Node> hash    = new HashMap<Long,Phase.Node>();  /* ALLOC */
  51
  52         /** the number of pending reductions */
  53         private int pendingReductions = 0;
  54         private int totalReductions = 0;
  55         //private HashSet<Reduct> pendingReduct = new HashSet<Reduct>();
  56         private LinkedList<Reduct> pendingReduct = new LinkedList<Reduct>();
  57
  58         /** the number of nodes in this phase */
  59         private int numNodes = 0;
  60
  61         boolean closed = false;
  62
  63         private Token.Location location;
  64         public Phase(Phase previous, Token token, Token.Location location) {
  65             this.pos = previous==null ? 0 : previous.pos+1;
  66             this.token = token;
  67             this.location = location;
  68         }
  69
  70         public boolean isDone() { return token == null; }
  71
  72         private String error = "generic syntax error";
  73         public void checkFailure() throws Parser.Failed {
  74             if (numNodes <= 0)
  75                 throw new Parser.Failed(error, getLocation());
  76         }
  77
  78         public Token.Location getLocation() { return location; }
  79
  80         /** add a new node (merging with existing nodes if possible)
  81          *  @param parent             the parent of the new node
  82          *  @param result             the SPPF result corresponding to the new node
  83          *  @param state              the state that the new node is in
  84          *  @param fromEmptyReduction true iff this node is being created as a result of a reduction of length zero (see GRMLR paper)
  85          *  @param start              the earliest part of the input contributing to this node (used to make merging decisions)
  86          */
  87         public void newNode(Node parent, Forest pending, Parser.Table.State state, boolean fromEmptyReduction, Phase start) {
  88             Node p = hash.get(code(state, start));
  89             if (p != null)  newNode2(p, parent, pending, state, fromEmptyReduction, start);
  90             else            newNode3(parent, pending, state, fromEmptyReduction, start);
  91         }
  92         private void newNode2(Node p, Node parent, Forest pending, Parser.Table.State state, boolean fromEmptyReduction, Phase start) {
  93             p.holder.merge(pending);
  94             if (p.parents.contains(parent)) return;
  95             p.parents.add(parent, true);
  96             if (p!=parent && !fromEmptyReduction) p.queueReductions(parent);
  97         }
  98         private void newNode3(Node parent, Forest pending, Parser.Table.State state, boolean fromEmptyReduction, Phase start) {
  99             do {
 100                 if (token != null && state.canShift(token)) break;
 101                 if (state.isAccepting()) break;
 102                 if (token==null) break;
 103                 int count = 0;
 104                 Parser.Table.Reduction r = null;
 105                 for(Parser.Table.Reduction red : token==null ? state.getEofReductions() : state.getReductions(token)) { r = red; count++; }
 106                 //if (count==0) return;     // BEWARE! this optimization is suspected to cause really nasty heisenbugs
 107                 //if (count > 1) break;
 108                 //if (r.numPop == 0) break;
 109                 //r.reduce(pending, parent, null, Phase.this, null);
 110                 //return;
 111             } while(false);
 112
 113             Node n = new Node(parent, pending, state, start);  // ALLOC
 114             n.queueEmptyReductions();
 115             if (!fromEmptyReduction) n.queueReductions();
 116         }
 117
 118         /** perform all reduction operations */
 119         public void reduce() {
 120             HashSet<Phase.Node> s = new HashSet<Phase.Node>();
 121             s.addAll(hash.values());
 122             for(Phase.Node n : s) {
 123                 n.queueEmptyReductions();
 124                 n.queueReductions();
 125             }
 126             while(pendingReduct.size()>0)
 127                 //pendingReduct.iterator().next().go();
 128                 pendingReduct.removeFirst().go();
 129         }
 130
 131         /** perform all shift operations, adding promoted nodes to <tt>next</tt> */
 132         public void shift(Phase next, Forest result) {
 133             closed = true;
 134             Forest res = null;
 135             boolean ok = false;
 136             for(Phase.Node n : hash.values()) {
 137                 n.holder.resolve();
 138                 if (token == null && n.state.isAccepting()) {
 139                     ok = true;
 140                     if (finalResult==null) finalResult = new Forest.Ref();
 141                     finalResult.merge(n.holder);
 142                 }
 143                 if (!n.holder.valid()) continue;
 144                 if (token == null) continue;
 145                 for(Parser.Table.State st : n.state.getShifts(token)) {
 146                     if (res == null) res = result;
 147                     next.newNode(n, res, st, true, this);
 148                     ok = true;
 149                 }
 150             }
 151
 152             if (!ok && token != null) {
 153                 StringBuffer error = new StringBuffer();
 154                 error.append("error: unable to shift token \"" + token + "\"\n");
 155                 error.append("  before: " +pendingReductions+ "\n");
 156                 error.append("  before: " +totalReductions+ "\n");
 157                 for(Phase.Node n : hash.values()) {
 158                     n.queueReductions();
 159                     n.queueEmptyReductions();
 160                 }
 161                 error.append("  after: " +pendingReductions+ "\n");
 162                 error.append("  candidate states:\n");
 163                 for(Phase.Node n : hash.values()) {
 164                     //for(Sequence.Position p : n.state) error.append("        " + p + "\n");
 165                     //error.append("        --\n");
 166                     for(Parser.Table.Reduction r : n.state.getReductions(token)) error.append("        " + r + "\n");
 167                     //error.append("        ==\n");
 168                 }
 169                 next.error = error.toString();
 170             }
 171
 172             // this massively improves GC performance
 173             reductions = null;
 174             hash = null;
 175         }
 176
 177
 178         // GSS Nodes //////////////////////////////////////////////////////////////////////////////
 179
 180         //private HashMap<Parser.Table.Reduction,Forest> pcache = new HashMap<Parser.Table.Reduction,Forest>();
 181         /** a node in the GSS */
 182         public final class Node {
 183
 184             private Forest.Ref holder = null;
 185
 186             private HashMap<Parser.Table.Reduction,Forest> cache = null;
 187
 188             /** the set of nodes to which there is an edge starting at this node */
 189             public final FastSet<Node> parents = new FastSet<Node>();  /* ALLOC */
 190
 191             /** what state this node is in */
 192             public final Parser.Table.State state;
 193             /** which Phase this Node belongs to (node that Node is also a non-static inner class of Phase) */
 194             public final Phase phase = Phase.this;
 195
 196             public  HashMap<Parser.Table.Reduction,Forest> cache() {
 197                 return cache==null ? (cache = new HashMap<Parser.Table.Reduction,Forest>()) : cache; }
 198             public  Forest.Ref holder() { return holder==null ? (holder = new Forest.Ref()) : holder; }
 199             public  Forest pending() { return Phase.this.closed ? holder().resolve() : holder; }
 200             public  FastSet<Node> parents() { return parents; }
 201
 202             /** FIXME */
 203             public void queueReductions() {
 204                 for(Node n2 : parents)
 205                     queueReductions(n2);
 206             }
 207
 208             /** FIXME */
 209             public void queueReductions(Node n2) {
 210                 newReduct(this, n2, null);
 211             }
 212
 213
 214             /** FIXME */
 215             public void queueEmptyReductions() {
 216                 for(Parser.Table.Reduction r : token==null ? state.getEofReductions() : state.getReductions(token)) {
 217                     if (r.numPop==0)
 218                         newReduct(this, null, r);   /* ALLOC */
 219                 }
 220             }
 221
 222             private Node(Node parent, Forest pending, Parser.Table.State state, Phase start) {
 223                 this.state = state;
 224                 if (pending != null) this.holder().merge(pending);
 225                 if (parent != null) parents.add(parent, true);
 226                 if (Phase.this.hash.get(code(state, start)) != null) throw new Error("severe problem!");
 227                 Phase.this.hash.put(code(state, start), this);
 228                 Phase.this.numNodes++;
 229                 if (parent==null) holder().valid = true; // hack to make sure that the "base" node is always considered valid
 230             }
 231         }
 232
 233         public void newReduct(Node n, Node n2, Parser.Table.Reduction r) {
 234             new Reduct(n, n2, r)/*.go()*/;
 235         }
 236
 237         // Forest / Completed Reductions //////////////////////////////////////////////////////////////////////////////
 238
 239         /** a pending or completed reduction */
 240         class Reduct {
 241
 242             /** the node from which the reduction should begin */
 243             public Node n = null;
 244
 245             /** the node on the other end of the edge to be reduced along (either: null, the second node of the reduction,
 246              *  or the parent of the result of a length-one reduction)
 247              */
 248             public Node n2 = null;
 249
 250             /** true iff the reduction has already been performed */
 251             private boolean done = false;
 252
 253             /** the reduction to be applied */
 254             public Parser.Table.Reduction r;
 255
 256             public Tree<String> result = null;
 257
 258             public Reduct(Node n, Node n2, Parser.Table.Reduction r) {
 259                 this.n = n;
 260                 this.n2 = n2;
 261                 this.r = r;
 262                 if (reductions.contains(this)) { done = true; return; }
 263                 reductions.add(this);
 264                 pendingReduct.addFirst(this);
 265                 pendingReductions++;
 266             }
 267
 268             /** perform the reduction */
 269             public void go() {
 270                 if (done) return;
 271                 done = true;
 272                 pendingReduct.remove(this);
 273                 pendingReductions--;
 274
 275                 if (r==null)
 276                     for(Parser.Table.Reduction r : token==null ? n.state.getEofReductions() : n.state.getReductions(token)) {
 277
 278                         // currently we have this weird problem where we
 279                         // have to do an individual reduct for each child
 280                         // when the reduction length is one (ie the
 281                         // children wind up being children of the newly
 282                         // created node rather than part of the popped
 283                         // sequence
 284
 285                         if (r.numPop == 1) new Reduct(n, n2, r).go();
 286                     }
 287
 288
 289                 // FIXME: explain this
 290                 if (r==null) {
 291                     for(Parser.Table.Reduction r : token==null ? n.state.getEofReductions() : n.state.getReductions(token)) {
 292                         if (r.numPop <= 1) continue;
 293                         r.reduce(n, n2, Phase.this, null);
 294                     }
 295                 } else if (r.numPop==0) { r.reduce(n, n2, n.phase, r.zero());
 296                 } else if (r.numPop==1) {
 297                     // UGLY HACK
 298                     // The problem here is that a "reduction of length 0/1"
 299                     // performed twice with different values of n2 needs
 300                     // to only create a *single* new result, but must add
 301                     // multiple parents to the node holding that result.
 302                     // The current reducer doesn't differentiate between
 303                     // the next node of an n-pop reduction and the
 304                     // ultimate parent of the last pop, so we need to
 305                     // cache instances here as a way of avoiding
 306                     // recreating them.
 307
 308                     Forest ret = n.cache().get(r);
 309                     if (ret != null) r.reduce(n, n2, n.phase, ret);
 310                     else n.cache().put(r, r.reduce(n, n2, n.phase, null));
 311
 312                 } else {
 313                     r.reduce(n, n2, Phase.this, null);
 314                 }
 315             }
 316
 317             // FIXME: this is a PITA
 318             public int hashCode() { return n.hashCode() ^ (r==null ? 0 : r.hashCode()) ^ (n2==null ? 0 : n2.hashCode()); }
 319             public boolean equals(Object o) {
 320                 if (o==null) return false;
 321                 if (o==this) return true;
 322                 if (!(o instanceof Reduct)) return false;
 323                 Reduct other = (Reduct)o;
 324                 return equal(r, other.r) && equal(n, other.n) && equal(n2, other.n2);
 325             }
 326         }
 327
 328     }
 329
 330     /** helper method */
 331     private static boolean equal(Object a, Object b) {
 332         if (a==null && b==null) return true;
 333         if (a==null || b==null) return false;
 334         return a.equals(b);
 335     }
 336
 337     /** this is something of a hack right now */
 338     private static long code(Parser.Table.State state, Phase start) {
 339         return (((long)state.idx) << 32) | (start==null ? 0 : start.pos);
 340     }
 341
 342 }