1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
// SPDX-License-Identifier: Apache-2.0
// Transform implementations for name-propagation related annotations.
//
// Helpful references:
// http://docs.scala-lang.org/overviews/quasiquotes/syntax-summary.html#definitions
// for quasiquote structures of various Scala structures
// http://jsuereth.com/scala/2009/02/05/leveraging-annotations-in-scala.html
// use of Transformer
// http://www.scala-lang.org/old/sites/default/files/sids/rytz/Wed,%202010-01-27,%2015:10/annots.pdf
// general annotations reference
package chisel3.internal.naming
import scala.reflect.macros.whitebox.Context
import scala.annotation.{compileTimeOnly, StaticAnnotation}
import scala.language.experimental.macros
// Workaround for https://github.com/sbt/sbt/issues/3966
object DebugTransforms
class DebugTransforms(val c: Context) {
import c.universe._
/** Passthrough transform that prints the annottee for debugging purposes.
* No guarantees are made on what this annotation does, and it may very well change over time.
*
* The print is warning level to make it visually easier to spot, as well as a reminder that
* this annotation should not make it to production / committed code.
*/
def dump(annottees: c.Tree*): c.Tree = {
val combined = annottees.map({ tree => show(tree) }).mkString("\r\n\r\n")
annottees.foreach(tree => c.warning(c.enclosingPosition, s"Debug dump:\n$combined"))
q"..$annottees"
}
/** Passthrough transform that prints the annottee as a tree for debugging purposes.
* No guarantees are made on what this annotation does, and it may very well change over time.
*
* The print is warning level to make it visually easier to spot, as well as a reminder that
* this annotation should not make it to production / committed code.
*/
def treedump(annottees: c.Tree*): c.Tree = {
val combined = annottees.map({ tree => showRaw(tree) }).mkString("\r\n")
annottees.foreach(tree => c.warning(c.enclosingPosition, s"Debug tree dump:\n$combined"))
q"..$annottees"
}
}
// Workaround for https://github.com/sbt/sbt/issues/3966
object NamingTransforms
class NamingTransforms(val c: Context) {
import c.universe._
val globalNamingStack = q"_root_.chisel3.internal.DynamicNamingStack"
/** Base transformer that provides the val name transform.
* Should not be instantiated, since by default this will recurse everywhere and break the
* naming context variable bounds.
*/
trait ValNameTransformer extends Transformer {
val contextVar: TermName
override def transform(tree: Tree): Tree = tree match {
// Intentionally not prefixed with $mods, since modifiers usually mean the val definition
// is in a non-transformable location, like as a parameter list.
// TODO: is this exhaustive / correct in all cases?
case q"val $tname: $tpt = $expr" => {
val TermName(tnameStr: String) = tname
val transformedExpr = super.transform(expr)
q"val $tname: $tpt = $contextVar.name($transformedExpr, $tnameStr)"
}
case other => super.transform(other)
}
}
/** Module-specific val name transform, containing logic to prevent from recursing into inner
* classes and applies the naming transform on inner functions.
*/
class ClassBodyTransformer(val contextVar: TermName) extends ValNameTransformer {
override def transform(tree: Tree): Tree = tree match {
case q"$mods class $tpname[..$tparams] $ctorMods(...$paramss) extends { ..$earlydefns } with ..$parents { $self => ..$stats }" =>
tree // don't recurse into inner classes
case q"$mods trait $tpname[..$tparams] extends { ..$earlydefns } with ..$parents { $self => ..$stats }" =>
tree // don't recurse into inner classes
case q"$mods def $tname[..$tparams](...$paramss): $tpt = $expr" => {
val Modifiers(_, _, annotations) = mods
// don't apply naming transform twice
val containsChiselName = annotations.map({ q"new chiselName()" equalsStructure _ }).fold(false)({ _ || _ })
// transforming overloaded initializers causes errors, and the transform isn't helpful
val isInitializer = tname == TermName("<init>")
if (containsChiselName || isInitializer) {
tree
} else {
// apply chiselName transform by default
val transformedExpr = transformHierarchicalMethod(expr)
q"$mods def $tname[..$tparams](...$paramss): $tpt = $transformedExpr"
}
}
case other => super.transform(other)
}
}
/** Method-specific val name transform, handling the return case.
*/
class MethodTransformer(val contextVar: TermName) extends ValNameTransformer {
override def transform(tree: Tree): Tree = tree match {
// TODO: better error messages when returning nothing
case q"return $expr" => q"return $globalNamingStack.popReturnContext($expr, $contextVar)"
// Do not recurse into methods
case q"$mods def $tname[..$tparams](...$paramss): $tpt = $expr" => tree
case other => super.transform(other)
}
}
/** Applies the val name transform to a class body.
* Closes context on top level or return local context to englobing context.
* Closing context only makes sense when top level a Module.
* A Module is always the naming top level.
* Transformed classes can be either Module or standard class.
*/
def transformClassBody(stats: List[c.Tree]): Tree = {
val contextVar = TermName(c.freshName("namingContext"))
val transformedBody = (new ClassBodyTransformer(contextVar)).transformTrees(stats)
// Note: passing "this" to popReturnContext is mandatory for propagation through non-module classes
q"""
val $contextVar = $globalNamingStack.pushContext()
..$transformedBody
if($globalNamingStack.length() == 1){
$contextVar.namePrefix("")
}
$globalNamingStack.popReturnContext(this, $contextVar)
"""
}
/** Applies the val name transform to a method body, doing additional bookkeeping with the
* context to allow names to propagate and prefix through the function call stack.
*/
def transformHierarchicalMethod(expr: c.Tree): Tree = {
val contextVar = TermName(c.freshName("namingContext"))
val transformedBody = (new MethodTransformer(contextVar)).transform(expr)
q"""{
val $contextVar = $globalNamingStack.pushContext()
$globalNamingStack.popReturnContext($transformedBody, $contextVar)
}
"""
}
/** Applies naming transforms to vals in the annotated module or method.
*
* For methods, a hierarchical naming transform is used, where it will try to give objects names
* based on the call stack, assuming all functions on the stack are annotated as such and return
* a non-AnyVal object. Does not recurse into inner functions.
*
* For modules, this serves as the root of the call stack hierarchy for naming purposes. Methods
* will have chiselName annotations (non-recursively), but this does NOT affect inner classes.
*
* Basically rewrites all instances of:
* val name = expr
* to:
* val name = context.name(expr, name)
*/
def chiselName(annottees: c.Tree*): c.Tree = {
var namedElts: Int = 0
val transformed = annottees.map(annottee =>
annottee match {
case q"$mods class $tpname[..$tparams] $ctorMods(...$paramss) extends { ..$earlydefns } with ..$parents { $self => ..$stats }" => {
val transformedStats = transformClassBody(stats)
namedElts += 1
q"$mods class $tpname[..$tparams] $ctorMods(...$paramss) extends { ..$earlydefns } with ..$parents { $self => ..$transformedStats }"
}
case q"$mods object $tname extends { ..$earlydefns } with ..$parents { $self => ..$body }" => {
annottee // Don't fail noisly when a companion object is passed in with the actual class def
}
// Currently disallow on traits, this won't work well with inheritance.
case q"$mods def $tname[..$tparams](...$paramss): $tpt = $expr" => {
val transformedExpr = transformHierarchicalMethod(expr)
namedElts += 1
q"$mods def $tname[..$tparams](...$paramss): $tpt = $transformedExpr"
}
case other =>
c.abort(
c.enclosingPosition,
s"@chiselName annotion may only be used on classes and methods, got ${showCode(other)}"
)
}
)
if (namedElts != 1) {
c.abort(
c.enclosingPosition,
s"@chiselName annotation did not match exactly one valid tree, got:\r\n${annottees.map(tree => showCode(tree)).mkString("\r\n\r\n")}"
)
}
q"..$transformed"
}
}
@compileTimeOnly("enable macro paradise to expand macro annotations")
class dump extends StaticAnnotation {
def macroTransform(annottees: Any*): Any = macro chisel3.internal.naming.DebugTransforms.dump
}
@compileTimeOnly("enable macro paradise to expand macro annotations")
class treedump extends StaticAnnotation {
def macroTransform(annottees: Any*): Any = macro chisel3.internal.naming.DebugTransforms.treedump
}
@compileTimeOnly("enable macro paradise to expand macro annotations")
@deprecated(
"Use chisel3.experimental.AffectsChiselPrefix instead. @chiselName will be removed in Chisel 3.6",
"Chisel 3.5"
)
class chiselName extends StaticAnnotation {
def macroTransform(annottees: Any*): Any = macro chisel3.internal.naming.NamingTransforms.chiselName
}
|
