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
|
package firrtl
package annotations
import scala.util.{Try, Failure}
import org.json4s._
import org.json4s.native.JsonMethods._
import org.json4s.native.Serialization
import org.json4s.native.Serialization.{read, writePretty}
trait HasSerializationHints {
// For serialization of complicated constuctor arguments, let the annotation
// writer specify additional type hints for relevant classes that might be
// contained within
def typeHints(): Seq[Class[_]]
}
object JsonProtocol {
class TransformClassSerializer extends CustomSerializer[Class[_ <: Transform]](format => (
{ case JString(s) => Class.forName(s).asInstanceOf[Class[_ <: Transform]] },
{ case x: Class[_] => JString(x.getName) }
))
// TODO Reduce boilerplate?
class NamedSerializer extends CustomSerializer[Named](format => (
{ case JString(s) => AnnotationUtils.toNamed(s) },
{ case named: Named => JString(named.serialize) }
))
class CircuitNameSerializer extends CustomSerializer[CircuitName](format => (
{ case JString(s) => AnnotationUtils.toNamed(s).asInstanceOf[CircuitName] },
{ case named: CircuitName => JString(named.serialize) }
))
class ModuleNameSerializer extends CustomSerializer[ModuleName](format => (
{ case JString(s) => AnnotationUtils.toNamed(s).asInstanceOf[ModuleName] },
{ case named: ModuleName => JString(named.serialize) }
))
class ComponentNameSerializer extends CustomSerializer[ComponentName](format => (
{ case JString(s) => AnnotationUtils.toNamed(s).asInstanceOf[ComponentName] },
{ case named: ComponentName => JString(named.serialize) }
))
class TransformSerializer extends CustomSerializer[Transform](format => (
{ case JString(s) =>
try {
Class.forName(s).asInstanceOf[Class[_ <: Transform]].newInstance()
} catch {
case e: java.lang.InstantiationException => throw new FirrtlInternalException(
"NoSuchMethodException during construction of serialized Transform. Is your Transform an inner class?", e)
case t: Throwable => throw t
}},
{ case x: Transform => JString(x.getClass.getName) }
))
class LoadMemoryFileTypeSerializer extends CustomSerializer[MemoryLoadFileType](format => (
{ case JString(s) => MemoryLoadFileType.deserialize(s) },
{ case named: MemoryLoadFileType => JString(named.serialize) }
))
class TargetSerializer extends CustomSerializer[Target](format => (
{ case JString(s) => Target.deserialize(s) },
{ case named: Target => JString(named.serialize) }
))
class GenericTargetSerializer extends CustomSerializer[GenericTarget](format => (
{ case JString(s) => Target.deserialize(s).asInstanceOf[GenericTarget] },
{ case named: GenericTarget => JString(named.serialize) }
))
class CircuitTargetSerializer extends CustomSerializer[CircuitTarget](format => (
{ case JString(s) => Target.deserialize(s).asInstanceOf[CircuitTarget] },
{ case named: CircuitTarget => JString(named.serialize) }
))
class ModuleTargetSerializer extends CustomSerializer[ModuleTarget](format => (
{ case JString(s) => Target.deserialize(s).asInstanceOf[ModuleTarget] },
{ case named: ModuleTarget => JString(named.serialize) }
))
class InstanceTargetSerializer extends CustomSerializer[InstanceTarget](format => (
{ case JString(s) => Target.deserialize(s).asInstanceOf[InstanceTarget] },
{ case named: InstanceTarget => JString(named.serialize) }
))
class ReferenceTargetSerializer extends CustomSerializer[ReferenceTarget](format => (
{ case JString(s) => Target.deserialize(s).asInstanceOf[ReferenceTarget] },
{ case named: ReferenceTarget => JString(named.serialize) }
))
/** Construct Json formatter for annotations */
def jsonFormat(tags: Seq[Class[_]]) = {
Serialization.formats(FullTypeHints(tags.toList)).withTypeHintFieldName("class") +
new TransformClassSerializer + new NamedSerializer + new CircuitNameSerializer +
new ModuleNameSerializer + new ComponentNameSerializer + new TargetSerializer +
new GenericTargetSerializer + new CircuitTargetSerializer + new ModuleTargetSerializer +
new InstanceTargetSerializer + new ReferenceTargetSerializer + new TransformSerializer +
new LoadMemoryFileTypeSerializer
}
/** Serialize annotations to a String for emission */
def serialize(annos: Seq[Annotation]): String = serializeTry(annos).get
def serializeTry(annos: Seq[Annotation]): Try[String] = {
val tags = annos.collect({
case anno: HasSerializationHints => anno.getClass +: anno.typeHints
case anno => Seq(anno.getClass)
}).flatten.distinct
implicit val formats = jsonFormat(tags)
Try(writePretty(annos))
}
def deserialize(in: JsonInput): Seq[Annotation] = deserializeTry(in).get
def deserializeTry(in: JsonInput): Try[Seq[Annotation]] = Try({
val parsed = parse(in)
val annos = parsed match {
case JArray(objs) => objs
case x => throw new InvalidAnnotationJSONException(
s"Annotations must be serialized as a JArray, got ${x.getClass.getSimpleName} instead!")
}
// Recursively gather typeHints by pulling the "class" field from JObjects
// Json4s should emit this as the first field in all serialized classes
// Setting requireClassField mandates that all JObjects must provide a typeHint,
// this used on the first invocation to check all annotations do so
def findTypeHints(classInst: Seq[JValue], requireClassField: Boolean = false): Seq[String] = classInst.flatMap({
case JObject(("class", JString(name)) :: fields) => name +: findTypeHints(fields.map(_._2))
case obj: JObject if requireClassField => throw new InvalidAnnotationJSONException(s"Expected field 'class' not found! $obj")
case JObject(fields) => findTypeHints(fields.map(_._2))
case JArray(arr) => findTypeHints(arr)
case oJValue => Seq()
}).distinct
val classes = findTypeHints(annos, true)
val loaded = classes.map(Class.forName(_).asInstanceOf[Class[_]])
implicit val formats = jsonFormat(loaded)
read[List[Annotation]](in)
}).recoverWith {
// Translate some generic errors to specific ones
case e: java.lang.ClassNotFoundException =>
Failure(new AnnotationClassNotFoundException(e.getMessage))
// Eat the stack traces of json4s exceptions
case e @ (_: org.json4s.ParserUtil.ParseException | _: org.json4s.MappingException) =>
Failure(new InvalidAnnotationJSONException(e.getMessage))
}.recoverWith { // If the input is a file, wrap in InvalidAnnotationFileException
case e: FirrtlUserException => in match {
case FileInput(file) =>
Failure(new InvalidAnnotationFileException(file, e))
case _ => Failure(e)
}
}
}
|
