path: root/src/test/scala/firrtlTests/UnitTests.scala

// SPDX-License-Identifier: Apache-2.0

package firrtlTests

import java.io._
import firrtl._
import firrtl.ir._
import firrtl.passes._
import firrtl.transforms._
import firrtl.testutils._
import FirrtlCheckers._

class UnitTests extends FirrtlFlatSpec {
  private def executeTest(input: String, expected: Seq[String], transforms: Seq[Transform]) = {
    val lines = execute(input, transforms).circuit.serialize.split("\n").map(normalized)

    expected.foreach { e =>
      lines should contain(e)
    }
  }

  private def executeTest(input: String, expected: String, transforms: Seq[Transform]) = {
    execute(input, transforms).circuit should be(parse(expected))
  }

  def execute(input: String, transforms: Seq[Transform]): CircuitState = {
    val c = transforms
      .foldLeft(CircuitState(parse(input), UnknownForm)) { (c: CircuitState, t: Transform) =>
        t.runTransform(c)
      }
      .circuit
    CircuitState(c, UnknownForm, Seq(), None)
  }

  "Pull muxes" should "not be exponential in runtime" in {
    val passes = Seq(ToWorkingIR, CheckHighForm, ResolveKinds, InferTypes, CheckTypes, PullMuxes)
    val input =
      """circuit Unit :
        |  module Unit :
        |    input _2: UInt<1>
        |    output x: UInt<32>
        |    x <= cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(_2, cat(   _2, cat(_2, cat(_2, cat(_2, _2)))))))))))))))))))))))))))))))""".stripMargin
    passes.foldLeft(parse(input)) { (c: Circuit, p: Pass) =>
      p.run(c)
    }
  }

  "Connecting bundles of different types" should "throw an exception" in {
    val passes = Seq(ToWorkingIR, CheckHighForm, ResolveKinds, InferTypes, CheckTypes)
    val input =
      """circuit Unit :
        |  module Unit :
        |    input y: {a : UInt<1>}
        |    output x: {a : UInt<1>, b : UInt<1>}
        |    x <= y""".stripMargin
    intercept[CheckTypes.InvalidConnect] {
      passes.foldLeft(parse(input)) { (c: Circuit, p: Pass) =>
        p.run(c)
      }
    }
  }

  "Initializing a register with a different type" should "throw an exception" in {
    val passes = Seq(ToWorkingIR, CheckHighForm, ResolveKinds, InferTypes, CheckTypes)
    val input =
      """circuit Unit :
        |  module Unit :
        |    input clock : Clock
        |    input reset : UInt<1>
        |    wire x : { valid : UInt<1> }
        |    reg y : { valid : UInt<1>, bits : UInt<3> }, clock with :
        |      reset => (reset, x)""".stripMargin
    intercept[CheckTypes.InvalidRegInit] {
      passes.foldLeft(parse(input)) { (c: Circuit, p: Pass) =>
        p.run(c)
      }
    }
  }

  "Partial connection two bundle types whose relative flips don't match but leaf node directions do" should "connect correctly" in {
    val passes = Seq(ToWorkingIR, CheckHighForm, ResolveKinds, InferTypes, CheckTypes, ResolveFlows, ExpandConnects)
    val input =
      """circuit Unit :
        |  module Unit :
        |    wire x : { flip a: { b: UInt<32> } }
        |    wire y : { a: { flip b: UInt<32> } }
        |    x <- y""".stripMargin
    val check =
      """circuit Unit :
        |  module Unit :
        |    wire x : { flip a: { b: UInt<32> } }
        |    wire y : { a: { flip b: UInt<32> } }
        |    y.a.b <= x.a.b""".stripMargin
    val c_result = passes.foldLeft(parse(input)) { (c: Circuit, p: Pass) =>
      p.run(c)
    }
    val writer = new StringWriter()
    (new HighFirrtlEmitter).emit(CircuitState(c_result, HighForm), writer)
    (parse(writer.toString())) should be(parse(check))
  }

  val splitExpTestCode =
    """
      |circuit Unit :
      |  module Unit :
      |    input a : UInt<1>
      |    input b : UInt<2>
      |    input c : UInt<2>
      |    output out : UInt<1>
      |    out <= bits(mux(a, b, c), 0, 0)
      |""".stripMargin

  "Emitting a nested expression" should "compile" in {
    val passes = Seq(ToWorkingIR, InferTypes, ResolveKinds)
    val c = Parser.parse(splitExpTestCode.split("\n").toIterator)
    val c2 = passes.foldLeft(c)((c, p) => p.run(c))
    val writer = new StringWriter()
    (new VerilogEmitter).emit(CircuitState(c2, LowForm), writer)
  }

  "Simple compound expressions" should "be split" in {
    val passes = Seq(
      ToWorkingIR,
      ResolveKinds,
      InferTypes,
      ResolveFlows,
      new InferWidths,
      SplitExpressions
    )
    val input =
      """circuit Top :
        |  module Top :
        |    input a : UInt<32>
        |    input b : UInt<32>
        |    input d : UInt<32>
        |    output c : UInt<1>
        |    c <= geq(add(a, b),d)""".stripMargin
    val check = Seq(
      "node _GEN_0 = add(a, b)",
      "c <= geq(_GEN_0, d)"
    )
    executeTest(input, check, passes)
  }

  "Smaller widths" should "be explicitly padded" in {
    val passes = Seq(
      ToWorkingIR,
      ResolveKinds,
      InferTypes,
      ResolveFlows,
      new InferWidths,
      PadWidths
    )
    val input =
      """circuit Top :
        |  module Top :
        |    input a : UInt<32>
        |    input b : UInt<20>
        |    input pred : UInt<1>
        |    output c : UInt<32>
        |    c <= mux(pred,a,b)""".stripMargin
    val check = Seq("c <= mux(pred, a, pad(b, 32))")
    executeTest(input, check, passes)
  }

  "Indexes into sub-accesses" should "be dealt with" in {
    val passes = Seq(
      ToWorkingIR,
      ResolveKinds,
      InferTypes,
      ResolveFlows,
      new InferWidths,
      PullMuxes,
      ExpandConnects,
      RemoveAccesses,
      new ConstantPropagation
    )
    val input =
      """circuit AssignViaDeref :
        |  module AssignViaDeref :
        |    input clock : Clock
        |    input reset : UInt<1>
        |    output io : {a : UInt<8>, sel : UInt<1>}
        |
        |    io is invalid
        |    reg table : {a : UInt<8>}[2], clock
        |    reg otherTable : {a : UInt<8>}[2], clock
        |    otherTable[table[UInt<1>("h01")].a].a <= UInt<1>("h00")""".stripMargin
    //TODO(azidar): I realize this is brittle, but unfortunately there
    //  isn't a better way to test this pass
    val check = Seq(
      """wire _table_1_a : UInt<8>""",
      """_table_1_a is invalid""",
      """when UInt<1>("h1") :""",
      """_table_1_a <= table[1].a""",
      """wire _otherTable_table_1_a_a : UInt<8>""",
      """when eq(UInt<1>("h0"), _table_1_a) :""",
      """otherTable[0].a <= _otherTable_table_1_a_a""",
      """when eq(UInt<1>("h1"), _table_1_a) :""",
      """otherTable[1].a <= _otherTable_table_1_a_a""",
      """_otherTable_table_1_a_a <= UInt<1>("h0")"""
    )
    executeTest(input, check, passes)
  }

  "Oversized bit select" should "throw an exception" in {
    val passes = Seq(ToWorkingIR, ResolveKinds, InferTypes, ResolveFlows, new InferWidths, CheckWidths)
    val input =
      """circuit Unit :
        |  module Unit :
        |    node x = bits(UInt(1), 100, 0)""".stripMargin
    intercept[CheckWidths.BitsWidthException] {
      passes.foldLeft(CircuitState(Parser.parse(input.split("\n").toIterator), UnknownForm)) {
        (c: CircuitState, p: Transform) => p.runTransform(c)
      }
    }
  }

  "Oversized head select" should "throw an exception" in {
    val passes = Seq(ToWorkingIR, ResolveKinds, InferTypes, ResolveFlows, new InferWidths, CheckWidths)
    val input =
      """circuit Unit :
        |  module Unit :
        |    node x = head(UInt(1), 100)""".stripMargin
    intercept[CheckWidths.HeadWidthException] {
      passes.foldLeft(CircuitState(Parser.parse(input.split("\n").toIterator), UnknownForm)) {
        (c: CircuitState, p: Transform) => p.runTransform(c)
      }
    }
  }

  "zero head select" should "return an empty module" in {
    val passes =
      Seq(ToWorkingIR, ResolveKinds, InferTypes, ResolveFlows, new InferWidths, CheckWidths, new DeadCodeElimination)
    val input =
      """circuit Unit :
        |  module Unit :
        |    node x = head(UInt(1), 0)""".stripMargin
    val check =
      """circuit Unit :
        |  module Unit :
        |    skip""".stripMargin
    executeTest(input, check, passes)
  }

  "Oversized tail select" should "throw an exception" in {
    val passes = Seq(ToWorkingIR, ResolveKinds, InferTypes, ResolveFlows, new InferWidths, CheckWidths)
    val input =
      """circuit Unit :
        |  module Unit :
        |    node x = tail(UInt(1), 100)""".stripMargin
    intercept[CheckWidths.TailWidthException] {
      passes.foldLeft(CircuitState(Parser.parse(input.split("\n").toIterator), UnknownForm)) {
        (c: CircuitState, p: Transform) => p.runTransform(c)
      }
    }
  }

  "max tail select" should "return an empty module" in {
    val passes =
      Seq(ToWorkingIR, ResolveKinds, InferTypes, ResolveFlows, new InferWidths, CheckWidths, new DeadCodeElimination)
    val input =
      """circuit Unit :
        |  module Unit :
        |    node x = tail(UInt(1), 1)""".stripMargin
    val check =
      """circuit Unit :
        |  module Unit :
        |    skip""".stripMargin
    executeTest(input, check, passes)
  }

  "Partial connecting incompatable types" should "throw an exception" in {
    val passes = Seq(ToWorkingIR, ResolveKinds, InferTypes, CheckTypes)
    val input =
      """circuit Unit :
        |  module Unit :
        |    input foo : { bar : UInt<32> }
        |    output bar : UInt<32>
        |    bar <- foo
        |""".stripMargin
    intercept[PassException] {
      passes.foldLeft(CircuitState(Parser.parse(input.split("\n").toIterator), UnknownForm)) {
        (c: CircuitState, p: Transform) => p.runTransform(c)
      }
    }
  }

  "Conditional connection of clocks" should "throw an exception" in {
    val input =
      """circuit Unit :
        |  module Unit :
        |    input clock1 : Clock
        |    input clock2 : Clock
        |    input sel : UInt<1>
        |    output clock3 : Clock
        |    clock3 <= clock1
        |    when sel :
        |      clock3 <= clock2
        |""".stripMargin
    intercept[EmitterException] {
      compileToVerilog(input)
    }
  }

  "Parsing SInts" should "work" in {
    val passes = Seq()
    val input =
      """circuit Unit :
        |  module Unit :
        |    node posSInt = SInt(13)
        |    node negSInt = SInt(-13)
        |    node posSIntString = SInt("h0d")
        |    node posSIntString2 = SInt("h+d")
        |    node posSIntString3 = SInt("hd")
        |    node negSIntString = SInt("h-d")
        |    node negSIntStringWidth = SInt<5>("h-d")
        |    node neg2 = SInt("h-2")
        |    node pos2 = SInt("h2")
        |    node neg1 = SInt("h-1")
        |""".stripMargin
    val expected = Seq(
      """node posSInt = SInt<5>("hd")""",
      """node negSInt = SInt<5>("h-d")""",
      """node posSIntString = SInt<5>("hd")""",
      """node posSIntString2 = SInt<5>("hd")""",
      """node posSIntString3 = SInt<5>("hd")""",
      """node negSIntString = SInt<5>("h-d")""",
      """node negSIntStringWidth = SInt<5>("h-d")""",
      """node neg2 = SInt<2>("h-2")""",
      """node pos2 = SInt<3>("h2")""",
      """node neg1 = SInt<1>("h-1")"""
    )
    executeTest(input, expected, passes)
  }
  "Verilog SInts" should "work" in {
    val passes = Seq()
    val input =
      """circuit Unit :
        |  module Unit :
        |    output posSInt : SInt
        |    output negSInt : SInt
        |    posSInt <= SInt(13)
        |    negSInt <= SInt(-13)
        |""".stripMargin
    val expected = Seq(
      """assign posSInt = 5'shd;""",
      """assign negSInt = -5'shd;"""
    )
    val out = compileToVerilog(input)
    val lines = out.split("\n").map(normalized)
    expected.foreach { e =>
      lines should contain(e)
    }
  }

  "Out of bound accesses" should "be invalid" in {
    val passes = Seq(
      ToWorkingIR,
      ResolveKinds,
      InferTypes,
      ResolveFlows,
      new InferWidths,
      PullMuxes,
      ExpandConnects,
      RemoveAccesses,
      ResolveFlows,
      new ConstantPropagation
    )
    val input =
      """circuit Top :
        |  module Top :
        |    input index: UInt<2>
        |    output out: UInt<16>
        |    wire array: UInt<16>[3]
        |    out <= array[index]""".stripMargin

    val result = execute(input, passes)

    def u(value: Int) = UIntLiteral(BigInt(value))

    val ut16 = UIntType(IntWidth(BigInt(16)))
    val ut2 = UIntType(IntWidth(BigInt(2)))
    val ut1 = UIntType(IntWidth(BigInt(1)))

    val mgen = WRef("_array_index", ut16, WireKind, SourceFlow)
    val fgen = WRef("_array_index", ut16, WireKind, SinkFlow)
    val index = WRef("index", ut2, PortKind, SourceFlow)
    val out = WRef("out", ut16, PortKind, SinkFlow)

    def eq(e1:   Expression, e2: Expression): Expression = DoPrim(PrimOps.Eq, Seq(e1, e2), Nil, ut1)
    def array(v: Int): Expression =
      WSubIndex(WRef("array", VectorType(ut16, 3), WireKind, SourceFlow), v, ut16, SourceFlow)

    result should containTree { case DefWire(_, "_array_index", `ut16`) => true }
    result should containTree { case IsInvalid(_, `fgen`) => true }

    val eq0 = eq(u(0), index)
    val array0 = array(0)
    result should containTree { case Conditionally(_, `eq0`, Connect(_, `fgen`, `array0`), EmptyStmt) => true }

    val eq1 = eq(u(1), index)
    val array1 = array(1)
    result should containTree { case Conditionally(_, `eq1`, Connect(_, `fgen`, `array1`), EmptyStmt) => true }

    val eq2 = eq(u(2), index)
    val array2 = array(2)
    result should containTree { case Conditionally(_, `eq2`, Connect(_, `fgen`, `array2`), EmptyStmt) => true }

    result should containTree { case Connect(_, `out`, mgen) => true }
  }

  "Shl" should "be emitted in Verilog as concat" in {
    val input =
      """circuit Unit :
        |  module Unit :
        |    input in : UInt<4>
        |    output out : UInt<8>
        |    out <= shl(in, 4)
        |""".stripMargin
    val res = (new VerilogCompiler).compileAndEmit(CircuitState(parse(input), ChirrtlForm))
    res should containLine("assign out = {in, 4'h0};")
  }
}