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