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