src/edu/berkeley/fleet/ies44/InstructionEncoder.java

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