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