path: root/src/main/scala/firrtl/Driver.scala

package firrtl

import java.io._
import scala.sys.process._
import java.nio.file.{Paths, Files}
import scala.io.Source
import Utils._
import DebugUtils._
import Passes._

object Driver
{
  private val usage = """
    Usage: java -cp utils/bin/firrtl.jar firrtl.Driver [options] -i <input> -o <output>
  """
  private val defaultOptions = Map[Symbol, Any]().withDefaultValue(false)

  // Appends 0 to the filename and appends .tmp to the extension
  private def genTempFilename(filename: String): String = {
    val pat = """(.*/)([^/]*)([.][^/.]*)""".r
    val (path, name, ext) = filename match {
      case pat(path, name, ext) => (path, name, ext + ".tmp")
      case _ => ("./", "temp", ".tmp")
    }
    var count = 0
    while( Files.exists(Paths.get(path + name + count + ext )) )
      count += 1
    path + name + count + ext
  }

  // Parse input file and print to output
  private def firrtl(input: String, output: String)(implicit logger: Logger)
  {
    val ast = Parser.parse(input, Source.fromFile(input).getLines)
    val writer = new PrintWriter(new File(output))
    writer.write(ast.serialize())
    writer.close()
    logger.printlnDebug(ast)
  }

  // Should we just remove logger?
  private def executePassesWithLogger(ast: Circuit, passes: Seq[Circuit => Circuit])(implicit logger: Logger): Circuit = {
    if (passes.isEmpty) ast
    else executePasses(passes.head(ast), passes.tail)
  }

  def executePasses(ast: Circuit, passes: Seq[Circuit => Circuit]): Circuit = {
    implicit val logger = Logger() // No logging
    executePassesWithLogger(ast, passes)
  }

  trait Pass
  case class StanzaPass(val name : String) extends Pass
  case class AggregatedStanzaPass(val passes : Seq[StanzaPass]) extends Pass
  case class ScalaPass(val func : Circuit => Circuit) extends Pass

  def aggregateStanzaPasses(l : Seq[Pass]) : Seq[Pass] = {
    if (l.isEmpty) return Seq()
    val span = l.span(x => x match {
      case p : StanzaPass => true
      case _ => false
    })
    if (span._1.isEmpty) {
      val tail = if(span._2.length > 1)
        aggregateStanzaPasses(span._2.tail)
      else
        Seq()
      Seq(span._2.head) ++ tail
    } else {
      Seq(AggregatedStanzaPass(span._1.asInstanceOf[Seq[StanzaPass]])) ++ aggregateStanzaPasses(span._2)
    }
  }

  def run(pass : Pass, input : String, output : String)(implicit logger : Logger) : Unit = pass match {
    case p : StanzaPass =>
      val cmd = Seq("firrtl-stanza", "-i", input, "-o", output, "-b", "firrtl", "-x", p.name)
      println(cmd.mkString(" "))
      val ret = cmd.!!
      println(ret)
    case p : AggregatedStanzaPass =>
      val cmd = Seq("firrtl-stanza", "-i", input, "-o", output, "-b", "firrtl") ++ p.passes.flatMap(x=>Seq("-x", x.name))
      println(cmd.mkString(" "))
      val ret = cmd.!!
      println(ret)
    case p : ScalaPass =>
      var ast = Parser.parse(input, Source.fromFile(input).getLines)
      val newast = p.func(ast)
      println("Writing to " + output)
      val writer = new PrintWriter(new File(output))
      writer.write(newast.serialize())
      writer.close()
    case _ => logger.warn("Pass " + pass + " cannot be run")
  }

  private def verilog(input: String, output: String)(implicit logger: Logger)
  {

    val passes = aggregateStanzaPasses(Seq(
      StanzaPass("rem-spec-chars"),
      StanzaPass("high-form-check"),
      ScalaPass(renameall(Map(
        "c"->"ccc",
        "z"->"zzz",
        "top"->"its_a_top_module"
      ))),
      StanzaPass("temp-elim"),
      StanzaPass("to-working-ir"),
      StanzaPass("resolve-kinds"),
      StanzaPass("infer-types"),
      StanzaPass("resolve-genders"),
      StanzaPass("check-genders"),
      StanzaPass("check-kinds"),
      StanzaPass("check-types"),
      StanzaPass("expand-accessors"),
      StanzaPass("lower-to-ground"),
      StanzaPass("inline-indexers"),
      StanzaPass("infer-types"),
      //ScalaPass(inferTypes),
      StanzaPass("check-genders"),
      StanzaPass("expand-whens"),
      StanzaPass("infer-widths"),
      StanzaPass("real-ir"),
      StanzaPass("width-check"),
      StanzaPass("pad-widths"),
      StanzaPass("const-prop"),
      StanzaPass("split-expressions"),
      StanzaPass("width-check"),
      StanzaPass("high-form-check"),
      StanzaPass("low-form-check"),
      StanzaPass("check-init")//,
      //ScalaPass(renamec)
    ))

    val outfile = passes.foldLeft( input ) ( (infile, pass) => {
      val outfile = genTempFilename(output)
      run(pass, infile, outfile)
      outfile
    })

    println(outfile)

    // finally, convert to verilog at the end
    val cmd = Seq("firrtl-stanza", "-i", outfile, "-o", output, "-X", "verilog")
    println(cmd.mkString(" "))
    val ret = cmd.!!
    println(ret)
  }

  def main(args: Array[String])
  {
    val arglist = args.toList
    type OptionMap = Map[Symbol, Any]

    // Default debug mode is 'debug
    def decodeDebugMode(mode: Any): Symbol =
      mode match {
        case s: String => Symbol(s)
        case _ => 'debug
      }

    def nextPrintVar(syms: List[Symbol], chars: List[Char]): List[Symbol] =
      chars match {
        case Nil => syms
        case 't' :: tail => nextPrintVar(syms ++ List('types), tail)
        case 'k' :: tail => nextPrintVar(syms ++ List('kinds), tail)
        case 'w' :: tail => nextPrintVar(syms ++ List('widths), tail)
        case 'T' :: tail => nextPrintVar(syms ++ List('twidths), tail)
        case 'g' :: tail => nextPrintVar(syms ++ List('genders), tail)
        case 'c' :: tail => nextPrintVar(syms ++ List('circuit), tail)
        case 'd' :: tail => nextPrintVar(syms ++ List('debug), tail) // Currently ignored
        case 'i' :: tail => nextPrintVar(syms ++ List('info), tail)
        case char :: tail => throw new Exception("Unknown print option " + char)
      }

    def nextOption(map: OptionMap, list: List[String]): OptionMap = {
      list match {
        case Nil => map
        case "-X" :: value :: tail =>
                  nextOption(map ++ Map('compiler -> value), tail)
        case "-d" :: value :: tail =>
                  nextOption(map ++ Map('debugMode -> value), tail)
        case "-l" :: value :: tail =>
                  nextOption(map ++ Map('log -> value), tail)
        case "-p" :: value :: tail =>
                  nextOption(map ++ Map('printVars -> value), tail)
        case "-i" :: value :: tail =>
                  nextOption(map ++ Map('input -> value), tail)
        case "-o" :: value :: tail =>
                  nextOption(map ++ Map('output -> value), tail)
        case ("-h" | "--help") :: tail =>
                  nextOption(map ++ Map('help -> true), tail)
        case option :: tail =>
                  throw new Exception("Unknown option " + option)
      }
    }
    val options = nextOption(defaultOptions, arglist)

    if (options('help) == true) {
      println(usage)
      System.exit(0)
    }

    val input = options('input) match {
      case s: String => s
      case false => throw new Exception("No input file provided!" + usage)
    }
    val output = options('output) match {
      case s: String => s
      case false => throw new Exception("No output file provided!" + usage)
    }
    val debugMode = decodeDebugMode(options('debugMode))
    val printVars = options('printVars) match {
      case s: String => nextPrintVar(List(), s.toList)
      case false => List()
    }
    implicit val logger = options('log) match {
      case s: String => Logger(new PrintWriter(new FileOutputStream(s)), debugMode, printVars)
      case false => Logger(new PrintWriter(System.err, true), debugMode, printVars)
    }

    // -p "printVars" options only print for debugMode > 'debug, warn if -p enabled and debugMode < 'debug
    if( !logger.debugEnable && !printVars.isEmpty )
      logger.warn("-p options will not print unless debugMode (-d) is debug or trace")

    options('compiler) match {
      case "verilog" => verilog(input, output)
      case "firrtl" => firrtl(input, output)
      case other => throw new Exception("Invalid compiler! " + other)
    }
  }

  def time[R](str: String)(block: => R)(implicit logger: Logger): R = {
    val t0 = System.currentTimeMillis()
    val result = block    // call-by-name
    val t1 = System.currentTimeMillis()
    logger.info(s"Time to ${str}: ${t1 - t0} ms")
    result
  }
}