diff options
3 files changed, 97 insertions, 14 deletions
diff --git a/src/main/scala/firrtl/passes/memlib/ReplaceMemMacros.scala b/src/main/scala/firrtl/passes/memlib/ReplaceMemMacros.scala index 4b43118b..35a765f8 100644 --- a/src/main/scala/firrtl/passes/memlib/ReplaceMemMacros.scala +++ b/src/main/scala/firrtl/passes/memlib/ReplaceMemMacros.scala @@ -218,15 +218,18 @@ class ReplaceMemMacros extends Transform with DependencyAPIMigration { } } - /** Mapping from (module, memory name) pairs to blackbox names */ - private type NameMap = collection.mutable.HashMap[(String, String), String] + /** Mapping from (module, memory name) pairs to pair of blackbox wrapper name and blackbox name */ + private type NameMap = collection.mutable.HashMap[(String, String), (String, String)] /** Construct NameMap by assigning unique names for each memory blackbox */ private def constructNameMap(namespace: Namespace, nameMap: NameMap, mname: String)(s: Statement): Statement = { s match { case m: DefAnnotatedMemory => m.memRef match { - case None => nameMap(mname -> m.name) = namespace.newName(m.name) + case None => + val wrapperName = namespace.newName(m.name) + val blackboxName = namespace.newName(s"${wrapperName}_ext") + nameMap(mname -> m.name) = (wrapperName, blackboxName) case Some(_) => } case _ => @@ -240,7 +243,9 @@ class ReplaceMemMacros extends Transform with DependencyAPIMigration { mname: String, memPortMap: MemPortMap, memMods: Modules, - annotatedMemoriesBuffer: ListBuffer[DefAnnotatedMemory] + annotatedMemoriesBuffer: ListBuffer[DefAnnotatedMemory], + renameMap: RenameMap, + circuit: String )(s: Statement ): Statement = s match { case m: DefAnnotatedMemory => @@ -248,30 +253,42 @@ class ReplaceMemMacros extends Transform with DependencyAPIMigration { m.writers.foreach { w => memPortMap(s"${m.name}.$w.mask") = EmptyExpression } m.readwriters.foreach { w => memPortMap(s"${m.name}.$w.wmask") = EmptyExpression } } + val moduleTarget = ModuleTarget(circuit, mname) m.memRef match { case None => // prototype mem - val newWrapperName = nameMap(mname -> m.name) - val newMemBBName = namespace.newName(s"${newWrapperName}_ext") + val (newWrapperName, newMemBBName) = nameMap(mname -> m.name) val newMem = m.copy(name = newMemBBName) memMods ++= createMemModule(newMem, newWrapperName, annotatedMemoriesBuffer) + val renameFrom = moduleTarget.ref(m.name) + val renameTo = moduleTarget.instOf(m.name, newWrapperName).instOf(newMemBBName, newMemBBName) + renameMap.record(renameFrom, renameTo) WDefInstance(m.info, m.name, newWrapperName, UnknownType) case Some((module, mem)) => - WDefInstance(m.info, m.name, nameMap(module -> mem), UnknownType) + val (memModuleName, newMemBBName) = nameMap(module -> mem) + val renameFrom = moduleTarget.ref(m.name) + val renameTo = moduleTarget.instOf(m.name, memModuleName).instOf(newMemBBName, newMemBBName) + renameMap.record(renameFrom, renameTo) + WDefInstance(m.info, m.name, memModuleName, UnknownType) } - case sx => sx.map(updateMemStmts(namespace, nameMap, mname, memPortMap, memMods, annotatedMemoriesBuffer)) + case sx => + sx.map( + updateMemStmts(namespace, nameMap, mname, memPortMap, memMods, annotatedMemoriesBuffer, renameMap, circuit) + ) } private def updateMemMods( namespace: Namespace, nameMap: NameMap, memMods: Modules, - annotatedMemoriesBuffer: ListBuffer[DefAnnotatedMemory] + annotatedMemoriesBuffer: ListBuffer[DefAnnotatedMemory], + renameMap: RenameMap, + circuit: String )(m: DefModule ) = { val memPortMap = new MemPortMap - (m.map(updateMemStmts(namespace, nameMap, m.name, memPortMap, memMods, annotatedMemoriesBuffer)) + (m.map(updateMemStmts(namespace, nameMap, m.name, memPortMap, memMods, annotatedMemoriesBuffer, renameMap, circuit)) .map(updateStmtRefs(memPortMap))) } @@ -282,7 +299,8 @@ class ReplaceMemMacros extends Transform with DependencyAPIMigration { val memMods = new Modules val nameMap = new NameMap c.modules.map(m => m.map(constructNameMap(namespace, nameMap, m.name))) - val modules = c.modules.map(updateMemMods(namespace, nameMap, memMods, annotatedMemoriesBuffer)) + val renameMap = RenameMap() + val modules = c.modules.map(updateMemMods(namespace, nameMap, memMods, annotatedMemoriesBuffer, renameMap, c.main)) state.copy( circuit = c.copy(modules = modules ++ memMods), annotations = @@ -296,7 +314,8 @@ class ReplaceMemMacros extends Transform with DependencyAPIMigration { } } }) :+ - AnnotatedMemoriesAnnotation(annotatedMemoriesBuffer.toList) + AnnotatedMemoriesAnnotation(annotatedMemoriesBuffer.toList), + renames = Some(renameMap) ) } } diff --git a/src/main/scala/firrtl/passes/memlib/ResolveMemoryReference.scala b/src/main/scala/firrtl/passes/memlib/ResolveMemoryReference.scala index 73aa5399..b916842f 100644 --- a/src/main/scala/firrtl/passes/memlib/ResolveMemoryReference.scala +++ b/src/main/scala/firrtl/passes/memlib/ResolveMemoryReference.scala @@ -71,10 +71,17 @@ class ResolveMemoryReference extends Transform with DependencyAPIMigration { c.copy(modules = modulesx) } def execute(state: CircuitState): CircuitState = { - val noDedups = state.annotations.collect { + val (remainingAnnotations, noDedupMemAnnos) = state.annotations.partition { + case _: NoDedupMemAnnotation => false + case _ => true + } + val noDedups = noDedupMemAnnos.map { case NoDedupMemAnnotation(ComponentName(cn, ModuleName(mn, _))) => mn -> cn } val noDedupMap: Map[String, Set[String]] = noDedups.groupBy(_._1).mapValues(_.map(_._2).toSet).toMap - state.copy(circuit = run(state.circuit, noDedupMap)) + state.copy( + circuit = run(state.circuit, noDedupMap), + annotations = remainingAnnotations + ) } } diff --git a/src/test/scala/firrtlTests/ReplSeqMemTests.scala b/src/test/scala/firrtlTests/ReplSeqMemTests.scala index cb6dd7a6..414fc6af 100644 --- a/src/test/scala/firrtlTests/ReplSeqMemTests.scala +++ b/src/test/scala/firrtlTests/ReplSeqMemTests.scala @@ -13,7 +13,18 @@ import firrtl.transforms._ import firrtl.util.BackendCompilationUtilities.loggingProcessLogger import scala.sys.process._ +object ReplSeqMemSpec { + private case class DummyAnno(targets: CompleteTarget*) extends Annotation { + override def update(renames: RenameMap): Seq[Annotation] = { + Seq(DummyAnno(targets.flatMap { t => + renames.get(t).getOrElse(Seq(t)) + }: _*)) + } + } +} + class ReplSeqMemSpec extends SimpleTransformSpec { + import ReplSeqMemSpec._ def emitter = new LowFirrtlEmitter def transforms = Seq( new ChirrtlToHighFirrtl(), @@ -608,4 +619,50 @@ circuit Top : checkGenMemVerilog(input, Set.empty) } + "ReplSeqMem" should "rename reference targets to blackbox instance targets" in { + val input = + """ + |circuit CustomMemory : + | module CustomMemory : + | input clock : Clock + | input reset : UInt<1> + | output io : {flip rClk : Clock, flip rAddr : UInt<3>, dO : UInt<16>, flip wClk : Clock, flip wAddr : UInt<3>, flip wEn : UInt<1>, flip dI : UInt<16>} + + | io is invalid + | smem mem_0 : UInt<16>[7] + | smem mem_1 : UInt<16>[7] + | read mport _T_17 = mem_0[io.rAddr], clock + | read mport _T_19 = mem_1[io.rAddr], clock + | io.dO <= and(_T_17, _T_19) + | when io.wEn : + | write mport _T_18 = mem_0[io.wAddr], clock + | write mport _T_20 = mem_1[io.wAddr], clock + | _T_18 <= io.dI + | _T_20 <= io.dI + |""".stripMargin + val mems = Set( + MemConf("mem_0_ext", 7, 16, Map(WritePort -> 1, ReadPort -> 1), None) + ) + val confLoc = "ReplSeqMemTests.confTEMP" + val annos = Seq( + ReplSeqMemAnnotation.parse("-c:CustomMemory:-o:" + confLoc), + DummyAnno( + CircuitTarget("CustomMemory").module("CustomMemory").ref("mem_0"), + CircuitTarget("CustomMemory").module("CustomMemory").ref("mem_1") + ) + ) + val res = compileAndEmit(CircuitState(parse(input), ChirrtlForm, annos)) + val resAnnos = res.annotations.collect { case a: DummyAnno => a.targets }.flatten + val expected = Seq( + CircuitTarget("CustomMemory") + .module("CustomMemory") + .instOf("mem_0", "mem_0") + .instOf("mem_0_ext", "mem_0_ext"), + CircuitTarget("CustomMemory") + .module("CustomMemory") + .instOf("mem_1", "mem_0") + .instOf("mem_0_ext", "mem_0_ext") + ) + resAnnos should be(expected) + } } |