aboutsummaryrefslogtreecommitdiff
path: root/src/test/scala/firrtlTests/transforms/CSESubAccessesSpec.scala
blob: f7d67026fdedabee9d1abe53dbe15498c7dfd8ba (plain)
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
217
218
219
220
221
222
223
// SPDX-License-Identifier: Apache-2.0

package firrtlTests
package transforms

import firrtl._
import firrtl.testutils._
import firrtl.stage.TransformManager
import firrtl.options.Dependency
import firrtl.transforms.CSESubAccesses

class CSESubAccessesSpec extends FirrtlFlatSpec {
  def compile(input: String): String = {
    val manager = new TransformManager(Dependency[CSESubAccesses] :: Nil)
    val result = manager.execute(CircuitState(parse(input), Nil))
    result.circuit.serialize
  }
  def circuit(body: String): String = {
    """|circuit Test :
       |  module Test :
       |""".stripMargin + body.stripMargin.split("\n").mkString("    ", "\n    ", "\n")
  }

  behavior.of("CSESubAccesses")

  it should "hoist a single RHS subaccess" in {
    val input = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |out <= in[idx]"""
    )
    val expected = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |node _in_idx = in[idx]
          |out <= _in_idx"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "be idempotent" in {
    val input = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |out <= in[idx]"""
    )
    val expected = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |node _in_idx = in[idx]
          |out <= _in_idx"""
    )
    val first = compile(input)
    val second = compile(first)
    first should be(second)
    first should be(parse(expected).serialize)
  }

  it should "hoist a redundant RHS subaccess" in {
    val input = circuit(
      s"""|input in : { foo : UInt<8>, bar : UInt<8> }[4]
          |input idx : UInt<2>
          |output out : { foo : UInt<8>, bar : UInt<8> }
          |out.foo <= in[idx].foo
          |out.bar <= in[idx].bar"""
    )
    val expected = circuit(
      s"""|input in : { foo : UInt<8>, bar : UInt<8> }[4]
          |input idx : UInt<2>
          |output out : { foo : UInt<8>, bar : UInt<8> }
          |node _in_idx = in[idx]
          |out.foo <= _in_idx.foo
          |out.bar <= _in_idx.bar"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "correctly place hosited subaccess after last declaration it depends on" in {
    val input = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |out is invalid
          |when UInt(1) :
          |  node nidx = not(idx)
          |  out <= in[nidx]
          |"""
    )
    val expected = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |out is invalid
          |when UInt(1) :
          |  node nidx = not(idx)
          |  node _in_nidx = in[nidx]
          |  out <= _in_nidx
          |"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "support complex expressions" in {
    val input = circuit(
      s"""|input clock : Clock
          |input in : UInt<8>[4]
          |input idx : UInt<2>
          |input sel : UInt<1>
          |output out : UInt<8>
          |reg r : UInt<2>, clock
          |out <= in[mux(sel, r, idx)]
          |r <= not(idx)"""
    )
    val expected = circuit(
      s"""|input clock : Clock
          |input in : UInt<8>[4]
          |input idx : UInt<2>
          |input sel : UInt<1>
          |output out : UInt<8>
          |reg r : UInt<2>, clock
          |node _in_mux = in[mux(sel, r, idx)]
          |out <= _in_mux
          |r <= not(idx)"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "support nested subaccesses" in {
    val input = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>[4]
          |input jdx : UInt<2>
          |output out : UInt<8>
          |out <= in[idx[jdx]]"""
    )
    val expected = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>[4]
          |input jdx : UInt<2>
          |output out : UInt<8>
          |node _idx_jdx = idx[jdx]
          |node _in_idx = in[_idx_jdx]
          |out <= _in_idx"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "avoid name collisions" in {
    val input = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |out <= in[idx]
          |node _in_idx = not(idx)"""
    )
    val expected = circuit(
      s"""|input in : UInt<8>[4]
          |input idx : UInt<2>
          |output out : UInt<8>
          |node _in_idx_0 = in[idx]
          |out <= _in_idx_0
          |node _in_idx = not(idx)"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "have no effect on LHS SubAccesses" in {
    val input = circuit(
      s"""|input in : UInt<8>
          |input idx : UInt<2>
          |output out : UInt<8>[4]
          |out[idx] <= in"""
    )
    val expected = circuit(
      s"""|input in : UInt<8>
          |input idx : UInt<2>
          |output out : UInt<8>[4]
          |out[idx] <= in"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "ignore flipped LHS SubAccesses" in {
    val input = circuit(
      s"""|input in : { foo : UInt<8> }
          |input idx : UInt<1>
          |input out : { flip foo : UInt<8> }[2]
          |out[0].foo <= UInt(0)
          |out[1].foo <= UInt(0)
          |out[idx].foo <= in.foo"""
    )
    val expected = circuit(
      s"""|input in : { foo : UInt<8> }
          |input idx : UInt<1>
          |input out : { flip foo : UInt<8> }[2]
          |out[0].foo <= UInt(0)
          |out[1].foo <= UInt(0)
          |out[idx].foo <= in.foo"""
    )
    compile(input) should be(parse(expected).serialize)
  }

  it should "ignore SubAccesses of bidirectional aggregates" in {
    val input = circuit(
      s"""|input in : { flip foo : UInt<8>, bar : UInt<8> }
          |input idx : UInt<2>
          |output out : { flip foo : UInt<8>, bar : UInt<8> }[4]
          |out[idx] <= in"""
    )
    val expected = circuit(
      s"""|input in : { flip foo : UInt<8>, bar : UInt<8> }
          |input idx : UInt<2>
          |output out : { flip foo : UInt<8>, bar : UInt<8> }[4]
          |out[idx] <= in"""
    )
    compile(input) should be(parse(expected).serialize)
  }

}