summaryrefslogtreecommitdiff
path: root/plugin/src/main/scala-2.12/chisel3
diff options
context:
space:
mode:
authorJack Koenig2021-09-17 21:01:26 -0700
committerJack Koenig2021-09-17 21:01:26 -0700
commit5c8c19345e6711279594cf1f9ddab33623c8eba7 (patch)
treed9d6ced3934aa4a8be3dec19ddcefe50a7a93d5a /plugin/src/main/scala-2.12/chisel3
parente63b9667d89768e0ec6dc8a9153335cb48a213a7 (diff)
parent958904cb2f2f65d02b2ab3ec6d9ec2e06d04e482 (diff)
Merge branch 'master' into 3.5-release
Diffstat (limited to 'plugin/src/main/scala-2.12/chisel3')
-rw-r--r--plugin/src/main/scala-2.12/chisel3/internal/plugin/ChiselPlugin.scala223
1 files changed, 0 insertions, 223 deletions
diff --git a/plugin/src/main/scala-2.12/chisel3/internal/plugin/ChiselPlugin.scala b/plugin/src/main/scala-2.12/chisel3/internal/plugin/ChiselPlugin.scala
deleted file mode 100644
index 59be7588..00000000
--- a/plugin/src/main/scala-2.12/chisel3/internal/plugin/ChiselPlugin.scala
+++ /dev/null
@@ -1,223 +0,0 @@
-// See LICENSE for license details.
-
-package chisel3.internal.plugin
-
-import scala.tools.nsc
-import nsc.{Global, Phase}
-import nsc.plugins.Plugin
-import nsc.plugins.PluginComponent
-import scala.reflect.internal.Flags
-import scala.tools.nsc.transform.TypingTransformers
-
-import scala.collection.mutable
-
-// The plugin to be run by the Scala compiler during compilation of Chisel code
-class ChiselPlugin(val global: Global) extends Plugin {
- val name = "chiselplugin"
- val description = "Plugin for Chisel 3 Hardware Description Language"
- val components: List[PluginComponent] = List[PluginComponent](new ChiselComponent(global))
-}
-
-// The component of the chisel plugin. Not sure exactly what the difference is between
-// a Plugin and a PluginComponent.
-class ChiselComponent(val global: Global) extends PluginComponent with TypingTransformers {
- import global._
- val runsAfter: List[String] = List[String]("typer")
- val phaseName: String = "chiselcomponent"
- def newPhase(_prev: Phase): ChiselComponentPhase = new ChiselComponentPhase(_prev)
- class ChiselComponentPhase(prev: Phase) extends StdPhase(prev) {
- override def name: String = phaseName
- def apply(unit: CompilationUnit): Unit = {
- // This plugin doesn't work on Scala 2.11. Rather than complicate the sbt build flow,
- // instead we just check the version and if its an early Scala version, the plugin does nothing
- if(scala.util.Properties.versionNumberString.split('.')(1).toInt >= 12) {
- unit.body = new MyTypingTransformer(unit).transform(unit.body)
- }
- }
- }
-
- class MyTypingTransformer(unit: CompilationUnit)
- extends TypingTransformer(unit) {
-
- private def shouldMatchGen(bases: Tree*): Type => Boolean = {
- val cache = mutable.HashMap.empty[Type, Boolean]
- val baseTypes = bases.map(inferType)
-
- // If subtype of one of the base types, it's a match!
- def terminate(t: Type): Boolean = baseTypes.exists(t <:< _)
-
- // Recurse through subtype hierarchy finding containers
- // Seen is only updated when we recurse into type parameters, thus it is typically small
- def recShouldMatch(s: Type, seen: Set[Type]): Boolean = {
- def outerMatches(t: Type): Boolean = {
- val str = t.toString
- str.startsWith("Option[") || str.startsWith("Iterable[")
- }
- if (terminate(s)) {
- true
- } else if (seen.contains(s)) {
- false
- } else if (outerMatches(s)) {
- // These are type parameters, loops *are* possible here
- recShouldMatch(s.typeArgs.head, seen + s)
- } else {
- // This is the standard inheritance hierarchy, Scalac catches loops here
- s.parents.exists( p => recShouldMatch(p, seen) )
- }
- }
-
- // If doesn't match container pattern, exit early
- def earlyExit(t: Type): Boolean = {
- !(t.matchesPattern(inferType(tq"Iterable[_]")) || t.matchesPattern(inferType(tq"Option[_]")))
- }
-
- // Return function so that it captures the cache
- { q: Type =>
- cache.getOrElseUpdate(q, {
- // First check if a match, then check early exit, then recurse
- if(terminate(q)){
- true
- } else if(earlyExit(q)) {
- false
- } else {
- recShouldMatch(q, Set.empty)
- }
- })
- }
- }
-
-
- private val shouldMatchData : Type => Boolean = shouldMatchGen(tq"chisel3.Data")
- private val shouldMatchDataOrMem : Type => Boolean = shouldMatchGen(tq"chisel3.Data", tq"chisel3.MemBase[_]")
- private val shouldMatchModule : Type => Boolean = shouldMatchGen(tq"chisel3.experimental.BaseModule")
-
- // Given a type tree, infer the type and return it
- private def inferType(t: Tree): Type = localTyper.typed(t, nsc.Mode.TYPEmode).tpe
-
- // Indicates whether a ValDef is properly formed to get name
- private def okVal(dd: ValDef): Boolean = {
-
- // These were found through trial and error
- def okFlags(mods: Modifiers): Boolean = {
- val badFlags = Set(
- Flag.PARAM,
- Flag.SYNTHETIC,
- Flag.DEFERRED,
- Flags.TRIEDCOOKING,
- Flags.CASEACCESSOR,
- Flags.PARAMACCESSOR
- )
- badFlags.forall{ x => !mods.hasFlag(x)}
- }
-
- // Ensure expression isn't null, as you can't call `null.autoName("myname")`
- val isNull = dd.rhs match {
- case Literal(Constant(null)) => true
- case _ => false
- }
-
- okFlags(dd.mods) && !isNull && dd.rhs != EmptyTree
- }
- // TODO Unify with okVal
- private def okUnapply(dd: ValDef): Boolean = {
-
- // These were found through trial and error
- def okFlags(mods: Modifiers): Boolean = {
- val badFlags = Set(
- Flag.PARAM,
- Flag.DEFERRED,
- Flags.TRIEDCOOKING,
- Flags.CASEACCESSOR,
- Flags.PARAMACCESSOR
- )
- val goodFlags = Set(
- Flag.SYNTHETIC,
- Flag.ARTIFACT
- )
- goodFlags.forall(f => mods.hasFlag(f)) && badFlags.forall(f => !mods.hasFlag(f))
- }
-
- // Ensure expression isn't null, as you can't call `null.autoName("myname")`
- val isNull = dd.rhs match {
- case Literal(Constant(null)) => true
- case _ => false
- }
- val tpe = inferType(dd.tpt)
- definitions.isTupleType(tpe) && okFlags(dd.mods) && !isNull && dd.rhs != EmptyTree
- }
-
- private def findUnapplyNames(tree: Tree): Option[List[String]] = {
- val applyArgs: Option[List[Tree]] = tree match {
- case Match(_, List(CaseDef(_, _, Apply(_, args)))) => Some(args)
- case _ => None
- }
- applyArgs.flatMap { args =>
- var ok = true
- val result = mutable.ListBuffer[String]()
- args.foreach {
- case Ident(TermName(name)) => result += name
- // Anything unexpected and we abort
- case _ => ok = false
- }
- if (ok) Some(result.toList) else None
- }
- }
-
- // Whether this val is directly enclosed by a Bundle type
- private def inBundle(dd: ValDef): Boolean = {
- dd.symbol.logicallyEnclosingMember.thisType <:< inferType(tq"chisel3.Bundle")
- }
-
- private def stringFromTermName(name: TermName): String =
- name.toString.trim() // Remove trailing space (Scalac implementation detail)
-
- // Method called by the compiler to modify source tree
- override def transform(tree: Tree): Tree = tree match {
- // Check if a subtree is a candidate
- case dd @ ValDef(mods, name, tpt, rhs) if okVal(dd) =>
- val tpe = inferType(tpt)
- // If a Data and in a Bundle, just get the name but not a prefix
- if (shouldMatchData(tpe) && inBundle(dd)) {
- val str = stringFromTermName(name)
- val newRHS = transform(rhs) // chisel3.internal.plugin.autoNameRecursively
- val named = q"chisel3.internal.plugin.autoNameRecursively($str)($newRHS)"
- treeCopy.ValDef(dd, mods, name, tpt, localTyper typed named)
- }
- // If a Data or a Memory, get the name and a prefix
- else if (shouldMatchDataOrMem(tpe)) {
- val str = stringFromTermName(name)
- val newRHS = transform(rhs)
- val prefixed = q"chisel3.experimental.prefix.apply[$tpt](name=$str)(f=$newRHS)"
- val named = q"chisel3.internal.plugin.autoNameRecursively($str)($prefixed)"
- treeCopy.ValDef(dd, mods, name, tpt, localTyper typed named)
- // If an instance, just get a name but no prefix
- } else if (shouldMatchModule(tpe)) {
- val str = stringFromTermName(name)
- val newRHS = transform(rhs)
- val named = q"chisel3.internal.plugin.autoNameRecursively($str)($newRHS)"
- treeCopy.ValDef(dd, mods, name, tpt, localTyper typed named)
- } else {
- // Otherwise, continue
- super.transform(tree)
- }
- case dd @ ValDef(mods, name, tpt, rhs @ Match(_, _)) if okUnapply(dd) =>
- val tpe = inferType(tpt)
- val fieldsOfInterest: List[Boolean] = tpe.typeArgs.map(shouldMatchData)
- // Only transform if at least one field is of interest
- if (fieldsOfInterest.reduce(_ || _)) {
- findUnapplyNames(rhs) match {
- case Some(names) =>
- val onames: List[Option[String]] = fieldsOfInterest.zip(names).map { case (ok, name) => if (ok) Some(name) else None }
- val named = q"chisel3.internal.plugin.autoNameRecursivelyProduct($onames)($rhs)"
- treeCopy.ValDef(dd, mods, name, tpt, localTyper typed named)
- case None => // It's not clear how this could happen but we don't want to crash
- super.transform(tree)
- }
- } else {
- super.transform(tree)
- }
- // Otherwise, continue
- case _ => super.transform(tree)
- }
- }
-}