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
|
// SPDX-License-Identifier: Apache-2.0
package firrtl.backends.proto
import firrtl.{AnnotationSeq, CircuitState, DependencyAPIMigration, Transform}
import firrtl.ir
import firrtl.annotations.NoTargetAnnotation
import firrtl.options.CustomFileEmission
import firrtl.options.Viewer.view
import firrtl.proto.ToProto
import firrtl.stage.{FirrtlOptions, Forms}
import firrtl.stage.TransformManager.TransformDependency
import java.io.{ByteArrayOutputStream, Writer}
/** This object defines Annotations that are used by Protocol Buffer emission.
*/
object Annotation {
/** This will cause the enclosed circuit to be serialized to a Protocol Buffer with the provided suffix. */
case class ProtoBufSerialization(circuit: ir.Circuit, suffix: Option[String])
extends NoTargetAnnotation
with CustomFileEmission {
/** The hash code is cached for this case class because it includes a very large circuit operand whose hash is expensive
* to compute. This is safe to do because the case class is immutable.
*/
override lazy val hashCode = scala.util.hashing.MurmurHash3.productHash(this)
override protected def baseFileName(annotations: AnnotationSeq): String = {
view[FirrtlOptions](annotations).outputFileName.getOrElse(circuit.main)
}
override def getBytes: Iterable[Byte] = {
val ostream = new java.io.ByteArrayOutputStream
ToProto.writeToStream(ostream, circuit)
ostream.toByteArray()
}
}
}
/** Running this transform will cause a circuit to be emitted to ProtoBuf after some prerequisites have been
* satisfied.
*
* This is not intended to be used directly. Instead see one of the concrete emitters, e.g., [[Emitter.Low]].
* @see [[Emitter.Chirrtl]]
* @see [[Emitter.MHigh]]
* @see [[Emitter.High]]
* @see [[Emitter.Middle]]
* @see [[Emitter.Low]]
* @see [[Emitter.OptLow]]
*/
sealed abstract class ProtoBufEmitter(prereqs: Seq[TransformDependency])
extends Transform
with DependencyAPIMigration
with firrtl.Emitter {
override def prerequisites = prereqs
override def optionalPrerequisites = Seq.empty
override def optionalPrerequisiteOf = Seq.empty
override def invalidates(a: Transform) = false
override def execute(state: CircuitState) =
state.copy(annotations = state.annotations :+ Annotation.ProtoBufSerialization(state.circuit, Some(outputSuffix)))
override def emit(state: CircuitState, writer: Writer): Unit = {
val ostream = new java.io.ByteArrayOutputStream
ToProto.writeToStream(ostream, state.circuit)
writer.write(ostream.toString())
}
}
/** This object defines different emitters that can be used to generate a Protocol Buffer of a FIRRTL circuit. */
object Emitter {
/** Emit a FIRRTL circuit as ProtoBuf in CHIRRTL form. */
class Chirrtl extends ProtoBufEmitter(Forms.ChirrtlForm) {
override def outputSuffix = ".pb"
}
/** Emit a FIRRTL circuit as ProtoBuf in minimal High FIRRTL form.
*
* This will only have CHIRRTL constructs removed. The circuit will not be deduplicated nor have widths inferred.
* @see [[High]]
*/
class MHigh extends ProtoBufEmitter(Forms.MinimalHighForm) {
override def outputSuffix = ".mhi.pb"
}
/** Emit a FIRRTL circuit as ProtoBuf in High FIRRTL form.
*
* The emitted circuit will be structurally deduplicated and have widths inferred.
* @see [[MHigh]]
*/
class High extends ProtoBufEmitter(Forms.HighForm) {
override def outputSuffix = ".hi.pb"
}
/** Emit a FIRRTL circuit as ProtoBuf in Mid FIRRTL form. */
class Middle extends ProtoBufEmitter(Forms.MidForm) {
override def outputSuffix = ".mid.pb"
}
/** Emit a FIRRTL circuit as ProtoBuf in Low FIRRTL form without optimizations.
*
* @see [[OptLow]]
*/
class Low extends ProtoBufEmitter(Forms.LowForm) {
override def outputSuffix = ".lo.pb"
}
/** Emit a FIRRTL circuit as ProtoBuf in Low FIRRTL form with optimizations.
*
* @see [[OptLow]]
*/
class OptLow extends ProtoBufEmitter(Forms.LowFormOptimized) {
override def outputSuffix = ".lo.pb"
}
}
|
