aboutsummaryrefslogtreecommitdiff
path: root/src/test/scala/firrtlTests/annotationTests/EliminateTargetPathsSpec.scala
diff options
context:
space:
mode:
authorAdam Izraelevitz2018-10-27 22:44:00 -0700
committerGitHub2018-10-27 22:44:00 -0700
commit223bad6d9ddd93e48678da7c3ab50b6656809157 (patch)
treebf9efdcd7e1c8fb50175686810531be07747e8a9 /src/test/scala/firrtlTests/annotationTests/EliminateTargetPathsSpec.scala
parent7e2f787e125227dc389d5cf1d09717748ecfed2e (diff)
Revert "Instance Annotations (#865)" (#925)
This reverts commit 7e2f787e125227dc389d5cf1d09717748ecfed2e.
Diffstat (limited to 'src/test/scala/firrtlTests/annotationTests/EliminateTargetPathsSpec.scala')
-rw-r--r--src/test/scala/firrtlTests/annotationTests/EliminateTargetPathsSpec.scala357
1 files changed, 0 insertions, 357 deletions
diff --git a/src/test/scala/firrtlTests/annotationTests/EliminateTargetPathsSpec.scala b/src/test/scala/firrtlTests/annotationTests/EliminateTargetPathsSpec.scala
deleted file mode 100644
index de84d79d..00000000
--- a/src/test/scala/firrtlTests/annotationTests/EliminateTargetPathsSpec.scala
+++ /dev/null
@@ -1,357 +0,0 @@
-// See LICENSE for license details.
-
-package firrtlTests.annotationTests
-
-import firrtl._
-import firrtl.annotations._
-import firrtl.annotations.analysis.DuplicationHelper
-import firrtl.annotations.transforms.NoSuchTargetException
-import firrtl.transforms.DontTouchAnnotation
-import firrtlTests.{FirrtlMatchers, FirrtlPropSpec}
-
-class EliminateTargetPathsSpec extends FirrtlPropSpec with FirrtlMatchers {
- val input =
- """circuit Top:
- | module Leaf:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- | node a = i
- | module Middle:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst l1 of Leaf
- | inst l2 of Leaf
- | l1.i <= i
- | l2.i <= l1.o
- | o <= l2.o
- | module Top:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst m1 of Middle
- | inst m2 of Middle
- | m1.i <= i
- | m2.i <= m1.o
- | o <= m2.o
- """.stripMargin
-
- val TopCircuit = CircuitTarget("Top")
- val Top = TopCircuit.module("Top")
- val Middle = TopCircuit.module("Middle")
- val Leaf = TopCircuit.module("Leaf")
-
- val Top_m1_l1_a = Top.instOf("m1", "Middle").instOf("l1", "Leaf").ref("a")
- val Top_m2_l1_a = Top.instOf("m2", "Middle").instOf("l1", "Leaf").ref("a")
- val Top_m1_l2_a = Top.instOf("m1", "Middle").instOf("l2", "Leaf").ref("a")
- val Top_m2_l2_a = Top.instOf("m2", "Middle").instOf("l2", "Leaf").ref("a")
- val Middle_l1_a = Middle.instOf("l1", "Leaf").ref("a")
- val Middle_l2_a = Middle.instOf("l2", "Leaf").ref("a")
- val Leaf_a = Leaf.ref("a")
-
- case class DummyAnnotation(target: Target) extends SingleTargetAnnotation[Target] {
- override def duplicate(n: Target): Annotation = DummyAnnotation(n)
- }
- class DummyTransform() extends Transform with ResolvedAnnotationPaths {
- override def inputForm: CircuitForm = LowForm
- override def outputForm: CircuitForm = LowForm
-
- override val annotationClasses: Traversable[Class[_]] = Seq(classOf[DummyAnnotation])
-
- override def execute(state: CircuitState): CircuitState = state
- }
- val customTransforms = Seq(new DummyTransform())
-
- val inputState = CircuitState(parse(input), ChirrtlForm)
- property("Hierarchical tokens should be expanded properly") {
- val dupMap = new DuplicationHelper(inputState.circuit.modules.map(_.name).toSet)
-
-
- // Only a few instance references
- dupMap.expandHierarchy(Top_m1_l1_a)
- dupMap.expandHierarchy(Top_m2_l1_a)
- dupMap.expandHierarchy(Middle_l1_a)
-
- dupMap.makePathless(Top_m1_l1_a).foreach {Set(TopCircuit.module("Leaf___Top_m1_l1").ref("a")) should contain (_)}
- dupMap.makePathless(Top_m2_l1_a).foreach {Set(TopCircuit.module("Leaf___Top_m2_l1").ref("a")) should contain (_)}
- dupMap.makePathless(Top_m1_l2_a).foreach {Set(Leaf_a) should contain (_)}
- dupMap.makePathless(Top_m2_l2_a).foreach {Set(Leaf_a) should contain (_)}
- dupMap.makePathless(Middle_l1_a).foreach {Set(
- TopCircuit.module("Leaf___Top_m1_l1").ref("a"),
- TopCircuit.module("Leaf___Top_m2_l1").ref("a"),
- TopCircuit.module("Leaf___Middle_l1").ref("a")
- ) should contain (_) }
- dupMap.makePathless(Middle_l2_a).foreach {Set(Leaf_a) should contain (_)}
- dupMap.makePathless(Leaf_a).foreach {Set(
- TopCircuit.module("Leaf___Top_m1_l1").ref("a"),
- TopCircuit.module("Leaf___Top_m2_l1").ref("a"),
- TopCircuit.module("Leaf___Middle_l1").ref("a"),
- Leaf_a
- ) should contain (_)}
- dupMap.makePathless(Top).foreach {Set(Top) should contain (_)}
- dupMap.makePathless(Middle).foreach {Set(
- TopCircuit.module("Middle___Top_m1"),
- TopCircuit.module("Middle___Top_m2"),
- Middle
- ) should contain (_)}
- dupMap.makePathless(Leaf).foreach {Set(
- TopCircuit.module("Leaf___Top_m1_l1"),
- TopCircuit.module("Leaf___Top_m2_l1"),
- TopCircuit.module("Leaf___Middle_l1"),
- Leaf
- ) should contain (_) }
- }
-
- property("Hierarchical donttouch should be resolved properly") {
- val inputState = CircuitState(parse(input), ChirrtlForm, Seq(DontTouchAnnotation(Top_m1_l1_a)))
- val customTransforms = Seq(new LowFirrtlOptimization())
- val outputState = new LowFirrtlCompiler().compile(inputState, customTransforms)
- val check =
- """circuit Top :
- | module Leaf___Top_m1_l1 :
- | input i : UInt<1>
- | output o : UInt<1>
- |
- | node a = i
- | o <= i
- |
- | module Leaf :
- | input i : UInt<1>
- | output o : UInt<1>
- |
- | skip
- | o <= i
- |
- | module Middle___Top_m1 :
- | input i : UInt<1>
- | output o : UInt<1>
- |
- | inst l1 of Leaf___Top_m1_l1
- | inst l2 of Leaf
- | o <= l2.o
- | l1.i <= i
- | l2.i <= l1.o
- |
- | module Middle :
- | input i : UInt<1>
- | output o : UInt<1>
- |
- | inst l1 of Leaf
- | inst l2 of Leaf
- | o <= l2.o
- | l1.i <= i
- | l2.i <= l1.o
- |
- | module Top :
- | input i : UInt<1>
- | output o : UInt<1>
- |
- | inst m1 of Middle___Top_m1
- | inst m2 of Middle
- | o <= m2.o
- | m1.i <= i
- | m2.i <= m1.o
- |
- """.stripMargin
- canonicalize(outputState.circuit).serialize should be (canonicalize(parse(check)).serialize)
- outputState.annotations.collect {
- case x: DontTouchAnnotation => x.target
- } should be (Seq(Top.circuitTarget.module("Leaf___Top_m1_l1").ref("a")))
- }
-
- property("No name conflicts between old and new modules") {
- val input =
- """circuit Top:
- | module Middle:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- | module Top:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst m1 of Middle
- | inst m2 of Middle
- | inst x of Middle___Top_m1
- | x.i <= i
- | m1.i <= i
- | m2.i <= m1.o
- | o <= m2.o
- | module Middle___Top_m1:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- | node a = i
- """.stripMargin
- val checks =
- """circuit Top :
- | module Middle :
- | module Top :
- | module Middle___Top_m1 :
- | module Middle____Top_m1 :""".stripMargin.split("\n")
- val Top_m1 = Top.instOf("m1", "Middle")
- val inputState = CircuitState(parse(input), ChirrtlForm, Seq(DummyAnnotation(Top_m1)))
- val outputState = new LowFirrtlCompiler().compile(inputState, customTransforms)
- val outputLines = outputState.circuit.serialize.split("\n")
- checks.foreach { line =>
- outputLines should contain (line)
- }
- }
-
- property("Previously unused modules should remain, but newly unused modules should be eliminated") {
- val input =
- """circuit Top:
- | module Leaf:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- | node a = i
- | module Middle:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- | module Top:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst m1 of Middle
- | inst m2 of Middle
- | m1.i <= i
- | m2.i <= m1.o
- | o <= m2.o
- """.stripMargin
-
- val checks =
- """circuit Top :
- | module Leaf :
- | module Top :
- | module Middle___Top_m1 :
- | module Middle___Top_m2 :""".stripMargin.split("\n")
-
- val Top_m1 = Top.instOf("m1", "Middle")
- val Top_m2 = Top.instOf("m2", "Middle")
- val inputState = CircuitState(parse(input), ChirrtlForm, Seq(DummyAnnotation(Top_m1), DummyAnnotation(Top_m2)))
- val outputState = new LowFirrtlCompiler().compile(inputState, customTransforms)
- val outputLines = outputState.circuit.serialize.split("\n")
-
- checks.foreach { line =>
- outputLines should contain (line)
- }
- checks.foreach { line =>
- outputLines should not contain (" module Middle :")
- }
- }
-
- property("Paths with incorrect names should error") {
- val input =
- """circuit Top:
- | module Leaf:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- | node a = i
- | module Middle:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- | module Top:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst m1 of Middle
- | inst m2 of Middle
- | m1.i <= i
- | m2.i <= m1.o
- | o <= m2.o
- """.stripMargin
- intercept[NoSuchTargetException] {
- val Top_m1 = Top.instOf("m1", "MiddleX")
- val inputState = CircuitState(parse(input), ChirrtlForm, Seq(DummyAnnotation(Top_m1)))
- new LowFirrtlCompiler().compile(inputState, customTransforms)
- }
- intercept[NoSuchTargetException] {
- val Top_m2 = Top.instOf("x2", "Middle")
- val inputState = CircuitState(parse(input), ChirrtlForm, Seq(DummyAnnotation(Top_m2)))
- new LowFirrtlCompiler().compile(inputState, customTransforms)
- }
- }
-
- property("No name conflicts between two new modules") {
- val input =
- """circuit Top:
- | module Top:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst m1 of Middle_
- | inst m2 of Middle
- | m1.i <= i
- | m2.i <= m1.o
- | o <= m2.o
- | module Middle:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst _l of Leaf
- | _l.i <= i
- | o <= _l.o
- | module Middle_:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst l of Leaf
- | l.i <= i
- | node x = i
- | o <= l.o
- | module Leaf:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- """.stripMargin
- val checks =
- """circuit Top :
- | module Middle :
- | module Top :
- | module Leaf___Middle__l :
- | module Leaf____Middle__l :""".stripMargin.split("\n")
- val Middle_l1 = CircuitTarget("Top").module("Middle").instOf("_l", "Leaf")
- val Middle_l2 = CircuitTarget("Top").module("Middle_").instOf("l", "Leaf")
- val inputState = CircuitState(parse(input), ChirrtlForm, Seq(DummyAnnotation(Middle_l1), DummyAnnotation(Middle_l2)))
- val outputState = new LowFirrtlCompiler().compile(inputState, customTransforms)
- val outputLines = outputState.circuit.serialize.split("\n")
- checks.foreach { line =>
- outputLines should contain (line)
- }
- }
-
- property("Keep annotations of modules not instantiated") {
- val input =
- """circuit Top:
- | module Top:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst m1 of Middle
- | inst m2 of Middle
- | m1.i <= i
- | m2.i <= m1.o
- | o <= m2.o
- | module Middle:
- | input i: UInt<1>
- | output o: UInt<1>
- | inst _l of Leaf
- | _l.i <= i
- | o <= _l.o
- | module Middle_:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= UInt(0)
- | module Leaf:
- | input i: UInt<1>
- | output o: UInt<1>
- | o <= i
- """.stripMargin
- val checks =
- """circuit Top :
- | module Middle_ :""".stripMargin.split("\n")
- val Middle_ = CircuitTarget("Top").module("Middle_").ref("i")
- val inputState = CircuitState(parse(input), ChirrtlForm, Seq(DontTouchAnnotation(Middle_)))
- val outputState = new VerilogCompiler().compile(inputState, customTransforms)
- val outputLines = outputState.circuit.serialize.split("\n")
- checks.foreach { line =>
- outputLines should contain (line)
- }
- }
-}