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