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
|
// See LICENSE for license details.
package firrtl.passes
import firrtl._
import firrtl.ir._
import firrtl.PrimOps._
import firrtl.traversals.Foreachers._
import firrtl.Utils._
import firrtl.constraint.IsKnown
import firrtl.annotations.{CircuitTarget, ModuleTarget, Target, TargetToken}
import firrtl.options.{Dependency, PreservesAll}
object CheckWidths extends Pass with PreservesAll[Transform] {
override val prerequisites = Dependency[passes.InferWidths] +: firrtl.stage.Forms.WorkingIR
override val dependents = Seq(Dependency[transforms.InferResets])
/** The maximum allowed width for any circuit element */
val MaxWidth = 1000000
val DshlMaxWidth = getUIntWidth(MaxWidth)
class UninferredWidth (info: Info, target: String) extends PassException(
s"""|$info : Uninferred width for target below.serialize}. (Did you forget to assign to it?)
|$target""".stripMargin)
class UninferredBound (info: Info, target: String, bound: String) extends PassException(
s"""|$info : Uninferred $bound bound for target. (Did you forget to assign to it?)
|$target""".stripMargin)
class InvalidRange (info: Info, target: String, i: IntervalType) extends PassException(
s"""|$info : Invalid range ${i.serialize} for target below. (Are the bounds valid?)
|$target""".stripMargin)
class WidthTooSmall(info: Info, mname: String, b: BigInt) extends PassException(
s"$info : [target $mname] Width too small for constant $b.")
class WidthTooBig(info: Info, mname: String, b: BigInt) extends PassException(
s"$info : [target $mname] Width $b greater than max allowed width of $MaxWidth bits")
class DshlTooBig(info: Info, mname: String) extends PassException(
s"$info : [target $mname] Width of dshl shift amount cannot be larger than $DshlMaxWidth bits.")
class NegWidthException(info:Info, mname: String) extends PassException(
s"$info: [target $mname] Width cannot be negative or zero.")
class BitsWidthException(info: Info, mname: String, hi: BigInt, width: BigInt, exp: String) extends PassException(
s"$info: [target $mname] High bit $hi in bits operator is larger than input width $width in $exp.")
class HeadWidthException(info: Info, mname: String, n: BigInt, width: BigInt) extends PassException(
s"$info: [target $mname] Parameter $n in head operator is larger than input width $width.")
class TailWidthException(info: Info, mname: String, n: BigInt, width: BigInt) extends PassException(
s"$info: [target $mname] Parameter $n in tail operator is larger than input width $width.")
class AttachWidthsNotEqual(info: Info, mname: String, eName: String, source: String) extends PassException(
s"$info: [target $mname] Attach source $source and expression $eName must have identical widths.")
class DisjointSqueeze(info: Info, mname: String, squeeze: DoPrim)
extends PassException({
val toSqz = squeeze.args.head.serialize
val toSqzTpe = squeeze.args.head.tpe.serialize
val sqzTo = squeeze.args(1).serialize
val sqzToTpe = squeeze.args(1).tpe.serialize
s"$info: [module $mname] Disjoint squz currently unsupported: $toSqz:$toSqzTpe cannot be squeezed with $sqzTo's type $sqzToTpe"
})
def run(c: Circuit): Circuit = {
val errors = new Errors()
def check_width_w(info: Info, target: Target, t: Type)(w: Width): Unit = {
(w, t) match {
case (IntWidth(width), _) if width >= MaxWidth =>
errors.append(new WidthTooBig(info, target.serialize, width))
case (w: IntWidth, f: FixedType) if (w.width < 0 && w.width == f.width) =>
errors append new NegWidthException(info, target.serialize)
case (_: IntWidth, _) =>
case _ =>
errors append new UninferredWidth(info, target.prettyPrint(" "))
}
}
def hasWidth(tpe: Type): Boolean = tpe match {
case GroundType(IntWidth(w)) => true
case GroundType(_) => false
case _ => throwInternalError(s"hasWidth - $tpe")
}
def check_width_t(info: Info, target: Target)(t: Type): Unit = {
t match {
case tt: BundleType => tt.fields.foreach(check_width_f(info, target))
//Supports when l = u (if closed)
case i@IntervalType(Closed(l), Closed(u), IntWidth(_)) if l <= u => i
case i:IntervalType if i.range == Some(Nil) =>
errors append new InvalidRange(info, target.prettyPrint(" "), i)
i
case i@IntervalType(KnownBound(l), KnownBound(u), IntWidth(p)) if l >= u =>
errors append new InvalidRange(info, target.prettyPrint(" "), i)
i
case i@IntervalType(KnownBound(_), KnownBound(_), IntWidth(_)) => i
case i@IntervalType(_: IsKnown, _, _) =>
errors append new UninferredBound(info, target.prettyPrint(" "), "upper")
i
case i@IntervalType(_, _: IsKnown, _) =>
errors append new UninferredBound(info, target.prettyPrint(" "), "lower")
i
case i@IntervalType(_, _, _) =>
errors append new UninferredBound(info, target.prettyPrint(" "), "lower")
errors append new UninferredBound(info, target.prettyPrint(" "), "upper")
i
case tt => tt foreach check_width_t(info, target)
}
t foreach check_width_w(info, target, t)
}
def check_width_f(info: Info, target: Target)(f: Field): Unit =
check_width_t(info, target.modify(tokens = target.tokens :+ TargetToken.Field(f.name)))(f.tpe)
def check_width_e(info: Info, target: Target)(e: Expression): Unit = {
e match {
case e: UIntLiteral => e.width match {
case w: IntWidth if math.max(1, e.value.bitLength) > w.width =>
errors append new WidthTooSmall(info, target.serialize, e.value)
case _ =>
}
case e: SIntLiteral => e.width match {
case w: IntWidth if e.value.bitLength + 1 > w.width =>
errors append new WidthTooSmall(info, target.serialize, e.value)
case _ =>
}
case sqz@DoPrim(Squeeze, Seq(a, b), _, IntervalType(Closed(min), Closed(max), _)) =>
(a.tpe, b.tpe) match {
case (IntervalType(Closed(la), Closed(ua), _), IntervalType(Closed(lb), Closed(ub), _)) if (ua < lb) || (ub < la) =>
errors append new DisjointSqueeze(info, target.serialize, sqz)
case other =>
}
case DoPrim(Bits, Seq(a), Seq(hi, lo), _) if (hasWidth(a.tpe) && bitWidth(a.tpe) <= hi) =>
errors append new BitsWidthException(info, target.serialize, hi, bitWidth(a.tpe), e.serialize)
case DoPrim(Head, Seq(a), Seq(n), _) if (hasWidth(a.tpe) && bitWidth(a.tpe) < n) =>
errors append new HeadWidthException(info, target.serialize, n, bitWidth(a.tpe))
case DoPrim(Tail, Seq(a), Seq(n), _) if (hasWidth(a.tpe) && bitWidth(a.tpe) < n) =>
errors append new TailWidthException(info, target.serialize, n, bitWidth(a.tpe))
case DoPrim(Dshl, Seq(a, b), _, _) if (hasWidth(a.tpe) && bitWidth(b.tpe) >= DshlMaxWidth) =>
errors append new DshlTooBig(info, target.serialize)
case _ =>
}
e foreach check_width_e(info, target)
}
def check_width_s(minfo: Info, target: ModuleTarget)(s: Statement): Unit = {
val info = get_info(s) match { case NoInfo => minfo case x => x }
val subRef = s match { case sx: HasName => target.ref(sx.name) case _ => target }
s foreach check_width_e(info, target)
s foreach check_width_s(info, target)
s foreach check_width_t(info, subRef)
s match {
case Attach(infox, exprs) =>
exprs.tail.foreach ( e =>
if (bitWidth(e.tpe) != bitWidth(exprs.head.tpe))
errors.append(new AttachWidthsNotEqual(infox, target.serialize, e.serialize, exprs.head.serialize))
)
case sx: DefRegister =>
sx.reset.tpe match {
case UIntType(IntWidth(w)) if w == 1 =>
case AsyncResetType =>
case ResetType =>
case _ => errors.append(new CheckTypes.IllegalResetType(info, target.serialize, sx.name))
}
if(!CheckTypes.validConnect(sx.tpe, sx.init.tpe)) {
val conMsg = sx.copy(info = NoInfo).serialize
errors.append(new CheckTypes.InvalidConnect(info, target.module, conMsg, WRef(sx), sx.init))
}
case _ =>
}
}
def check_width_p(minfo: Info, target: ModuleTarget)(p: Port): Unit = check_width_t(p.info, target.ref(p.name))(p.tpe)
def check_width_m(circuit: CircuitTarget)(m: DefModule): Unit = {
m foreach check_width_p(m.info, circuit.module(m.name))
m foreach check_width_s(m.info, circuit.module(m.name))
}
c.modules foreach check_width_m(CircuitTarget(c.main))
errors.trigger()
c
}
}
|
