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