src/edu/berkeley/fleet/fpga/FpgaDock.java

   1 package edu.berkeley.fleet.fpga;
   2 import edu.berkeley.fleet.api.*;
   3 import edu.berkeley.fleet.two.*;
   4 import edu.berkeley.fleet.*;
   5 import java.lang.reflect.*;
   6 import edu.berkeley.sbp.chr.*;
   7 import edu.berkeley.sbp.misc.*;
   8 import edu.berkeley.sbp.meta.*;
   9 import edu.berkeley.sbp.util.*;
  10 import java.util.*;
  11 import java.io.*;
  12 import static edu.berkeley.fleet.two.FleetTwoFleet.*;
  13 import static edu.berkeley.fleet.fpga.verilog.Verilog.*;
  14 import edu.berkeley.fleet.api.*;
  15 import edu.berkeley.fleet.api.Dock;
  16 import edu.berkeley.fleet.two.*;
  17 import java.util.*;
  18
  19 /** the pump itself is a */
  20 public class FpgaDock extends FleetTwoDock implements FabricElement {
  21
  22     private static final int INSTRUCTION_FIFO_SIZE = 12;
  23     private static final int EPILOGUE_FIFO_SIZE    = 0;
  24     private static final int DATA_FIFO_SIZE        = 4;
  25
  26     private FpgaDestination dataDestination;
  27     private FpgaDestination instructionDestination;
  28
  29     private Module.InstantiatedModule instance;
  30
  31     public Module.InstantiatedModule getInstance() { return instance; }
  32
  33     public Destination getDataDestination() { return dataDestination; }
  34     public Destination getInstructionDestination() { return instructionDestination; }
  35     public int         getInstructionFifoSize() { return INSTRUCTION_FIFO_SIZE; }
  36
  37     FpgaDock(FpgaShip ship, DockDescription bbd) {
  38         super(ship, bbd);
  39         this.instance = new Module.InstantiatedModule(((Fpga)ship.getFleet()).top, new DockModule(isInputDock()));
  40         this.dataDestination = new FpgaDestination(this, this.instance.getInputPort("fabric_in"), false);
  41         this.instructionDestination = new FpgaDestination(this, this.instance.getInputPort("instruction"), true);
  42         Module.InstantiatedModule shipm = ship.getVerilogModule();
  43         if (isInputDock()) {
  44             instance.getOutputPort("ship").connect(shipm.getInputPort(getName()));
  45         } else {
  46             shipm.getOutputPort(getName()).connect(instance.getInputPort("ship"));
  47         }
  48     }
  49
  50
  51     // FabricElement methods //////////////////////////////////////////////////////////////////////////////
  52
  53     private FabricElement upstream;
  54     public Module.SourcePort getOutputPort() { throw new RuntimeException(); }
  55     public Module.Port getInputPort()  { throw new RuntimeException(); }
  56     public FpgaPath getPath(FabricElement dest, BitVector signal) { return upstream.getPath((FabricElement)dest, signal); }
  57     public FpgaPath getPath(Destination dest,BitVector signal) { return upstream.getPath((FabricElement)dest, signal); }
  58     public void addInput(FabricElement in, Module.Port inPort) { throw new RuntimeException(); }
  59     public void addOutput(FabricElement out, Module.Port outPort) {
  60         this.upstream = out;
  61         instance.getOutputPort("fabric_out").connect((Module.SinkPort)outPort);
  62     }
  63
  64     public static class TorpedoBranchModule extends Module {
  65         public TorpedoBranchModule() {
  66             super("torpedobranch");
  67             Module.SourcePort in      = createInputPort ("in",  WIDTH_PACKET);
  68             // FIXME: assumes DISPATCH_PATH is at top of word!!!
  69             Module.SinkPort   out     = createOutputPort("out", WIDTH_WORD-DISPATCH_PATH.valmaskwidth, "");
  70             Module.SinkPort   torpedo = createOutputPort("torpedo", 0, "");
  71             in.hasLatch = false;
  72             out.hasLatch = false;
  73             torpedo.hasLatch = false;
  74
  75             addPreCrap("assign out        = "+PACKET_DATA.verilogVal("in")+";");
  76             addPreCrap("assign out_r      = in_r && !("+PACKET_TOKEN.verilogVal("in")+");");
  77             addPreCrap("assign torpedo_r  = in_r &&   "+PACKET_TOKEN.verilogVal("in")+";");
  78             addPreCrap("assign in_a       = out_a || torpedo_a;");
  79         }
  80     }
  81
  82     public static class RequeueModule extends Module {
  83         public RequeueModule() {
  84             super("requeue");
  85             Module.SourcePort fabric_in = createInputPort ("fabric_in",  WIDTH_WORD-DISPATCH_PATH.valmaskwidth);
  86             Module.SourcePort ondeck_in = createInputPort ("ondeck_in",  WIDTH_WORD-DISPATCH_PATH.valmaskwidth);
  87             Module.SourcePort olc_in    = createInputPort ("olc_in",     SET_OLC_FROM_IMMEDIATE.valmaskwidth);
  88             Module.SinkPort   out       = createOutputPort("out",        WIDTH_WORD-DISPATCH_PATH.valmaskwidth, "");
  89             out.forceNoLatch = true;
  90
  91             Module.StateWire  using         = new StateWire("using", false);
  92             Module.StateWire  circulating   = new StateWire("circulating", false);
  93             Module.StateWire  doResetFabric = new StateWire("doResetFabric", false);
  94             Module.StateWire  doResetOndeck = new StateWire("doResetOndeck", false);
  95
  96             addPreCrap("assign out = "+circulating.isEmpty()+" ? "+fabric_in.getName()+" : "+ondeck_in.getName()+";");
  97
  98             // always: discard one-shot instructions
  99             new Event(new Object[] { ondeck_in, /*olc_in,*/ OS.verilog(ondeck_in.getName()) },
 100                       new Action[] { ondeck_in, /*olc_in */});
 101
 102             new Event(new Object[] { doResetFabric.isFull(),  out },
 103                       new Action[] { doResetFabric.doDrain(), fabric_in });
 104             new Event(new Object[] { doResetOndeck.isFull(),  out },
 105                       new Action[] { doResetOndeck.doDrain(), ondeck_in });
 106
 107             new Event(new Object[] { circulating.isEmpty(),                  fabric_in, TAIL.verilog(fabric_in.getName()) },
 108                       new Action[] { circulating.doFill(),                   fabric_in });
 109             new Event(new Object[] { circulating.isEmpty(),                  fabric_in, "!("+TAIL.verilog(fabric_in.getName())+")", doResetFabric.isEmpty() },
 110                       new Action[] {                                         out, doResetFabric.doFill() });
 111             new Event(new Object[] { using.isEmpty(),                        ondeck_in, /*olc_in,*/   "!("+OS.verilog(ondeck_in.getName())+")", "olc_in==0" },
 112                       new Action[] {                                         ondeck_in, /*olc_in */ });
 113             new Event(new Object[] { using.isEmpty(),                        ondeck_in, /*olc_in,*/   "!("+OS.verilog(ondeck_in.getName())+")", "olc_in!=0" },
 114                       new Action[] { using.doFill() });
 115             new Event(new Object[] { circulating.isFull(),  using.isFull(),  ondeck_in, /*olc_in,*/   "!("+OS.verilog(ondeck_in.getName())+")", "olc_in==0" },
 116                       new Action[] { circulating.doDrain(), using.doDrain(), ondeck_in, /*olc_in */});
 117             new Event(new Object[] { circulating.isFull(),  using.isFull(),  ondeck_in, /*olc_in,*/   "!("+OS.verilog(ondeck_in.getName())+")", "olc_in!=0", doResetOndeck.isEmpty() },
 118                       new Action[] {                                         out, /*olc_in,*/ doResetOndeck.doFill() });
 119
 120         }
 121     }
 122
 123     public static class DockModule extends Module {
 124
 125         public DockModule(boolean inbox) {
 126             super(inbox ? "inbox" : "outbox");
 127
 128             int dfifo_width = inbox ? WIDTH_WORD+1 : 1;
 129
 130             // FIXME: assumes DISPATCH_PATH is at top of word!!!
 131             Module ififo_m   = new FifoModule(INSTRUCTION_FIFO_SIZE, WIDTH_WORD-DISPATCH_PATH.valmaskwidth);
 132             Module dfifo_m   = new FifoModule(DATA_FIFO_SIZE,        dfifo_width);
 133
 134             Module.SourcePort instruction   = createInputPort("instruction", WIDTH_PACKET);
 135             Module.SourcePort fabric_in     = createInputPort("fabric_in",   WIDTH_PACKET);
 136
 137             // FIXME: at inboxes, no need for a full set of latches
 138             Module.SinkPort   fabric_out    = createOutputPort("fabric_out", WIDTH_PACKET, "");
 139
 140             Module.InstantiatedModule dfifo = new Module.InstantiatedModule(this, dfifo_m);
 141
 142             fabric_in.hasLatch = false;
 143             addPreCrap("assign "+dfifo.getInputPort("in").getName()+"_r = fabric_in_r;\n");
 144             addPreCrap("assign fabric_in_a = "+dfifo.getInputPort("in").getName()+"_a;\n");
 145             if (inbox)
 146                 addPreCrap("assign "+dfifo.getInputPort("in").getName()+
 147                            " = { "+PACKET_SIGNAL.verilogVal("fabric_in")+
 148                            ",    "+PACKET_DATA.verilogVal("fabric_in")+" };\n");
 149             else
 150                 addPreCrap("assign "+dfifo.getInputPort("in").getName()+
 151                            " = "+PACKET_SIGNAL.verilogVal("fabric_in")+";\n");
 152
 153
 154             Module.SourcePort dfifo_out = dfifo.getOutputPort("out");
 155             Module.SourcePort   ship_out    = null;
 156             if (!inbox) {
 157                 ship_out = createInputPort("ship",        WIDTH_WORD+1);
 158                 ship_out.hasLatch = true;
 159             }
 160
 161             Module.SinkPort   ship_in     = null;
 162             if (inbox) {
 163                 ship_in = createOutputPort("ship",        WIDTH_WORD+1, "");
 164                 ship_in.hasLatch = true;
 165             }
 166
 167             Module.Latch     ilc = new Latch("ilc", SET_ILC_FROM_IMMEDIATE.valmaskwidth+1, 1);
 168             Module.Latch     olc   = new Latch("olc", SET_OLC_FROM_IMMEDIATE.valmaskwidth, 1);
 169             Module.Latch     flag_a         = new Latch("flag_a", 1);
 170             Module.Latch     flag_b         = new Latch("flag_b", 1);
 171             Module.Latch     flag_c         = new Latch("flag_c", 1);
 172
 173             Module.StateWire  torpedoWaiting = new StateWire("torpedoWaiting", false);
 174
 175             Module.SinkPort   token_out     = fabric_out;
 176             Module.SourcePort token_in      = dfifo_out;
 177             Module.SinkPort   data_out      = inbox ? ship_in   : fabric_out;
 178             Module.SourcePort data_in       = inbox ? dfifo_out : ship_out;
 179
 180             Module.InstantiatedModule ififo = new Module.InstantiatedModule(this, ififo_m);
 181             Module.SinkPort   ififo_in      = ififo.getInputPort("in");
 182             Module.SourcePort ififo_out     = ififo.getOutputPort("out");
 183
 184             Module.SinkPort data_latch_output_p = createWirePort("data_latch_output", inbox ? WIDTH_WORD+1 : WIDTH_WORD);
 185
 186             Module.InstantiatedModule torpedo_branch = new Module.InstantiatedModule(this, new TorpedoBranchModule());
 187             instruction.connect(torpedo_branch.getInputPort("in"));
 188             Module.SourcePort efifo_out              = torpedo_branch.getOutputPort("out");
 189             Module.SourcePort torpedo_branch_torpedo = torpedo_branch.getOutputPort("torpedo");
 190
 191             Module.InstantiatedModule fanout_module = new Module.InstantiatedModule(this, new FanoutModule(WIDTH_WORD-DISPATCH_PATH.valmaskwidth));
 192             Module.SinkPort   fanout_module_in   = fanout_module.getInputPort("in");
 193             Module.SourcePort fanout_module_out0 = fanout_module.getOutputPort("out0");
 194             Module.SourcePort fanout_module_out1 = fanout_module.getOutputPort("out1");
 195
 196             Module.InstantiatedModule requeue_module = new Module.InstantiatedModule(this, new RequeueModule());
 197             Module.SinkPort   requeue_fabric_in = requeue_module.getInputPort("fabric_in");
 198             Module.SinkPort   requeue_ondeck    = requeue_module.getInputPort("ondeck_in");
 199             Module.SinkPort   requeue_olc_in    = requeue_module.getInputPort("olc_in");
 200             Module.SourcePort requeue_out       = requeue_module.getOutputPort("out");
 201
 202             efifo_out.connect(requeue_fabric_in);
 203             requeue_out.connect(ififo_in);
 204             ififo_out.connect(fanout_module_in);
 205             fanout_module_out0.connect(requeue_ondeck);
 206             Module.SourcePort ondeck = fanout_module_out1;
 207
 208             addPreCrap("assign data_latch_output = " + (inbox ? data_out.getName() : PACKET_DATA.verilogVal(data_out.getName()))+";");
 209             addPreCrap("wire ["+(Math.max(ilc.width,olc.width)-1)+":0] decremented;");
 210             addPreCrap("assign decremented = ("+SET_OLC_FROM_OLC_MINUS_ONE.verilog(ondeck.getName())+" ? {1'b0, olc} : ilc)-1;");
 211             addPreCrap("assign "+requeue_olc_in.getName()+" = olc;");
 212
 213             Assignable data_latch    = new SimpleAssignable(inbox ? data_out.getName() : PACKET_DATA.verilogVal(data_out.getName()));
 214             String data_latch_input  = inbox ? data_in.getName() : data_in.getName();
 215
 216             String magic_standing_value = "(1<<"+SET_ILC_FROM_IMMEDIATE.valmaskwidth+")";
 217             String done_executing       = "(ilc==0 || ilc==1 || !"+MOVE.verilog(ondeck.getName())+")";
 218
 219             // Torpedo Arrival
 220             new Event(new Object[] { torpedo_branch_torpedo, torpedoWaiting.isEmpty() },
 221                       new Action[] { torpedo_branch_torpedo, torpedoWaiting.doFill() });
 222
 223             String predicate_met =
 224                 "("+
 225                 "("+
 226                 "!"+MOVE.verilog(ondeck.getName())+" || ilc!=0"+
 227                 ") && ("+
 228                 "("+
 229                 P_ALWAYS.verilog(ondeck.getName())+
 230                 ") || ("+
 231                 P_OLC_ZERO.verilog(ondeck.getName())+"==(olc==0)"+
 232                 ")"+
 233                 ") && ("+
 234                 " " + P_A.verilog(ondeck.getName())+" ? flag_a"+
 235                 ":" + P_B.verilog(ondeck.getName())+" ? flag_b"+
 236                 ":" + P_NOT_A.verilog(ondeck.getName())+" ? !flag_a"+
 237                 ":" + P_NOT_B.verilog(ondeck.getName())+" ? !flag_b "+
 238                 ": 1"+
 239                 ")"+
 240                 ")";
 241
 242             // Torpedo strikes
 243             new Event(new Object[] {
 244                     ondeck,
 245                     data_out,
 246                     token_out,
 247                     predicate_met,
 248                     MOVE.verilog(ondeck.getName()),
 249                     I.verilog(ondeck.getName()),
 250                     torpedoWaiting.isFull()
 251                 },
 252                 new Object[] {
 253                     ondeck,
 254                     torpedoWaiting.doDrain(),
 255                     new AssignAction(olc, "0"),
 256                     new AssignAction(ilc, "1")
 257                 });
 258
 259             // Predicate not met
 260             new Event(new Object[] { ondeck, "!("+predicate_met+")" },
 261                       new Action[] { ondeck,
 262                                      new ConditionalAction(MOVE.verilog(ondeck.getName()), new AssignAction(ilc, "1"))
 263                       });
 264
 265             new Event(new Object[] { ondeck,
 266                                      data_out,
 267                                      token_out,
 268                                      predicate_met,
 269                                      "(!"+MOVE.verilog(ondeck.getName())+" || !"+I.verilog(ondeck.getName())+" || !"+torpedoWaiting.isFull()+")",
 270                                      new ConditionalTrigger(DI.verilog(ondeck.getName()), data_in),
 271                                      new ConditionalTrigger(TI.verilog(ondeck.getName()), token_in)
 272                       },
 273                       new Action[] {
 274                           new ConditionalAction(done_executing+" && "+MOVE.verilog(ondeck.getName()), new AssignAction(ilc, "1")),
 275                           new ConditionalAction(done_executing, ondeck),
 276                           new ConditionalAction("!"+done_executing,
 277                                                 new AssignAction(ilc,
 278                                                                  "ilc=="+magic_standing_value+"?"+magic_standing_value+":decremented")),
 279
 280                           new ConditionalAction(SET_OLC_FROM_DATA_LATCH.verilog(ondeck.getName()), new AssignAction(olc, "data_latch_output")),
 281                           new ConditionalAction(SET_OLC_FROM_IMMEDIATE.verilog(ondeck.getName()),
 282                                                 new AssignAction(olc, SET_OLC_FROM_IMMEDIATE.verilogVal(ondeck.getName()))),
 283                           new ConditionalAction(SET_OLC_FROM_OLC_MINUS_ONE.verilog(ondeck.getName()),
 284                                                 new AssignAction(olc, "olc==0 ? 0 : decremented")),
 285                           new ConditionalAction(SET_ILC_FROM_DATA_LATCH.verilog(ondeck.getName()), new AssignAction(ilc, "data_latch_output")),
 286                           new ConditionalAction(SET_ILC_FROM_IMMEDIATE.verilog(ondeck.getName()),
 287                                                 new AssignAction(ilc, SET_ILC_FROM_IMMEDIATE.verilogVal(ondeck.getName()))),
 288                           new ConditionalAction(SET_ILC_FROM_INFINITY.verilog(ondeck.getName()), new AssignAction(ilc, magic_standing_value)),
 289                           new ConditionalAction(SHIFT.verilog(ondeck.getName()),
 290                                                 new AssignAction(data_latch,
 291                                                                  "{ data_latch_output["+(WIDTH_WORD-1-SHIFT.valmaskwidth)+":0], "+
 292                                                                  SHIFT.verilogVal(ondeck.getName())+"}")),
 293                           new ConditionalAction(SET_IMMEDIATE.verilog(ondeck.getName()),
 294                                                 new AssignAction(data_latch,
 295                                                                  "{ {"+(WIDTH_WORD-FleetTwoFleet.DataLatch_WIDTH)+
 296                                                                  "{"+SET_IMMEDIATE_EXTEND.verilogVal(ondeck.getName())+"}}, "+
 297                                                                  SET_IMMEDIATE.verilogVal(ondeck.getName())+" }")),
 298                           new ConditionalAction(SET_FLAGS.verilog(ondeck.getName()), new AssignAction(flag_a, new_flag(SET_FLAGS_A.verilogVal(ondeck.getName())))),
 299                           new ConditionalAction(SET_FLAGS.verilog(ondeck.getName()), new AssignAction(flag_b, new_flag(SET_FLAGS_B.verilogVal(ondeck.getName())))),
 300                           new ConditionalAction(inbox
 301                                                 ? "("+DI.verilog(ondeck.getName())+" || "+TI.verilog(ondeck.getName())+")"
 302                                                 : "(!"+DI.verilog(ondeck.getName())+" && "+TI.verilog(ondeck.getName())+")",
 303                                                 new AssignAction(flag_c, dfifo_out.getBits(dfifo_width-1, dfifo_width-1))),
 304                           new ConditionalAction(DI.verilog(ondeck.getName()),    data_in),
 305                           new ConditionalAction(DO.verilog(ondeck.getName()),    data_out),
 306                           new ConditionalAction(FLUSH.verilog(ondeck.getName()), data_out),
 307                           inbox
 308                           ? new AssignAction(new SimpleAssignable(data_out.getName()+"["+WIDTH_WORD+"]"), FLUSH.verilog(ondeck.getName())+"?1:0")
 309                           : new ConditionalAction(DI.verilog(ondeck.getName()),   new AssignAction(flag_c, data_latch_input+"["+WIDTH_WORD+"]")),
 310                           new ConditionalAction(TI.verilog(ondeck.getName()),    token_in),
 311                           new ConditionalAction(TO.verilog(ondeck.getName()),    token_out),
 312                           new ConditionalAction(DC.verilog(ondeck.getName()),   new AssignAction(data_latch, data_latch_input)),
 313                           new AssignAction(new SimpleAssignable(PACKET_TOKEN.verilogVal(token_out.getName())), "("+TO.verilog(ondeck.getName())+")?1:0"),
 314                           new ConditionalAction(PATH_DATA.verilog(ondeck.getName()),
 315                                                 new AssignAction(new SimpleAssignable("{ "+PACKET_SIGNAL.verilogVal(token_out.getName())+", "+
 316                                                                                       PACKET_DEST.verilogVal(token_out.getName())+" }"),
 317                                                                  DISPATCH_PATH.verilogVal(data_latch_input))),
 318                           new ConditionalAction(PATH_IMMEDIATE.verilog(ondeck.getName()),
 319                                                 new AssignAction(new SimpleAssignable("{ "+PACKET_SIGNAL.verilogVal(token_out.getName())+", "+
 320                                                                                       PACKET_DEST.verilogVal(token_out.getName())+" }"),
 321                                                                  PATH_IMMEDIATE.verilogVal(ondeck.getName()))),
 322                       }
 323                       );
 324         }
 325
 326         private static String new_flag(String x) {
 327             return "("+
 328                 "( (("+x+" >> 0) & 1) & !flag_c) |" +
 329                 "( (("+x+" >> 1) & 1) &  flag_c) |" +
 330                 "( (("+x+" >> 2) & 1) & !flag_b) |" +
 331                 "( (("+x+" >> 3) & 1) &  flag_b) |" +
 332                 "( (("+x+" >> 4) & 1) & !flag_a) |" +
 333                 "( (("+x+" >> 5) & 1) &  flag_a) | 0" +
 334                 ")";
 335         }
 336     }
 337 }
 338