Move Chisel API into separate chiselFrontend compilation unit in preparation for source locator macros

1 files changed, 97 insertions, 0 deletions

diff --git a/chiselFrontend/src/main/scala/Chisel/CoreUtil.scala b/chiselFrontend/src/main/scala/Chisel/CoreUtil.scala
new file mode 100644
index 00000000..708b516e
--- /dev/null
+++ b/chiselFrontend/src/main/scala/Chisel/CoreUtil.scala
@@ -0,0 +1,97 @@
+// See LICENSE for license details.
+
+package Chisel
+
+import internal._
+import internal.Builder.pushCommand
+import internal.firrtl._
+
+import scala.language.experimental.macros
+import scala.reflect.macros.blackbox.Context
+
+object assert { // scalastyle:ignore object.name
+  /** Checks for a condition to be valid in the circuit at all times. If the
+    * condition evaluates to false, the circuit simulation stops with an error.
+    *
+    * Does not fire when in reset (defined as the encapsulating Module's
+    * reset). If your definition of reset is not the encapsulating Module's
+    * reset, you will need to gate this externally.
+    *
+    * May be called outside of a Module (like defined in a function), so
+    * functions using assert make the standard Module assumptions (single clock
+    * and single reset).
+    *
+    * @param cond condition, assertion fires (simulation fails) when false
+    * @param message optional message to print when the assertion fires
+    *
+    * @note currently cannot be used in core Chisel / libraries because macro
+    * defs need to be compiled first and the SBT project is not set up to do
+    * that
+    */
+  def apply(cond: Bool, message: String): Unit = macro apply_impl_msg
+  def apply(cond: Bool): Unit = macro apply_impl  // macros currently can't take default arguments
+
+  def apply_impl_msg(c: Context)(cond: c.Tree, message: c.Tree): c.Tree = {
+    import c.universe._
+    val p = c.enclosingPosition
+    val condStr = s"${p.source.file.name}:${p.line} ${p.lineContent.trim}"
+    val apply_impl_do = symbolOf[this.type].asClass.module.info.member(TermName("apply_impl_do"))
+    q"$apply_impl_do($cond, $condStr, _root_.scala.Some($message))"
+  }
+
+  def apply_impl(c: Context)(cond: c.Tree): c.Tree = {
+    import c.universe._
+    val p = c.enclosingPosition
+    val condStr = s"${p.source.file.name}:${p.line} ${p.lineContent.trim}"
+    val apply_impl_do = symbolOf[this.type].asClass.module.info.member(TermName("apply_impl_do"))
+    q"$apply_impl_do($cond, $condStr, _root_.scala.None)"
+  }
+
+  def apply_impl_do(cond: Bool, line: String, message: Option[String]) {
+    when (!(cond || Builder.dynamicContext.currentModule.get.reset)) {
+      message match {
+        case Some(str) => printf.printfWithoutReset(s"Assertion failed: $str\n    at $line\n")
+        case None => printf.printfWithoutReset(s"Assertion failed\n    at $line\n")
+      }
+      pushCommand(Stop(Node(Builder.dynamicContext.currentModule.get.clock), 1))
+    }
+  }
+
+  /** An elaboration-time assertion, otherwise the same as the above run-time
+    * assertion. */
+  def apply(cond: Boolean, message: => String) {
+    Predef.assert(cond, message)
+  }
+
+  /** A workaround for default-value overloading problems in Scala, just
+    * 'assert(cond, "")' */
+  def apply(cond: Boolean) {
+    Predef.assert(cond, "")
+  }
+}
+
+object printf { // scalastyle:ignore object.name
+  /** Prints a message in simulation.
+    *
+    * Does not fire when in reset (defined as the encapsulating Module's
+    * reset). If your definition of reset is not the encapsulating Module's
+    * reset, you will need to gate this externally.
+    *
+    * May be called outside of a Module (like defined in a function), so
+    * functions using printf make the standard Module assumptions (single clock
+    * and single reset).
+    *
+    * @param fmt printf format string
+    * @param data format string varargs containing data to print
+    */
+  def apply(fmt: String, data: Bits*) {
+    when (!Builder.dynamicContext.currentModule.get.reset) {
+      printfWithoutReset(fmt, data:_*)
+    }
+  }
+
+  private[Chisel] def printfWithoutReset(fmt: String, data: Bits*) {
+    val clock = Builder.dynamicContext.currentModule.get.clock
+    pushCommand(Printf(Node(clock), fmt, data.map((d: Bits) => d.ref)))
+  }
+}