1 package edu.berkeley.fleet.two;
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.*;
10 /** common subclass for the "FleetTwo" generation of processors, all 37-bit wide, with AM33 encoding */
11 public abstract class FleetTwoFleet extends Fleet {
13 private final boolean hack = "true".equals(System.getProperty("inverted-dc-bit-hack", "false"));
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;
21 public final Mask CBD_SIZE;
22 public final Mask CBD_OFFSET;
24 public final Mask WHOLE_WORD;
25 public final Mask DISPATCH_PATH;
26 public final Mask DISPATCH_INSTR;
27 public final Mask NOT_INTERRUPTIBLE;
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;
39 public final Mask SHIFT;
41 public final Mask TAIL;
42 public final Mask HEAD;
43 public final Mask ABORT;
45 public final Mask MOVE;
48 public final Mask FLUSH;
52 public final Mask PATH_IMMEDIATE;
53 public final Mask PATH_DATA;
54 public final Mask PATH_NOCHANGE;
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;
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;
64 public final Mask SET_IMMEDIATE;
65 public final Mask SET_IMMEDIATE_EXTEND;
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;
77 public final int WIDTH_WORD;
78 public final int WIDTH_PACKET;
80 public final long DataLatch_WIDTH;
81 private final long mask;
83 public FleetTwoFleet() { this(false); }
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");
92 CBD_SIZE = new Mask("...............................vvvvvv");
93 CBD_OFFSET = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv......");
95 WHOLE_WORD = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
97 if (useInternalEncoding) {
99 DISPATCH_PATH = new Mask("v....................................");
100 DISPATCH_INSTR = new Mask(".vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
101 NOT_INTERRUPTIBLE = new Mask(".................1...................");
102 OS = new Mask(".......1.............................");
103 P = new Mask(".vvvvvv..............................");
104 P_NOT_A = new Mask(".011110..............................");
105 P_A = new Mask(".011101..............................");
106 P_NOT_B = new Mask(".011011..............................");
107 P_B = new Mask(".010111..............................");
108 P_UNUSED = new Mask(".000000..............................");
109 P_OLC_ZERO = new Mask(".101111..............................");
110 P_OLC_NONZERO = new Mask(".011111..............................");
111 P_ALWAYS = new Mask(".111111..............................");
113 SHIFT = new Mask("..........101111.1vvvvvvvvvvvvvvvvvvv");
115 TAIL = new Mask("................1...................0");
119 MOVE = new Mask("..........110111.....................");
120 TI = new Mask("..........110111..1..................");
121 DI = new Mask("..........110111...1.................");
122 FLUSH = new Mask(".........1110111.....................");
123 DC = new Mask("..........110111....1................");
124 DO = new Mask("..........110111.....1...............");
125 TO = new Mask("..........110111......1..............");
126 PATH_IMMEDIATE = new Mask("..........110111.......1vvvvvvvvvvvvv");
127 PATH_DATA = new Mask("..........110111.......00............");
128 PATH_NOCHANGE = new Mask("..........110111.......01............");
130 SET_OLC_FROM_IMMEDIATE = new Mask("..........111101.0.............vvvvvv");
131 SET_OLC_FROM_DATA_LATCH = new Mask("..........111101.1...................");
132 SET_OLC_FROM_OLC_MINUS_ONE = new Mask("..........111011.....................");
134 SET_ILC_FROM_IMMEDIATE = new Mask("..........011111.0...........0.vvvvvv");
135 SET_ILC_FROM_INFINITY = new Mask("..........011111.............1.......");
136 SET_ILC_FROM_DATA_LATCH = new Mask("..........011111.1...................");
138 SET_IMMEDIATE = new Mask("..........101111.0.....vvvvvvvvvvvvvv");
139 SET_IMMEDIATE_EXTEND = new Mask("..........101111.0....v..............");
141 SET_FLAGS = new Mask("..........111110.....................");
142 SET_FLAGS_A = new Mask("..........111110...............vvvvvv");
143 SET_FLAGS_B = new Mask("..........111110.........vvvvvv......");
145 SET_FLAGS_VALUE_A = new Mask(".....1");
146 SET_FLAGS_VALUE_NOT_A = new Mask("....1.");
147 SET_FLAGS_VALUE_B = new Mask("...1..");
148 SET_FLAGS_VALUE_NOT_B = new Mask("..1...");
149 SET_FLAGS_VALUE_C = new Mask(".1....");
150 SET_FLAGS_VALUE_NOT_C = new Mask("1.....");
153 DISPATCH_PATH = new Mask("vvvvvvvvvvv..........................");
154 DISPATCH_INSTR = new Mask("...........vvvvvvvvvvvvvvvvvvvvvvvvvv");
155 NOT_INTERRUPTIBLE = new Mask("...........1.........................");
156 OS = new Mask("............1........................");
157 P = new Mask(".............vvv.....................");
158 P_NOT_A = new Mask(".............000.....................");
159 P_A = new Mask(".............001.....................");
160 P_NOT_B = new Mask(".............010.....................");
161 P_B = new Mask(".............011.....................");
162 P_UNUSED = new Mask(".............100.....................");
163 P_OLC_ZERO = new Mask(".............101.....................");
164 P_OLC_NONZERO = new Mask(".............110.....................");
165 P_ALWAYS = new Mask(".............111.....................");
167 SHIFT = new Mask("................00vvvvvvvvvvvvvvvvvvv");
169 ABORT = new Mask("................1100................."); // note: has a predicate!
171 HEAD = new Mask("................1110.................");
172 TAIL = new Mask("................1111.................");
174 MOVE = new Mask("................01...................");
175 TI = new Mask("................011..................");
176 DI = new Mask("................01.1.................");
177 FLUSH = new Mask("................01.01................");
178 DC = new Mask("................01.11................");
179 DO = new Mask("................01...1...............");
180 TO = new Mask("................01....1..............");
181 PATH_IMMEDIATE = new Mask("................01.....1vvvvvvvvvvvvv");
182 PATH_DATA = new Mask("................01.....01............");
183 PATH_NOCHANGE = new Mask("................01.....00............");
185 SET_OLC_FROM_IMMEDIATE = new Mask("................101000100......vvvvvv");
186 SET_OLC_FROM_DATA_LATCH = new Mask("................101000010............");
187 SET_OLC_FROM_OLC_MINUS_ONE = new Mask("................101000001............");
189 SET_ILC_FROM_IMMEDIATE = new Mask("................10010010......0vvvvvv");
190 SET_ILC_FROM_INFINITY = new Mask("................10010010......1......");
191 SET_ILC_FROM_DATA_LATCH = new Mask("................10010001.............");
193 SET_IMMEDIATE = new Mask("................100010.vvvvvvvvvvvvvv");
194 SET_IMMEDIATE_EXTEND = new Mask("................100010v..............");
196 SET_FLAGS = new Mask("................100001...............");
197 SET_FLAGS_A = new Mask("................100001...vvvvvv......");
198 SET_FLAGS_B = new Mask("................100001.........vvvvvv");
200 SET_FLAGS_VALUE_A = new Mask("1.....");
201 SET_FLAGS_VALUE_NOT_A = new Mask(".1....");
202 SET_FLAGS_VALUE_B = new Mask("..1...");
203 SET_FLAGS_VALUE_NOT_B = new Mask("...1..");
204 SET_FLAGS_VALUE_C = new Mask("....1.");
205 SET_FLAGS_VALUE_NOT_C = new Mask(".....1");
208 WIDTH_WORD = PACKET_DATA.valmaskwidth;
209 WIDTH_PACKET = PACKET_TOKEN.width;
210 DataLatch_WIDTH = SET_IMMEDIATE.valmaskmax-SET_IMMEDIATE.valmaskmin+1; // FIXME: this is an abstraction breakage
211 mask = ~(-1L << DataLatch_WIDTH);
214 // Misc //////////////////////////////////////////////////////////////////////////////
216 public boolean isSmallEnoughToFit(long immediate) {
217 if ((immediate & ~mask) == 0) return true;
218 if ((immediate | mask) == -1L) return true;
222 public int getWordWidth() { return 37; }
224 //////////////////////////////////////////////////////////////////////////////
226 /** get the bits describing this box's location on the DESTINATION HORN */
227 protected abstract BitVector getDestAddr(Path box);
229 private static final BitVector SIGNAL_ZERO = new BitVector(1);
230 private static final BitVector SIGNAL_ONE = new BitVector(1).set(0,true);
232 /** decode a path, given the starting point and the bits that comprise it */
233 public Path getPathByAddr(Dock source, BitVector dest) {
234 for(Ship ship : this)
235 for(Dock bb : ship) {
236 for(Destination d : new Destination[] { bb.getInstructionDestination(), bb.getDataDestination() }) {
237 for(BitVector signal : new BitVector[] { SIGNAL_ZERO, SIGNAL_ONE }) {
238 Path p = (Path)source.getPath(d, signal);
239 if (getDestAddr(p).equalsZeroExtended(dest)) return p;
246 public Instruction decodeInstruction(BitVector instruction, Dock dispatchFrom) {
247 return readInstruction(instruction.toLong(), dispatchFrom);
250 public BitVector encodeInstruction(Instruction instr, Dock dispatchFrom) {
251 return new BitVector(getWordWidth()).set(writeInstruction(instr, dispatchFrom));
254 public int getShiftWidth() { return SHIFT.valmaskwidth; }
255 public int getSetWidth() { return SET_IMMEDIATE.valmaskwidth+1; }
257 // FIXME: should use BitVector here
258 public Instruction readInstruction(long inst, Dock dispatchFrom) {
259 Dock dock = getPathByAddr(dispatchFrom, DISPATCH_PATH.getvalAsBitVector(inst)).getDestination().getDock();
261 if (TAIL.get(inst)) return new Tail(dock);
262 if (HEAD.get(inst)) return new Head(dock);
264 Predicate predicate = Default;
265 if (P_ALWAYS.get(inst)) predicate = IgnoreFlagD;
266 if (P_OLC_NONZERO.get(inst)) predicate = Default;
267 if (P_OLC_ZERO.get(inst)) predicate = FlagD;
268 if (P_A.get(inst)) predicate = FlagA;
269 if (P_B.get(inst)) predicate = FlagB;
270 if (P_NOT_A.get(inst)) predicate = NotFlagA;
271 if (P_NOT_B.get(inst)) predicate = NotFlagB;
273 boolean looping = !OS.get(inst);
275 return new Flush(dock, looping, predicate);
277 return new Abort(dock, predicate);
278 if (SHIFT.get(inst)) return new Shift(dock, looping, predicate, new BitVector(dock.getShip().getFleet().getShiftWidth()).set(SHIFT.getval(inst)));
279 if (SET_IMMEDIATE.get(inst)) {
280 boolean extend = SET_IMMEDIATE_EXTEND.getval(inst) != 0;
281 long immediate = SET_IMMEDIATE.getval(inst);
282 if (extend) immediate |= (-1L << DataLatch_WIDTH);
283 return new Set(dock, looping, predicate, SetDest.DataLatch, (immediate));
286 if (SET_OLC_FROM_OLC_MINUS_ONE.get(inst))
287 return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, SetSource.Decrement);
288 if (SET_OLC_FROM_IMMEDIATE.get(inst))
289 return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, (SET_OLC_FROM_IMMEDIATE.getval(inst)));
290 if (SET_ILC_FROM_IMMEDIATE.get(inst))
291 return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, (SET_ILC_FROM_IMMEDIATE.getval(inst)));
292 if (SET_OLC_FROM_DATA_LATCH.get(inst))
293 return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, SetSource.DataLatch);
294 if (SET_ILC_FROM_DATA_LATCH.get(inst))
295 return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, SetSource.DataLatch);
296 if (SET_ILC_FROM_INFINITY.get(inst))
297 return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, SetSource.Infinity);
298 if (SET_FLAGS.get(inst)) {
299 long flag_a = SET_FLAGS_A.getval(inst);
300 long flag_b = SET_FLAGS_B.getval(inst);
301 FlagFunction ap = FlagFunction.ZERO;
302 FlagFunction bp = FlagFunction.ZERO;
303 if (SET_FLAGS_VALUE_A .get(flag_a)) ap = ap.add(FlagA );
304 if (SET_FLAGS_VALUE_NOT_A.get(flag_a)) ap = ap.add(NotFlagA );
305 if (SET_FLAGS_VALUE_B .get(flag_a)) ap = ap.add(FlagB );
306 if (SET_FLAGS_VALUE_NOT_B.get(flag_a)) ap = ap.add(NotFlagB );
307 if (SET_FLAGS_VALUE_C .get(flag_a)) ap = ap.add(FlagC );
308 if (SET_FLAGS_VALUE_NOT_C.get(flag_a)) ap = ap.add(NotFlagC );
309 if (SET_FLAGS_VALUE_A .get(flag_b)) bp = bp.add(FlagA );
310 if (SET_FLAGS_VALUE_NOT_A.get(flag_b)) bp = bp.add(NotFlagA );
311 if (SET_FLAGS_VALUE_B .get(flag_b)) bp = bp.add(FlagB );
312 if (SET_FLAGS_VALUE_NOT_B.get(flag_b)) bp = bp.add(NotFlagB );
313 if (SET_FLAGS_VALUE_C .get(flag_b)) bp = bp.add(FlagC );
314 if (SET_FLAGS_VALUE_NOT_C.get(flag_b)) bp = bp.add(NotFlagC );
315 return new Set(dock, looping, predicate, ap, bp);
318 return new Move(dock,
321 !NOT_INTERRUPTIBLE.get(inst),
322 getPathByAddr(dock, PATH_IMMEDIATE.getvalAsBitVector(inst)),
325 hack?(!DC.get(inst)):DC.get(inst),
330 throw new RuntimeException("unknown instruction: 0x" + Long.toString(inst, 16));
333 // FIXME: should use BitVector here
334 public long writeInstruction(Instruction d, Dock dispatchFrom) {
337 if (d.dock != null) {
338 BitVector bv = getDestAddr(dispatchFrom.getPath(d.dock.getInstructionDestination(),null));
339 BitVector bv2 = new BitVector(DISPATCH_PATH.valmaskwidth);
340 for(int i=0; i<Math.min(bv.length(),bv2.length()); i++)
341 bv2.set(i, bv.get(i));
342 instr = DISPATCH_PATH.setval(instr, bv2);
347 if (!pi.looping) instr = OS.set(instr);
348 switch(pi.predicate) {
349 case IgnoreFlagD: instr = P_ALWAYS.set(instr); break;
350 case FlagD: instr = P_OLC_ZERO.set(instr); break;
351 case Default: instr = P_OLC_NONZERO.set(instr); break;
352 case FlagA: instr = P_A.set(instr); break;
353 case FlagB: instr = P_B.set(instr); break;
354 case NotFlagA: instr = P_NOT_A.set(instr); break;
355 case NotFlagB: instr = P_NOT_B.set(instr); break;
356 default: throw new RuntimeException("error!");
359 if (d instanceof Tail) {
360 instr = TAIL.set(instr);
362 } else if (d instanceof Head) {
363 instr = HEAD.set(instr);
365 } else if (d instanceof Shift) {
366 Shift shift = (Shift)d;
367 instr = SHIFT.set(instr);
368 instr = SHIFT.setval(instr, shift.immediate);
370 } else if (d instanceof Flush) {
371 instr = FLUSH.set(instr);
373 } else if (d instanceof Abort) {
374 instr = ABORT.set(instr);
376 } else if (d instanceof Set) {
379 case InnerLoopCounter:
382 instr = SET_ILC_FROM_DATA_LATCH.set(instr);
385 instr = SET_ILC_FROM_IMMEDIATE.setval(SET_ILC_FROM_IMMEDIATE.set(instr), s.immediate);
388 instr = SET_ILC_FROM_INFINITY.set(instr);
392 case OuterLoopCounter:
395 instr = SET_OLC_FROM_OLC_MINUS_ONE.set(instr);
398 instr = SET_OLC_FROM_DATA_LATCH.set(instr);
401 instr = SET_OLC_FROM_IMMEDIATE.setval(SET_OLC_FROM_IMMEDIATE.set(instr), s.immediate);
406 instr = SET_FLAGS.set(instr);
407 instr = SET_FLAGS_A.setval(instr, flagFunctionToLong(s.newFlagA));
408 instr = SET_FLAGS_B.setval(instr, flagFunctionToLong(s.newFlagB));
412 instr = SET_IMMEDIATE.set(instr);
413 instr = SET_IMMEDIATE_EXTEND.setval(instr, s.immediate < 0 ? 1 : 0);
414 instr = SET_IMMEDIATE.setval(instr, s.immediate & ~(-1L << DataLatch_WIDTH));
419 } else if (d instanceof Move) {
421 instr = MOVE.set(instr);
422 if (inst.tokenIn) instr = TI.set(instr);
423 if (inst.dataIn) instr = DI.set(instr);
425 if (!inst.latchData) instr = DC.set(instr);
426 System.err.println("WARNING: employing inverted-Dc-bit hack -- DO NOT FORGET TO DISABLE THIS WHEN THE NETLIST GETS UPDATED!");
428 if (inst.latchData) instr = DC.set(instr);
430 if (inst.dataOut) instr = DO.set(instr);
431 if (inst.tokenOut) instr = TO.set(instr);
432 if (!inst.interruptible) instr = NOT_INTERRUPTIBLE.set(instr);
434 if (inst.latchPath) instr = PATH_DATA.set(instr);
435 else if (inst.path!=null) {
436 instr = PATH_IMMEDIATE.set(instr);
437 BitVector bv = getDestAddr(inst.path);
438 BitVector bv2 = new BitVector(PATH_IMMEDIATE.valmaskwidth);
439 for(int i=0; i<Math.min(bv.length(),bv2.length()); i++)
440 bv2.set(i, bv.get(i));
441 instr = PATH_IMMEDIATE.setval(instr, bv2);
443 instr = PATH_NOCHANGE.set(instr);
447 throw new RuntimeException("unrecognized instruction " + d.getClass().getName());
453 private long flagFunctionToLong(FlagFunction ff) {
455 for(Predicate p : ff)
457 case FlagA : ret = SET_FLAGS_VALUE_A .set(ret); break;
458 case NotFlagA : ret = SET_FLAGS_VALUE_NOT_A.set(ret); break;
459 case FlagB : ret = SET_FLAGS_VALUE_B .set(ret); break;
460 case NotFlagB : ret = SET_FLAGS_VALUE_NOT_B.set(ret); break;
461 case FlagC : ret = SET_FLAGS_VALUE_C .set(ret); break;
462 case NotFlagC : ret = SET_FLAGS_VALUE_NOT_C.set(ret); break;
463 default: throw new RuntimeException();