-
Notifications
You must be signed in to change notification settings - Fork 594
/
PanamaCIRCTConverter.scala
1872 lines (1709 loc) · 77.5 KB
/
PanamaCIRCTConverter.scala
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: Apache-2.0
package chisel3.panamaconverter
import java.io.OutputStream
import geny.Writable
import chisel3.panamalib._
import scala.collection.mutable
import scala.math._
import firrtl.{ir => fir}
import chisel3.{Data => ChiselData, _}
import chisel3.experimental._
import chisel3.internal._
import chisel3.internal.firrtl.ir._
import chisel3.internal.firrtl.Converter
import chisel3.assert.{Assert => VerifAssert}
import chisel3.assume.{Assume => VerifAssume}
import chisel3.cover.{Cover => VerifCover}
import chisel3.panamalib.option.FirtoolOptions
import chisel3.panamaom.PanamaCIRCTOM
import chisel3.printf.{Printf => VerifPrintf}
import chisel3.stop.{Stop => VerifStop}
case class Region(region: MlirRegion, blocks: Seq[MlirBlock]) {
def get(): MlirRegion = region
def block(i: Int): MlirBlock = blocks(i)
}
case class Op(state: MlirOperationState, op: MlirOperation, regions: Seq[Region], results: Seq[MlirValue]) {
def region(i: Int): Region = {
regions(i)
}
}
case class Ports(
types: Seq[MlirType],
dirs: Seq[FIRRTLDirection],
locs: Seq[MlirLocation],
names: Seq[String],
nameAttrs: Seq[MlirAttribute],
typeAttrs: Seq[MlirAttribute],
annotationAttrs: Seq[MlirAttribute],
symAttrs: Seq[MlirAttribute],
locAttrs: Seq[MlirAttribute])
final case class FirTypeLazy(private var tpeOrData: Either[fir.Type, ChiselData]) {
def get: fir.Type = {
tpeOrData match {
case Left(tpe) => tpe
case Right(data) =>
val tpe = Converter.extractType(data, null)
tpeOrData = Left(tpe)
tpe
}
}
}
object FirTypeLazy {
implicit def apply(tpe: fir.Type): FirTypeLazy = FirTypeLazy(Left(tpe))
implicit def apply(data: ChiselData): FirTypeLazy = FirTypeLazy(Right(data))
}
sealed abstract class Reference
object Reference {
final case class Null() extends Reference
final case class Value(value: MlirValue, private val typeLazy: FirTypeLazy) extends Reference {
def tpe: fir.Type = typeLazy.get
}
// We made it for BlackBox port reference, as there will be only `io` port inside BlackBox and it will be stripped
final case class BlackBoxIO(enclosure: BaseModule) extends Reference
final case class SubField(index: Int, tpe: fir.Type) extends Reference
final case class SubIndex(index: Int, tpe: fir.Type) extends Reference
final case class SubIndexDynamic(index: MlirValue, tpe: fir.Type) extends Reference
}
case class WhenContext(op: Op, parent: MlirBlock, var inAlt: Boolean) {
def block: MlirBlock = op.region(if (!inAlt) 0 else 1).block(0)
}
class FirContext {
var opCircuit: Op = null
var opModules: Seq[(String, Op)] = Seq.empty
val whenStack = mutable.Stack.empty[WhenContext]
// TODO: It's a bit dirty, let's refactor it later
val items = mutable.Map.empty[Long, Seq[MlirValue]]
val ops = mutable.Map.empty[Long, MlirOperation]
def newItem(id: HasId, value: MlirValue) = items += ((id._id, Seq(value)))
def newItemVec(id: HasId, value: Seq[MlirValue]) = items += ((id._id, value))
def getItem(id: HasId): Option[MlirValue] = {
items
.get(id._id)
.map(i => {
assert(i.length == 1, "item is a vector")
i(0)
})
}
def getItemVec(id: HasId): Option[Seq[MlirValue]] = items.get(id._id)
def enterNewCircuit(newCircuit: Op): Unit = {
items.clear()
opCircuit = newCircuit
}
def enterNewModule(name: String, newModule: Op): Unit = {
items.clear()
opModules = opModules :+ (name, newModule)
}
def enterWhen(whenOp: Op): Unit = whenStack.push(WhenContext(whenOp, currentBlock, false))
def enterAlt(): Unit = whenStack.top.inAlt = true
def leaveOtherwise(depth: Int): Unit = (1 to depth).foreach(_ => whenStack.pop)
def leaveWhen(depth: Int, hasAlt: Boolean): Unit = if (!hasAlt) (0 to depth).foreach(_ => whenStack.pop)
def circuitBlock: MlirBlock = opCircuit.region(0).block(0)
def findModuleBlock(name: String): MlirBlock = opModules.find(_._1 == name).get._2.region(0).block(0)
def currentModuleName: String = opModules.last._1
def currentModuleBlock: MlirBlock = opModules.last._2.region(0).block(0)
def currentBlock: MlirBlock = if (whenStack.nonEmpty) whenStack.top.block else currentModuleBlock
def currentWhen: Option[WhenContext] = Option.when(whenStack.nonEmpty)(whenStack.top)
def rootWhen: Option[WhenContext] = Option.when(whenStack.nonEmpty)(whenStack.last)
}
class PanamaCIRCTConverter(val circt: PanamaCIRCT, fos: Option[FirtoolOptions], annotationsJSON: String) {
val firCtx = new FirContext
var mlirRootModule = circt.mlirModuleCreateEmpty(circt.unkLoc)
object util {
def getWidthOrSentinel(width: fir.Width): BigInt = width match {
case fir.UnknownWidth => -1
case fir.IntWidth(v) => v
}
/// If this is an IntType, AnalogType, or sugar type for a single bit (Clock,
/// Reset, etc) then return the bitwidth. Return -1 if the is one of these
/// types but without a specified bitwidth. Return -2 if this isn't a simple
/// type.
def getWidthOrSentinel(tpe: fir.Type): BigInt = {
tpe match {
case fir.ClockType | fir.ResetType | fir.AsyncResetType => 1
case fir.UIntType(width) => getWidthOrSentinel(width)
case fir.SIntType(width) => getWidthOrSentinel(width)
case fir.AnalogType(width) => getWidthOrSentinel(width)
case fir.ProbeType(underlying, _) => getWidthOrSentinel(underlying)
case fir.RWProbeType(underlying, _) => getWidthOrSentinel(underlying)
case _: fir.BundleType | _: fir.VectorType => -2
case unhandled => throw new Exception(s"unhandled: $unhandled")
}
}
def convert(firType: fir.Type): MlirType = {
firType match {
case t: fir.UIntType => circt.firrtlTypeGetUInt(getWidthOrSentinel(t.width).toInt)
case t: fir.SIntType => circt.firrtlTypeGetSInt(getWidthOrSentinel(t.width).toInt)
case fir.ClockType => circt.firrtlTypeGetClock()
case fir.ResetType => circt.firrtlTypeGetReset()
case fir.AsyncResetType => circt.firrtlTypeGetAsyncReset()
case t: fir.AnalogType => circt.firrtlTypeGetAnalog(getWidthOrSentinel(t.width).toInt)
case t: fir.VectorType => circt.firrtlTypeGetVector(convert(t.tpe), t.size)
case t: fir.BundleType =>
circt.firrtlTypeGetBundle(
t.fields.map(field =>
new FIRRTLBundleField(
field.name,
field.flip match {
case fir.Default => false
case fir.Flip => true
},
convert(field.tpe)
)
)
)
case fir.ProbeType(underlying, _) => circt.firrtlTypeGetRef(convert(underlying), false)
case fir.RWProbeType(underlying, _) => circt.firrtlTypeGetRef(convert(underlying), true)
case fir.AnyRefPropertyType => circt.firrtlTypeGetAnyRef()
case fir.IntegerPropertyType => circt.firrtlTypeGetInteger()
case fir.DoublePropertyType => circt.firrtlTypeGetDouble()
case fir.StringPropertyType => circt.firrtlTypeGetString()
case fir.BooleanPropertyType => circt.firrtlTypeGetBoolean()
case fir.PathPropertyType => circt.firrtlTypeGetPath()
case t: fir.SequencePropertyType => circt.firrtlTypeGetList(convert(t.tpe))
case t: fir.ClassPropertyType =>
circt.firrtlTypeGetClass(
circt.mlirFlatSymbolRefAttrGet(t.name),
Seq.empty /* TODO: where is the elements? */
)
}
}
def convert(sourceInfo: SourceInfo): MlirLocation = {
sourceInfo match {
case _: NoSourceInfo => circt.unkLoc
case SourceLine(filename, line, col) => circt.mlirLocationFileLineColGet(filename, line, col)
}
}
def convert(name: String, parameter: Param): MlirAttribute = {
val (tpe, value) = parameter match {
case IntParam(value) =>
val tpe = circt.mlirIntegerTypeGet(max(value.bitLength, 32))
(tpe, circt.mlirIntegerAttrGet(tpe, value.toLong))
case DoubleParam(value) =>
val tpe = circt.mlirF64TypeGet()
(tpe, circt.mlirFloatAttrDoubleGet(tpe, value))
case StringParam(value) =>
val tpe = circt.mlirNoneTypeGet()
(tpe, circt.mlirStringAttrGet(value))
}
circt.firrtlAttrGetParamDecl(name, tpe, value)
}
def convert(ports: Seq[Port], topDir: SpecifiedDirection = SpecifiedDirection.Unspecified): Ports = {
val irs = ports.map(Converter.convert(_, topDir)) // firrtl.Port -> IR.Port
val types = irs.foldLeft(Seq.empty[MlirType]) { case (types, port) => types :+ util.convert(port.tpe) }
val locs = ports.map(port => util.convert(port.sourceInfo))
Ports(
types = types,
dirs = irs.map(_.direction match {
case fir.Input => FIRRTLDirection.In
case fir.Output => FIRRTLDirection.Out
}),
locs = locs,
names = irs.map(_.name),
nameAttrs = irs.map(port => circt.mlirStringAttrGet(port.name)),
typeAttrs = types.map(circt.mlirTypeAttrGet(_)),
annotationAttrs = ports.map(_ => circt.emptyArrayAttr),
symAttrs = Seq.empty,
locAttrs = locs.map(circt.mlirLocationGetAttribute(_))
)
}
def moduleBuilderInsertPorts(builder: OpBuilder, ports: Ports): OpBuilder = {
builder
.withNamedAttr("portDirections", circt.firrtlAttrGetPortDirs(ports.dirs))
.withNamedAttr("portNames", circt.mlirArrayAttrGet(ports.nameAttrs))
.withNamedAttr("portTypes", circt.mlirArrayAttrGet(ports.typeAttrs))
.withNamedAttr("portAnnotations", circt.mlirArrayAttrGet(ports.annotationAttrs))
.withNamedAttr("portSyms", circt.mlirArrayAttrGet(ports.symAttrs))
.withNamedAttr("portLocations", circt.mlirArrayAttrGet(ports.locAttrs))
}
def widthShl(lhs: fir.Width, rhs: fir.Width): fir.Width = (lhs, rhs) match {
case (l: fir.IntWidth, r: fir.IntWidth) => fir.IntWidth(l.width << r.width.toInt)
case _ => fir.UnknownWidth
}
case class OpBuilder(opName: String, parent: MlirBlock, loc: MlirLocation) {
var regionsBlocks: Seq[Option[Seq[(Seq[MlirType], Seq[MlirLocation])]]] = Seq.empty
var attrs: Seq[MlirNamedAttribute] = Seq.empty
var operands: Seq[MlirValue] = Seq.empty
var results: Seq[MlirType] = Seq.empty
var resultInference: Option[Int] = None
def withRegion(block: Seq[(Seq[MlirType], Seq[MlirLocation])]): OpBuilder = {
regionsBlocks = regionsBlocks :+ Some(block)
this
}
def withRegionNoBlock(): OpBuilder = {
regionsBlocks = regionsBlocks :+ None
this
}
def withRegions(blocks: Seq[Seq[(Seq[MlirType], Seq[MlirLocation])]]): OpBuilder = {
regionsBlocks = regionsBlocks ++ blocks.map(Some(_))
this
}
def withNamedAttr(name: String, attr: MlirAttribute): OpBuilder = {
attrs = attrs :+ circt.mlirNamedAttributeGet(name, attr)
this
}
def withNamedAttrs(as: Seq[(String, MlirAttribute)]): OpBuilder = {
as.foreach(a => withNamedAttr(a._1, a._2))
this
}
def withOperand(o: MlirValue): OpBuilder = { operands = operands :+ o; this }
def withOperands(os: Seq[MlirValue]): OpBuilder = { operands = operands ++ os; this }
def withResult(r: MlirType): OpBuilder = { results = results :+ r; this }
def withResults(rs: Seq[MlirType]): OpBuilder = { results = results ++ rs; this }
def withResultInference(expectedCount: Int): OpBuilder = { resultInference = Some(expectedCount); this }
private[OpBuilder] def buildImpl(inserter: MlirOperation => Unit): Op = {
val state = circt.mlirOperationStateGet(opName, loc)
circt.mlirOperationStateAddAttributes(state, attrs)
circt.mlirOperationStateAddOperands(state, operands)
if (resultInference.isEmpty) {
circt.mlirOperationStateAddResults(state, results)
} else {
circt.mlirOperationStateEnableResultTypeInference(state)
}
val builtRegions = regionsBlocks.foldLeft(Seq.empty[Region]) {
case (builtRegions, blocks) => {
val region = circt.mlirRegionCreate()
if (blocks.nonEmpty) {
val builtBlocks = blocks.get.map {
case (blockArgTypes, blockArgLocs) => {
val block = circt.mlirBlockCreate(blockArgTypes, blockArgLocs)
circt.mlirRegionAppendOwnedBlock(region, block)
block
}
}
builtRegions :+ Region(region, builtBlocks)
} else {
builtRegions :+ Region(region, Seq.empty)
}
}
}
circt.mlirOperationStateAddOwnedRegions(state, builtRegions.map(_.region))
val op = circt.mlirOperationCreate(state)
inserter(op)
val resultVals = (0 until resultInference.getOrElse(results.length)).map(
circt.mlirOperationGetResult(op, _)
)
Op(state, op, builtRegions, resultVals)
}
def build(): Op = buildImpl(circt.mlirBlockAppendOwnedOperation(parent, _))
def buildAfter(ref: Op): Op = buildImpl(circt.mlirBlockInsertOwnedOperationAfter(parent, ref.op, _))
def buildBefore(ref: Op): Op = buildImpl(circt.mlirBlockInsertOwnedOperationBefore(parent, ref.op, _))
}
def newConstantValue(
resultType: fir.Type,
valueType: MlirType,
bitLen: Int,
value: BigInt,
loc: MlirLocation
): MlirValue = {
util
.OpBuilder("firrtl.constant", firCtx.currentBlock, loc)
.withNamedAttr("value", circt.firrtlAttrGetIntegerFromString(valueType, bitLen, value.toString, 10))
.withResult(util.convert(resultType))
.build()
.results(0)
}
// Get reference chain for a node
def valueReferenceChain(id: HasId, srcInfo: SourceInfo): Seq[Reference] = {
def rec(id: HasId, chain: Seq[Reference]): Seq[Reference] = {
def referToPort(data: ChiselData, enclosure: BaseModule): Reference = {
enclosure match {
case enclosure: BlackBox => Reference.BlackBoxIO(enclosure)
case enclosure =>
val index = enclosure.getChiselPorts.indexWhere(_._2 == data)
assert(index >= 0, s"can't find port '$data' from '$enclosure'")
val value = if (enclosure.name != firCtx.currentModuleName) {
// Reference to a port from instance
firCtx.getItemVec(enclosure).get(index)
} else {
// Reference to a port from current module
circt.mlirBlockGetArgument(firCtx.currentModuleBlock, index)
}
Reference.Value(value, data)
}
}
def referToElement(data: ChiselData): Reference = {
val tpe = Converter.extractType(data, null)
data.binding.getOrElse(throw new Exception("non-child data")) match {
case binding: ChildBinding =>
binding.parent match {
case vec: Vec[_] =>
data.getRef match {
case Index(_, ILit(index)) => Reference.SubIndex(index.toInt, tpe)
case Index(_, dynamicIndex) =>
val index = referTo(dynamicIndex, srcInfo)
Reference.SubIndexDynamic(index.value, tpe)
}
case record: Record =>
val index = record.elements.size - record.elements.values.iterator.indexOf(data) - 1
assert(index >= 0, s"can't find field '$data'")
Reference.SubField(index, tpe)
}
case _ => throw new Exception("non-child data")
}
}
def referToValue(data: ChiselData) = Reference.Value(
firCtx.getItem(data) match {
case Some(value) => value
case None => throw new Exception(s"data $data not found")
},
data
)
id match {
case module: BaseModule => chain
case data: ChiselData =>
data.binding.getOrElse(throw new Exception("unbound data")) match {
case PortBinding(enclosure) => rec(enclosure, chain :+ referToPort(data, enclosure))
case ChildBinding(parent) => rec(parent, chain :+ referToElement(data))
case SampleElementBinding(parent) => rec(parent, chain :+ referToElement(data))
case MemoryPortBinding(enclosure, visibility) => rec(enclosure, chain :+ referToValue(data))
case WireBinding(enclosure, visibility) => rec(enclosure, chain :+ referToValue(data))
case OpBinding(enclosure, visibility) => rec(enclosure, chain :+ referToValue(data))
case RegBinding(enclosure, visibility) => rec(enclosure, chain :+ referToValue(data))
case SecretPortBinding(enclosure) => rec(enclosure, chain :+ referToPort(data, enclosure))
case unhandled => throw new Exception(s"unhandled binding $unhandled")
}
case mem: Mem[ChiselData] => chain :+ referToValue(mem.t)
case smem: SyncReadMem[ChiselData] => chain :+ referToValue(smem.t)
case unhandled => throw new Exception(s"unhandled node $unhandled")
}
}
rec(id, Seq()).reverse // Reverse to make it root first
}
def referTo(id: HasId, srcInfo: SourceInfo): Reference.Value = {
val loc = util.convert(srcInfo)
val indexType = circt.mlirIntegerTypeGet(32)
val refChain = valueReferenceChain(id, srcInfo)
// Root value will be the first element in the chain
// So the initialization value of the `foldLeft` is unnecessary
refChain.foldLeft(Reference.Null().asInstanceOf[Reference]) {
case (parent: Reference, ref: Reference) => {
ref match {
case ref @ Reference.Value(_, _) => ref
case ref @ Reference.BlackBoxIO(_) => ref
case Reference.SubField(index, tpe) =>
val value = parent match {
case Reference.Value(parentValue, parentType) =>
val op = if (circt.firrtlTypeIsAOpenBundle(circt.mlirValueGetType(parentValue))) {
"firrtl.opensubfield"
} else {
"firrtl.subfield"
}
util
.OpBuilder(op, firCtx.currentBlock, loc)
.withNamedAttr("fieldIndex", circt.mlirIntegerAttrGet(indexType, index))
.withOperand(parentValue)
.withResult(util.convert(tpe))
.build()
.results(0)
case Reference.BlackBoxIO(enclosure) =>
// Look up the field under the instance
firCtx.getItemVec(enclosure).map(_(index)).get
}
Reference.Value(value, tpe)
case Reference.SubIndex(index, tpe) =>
val (parentValue, parentType) = parent match {
case Reference.Value(parentValue, parentType) => (parentValue, parentType)
}
Reference.Value(
util
.OpBuilder("firrtl.subindex", firCtx.currentBlock, loc)
.withNamedAttr("index", circt.mlirIntegerAttrGet(indexType, index))
.withOperand(parentValue)
.withResult(util.convert(tpe))
.build()
.results(0),
tpe
)
case Reference.SubIndexDynamic(index, tpe) =>
val (parentValue, parentType) = parent match {
case Reference.Value(parentValue, parentType) => (parentValue, parentType)
}
Reference.Value(
util
.OpBuilder("firrtl.subaccess", firCtx.currentBlock, loc)
.withOperand( /* input */ parentValue)
.withOperand( /* index */ index)
.withResult(util.convert(tpe))
.build()
.results(0),
tpe
)
}
}
} match {
case ref @ Reference.Value(_, _) => ref
}
}
def referTo(
arg: Arg,
srcInfo: SourceInfo,
parent: Option[Component] = None
): Reference.Value = {
def referToNewConstant(n: BigInt, w: Width, isSigned: Boolean): Reference.Value = {
val (firWidth, valWidth) = w match {
case _: UnknownWidth =>
// We need to keep the most significant sign bit for signed literals
val bitLen = if (!isSigned) max(n.bitLength, 1) else n.bitLength + 1
(fir.IntWidth(bitLen), bitLen)
case w: KnownWidth => (fir.IntWidth(w.get), w.get)
}
val resultType = if (isSigned) fir.SIntType(firWidth) else fir.UIntType(firWidth)
val valueType =
if (isSigned) circt.mlirIntegerTypeSignedGet(valWidth) else circt.mlirIntegerTypeUnsignedGet(valWidth)
Reference.Value(util.newConstantValue(resultType, valueType, valWidth, n, util.convert(srcInfo)), resultType)
}
def referToNewProperty[T, U](propLit: PropertyLit[T, U]): Reference.Value = {
def rec(tpe: fir.PropertyType, exp: fir.Expression): MlirValue = {
val (opName, attrs, operands) = exp match {
case fir.IntegerPropertyLiteral(value) =>
val attrs = Seq(
(
"value",
circt.mlirIntegerAttrGet(circt.mlirIntegerTypeSignedGet(max(value.bitLength, 1) + 1), value.toLong)
)
)
("integer", attrs, Seq.empty)
case fir.DoublePropertyLiteral(value) =>
val attrs = Seq(("value", circt.mlirFloatAttrDoubleGet(circt.mlirF64TypeGet(), value)))
("double", attrs, Seq.empty)
case fir.StringPropertyLiteral(value) =>
val attrs = Seq(("value", circt.mlirStringAttrGet(value)))
("string", attrs, Seq.empty)
case fir.BooleanPropertyLiteral(value) =>
val attrs = Seq(("value", circt.mlirBoolAttrGet(value)))
("bool", attrs, Seq.empty)
case fir.PathPropertyLiteral(value) =>
val attrs = Seq(("target", circt.mlirStringAttrGet(value)))
("unresolved_path", attrs, Seq.empty)
case fir.SequencePropertyValue(elementTpe, values) =>
("list.create", Seq.empty, values.map(rec(elementTpe.asInstanceOf[fir.PropertyType], _)))
}
util
.OpBuilder(s"firrtl.$opName", firCtx.currentBlock, util.convert(srcInfo))
.withNamedAttrs(attrs)
.withOperands(operands)
.withResult(util.convert(tpe))
.build()
.results(0)
}
val tpe = propLit.propertyType.getPropertyType()
val exp = propLit.propertyType.convert(propLit.lit, parent.get, srcInfo);
Reference.Value(rec(tpe, exp), tpe)
}
def referToNewProbe(expr: Arg, resultType: fir.Type): Option[Reference.Value] = {
val builder = expr match {
case ProbeExpr(probe) =>
util
.OpBuilder(s"firrtl.ref.send", firCtx.currentBlock, util.convert(srcInfo))
.withOperand(referTo(probe, srcInfo).value)
case RWProbeExpr(probe) =>
circt.mlirOperationSetInherentAttributeByName(
firCtx.ops.get(probe.asInstanceOf[Node].id._id).get,
"inner_sym",
circt.hwInnerSymAttrGet(probe.localName)
)
util
.OpBuilder("firrtl.ref.rwprobe", firCtx.currentBlock, util.convert(srcInfo))
.withNamedAttr("target", circt.hwInnerRefAttrGet(parent.get.id.name, probe.localName))
case ProbeRead(probe) =>
util
.OpBuilder(s"firrtl.ref.resolve", firCtx.currentBlock, util.convert(srcInfo))
.withOperand(referTo(probe, srcInfo).value)
case _ => return None
}
val op = builder.withResult(util.convert(resultType)).build()
Some(Reference.Value(op.results(0), resultType))
}
arg match {
case Node(id) =>
// Workaround, as the current implementation relies on Binding. We will probably remove the
// current Binding implementation eventually, and use Expression instead
id match {
case data: ChiselData if data.probeInfo.nonEmpty || data.getOptionRef.isDefined =>
referToNewProbe(Converter.getRef(id, srcInfo), Converter.extractType(data, srcInfo)).getOrElse {
referTo(id, srcInfo)
}
case _ => referTo(id, srcInfo)
}
case arg @ ProbeExpr(data) =>
val retTpe =
fir.ProbeType(Converter.extractType(data.asInstanceOf[Node].id.asInstanceOf[ChiselData], srcInfo))
referToNewProbe(arg, retTpe).get
case arg @ ProbeRead(data) =>
val retTpe = Converter
.extractType(data.asInstanceOf[Node].id.asInstanceOf[ChiselData], srcInfo)
.asInstanceOf[fir.ProbeType]
.underlying
referToNewProbe(arg, retTpe).get
case ULit(value, width) => referToNewConstant(value, width, false)
case SLit(value, width) => referToNewConstant(value, width, true)
case propLit: PropertyLit[_, _] => referToNewProperty(propLit)
case unhandled => throw new Exception(s"unhandled arg type to be reference: $unhandled")
}
}
def newNode(id: HasId, name: String, resultType: fir.Type, input: MlirValue, loc: MlirLocation): Unit = {
newNode(id, name, util.convert(resultType), input, loc)
}
def newNode(id: HasId, name: String, resultType: MlirType, input: MlirValue, loc: MlirLocation): Unit = {
val op = util
.OpBuilder("firrtl.node", firCtx.currentBlock, loc)
.withNamedAttr("name", circt.mlirStringAttrGet(name))
.withNamedAttr("nameKind", circt.firrtlAttrGetNameKind(FIRRTLNameKind.InterestingName))
.withNamedAttr("annotations", circt.emptyArrayAttr)
.withOperand(input)
.withResult(resultType)
// .withResult( /* ref */ )
.build()
firCtx.ops += ((id._id, op.op))
firCtx.newItem(id, op.results(0))
}
def emitConnect(dest: Reference.Value, srcVal: Reference.Value, loc: MlirLocation): Unit = {
val indexType = circt.mlirIntegerTypeGet(32)
var src = srcVal
// TODO: Strict connect
(dest.tpe, src.tpe) match {
case (fir.BundleType(fields), fir.BundleType(srcFields)) => {
assert(srcFields.size == fields.size)
def subField(index: Int, value: Reference.Value): Reference.Value = {
val opName = if (circt.firrtlTypeIsAOpenBundle(circt.mlirValueGetType(value.value))) {
"firrtl.opensubfield"
} else {
"firrtl.subfield"
}
val fieldTpe = value.tpe.asInstanceOf[fir.BundleType].fields(index).tpe
val op = util
.OpBuilder(opName, firCtx.currentBlock, loc)
.withNamedAttr("fieldIndex", circt.mlirIntegerAttrGet(indexType, index))
.withOperand(value.value)
.withResult(util.convert(fieldTpe))
.build()
Reference.Value(op.results(0), fieldTpe)
}
for (index <- 0 until fields.size) {
var destField = subField(index, dest)
var srcField = subField(index, src)
if (fields(index).flip == fir.Flip) {
emitConnect(srcField, destField, loc)
} else {
emitConnect(destField, srcField, loc)
}
}
return
}
case (fir.VectorType(tpe, size), fir.VectorType(_, srcSize)) => {
assert(srcSize == size)
def subIndex(index: Int, value: Reference.Value): Reference.Value = {
val fieldTpe = value.tpe.asInstanceOf[fir.VectorType].tpe
val op = util
.OpBuilder("firrtl.subindex", firCtx.currentBlock, loc)
.withNamedAttr("index", circt.mlirIntegerAttrGet(indexType, index))
.withOperand(value.value)
.withResult(util.convert(fieldTpe))
.build()
Reference.Value(op.results(0), fieldTpe)
}
for (index <- 0 until size) {
val destElement = subIndex(index, dest)
val srcElement = subIndex(index, src)
emitConnect(destElement, srcElement, loc)
}
return
}
case (_, _) => {}
}
val destWidth = util.getWidthOrSentinel(dest.tpe)
val srcWidth = util.getWidthOrSentinel(src.tpe)
if (!(destWidth < 0 || srcWidth < 0)) {
if (destWidth < srcWidth) {
val isSignedDest = dest.tpe.isInstanceOf[fir.SIntType]
val tmpType = dest.tpe match {
case t: fir.UIntType => t
case fir.SIntType(width) => fir.UIntType(width)
}
src = Reference.Value(
util
.OpBuilder("firrtl.tail", firCtx.currentBlock, loc)
.withNamedAttrs(
Seq(("amount", circt.mlirIntegerAttrGet(circt.mlirIntegerTypeGet(32), (srcWidth - destWidth).toLong)))
)
.withOperands(Seq(src.value))
.withResult(util.convert(tmpType))
.build()
.results(0),
tmpType
)
if (isSignedDest) {
src = Reference.Value(
util
.OpBuilder("firrtl.asSInt", firCtx.currentBlock, loc)
.withOperands(Seq(src.value))
.withResult(util.convert(dest.tpe))
.build()
.results(0),
dest.tpe
)
}
} else if (srcWidth < destWidth) {
src = Reference.Value(
util
.OpBuilder("firrtl.pad", firCtx.currentBlock, loc)
.withNamedAttrs(Seq(("amount", circt.mlirIntegerAttrGet(circt.mlirIntegerTypeGet(32), destWidth.toLong))))
.withOperands(Seq(src.value))
.withResult(util.convert(dest.tpe))
.build()
.results(0),
dest.tpe
)
}
} else {
// TODO: const cast
}
util
.OpBuilder("firrtl.connect", firCtx.currentBlock, loc)
.withOperand( /* dest */ dest.value)
.withOperand( /* src */ src.value)
.build()
}
case class RecursiveTypeProperties(isPassive: Boolean, containsAnalog: Boolean)
def recursiveTypeProperties(tpe: fir.Type): RecursiveTypeProperties = {
tpe match {
case fir.ClockType | fir.ResetType | fir.AsyncResetType | _: fir.SIntType | _: fir.UIntType =>
RecursiveTypeProperties(true, false)
case _: fir.AnalogType => RecursiveTypeProperties(true, true)
case bundle: fir.BundleType =>
bundle.fields.foldLeft(RecursiveTypeProperties(true, false)) {
case (properties, field) =>
val fieldProperties = recursiveTypeProperties(field.tpe)
RecursiveTypeProperties(
properties.isPassive && fieldProperties.isPassive && field.flip == fir.Flip,
properties.containsAnalog || fieldProperties.containsAnalog
)
}
case _: fir.PropertyType => RecursiveTypeProperties(true, false)
case vector: fir.VectorType => recursiveTypeProperties(vector.tpe)
}
}
sealed trait Flow
object Flow {
final case object None extends Flow
final case object Source extends Flow
final case object Sink extends Flow
final case object Duplex extends Flow
}
def swapFlow(flow: Flow): Flow = flow match {
case Flow.None => Flow.None
case Flow.Source => Flow.Sink
case Flow.Sink => Flow.Source
case Flow.Duplex => Flow.Duplex
}
def foldFlow(value: Reference.Value, acc: Flow = Flow.Source): Flow = {
circt.firrtlValueFoldFlow(
value.value,
acc match {
case Flow.None => 0
case Flow.Source => 1
case Flow.Sink => 2
case Flow.Duplex => 3
}
) match {
case 0 => Flow.None
case 1 => Flow.Source
case 2 => Flow.Sink
case 3 => Flow.Duplex
}
}
def emitInvalidate(value: Reference.Value, loc: MlirLocation): Unit = emitInvalidate(value, loc, foldFlow(value))
def emitInvalidate(value: Reference.Value, loc: MlirLocation, flow: Flow): Unit = {
val props = recursiveTypeProperties(value.tpe)
if (props.isPassive && !props.containsAnalog) {
if (flow == Flow.Source) {
return
}
val invalidValue = Reference.Value(
util
.OpBuilder("firrtl.invalidvalue", firCtx.currentBlock, loc)
.withResult(util.convert(value.tpe))
.build()
.results(0),
value.tpe
)
emitConnect(value, invalidValue, loc)
return
}
val indexType = circt.mlirIntegerTypeGet(32)
value.tpe match {
case bundle: fir.BundleType =>
bundle.fields.zipWithIndex.foreach {
case (field, index) =>
val fieldAccess = Reference.Value(
util
.OpBuilder("firrtl.subfield", firCtx.currentBlock, loc)
.withNamedAttr("fieldIndex", circt.mlirIntegerAttrGet(indexType, index))
.withOperand(value.value)
.withResult(util.convert(field.tpe))
.build()
.results(0),
field.tpe
)
emitInvalidate(fieldAccess, loc, if (field.flip == fir.Flip) swapFlow(flow) else flow)
}
case vector: fir.VectorType =>
for (index <- 0 until vector.size) {
val elementAccess = Reference.Value(
util
.OpBuilder("firrtl.subindex", firCtx.currentBlock, loc)
.withNamedAttr("index", circt.mlirIntegerAttrGet(indexType, index))
.withOperand(value.value)
.withResult(util.convert(vector.tpe))
.build()
.results(0),
vector.tpe
)
emitInvalidate(elementAccess, loc, flow)
}
}
}
}
val mlirStream = new Writable {
def writeBytesTo(out: OutputStream): Unit = {
circt.mlirOperationPrint(circt.mlirModuleGetOperation(mlirRootModule), message => out.write(message.getBytes))
out.flush()
}
}
val firrtlStream = new Writable {
def writeBytesTo(out: OutputStream): Unit = {
circt.mlirExportFIRRTL(mlirRootModule, message => out.write(message.getBytes))
out.flush()
}
}
val verilogStream = new Writable {
def writeBytesTo(out: OutputStream): Unit = {
def assertResult(result: MlirLogicalResult): Unit = {
assert(circt.mlirLogicalResultIsSuccess(result))
}
val pm = circt.mlirPassManagerCreate()
val options = circt.circtFirtoolOptionsCreateDefault()
assertResult(circt.circtFirtoolPopulatePreprocessTransforms(pm, options))
assertResult(circt.circtFirtoolPopulateCHIRRTLToLowFIRRTL(pm, options, mlirRootModule, "-"))
assertResult(circt.circtFirtoolPopulateLowFIRRTLToHW(pm, options))
assertResult(circt.circtFirtoolPopulateHWToSV(pm, options))
assertResult(circt.circtFirtoolPopulateExportVerilog(pm, options, message => out.write(message.getBytes)))
assertResult(circt.mlirPassManagerRunOnOp(pm, circt.mlirModuleGetOperation(mlirRootModule)))
out.flush()
}
}
val mlirBytecodeStream = new Writable {
def writeBytesTo(out: OutputStream): Unit = {
circt.mlirOperationWriteBytecode(
circt.mlirModuleGetOperation(mlirRootModule),
bytecode => out.write(bytecode)
)
out.flush()
}
}
def exportSplitVerilog(directory: os.Path): Unit = {
def assertResult(result: MlirLogicalResult): Unit = {
assert(circt.mlirLogicalResultIsSuccess(result))
}
val pm = circt.mlirPassManagerCreate()
val options = circt.circtFirtoolOptionsCreateDefault()
assertResult(circt.circtFirtoolPopulatePreprocessTransforms(pm, options))
assertResult(circt.circtFirtoolPopulateCHIRRTLToLowFIRRTL(pm, options, mlirRootModule, "-"))
assertResult(circt.circtFirtoolPopulateLowFIRRTLToHW(pm, options))
assertResult(circt.circtFirtoolPopulateHWToSV(pm, options))
assertResult(circt.circtFirtoolPopulateExportSplitVerilog(pm, options, directory.toString))
assertResult(circt.mlirPassManagerRunOnOp(pm, circt.mlirModuleGetOperation(mlirRootModule)))
}
def passManager(): PanamaCIRCTPassManager = new PanamaCIRCTPassManager(circt, mlirRootModule, fos)
def om(): PanamaCIRCTOM = new PanamaCIRCTOM(circt, mlirRootModule)
def foreachHwModule(callback: String => Unit) = {
val instanceGraph = circt.hwInstanceGraphGet(circt.mlirModuleGetOperation(mlirRootModule))
val topLevelNode = circt.hwInstanceGraphGetTopLevelNode(instanceGraph)
circt.hwInstanceGraphForEachNode(
instanceGraph,
node => {
if (!circt.hwInstanceGraphNodeEqual(node, topLevelNode)) {
val moduleOp = circt.hwInstanceGraphNodeGetModuleOp(node)
val moduleName = circt.mlirStringAttrGetValue(circt.mlirOperationGetAttributeByName(moduleOp, "sym_name"))
callback(moduleName)
}
}
)
}
def visitCircuit(name: String): Unit = {
val firCircuit = util
.OpBuilder("firrtl.circuit", circt.mlirModuleGetBody(mlirRootModule), circt.unkLoc)
.withRegion(Seq((Seq.empty, Seq.empty)))
.withNamedAttr("name", circt.mlirStringAttrGet(name))
.withNamedAttr("rawAnnotations", circt.firrtlImportAnnotationsFromJSONRaw(annotationsJSON).get)
.withNamedAttr("annotations", circt.emptyArrayAttr)
.build()
firCtx.enterNewCircuit(firCircuit)
}
def visitDefBlackBox(defBlackBox: DefBlackBox): Unit = {
val ports = util.convert(defBlackBox.ports ++ defBlackBox.id.secretPorts, defBlackBox.topDir)
val nameAttr = circt.mlirStringAttrGet(defBlackBox.name)
val desiredNameAttr = circt.mlirStringAttrGet(defBlackBox.id.desiredName)
val builder = util
.OpBuilder("firrtl.extmodule", firCtx.circuitBlock, circt.unkLoc)
.withRegionNoBlock()
.withNamedAttr("sym_name", nameAttr)
.withNamedAttr("sym_visibility", circt.mlirStringAttrGet("private"))
.withNamedAttr("defname", desiredNameAttr)
.withNamedAttr("parameters", circt.mlirArrayAttrGet(defBlackBox.params.map(p => util.convert(p._1, p._2)).toSeq))
.withNamedAttr(
"convention",
circt.firrtlAttrGetConvention(FIRRTLConvention.Scalarized)
) // TODO: Make an option `scalarizeExtModules` for it
.withNamedAttr("annotations", circt.emptyArrayAttr)
val firModule = util.moduleBuilderInsertPorts(builder, ports).build()
firCtx.enterNewModule(defBlackBox.name, firModule)
}
def visitDefIntrinsicModule(defIntrinsicModule: DefIntrinsicModule): Unit = {
val ports = util.convert(defIntrinsicModule.ports ++ defIntrinsicModule.id.secretPorts, defIntrinsicModule.topDir)
val builder = util
.OpBuilder("firrtl.intmodule", firCtx.circuitBlock, circt.unkLoc)
.withRegionNoBlock()
.withNamedAttr("sym_name", circt.mlirStringAttrGet(defIntrinsicModule.name))
.withNamedAttr("sym_visibility", circt.mlirStringAttrGet("private"))
.withNamedAttr("intrinsic", circt.mlirStringAttrGet(defIntrinsicModule.id.intrinsic))
.withNamedAttr(
"parameters",
circt.mlirArrayAttrGet(defIntrinsicModule.params.map(p => util.convert(p._1, p._2)).toSeq)
)
.withNamedAttr("annotations", circt.emptyArrayAttr)
val firModule = util.moduleBuilderInsertPorts(builder, ports).build()
firCtx.enterNewModule(defIntrinsicModule.name, firModule)
}
def visitDefModule(defModule: DefModule): Unit = {
val ports = util.convert(defModule.ports ++ defModule.id.secretPorts)
val isMainModule = defModule.id.circuitName == defModule.name
val builder = util
.OpBuilder("firrtl.module", firCtx.circuitBlock, circt.unkLoc)
.withRegion(Seq((ports.types, ports.locs)))
.withNamedAttr("sym_name", circt.mlirStringAttrGet(defModule.name))
.withNamedAttr("sym_visibility", circt.mlirStringAttrGet(if (isMainModule) "public" else "private"))
.withNamedAttr(
"convention",
circt.firrtlAttrGetConvention(if (isMainModule) FIRRTLConvention.Scalarized else FIRRTLConvention.Internal)
) // TODO: Make an option `scalarizePublicModules` for it
.withNamedAttr("annotations", circt.emptyArrayAttr)
val firModule = util.moduleBuilderInsertPorts(builder, ports).build()
firCtx.enterNewModule(defModule.name, firModule)
}
def visitAltBegin(altBegin: AltBegin): Unit = {
firCtx.enterAlt()
}
def visitAttach(attach: Attach): Unit = {
util
.OpBuilder("firrtl.attach", firCtx.currentBlock, util.convert(attach.sourceInfo))
.withOperands(attach.locs.map(node => util.referTo(node.id, attach.sourceInfo).value))
.build()
}
def visitConnect(connect: Connect): Unit = {