aboutsummaryrefslogtreecommitdiff
path: root/src/main/scala/firrtl/passes/AnnotateMemMacros.scala
blob: a59ca4af9566d9e766f9b6adf404b8b968cb4a78 (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
package firrtl.passes

import scala.collection.mutable.{ArrayBuffer,HashMap}
import AnalysisUtils._
import firrtl.WrappedExpression._
import firrtl.ir._
import firrtl._
import firrtl.Utils._

case class AppendableInfo(fields: Map[String,Any]) extends Info {
  def append(a: Map[String,Any]) = this.copy(fields = fields ++ a)
  def append(a: (String,Any)): AppendableInfo = append(Map(a))
  def get(f: String) = fields.get(f)
  override def equals(b: Any) = b match {
    case i: AppendableInfo => fields - "info" == i.fields - "info"
    case _ => false
  }
}

object AnalysisUtils {

  def getConnects(m: Module) = {
    val connects = HashMap[String, Expression]()
    def getConnects(s: Statement): Unit = s match {
      case s: Connect =>
        connects(s.loc.serialize) = s.expr
      case s: PartialConnect =>
        connects(s.loc.serialize) = s.expr
      case s: DefNode =>
        connects(s.name) = s.value
      case s: Block =>
        s.stmts foreach getConnects
      case _ =>
    }
    getConnects(m.body)
    connects.toMap
  }  

  // only works in a module
  def getConnectOrigin(connects: Map[String, Expression], node: String): Expression = {
    if (connects contains node) getConnectOrigin(connects,connects(node))
    else EmptyExpression
  }

  def checkLit(e: Expression) = e match {
    case l : Literal => true
    case _ => false
  }

  def getOrigin(connects: Map[String, Expression], e: Expression) = e match {
    case DoPrim(_,_,_,_) => getConnectOrigin(connects,e)
    case l if (checkLit(l)) => e
    case _ => getConnectOrigin(connects,e.serialize)  
  }

  // backward searches until PrimOp, Lit or non-trivial Mux appears
  // technically, you should keep searching through PrimOp, because a node + 0 is still itself, 
  // a node shifted by 0 is still itself, etc. 
  // TODO: handle validif???, more thorough
  private def getConnectOrigin(connects: Map[String, Expression], e: Expression): Expression = e match { 
    case Mux(cond, tv, fv, _) =>
      val fvOrigin = getOrigin(connects,fv)
      val tvOrigin = getOrigin(connects,tv)
      val condOrigin = getOrigin(connects,cond)
      if (we(tvOrigin) == we(one) && we(fvOrigin) == we(zero)) condOrigin
      else if (we(condOrigin) == we(one)) tvOrigin
      else if (we(condOrigin) == we(zero)) fvOrigin
      else if (we(tvOrigin) == we(fvOrigin)) tvOrigin
      else if (we(fvOrigin) == we(zero) && we(condOrigin) == we(tvOrigin)) condOrigin
      else e
    case DoPrim(op, args, consts, tpe) if op == PrimOps.Or && args.contains(one) => one
    case DoPrim(op, args, consts, tpe) if op == PrimOps.And && args.contains(zero) => zero
    case DoPrim(op, args, consts, tpe) if op == PrimOps.Bits =>  
      val msb = consts(0)
      val lsb = consts(1) 
      val extractionWidth = (msb-lsb)+1
      val nodeWidth = bitWidth(args.head.tpe)
      // if you're extracting the full bitwidth, then keep searching for origin
      if (nodeWidth == extractionWidth) getOrigin(connects,args.head)
      else e
    case DoPrim(op, args, _, _) if (op == PrimOps.AsUInt || op == PrimOps.AsSInt || op == PrimOps.AsClock) =>
      getOrigin(connects,args.head)
    case _: WRef | _: SubField | _: SubIndex | _: SubAccess if connects contains e.serialize =>
      getConnectOrigin(connects,e.serialize) 
    case _ => e
  }

  def appendInfo[T <: Info](info: T, add: Map[String,Any]) = info match {
    case i: AppendableInfo => i.append(add)
    case _ => AppendableInfo(fields = add + ("info" -> info))
  }
  def appendInfo[T <: Info](info: T, add: (String,Any)): AppendableInfo = appendInfo(info,Map(add))
  def getInfo[T <: Info](info: T, k: String) = info match{
    case i: AppendableInfo => i.get(k)
    case _ => None
  }
  def containsInfo[T <: Info](info: T, k: String) = info match {
    case i: AppendableInfo => i.fields.contains(k)
    case _ => false
  }

  def eqMems(a: DefMemory, b: DefMemory) = {
    a.info == b.info &&
    a.dataType == b.dataType &&
    a.depth == b.depth &&
    a.writeLatency == b.writeLatency &&
    a.readLatency == b.readLatency &&
    a.readers == b.readers &&
    a.writers == b.writers &&
    a.readwriters == b.readwriters &&
    a.readUnderWrite == b.readUnderWrite
  }  

}

object AnnotateMemMacros extends Pass {

  def name = "Analyze sequential memories and tag with info for future passes (useMacro,maskGran)"

  def run(c: Circuit) = {

    def annotateModMems(m: Module) = {
      val connects = getConnects(m)

      // returns # of mask bits if used
      def getMaskBits(wen: String, wmask: String): Option[Int] = {
        val wenOrigin = we(getConnectOrigin(connects,wen))
        val one1 = we(one)
        val wmaskOrigin = connects.keys.toSeq.filter(_.startsWith(wmask)).map(x => we(getConnectOrigin(connects,x)))
        // all wmask bits are equal to wmode/wen or all wmask bits = 1(for redundancy checking)
        val redundantMask = wmaskOrigin.map( x => (x == wenOrigin) || (x == one1) ).foldLeft(true)(_ && _)
        if (redundantMask) None else Some(wmaskOrigin.length)
      }

      def updateStmts(s: Statement): Statement = s match {
        // only annotate memories that are candidates for memory macro replacements
        // i.e. rw, w + r (read,write 1 cycle delay)
        case m: DefMemory if m.readLatency == 1 && m.writeLatency == 1 && 
            (m.writers.length + m.readwriters.length) == 1 && m.readers.length <= 1 =>
          val dataBits = bitWidth(m.dataType)
          val rwMasks = m.readwriters map (w => getMaskBits(s"${m.name}.$w.wmode",s"${m.name}.$w.wmask"))
          val wMasks = m.writers map (w => getMaskBits(s"${m.name}.$w.en",s"${m.name}.$w.mask"))
          val maskBits = (rwMasks ++ wMasks).head
          val memAnnotations = Map("useMacro" -> true)
          val tempInfo = appendInfo(m.info,memAnnotations)
          if (maskBits == None) m.copy(info = tempInfo)
          else m.copy(info = tempInfo.append("maskGran" -> dataBits/maskBits.get))       
        case b: Block => Block(b.stmts map updateStmts)
        case s => s
      }
      m.copy(body=updateStmts(m.body))
    } 

    val updatedMods = c.modules map {
      case m: Module => annotateModMems(m)
      case m: ExtModule => m
    }
    c.copy(modules = updatedMods)

  }  

}

// TODO: Add floorplan info?