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