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

import Utils._
import DebugUtils._
import Primops._

object Passes {

  // TODO Perhaps we should get rid of Logger since this map would be nice
  ////private val defaultLogger = Logger()
  //private def mapNameToPass = Map[String, Circuit => Circuit] (
  //  "infer-types" -> inferTypes
  //)
  def nameToPass(name: String): Circuit => Circuit = {
    implicit val logger = Logger() // throw logging away
    //mapNameToPass.getOrElse(name, throw new Exception("No Standard FIRRTL Pass of name " + name))
    name match {
      case "infer-types" => inferTypes
        // errrrrrrrrrr...
      case "renameall" => renameall(Map())
    }
  }

  private def toField(p: Port)(implicit logger: Logger): Field = {
    logger.trace(s"toField called on port ${p.serialize}")
    p.dir match {
      case Input  => Field(p.name, Reverse, p.tpe)
      case Output => Field(p.name, Default, p.tpe)
    }
  }

  /** INFER TYPES
   *
   *  This pass infers the type field in all IR nodes by updating
   *    and passing an environment to all statements in pre-order
   *    traversal, and resolving types in expressions in post-
   *    order traversal.
   *  Type propagation for primary ops are defined here.
   *  Notable cases: LetRec requires updating environment before
   *    resolving the subexpressions in its elements.
   *  Type errors are not checked in this pass, as this is
   *    postponed for a later/earlier pass.
   */
  // input -> flip
  private type TypeMap = Map[String, Type]
  private val TypeMap = Map[String, Type]().withDefaultValue(UnknownType)
  private def getBundleSubtype(t: Type, name: String): Type = {
    t match {
      case b: BundleType => {
        val tpe = b.fields.find( _.name == name )
        if (tpe.isEmpty) UnknownType
        else tpe.get.tpe
      }
      case _ => UnknownType
    }
  }
  private def getVectorSubtype(t: Type): Type = t.getType // Added for clarity
  // TODO Add genders
  private def inferExpTypes(typeMap: TypeMap)(exp: Exp)(implicit logger: Logger): Exp = {
    logger.trace(s"inferTypes called on ${exp.getClass.getSimpleName}")
    exp.map(inferExpTypes(typeMap)) match {
      case e: UIntValue => e
      case e: SIntValue => e
      case e: Ref => Ref(e.name, typeMap(e.name))
      case e: Subfield => Subfield(e.exp, e.name, getBundleSubtype(e.exp.getType, e.name))
      case e: Index => Index(e.exp, e.value, getVectorSubtype(e.exp.getType))
      case e: DoPrimop => lowerAndTypePrimop(e)
      case e: Exp => e
    }
  }
  private def inferTypes(typeMap: TypeMap, stmt: Stmt)(implicit logger: Logger): (Stmt, TypeMap) = {
    logger.trace(s"inferTypes called on ${stmt.getClass.getSimpleName} ")
    stmt.map(inferExpTypes(typeMap)) match {
      case b: Block => {
        var tMap = typeMap
        // TODO FIXME is map correctly called in sequential order
        val body = b.stmts.map { s =>
          val ret = inferTypes(tMap, s)
          tMap = ret._2
          ret._1
        }
        (Block(body), tMap)
      }
      case s: DefWire => (s, typeMap ++ Map(s.name -> s.tpe))
      case s: DefReg => (s, typeMap ++ Map(s.name -> s.tpe))
      case s: DefMemory => (s, typeMap ++ Map(s.name -> s.tpe))
      case s: DefInst => (s, typeMap ++ Map(s.name -> s.module.getType))
      case s: DefNode => (s, typeMap ++ Map(s.name -> s.value.getType))
      case s: DefPoison => (s, typeMap ++ Map(s.name -> s.tpe))
      case s: DefAccessor => (s, typeMap ++ Map(s.name -> getVectorSubtype(s.source.getType)))
      case s: When => { // TODO Check: Assuming else block won't see when scope
        val (conseq, cMap) = inferTypes(typeMap, s.conseq)
        val (alt, aMap) = inferTypes(typeMap, s.alt)
        (When(s.info, s.pred, conseq, alt), cMap ++ aMap)
      }
      case s: Stmt => (s, typeMap)
    }
  }
  private def inferTypes(typeMap: TypeMap, m: Module)(implicit logger: Logger): Module = {
    logger.trace(s"inferTypes called on module ${m.name}")

    val pTypeMap = m.ports.map( p => p.name -> p.tpe ).toMap

    Module(m.info, m.name, m.ports, inferTypes(typeMap ++ pTypeMap, m.stmt)._1)
  }
  def inferTypes(c: Circuit)(implicit logger: Logger): Circuit = {
    logger.trace(s"inferTypes called on circuit ${c.name}")

    // initialize typeMap with each module of circuit mapped to their bundled IO (ports converted to fields)
    val typeMap = c.modules.map(m => m.name -> BundleType(m.ports.map(toField(_)))).toMap

    //val typeMap = c.modules.flatMap(buildTypeMap).toMap
    Circuit(c.info, c.name, c.modules.map(inferTypes(typeMap, _)))
  }

  def renameall(s : String)(implicit map : Map[String,String]) : String =
    map getOrElse (s, s)

  def renameall(e : Exp)(implicit logger : Logger, map : Map[String,String]) : Exp = {
    logger.trace(s"renameall called on expression ${e.toString}")
    e match {
      case p : Ref =>
        Ref(renameall(p.name), p.tpe)
      case p : Subfield =>
        Subfield(renameall(p.exp), renameall(p.name), p.tpe)
      case p : Index =>
        Index(renameall(p.exp), p.value, p.tpe)
      case p : DoPrimop =>
        println( p.args.map(x => renameall(x)) )
        DoPrimop(p.op, p.args.map(x => renameall(x)), p.consts, p.tpe)
      case p : Exp => p
    }
  }

  def renameall(s : Stmt)(implicit logger : Logger, map : Map[String,String]) : Stmt = {
    logger.trace(s"renameall called on statement ${s.toString}")

    s match {
      case p : DefWire =>
        DefWire(p.info, renameall(p.name), p.tpe)
      case p: DefReg =>
        DefReg(p.info, renameall(p.name), p.tpe, p.clock, p.reset)
      case p : DefMemory =>
        DefMemory(p.info, renameall(p.name), p.seq, p.tpe, p.clock)
      case p : DefInst =>
        DefInst(p.info, renameall(p.name), renameall(p.module))
      case p : DefNode =>
        DefNode(p.info, renameall(p.name), renameall(p.value))
      case p : DefPoison =>
        DefPoison(p.info, renameall(p.name), p.tpe)
      case p : DefAccessor =>
        DefAccessor(p.info, renameall(p.name), p.dir, renameall(p.source), renameall(p.index))
      case p : OnReset =>
        OnReset(p.info, renameall(p.lhs), renameall(p.rhs))
      case p : Connect =>
        Connect(p.info, renameall(p.lhs), renameall(p.rhs))
      case p : BulkConnect =>
        BulkConnect(p.info, renameall(p.lhs), renameall(p.rhs))
      case p : When =>
        When(p.info, renameall(p.pred), renameall(p.conseq), renameall(p.alt))
      case p : Assert =>
        Assert(p.info, renameall(p.pred))
      case p : Block =>
        Block(p.stmts.map(renameall))
      case p : Stmt => p
    }
  }

  def renameall(p : Port)(implicit logger : Logger, map : Map[String,String]) : Port = {
    logger.trace(s"renameall called on port ${p.name}")
    Port(p.info, renameall(p.name), p.dir, p.tpe)
  }

  def renameall(m : Module)(implicit logger : Logger, map : Map[String,String]) : Module = {
    logger.trace(s"renameall called on module ${m.name}")
    Module(m.info, renameall(m.name), m.ports.map(renameall(_)), renameall(m.stmt))
  }

  def renameall(map : Map[String,String])(implicit logger : Logger) : Circuit => Circuit = {
    c => {
      implicit val imap = map
      logger.trace(s"renameall called on circuit ${c.name} with %{renameto}")
      Circuit(c.info, renameall(c.name), c.modules.map(renameall(_)))
    }
  }
}