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     public static final Mask PACKET_TOKEN               = new Mask("v.................................................");
  14     public static final Mask PACKET_DATA                = new Mask(".vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv............");
  15     public static final Mask PACKET_SIGNAL              = new Mask("......................................v...........");
  16     public static final Mask PACKET_DEST                = new Mask(".......................................vvvvvvvvvvv");
  17
  18     public static final Mask CBD_SIZE                   = new Mask("...............................vvvvvv");
  19     public static final Mask CBD_OFFSET                 = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv......");
  20
  21     public static final int  WIDTH_WORD                 = PACKET_DATA.valmaskwidth;
  22     public static final int  WIDTH_PACKET               = PACKET_TOKEN.width;
  23
  24     public static final Mask WHOLE_WORD                 = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
  25     public static final Mask DISPATCH_PATH              = new Mask("vvvvvvvvvvv..........................");
  26     public static final Mask DISPATCH_INSTR             = new Mask("...........vvvvvvvvvvvvvvvvvvvvvvvvvv");
  27     public static final Mask I                          = new Mask("...........1.........................");
  28     public static final Mask OS                         = new Mask("............1........................");
  29     public static final Mask P                          = new Mask(".............vvv.....................");
  30     public static final Mask P_NOT_A                    = new Mask(".............000.....................");
  31     public static final Mask P_A                        = new Mask(".............001.....................");
  32     public static final Mask P_NOT_B                    = new Mask(".............010.....................");
  33     public static final Mask P_B                        = new Mask(".............011.....................");
  34     public static final Mask P_UNUSED                   = new Mask(".............100.....................");
  35     public static final Mask P_OLC_ZERO                 = new Mask(".............101.....................");
  36     public static final Mask P_OLC_NONZERO              = new Mask(".............110.....................");
  37     public static final Mask P_ALWAYS                   = new Mask(".............111.....................");
  38
  39     public static final Mask SHIFT                      = new Mask("................00vvvvvvvvvvvvvvvvvvv");
  40
  41     public static final Mask TAIL                       = new Mask("................11...................");
  42
  43     public static final Mask MOVE                       = new Mask("................01...................");
  44     public static final Mask TI                         = new Mask("................011..................");
  45     public static final Mask DI                         = new Mask("................01.1.................");
  46     public static final Mask FLUSH                      = new Mask("................01.01................");
  47     public static final Mask DC                         = new Mask("................01.11................");
  48     public static final Mask DO                         = new Mask("................01...1...............");
  49     public static final Mask TO                         = new Mask("................01....1..............");
  50     public static final Mask PATH_IMMEDIATE             = new Mask("................01.....1vvvvvvvvvvvvv");
  51     public static final Mask PATH_DATA                  = new Mask("................01.....01............");
  52     public static final Mask PATH_NOCHANGE              = new Mask("................01.....00............");
  53
  54     public static final Mask SET_OLC_FROM_IMMEDIATE     = new Mask("................101000100......vvvvvv");
  55     public static final Mask SET_OLC_FROM_DATA_LATCH    = new Mask("................101000010............");
  56     public static final Mask SET_OLC_FROM_OLC_MINUS_ONE = new Mask("................101000001............");
  57
  58     public static final Mask SET_ILC_FROM_IMMEDIATE     = new Mask("................10010010......0vvvvvv");
  59     public static final Mask SET_ILC_FROM_INFINITY      = new Mask("................10010010......1......");
  60     public static final Mask SET_ILC_FROM_DATA_LATCH    = new Mask("................10010001.............");
  61
  62     public static final Mask SET_IMMEDIATE              = new Mask("................100010.vvvvvvvvvvvvvv");
  63     public static final Mask SET_IMMEDIATE_EXTEND       = new Mask("................100010v..............");
  64
  65     public static final Mask SET_FLAGS                  = new Mask("................100001...............");
  66     public static final Mask SET_FLAGS_A                = new Mask("................100001...vvvvvv......");
  67     public static final Mask SET_FLAGS_B                = new Mask("................100001.........vvvvvv");
  68     public static final Mask SET_FLAGS_VALUE_A          = new Mask("1.....");
  69     public static final Mask SET_FLAGS_VALUE_NOT_A      = new Mask(".1....");
  70     public static final Mask SET_FLAGS_VALUE_B          = new Mask("..1...");
  71     public static final Mask SET_FLAGS_VALUE_NOT_B      = new Mask("...1..");
  72     public static final Mask SET_FLAGS_VALUE_C          = new Mask("....1.");
  73     public static final Mask SET_FLAGS_VALUE_NOT_C      = new Mask(".....1");
  74
  75     // Misc //////////////////////////////////////////////////////////////////////////////
  76
  77     public static final long DataLatch_WIDTH = SET_IMMEDIATE.valmaskmax-SET_IMMEDIATE.valmaskmin+1;  // FIXME: this is an abstraction breakage
  78     private static final long mask  = ~(-1L << DataLatch_WIDTH);
  79     public static boolean isSmallEnoughToFit(long immediate) {
  80         if ((immediate & ~mask) == 0)   return true;
  81         if ((immediate |  mask) == -1L) return true;
  82         return false;
  83     }
  84
  85     public int getWordWidth() { return 37; }
  86
  87     //////////////////////////////////////////////////////////////////////////////
  88
  89     /** get the bits describing this box's location on the DESTINATION HORN */
  90     // FIXME this should use a BitVector not a long!
  91     protected abstract long getDestAddr(Path box);
  92
  93     private static final BitVector SIGNAL_ZERO = new BitVector(1);
  94     private static final BitVector SIGNAL_ONE  = new BitVector(1);
  95     static {
  96         SIGNAL_ONE.set(0,true);
  97     }
  98
  99     /** decode a path, given the starting point and the bits that comprise it */
 100     // FIXME this should use a BitVector not a long!
 101     //protected abstract Path getPathByAddr(Dock source, long dest);
 102     public Path getPathByAddr(Dock source, long dest) {
 103         for(Ship ship : this)
 104             for(Dock bb : ship) {
 105                 for(Destination d : new Destination[] { bb.getInstructionDestination(), bb.getDataDestination() }) {
 106                     for(BitVector signal : new BitVector[] { SIGNAL_ZERO, SIGNAL_ONE }) {
 107                         Path p = (Path)source.getPath(d, signal);
 108                         if (getDestAddr(p) == dest) return p;
 109                     }
 110                 }
 111             }
 112         return null;
 113     }
 114
 115     /** read a machine-formatted instruction from a file (into a Java object) */
 116     public Instruction readInstruction(DataInputStream is, Dock dispatchFrom) throws IOException {
 117         long inst = 0;
 118         try {
 119             inst = (inst << 8) | (is.readByte() & 0xff);
 120             inst = (inst << 8) | (is.readByte() & 0xff);
 121             inst = (inst << 8) | (is.readByte() & 0xff);
 122             inst = (inst << 8) | (is.readByte() & 0xff);
 123             inst = (inst << 8) | (is.readByte() & 0xff);
 124             inst = (inst << 8) | (is.readByte() & 0xff);
 125             return readInstruction(inst, dispatchFrom);
 126         } catch (EOFException eof) {
 127             return null;
 128         }
 129     }
 130
 131     public Instruction readInstruction(long inst, Dock dispatchFrom) {
 132         Dock dock = getPathByAddr(dispatchFrom, DISPATCH_PATH.getval(inst)).getDestination().getDock();
 133
 134         if (TAIL.get(inst))   return new Tail(dock);
 135
 136         Predicate predicate = Default;
 137         if (P_ALWAYS.get(inst)) predicate = IgnoreOLC;
 138         if (P_OLC_NONZERO.get(inst))    predicate = Default;
 139         if (P_OLC_ZERO.get(inst))    predicate = OLCZero;
 140         if (P_A.get(inst))      predicate = FlagA;
 141         if (P_B.get(inst))      predicate = FlagB;
 142         if (P_NOT_A.get(inst))  predicate = NotFlagA;
 143         if (P_NOT_B.get(inst))  predicate = NotFlagB;
 144
 145         boolean looping = !OS.get(inst);
 146         if (FLUSH.get(inst))
 147             return new Flush(dock, looping, predicate);
 148         if (SHIFT.get(inst))                return new Shift(dock, looping, predicate, new BitVector(dock.getShip().getFleet().getWordWidth()).set(SHIFT.getval(inst)));
 149         if (SET_IMMEDIATE.get(inst)) {
 150             boolean extend = SET_IMMEDIATE_EXTEND.getval(inst) != 0;
 151             long immediate = SET_IMMEDIATE.getval(inst);
 152             if (extend) immediate |= (-1L << DataLatch_WIDTH);
 153             return new Set(dock, looping, predicate, SetDest.DataLatch, (immediate));
 154         }
 155
 156         if (SET_OLC_FROM_OLC_MINUS_ONE.get(inst))
 157             return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, SetSource.Decrement);
 158         if (SET_OLC_FROM_IMMEDIATE.get(inst))
 159             return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, (SET_OLC_FROM_IMMEDIATE.getval(inst)));
 160         if (SET_ILC_FROM_IMMEDIATE.get(inst))
 161             return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, (SET_ILC_FROM_IMMEDIATE.getval(inst)));
 162         if (SET_OLC_FROM_DATA_LATCH.get(inst))
 163             return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, SetSource.DataLatch);
 164         if (SET_ILC_FROM_DATA_LATCH.get(inst))
 165             return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, SetSource.DataLatch);
 166         if (SET_ILC_FROM_INFINITY.get(inst))
 167             return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, SetSource.Infinity);
 168         if (SET_FLAGS.get(inst)) {
 169             long flag_a = SET_FLAGS_A.getval(inst);
 170             long flag_b = SET_FLAGS_B.getval(inst);
 171             FlagFunction ap = FlagFunction.ZERO;
 172             FlagFunction bp = FlagFunction.ZERO;
 173             if (SET_FLAGS_VALUE_A    .get(flag_a)) ap = ap.add(FlagA    );
 174             if (SET_FLAGS_VALUE_NOT_A.get(flag_a)) ap = ap.add(NotFlagA );
 175             if (SET_FLAGS_VALUE_B    .get(flag_a)) ap = ap.add(FlagB    );
 176             if (SET_FLAGS_VALUE_NOT_B.get(flag_a)) ap = ap.add(NotFlagB );
 177             if (SET_FLAGS_VALUE_C    .get(flag_a)) ap = ap.add(FlagC    );
 178             if (SET_FLAGS_VALUE_NOT_C.get(flag_a)) ap = ap.add(NotFlagC );
 179             if (SET_FLAGS_VALUE_A    .get(flag_b)) bp = bp.add(FlagA    );
 180             if (SET_FLAGS_VALUE_NOT_A.get(flag_b)) bp = bp.add(NotFlagA );
 181             if (SET_FLAGS_VALUE_B    .get(flag_b)) bp = bp.add(FlagB    );
 182             if (SET_FLAGS_VALUE_NOT_B.get(flag_b)) bp = bp.add(NotFlagB );
 183             if (SET_FLAGS_VALUE_C    .get(flag_b)) bp = bp.add(FlagC    );
 184             if (SET_FLAGS_VALUE_NOT_C.get(flag_b)) bp = bp.add(NotFlagC );
 185             return new Set(dock, looping, predicate, ap, bp);
 186         }
 187         if (MOVE.get(inst))
 188             return new Move(dock,
 189                             looping,
 190                             predicate,
 191                             I.get(inst),
 192                             getPathByAddr(dock, PATH_IMMEDIATE.getval(inst)),
 193                             TI.get(inst),
 194                             DI.get(inst),
 195                             DC.get(inst),
 196                             PATH_DATA.get(inst),
 197                             DO.get(inst),
 198                             TO.get(inst)
 199                             );
 200         throw new RuntimeException("unknown instruction: 0x" + Long.toString(inst, 16));
 201     }
 202
 203     public long writeInstruction(Instruction d, Dock dispatchFrom) {
 204         long instr = 0;
 205
 206         if (d.dock != null)
 207             instr = DISPATCH_PATH.setval(instr, getDestAddr(dispatchFrom.getPath(d.dock.getInstructionDestination(),null)));
 208
 209         boolean dl = false;
 210         Instruction pi = d;
 211         if (!pi.looping) instr = OS.set(instr);
 212         switch(pi.predicate) {
 213             case IgnoreOLC:         instr = P_ALWAYS.set(instr); break;
 214             case OLCZero:         instr = P_OLC_ZERO.set(instr); break;
 215             case Default: instr = P_OLC_NONZERO.set(instr); break;
 216             case FlagA:      instr = P_A.set(instr);      break;
 217             case FlagB:      instr = P_B.set(instr);      break;
 218             case NotFlagA:  instr = P_NOT_A.set(instr);      break;
 219             case NotFlagB:  instr = P_NOT_B.set(instr);      break;
 220             default: throw new RuntimeException("error!");
 221         }
 222
 223         if (d instanceof Tail) {
 224             instr = TAIL.set(instr);
 225
 226         } else if (d instanceof Shift) {
 227             Shift shift = (Shift)d;
 228             instr = SHIFT.set(instr);
 229             instr = SHIFT.setval(instr, shift.immediate);
 230
 231         } else if (d instanceof Flush) {
 232             instr = FLUSH.set(instr);
 233
 234         } else if (d instanceof Set) {
 235             Set s = (Set)d;
 236             switch(s.dest) {
 237                 case InnerLoopCounter:
 238                     switch(s.source) {
 239                         case DataLatch:
 240                             instr = SET_ILC_FROM_DATA_LATCH.set(instr);
 241                             break;
 242                         case Immediate:
 243                             instr = SET_ILC_FROM_IMMEDIATE.setval(SET_ILC_FROM_IMMEDIATE.set(instr), s.immediate);
 244                             break;
 245                         case Infinity:
 246                             instr = SET_ILC_FROM_INFINITY.set(instr);
 247                             break;
 248                     }
 249                     break;
 250                 case OuterLoopCounter:
 251                     switch(s.source) {
 252                         case Decrement:
 253                             instr = SET_OLC_FROM_OLC_MINUS_ONE.set(instr);
 254                             break;
 255                         case DataLatch:
 256                             instr = SET_OLC_FROM_DATA_LATCH.set(instr);
 257                             break;
 258                         case Immediate:
 259                             instr = SET_OLC_FROM_IMMEDIATE.setval(SET_OLC_FROM_IMMEDIATE.set(instr), s.immediate);
 260                             break;
 261                     }
 262                     break;
 263                 case Flags: {
 264                     instr = SET_FLAGS.set(instr);
 265                     instr = SET_FLAGS_A.setval(instr, flagFunctionToLong(s.newFlagA));
 266                     instr = SET_FLAGS_B.setval(instr, flagFunctionToLong(s.newFlagB));
 267                     break;
 268                 }
 269                 case DataLatch: {
 270                     instr = SET_IMMEDIATE.set(instr);
 271                     instr = SET_IMMEDIATE_EXTEND.setval(instr, s.immediate < 0 ? 1 : 0);
 272                     instr = SET_IMMEDIATE.setval(instr, s.immediate & ~(-1L << DataLatch_WIDTH));
 273                     break;
 274                 }
 275             }
 276
 277         } else if (d instanceof Move) {
 278             Move inst = (Move)d;
 279             instr  = MOVE.set(instr);
 280             if (inst.tokenIn)                    instr = TI.set(instr);
 281             if (inst.dataIn)                     instr = DI.set(instr);
 282             if (inst.latchData)                  instr = DC.set(instr);
 283             if (inst.dataOut)                    instr = DO.set(instr);
 284             if (inst.tokenOut)                   instr = TO.set(instr);
 285             if (inst.interruptible)              instr = I.set(instr);
 286
 287             if (inst.latchPath)                  instr = PATH_DATA.set(instr);
 288             else {
 289                 instr  = PATH_IMMEDIATE.set(instr);
 290                 instr  = PATH_IMMEDIATE.setval(instr, inst.path==null?0:getDestAddr(inst.path));
 291             }
 292
 293         } else {
 294             throw new RuntimeException("unrecognized instruction " + d.getClass().getName());
 295
 296         }
 297         return instr;
 298     }
 299
 300     public void writeInstruction(DataOutputStream os, Dock dispatchFrom, Instruction d) throws IOException {
 301         long instr = writeInstruction(d, dispatchFrom);
 302         for(int i=5; i>=0; i--)
 303             os.write(BitManipulations.getIntField(i*8+7, i*8, instr));
 304     }
 305
 306     private static long flagFunctionToLong(FlagFunction ff) {
 307         long ret = 0;
 308         for(Predicate p : ff)
 309             switch(p) {
 310                 case FlagA    : ret = SET_FLAGS_VALUE_A    .set(ret); break;
 311                 case NotFlagA : ret = SET_FLAGS_VALUE_NOT_A.set(ret); break;
 312                 case FlagB    : ret = SET_FLAGS_VALUE_B    .set(ret); break;
 313                 case NotFlagB : ret = SET_FLAGS_VALUE_NOT_B.set(ret); break;
 314                 case FlagC    : ret = SET_FLAGS_VALUE_C    .set(ret); break;
 315                 case NotFlagC : ret = SET_FLAGS_VALUE_NOT_C.set(ret); break;
 316                 default: throw new RuntimeException();
 317             }
 318         return ret;
 319     }
 320
 321 }