// See LICENSE for license details.

package tapeout.macros

/** Trait which can calculate the cost of compiling a memory against a certain
  * library memory macro using a cost function.
  */
// TODO: eventually explore compiling a single target memory using multiple
// different kinds of target memory.
trait CostMetric extends Serializable {

  /** Cost function that returns the cost of compiling a memory using a certain
    * macro.
    *
    * @param mem Memory macro to compile (target memory)
    * @param lib Library memory macro to use (library memory)
    * @return The cost of this compile, defined by this cost metric, or None if
    *         it cannot be compiled.
    */
  def cost(mem: Macro, lib: Macro): Option[Double]

  /** Helper function to return the map of arguments (or an empty map if there are none).
    */
  def commandLineParams(): Map[String, String]

  // We also want this to show up for the class itself.
  def name(): String
}

// Is there a better way to do this? (static method associated to CostMetric)
trait CostMetricCompanion {
  def name(): String

  /** Construct this cost metric from a command line mapping. */
  def construct(m: Map[String, String]): CostMetric
}

// Some default cost functions.

/** Palmer's old metric.
  * TODO: figure out what is the difference between this metric and the current
  * default metric and either revive or delete this metric.
  */
object OldMetric extends CostMetric with CostMetricCompanion {
  override def cost(mem: Macro, lib: Macro): Option[Double] = {
    /* Palmer: A quick cost function (that must be kept in sync with
     * memory_cost()) that attempts to avoid compiling unnecessary
     * memories.  This is a lower bound on the cost of compiling a
     * memory: it assumes 100% bit-cell utilization when mapping. */
    // val cost = 100 * (mem.depth * mem.width) / (lib.depth * lib.width) +
    //                  (mem.depth * mem.width)
    ???
  }

  override def commandLineParams() = Map.empty[String, String]
  override def name() = "OldMetric"
  override def construct(m: Map[String, String]): CostMetric = OldMetric
}

/** An external cost function.
  * Calls the specified path with paths to the JSON MDF representation of the mem
  * and lib macros. The external executable should print a Double.
  * None will be returned if the external executable does not print a valid
  * Double.
  */
class ExternalMetric(path: String) extends CostMetric {
  import mdf.macrolib.Utils.writeMacroToPath

  import java.io._
  import scala.language.postfixOps
  import sys.process._

  override def cost(mem: Macro, lib: Macro): Option[Double] = {
    // Create temporary files.
    val memFile = File.createTempFile("_macrocompiler_mem_", ".json")
    val libFile = File.createTempFile("_macrocompiler_lib_", ".json")

    writeMacroToPath(Some(memFile.getAbsolutePath), mem.src)
    writeMacroToPath(Some(libFile.getAbsolutePath), lib.src)

    // !! executes the given command
    val result: String = (s"$path ${memFile.getAbsolutePath} ${libFile.getAbsolutePath}" !!).trim

    // Remove temporary files.
    memFile.delete()
    libFile.delete()

    try {
      Some(result.toDouble)
    } catch {
      case _: NumberFormatException => None
    }
  }

  override def commandLineParams() = Map("path" -> path)
  override def name(): String = ExternalMetric.name()
}

object ExternalMetric extends CostMetricCompanion {
  override def name() = "ExternalMetric"

  /** Construct this cost metric from a command line mapping. */
  override def construct(m: Map[String, String]): ExternalMetric = {
    val pathOption = m.get("path")
    pathOption match {
      case Some(path: String) => new ExternalMetric(path)
      case _ => throw new IllegalArgumentException("ExternalMetric missing option 'path'")
    }
  }
}

/** The current default metric in barstools, re-defined by Donggyu. */
// TODO: write tests for this function to make sure it selects the right things
object DefaultMetric extends CostMetric with CostMetricCompanion {
  override def cost(mem: Macro, lib: Macro): Option[Double] = {
    val memMask = mem.src.ports.map(_.maskGran).find(_.isDefined).flatten
    val libMask = lib.src.ports.map(_.maskGran).find(_.isDefined).flatten
    val memWidth = (memMask, libMask) match {
      case (None, _) => mem.src.width
      case (Some(p), None) =>
        (mem.src.width / p) * math.ceil(
          p.toDouble / lib.src.width
        ) * lib.src.width //We map the mask to distinct memories
      case (Some(p), Some(m)) =>
        if (m <= p) (mem.src.width / p) * math.ceil(p.toDouble / m) * m //Using multiple m's to create a p (integrally)
        else (mem.src.width / p) * m //Waste the extra maskbits
    }
    val maskPenalty = (memMask, libMask) match {
      case (None, Some(_)) => 0.001
      case (_, _)          => 0
    }
    val depthCost = math.ceil(mem.src.depth.toDouble / lib.src.depth.toDouble)
    val widthCost = math.ceil(memWidth / lib.src.width.toDouble)
    val bitsCost = (lib.src.depth * lib.src.width).toDouble
    // Fraction of wasted bits plus const per mem
    val requestedBits = (mem.src.depth * mem.src.width).toDouble
    val bitsWasted = depthCost * widthCost * bitsCost - requestedBits
    val wastedConst = 0.05 // 0 means waste as few bits with no regard for instance count
    val costPerInst = wastedConst * depthCost * widthCost
    Some(1.0 * bitsWasted / requestedBits + costPerInst + maskPenalty)
  }

  override def commandLineParams() = Map.empty[String, String]
  override def name() = "DefaultMetric"
  override def construct(m: Map[String, String]): CostMetric = DefaultMetric
}

object MacroCompilerUtil {
  import java.io._
  import java.util.Base64

  // Adapted from https://stackoverflow.com/a/134918

  /** Serialize an arbitrary object to String.
    *  Used to pass structured values through as an annotation.
    */
  def objToString(o: Serializable): String = {
    val byteOutput:   ByteArrayOutputStream = new ByteArrayOutputStream
    val objectOutput: ObjectOutputStream = new ObjectOutputStream(byteOutput)
    objectOutput.writeObject(o)
    objectOutput.close()
    Base64.getEncoder.encodeToString(byteOutput.toByteArray)
  }

  /** Deserialize an arbitrary object from String. */
  def objFromString(s: String): AnyRef = {
    val data = Base64.getDecoder.decode(s)
    val ois: ObjectInputStream = new ObjectInputStream(new ByteArrayInputStream(data))
    val o = ois.readObject
    ois.close()
    o
  }
}

object CostMetric {

  /** Define some default metric. */
  val default: CostMetric = DefaultMetric

  val costMetricCreators: scala.collection.mutable.Map[String, CostMetricCompanion] = scala.collection.mutable.Map()

  // Register some default metrics
  registerCostMetric(OldMetric)
  registerCostMetric(ExternalMetric)
  registerCostMetric(DefaultMetric)

  /** Register a cost metric.
    * @param createFuncHelper Companion object to fetch the name and construct
    *                         the metric.
    */
  def registerCostMetric(createFuncHelper: CostMetricCompanion): Unit = {
    costMetricCreators.update(createFuncHelper.name(), createFuncHelper)
  }

  /** Select a cost metric from string. */
  def getCostMetric(m: String, params: Map[String, String]): CostMetric = {
    if (m == "default") {
      CostMetric.default
    } else if (!costMetricCreators.contains(m)) {
      throw new IllegalArgumentException("Invalid cost metric " + m)
    } else {
      costMetricCreators(m).construct(params)
    }
  }
}
