testCode/com/sun/vlsi/chips/marina/test/MarinaTest.java

   1 package com.sun.vlsi.chips.marina.test;
   2 /* -*- tab-width: 4 -*- */
   3 import java.util.ArrayList;
   4 import java.util.List;
   5
   6 import com.sun.async.test.BitVector;
   7 import com.sun.async.test.ChainControl;
   8 import com.sun.async.test.ChainG;
   9 import com.sun.async.test.ChainTest;
  10 import com.sun.async.test.ChipModel;
  11 import com.sun.async.test.HP34401A;
  12 import com.sun.async.test.Infrastructure;
  13 import com.sun.async.test.JtagSubchainTesterModel;
  14 import com.sun.async.test.JtagTester;
  15 import com.sun.async.test.ManualPowerChannel;
  16 import com.sun.async.test.NanosimModel;
  17 import com.sun.async.test.HsimModel;
  18 import com.sun.async.test.VerilogModel;
  19 import com.sun.async.test.Netscan4;
  20 import com.sun.async.test.PowerChannel;
  21 import com.sun.async.test.Pst3202Channel;
  22 import com.sun.async.test.SiliconChip;
  23 import com.sun.async.test.SimulationModel;
  24 import com.sun.async.test.VoltageReadable;
  25 import com.sun.vlsi.chips.marina.test.Marina.Ilc;
  26 import com.sun.vlsi.chips.marina.test.CmdArgs;
  27 import com.sun.vlsi.chips.marina.test.CmdArgs.Mode;
  28
  29 import edu.berkeley.fleet.api.Dock;
  30 import edu.berkeley.fleet.api.Instruction;
  31 import edu.berkeley.fleet.api.Predicate;
  32 import edu.berkeley.fleet.api.Instruction.Set.SetDest;
  33 import edu.berkeley.fleet.api.Instruction.Set.SetSource;
  34 import edu.berkeley.fleet.marina.MarinaFleet;
  35 import edu.berkeley.fleet.marina.MarinaPath;
  36
  37 /**
  38  * Tests for Marina
  39  */
  40 public class MarinaTest {
  41     public static final MarinaFleet marinaFleet = new MarinaFleet();
  42     public static final Dock dock = marinaFleet.getOnlyInputDock();
  43
  44     //--------------------------  constants -----------------------------------
  45     private static final String SCAN_CHAIN_XML = "marina.xml";
  46     private static final String NET_LIST = "marina.spi";
  47
  48     public static final int INSTR_SZ = 36;
  49
  50
  51     public static final Instruction.Set.FlagFunction CLEAR_FLAG
  52         = Instruction.Set.FlagFunction.ZERO;
  53     public static final Instruction.Set.FlagFunction SET_FLAG
  54         = Instruction.Set.FlagFunction.ZERO.add(Predicate.FlagA)
  55         .add(Predicate.NotFlagA);
  56     public static final Instruction.Set.FlagFunction A_FLAG
  57         = Instruction.Set.FlagFunction.ZERO.add(Predicate.FlagA);
  58
  59     public static final Instruction.Set.FlagFunction B_FLAG
  60         = Instruction.Set.FlagFunction.ZERO.add(Predicate.FlagB);
  61
  62     // COLUMN_LATENCY is a delay that is larger than the latency through an Infinity column
  63     private static final int COLUMN_LATENCY = 10; // nanoseconds
  64
  65
  66     // Officially, this should be the number of requeueing no-ops that
  67     // can be inserted into an idle dock whose OLC is nonzero.
  68     //
  69     // Less formally, this is roughly the number of stages of
  70     // buffering between the instruction insertion point and the
  71     // instruction ring, plus the capacity of the instruction ring.
  72     private static final int INSTRUCTION_IN_SATURATION_AMOUNT = 19;
  73
  74     // This is some number which is significantly greater than
  75     // INSTRUCTION_IN_SATURATION_AMOUNT.  Increasing it may slow the tests down, but
  76     // will never cause them to operate incorrectly.
  77     private static final int MORE_THAN_INSTRUCTION_IN_SATURATION_AMOUNT = 25;
  78
  79     // This is the number of items which can be in the instruction
  80     // fifo ring WITHOUT causing it to stop circulating.
  81     private static final int INSTRUCTION_RING_CAPACITY = 13;
  82
  83     // Officially, this should be the number of data items which can
  84     // be sent from the dock while the "data" proper stopper is in
  85     // the "stopped" state
  86     //
  87     // Less formally, this is roughly the number of stages of
  88     // buffering between the dock's data successor and the "data"
  89     // proper stopper
  90     /*
  91       FIXME: what is the correct value here?
  92       private static final int DATA_OUT_SATURATION_AMOUNT = XXX;
  93     */
  94
  95     // This is some number which is greater than
  96     // DATA_OUT_SATURATION_AMOUNT, but less than the capacity of the
  97     // instruction fifo.
  98     private static final int MORE_THAN_DATA_OUT_SATURATION_AMOUNT = 10;
  99
 100     // Nominal cycle time assuming 4 GHz throughput
 101     public static double CYCLE_TIME_NS;
 102
 103     //--------------------------------  types ---------------------------------
 104
 105     //--------------------------  private data --------------------------------
 106     private static long startTime;
 107
 108     public static Indenter indenter = new Indenter();
 109     private Marina marina;
 110     private ChipModel model;
 111     //private ChainControl cc;
 112     //private JtagTester tester;
 113     private CmdArgs cmdArgs;
 114     private PowerChannel corePowerSupply, padsPowerSupply;
 115     private VoltageReadable coreVoltmeter, voltmeterForCurrent;
 116
 117     private ChainTest ctD, ctR, ctC;
 118     private ChainControl ccD, ccR, ccC;
 119
 120     //--------------------------  private methods -----------------------------
 121     /** @return true if simulation. Return false if we're testing silicon. */
 122     private boolean sim() {return model instanceof SimulationModel;}
 123
 124     private void prln(String msg) {indenter.prln(msg);}
 125     private void pr(String msg) {indenter.pr(msg);}
 126     private void adjustIndent(int n) {indenter.adjustIndent(n);}
 127
 128     public static void fatal(boolean pred, String msg) { MarinaUtils.fatal(pred, msg); }
 129
 130     public static void fatalIfBitVectorsDoNotMatch(BitVector bv1, BitVector bv2) {
 131         // FIXME: better error reporting needed here
 132
 133         fatal(bv1.getNumBits()!=bv2.getNumBits(), "lengths do not match");
 134
 135         boolean mismatch = false;
 136         String err = "";
 137         for(int i=0; i<bv1.getNumBits(); i++) {
 138             if (bv1.get(i) != bv2.get(i)) {
 139                 mismatch = true;
 140                 err += ""+i+", ";
 141             }
 142         }
 143         fatal(mismatch, "bit vectors do not match on bits " + err + "\n  "+bv1+"\n  "+bv2);
 144     }
 145
 146     private static void printTestTime() {
 147         long endTime = System.currentTimeMillis();
 148         System.out.println("Test took: "+(endTime-startTime)/1000.0+"  sec");
 149     }
 150
 151     // Tell user what we're about to do
 152     private static void reportTask(CmdArgs args) {
 153         System.out.println("Begin testing Marina");
 154         switch (args.mode) {
 155             case WHOLE_CHIP_SCHEMATIC_PARASITICS:
 156                 System.out.println("  Simulate whole chip, schematic parasitics");
 157                 break;
 158             case WHOLE_CHIP_LAYOUT_PARASITICS:
 159                 System.out.println("  Simulate whole chip, layout parasitics");
 160                 break;
 161             case TEST_SILICON:
 162                 System.out.println("  Test silicon");
 163                 break;
 164             default:
 165                 fatal(true, "unrecognized CmdArgs.Mode");
 166                 return;
 167         }
 168     }
 169     private void setUpSuppliesAndMeters(Station station) {
 170         // set up power supplies and meters
 171         if (!sim()) {
 172             prln("Testing station: "+station);
 173             Infrastructure.gpibControllers = new int[] {0};
 174             switch (cmdArgs.station) {
 175                 case ONE:
 176                     corePowerSupply = new Pst3202Channel("ch1", "HPST3202", 1);
 177                     padsPowerSupply = new Pst3202Channel("ch2", "HPST3202", 2);
 178                     break;
 179                 case TWO:
 180                     corePowerSupply = new Pst3202Channel("ch1", "HPST3202B", 1);
 181                     padsPowerSupply = new Pst3202Channel("ch2", "HPST3202B", 2);
 182                     break;
 183                 default:
 184                     fatal(true, "Unrecognized station: "+cmdArgs.station);
 185             }
 186             corePowerSupply.setCurrent((float)1.7);
 187             corePowerSupply.setVoltageWait((float)1.0);
 188
 189             padsPowerSupply.setCurrent((float)0.100);
 190             padsPowerSupply.setVoltageWait((float)1.8);
 191
 192             coreVoltmeter = new HP34401A(station.coreVoltmeter);
 193             voltmeterForCurrent = new HP34401A(station.currentVoltmenter);
 194         }
 195     }
 196
 197     private MarinaTest(String[] args) {
 198         cmdArgs = new CmdArgs(args);
 199         reportTask(cmdArgs);
 200         if (cmdArgs.mode==Mode.TEST_SILICON) doSilicon(); else doSim();
 201     }
 202
 203     private void doSim() {
 204         String netListName;
 205         switch (cmdArgs.mode) {
 206             case WHOLE_CHIP_SCHEMATIC_PARASITICS:
 207                 netListName = NET_LIST;
 208                 break;
 209             case WHOLE_CHIP_LAYOUT_PARASITICS:
 210                 netListName = "marina_pads_guts.spi";
 211                 break;
 212             default:
 213                 fatal(true, "unrecognized CmdArgs.Mode");
 214                 return;
 215         }
 216         model = cmdArgs.useVerilog
 217             ? new VerilogModel()
 218             : cmdArgs.useHsim
 219             ? new HsimModel()
 220             : new NanosimModel();
 221
 222         ((SimulationModel)model).setOptimizedDirectReadsWrites(true);
 223
 224         CYCLE_TIME_NS = cmdArgs.useVerilog ? (100*20) : 0.250;
 225
 226         //tester = ((SimulationModel)model).createJtagTester("TCK", "TMS", "TRSTb", "TDI", "TDO");
 227         ChainControls ccs = new ChainControls();
 228         JtagTester testerD, testerR, testerC;
 229         testerD = ((SimulationModel)model).createJtagSubchainTester("sid[1:9]", null);
 230         testerR = ((SimulationModel)model).createJtagSubchainTester("sir[1:9]", null);
 231         testerC = ((SimulationModel)model).createJtagSubchainTester("sic[1:9]", null);
 232         testerD.printInfo = testerR.printInfo = testerC.printInfo = false;
 233
 234         int khz   = model instanceof VerilogModel ?  100000 : 1000000;
 235
 236         ccD = new ChainControl(SCAN_CHAIN_XML, testerD, 1.8f, khz);
 237         ccR = new ChainControl(SCAN_CHAIN_XML, testerR, 1.8f, khz);
 238         ccC = new ChainControl(SCAN_CHAIN_XML, testerC, 1.8f, khz);
 239         ccD.noTestSeverity = ccR.noTestSeverity = ccC.noTestSeverity = Infrastructure.SEVERITY_NOMESSAGE;
 240
 241         PowerChannel pc = new ManualPowerChannel("pc", false);
 242
 243         ctD = new ChainTest(ccD, pc);
 244         ctR = new ChainTest(ccR, pc);
 245         ctC = new ChainTest(ccC, pc);
 246
 247         ccs.addChain(Marina.DATA_CHAIN, ccD);
 248         ccs.addChain(Marina.REPORT_CHAIN, ccR);
 249         ccs.addChain(Marina.CONTROL_CHAIN, ccC);
 250
 251         marina = new Marina(ccs, model, !cmdArgs.jtagShift, indenter);
 252
 253         if (model instanceof VerilogModel)
 254             ((SimulationModel)model).start("verilog", "marina.v", VerilogModel.DUMPVARS, !cmdArgs.jtagShift);
 255         else if (model instanceof HsimModel)
 256             ((SimulationModel)model).start("hsim64", netListName, 0, !cmdArgs.jtagShift);
 257         else
 258             ((SimulationModel)model).start("nanosim -c cfg", netListName, 0, !cmdArgs.jtagShift);
 259
 260         ccC.resetInBits();
 261         ccC.shift(Marina.CONTROL_CHAIN, false, true);
 262
 263         doOneTest(cmdArgs.testNum);
 264
 265         ((SimulationModel)model).finish();
 266     }
 267     private void doSilicon() {
 268         model = new SiliconChip();
 269         String ip = cmdArgs.station.ipAddr;
 270         JtagTester tester = new Netscan4(ip, cmdArgs.station.jtagChannel);
 271         tester.printInfo = false;
 272         int khz = 1000;
 273         ChainControl cc = new ChainControl("???", tester, 1.8f, khz);
 274         cc.noTestSeverity = Infrastructure.SEVERITY_NOMESSAGE;
 275         ChainControls ccs = new ChainControls();
 276         ccs.addChain(Marina.DATA_CHAIN, cc);
 277         ccs.addChain(Marina.REPORT_CHAIN, cc);
 278         ccs.addChain(Marina.CONTROL_CHAIN, cc);
 279         marina = new Marina(ccs, model, false, indenter);
 280         PowerChannel pc = new ManualPowerChannel("pc", false);
 281         ChainTest ct = new ChainTest(cc, pc);
 282         ct.testAllChains("marina", Infrastructure.SEVERITY_WARNING);
 283         doOneTest(cmdArgs.testNum);
 284         setUpSuppliesAndMeters(cmdArgs.station);
 285     }
 286
 287     /** In the absence of looping, the longest path through Infinity is 4 column delays */
 288     private void waitUntilQuiescent() {
 289         model.waitNS(4*COLUMN_LATENCY);
 290     }
 291
 292     private double readCurrent() {
 293         return voltmeterForCurrent.readVoltage() / cmdArgs.station.ammeterShuntResistance;
 294     }
 295
 296     /** Generate List of BitVectors where Token=true, high 25 data bits
 297      * are alternating ones and zeros, low 12 data bits increment from
 298      * zero, and address is given by addr. */
 299     private List<BitVector> makeIncrDataConstAdr(int num, int addr) {
 300         List<BitVector> ans = new ArrayList<BitVector>();
 301         BitVector dHi = new BitVector(25, "dataHi");
 302         BitVector dLo = new BitVector(12, "dataLo");
 303         BitVector t = new BitVector("1", "token");
 304         BitVector a = new BitVector(14, "addr");
 305         dHi.setFromLong(0x00aaaaa);
 306         a.setFromLong(addr);
 307         for (int i=0; i<num; i++) {
 308             dLo.setFromLong(i);
 309             ans.add(dHi.cat(dLo).cat(t).cat(a));
 310             dHi = dHi.not();
 311         }
 312         return ans;
 313     }
 314     private void stopToStop(ProperStopper s1, ProperStopper s2,
 315                             Counter ctr,
 316                             List<BitVector> din) {
 317         prln("Begin stopToStop");
 318         adjustIndent(2);
 319
 320         s1.stop();
 321
 322         long ctrStart = ctr==null ? 0 : ctr.getCount();
 323
 324         s1.fillMany(din);
 325         waitUntilQuiescent();
 326
 327         List<BitVector> dout = s2.drainMany();
 328
 329         MarinaUtils.compareItemsOrdered(din, dout);
 330
 331         if (ctr!=null) {
 332             long ctrEnd = ctr.getCount();
 333             long delta = ctrEnd - ctrStart;
 334             long expect = din.size();
 335             fatal(delta!=expect,
 336                   "counter delta wrong: expected delta: "+expect+
 337                   " counter before:"+ctrStart+" counter after:"+ctrEnd);
 338         }
 339
 340         adjustIndent(-2);
 341         prln("End stopToStop");
 342     }
 343     /** Burst data from src to dst. gate is stopped while loading src. gate
 344      * is then run to allow the burst to flow. */
 345     private void stopToStopBurst(ProperStopper src, ProperStopper gate,
 346                                  ProperStopper dst,
 347                                  Counter ctr,
 348                                  List<BitVector> din) {
 349         prln("Begin stopToStopBurst test");
 350         adjustIndent(2);
 351
 352         src.stop();
 353         gate.stop();
 354
 355         long ctrStart = ctr==null ? 0 : ctr.getCount();
 356
 357         src.fillMany(din);
 358         waitUntilQuiescent();
 359
 360         // open the gate to start the burst
 361         gate.run();
 362         waitUntilQuiescent();
 363
 364         List<BitVector> dout = dst.drainMany();
 365
 366         MarinaUtils.compareItemsOrdered(din, dout);
 367
 368         if (ctr!=null) {
 369             long ctrEnd = ctr.getCount();
 370             long delta = ctrEnd - ctrStart;
 371
 372             long expectA = din.size();
 373             fatal(delta!=expectA,
 374                   "counter delta wrong: expected delta: "+expectA+
 375                   " counter before:"+ctrStart+" counter after:"+ctrEnd);
 376         }
 377
 378         adjustIndent(-2);
 379         prln("End stopToStopBurst test");
 380     }
 381
 382     private void stopToStopOne(ProperStopper s1, ProperStopper s2,
 383                                Counter ctr, int adr) {
 384         prln("Begin stopToStopOne");
 385         adjustIndent(2);
 386
 387         List<BitVector> din = makeIncrDataConstAdr(1, adr);
 388         stopToStop(s1, s2, ctr, din);
 389
 390         adjustIndent(-2);
 391         prln("End stopToStopOne");
 392     }
 393
 394     private void stopToStopThree(ProperStopper s1, ProperStopper s2,
 395                                  Counter ctr, int adr) {
 396         prln("Begin stopToStopOne");
 397         adjustIndent(2);
 398
 399         List<BitVector> din = makeIncrDataConstAdr(3, adr);
 400         stopToStop(s1, s2, ctr, din);
 401
 402         adjustIndent(-2);
 403         prln("End stopToStopOne");
 404     }
 405
 406     private int indexOf(BitVector o, List<BitVector> dIn) {
 407         for (int i=0; i<dIn.size(); i++) {
 408             if (o.equals(dIn.get(i)))  return i;
 409         }
 410         return -1;
 411     }
 412     private String ringDump(List<BitVector> dIn, List<BitVector> dOut) {
 413         StringBuffer sb = new StringBuffer();
 414         sb.append("  ring dump: ");
 415         for (BitVector o : dOut) {
 416             sb.append(indexOf(o, dIn)+" ");
 417         }
 418         return sb.toString();
 419     }
 420
 421     private int[][] makeIntArray2D(int a, int b) {
 422         int[][] ans = new int[a][];
 423         for (int i=0; i<a; i++) ans[i] = new int[b];
 424         return ans;
 425     }
 426
 427     //=========================================================================
 428     // Put top level tests here
 429
 430     private void testChains(Marina marina) {
 431         prln("Testing control chain...");
 432         ctC.testOneChain(Marina.CONTROL_CHAIN, Infrastructure.SEVERITY_WARNING);
 433         ccC.resetInBits();
 434         ccC.shift(Marina.CONTROL_CHAIN, false, true);
 435
 436         prln("Testing data chain...");
 437         ctD.testOneChain(Marina.DATA_CHAIN, Infrastructure.SEVERITY_WARNING);
 438         //ccD.resetInBits();
 439         //ccD.shift(Marina.DATA_CHAIN, false, true);
 440
 441         prln("Testing report chain...");
 442         ctR.testOneChain(Marina.REPORT_CHAIN, Infrastructure.SEVERITY_WARNING);
 443         //ccR.resetInBits();
 444         //ccR.shift(Marina.REPORT_CHAIN, false, true);
 445     }
 446
 447     private void testProperStoppers(Marina marina) {
 448         prln("Begin testProperStoppers");
 449         adjustIndent(2);
 450
 451         for(ProperStopper ps : new ProperStopper[] { marina.data, marina.instrIn }) {
 452
 453             prln("testing " + (ps == marina.data ? "data" : "instruction") + " stopper");
 454             adjustIndent(2);
 455
 456             prln("un-stopping stopper");
 457             ps.run();
 458             fatal( ps.getStopped(), "stopper should not have been stopped, but was");
 459
 460             prln("stopping stopper");
 461             ps.stop();
 462             fatal( !ps.getStopped(), "stopper should have been stopped, but was not");
 463
 464             adjustIndent(-2);
 465         }
 466
 467         adjustIndent(-2);
 468     }
 469
 470     private void sendInstructions(Marina marina) {
 471         prln("Begin sendInstructions");
 472         adjustIndent(2);
 473
 474         List<BitVector> din = new ArrayList<BitVector>();
 475
 476         BitVector count = new BitVector(MarinaPacket.WORD_WIDTH,"count");
 477         BitVector one = new BitVector(MarinaPacket.WORD_WIDTH, "one");
 478         count.setFromLong(0);
 479         one.setFromLong(1);
 480         for (int i=0; i<3; i++) {
 481             din.add(count);
 482             count = count.add(one);
 483         }
 484
 485         for(BitVector d : din)
 486             marina.instrIn.fill(new MarinaPacket(d, false, MarinaPacket.null_path));
 487
 488         adjustIndent(-2);
 489         prln("End sendInstructions");
 490     }
 491
 492     private void sendToken(Marina marina) {
 493         prln("Begin sendToken");
 494         adjustIndent(2);
 495
 496         //getCtrsFlags(marina);
 497
 498         int nbToks = marina.getNumTokens();
 499         fatal(nbToks!=0, "Expected no tokens on initialization but got: "+nbToks+" tokens");
 500
 501         marina.instrIn.fill(setIlc(1));
 502         marina.instrIn.fill(SEND_TOKEN);
 503         nbToks = marina.getNumTokens();
 504         fatal(nbToks!=1, "Expected one token to emerge but got: "+nbToks+" tokens");
 505
 506         adjustIndent(-2);
 507         prln("End sendToken");
 508     }
 509
 510     private void sendData(Marina marina) {
 511         prln("Begin sendData");
 512         adjustIndent(2);
 513
 514         edu.berkeley.fleet.api.BitVector bv = new edu.berkeley.fleet.api.BitVector(13);
 515         for(int i=0; i<bv.length(); i+=2) bv.set(i, false);
 516         MarinaPath path = new MarinaPath((MarinaFleet)dock.getShip().getFleet(), bv);
 517
 518         marina.instrIn.fill(setIlc(1));
 519         marina.instrIn.fill(SEND_DATA);
 520
 521         List<BitVector> dataItems = marina.data.drainMany();
 522         fatal(dataItems.size()!=1, "Expected one data item to emerge but got: "+dataItems.size()+" data items");
 523
 524         MarinaPacket mp = new MarinaPacket(dataItems.get(0));
 525         fatal(mp.tokenhood, "Expected tokenhood=data, but got tokenhood=token");
 526
 527         adjustIndent(-2);
 528         prln("End sendData");
 529     }
 530
 531     private void sendDataIlcInfinite(Marina marina) {
 532         prln("Begin sendDataIlcInfinite");
 533         adjustIndent(2);
 534
 535         marina.fillSouthProperStopper(new Instruction[] {
 536                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,SetSource.Infinity),
 537                 SEND_DATA,
 538             });
 539
 540         // more than MAX_ILC
 541         int howmany = 70;
 542         List<BitVector> dataItems = marina.data.drainMany(howmany);
 543         fatal(dataItems.size()!=howmany,
 544               "Expected an unending supply of data items to emerge but only got got: "+dataItems.size());
 545
 546         adjustIndent(-2);
 547         prln("End sendDataIlcInfinite");
 548     }
 549
 550     private Instruction setOlc(int olc) {
 551         return new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, olc);
 552     }
 553     private Instruction setOlcIfZero(int olc) {
 554         return new Instruction.Set(dock,Predicate.Default,SetDest.OuterLoopCounter, olc);
 555     }
 556     private Instruction setIlc(int ilc) {
 557         return new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, ilc);
 558     }
 559
 560     private void testFlagD(Marina marina) {
 561         prln("Begin testFlagD");
 562         adjustIndent(2);
 563
 564         List<BitVector> toks;
 565
 566         Predicate only_if_olc_zero    = Predicate.FlagD;
 567         Predicate only_if_olc_nonzero = Predicate.Default;
 568
 569         marina.instrIn.fill(setIlc(1));
 570
 571         for(int olc : new int[] { 1, 0 }) {
 572             for(boolean predicate_olc_nonzero : new boolean[] { true, false }) {
 573                 prln("Attempting send data item with "+
 574                      "olc=="+olc+" and "+
 575                      "predicate olc"+(predicate_olc_nonzero?"!=0":"==0"));
 576                 adjustIndent(2);
 577
 578                 marina.fillSouthProperStopper(new Instruction[] {
 579                         setOlc(olc),
 580                         new Instruction.Move(dock,
 581                                              predicate_olc_nonzero  // predicate
 582                                              ? only_if_olc_nonzero
 583                                              : only_if_olc_zero
 584                                              ,
 585                                              false,                 // torpedoable
 586                                              null,                  // path
 587                                              false,                 // tokenIn
 588                                              false,                 // dataIn
 589                                              false,                 // latchData
 590                                              false,                 // latchPath
 591                                              true,                  // dataOut
 592                                              false                  // tokenOut
 593                                              ),
 594                     });
 595                 expectNorthFifoExactly((predicate_olc_nonzero == (olc!=0)) ? 1 : 0);
 596
 597                 for(int i=0; i<olc; i++)
 598                     marina.instrIn.fill(DEC);
 599
 600                 adjustIndent(-2);
 601             }
 602         }
 603         adjustIndent(-2);
 604         prln("End testFlagD");
 605     }
 606
 607     private void testPredicationOnAB(Marina marina) {
 608         prln("Begin testPredicationOnAB");
 609         adjustIndent(2);
 610
 611         List<BitVector> dItems;
 612
 613         marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, 1));
 614         marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, 1));
 615
 616         for(boolean flag_a : new boolean[] { false, true }) {
 617             for(boolean flag_b : new boolean[] { false, true }) {
 618                 prln("Setting flags, a="+flag_a+" b="+flag_b);
 619                 marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,
 620                                                         flag_a
 621                                                         ? Instruction.Set.FlagFunction.ONE
 622                                                         : Instruction.Set.FlagFunction.ZERO,
 623                                                         flag_b
 624                                                         ? Instruction.Set.FlagFunction.ONE
 625                                                         : Instruction.Set.FlagFunction.ZERO
 626                                                         ));
 627                 getCtrsFlags(marina);
 628
 629                 adjustIndent(2);
 630                 for(Predicate predicate : new Predicate[] {
 631                         Predicate.Default,
 632                         Predicate.FlagA,
 633                         Predicate.FlagB,
 634                         Predicate.NotFlagA,
 635                         Predicate.NotFlagB,
 636                     }) {
 637
 638                     prln("Attempting send data with a="+flag_a+", b="+flag_b+", predicate="+predicate);
 639                     adjustIndent(2);
 640                     marina.instrIn.fill(new Instruction.Move(dock,
 641                                                              predicate,  // predicate
 642                                                              false,      // torpedoable
 643                                                              null,       // path
 644                                                              false,      // tokenIn
 645                                                              false,      // dataIn
 646                                                              false,      // latchData
 647                                                              false,      // latchPath
 648                                                              true,       // dataOut
 649                                                              false       // tokenOut
 650                                                              ));
 651                     adjustIndent(-2);
 652                     dItems = marina.data.drainMany();
 653                     int expected = predicate.evaluate(flag_a, flag_b, false, false) ? 1 : 0;
 654                     fatal(dItems.size()!=expected, "Expected "+expected+" data items to emerge but got: "+
 655                           dItems.size()+" items(s)");
 656                 }
 657                 adjustIndent(-2);
 658             }
 659         }
 660         adjustIndent(-2);
 661         prln("End testPredicationOnAB");
 662     }
 663
 664
 665
 666     private void getCtrsFlags(Marina marina) {
 667         prln("begin getCtrsFlags");
 668         adjustIndent(2);
 669
 670         int olc = marina.getOLC();
 671         prln("OLC=="+olc);
 672
 673         Ilc ilc = marina.getILC();
 674         prln("ILC.done=="+ilc.getDone()+
 675              " ILC.infinity=="+ilc.getInfinity()+
 676              " ILC.count=="+ilc.getCount());
 677         prln("flagA=="+marina.getFlagA());
 678         prln("flagB=="+marina.getFlagB());
 679         adjustIndent(-2);
 680         prln("end getCtrsFlags");
 681     }
 682
 683     private void walkOneOLC(Marina marina) {
 684         prln("Begin walkOneOLC");
 685         adjustIndent(2);
 686         for (int i=5; i>=0; i--) {
 687             int inOlc = 1<<i;
 688             marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, inOlc));
 689             int outOlc = marina.getOLC();
 690             fatal(outOlc!=inOlc, "walkOneOLC: got="+outOlc+" expected="+inOlc);
 691             prln("walkOneOLC: "+inOlc+" checks out");
 692         }
 693         adjustIndent(-2);
 694         prln("End walkOneOLC");
 695     }
 696     private void walkOneILC(Marina marina) {
 697         prln("Begin walkOneILC");
 698         adjustIndent(2);
 699         for (int i=0; i<6; i++) {
 700             // Mask off the "zero" bit position
 701             int inIlc = 1 << i;
 702             prln("inIlc="+inIlc);
 703             marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, inIlc));
 704             Ilc ilc = marina.getILC();
 705             int outIlc = ilc.getCount();
 706             fatal(outIlc!=inIlc, "bad ILC count: "+outIlc+" expected: "+inIlc);
 707             fatal(ilc.getInfinity(), "bad Infinity bit: true");
 708         }
 709         prln("Now test the infinity bit");
 710         marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, SetSource.Infinity));
 711         Ilc ilc = marina.getILC();
 712         fatal(!ilc.getInfinity(), "bad Infinity bit: false");
 713         adjustIndent(-2);
 714         prln("End walkOneILC");
 715     }
 716     private void countIlc(Marina marina) {
 717         final int maxIlc = 63;
 718         prln("Begin countIlc");
 719         adjustIndent(2);
 720
 721         marina.instrIn.fill(new
 722                             Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, maxIlc));
 723
 724         int ilc = marina.getILC().getCount();
 725         fatal(ilc!=maxIlc, "bad ILC count: "+ilc+" expected: "+maxIlc);
 726
 727         prln("execute a move instruction that does nothing except decrement the ILC to zero");
 728         marina.instrIn.fill(
 729                             new Instruction.Move(dock,
 730                                                  Predicate.IgnoreFlagD, // predicate
 731                                                  false,                 // torpedoable
 732                                                  null,                  // path
 733                                                  false,                 // tokenIn
 734                                                  false,                 // dataIn
 735                                                  false,                 // latchData
 736                                                  false,                 // latchPath
 737                                                  false,                 // dataOut
 738                                                  false                  // tokenOut
 739                                                  ));
 740
 741         // wait for ILC to count from 63 to 0
 742         model.waitNS(128 * CYCLE_TIME_NS);
 743         //model.waitNS(10000);
 744
 745         prln("Check that ILC==0");
 746         ilc = marina.getILC().getCount();
 747         fatal(ilc!=0, "bad ILC count: "+ilc+" expected: "+0);
 748
 749         adjustIndent(-2);
 750         prln("End countIlc");
 751     }
 752     // Note: countOlc takes 44 minutes to run on nanosim
 753     private void countOlc(Marina marina) {
 754         int maxOlc = 63;
 755         prln("Begin countOlc");
 756         adjustIndent(2);
 757
 758         marina.instrIn.fill(setOlc(maxOlc));
 759
 760         for (int i=maxOlc; i>=0; i--) {
 761             model.waitNS(128 * CYCLE_TIME_NS);
 762             prln("OLC should be: "+i);
 763             int olc = marina.getOLC();
 764             fatal(olc!=i, "bad OLC: "+olc+" expected: "+i);
 765             marina.instrIn.fill(new
 766                                 Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, SetSource.Decrement));
 767         }
 768
 769         adjustIndent(-2);
 770         prln("End countOlc");
 771     }
 772
 773     private void saturateInstructionFifo(Marina marina, Instruction instruction, int quantity, boolean expect_it_to_jam_up) {
 774         prln("Inserting "+quantity+" copies of \"" + instruction + "\"");
 775         adjustIndent(2);
 776         int i=0;
 777         for(i=0; i<quantity; i++) {
 778             prln("Inserting instruction " + (i+1) +"/"+ quantity);
 779             marina.instrIn.fill(instruction);
 780             boolean jammed = (marina.instrIn.getFillStateWire()==MarinaUtils.StateWireState.FULL);
 781             if (jammed && expect_it_to_jam_up) {
 782                 prln("Stopper remained full after inserting instruction; this was expected; we are happy.");
 783                 adjustIndent(-2);
 784                 return;
 785             }
 786             fatal(jammed, "Instruction stopper did not drain after inserting " + (i+1) + " instructions; not good!");
 787         }
 788         fatal(expect_it_to_jam_up, "Expected instruction stopper to jam up, but it did not");
 789         adjustIndent(-2);
 790         prln("Successfully inserted " + i + " instructions");
 791     }
 792
 793     private static MarinaPath null_path = new MarinaPath((MarinaFleet)dock.getShip().getFleet(),
 794                                                          MarinaUtils.sunToBerk(MarinaPacket.null_path));
 795
 796     private static final Instruction DEC =
 797         new Instruction.Set(dock,Predicate.Default,SetDest.OuterLoopCounter, SetSource.Decrement);
 798
 799     private static final Instruction FLAG_NOP =
 800         new Instruction.Set(dock, Predicate.IgnoreFlagD,
 801                             CLEAR_FLAG.add(Predicate.FlagA),
 802                             CLEAR_FLAG.add(Predicate.FlagB));
 803
 804     private static final Instruction NOP =
 805         new Instruction.Move(dock,
 806                              Predicate.IgnoreFlagD,   /* predicate   */
 807                              false,                 /* torpedoable */
 808                              null,                  /* path        */
 809                              false,                 /* tokenIn     */
 810                              false,                 /* dataIn      */
 811                              false,                 /* latchData   */
 812                              false,                 /* latchPath   */
 813                              false,                 /* dataOut     */
 814                              false                  /* tokenOut    */
 815                              );
 816
 817     private static final Instruction SEND_DATA =
 818         new Instruction.Move(dock,
 819                              Predicate.IgnoreFlagD,   /* predicate   */
 820                              false,                 /* torpedoable */
 821                              null_path,                  /* path        */
 822                              false,                 /* tokenIn     */
 823                              false,                 /* dataIn      */
 824                              false,                 /* latchData   */
 825                              false,                 /* latchPath   */
 826                              true,                  /* dataOut     */
 827                              false                  /* tokenOut    */
 828                              );
 829
 830     private static final Instruction SEND_DATA_IF_D_NOT_SET =
 831         new Instruction.Move(dock,
 832                              Predicate.Default,     /* predicate   */
 833                              false,                 /* torpedoable */
 834                              null_path,             /* path        */
 835                              false,                 /* tokenIn     */
 836                              false,                 /* dataIn      */
 837                              false,                 /* latchData   */
 838                              false,                 /* latchPath   */
 839                              true,                  /* dataOut     */
 840                              false                  /* tokenOut    */
 841                              );
 842
 843     private static final Instruction TORPEDOABLE_RECV_DATA =
 844         new Instruction.Move(dock,
 845                              Predicate.IgnoreFlagD, /* predicate   */
 846                              true,                  /* torpedoable */
 847                              null,                  /* path        */
 848                              false,                 /* tokenIn     */
 849                              true,                  /* dataIn      */
 850                              true,                  /* latchData   */
 851                              false,                 /* latchPath   */
 852                              false,                 /* dataOut     */
 853                              false                  /* tokenOut    */
 854                              );
 855
 856     private static final Instruction RECV_DATA =
 857         new Instruction.Move(dock,
 858                              Predicate.IgnoreFlagD,   /* predicate   */
 859                              false,                 /* torpedoable */
 860                              null,                  /* path        */
 861                              false,                 /* tokenIn     */
 862                              true,                  /* dataIn      */
 863                              true,                  /* latchData   */
 864                              false,                 /* latchPath   */
 865                              false,                 /* dataOut     */
 866                              false                  /* tokenOut    */
 867                              );
 868
 869     private static final Instruction SEND_TOKEN =
 870         new Instruction.Move(dock,
 871                              Predicate.IgnoreFlagD,   /* predicate   */
 872                              false,                 /* torpedoable */
 873                              null_path,                  /* path        */
 874                              false,                 /* tokenIn     */
 875                              false,                 /* dataIn      */
 876                              false,                 /* latchData   */
 877                              false,                 /* latchPath   */
 878                              false,                 /* dataOut     */
 879                              true                   /* tokenOut    */
 880                              );
 881
 882     private static final Instruction RECV_TOKEN =
 883         new Instruction.Move(dock,
 884                              Predicate.IgnoreFlagD,   /* predicate   */
 885                              false,                 /* torpedoable */
 886                              null,                  /* path        */
 887                              true,                  /* tokenIn     */
 888                              false,                 /* dataIn      */
 889                              false,                 /* latchData   */
 890                              false,                 /* latchPath   */
 891                              false,                 /* dataOut     */
 892                              false                  /* tokenOut    */
 893                              );
 894
 895
 896     private void expectNorthFifoNoMoreThan(int num) {
 897         model.waitNS(128 * CYCLE_TIME_NS);
 898         List<BitVector> dataItems = marina.data.drainMany(num+1);
 899         fatal(dataItems.size()>num,
 900               "Expected no more than "+num+
 901               " data items to emerge but got at least: "+dataItems.size());
 902     }
 903     private void expectNorthFifoExactly(int num) {
 904         model.waitNS(128 * CYCLE_TIME_NS);
 905         List<BitVector> dataItems = marina.data.drainMany(num+1);
 906         fatal(dataItems.size()!=num,
 907               "Expected exactly "+num+
 908               " data items to emerge but got at least: "+dataItems.size());
 909     }
 910     private void expectTokensNoMoreThan(int num) {
 911         int x = marina.getNumTokens();
 912         List<BitVector> dataItems = marina.data.drainMany(num+1);
 913         fatal(x>num,
 914               "Expected no more than "+num+
 915               " data items to emerge but got at least: "+x);
 916     }
 917     private void expectTokensExactly(int num) {
 918         int x = marina.getNumTokens();
 919         fatal(x!=num,
 920               "Expected exactly "+num+
 921               " data items to emerge but got at least: "+x);
 922     }
 923
 924     private void testFlagDRecomputationTime(Marina marina) {
 925         marina.instrIn.fill(setIlc(1));
 926         marina.fillSouthProperStopper(new Instruction[] {
 927                 RECV_DATA,
 928                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,0),
 929                 SEND_DATA_IF_D_NOT_SET
 930             });
 931         marina.fillNorthProperStopper();
 932         expectNorthFifoNoMoreThan(0);
 933
 934         marina.fillSouthProperStopper(new Instruction[] {
 935                 RECV_DATA,
 936                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,1),
 937                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,SetSource.Decrement),
 938                 SEND_DATA_IF_D_NOT_SET
 939             });
 940         marina.fillNorthProperStopper();
 941         expectNorthFifoNoMoreThan(0);
 942
 943         marina.fillSouthProperStopper(new Instruction[] {
 944                 RECV_DATA,
 945                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,2),
 946                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,SetSource.Decrement),
 947                 SEND_DATA_IF_D_NOT_SET
 948             });
 949         marina.fillNorthProperStopper();
 950         expectNorthFifoExactly(1);
 951         marina.instrIn.fill(DEC);
 952
 953         marina.fillSouthProperStopper(new Instruction[] {
 954                 RECV_DATA,
 955                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,0),
 956                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,1),
 957                 SEND_DATA_IF_D_NOT_SET
 958             });
 959         marina.fillNorthProperStopper();
 960         expectNorthFifoExactly(1);
 961     }
 962
 963     private void testTailWaitsForHead(Marina marina) {
 964         marina.instrIn.fill(setIlc(1));
 965         marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, 63));
 966
 967         marina.enableInstructionSend(false);
 968         marina.enableInstructionRecirculate(true);
 969
 970         marina.instrIn.fill(TORPEDOABLE_RECV_DATA);
 971         marina.instrIn.fill(new Instruction.Head(dock));
 972         marina.instrIn.fill(SEND_DATA);
 973         marina.instrIn.fill(TORPEDOABLE_RECV_DATA);
 974         marina.instrIn.fill(SEND_TOKEN);
 975         marina.instrIn.fill(TORPEDOABLE_RECV_DATA);
 976         marina.instrIn.fill(new Instruction.Tail(dock));
 977         marina.instrIn.fillTorpedo();
 978
 979         marina.enableInstructionRecirculate(false);
 980         marina.enableInstructionSend(true);
 981         marina.instrIn.run();
 982
 983         expectNorthFifoNoMoreThan(0);
 984         prln("inserting into north proper stopper");
 985         marina.fillNorthProperStopper();
 986         expectNorthFifoExactly(1);
 987         int nbToks = marina.getNumTokens();
 988         fatal(nbToks!=1, "Expected one token to emerge but got: "+nbToks+" tokens");
 989     }
 990
 991         /*
 992         marina.instrIn.fill(setIlc(1));
 993         marina.instrIn.fill(setOlc(1));
 994
 995         // this makes the head wait for the torpedo
 996         marina.instrIn.fill(TORPEDOABLE_RECV_DATA);
 997
 998         // the head should wait for the tail
 999         marina.instrIn.fill(new Instruction.Head(dock));
1000         marina.instrIn.fill(NOP);
1001         marina.instrIn.fill(SEND_DATA);
1002         marina.instrIn.fill(RECV_DATA);
1003
1004         expectNorthFifoNoMoreThan(0);
1005
1006         marina.instrIn.fillTorpedo();
1007         expectNorthFifoNoMoreThan(0);
1008
1009         marina.instrIn.fill(new Instruction.Tail(dock));
1010         expectNorthFifoExactly(1);
1011         */
1012
1013     private void testTailWithoutHead(Marina marina) {
1014         marina.instrIn.fill(setIlc(1));
1015         marina.fillSouthProperStopper(new Instruction[] {
1016                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, 63),
1017                 new Instruction.Tail(dock),
1018                 SEND_DATA,
1019             });
1020         List<BitVector> dataItems = marina.data.drainMany(1);
1021         fatal(dataItems.size()!=0, "Expected exactly no data items to emerge but got at least: "+dataItems.size());
1022     }
1023
1024     private void testHeadWaitsForTail(Marina marina) {
1025         List<BitVector> dataItems;
1026
1027         prln("Begin testHeadWaitsForTail");
1028         adjustIndent(2);
1029
1030         marina.instrIn.fill(setIlc(1));
1031         marina.fillSouthProperStopper(new Instruction[] {
1032                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, 63),
1033                 new Instruction.Head(dock),
1034                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,1),
1035                 SEND_DATA,
1036             });
1037         dataItems = marina.data.drainMany(1);
1038         fatal(dataItems.size()!=0, "Expected exactly no data items to emerge but got at least: "+dataItems.size());
1039         marina.instrIn.fill(new Instruction.Tail(dock));
1040
1041         BitVector bv = marina.data.drain();
1042         fatal(bv==null, "Expected at least one data item to emerge but got none");
1043
1044         adjustIndent(-2);
1045         prln("End testHeadWaitsForTail");
1046     }
1047
1048     private void testNonTorpedoableMoveDoesNotResetDFlag(Marina marina) {
1049         marina.instrIn.fill(setIlc(1));
1050         marina.fillSouthProperStopper(new Instruction[] {
1051                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,63),
1052                 new Instruction.Move(dock,
1053                                      Predicate.IgnoreFlagD, // predicate
1054                                      true,                  // torpedoable
1055                                      null,                  // path
1056                                      true,                  // tokenIn
1057                                      false,                 // dataIn
1058                                      false,                 // latchData
1059                                      false,                 // latchPath
1060                                      false,                 // dataOut
1061                                      false                  // tokenOut
1062                                      ),
1063                 new Instruction.Move(dock,
1064                                      Predicate.FlagD,       // predicate
1065                                      false,                 // torpedoable
1066                                      null,                  // path
1067                                      false,                 // tokenIn
1068                                      false,                 // dataIn
1069                                      false,                 // latchData
1070                                      false,                 // latchPath
1071                                      true,                  // dataOut
1072                                      false                  // tokenOut
1073                                      ),
1074             });
1075         marina.instrIn.fillTorpedo();
1076         expectNorthFifoExactly(1);
1077         marina.fillSouthProperStopper(new Instruction[] {
1078                 new Instruction.Move(dock,
1079                                      Predicate.Default,     // predicate
1080                                      false,                 // torpedoable
1081                                      null,                  // path
1082                                      false,                 // tokenIn
1083                                      false,                 // dataIn
1084                                      false,                 // latchData
1085                                      false,                 // latchPath
1086                                      true,                  // dataOut
1087                                      false                  // tokenOut
1088                                      ),
1089             });
1090         expectNorthFifoNoMoreThan(0);
1091     }
1092
1093     private void testAbort(Marina marina) {
1094
1095         marina.instrIn.fill(setIlc(1));
1096         marina.fillSouthProperStopper(new Instruction[] {
1097                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.DataLatch,1),
1098                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,2),
1099                 SEND_DATA_IF_D_NOT_SET,
1100                 new Instruction.Head(dock),
1101                 SEND_DATA_IF_D_NOT_SET,
1102                 new Instruction.Set(dock,Predicate.Default,SetDest.DataLatch,2),
1103                 new Instruction.Abort(dock, Predicate.FlagD),
1104                 new Instruction.Set(dock,Predicate.Default,SetDest.OuterLoopCounter,SetSource.Decrement),
1105                 new Instruction.Tail(dock),
1106             }, true);
1107
1108         for(int i=0; i<4; i++) {
1109             BitVector bv;
1110
1111             model.waitNS(128 * CYCLE_TIME_NS);
1112             bv = new MarinaPacket(marina.data.drain()).data.bitReverse();
1113             fatal(bv==null, "no data item found");
1114             prln("got " + bv.toLong());
1115             fatal(bv.toLong()!=1, "expected 1, got " + bv.toLong());
1116
1117             model.waitNS(128 * CYCLE_TIME_NS);
1118             bv = new MarinaPacket(marina.data.drain()).data.bitReverse();
1119             fatal(bv==null, "no data item found");
1120             prln("got " + bv.toLong());
1121             fatal(bv.toLong()!=1, "expected 1, got " + bv.toLong());
1122
1123             model.waitNS(128 * CYCLE_TIME_NS);
1124             bv = new MarinaPacket(marina.data.drain()).data.bitReverse();
1125             fatal(bv==null, "no data item found");
1126             prln("got " + bv.toLong());
1127             fatal(bv.toLong()!=2, "expected 2, got " + bv.toLong());
1128
1129         }
1130     }
1131
1132     private void testAbortOutsideOfLoop(Marina marina) {
1133         marina.instrIn.fill(setIlc(1));
1134         marina.fillSouthProperStopper(new Instruction[] {
1135                 // ensure that an abort doesn't cause problems if no loop is in progress
1136                 new Instruction.Abort(dock, Predicate.IgnoreFlagD),
1137                 SEND_DATA,
1138             });
1139         expectNorthFifoExactly(1);
1140     }
1141
1142     private void testFlagAB(Marina marina) {
1143         prln("Begin testFlagAB");
1144         adjustIndent(2);
1145
1146         Instruction.Set.FlagFunction zero = Instruction.Set.FlagFunction.ZERO;
1147         Instruction.Set.FlagFunction one  = zero;
1148
1149
1150         // we should be able to use any pair of FlagX+NotFlagX,
1151         // but we toss them all in to maximize the chances of the
1152         // test passing (later we will try the individual
1153         // combinations to maximize the chances of failure).
1154         one = one.add(Predicate.FlagA);
1155         one = one.add(Predicate.NotFlagA);
1156         one = one.add(Predicate.FlagB);
1157         one = one.add(Predicate.NotFlagB);
1158         one = one.add(Predicate.FlagC);
1159         one = one.add(Predicate.NotFlagC);
1160
1161         marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,1));
1162         for(boolean fast : new boolean[] { true, false }) {
1163             // clear the flags to a known state, then check both 0->1 and 1->0 transitions
1164             for(boolean b : new boolean[] { false, true, false }) {
1165                 prln("state: a="+marina.getFlagA()+", b="+marina.getFlagB());
1166                 prln((b?"Setting":"Clearing")+" flags");
1167
1168                 Instruction inst = new Instruction.Set(dock,Predicate.IgnoreFlagD,
1169                                                        b ? one : zero,
1170                                                        b ? one : zero
1171                                                        );
1172                 if (fast) {
1173                     marina.fillSouthProperStopper(new Instruction[] {
1174                             RECV_DATA,
1175                             inst,
1176                             NOP,
1177                         });
1178                     model.waitNS(64 * CYCLE_TIME_NS);
1179                     marina.fillNorthProperStopper();
1180                 } else {
1181                     marina.instrIn.fill(inst);
1182                 }
1183
1184                 fatal(marina.getFlagA()!=b,
1185                       "after "+(b?"setting":"clearing")+" FlagA, it was still "+(b?"clear":"set"));
1186                 fatal(marina.getFlagB()!=b,
1187                       "after "+(b?"setting":"clearing")+" FlagB, it was still "+(b?"clear":"set"));
1188             }
1189         }
1190
1191         adjustIndent(-2);
1192         prln("End testFlagAB");
1193     }
1194
1195     /**
1196      *  WARNING: this is a very, very, very long test case -- it goes
1197      *  through 216 iterations.
1198      */
1199     private void testFlagTruthTable(Marina marina) {
1200         prln("Begin testFlagTruthTable");
1201         adjustIndent(2);
1202
1203         marina.instrIn.fill(setIlc(1));
1204         Instruction.Set.FlagFunction zero = Instruction.Set.FlagFunction.ZERO;
1205         Instruction.Set.FlagFunction one  = zero.add(Predicate.FlagA).add(Predicate.NotFlagA);
1206
1207         for(Predicate a_input : new Predicate[] { null, Predicate.FlagA, Predicate.NotFlagA })
1208             for(Predicate b_input : new Predicate[] { null, Predicate.FlagB, Predicate.NotFlagB })
1209                 for(Predicate c_input : new Predicate[] { null, Predicate.FlagC, Predicate.NotFlagC })
1210                     for(boolean a_state : new boolean[] { false, true })
1211                         for(boolean b_state : new boolean[] { false, true })
1212                             for(boolean c_state : new boolean[] { false, true }) {
1213                                 for(boolean which : new boolean[] { false, true }) {
1214
1215                                     prln("before instruction: a="+a_state+", b="+b_state+", c="+c_state);
1216                                     // set A,B flags to a_state and b_state
1217                                     marina.instrIn.fill(new
1218                                                         Instruction.Set(dock,Predicate.IgnoreFlagD,
1219                                                                         a_state ? one : zero,
1220                                                                         b_state ? one : zero
1221                                                                         ));
1222
1223                                     // set C flag to c_state
1224                                     BitVector data = new BitVector(37, "empty");
1225                                     BitVector addr = new BitVector(14, "empty");
1226                                     for(int i=0; i<data.getNumBits(); i++) data.set(i, false);
1227                                     for(int i=0; i<addr.getNumBits(); i++) addr.set(i, false);
1228                                     addr.set(Marina.INDEX_OF_ADDRESS_BIT_COPIED_TO_C_FLAG_WHEN_DC_EQUALS_ONE, c_state);
1229                                     marina.fillNorthProperStopper(new MarinaPacket(data, false, addr));
1230                                     marina.instrIn.fill(RECV_DATA);
1231
1232                                     Instruction.Set.FlagFunction func = zero;
1233                                     if (a_input!=null) func = func.add(a_input);
1234                                     if (b_input!=null) func = func.add(b_input);
1235                                     if (c_input!=null) func = func.add(c_input);
1236
1237                                     Instruction inst = new
1238                                         Instruction.Set(dock,Predicate.IgnoreFlagD,
1239                                                         !which ? func : zero.add(Predicate.FlagA),
1240                                                         which  ? func : zero.add(Predicate.FlagB)
1241                                                         );
1242
1243                                     marina.instrIn.fill(inst);
1244
1245                                     boolean expected_a = !which ? func.evaluate(a_state, b_state, c_state, false) : a_state;
1246                                     boolean expected_b =  which ? func.evaluate(a_state, b_state, c_state, false) : b_state;
1247                                     fatal(expected_a != marina.getFlagA(),
1248                                           "expected A="+expected_a+", but got "+marina.getFlagA());
1249                                     fatal(expected_b != marina.getFlagB(),
1250                                           "expected B="+expected_b+", but got "+marina.getFlagB());
1251                                 }
1252                             }
1253         adjustIndent(-2);
1254         prln("End testFlagTruthTable");
1255     }
1256
1257     private void recvData(Marina marina) {
1258         prln("Begin recvData");
1259         adjustIndent(2);
1260
1261         marina.instrIn.fill(setIlc(1));
1262         marina.fillSouthProperStopper(new Instruction[] {
1263                 new Instruction.Set(dock,Predicate.IgnoreFlagD, CLEAR_FLAG, CLEAR_FLAG),
1264                 new Instruction.Move(dock,
1265                                      Predicate.IgnoreFlagD, // predicate
1266                                      false,                 // torpedoable
1267                                      null,                  // path
1268                                      false,                 // tokenIn
1269                                      true,                  // dataIn
1270                                      false,                 // latchData
1271                                      false,                 // latchPath
1272                                      false,                 // dataOut
1273                                      false                  // tokenOut
1274                                      ),
1275                 new Instruction.Set(dock,Predicate.IgnoreFlagD, SET_FLAG, SET_FLAG),
1276             });
1277         model.waitNS(64 * CYCLE_TIME_NS);
1278
1279         prln("checking to confirm that A flag is cleared");
1280         fatal(marina.getFlagA(), "bad A flag: "+marina.getFlagA());
1281
1282         prln("inserting data item in north fifo ring");
1283         BitVector data = new BitVector(37, "empty");
1284         BitVector addr = new BitVector(14, "empty");
1285         for(int i=0; i<data.getNumBits(); i++) data.set(i, false);
1286         for(int i=0; i<addr.getNumBits(); i++) addr.set(i, false);
1287         marina.fillNorthProperStopper(new MarinaPacket(data, false, addr));
1288         model.waitNS(64 * CYCLE_TIME_NS);
1289
1290         prln("checking to see if A flag got set");
1291         fatal(!marina.getFlagA(), "bad A flag: "+marina.getFlagA());
1292
1293         adjustIndent(-2);
1294         prln("End recvData");
1295     }
1296
1297
1298     private void testRecvAndSendWalkingOne(Marina marina) {
1299         prln("Begin testRecvAndSendWalkingOne");
1300         adjustIndent(2);
1301
1302         marina.instrIn.fill(setIlc(1));
1303
1304         List<BitVector> dataItems;
1305         for(int bit=0; bit<37; bit++) {
1306
1307             BitVector data = new BitVector(37, "empty");
1308             BitVector addr = new BitVector(14, "empty");
1309             for(int i=0; i<data.getNumBits(); i++) data.set(i, false);
1310             for(int i=0; i<addr.getNumBits(); i++) addr.set(i, false);
1311             data.set(bit, true);
1312             prln("testing with bit pattern " + data);
1313
1314             prln("inserting data item into north fifo ring");
1315             marina.fillNorthProperStopper(new MarinaPacket(data, false, addr));
1316
1317             prln("stopping the north proper stopper");
1318             marina.data.stop();
1319
1320             dataItems = marina.data.drainMany(1);
1321             fatal(dataItems.size()!=0,
1322                   "found a data item waiting in the north proper stopper, but should not have");
1323
1324             marina.instrIn.fill(new Instruction.Move(dock,
1325                                                      Predicate.IgnoreFlagD,  // predicate
1326                                                      false,                  // torpedoable
1327                                                      null_path,              // path
1328                                                      false,                  // tokenIn
1329                                                      true,                   // dataIn
1330                                                      true,                   // latchData
1331                                                      false,                  // latchPath
1332                                                      true,                   // dataOut
1333                                                      false                   // tokenOut
1334                                                      ));
1335
1336             dataItems = marina.data.drainMany(2);
1337             fatal(dataItems.size()!=1,
1338                   "found "+dataItems.size()+" data items in north fifo; expected one");
1339             MarinaPacket mp = new MarinaPacket(dataItems.get(0));
1340             fatalIfBitVectorsDoNotMatch(mp.data, data);
1341         }
1342
1343         adjustIndent(-2);
1344         prln("End testRecvAndSendWalkingOne");
1345     }
1346
1347
1348
1349     private void setOlcFromDataLatch(Marina marina) {
1350         prln("Begin setOlcFromDataLatch");
1351         adjustIndent(2);
1352
1353         marina.instrIn.fill(setIlc(1));
1354
1355         // walk a bit from 0 to 5
1356         for(int bit=0; bit<6; bit++) {
1357             prln("inserting data item in north fifo ring");
1358             BitVector data = new BitVector(37, "empty");
1359             BitVector addr = new BitVector(14, "empty");
1360             for(int i=0; i<data.getNumBits(); i++) data.set(i, false);
1361             for(int i=0; i<addr.getNumBits(); i++) addr.set(i, false);
1362             data.set(bit, true);
1363             marina.fillNorthProperStopper(new MarinaPacket(data, false, addr));
1364
1365             marina.fillSouthProperStopper(new Instruction[] {
1366                     RECV_DATA,
1367                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,SetSource.DataLatch)
1368                 });
1369
1370             model.waitNS(CYCLE_TIME_NS * 64);
1371
1372             int olc = marina.getOLC();
1373             fatal(olc != (1<<bit), "expected olc to be " + (1<<bit) + ", but got " + olc);
1374         }
1375
1376         adjustIndent(-2);
1377         prln("End setOlcFromDataLatch");
1378     }
1379
1380     private void setIlcFromDataLatch(Marina marina) {
1381         prln("Begin setIlcFromDataLatch");
1382         adjustIndent(2);
1383
1384         marina.instrIn.fill(setIlc(1));
1385
1386         // walk a bit from 0 to 5
1387         for(int bit=5; bit>=0; bit--) {
1388             prln("inserting data item in north fifo ring");
1389             BitVector data = new BitVector(37, "empty");
1390             BitVector addr = new BitVector(14, "empty");
1391             for(int i=0; i<data.getNumBits(); i++) data.set(i, false);
1392             for(int i=0; i<addr.getNumBits(); i++) addr.set(i, false);
1393             data.set(bit, true);
1394             marina.fillNorthProperStopper(new MarinaPacket(data, false, addr));
1395
1396             marina.fillSouthProperStopper(new Instruction[] {
1397                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,1),
1398                     RECV_DATA,
1399                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,SetSource.DataLatch),
1400                 });
1401             model.waitNS(CYCLE_TIME_NS * 64);
1402
1403             int ilc = marina.getILC().getCount();
1404             fatal(ilc != (1<<bit), "expected ilc to be " + (1<<bit) + ", but got " + ilc);
1405         }
1406
1407         adjustIndent(-2);
1408         prln("End setIlcFromDataLatch");
1409     }
1410
1411     private void testSendAndRecvToken(Marina marina) {
1412         prln("Begin testSendAndRecvToken");
1413         adjustIndent(2);
1414
1415         marina.instrIn.fill(setIlc(1));
1416         marina.fillSouthProperStopper(new Instruction[] {
1417                 SEND_TOKEN,
1418                 RECV_TOKEN,
1419                 SEND_DATA,
1420             });
1421         expectNorthFifoExactly(1);
1422
1423         adjustIndent(-2);
1424         prln("End testSendAndRecvToken");
1425     }
1426
1427     private void testSignExtendedLiteral(Marina marina) {
1428         prln("Begin testSignExtendedLiteral");
1429         adjustIndent(2);
1430
1431         marina.instrIn.fill(setIlc(1));
1432         for(long val : new long[] { (-1L << 14), -1, 0, 1 }) {
1433
1434             marina.fillSouthProperStopper(new Instruction[] {
1435                     new Instruction.Set(dock,Predicate.IgnoreFlagD,
1436                                         Instruction.Set.SetDest.DataLatch,
1437                                         val),
1438                     SEND_DATA,
1439                 });
1440             model.waitNS(CYCLE_TIME_NS * 64);
1441
1442             List<BitVector> dataItems = marina.data.drainMany(3);
1443             fatal(dataItems.size()!=1, "expected exactly one data item, got " + dataItems.size());
1444
1445             MarinaPacket mp = new MarinaPacket(dataItems.get(0));
1446             BitVector bv = mp.data;
1447             prln("got back " + mp);
1448
1449             boolean mismatch = false;
1450             String err = "";
1451             for(int i=0; i<37; i++) {
1452                 if (bv.get(i) != ( (val & (1L << i)) != 0 )) {
1453                     mismatch = true;
1454                     err += ""+i+", ";
1455                 }
1456             }
1457             fatal(mismatch, "data read back did not match inserted literal; mismatch on bits " + err);
1458         }
1459
1460         adjustIndent(-2);
1461         prln("End testSignExtendedLiteral");
1462     }
1463
1464     private void testShiftedLiteral(Marina marina) {
1465         prln("Begin testShiftedLiteral");
1466         adjustIndent(2);
1467
1468         marina.instrIn.fill(setIlc(1));
1469         marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD,
1470                                                 Instruction.Set.SetDest.DataLatch,
1471                                                 0));
1472
1473         BitVector dreg = new BitVector(37, "what we think is in the d-register");
1474         for(int i=0; i<37; i++) dreg.set(i, false);
1475
1476         for(long val : new long[] { -1, 0, 1, (-1L << 18) }) {
1477
1478             edu.berkeley.fleet.api.BitVector immediate =
1479                 new edu.berkeley.fleet.api.BitVector(19);
1480             for(int i=0; i<immediate.length(); i++)
1481                 immediate.set(i, (val & (1L << i)) != 0);
1482
1483             // shift over 19 LSB's towards MSB
1484             for(int i=0; i<19; i++)
1485                 if (i+19 <= 36)  dreg.set(i+19, dreg.get(i));
1486             for(int i=0; i<19; i++)
1487                 dreg.set(i, immediate.get(i));
1488
1489             marina.fillSouthProperStopper(new Instruction[] {
1490                     new Instruction.Shift(dock,Predicate.IgnoreFlagD,immediate),
1491                     SEND_DATA,
1492                 });
1493
1494             model.waitNS(CYCLE_TIME_NS * 64);
1495             List<BitVector> dataItems = marina.data.drainMany(3);
1496             fatal(dataItems.size()!=1, "expected exactly one data item, got " + dataItems.size());
1497
1498             BitVector bv = new MarinaPacket(dataItems.get(0)).data;
1499             fatal(!bv.equals(dreg), "data read back did not match inserted literal.\n" +
1500                   "got:     "+bv.bitReverse().getState()+"\n"+
1501                   "expected:"+dreg.bitReverse().getState());
1502         }
1503
1504         adjustIndent(-2);
1505         prln("End testShiftedLiteral");
1506     }
1507
1508     private void testFlagC(Marina marina) {
1509         prln("Begin testFlagC");
1510         adjustIndent(2);
1511
1512         // Russell says:
1513         // addr[14] == sigS
1514         // addr[1]  == sigA
1515         //
1516         // Adam says:
1517         // Dc=1 => sigS is copied into C-flag
1518         // Dc=0 => sigA is copied into C-flag
1519
1520         marina.instrIn.fill(setIlc(1));
1521         for(boolean dc : new boolean[] { false, true }) {
1522             for(boolean c_flag : new boolean[] { true, false, true }) {
1523
1524                 prln("");
1525                 prln("****** checking case where dc="+dc+", cflag="+c_flag);
1526                 BitVector data = new BitVector(37, "empty");
1527                 BitVector addr = new BitVector(14, "empty");
1528                 for(int i=0; i<data.getNumBits(); i++) data.set(i, false);
1529                 for(int i=0; i<addr.getNumBits(); i++) addr.set(i, false);
1530
1531                 int whichbit = dc
1532                     ? Marina.INDEX_OF_ADDRESS_BIT_COPIED_TO_C_FLAG_WHEN_DC_EQUALS_ONE
1533                     : Marina.INDEX_OF_ADDRESS_BIT_COPIED_TO_C_FLAG_WHEN_DC_EQUALS_ZERO;
1534                 prln("setting addr["+whichbit+"] to "+(c_flag?"1":"0"));
1535                 addr.set(whichbit, c_flag);
1536
1537                 prln("... and filling north fifo proper stopper");
1538                 marina.fillNorthProperStopper(new MarinaPacket(data, false, addr));
1539
1540                 prln("clearing flags");
1541                 prln("executing recv data with Dc="+dc);
1542                 prln("copying c-flag to a-flag");
1543                 marina.fillSouthProperStopper(new Instruction[] {
1544                         new Instruction.Set(dock,Predicate.IgnoreFlagD, CLEAR_FLAG, CLEAR_FLAG),
1545                         new Instruction.Move(dock,
1546                                              Predicate.IgnoreFlagD,   /* predicate   */
1547                                              true,                  /* torpedoable */
1548                                              null,                  /* path        */
1549                                              false,                 /* tokenIn     */
1550                                              true,                  /* dataIn      */
1551                                              dc,                    /* latchData   */
1552                                              false,                 /* latchPath   */
1553                                              false,                 /* dataOut     */
1554                                              false                  /* tokenOut    */
1555                                              ),
1556                         FLAG_NOP,
1557                         new Instruction.Set(dock,Predicate.IgnoreFlagD,
1558                                             Instruction.Set.FlagFunction.ZERO.add(Predicate.FlagC),
1559                                             CLEAR_FLAG
1560                                             ),
1561                     });
1562
1563                 model.waitNS(CYCLE_TIME_NS * 64);
1564
1565                 prln("checking to confirm that A flag is " + c_flag);
1566                 fatal(marina.getFlagA()!=c_flag, "bad A flag: "+marina.getFlagA());
1567             }
1568         }
1569         adjustIndent(-2);
1570         prln("End testFlagC");
1571     }
1572
1573     private void sendDataWithPath(Marina marina) {
1574         prln("Begin sendDataWithPath");
1575         adjustIndent(2);
1576
1577         edu.berkeley.fleet.api.BitVector bv = new edu.berkeley.fleet.api.BitVector(13);
1578         marina.instrIn.fill(setIlc(1));
1579
1580         // alternating ones and zeroes
1581         for(int i=0; i<bv.length(); i+=2)
1582             bv.set(i, true);
1583         // and then ones in the lower four bits so it's not symmetric
1584         for(int i=0; i<4; i++)
1585             bv.set(i, true);
1586
1587         MarinaPath path = new MarinaPath((MarinaFleet)dock.getShip().getFleet(), bv);
1588
1589         marina.fillSouthProperStopper(new Instruction[] {
1590                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,1),
1591                 new Instruction.Move(dock,
1592                                      Predicate.IgnoreFlagD, /* predicate   */
1593                                      false,                 /* torpedoable */
1594                                      path,                  /* path        */
1595                                      false,                 /* tokenIn     */
1596                                      false,                 /* dataIn      */
1597                                      false,                 /* latchData   */
1598                                      false,                 /* latchPath   */
1599                                      true,                  /* dataOut     */
1600                                      false                  /* tokenOut    */
1601                                      ),
1602             });
1603
1604         List<BitVector> dataItems;
1605         MarinaPacket mp;
1606
1607         dataItems = marina.data.drainMany();
1608         fatal(dataItems.size()!=1, "Expected one data item to emerge but got: "+dataItems.size()+" data items");
1609         mp = new MarinaPacket(dataItems.get(0));
1610
1611         // the 14th bit of the outbound address cannot be set by the
1612         // ship, so we don't care about it
1613         fatalIfBitVectorsDoNotMatch(MarinaUtils.berkToSun(bv), mp.path.get(0,13));
1614
1615         prln("send data with no change to path");
1616         marina.instrIn.fill(new Instruction.Move(dock,
1617                                                  Predicate.IgnoreFlagD, /* predicate   */
1618                                                  false,                 /* torpedoable */
1619                                                  null,                  /* path        */
1620                                                  false,                 /* tokenIn     */
1621                                                  false,                 /* dataIn      */
1622                                                  false,                 /* latchData   */
1623                                                  false,                 /* latchPath   */
1624                                                  true,                  /* dataOut     */
1625                                                  false                  /* tokenOut    */
1626                                                  ));
1627
1628         dataItems = marina.data.drainMany();
1629         fatal(dataItems.size()!=1, "Expected one data item to emerge but got: "+dataItems.size()+" data items");
1630         mp = new MarinaPacket(dataItems.get(0));
1631
1632         // the 14th bit of the outbound address cannot be set by the
1633         // ship, so we don't care about it
1634         fatalIfBitVectorsDoNotMatch(MarinaUtils.berkToSun(bv), mp.path.get(0,13));
1635
1636         adjustIndent(-2);
1637         prln("End sendDataWithPath");
1638     }
1639
1640     private void recvPath(Marina marina) {
1641         prln("Begin recvPath");
1642         adjustIndent(2);
1643
1644         marina.instrIn.fill(setIlc(1));
1645         for(int bit=0; bit<11; bit++) {
1646             BitVector packet_data = new BitVector(37, "inbound data item");
1647             for(int i=0; i<37; i++) packet_data.set(i, false);
1648             packet_data.set(27+bit, true);
1649             BitVector packet_path = new BitVector(14, "inbound data item");
1650             for(int i=0; i<14; i++) packet_path.set(i, false);
1651
1652             marina.fillNorthProperStopper(new MarinaPacket(packet_data, false, packet_path));
1653
1654             prln("recv path, send data (using recv'd path)");
1655             marina.instrIn.fill(new Instruction.Move(dock,
1656                                                      Predicate.IgnoreFlagD,   /* predicate   */
1657                                                      false,                 /* torpedoable */
1658                                                      null,                  /* path        */
1659                                                      false,                 /* tokenIn     */
1660                                                      true,                  /* dataIn      */
1661                                                      true,                  /* latchData   */
1662                                                      true,                  /* latchPath   */
1663                                                      true,                  /* dataOut     */
1664                                                      false                  /* tokenOut    */
1665                                                      ));
1666
1667             List<BitVector> dataItems = marina.data.drainMany();
1668             fatal(dataItems.size()!=1, "Expected one data item to emerge but got: "+dataItems.size()+" data items");
1669             MarinaPacket mp = new MarinaPacket(dataItems.get(0));
1670
1671             fatalIfBitVectorsDoNotMatch(packet_data.get(25,11), mp.path.get(0,11));
1672             fatalIfBitVectorsDoNotMatch(packet_data, mp.data);
1673         }
1674
1675         adjustIndent(-2);
1676         prln("End recvPath");
1677     }
1678
1679     private void testILC(Marina marina) {
1680         prln("Begin testILC");
1681         adjustIndent(2);
1682
1683         for(int bit=0; bit<6; bit++) {
1684             int ilc = bit<0 ? 0 : (1<<bit);
1685             marina.fillSouthProperStopper(new Instruction[] {
1686                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,ilc),
1687                     SEND_DATA,
1688                 });
1689             List<BitVector> dataItems = marina.data.drainMany();
1690             fatal(dataItems.size()!=ilc, "Expected "+ilc+" data item(s) to emerge but got: "+dataItems.size()+" data items");
1691         }
1692
1693         adjustIndent(-2);
1694         prln("End testILC");
1695     }
1696
1697     private void testILCZero(Marina marina) {
1698         adjustIndent(2);
1699         marina.fillSouthProperStopper(new Instruction[] {
1700                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,0),
1701                 SEND_DATA,
1702                 SEND_TOKEN,
1703             });
1704         expectNorthFifoNoMoreThan(0);
1705         expectTokensExactly(1);
1706         adjustIndent(-2);
1707     }
1708
1709     private void sendTorpedo(Marina marina) {
1710         prln("Begin sendTorpedo");
1711         adjustIndent(2);
1712         marina.instrIn.fill(setIlc(1));
1713         marina.instrIn.fill(setOlc(63));
1714
1715         int olc;
1716         olc = marina.getOLC();
1717         fatal(olc!=63, "bad OLC: "+olc+" expected: 1");
1718
1719         marina.instrIn.fill(new
1720                             Instruction.Set(dock,Predicate.IgnoreFlagD, CLEAR_FLAG, CLEAR_FLAG));
1721         fatal(marina.getFlagA(), "bad A flag: true");
1722         fatal(marina.getFlagB(), "bad B flag: true");
1723
1724         prln("execute a move instruction that does nothing but loops until torpedo arrives");
1725         prln("A=1, B=B This instruction should not execute because D-flag is set");
1726         prln("Set A=A, B=1 This instruction should execute because D-flag is set");
1727         marina.fillSouthProperStopper(new Instruction[] {
1728                 new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, SetSource.Infinity),
1729                 new Instruction.Move(dock,
1730                                      Predicate.IgnoreFlagD, // predicate
1731                                      true,                  // torpedoable
1732                                      null,                  // path
1733                                      false,                 // tokenIn
1734                                      true,                  // dataIn
1735                                      false,                 // latchData
1736                                      false,                 // latchPath
1737                                      false,                 // dataOut
1738                                      false                  // tokenOut
1739                                      ),
1740                 new Instruction.Set(dock,Predicate.Default,
1741                                     SET_FLAG,
1742                                     Instruction.Set.FlagFunction.ZERO.add(Predicate.FlagB)
1743                                     ),
1744                 new Instruction.Set(dock, Predicate.FlagD,
1745                                     Instruction.Set.FlagFunction.ZERO.add(Predicate.FlagA),
1746                                     SET_FLAG
1747                                     ),
1748             });
1749
1750         prln("send torpedo. This should clear the OLC");
1751         marina.instrIn.fillTorpedo();
1752         model.waitNS(128 * CYCLE_TIME_NS);
1753
1754         prln("A should remain false, B should be true");
1755         fatal(marina.getFlagA(), "bad A flag: true");
1756         fatal(!marina.getFlagB(), "bad B flag: false");
1757
1758         prln("OLC = 63. Reload OLC after torpedo, clears D-flag");
1759         marina.instrIn.fill(new
1760                             Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, 63));
1761
1762         // FIXME: find another way to test this
1763         olc = marina.getOLC();
1764         fatal(olc!=63, "bad OLC: "+olc+" expected: 63");
1765
1766         prln("Set A=1, B=1 This instruction should execute because OLC!=0");
1767         marina.instrIn.fill(new
1768                             Instruction.Set(dock,Predicate.Default, SET_FLAG, SET_FLAG));
1769
1770         prln("A and B should be true");
1771         fatal(!marina.getFlagA(), "bad A flag: false");
1772         fatal(!marina.getFlagB(), "bad B flag: false");
1773
1774         adjustIndent(-2);
1775         prln("End sendTorpedo");
1776     }
1777
1778     private void testTorpedoOnAnInfinite(Marina marina) {
1779         prln("Begin testTorpedoOnAnInfinite");
1780         adjustIndent(2);
1781
1782         List<BitVector> dataItems;
1783
1784         marina.instrIn.fill(setIlc(1));
1785         for(boolean torpedoable : new boolean[] { true, false }) {
1786
1787             marina.fillSouthProperStopper(new Instruction[] {
1788                     new Instruction.Move(dock,
1789                                          Predicate.IgnoreFlagD, // predicate
1790                                          false,                 // torpedoable
1791                                          null,                  // path
1792                                          false,                 // tokenIn
1793                                          false,                 // dataIn
1794                                          false,                 // latchData
1795                                          false,                 // latchPath
1796                                          false,                 // dataOut
1797                                          true                   // tokenOut
1798                                          ),
1799                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,SetSource.Infinity),
1800                     new Instruction.Move(dock,
1801                                          Predicate.IgnoreFlagD, // predicate
1802                                          torpedoable,           // torpedoable
1803                                          null,                  // path
1804                                          true,                  // tokenIn
1805                                          false,                 // dataIn
1806                                          false,                 // latchData
1807                                          false,                 // latchPath
1808                                          false,                 // dataOut
1809                                          true                   // tokenOut
1810                                          ),
1811                     // FIXME: this probably should be removed, unless Ivan doesn't want to change the behavior
1812                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,1),
1813
1814                     SEND_DATA,
1815                 });
1816
1817             // expect nothing to come out, because the NOP is executing
1818             dataItems = marina.data.drainMany(2);
1819             fatal(dataItems.size()!=0, "Expected no data item(s) to emerge but got at least: "+dataItems.size()+" data items");
1820
1821             marina.instrIn.fillTorpedo();
1822
1823             int expected = torpedoable?1:0;
1824             dataItems = marina.data.drainMany(2);
1825             fatal(dataItems.size()!=expected, "Expected "+expected+" item to emerge but got: "+dataItems.size()+" data items");
1826
1827             fatal(!marina.getILC().getDone(), "Expected ilc=done, but got "+marina.getILC());
1828         }
1829
1830         adjustIndent(-2);
1831         prln("End testTorpedoOnAnInfinite");
1832     }
1833
1834     private void testOlcDecrementAtHighSpeed(Marina marina) {
1835         prln("Begin testOlcDecrementAtHighSpeed");
1836         adjustIndent(2);
1837
1838         List<BitVector> dataItems;
1839
1840         // Each element of the following pair of arrays is one "test".
1841         // The OLC will be loaded with olcs[i] and then decremented
1842         // decr_amounts[i] times; after that has happened the zeroness
1843         // of the OLC will be checked by executing a MOVE with
1844         // [olc!=0] as the predicate.
1845
1846         int[] olcs         = new int[] { 3, 3, 3, 10, 41 };
1847         int[] decr_amounts = new int[] { 2, 3, 4, 9,  9  };
1848
1849         for(int which=0; which<olcs.length; which++) {
1850             int olc = olcs[which];
1851             int decr_amount = decr_amounts[which];
1852
1853             prln("inserting set olc="+olc);
1854             prln("inserting set ilc=1");
1855             marina.fillSouthProperStopper(new Instruction[] {
1856                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter,1),
1857                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter,olc),
1858                 });
1859
1860             // commenting the following four lines causes this test to pass
1861
1862             prln("inserting: "+decr_amount+" olc-- instructions");
1863             prln("inserting: [!d] send data");
1864             Instruction[] instructions = new Instruction[decr_amount+1];
1865             for(int i=0; i<decr_amount; i++)
1866                 instructions[i] =
1867                     new Instruction.Set(dock,
1868                                         Predicate.Default,
1869                                         SetDest.OuterLoopCounter,
1870                                         SetSource.Decrement);
1871             instructions[instructions.length-1] =
1872                 new Instruction.Move(dock,
1873                                      Predicate.Default,     // predicate
1874                                      false,                 // torpedoable
1875                                      null,                  // path
1876                                      false,                 // tokenIn
1877                                      false,                 // dataIn
1878                                      false,                 // latchData
1879                                      false,                 // latchPath
1880                                      true,                  // dataOut
1881                                      false                  // tokenOut
1882                                      );
1883             marina.fillSouthProperStopper(instructions);
1884             model.waitNS(64 * CYCLE_TIME_NS);
1885
1886             int expected = decr_amount>=olc ? 0 : 1;
1887             dataItems = marina.data.drainMany(2);
1888             fatal(dataItems.size()!=expected, "Expected "+expected+" item to emerge but got: "+dataItems.size()+" data items");
1889             for(int i=0; i<Math.max(0, olc-decr_amount); i++)
1890                 marina.instrIn.fill(new Instruction.Set(dock,
1891                                                         Predicate.Default,
1892                                                         SetDest.OuterLoopCounter,
1893                                                         SetSource.Decrement));
1894         }
1895
1896         adjustIndent(-2);
1897         prln("End testOlcDecrementAtHighSpeed");
1898     }
1899
1900     private void flipIlcBit(Marina marina) {
1901         prln("Begin flipIlcBit");
1902         adjustIndent(2);
1903         prln("Using the set ILC instruction, toggle a single bit between zero and one. \n" +
1904              "Check correct setting of the ILC zero bit");
1905
1906         for (int i=0; i<6; i++) {
1907             int notZero = 1<<i;
1908
1909             prln("Then immediately set ILC="+notZero);
1910             marina.fillSouthProperStopper(new Instruction[] {
1911                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, 0),
1912                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, notZero),
1913                 });
1914
1915             model.waitNS(64 * CYCLE_TIME_NS);
1916
1917             prln("Verify ILC using scan chain");
1918             Ilc ilc = marina.getILC();
1919             int ilcCount = ilc.getCount();
1920             fatal(ilcCount!=notZero, "bad ILC count: "+ilcCount+" expected: "+notZero);
1921             fatal(ilc.getInfinity(), "bad ILC Infinity bit: true");
1922
1923             marina.fillSouthProperStopper(new Instruction[] {
1924                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, notZero),
1925                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.InnerLoopCounter, 0),
1926                 });
1927
1928             model.waitNS(64 * CYCLE_TIME_NS);
1929
1930             prln("Verify ILC using scan chain");
1931             ilc = marina.getILC();
1932             ilcCount = ilc.getCount();
1933             fatal(ilcCount!=0, "bad ILC count: "+ilcCount+" expected: 0");
1934             fatal(ilc.getInfinity(), "bad ILC Infinity bit: true");
1935         }
1936
1937         adjustIndent(-2);
1938         prln("End flipIlcBit");
1939     }
1940     private void flipOlcBit(Marina marina) {
1941         prln("Begin flipOlcBit");
1942         adjustIndent(2);
1943         prln("Using the set OLC instruction, toggle a single bit between zero and one. \n" +
1944              "Check correct setting of the OLC zero bit");
1945
1946         marina.instrIn.fill(new Instruction.Set(dock,Predicate.IgnoreFlagD, CLEAR_FLAG, CLEAR_FLAG));
1947
1948         for (int i=0; i<6; i++) {
1949             int notZero = 32 >> i;
1950             prln("Set OLC=0");
1951             prln("Then immediately set OLC="+notZero);
1952             marina.fillSouthProperStopper(new Instruction[] {
1953                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, 0),
1954                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, notZero),
1955                 });
1956
1957             model.waitNS(64 * CYCLE_TIME_NS);
1958             prln("Verify OLC count using scan chain");
1959             int outOlc = marina.getOLC();
1960             fatal(outOlc!=notZero, "bad OLC count: "+outOlc+" expected: "+notZero);
1961
1962             prln("Set OLC="+notZero);
1963             prln("Then immediately set OLC=0");
1964             marina.fillSouthProperStopper(new Instruction[] {
1965                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, notZero),
1966                     new Instruction.Set(dock,Predicate.IgnoreFlagD,SetDest.OuterLoopCounter, 0),
1967                 });
1968
1969             model.waitNS(64 * CYCLE_TIME_NS);
1970             prln("Verify OLC count using scan chain");
1971             outOlc = marina.getOLC();
1972             fatal(outOlc!=0, "bad OLC count: "+outOlc+" expected: 0");
1973         }
1974
1975         adjustIndent(-2);
1976         prln("End flipOlcBit");
1977     }
1978     private void testSouthRecirculate(Marina marina, int AMOUNT) {
1979         prln("Begin testSouthRecirculate("+AMOUNT+")");
1980         adjustIndent(2);
1981
1982         marina.enableInstructionSend(false);
1983         marina.enableInstructionRecirculate(true);
1984
1985         prln("Completely fill south ring");
1986         adjustIndent(2);
1987         for (int i=0; i<AMOUNT; i++) {
1988             prln("inserting item " + (i+1) + " / " + AMOUNT);
1989             BitVector path = new BitVector(MarinaPacket.PATH_WIDTH, "path");
1990             BitVector data = new BitVector(MarinaPacket.WORD_WIDTH, "path");
1991             path.set(0, MarinaPacket.PATH_WIDTH, false);
1992             data.setFromLong(i+9);
1993             marina.instrIn.fill(new MarinaPacket(data, false, path));
1994         }
1995         adjustIndent(-2);
1996
1997         prln("Drain south ring and check contents");
1998         adjustIndent(2);
1999         List<BitVector> out = marina.instrIn.drainMany();
2000         boolean bad = false;
2001         for (int i=0; i<AMOUNT; i++) {
2002             prln("extracting item " + (i+1) + " / " + AMOUNT);
2003             //int expect = (i+Marina.SOUTH_RING_CAPACITY-1) % Marina.SOUTH_RING_CAPACITY;
2004             int expect = i+9;
2005             long got = new MarinaPacket(out.get(i)).data.toLong();
2006             if (got!=expect) {
2007                 bad = true;
2008                 prln("  bad instruction: "+got+" expected: "+expect);
2009             } else {
2010                 prln("  good instruction.");
2011             }
2012         }
2013         fatal(bad, "data inserted does not match data retrieved");
2014         adjustIndent(-2);
2015
2016         for (int i=0; i<5; i++) {}
2017
2018         adjustIndent(-2);
2019         prln("End testSouthRecirculate("+AMOUNT+")");
2020     }
2021     private void doOneTest(int testNum) {
2022         prln("");
2023         prln("============================================================");
2024         prln("MarinaTest: performing test: "+testNum);
2025
2026         marina.masterClear();
2027         marina.enableInstructionSend(true);
2028
2029
2030         try {
2031             switch (testNum) {
2032                 case 0: {
2033
2034                     // these tests run fairly quickly
2035                     doOneTest(1);       // passes extracted parasitics
2036                     doOneTest(2);       // passes extracted parasitics
2037                     doOneTest(3);       // passes extracted parasitics
2038                     doOneTest(4);       // passes extracted parasitics
2039                     doOneTest(5);       // passes extracted parasitics
2040                     doOneTest(6);       // passes extracted parasitics
2041                     doOneTest(1000);    // passes extracted parasitics
2042                     doOneTest(1001);    // passes extracted parasitics
2043                     doOneTest(1003);    // passes extracted parasitics
2044                     doOneTest(3000);    // passes extracted parasitics
2045                     doOneTest(3001);    // passes extracted parasitics
2046                     doOneTest(3003);    // passes extracted parasitics
2047                     doOneTest(3004);    // passes extracted parasitics
2048                     doOneTest(3005);    // passes extracted parasitics
2049                     doOneTest(3006);    // passes extracted parasitics
2050                     doOneTest(3007);    // passes extracted parasitics
2051                     doOneTest(3008);    // passes extracted parasitics
2052                     doOneTest(3009);    // fails extracted parasitics
2053                     doOneTest(3010);    // passes extracted parasitics
2054                     doOneTest(3011);    // passes extracted parasitics
2055                     doOneTest(3012);    // passes extracted parasitics
2056                     doOneTest(3013);    // passes extracted parasitics
2057                     doOneTest(3014);    // passes extracted parasitics
2058                     doOneTest(3015);    // fails extracted parasitics
2059                     doOneTest(3019);    // fails extracted parasitics
2060                     doOneTest(3020);    // passes extracted parasitics
2061                     doOneTest(3022);    // passes extracted parasitics
2062                     doOneTest(3023);    // passes extracted parasitics
2063                     doOneTest(3026);    // passes extracted parasitics
2064                     doOneTest(3027);    // passes extracted parasitics
2065                     doOneTest(3028);    // passes extracted parasitics
2066
2067                                         // these tests take a while and usually pass
2068                     doOneTest(1002);
2069                     doOneTest(1004);
2070                     doOneTest(1005);
2071                     doOneTest(1006);
2072                     doOneTest(3002);
2073                     doOneTest(3016);
2074                     doOneTest(3021);
2075                     doOneTest(3024);
2076                     doOneTest(3025);
2077
2078                     // this takes an insanely long time
2079                     doOneTest(3017);
2080                     break;
2081                 }
2082                 case 1:    testChains(marina);                     break; // passes, 24-Mar (+verilog)
2083                 case 2:    testProperStoppers(marina);             break; // passes, 24-Mar (+verilog)
2084                 case 3:    testSouthRecirculate(marina, 1);        break; // passes, 24-Mar (+verilog)
2085                 case 4:    getCtrsFlags(marina);                   break; //         20-Apr (+verilog)
2086                 case 5:    sendInstructions(marina);               break; // passes, 24-Mar (+verilog)
2087                 case 6:    walkOneOLC(marina);                     break; //         21-Apr (+verilog)
2088
2089                     // Russell's tests begin with 1000
2090                 case 1000: walkOneILC(marina);                     break; //         20-Apr (+verilog)
2091                 case 1001: countIlc(marina);                       break; //         20-Apr (+verilog)
2092                 case 1002: countOlc(marina);                       break; //         23-Apr (+verilog)
2093
2094                 case 1003: sendTorpedo(marina);                    break; //         23-Apr (+verilog)  [with wor-hack]
2095
2096                 case 1004: flipIlcBit(marina);                     break; //         20-Apr (+verilog)
2097                 case 1005: flipOlcBit(marina);                     break; //         21-Apr (+verilog)
2098
2099                 case 1006: testSouthRecirculate(marina, Marina.SOUTH_RING_CAPACITY-1);        break; // passes, 24-Mar (+verilog)
2100
2101                     // Adam's tests begin with 3000
2102                 case 3000: sendToken(marina);                      break; // passes, 24-Mar (+verilog)
2103                 case 3001: testFlagAB(marina);                     break; // passes, 08-Apr (+verilog)
2104                 case 3002: testPredicationOnAB(marina);            break; //         22-Apr (+verilog)
2105                 case 3003: testFlagC(marina);                      break; //         23-Apr (+verilog)
2106                 case 3004: testFlagD(marina);                      break; //         23-Apr (+verilog)
2107                 case 3005: testFlagDRecomputationTime(marina);     break;
2108
2109                 case 3006: testTailWaitsForHead(marina);           break;
2110                 case 3007: testTailWithoutHead(marina);            break;
2111                 case 3008: testHeadWaitsForTail(marina);           break; //         22-Apr (+verilog)
2112                 case 3009: testAbort(marina);                      break; //         22-Apr (+verilog)
2113
2114                 case 3010: sendData(marina);                       break; // passes, 24-Mar (+verilog)
2115                 case 3011: recvData(marina);                       break; //         21-Apr (+verilog)
2116                 case 3012: sendDataWithPath(marina);               break; // passes, 13-Apr (+verilog)
2117
2118                 case 3013: testSignExtendedLiteral(marina);        break; //         20-Apr (+verilog)
2119                 case 3014: testShiftedLiteral(marina);             break; //         20-Apr (+verilog)
2120                 case 3015: testSendAndRecvToken(marina);           break; //         21-Apr (+verilog)
2121
2122                 case 3016: sendDataIlcInfinite(marina);            break; //         22-Apr (+verilog)
2123                 case 3017: testFlagTruthTable(marina);             break; //         23-Apr (+verilog)
2124
2125                 case 3019: setOlcFromDataLatch(marina);            break; //         23-Apr (+verilog)
2126                 case 3020: setIlcFromDataLatch(marina);            break; //         23-Apr (+verilog)
2127                 case 3021: recvPath(marina);                       break; //         22-Apr (+verilog)
2128                 case 3022: testILC(marina);                        break; //         23-Apr (+verilog)
2129                 case 3023: testTorpedoOnAnInfinite(marina);        break; //         23-Apr (+verilog)
2130                 case 3024: testRecvAndSendWalkingOne(marina);      break; //         21-Apr (+verilog)
2131                 case 3025: testOlcDecrementAtHighSpeed(marina);    break; //         23-Apr (+verilog)
2132
2133                 case 3026: testNonTorpedoableMoveDoesNotResetDFlag(marina);        break; //         23-Apr (+verilog)
2134                 case 3027: testILCZero(marina);                    break;
2135                 case 3028: testAbortOutsideOfLoop(marina); break;
2136
2137                 default:
2138                     fatal(true, "Test number: "+testNum+" doesn't exist.");
2139                     break;
2140             }
2141             // If we get here then test passed
2142             prln("Test Result: Passed");
2143             printTestTime();
2144             //Infrastructure.exit(0);
2145         } catch (MarinaUtils.FailureException fe) {
2146             fe.printStackTrace();
2147         }
2148     }
2149
2150
2151     //============================ for public use =============================
2152
2153     /** Exit codes:
2154      * 0: test detected success
2155      * 2: test detected failure
2156      * 1: test crashed
2157      */
2158     public static void main(String[] args) {
2159         startTime = System.currentTimeMillis();
2160         new MarinaTest(args);
2161     }
2162
2163 }