checkpoint
[sbp.git] / 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 /** implements Tomita's Graph Structured Stack */
26 class GSS {
27
28     public GSS() { }
29
30     private Phase.Node[] reducing_list = null;
31
32     /** corresponds to a positions <i>between tokens</i> the input stream; same as Tomita's U_i's */
33     public class Phase {
34
35         /** the token immediately after this phase */
36         public  final Token token;
37
38         boolean reducing = false;
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 nodes, keyed by the value returned by code() */
47         private HashMap<Long,Phase.Node> hash    = new HashMap<Long,Phase.Node>();  /* ALLOC */
48
49         /** the number of nodes in this phase */
50         private int numNodes = 0;
51
52         boolean closed = false;
53
54         private Token.Location location;
55         public Phase(Phase previous, Token token, Token.Location location) {
56             this.pos = previous==null ? 0 : previous.pos+1;
57             this.token = token;
58             this.location = location;
59         }
60
61         public boolean isDone() { return token == null; }
62
63         private String error = "generic syntax error";
64         public void checkFailure() throws Parser.Failed {
65             if (numNodes <= 0)
66                 throw new Parser.Failed(error, getLocation());
67         }
68
69         public Token.Location getLocation() { return location; }
70
71         /** add a new node (merging with existing nodes if possible)
72          *  @param parent             the parent of the new node
73          *  @param result             the SPPF result corresponding to the new node
74          *  @param state              the state that the new node is in
75          *  @param fromEmptyReduction true iff this node is being created as a result of a reduction of length zero (see GRMLR paper)
76          *  @param start              the earliest part of the input contributing to this node (used to make merging decisions)
77          */
78         public void newNode(Node parent, Forest pending, Parser.Table.State state, boolean fromEmptyReduction, Phase start) {
79             Node p = hash.get(code(state, start));
80             if (p != null)  newNode2(p, parent, pending, state, fromEmptyReduction, start);
81             else            newNode3(parent, pending, state, fromEmptyReduction, start);
82         }
83         private void newNode2(Node p, Node parent, Forest pending, Parser.Table.State state, boolean fromEmptyReduction, Phase start) {
84             p.holder.merge(pending);
85             if (p.parents().contains(parent)) return;
86             p.addParent(parent, fromEmptyReduction);
87         }
88         private void newNode3(Node parent, Forest pending, Parser.Table.State state, boolean fromEmptyReduction, Phase start) {
89             do {
90                 if (token != null && state.canShift(token)) break;
91                 if (state.isAccepting()) break;
92                 if (token==null) break;
93                 int count = 0;
94                 Parser.Table.Reduction r = null;
95                 for(Parser.Table.Reduction red : token==null ? state.getEofReductions() : state.getReductions(token)) { r = red; count++; }
96                 if (count==0) return;     // BEWARE! this optimization is suspected to cause really nasty heisenbugs
97                 //if (count > 1) break;
98                 //if (r.numPop == 0) break;
99                 //r.reduce(pending, parent, null, Phase.this, null);
100                 //return;
101             } while(false);
102
103             Node n = new Node(parent, pending, state, start);  // ALLOC
104             n.queueEmptyReductions();
105             if (!fromEmptyReduction) n.queueReductions(parent);
106         }
107
108         
109         /** perform all reduction operations */
110         public void reduce() {
111             reducing = true;
112             if (reducing_list==null || reducing_list.length < hash.size())
113                 reducing_list = new Phase.Node[hash.size() * 4];
114             Collection<Node> hv = hash.values();
115             hv.toArray(reducing_list);
116             int num = hv.size();
117             for(int i=0; i<num; i++) {
118                 Node n = reducing_list[i];
119                 n.queueEmptyReductions();
120                 // INVARIANT: we never "see" a node until its parent-set is complete, modulo merges
121             }
122             for(int i=0; i<num; i++) {
123                 Node n = reducing_list[i];
124                 reducing_list[i] = null;
125                 n.queueReductions();
126             }
127         }
128
129         /** perform all shift operations, adding promoted nodes to <tt>next</tt> */
130         public void shift(Phase next, Forest result) {
131             closed = true;
132             Forest res = null;
133             boolean ok = false;
134             for(Phase.Node n : hash.values()) {
135                 if (n.holder==null) continue;
136                 n.holder.resolve();
137                 if (token == null && n.state.isAccepting()) {
138                     ok = true;
139                     if (finalResult==null) finalResult = new Forest.Ref();
140                     finalResult.merge(n.holder);
141                 }
142                 if (!n.holder.valid()) continue;
143                 if (token == null) continue;
144                 for(Parser.Table.State st : n.state.getShifts(token)) {
145                     if (res == null) res = result;
146                     next.newNode(n, res, st, true, this);
147                     ok = true;
148                 }
149             }
150
151             if (!ok && token != null) {
152                 StringBuffer error = new StringBuffer();
153                 error.append("error: unable to shift token \"" + token + "\"\n");
154                 //error.append("  before: " +pendingReductions+ "\n");
155                 //error.append("  before: " +totalReductions+ "\n");
156                 //for(Phase.Node n : hash.values()) {
157                 //n.queueReductions();
158                 //n.queueEmptyReductions();
159                 //}
160                 //error.append("  after: " +pendingReductions+ "\n");
161                 //error.append("  candidate states:\n");
162                 //for(Phase.Node n : hash.values()) {
163                     //for(Sequence.Position p : n.state) error.append("        " + p + "\n");
164                     //error.append("        --\n");
165                 //for(Parser.Table.Reduction r : n.state.getReductions(token)) error.append("        " + r + "\n");
166                     //error.append("        ==\n");
167                 //}
168                 next.error = error.toString();
169             }
170
171             // this massively improves GC performance
172             hash = null;
173         }
174
175        
176         // GSS Nodes //////////////////////////////////////////////////////////////////////////////
177
178         /** a node in the GSS */
179         public final class Node extends FastSet<Node> {
180
181             public void addParent(Node parent, boolean fromEmptyReduction) {
182                 parents().add(parent, true);
183                 if (this!=parent && !fromEmptyReduction) queueReductions(parent);
184             }
185
186             private Forest.Ref holder = null;
187             private boolean allqueued = false;
188
189             /** the set of nodes to which there is an edge starting at this node */
190             //public final FastSet<Node> parents = new FastSet<Node>();  /* ALLOC */
191
192             /** what state this node is in */
193             public final Parser.Table.State state;
194
195             /** which Phase this Node belongs to (node that Node is also a non-static inner class of Phase) */
196             public Phase phase() { return Phase.this; }
197
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 this; }
201
202             public void queueReductions() {
203                 if (allqueued) return;
204                 allqueued = true;
205                 int where = parents().size();
206                 for(Parser.Table.Reduction r : state.getReductions(token))
207                     if (r.numPop >= 1)
208                         r.reduce(this, null, null);
209             }
210
211             public void queueReductions(Node n2) {
212                 if (!allqueued) { queueReductions(); return; }
213                 for(Parser.Table.Reduction r : state.getReductions(token))
214                     if (r.numPop > 0)
215                         r.reduce(this, n2, null);
216             }
217
218
219             public void queueEmptyReductions() {
220                 if (reducing)
221                     for(Parser.Table.Reduction r : token==null ? state.getEofReductions() : state.getReductions(token))
222                         if (r.numPop==0)
223                             r.reduce(this, null, r.zero());
224             }
225
226             private Node(Node parent, Forest pending, Parser.Table.State state, Phase start) {
227                 this.state = state;
228                 if (pending != null) this.holder().merge(pending);
229                 if (parent != null) parents().add(parent, true);
230                 if (Phase.this.hash.get(code(state, start)) != null) throw new Error("severe problem!");
231                 Phase.this.hash.put(code(state, start), this);
232                 Phase.this.numNodes++;
233                 if (parent==null) holder().valid = true; // hack to make sure that the "base" node is always considered valid
234             }
235         }
236
237     }
238
239     /** helper method */
240     private static boolean equal(Object a, Object b) {
241         if (a==null && b==null) return true;
242         if (a==null || b==null) return false;
243         return a.equals(b);
244     }
245
246     /** this is something of a hack right now */
247     private static long code(Parser.Table.State state, Phase start) {
248         return (((long)state.idx) << 32) | (start==null ? 0 : start.pos);
249     }
250 }