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

   1 package edu.berkeley.fleet.ies44;
   2 import edu.berkeley.fleet.api.*;
   3 import edu.berkeley.fleet.*;
   4 import java.io.*;
   5 import static edu.berkeley.fleet.util.BitManipulations.*;
   6
   7 public abstract class InstructionEncoder {
   8
   9     public static final int WIDTH_WORD             = 37;   /* word width */
  10     public static final int WIDTH_CODEBAG_SIZE     = 6;
  11     public static final int WIDTH_PUMP_ADDR        = 11;
  12     public static final int WIDTH_DEST_ADDR        = 11;
  13     public static final int WIDTH_COUNT            = 7;
  14
  15     public static final int OFFSET_MASK_LITERAL    = 20;
  16     public static final int WIDTH_MASK_LITERAL     = 6;
  17     public static final int MASK_LITERAL           = 13;   // this is an excessive approximation
  18
  19
  20     public static final int OFFSET_MASK_MASSACRE   = 14;
  21     public static final int WIDTH_MASK_MASSACRE    = 26-14;
  22     public static final int MASK_MASSACRE          = 1;
  23
  24     public static final int OFFSET_MASK_KILL       = 14;
  25     public static final int WIDTH_MASK_KILL        = 26-14;
  26     public static final int MASK_KILL              = 0;
  27
  28     public static final int OFFSET_MASK_UNCLOG     = 14;
  29     public static final int WIDTH_MASK_UNCLOG      = 26-14;
  30     public static final int MASK_UNCLOG            = 3;
  31
  32     public static final int OFFSET_MASK_CLOG       = 14;
  33     public static final int WIDTH_MASK_CLOG        = 26-14;
  34     public static final int MASK_CLOG              = 2;
  35
  36     public static final int OFFSET_MASK_NORMAL     = 25;
  37     public static final int WIDTH_MASK_NORMAL      = 1;
  38     public static final int MASK_NORMAL            = 1;
  39
  40     public static final int OFFSET_COUNT           = 0;
  41     public static final int OFFSET_DEST            = OFFSET_COUNT+WIDTH_COUNT;
  42     public static final int OFFSET_CONTROL         = OFFSET_DEST+WIDTH_DEST_ADDR;
  43     public static final int OFFSET_RQ              = OFFSET_CONTROL+0;
  44     public static final int OFFSET_IG              = OFFSET_CONTROL+1;
  45     public static final int OFFSET_TO              = OFFSET_CONTROL+2;
  46     public static final int OFFSET_DO              = OFFSET_CONTROL+3;
  47     public static final int OFFSET_DL              = OFFSET_CONTROL+4;
  48     public static final int OFFSET_DI              = OFFSET_CONTROL+5;
  49     public static final int OFFSET_TI              = OFFSET_CONTROL+6;
  50     public static final int OFFSET_LITERAL_LOADHIGH = 19;
  51     public static final int OFFSET_INSTRUCTIONTYPE = OFFSET_CONTROL+7;
  52     public static final int OFFSET_PUMP_ADDR       = OFFSET_INSTRUCTIONTYPE+1;
  53
  54     public static final int OFFSET_LITERAL         = 0;
  55     public static final int WIDTH_LITERAL          = 19;
  56
  57
  58     /** get the bits describing this box's location on the DESTINATION HORN */
  59     protected abstract long getDestAddr(Destination box);
  60
  61     /** get the bits describing this box's location on the INSTRUCTION HORN */
  62     protected abstract long getBoxInstAddr(Pump box);
  63
  64     /** given an INSTRUCTION HORN address, retrieve the corresponding Pump object */
  65     protected abstract Pump getBoxByInstAddr(long dest);
  66
  67     /** given a DESTINATION HORN address, retrieve the corresponding Pump object */
  68     protected abstract Destination getDestByAddr(long dest);
  69
  70     /** read a machine-formatted instruction from a file (into a Java object) */
  71     public Instruction readInstruction(DataInputStream is) throws IOException {
  72         long inst = 0;
  73         try {
  74             inst = (inst << 8) | (is.readByte() & 0xff);
  75             inst = (inst << 8) | (is.readByte() & 0xff);
  76             inst = (inst << 8) | (is.readByte() & 0xff);
  77             inst = (inst << 8) | (is.readByte() & 0xff);
  78             inst = (inst << 8) | (is.readByte() & 0xff);
  79             inst = (inst << 8) | (is.readByte() & 0xff);
  80             return readInstruction(inst);
  81         } catch (EOFException eof) {
  82             return null;
  83         }
  84     }
  85
  86     public Instruction readInstruction(long inst) {
  87         Pump name           = getBoxByInstAddr(getIntField(OFFSET_PUMP_ADDR+WIDTH_PUMP_ADDR-1, OFFSET_PUMP_ADDR, inst));
  88         if (getIntField(OFFSET_MASK_UNCLOG+WIDTH_MASK_UNCLOG-1, OFFSET_MASK_UNCLOG,inst)==MASK_UNCLOG)
  89             return new Instruction.UnClog(name);
  90         if (getIntField(OFFSET_MASK_CLOG+WIDTH_MASK_CLOG-1, OFFSET_MASK_CLOG,inst)==MASK_CLOG)
  91             return new Instruction.Clog(name);
  92         if (getIntField(OFFSET_MASK_MASSACRE+WIDTH_MASK_MASSACRE-1, OFFSET_MASK_MASSACRE,inst)==MASK_MASSACRE)
  93             return new Instruction.Massacre(name);
  94         int count           = getIntField(                 OFFSET_COUNT+WIDTH_COUNT-1,         OFFSET_COUNT,     inst);
  95         if (getIntField(OFFSET_MASK_KILL+WIDTH_MASK_KILL-1, OFFSET_MASK_KILL,inst)==MASK_KILL)
  96             return new Instruction.Kill(name, count);
  97         Destination dest    = getDestByAddr   (getIntField(OFFSET_DEST+WIDTH_DEST_ADDR-1,      OFFSET_DEST,      inst));
  98         boolean tokenIn     = getBit(OFFSET_TI, inst);
  99         boolean dataIn      = getBit(OFFSET_DI, inst);
 100         boolean latch       = getBit(OFFSET_DL, inst);
 101         boolean dataOut     = getBit(OFFSET_DO, inst);
 102         boolean tokenOut    = getBit(OFFSET_TO, inst);
 103         boolean requeue     = getBit(OFFSET_RQ, inst);
 104         boolean ignoreUntilLast = getBit(OFFSET_IG, inst);
 105         boolean dataOutDest = name.isOutbox() && dataOut && tokenOut;
 106         boolean isLiteral   = getIntField(OFFSET_MASK_LITERAL+WIDTH_MASK_LITERAL-1, OFFSET_MASK_LITERAL, inst)==MASK_LITERAL;
 107         if (isLiteral)
 108             return new Instruction.LocalLiteral(name, getField(OFFSET_LITERAL+WIDTH_LITERAL-1, OFFSET_LITERAL, inst), 0,
 109                                                 getField(OFFSET_LITERAL_LOADHIGH, OFFSET_LITERAL_LOADHIGH, inst)!=0);
 110         if (dataOutDest) tokenOut = false;
 111         return new Instruction.Move(name,
 112                                     dest,
 113                                     count,
 114                                     tokenIn,
 115                                     dataIn,
 116                                     latch,
 117                                     dataOutDest,
 118                                     dataOut,
 119                                     tokenOut,
 120                                     requeue,
 121                                     ignoreUntilLast);
 122     }
 123
 124     public long writeInstruction(Instruction d) {
 125         long instr = 0;
 126
 127         if (d.pump != null)
 128             instr |= putField(OFFSET_PUMP_ADDR+WIDTH_PUMP_ADDR-1, OFFSET_PUMP_ADDR, getBoxInstAddr(d.pump));
 129
 130         if (d instanceof Instruction.CodeBagDescriptor) {
 131             Instruction.CodeBagDescriptor lc = (Instruction.CodeBagDescriptor)d;
 132             // MAJOR MAJOR FIXME: upper half here...
 133             d = new Instruction.LocalLiteral(lc.pump, ((lc.offset << WIDTH_CODEBAG_SIZE)) | lc.size, 1, false);
 134         }
 135
 136         if (d instanceof Instruction.UnClog) {
 137             instr |= putField(OFFSET_MASK_UNCLOG+WIDTH_MASK_UNCLOG-1, OFFSET_MASK_UNCLOG,       MASK_UNCLOG);
 138
 139         } else if (d instanceof Instruction.Kill) {
 140             Instruction.Kill k = (Instruction.Kill)d;
 141             instr |= putField(OFFSET_MASK_KILL+WIDTH_MASK_KILL-1, OFFSET_MASK_KILL,       MASK_KILL);
 142             instr |= putField(OFFSET_COUNT+WIDTH_COUNT-1,         OFFSET_COUNT,           k.count-1);
 143
 144         } else if (d instanceof Instruction.Clog) {
 145             instr |= putField(OFFSET_MASK_CLOG+WIDTH_MASK_CLOG-1, OFFSET_MASK_CLOG,       MASK_CLOG);
 146
 147         } else if (d instanceof Instruction.Massacre) {
 148             instr |= putField(OFFSET_MASK_MASSACRE+WIDTH_MASK_MASSACRE-1, OFFSET_MASK_MASSACRE,       MASK_MASSACRE);
 149
 150         } else if (d instanceof Instruction.LocalLiteral) {
 151             Instruction.LocalLiteral inst = (Instruction.LocalLiteral)d;
 152             if (inst.pump != null) {
 153                 instr |= putField(OFFSET_MASK_LITERAL+WIDTH_MASK_LITERAL-1, OFFSET_MASK_LITERAL,    MASK_LITERAL);
 154                 instr |= putField(OFFSET_LITERAL+WIDTH_LITERAL-1,           OFFSET_LITERAL,         inst.literal);
 155                 instr |= putField(OFFSET_LITERAL_LOADHIGH, OFFSET_LITERAL_LOADHIGH, (inst.high?1:0));
 156             } else {
 157                 instr = inst.literal;
 158             }
 159
 160         } else if (d instanceof Instruction.Move) {
 161             Instruction.Move inst = (Instruction.Move)d;
 162             instr |= putField(OFFSET_MASK_NORMAL+WIDTH_MASK_NORMAL-1, OFFSET_MASK_NORMAL,       MASK_NORMAL);
 163             instr |= putField(OFFSET_DEST+WIDTH_DEST_ADDR-1,      OFFSET_DEST,        inst.dest==null?0:getDestAddr(inst.dest));
 164             instr |= putField(OFFSET_COUNT+WIDTH_COUNT-1,         OFFSET_COUNT,       inst.count);
 165             instr |= putField(OFFSET_TI,                          OFFSET_TI,          inst.tokenIn?1:0);
 166             instr |= putField(OFFSET_DI,                          OFFSET_DI,          inst.dataIn?1:0);
 167             instr |= putField(OFFSET_DL,                          OFFSET_DL,          inst.latch?1:0);
 168             instr |= putField(OFFSET_DO,                          OFFSET_DO,          (inst.dataOutDest||inst.dataOut)?1:0);
 169             instr |= putField(OFFSET_TO,                          OFFSET_TO,          (inst.dataOutDest||inst.tokenOut)?1:0);
 170             instr |= putField(OFFSET_RQ,                          OFFSET_RQ,          inst.requeue?1:0);
 171             instr |= putField(OFFSET_IG,                          OFFSET_IG,          inst.ignoreUntilLast?1:0);
 172
 173         }
 174         return instr;
 175     }
 176
 177     public void writeInstruction(DataOutputStream os, Instruction d) throws IOException {
 178         long instr = writeInstruction(d);
 179         for(int i=5; i>=0; i--)
 180             os.write(getIntField(i*8+7, i*8, instr));
 181    }
 182
 183 }