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
|
// SPDX-License-Identifier: Apache-2.0
package firrtlTests.annotationTests
import firrtl._
import firrtl.annotations._
import firrtl.ir._
import firrtl.options.Dependency
import firrtl.transforms.DontTouchAnnotation
import scala.util.Failure
import _root_.logger.{LogLevel, LogLevelAnnotation, Logger}
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should._
import org.scalatest.Inside._
case class AnAnnotation(
info: Info,
cir: Circuit,
mod: DefModule,
port: Port,
statement: Statement,
expr: Expression,
tpe: Type,
groundType: GroundType)
extends NoTargetAnnotation
class AnnoInjector extends Transform with DependencyAPIMigration {
override def optionalPrerequisiteOf = Dependency[ChirrtlEmitter] :: Nil
override def invalidates(a: Transform): Boolean = false
def execute(state: CircuitState): CircuitState = {
// Classes defined in method bodies can't be serialized by json4s
case class MyAnno(x: Int) extends NoTargetAnnotation
state.copy(annotations = MyAnno(3) +: state.annotations)
}
}
class JsonProtocolSpec extends AnyFlatSpec with Matchers {
"JsonProtocol" should "serialize and deserialize FIRRTL types" in {
val circuit =
"""circuit Top: @[FPU.scala 509:25]
| module Top:
| input x: UInt
| output y: UInt
| y <= add(x, x)
|""".stripMargin
val cir = Parser.parse(circuit)
val mod = cir.modules.head
val port = mod.ports.head
val stmt = mod.asInstanceOf[Module].body
val expr = stmt.asInstanceOf[Block].stmts.head.asInstanceOf[Connect].expr
val tpe = port.tpe
val groundType = port.tpe.asInstanceOf[GroundType]
val inputAnnos = Seq(AnAnnotation(cir.info, cir, mod, port, stmt, expr, tpe, groundType))
val annosString = JsonProtocol.serialize(inputAnnos)
val outputAnnos = JsonProtocol.deserialize(annosString)
inputAnnos should be(outputAnnos)
}
"Annotation serialization during logging" should "not throw an exception" in {
val compiler = new firrtl.stage.transforms.Compiler(Seq(Dependency[AnnoInjector]))
val circuit = Parser.parse("""
|circuit test :
| module test :
| output out : UInt<1>
| out <= UInt(0)
""".stripMargin)
Logger.makeScope(LogLevelAnnotation(LogLevel.Trace) :: Nil) {
compiler.execute(CircuitState(circuit, Nil))
}
}
"Trying to serialize annotations that cannot be serialized" should "tell you why" in {
case class MyAnno(x: Int) extends NoTargetAnnotation
inside(JsonProtocol.serializeTry(MyAnno(3) :: Nil)) {
case Failure(e: UnserializableAnnotationException) =>
e.getMessage should include("MyAnno")
// From json4s Exception
e.getMessage should include("Classes defined in method bodies are not supported")
}
}
"JsonProtocol.serializeRecover" should "emit even annotations that cannot be serialized" in {
case class MyAnno(x: Int) extends NoTargetAnnotation
val target = CircuitTarget("Top").module("Foo").ref("x")
val annos = MyAnno(3) :: DontTouchAnnotation(target) :: Nil
val res = JsonProtocol.serializeRecover(annos)
res should include(""""class":"firrtl.annotations.UnserializeableAnnotation",""")
res should include(""""error":"Classes defined in method bodies are not supported.",""")
res should include(""""content":"MyAnno(3)"""")
}
}
|
