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     private final boolean hack = "true".equals(System.getProperty("inverted-dc-bit-hack", "false"));
  14
  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;
  20
  21     public final Mask CBD_SIZE;
  22     public final Mask CBD_OFFSET;
  23
  24     public final Mask WHOLE_WORD;
  25     public final Mask DISPATCH_PATH;
  26     public final Mask DISPATCH_INSTR;
  27     public final Mask NOT_INTERRUPTIBLE;
  28     public final Mask OS;
  29     public final Mask P;
  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;
  38
  39     public final Mask SHIFT;
  40
  41     public final Mask TAIL;
  42
  43     public final Mask MOVE;
  44     public final Mask TI;
  45     public final Mask DI;
  46     public final Mask FLUSH;
  47     public final Mask DC;
  48     public final Mask DO;
  49     public final Mask TO;
  50     public final Mask PATH_IMMEDIATE;
  51     public final Mask PATH_DATA;
  52     public final Mask PATH_NOCHANGE;
  53
  54     public final Mask SET_OLC_FROM_IMMEDIATE;
  55     public final Mask SET_OLC_FROM_DATA_LATCH;
  56     public final Mask SET_OLC_FROM_OLC_MINUS_ONE;
  57
  58     public final Mask SET_ILC_FROM_IMMEDIATE;
  59     public final Mask SET_ILC_FROM_INFINITY;
  60     public final Mask SET_ILC_FROM_DATA_LATCH;
  61
  62     public final Mask SET_IMMEDIATE;
  63     public final Mask SET_IMMEDIATE_EXTEND;
  64
  65     public final Mask SET_FLAGS;
  66     public final Mask SET_FLAGS_A;
  67     public final Mask SET_FLAGS_B;
  68     public final Mask SET_FLAGS_VALUE_A;
  69     public final Mask SET_FLAGS_VALUE_NOT_A;
  70     public final Mask SET_FLAGS_VALUE_B;
  71     public final Mask SET_FLAGS_VALUE_NOT_B;
  72     public final Mask SET_FLAGS_VALUE_C;
  73     public final Mask SET_FLAGS_VALUE_NOT_C;
  74
  75     public final int  WIDTH_WORD;
  76     public final int  WIDTH_PACKET;
  77
  78     public final long DataLatch_WIDTH;
  79     private final long mask;
  80
  81     public FleetTwoFleet() { this(false); }
  82
  83     public FleetTwoFleet(boolean useInternalEncoding) {
  84         PACKET_TOKEN               = new Mask("v.................................................");
  85         PACKET_IS_TOKEN            = new Mask("1.................................................");
  86         PACKET_DATA                = new Mask(".vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv............");
  87         PACKET_SIGNAL              = new Mask("......................................v...........");
  88         PACKET_DEST                = new Mask(".......................................vvvvvvvvvvv");
  89
  90         CBD_SIZE                   = new Mask("...............................vvvvvv");
  91         CBD_OFFSET                 = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv......");
  92
  93         WHOLE_WORD                 = new Mask("vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
  94
  95         if (useInternalEncoding) {
  96
  97             DISPATCH_PATH              = new Mask("v....................................");
  98             DISPATCH_INSTR             = new Mask(".vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv");
  99             NOT_INTERRUPTIBLE          = new Mask(".................1...................");
 100             OS                         = new Mask(".......1.............................");
 101             P                          = new Mask(".vvvvvv..............................");
 102             P_NOT_A                    = new Mask(".011110..............................");
 103             P_A                        = new Mask(".011101..............................");
 104             P_NOT_B                    = new Mask(".011011..............................");
 105             P_B                        = new Mask(".010111..............................");
 106             P_UNUSED                   = new Mask(".000000..............................");
 107             P_OLC_ZERO                 = new Mask(".101111..............................");
 108             P_OLC_NONZERO              = new Mask(".011111..............................");
 109             P_ALWAYS                   = new Mask(".111111..............................");
 110
 111             SHIFT                      = new Mask("..........101111.1vvvvvvvvvvvvvvvvvvv");
 112
 113             TAIL                       = new Mask("................1....................");
 114
 115             MOVE                       = new Mask("..........110111.....................");
 116             TI                         = new Mask("..........110111..1..................");
 117             DI                         = new Mask("..........110111...1.................");
 118             FLUSH                      = new Mask(".........1110111.....................");
 119             DC                         = new Mask("..........110111....1................");
 120             DO                         = new Mask("..........110111.....1...............");
 121             TO                         = new Mask("..........110111......1..............");
 122             PATH_IMMEDIATE             = new Mask("..........110111.......1vvvvvvvvvvvvv");
 123             PATH_DATA                  = new Mask("..........110111.......00............");
 124             PATH_NOCHANGE              = new Mask("..........110111.......01............");
 125
 126             SET_OLC_FROM_IMMEDIATE     = new Mask("..........111101.0.............vvvvvv");
 127             SET_OLC_FROM_DATA_LATCH    = new Mask("..........111101.1...................");
 128             SET_OLC_FROM_OLC_MINUS_ONE = new Mask("..........111011.....................");
 129
 130             SET_ILC_FROM_IMMEDIATE     = new Mask("..........011111.0...........0.vvvvvv");
 131             SET_ILC_FROM_INFINITY      = new Mask("..........011111.............1.......");
 132             SET_ILC_FROM_DATA_LATCH    = new Mask("..........011111.1...................");
 133
 134             SET_IMMEDIATE              = new Mask("..........101111.0.....vvvvvvvvvvvvvv");
 135             SET_IMMEDIATE_EXTEND       = new Mask("..........101111.0....v..............");
 136
 137             SET_FLAGS                  = new Mask("..........111110.....................");
 138             SET_FLAGS_A                = new Mask("..........111110...............vvvvvv");
 139             SET_FLAGS_B                = new Mask("..........111110.........vvvvvv......");
 140
 141             SET_FLAGS_VALUE_A          = new Mask(".....1");
 142             SET_FLAGS_VALUE_NOT_A      = new Mask("....1.");
 143             SET_FLAGS_VALUE_B          = new Mask("...1..");
 144             SET_FLAGS_VALUE_NOT_B      = new Mask("..1...");
 145             SET_FLAGS_VALUE_C          = new Mask(".1....");
 146             SET_FLAGS_VALUE_NOT_C      = new Mask("1.....");
 147
 148         } else {
 149             DISPATCH_PATH              = new Mask("vvvvvvvvvvv..........................");
 150             DISPATCH_INSTR             = new Mask("...........vvvvvvvvvvvvvvvvvvvvvvvvvv");
 151             NOT_INTERRUPTIBLE          = new Mask("...........1.........................");
 152             OS                         = new Mask("............1........................");
 153             P                          = new Mask(".............vvv.....................");
 154             P_NOT_A                    = new Mask(".............000.....................");
 155             P_A                        = new Mask(".............001.....................");
 156             P_NOT_B                    = new Mask(".............010.....................");
 157             P_B                        = new Mask(".............011.....................");
 158             P_UNUSED                   = new Mask(".............100.....................");
 159             P_OLC_ZERO                 = new Mask(".............101.....................");
 160             P_OLC_NONZERO              = new Mask(".............110.....................");
 161             P_ALWAYS                   = new Mask(".............111.....................");
 162
 163             SHIFT                      = new Mask("................00vvvvvvvvvvvvvvvvvvv");
 164
 165             TAIL                       = new Mask("................11...................");
 166
 167             MOVE                       = new Mask("................01...................");
 168             TI                         = new Mask("................011..................");
 169             DI                         = new Mask("................01.1.................");
 170             FLUSH                      = new Mask("................01.01................");
 171             DC                         = new Mask("................01.11................");
 172             DO                         = new Mask("................01...1...............");
 173             TO                         = new Mask("................01....1..............");
 174             PATH_IMMEDIATE             = new Mask("................01.....1vvvvvvvvvvvvv");
 175             PATH_DATA                  = new Mask("................01.....01............");
 176             PATH_NOCHANGE              = new Mask("................01.....00............");
 177
 178             SET_OLC_FROM_IMMEDIATE     = new Mask("................101000100......vvvvvv");
 179             SET_OLC_FROM_DATA_LATCH    = new Mask("................101000010............");
 180             SET_OLC_FROM_OLC_MINUS_ONE = new Mask("................101000001............");
 181
 182             SET_ILC_FROM_IMMEDIATE     = new Mask("................10010010......0vvvvvv");
 183             SET_ILC_FROM_INFINITY      = new Mask("................10010010......1......");
 184             SET_ILC_FROM_DATA_LATCH    = new Mask("................10010001.............");
 185
 186             SET_IMMEDIATE              = new Mask("................100010.vvvvvvvvvvvvvv");
 187             SET_IMMEDIATE_EXTEND       = new Mask("................100010v..............");
 188
 189             SET_FLAGS                  = new Mask("................100001...............");
 190             SET_FLAGS_A                = new Mask("................100001...vvvvvv......");
 191             SET_FLAGS_B                = new Mask("................100001.........vvvvvv");
 192
 193             SET_FLAGS_VALUE_A          = new Mask("1.....");
 194             SET_FLAGS_VALUE_NOT_A      = new Mask(".1....");
 195             SET_FLAGS_VALUE_B          = new Mask("..1...");
 196             SET_FLAGS_VALUE_NOT_B      = new Mask("...1..");
 197             SET_FLAGS_VALUE_C          = new Mask("....1.");
 198             SET_FLAGS_VALUE_NOT_C      = new Mask(".....1");
 199         }
 200
 201         WIDTH_WORD                 = PACKET_DATA.valmaskwidth;
 202         WIDTH_PACKET               = PACKET_TOKEN.width;
 203         DataLatch_WIDTH = SET_IMMEDIATE.valmaskmax-SET_IMMEDIATE.valmaskmin+1;  // FIXME: this is an abstraction breakage
 204         mask  = ~(-1L << DataLatch_WIDTH);
 205     }
 206
 207     // Misc //////////////////////////////////////////////////////////////////////////////
 208
 209     public boolean isSmallEnoughToFit(long immediate) {
 210         if ((immediate & ~mask) == 0)   return true;
 211         if ((immediate |  mask) == -1L) return true;
 212         return false;
 213     }
 214
 215     public int getWordWidth() { return 37; }
 216
 217     //////////////////////////////////////////////////////////////////////////////
 218
 219     /** get the bits describing this box's location on the DESTINATION HORN */
 220     protected abstract BitVector getDestAddr(Path box);
 221
 222     private static final BitVector SIGNAL_ZERO = new BitVector(1);
 223     private static final BitVector SIGNAL_ONE  = new BitVector(1).set(0,true);
 224
 225     /** decode a path, given the starting point and the bits that comprise it */
 226     public Path getPathByAddr(Dock source, BitVector dest) {
 227         for(Ship ship : this)
 228             for(Dock bb : ship) {
 229                 for(Destination d : new Destination[] { bb.getInstructionDestination(), bb.getDataDestination() }) {
 230                     for(BitVector signal : new BitVector[] { SIGNAL_ZERO, SIGNAL_ONE }) {
 231                         Path p = (Path)source.getPath(d, signal);
 232                         if (getDestAddr(p).equalsZeroExtended(dest)) return p;
 233                     }
 234                 }
 235             }
 236         return null;
 237     }
 238
 239     public Instruction decodeInstruction(BitVector instruction, Dock dispatchFrom) {
 240         return readInstruction(instruction.toLong(), dispatchFrom);
 241     }
 242
 243     public BitVector   encodeInstruction(Instruction instr, Dock dispatchFrom) {
 244         return new BitVector(getWordWidth()).set(writeInstruction(instr, dispatchFrom));
 245     }
 246
 247     public int getShiftWidth() { return SHIFT.valmaskwidth; }
 248     public int getSetWidth() { return SET_IMMEDIATE.valmaskwidth+1; }
 249
 250     // FIXME: should use BitVector here
 251     public Instruction readInstruction(long inst, Dock dispatchFrom) {
 252         Dock dock = getPathByAddr(dispatchFrom, DISPATCH_PATH.getvalAsBitVector(inst)).getDestination().getDock();
 253
 254         if (TAIL.get(inst))   return new Tail(dock);
 255
 256         Predicate predicate = Default;
 257         if (P_ALWAYS.get(inst)) predicate = IgnoreOLC;
 258         if (P_OLC_NONZERO.get(inst))    predicate = Default;
 259         if (P_OLC_ZERO.get(inst))    predicate = OLCZero;
 260         if (P_A.get(inst))      predicate = FlagA;
 261         if (P_B.get(inst))      predicate = FlagB;
 262         if (P_NOT_A.get(inst))  predicate = NotFlagA;
 263         if (P_NOT_B.get(inst))  predicate = NotFlagB;
 264
 265         boolean looping = !OS.get(inst);
 266         if (FLUSH.get(inst))
 267             return new Flush(dock, looping, predicate);
 268         if (SHIFT.get(inst))                return new Shift(dock, looping, predicate, new BitVector(dock.getShip().getFleet().getShiftWidth()).set(SHIFT.getval(inst)));
 269         if (SET_IMMEDIATE.get(inst)) {
 270             boolean extend = SET_IMMEDIATE_EXTEND.getval(inst) != 0;
 271             long immediate = SET_IMMEDIATE.getval(inst);
 272             if (extend) immediate |= (-1L << DataLatch_WIDTH);
 273             return new Set(dock, looping, predicate, SetDest.DataLatch, (immediate));
 274         }
 275
 276         if (SET_OLC_FROM_OLC_MINUS_ONE.get(inst))
 277             return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, SetSource.Decrement);
 278         if (SET_OLC_FROM_IMMEDIATE.get(inst))
 279             return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, (SET_OLC_FROM_IMMEDIATE.getval(inst)));
 280         if (SET_ILC_FROM_IMMEDIATE.get(inst))
 281             return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, (SET_ILC_FROM_IMMEDIATE.getval(inst)));
 282         if (SET_OLC_FROM_DATA_LATCH.get(inst))
 283             return new Set(dock, looping, predicate, SetDest.OuterLoopCounter, SetSource.DataLatch);
 284         if (SET_ILC_FROM_DATA_LATCH.get(inst))
 285             return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, SetSource.DataLatch);
 286         if (SET_ILC_FROM_INFINITY.get(inst))
 287             return new Set(dock, looping, predicate, SetDest.InnerLoopCounter, SetSource.Infinity);
 288         if (SET_FLAGS.get(inst)) {
 289             long flag_a = SET_FLAGS_A.getval(inst);
 290             long flag_b = SET_FLAGS_B.getval(inst);
 291             FlagFunction ap = FlagFunction.ZERO;
 292             FlagFunction bp = FlagFunction.ZERO;
 293             if (SET_FLAGS_VALUE_A    .get(flag_a)) ap = ap.add(FlagA    );
 294             if (SET_FLAGS_VALUE_NOT_A.get(flag_a)) ap = ap.add(NotFlagA );
 295             if (SET_FLAGS_VALUE_B    .get(flag_a)) ap = ap.add(FlagB    );
 296             if (SET_FLAGS_VALUE_NOT_B.get(flag_a)) ap = ap.add(NotFlagB );
 297             if (SET_FLAGS_VALUE_C    .get(flag_a)) ap = ap.add(FlagC    );
 298             if (SET_FLAGS_VALUE_NOT_C.get(flag_a)) ap = ap.add(NotFlagC );
 299             if (SET_FLAGS_VALUE_A    .get(flag_b)) bp = bp.add(FlagA    );
 300             if (SET_FLAGS_VALUE_NOT_A.get(flag_b)) bp = bp.add(NotFlagA );
 301             if (SET_FLAGS_VALUE_B    .get(flag_b)) bp = bp.add(FlagB    );
 302             if (SET_FLAGS_VALUE_NOT_B.get(flag_b)) bp = bp.add(NotFlagB );
 303             if (SET_FLAGS_VALUE_C    .get(flag_b)) bp = bp.add(FlagC    );
 304             if (SET_FLAGS_VALUE_NOT_C.get(flag_b)) bp = bp.add(NotFlagC );
 305             return new Set(dock, looping, predicate, ap, bp);
 306         }
 307         if (MOVE.get(inst))
 308             return new Move(dock,
 309                             looping,
 310                             predicate,
 311                             !NOT_INTERRUPTIBLE.get(inst),
 312                             getPathByAddr(dock, PATH_IMMEDIATE.getvalAsBitVector(inst)),
 313                             TI.get(inst),
 314                             DI.get(inst),
 315                             hack?(!DC.get(inst)):DC.get(inst),
 316                             PATH_DATA.get(inst),
 317                             DO.get(inst),
 318                             TO.get(inst)
 319                             );
 320         throw new RuntimeException("unknown instruction: 0x" + Long.toString(inst, 16));
 321     }
 322
 323     // FIXME: should use BitVector here
 324     public long writeInstruction(Instruction d, Dock dispatchFrom) {
 325         long instr = 0;
 326
 327         if (d.dock != null) {
 328             BitVector bv = getDestAddr(dispatchFrom.getPath(d.dock.getInstructionDestination(),null));
 329             BitVector bv2 = new BitVector(DISPATCH_PATH.valmaskwidth);
 330             for(int i=0; i<Math.min(bv.length(),bv2.length()); i++)
 331                 bv2.set(i, bv.get(i));
 332             instr = DISPATCH_PATH.setval(instr, bv2);
 333         }
 334
 335         boolean dl = false;
 336         Instruction pi = d;
 337         if (!pi.looping) instr = OS.set(instr);
 338         switch(pi.predicate) {
 339             case IgnoreOLC:         instr = P_ALWAYS.set(instr); break;
 340             case OLCZero:         instr = P_OLC_ZERO.set(instr); break;
 341             case Default: instr = P_OLC_NONZERO.set(instr); break;
 342             case FlagA:      instr = P_A.set(instr);      break;
 343             case FlagB:      instr = P_B.set(instr);      break;
 344             case NotFlagA:  instr = P_NOT_A.set(instr);      break;
 345             case NotFlagB:  instr = P_NOT_B.set(instr);      break;
 346             default: throw new RuntimeException("error!");
 347         }
 348
 349         if (d instanceof Tail) {
 350             instr = TAIL.set(instr);
 351
 352         } else if (d instanceof Shift) {
 353             Shift shift = (Shift)d;
 354             instr = SHIFT.set(instr);
 355             instr = SHIFT.setval(instr, shift.immediate);
 356
 357         } else if (d instanceof Flush) {
 358             instr = FLUSH.set(instr);
 359
 360         } else if (d instanceof Set) {
 361             Set s = (Set)d;
 362             switch(s.dest) {
 363                 case InnerLoopCounter:
 364                     switch(s.source) {
 365                         case DataLatch:
 366                             instr = SET_ILC_FROM_DATA_LATCH.set(instr);
 367                             break;
 368                         case Immediate:
 369                             instr = SET_ILC_FROM_IMMEDIATE.setval(SET_ILC_FROM_IMMEDIATE.set(instr), s.immediate);
 370                             break;
 371                         case Infinity:
 372                             instr = SET_ILC_FROM_INFINITY.set(instr);
 373                             break;
 374                     }
 375                     break;
 376                 case OuterLoopCounter:
 377                     switch(s.source) {
 378                         case Decrement:
 379                             instr = SET_OLC_FROM_OLC_MINUS_ONE.set(instr);
 380                             break;
 381                         case DataLatch:
 382                             instr = SET_OLC_FROM_DATA_LATCH.set(instr);
 383                             break;
 384                         case Immediate:
 385                             instr = SET_OLC_FROM_IMMEDIATE.setval(SET_OLC_FROM_IMMEDIATE.set(instr), s.immediate);
 386                             break;
 387                     }
 388                     break;
 389                 case Flags: {
 390                     instr = SET_FLAGS.set(instr);
 391                     instr = SET_FLAGS_A.setval(instr, flagFunctionToLong(s.newFlagA));
 392                     instr = SET_FLAGS_B.setval(instr, flagFunctionToLong(s.newFlagB));
 393                     break;
 394                 }
 395                 case DataLatch: {
 396                     instr = SET_IMMEDIATE.set(instr);
 397                     instr = SET_IMMEDIATE_EXTEND.setval(instr, s.immediate < 0 ? 1 : 0);
 398                     instr = SET_IMMEDIATE.setval(instr, s.immediate & ~(-1L << DataLatch_WIDTH));
 399                     break;
 400                 }
 401             }
 402
 403         } else if (d instanceof Move) {
 404             Move inst = (Move)d;
 405             instr  = MOVE.set(instr);
 406             if (inst.tokenIn)                    instr = TI.set(instr);
 407             if (inst.dataIn)                     instr = DI.set(instr);
 408             if (hack) {
 409                 if (!inst.latchData)                 instr = DC.set(instr);
 410                 System.err.println("WARNING: employing inverted-Dc-bit hack -- DO NOT FORGET TO DISABLE THIS WHEN THE NETLIST GETS UPDATED!");
 411             } else {
 412                 if (inst.latchData)                  instr = DC.set(instr);
 413             }
 414             if (inst.dataOut)                    instr = DO.set(instr);
 415             if (inst.tokenOut)                   instr = TO.set(instr);
 416             if (!inst.interruptible)             instr = NOT_INTERRUPTIBLE.set(instr);
 417
 418             if (inst.latchPath)                  instr = PATH_DATA.set(instr);
 419             else if (inst.path!=null) {
 420                 instr  = PATH_IMMEDIATE.set(instr);
 421                 BitVector bv  = getDestAddr(inst.path);
 422                 BitVector bv2 = new BitVector(PATH_IMMEDIATE.valmaskwidth);
 423                 for(int i=0; i<Math.min(bv.length(),bv2.length()); i++)
 424                     bv2.set(i, bv.get(i));
 425                 instr  = PATH_IMMEDIATE.setval(instr, bv2);
 426             } else {
 427                 instr  = PATH_NOCHANGE.set(instr);
 428             }
 429
 430         } else {
 431             throw new RuntimeException("unrecognized instruction " + d.getClass().getName());
 432
 433         }
 434         return instr;
 435     }
 436
 437     private long flagFunctionToLong(FlagFunction ff) {
 438         long ret = 0;
 439         for(Predicate p : ff)
 440             switch(p) {
 441                 case FlagA    : ret = SET_FLAGS_VALUE_A    .set(ret); break;
 442                 case NotFlagA : ret = SET_FLAGS_VALUE_NOT_A.set(ret); break;
 443                 case FlagB    : ret = SET_FLAGS_VALUE_B    .set(ret); break;
 444                 case NotFlagB : ret = SET_FLAGS_VALUE_NOT_B.set(ret); break;
 445                 case FlagC    : ret = SET_FLAGS_VALUE_C    .set(ret); break;
 446                 case NotFlagC : ret = SET_FLAGS_VALUE_NOT_C.set(ret); break;
 447                 default: throw new RuntimeException();
 448             }
 449         return ret;
 450     }
 451
 452 }