ba3ebfefd0642ccacd0403b636e24e5c3176c9f9
[fleet.git] / src / edu / berkeley / fleet / two / FleetTwoFleet.java
1 package edu.berkeley.fleet.two;
2 import java.io.*;
3 import edu.berkeley.fleet.api.*;
4 import edu.berkeley.fleet.util.*;
5 import edu.berkeley.fleet.api.Instruction.Set;
6 import static edu.berkeley.fleet.api.Instruction.Set.*;
7 import static edu.berkeley.fleet.api.Instruction.*;
8 import static edu.berkeley.fleet.api.Predicate.*;
9
10 /** common subclass for the "FleetTwo" generation of processors, all 37-bit wide, with AM33 encoding */
11 public abstract class FleetTwoFleet extends Fleet {
12
13     private final boolean hack = "true".equals(System.getProperty("inverted-dc-bit-hack", "false"));
14
15     public final Mask PACKET_TOKEN;
16     public final Mask PACKET_IS_TOKEN;
17     public final Mask PACKET_DATA;
18     public final Mask PACKET_SIGNAL;
19     public final Mask PACKET_DEST;
20
21     public final Mask CBD_SIZE;
22     public final Mask CBD_OFFSET;
23
24     public final Mask WHOLE_WORD;
25     public final Mask DISPATCH_PATH;
26     public final Mask DISPATCH_INSTR;
27     public final Mask NOT_INTERRUPTIBLE;
28     public final Mask IS_INTERRUPTIBLE;
29     public final Mask P;
30     public final Mask P_NOT_A;
31     public final Mask P_A;
32     public final Mask P_NOT_B;
33     public final Mask P_B;
34     public final Mask P_UNUSED;
35     public final Mask P_OLC_ZERO;
36     public final Mask P_OLC_NONZERO;
37     public final Mask P_ALWAYS;
38
39     public final Mask SHIFT;
40
41     public final Mask TAIL;
42     public final Mask HEAD;
43     public final Mask ABORT;
44
45     public final Mask MOVE;
46     public final Mask TI;
47     public final Mask DI;
48     public final Mask FLUSH;
49     public final Mask DC;
50     public final Mask DO;
51     public final Mask TO;
52     public final Mask PATH_IMMEDIATE;
53     public final Mask PATH_DATA;
54     public final Mask PATH_NOCHANGE;
55
56     public final Mask SET_OLC_FROM_IMMEDIATE;
57     public final Mask SET_OLC_FROM_DATA_LATCH;
58     public final Mask SET_OLC_FROM_OLC_MINUS_ONE;
59
60     public final Mask SET_ILC_FROM_IMMEDIATE;
61     public final Mask SET_ILC_FROM_INFINITY;
62     public final Mask SET_ILC_FROM_DATA_LATCH;
63
64     public final Mask SET_IMMEDIATE;
65     public final Mask SET_IMMEDIATE_EXTEND;
66
67     public final Mask SET_FLAGS;
68     public final Mask SET_FLAGS_A;
69     public final Mask SET_FLAGS_B;
70     public final Mask SET_FLAGS_VALUE_A;
71     public final Mask SET_FLAGS_VALUE_NOT_A;
72     public final Mask SET_FLAGS_VALUE_B;
73     public final Mask SET_FLAGS_VALUE_NOT_B;
74     public final Mask SET_FLAGS_VALUE_C;
75     public final Mask SET_FLAGS_VALUE_NOT_C;
76
77     public final int  WIDTH_WORD;
78     public final int  WIDTH_PACKET;
79
80     public final int DataLatch_WIDTH;
81     private final long mask;
82
83     public FleetTwoFleet() { this(false); }
84
85     public FleetTwoFleet(boolean useInternalEncoding) {
86         PACKET_TOKEN               = new Mask("v.................................................");
87         PACKET_IS_TOKEN            = new Mask("1.................................................");
88         PACKET_DATA                = new Mask(".vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv............");
89         PACKET_SIGNAL              = new Mask("......................................v...........");
90         PACKET_DEST                = new Mask(".......................................vvvvvvvvvvv");
91
92         CBD_SIZE                   = new Mask("...............................vvvvvv");
93         CBD_OFFSET                 = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv......");
94
95         WHOLE_WORD                 = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
96
97         if (useInternalEncoding) {
98
99             DISPATCH_PATH              = new Mask("v....................................");
100             DISPATCH_INSTR             = new Mask(".vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
101             P                          = new Mask(".vvvvvv..............................");
102             P_NOT_A                    = new Mask(".100001..............................");
103             P_A                        = new Mask(".100010..............................");
104             P_NOT_B                    = new Mask(".100100..............................");
105             P_B                        = new Mask(".101000..............................");
106             P_UNUSED                   = new Mask(".111111..............................");
107             P_OLC_ZERO                 = new Mask(".010000..............................");
108             P_OLC_NONZERO              = new Mask(".100000..............................");
109             P_ALWAYS                   = new Mask(".000000..............................");
110
111
112             // use these when Marina gets updated to 07-Jan-2009 version of internal encoding
113             HEAD                       = new Mask(".......1.............................");
114             ABORT                      = new Mask("........1............................");
115             TAIL                       = new Mask(".........1...........................");
116
117             // actually "is interruptible"
118             NOT_INTERRUPTIBLE          = new Mask("...........0....0....................");
119             IS_INTERRUPTIBLE           = new Mask("...........1....1....................");
120
121             SHIFT                      = new Mask("..........1......1vvvvvvvvvvvvvvvvvvv");
122             SET_IMMEDIATE              = new Mask("..........1......0.....vvvvvvvvvvvvvv");
123             SET_IMMEDIATE_EXTEND       = new Mask("..........1......0....v..............");
124             MOVE                       = new Mask("............1........................");
125             TI                         = new Mask("............1.....1..................");
126             DI                         = new Mask("............1......1.................");
127             FLUSH                      = new Mask("..........1......0.....011...........");
128             DC                         = new Mask("............1.......1................");
129             DO                         = new Mask("............1........1...............");
130             TO                         = new Mask("............1.........1..............");
131             PATH_IMMEDIATE             = new Mask("............1..........1vvvvvvvvvvvvv");
132             PATH_DATA                  = new Mask("............1..........00............");
133             PATH_NOCHANGE              = new Mask("............1..........01............");
134
135             SET_OLC_FROM_IMMEDIATE     = new Mask("..............1.10.............vvvvvv");
136             SET_OLC_FROM_DATA_LATCH    = new Mask("...............1.11..................");
137             SET_OLC_FROM_OLC_MINUS_ONE = new Mask("...............1.10..................");
138
139             SET_ILC_FROM_IMMEDIATE     = new Mask("...............1.00..........0.vvvvvv");
140             SET_ILC_FROM_INFINITY      = new Mask("...............1.0...........1.......");
141             SET_ILC_FROM_DATA_LATCH    = new Mask("...............1.01..................");
142
143             SET_FLAGS                  = new Mask("...............1.....................");
144             SET_FLAGS_A                = new Mask("...............1...............vvvvvv");
145             SET_FLAGS_B                = new Mask("...............1.........vvvvvv......");
146
147             SET_FLAGS_VALUE_A          = new Mask(".....1");
148             SET_FLAGS_VALUE_NOT_A      = new Mask("....1.");
149             SET_FLAGS_VALUE_B          = new Mask("...1..");
150             SET_FLAGS_VALUE_NOT_B      = new Mask("..1...");
151             SET_FLAGS_VALUE_C          = new Mask(".1....");
152             SET_FLAGS_VALUE_NOT_C      = new Mask("1.....");
153
154         } else {
155             DISPATCH_PATH              = new Mask("vvvvvvvvvvv..........................");
156             DISPATCH_INSTR             = new Mask("...........vvvvvvvvvvvvvvvvvvvvvvvvvv");
157             NOT_INTERRUPTIBLE          = new Mask("...........1.........................");
158             IS_INTERRUPTIBLE           = new Mask("...........0.........................");
159             P                          = new Mask(".............vvv.....................");
160             P_NOT_A                    = new Mask(".............000.....................");
161             P_A                        = new Mask(".............001.....................");
162             P_NOT_B                    = new Mask(".............010.....................");
163             P_B                        = new Mask(".............011.....................");
164             P_UNUSED                   = new Mask(".............100.....................");
165             P_OLC_ZERO                 = new Mask(".............101.....................");
166             P_OLC_NONZERO              = new Mask(".............110.....................");
167             P_ALWAYS                   = new Mask(".............111.....................");
168
169             SHIFT                      = new Mask("................00vvvvvvvvvvvvvvvvvvv");
170
171             ABORT                      = new Mask("................1100.................");  // note: has a predicate!
172
173             HEAD                       = new Mask("................1110.................");
174             TAIL                       = new Mask("................1111.................");
175
176             MOVE                       = new Mask("................01...................");
177             TI                         = new Mask("................011..................");
178             DI                         = new Mask("................01.1.................");
179             FLUSH                      = new Mask("................01.01................");
180             DC                         = new Mask("................01.11................");
181             DO                         = new Mask("................01...1...............");
182             TO                         = new Mask("................01....1..............");
183             PATH_IMMEDIATE             = new Mask("................01.....1vvvvvvvvvvvvv");
184             PATH_DATA                  = new Mask("................01.....01............");
185             PATH_NOCHANGE              = new Mask("................01.....00............");
186
187             SET_OLC_FROM_IMMEDIATE     = new Mask("................101000100......vvvvvv");
188             SET_OLC_FROM_DATA_LATCH    = new Mask("................101000010............");
189             SET_OLC_FROM_OLC_MINUS_ONE = new Mask("................101000001............");
190
191             SET_ILC_FROM_IMMEDIATE     = new Mask("................10010010......0vvvvvv");
192             SET_ILC_FROM_INFINITY      = new Mask("................10010010......1......");
193             SET_ILC_FROM_DATA_LATCH    = new Mask("................10010001.............");
194
195             SET_IMMEDIATE              = new Mask("................100010.vvvvvvvvvvvvvv");
196             SET_IMMEDIATE_EXTEND       = new Mask("................100010v..............");
197
198             SET_FLAGS                  = new Mask("................100001...............");
199             SET_FLAGS_A                = new Mask("................100001...vvvvvv......");
200             SET_FLAGS_B                = new Mask("................100001.........vvvvvv");
201
202             SET_FLAGS_VALUE_A          = new Mask("1.....");
203             SET_FLAGS_VALUE_NOT_A      = new Mask(".1....");
204             SET_FLAGS_VALUE_B          = new Mask("..1...");
205             SET_FLAGS_VALUE_NOT_B      = new Mask("...1..");
206             SET_FLAGS_VALUE_C          = new Mask("....1.");
207             SET_FLAGS_VALUE_NOT_C      = new Mask(".....1");
208         }
209
210         WIDTH_WORD                 = PACKET_DATA.valmaskwidth;
211         WIDTH_PACKET               = PACKET_TOKEN.width;
212         DataLatch_WIDTH = SET_IMMEDIATE.valmaskmax-SET_IMMEDIATE.valmaskmin+1;  // FIXME: this is an abstraction breakage
213         mask  = ~(-1L << DataLatch_WIDTH);
214     }
215
216     // Misc //////////////////////////////////////////////////////////////////////////////
217
218     public boolean isSmallEnoughToFit(long immediate) {
219         if ((immediate & ~mask) == 0)   return true;
220         if ((immediate |  mask) == -1L) return true;
221         return false;
222     }
223
224     public boolean isSmallEnoughToFit(BitVector immediate) {
225         boolean b = immediate.get((int)DataLatch_WIDTH);
226         for(int i=DataLatch_WIDTH+1; i<immediate.length(); i++)
227             if (immediate.get(i) != b) return false;
228         return true;
229     }
230
231     public int getWordWidth() { return 37; }
232
233     //////////////////////////////////////////////////////////////////////////////
234
235     /** get the bits describing this box's location on the DESTINATION HORN */
236     protected abstract BitVector getDestAddr(Path box);
237
238     private static final BitVector SIGNAL_ZERO = new BitVector(1);
239     private static final BitVector SIGNAL_ONE  = new BitVector(1).set(0,true);
240
241     /** decode a path, given the starting point and the bits that comprise it */
242     public Path getPathByAddr(Dock source, BitVector dest) {
243         for(Ship ship : this)
244             for(Dock bb : ship) {
245                 for(Destination d : new Destination[] { bb.getInstructionDestination(), bb.getDataDestination() }) {
246                     for(BitVector signal : new BitVector[] { SIGNAL_ZERO, SIGNAL_ONE }) {
247                         Path p = (Path)source.getPath(d, signal);
248                         if (getDestAddr(p).equalsZeroExtended(dest)) return p;
249                     }
250                 }
251             }
252         return null;
253     }
254
255     public Instruction decodeInstruction(BitVector instruction, Dock dispatchFrom) {
256         return readInstruction(instruction.toLong(), dispatchFrom);
257     }
258
259     public BitVector   encodeInstruction(Instruction instr, Dock dispatchFrom) {
260         return new BitVector(getWordWidth()).set(writeInstruction(instr, dispatchFrom));
261     }
262
263     public int getShiftWidth() { return SHIFT.valmaskwidth; }
264     public int getSetWidth() { return SET_IMMEDIATE.valmaskwidth+1; }
265
266     // FIXME: should use BitVector here
267     public Instruction readInstruction(long inst, Dock dispatchFrom) {
268         Dock dock = getPathByAddr(dispatchFrom, DISPATCH_PATH.getvalAsBitVector(inst)).getDestination().getDock();
269
270         if (TAIL.get(inst))   return new Tail(dock);
271         if (HEAD.get(inst))   return new Head(dock);
272
273         Predicate predicate = Default;
274         if (P_ALWAYS.get(inst)) predicate = IgnoreFlagD;
275         if (P_OLC_NONZERO.get(inst))    predicate = Default;
276         if (P_OLC_ZERO.get(inst))    predicate = FlagD;
277         if (P_A.get(inst))      predicate = FlagA;
278         if (P_B.get(inst))      predicate = FlagB;
279         if (P_NOT_A.get(inst))  predicate = NotFlagA;
280         if (P_NOT_B.get(inst))  predicate = NotFlagB;
281
282         if (FLUSH.get(inst))
283             return new Flush(dock, predicate);
284         if (ABORT.get(inst))
285             return new Abort(dock, predicate);
286         if (SHIFT.get(inst))                return new Shift(dock, predicate, new BitVector(dock.getShip().getFleet().getShiftWidth()).set(SHIFT.getval(inst)));
287         if (SET_IMMEDIATE.get(inst)) {
288             boolean extend = SET_IMMEDIATE_EXTEND.getval(inst) != 0;
289             long immediate = SET_IMMEDIATE.getval(inst);
290             if (extend) immediate |= (-1L << DataLatch_WIDTH);
291             return new Set(dock, predicate, SetDest.DataLatch, (immediate));
292         }
293
294         if (SET_OLC_FROM_OLC_MINUS_ONE.get(inst))
295             return new Set(dock, predicate, SetDest.OuterLoopCounter, SetSource.Decrement);
296         if (SET_OLC_FROM_IMMEDIATE.get(inst))
297             return new Set(dock, predicate, SetDest.OuterLoopCounter, (SET_OLC_FROM_IMMEDIATE.getval(inst)));
298         if (SET_ILC_FROM_IMMEDIATE.get(inst))
299             return new Set(dock, predicate, SetDest.InnerLoopCounter, (SET_ILC_FROM_IMMEDIATE.getval(inst)));
300         if (SET_OLC_FROM_DATA_LATCH.get(inst))
301             return new Set(dock, predicate, SetDest.OuterLoopCounter, SetSource.DataLatch);
302         if (SET_ILC_FROM_DATA_LATCH.get(inst))
303             return new Set(dock, predicate, SetDest.InnerLoopCounter, SetSource.DataLatch);
304         if (SET_ILC_FROM_INFINITY.get(inst))
305             return new Set(dock, predicate, SetDest.InnerLoopCounter, SetSource.Infinity);
306         if (SET_FLAGS.get(inst)) {
307             long flag_a = SET_FLAGS_A.getval(inst);
308             long flag_b = SET_FLAGS_B.getval(inst);
309             FlagFunction ap = FlagFunction.ZERO;
310             FlagFunction bp = FlagFunction.ZERO;
311             if (SET_FLAGS_VALUE_A    .get(flag_a)) ap = ap.add(FlagA    );
312             if (SET_FLAGS_VALUE_NOT_A.get(flag_a)) ap = ap.add(NotFlagA );
313             if (SET_FLAGS_VALUE_B    .get(flag_a)) ap = ap.add(FlagB    );
314             if (SET_FLAGS_VALUE_NOT_B.get(flag_a)) ap = ap.add(NotFlagB );
315             if (SET_FLAGS_VALUE_C    .get(flag_a)) ap = ap.add(FlagC    );
316             if (SET_FLAGS_VALUE_NOT_C.get(flag_a)) ap = ap.add(NotFlagC );
317             if (SET_FLAGS_VALUE_A    .get(flag_b)) bp = bp.add(FlagA    );
318             if (SET_FLAGS_VALUE_NOT_A.get(flag_b)) bp = bp.add(NotFlagA );
319             if (SET_FLAGS_VALUE_B    .get(flag_b)) bp = bp.add(FlagB    );
320             if (SET_FLAGS_VALUE_NOT_B.get(flag_b)) bp = bp.add(NotFlagB );
321             if (SET_FLAGS_VALUE_C    .get(flag_b)) bp = bp.add(FlagC    );
322             if (SET_FLAGS_VALUE_NOT_C.get(flag_b)) bp = bp.add(NotFlagC );
323             return new Set(dock,  predicate, ap, bp);
324         }
325         if (MOVE.get(inst))
326             return new Move(dock,
327                             predicate,
328                             !NOT_INTERRUPTIBLE.get(inst),
329                             PATH_DATA.get(inst)?null:getPathByAddr(dock, PATH_IMMEDIATE.getvalAsBitVector(inst)),
330                             TI.get(inst),
331                             DI.get(inst),
332                             hack?(!DC.get(inst)):DC.get(inst),
333                             PATH_DATA.get(inst),
334                             DO.get(inst),
335                             TO.get(inst)
336                             );
337         throw new RuntimeException("unknown instruction: 0x" + Long.toString(inst, 16));
338     }
339
340     // FIXME: should use BitVector here
341     public long writeInstruction(Instruction d, Dock dispatchFrom) {
342         long instr = 0;
343
344         if (d.dock != null) {
345             BitVector bv = getDestAddr(dispatchFrom.getPath(d.dock.getInstructionDestination(),null));
346             BitVector bv2 = new BitVector(DISPATCH_PATH.valmaskwidth);
347             for(int i=0; i<Math.min(bv.length(),bv2.length()); i++)
348                 bv2.set(i, bv.get(i));
349             instr = DISPATCH_PATH.setval(instr, bv2);
350         }
351
352         boolean dl = false;
353         Instruction pi = d;
354         switch(pi.predicate) {
355             case IgnoreFlagD:         instr = P_ALWAYS.set(instr); break;
356             case FlagD:         instr = P_OLC_ZERO.set(instr); break;
357             case Default: instr = P_OLC_NONZERO.set(instr); break;
358             case FlagA:      instr = P_A.set(instr);      break;
359             case FlagB:      instr = P_B.set(instr);      break;
360             case NotFlagA:  instr = P_NOT_A.set(instr);      break;
361             case NotFlagB:  instr = P_NOT_B.set(instr);      break;
362             default: throw new RuntimeException("error!");
363         }
364
365         if (d instanceof Tail) {
366             instr = TAIL.set(instr);
367
368         } else if (d instanceof Head) {
369             instr = HEAD.set(instr);
370
371         } else if (d instanceof Shift) {
372             Shift shift = (Shift)d;
373             instr = SHIFT.set(instr);
374             instr = SHIFT.setval(instr, shift.immediate.getBitVector());
375
376         } else if (d instanceof Flush) {
377             instr = FLUSH.set(instr);
378
379         } else if (d instanceof Abort) {
380             instr = ABORT.set(instr);
381
382         } else if (d instanceof Set) {
383             Set s = (Set)d;
384             switch(s.dest) {
385                 case InnerLoopCounter:
386                     switch(s.source) {
387                         case DataLatch:
388                             instr = SET_ILC_FROM_DATA_LATCH.set(instr);
389                             break;
390                         case Immediate:
391                             instr = SET_ILC_FROM_IMMEDIATE.setval(SET_ILC_FROM_IMMEDIATE.set(instr), s.immediate);
392                             break;
393                         case Infinity:
394                             instr = SET_ILC_FROM_INFINITY.set(instr);
395                             break;
396                     }
397                     break;
398                 case OuterLoopCounter:
399                     switch(s.source) {
400                         case Decrement:
401                             instr = SET_OLC_FROM_OLC_MINUS_ONE.set(instr);
402                             break;
403                         case DataLatch:
404                             instr = SET_OLC_FROM_DATA_LATCH.set(instr);
405                             break;
406                         case Immediate:
407                             instr = SET_OLC_FROM_IMMEDIATE.setval(SET_OLC_FROM_IMMEDIATE.set(instr), s.immediate);
408                             break;
409                     }
410                     break;
411                 case Flags: {
412                     instr = SET_FLAGS.set(instr);
413                     instr = SET_FLAGS_A.setval(instr, flagFunctionToLong(s.newFlagA));
414                     instr = SET_FLAGS_B.setval(instr, flagFunctionToLong(s.newFlagB));
415                     break;
416                 }
417                 case DataLatch: {
418                     instr = SET_IMMEDIATE.set(instr);
419                     instr = SET_IMMEDIATE_EXTEND.setval(instr, s.immediate < 0 ? 1 : 0);
420                     instr = SET_IMMEDIATE.setval(instr, s.immediate & ~(-1L << DataLatch_WIDTH));
421                     break;
422                 }
423             }
424
425         } else if (d instanceof Move) {
426             Move inst = (Move)d;
427             instr  = MOVE.set(instr);
428             if (inst.tokenIn)                    instr = TI.set(instr);
429             if (inst.dataIn)                     instr = DI.set(instr);
430             if (hack) {
431                 if (!inst.latchData)                 instr = DC.set(instr);
432                 System.err.println("WARNING: employing inverted-Dc-bit hack -- DO NOT FORGET TO DISABLE THIS WHEN THE NETLIST GETS UPDATED!");
433             } else {
434                 if (inst.latchData)                  instr = DC.set(instr);
435             }
436             if (inst.dataOut)                    instr = DO.set(instr);
437             if (inst.tokenOut)                   instr = TO.set(instr);
438             if (!inst.interruptible)             instr = NOT_INTERRUPTIBLE.set(instr);
439             else                                 instr = IS_INTERRUPTIBLE.set(instr);
440
441             if (inst.latchPath)                  instr = PATH_DATA.set(instr);
442             else if (inst.path!=null) {
443                 instr  = PATH_IMMEDIATE.set(instr);
444                 BitVector bv  = getDestAddr(inst.path);
445                 BitVector bv2 = new BitVector(PATH_IMMEDIATE.valmaskwidth);
446                 for(int i=0; i<Math.min(bv.length(),bv2.length()); i++)
447                     bv2.set(i, bv.get(i));
448                 instr  = PATH_IMMEDIATE.setval(instr, bv2);
449             } else {
450                 instr  = PATH_NOCHANGE.set(instr);
451             }
452
453         } else {
454             throw new RuntimeException("unrecognized instruction " + d.getClass().getName());
455
456         }
457         return instr;
458     }
459
460     private long flagFunctionToLong(FlagFunction ff) {
461         long ret = 0;
462         for(Predicate p : ff)
463             switch(p) {
464                 case FlagA    : ret = SET_FLAGS_VALUE_A    .set(ret); break;
465                 case NotFlagA : ret = SET_FLAGS_VALUE_NOT_A.set(ret); break;
466                 case FlagB    : ret = SET_FLAGS_VALUE_B    .set(ret); break;
467                 case NotFlagB : ret = SET_FLAGS_VALUE_NOT_B.set(ret); break;
468                 case FlagC    : ret = SET_FLAGS_VALUE_C    .set(ret); break;
469                 case NotFlagC : ret = SET_FLAGS_VALUE_NOT_C.set(ret); break;
470                 default: throw new RuntimeException();
471             }
472         return ret;
473     }
474
475 }