Jesse interface thesis proj

.gitattributes

@@ -10,4 +10,6 @@ Makefile text eol=lf
 *.mk text eol=lf
 *.md5sum text eol=lf linguist-generated
 
-src/test/make/bap-normalise.py text eol=lf
+src/test/make/bap-normalise.py text eol=lf
+
+src/frontend/* linguist-generated

.github/workflows/docs.yml

@@ -48,8 +48,9 @@ jobs:
         with:
           path: ${{ steps.allDocs.outputs.dir }}
 
+      # TODO: This excludes the ExitCode warning from decline. Remove after https://github.com/typelevel/cats-effect/issues/4532
       - run: |
-          ! grep --after-context=3 'Error\|Warning' out/scalaDocGenerated.log
+          ! grep -v effect/shared/src/main/scala/com/monovore/decline/effect/CommandIOApp out/scalaDocGenerated.log | grep --after-context=3 'Error\|Warning'
         name: check for scaladoc warnings
 
       - id: docArgs

.gitignore

@@ -26,7 +26,13 @@ examplesold/
 src/test/scala/dump/
 src/test/analysis/dump/
 *.gtirb
+# Ignore all JSON bug a select few for frontend
 *.json
+!/frontend/package.json
+!/frontend/package-lock.json
+!/frontend/tsconfig.app.json
+!/frontend/tsconfig.json
+!/frontend/tsconfig.node.json
 src/test/*.svg
 src/test/*.md.part
 src/test/summary-*.md

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "src/frontend"]
+	path = src/frontend
+	url = https://github.com/UQ-PAC/basil-gui-frontend.git
+	branch = static

build.mill

@@ -49,8 +49,19 @@ object `package` extends ScalaModule with BasilDocs with BasilVersion with Scala
   val aslpOffline = mvn"io.github.uq-pac::lifter:0.1.0"
   val javaSmt = mvn"org.sosy-lab:java-smt:5.0.0"
   val javaSmtZ3 = mvn"org.sosy-lab:javasmt-solver-z3:4.14.0"
-
-  override def mvnDeps = Seq(scalactic, sourceCode, mainArgs, upickle, aslpOffline, javaSmt, javaSmtZ3)
+  val catsEffect = mvn"org.typelevel::cats-effect:3.5.4"
+  val http4sVersion = "1.0.0-M40"
+  val http4Dsl = mvn"org.http4s::http4s-dsl::$http4sVersion"
+  val http4Circe = mvn"org.http4s::http4s-circe::$http4sVersion"
+  val circleGeneric = mvn"io.circe::circe-generic:0.14.6"
+  val slf4j = mvn"org.slf4j:slf4j-simple:2.0.12"
+  val scalaXml = mvn"org.scala-lang.modules::scala-xml:2.1.0"
+  val emberServer = mvn"org.http4s::http4s-ember-server::$http4sVersion"
+  val log4cats = mvn"org.typelevel::log4cats-slf4j:2.6.0"
+  val declineEffect = mvn"com.monovore::decline-effect:2.2.0"
+
+  override def mvnDeps = Seq(scalactic, sourceCode, mainArgs, upickle, aslpOffline, javaSmt, javaSmtZ3, catsEffect, http4Dsl,
+    http4Circe, circleGeneric, slf4j, scalaXml, emberServer, log4cats, declineEffect)
 
   override def repositoriesTask = Task.Anon {
     super.repositoriesTask() :+ MavenRepository(
@@ -63,7 +74,7 @@ object `package` extends ScalaModule with BasilDocs with BasilVersion with Scala
     )
   }
 
-  override def mainClass = Some("Main")
+  override def mainClass = Some("basil.main.Main")
 
   override def moduleDir = BuildCtx.workspaceRoot / "src"
 

docs/src/SUMMARY.md

@@ -28,8 +28,10 @@
 - [Common Development Tasks](development/readme.md) Explanation of common development tasks
 - [Version numbering](development/versioning.md) Use of the version number system, including how to cut a release.
 - [Profiling](development/profiling.md)
+- [Decompiler User Interface](development/api-information.md) Guide to using the interface 
+to visualise transform passes
 
-# Devleopment Guidelines
+# Development Guidelines
 
 - [Testing](development/testing.md)
   - [Integration (system) tests](development/integration-tests.md)

docs/src/development/api-information.md

@@ -0,0 +1,36 @@
+# Transform Viewer GUI
+
+The frontend project is stored in a separate repository: [UQ-PAC/basil-gui-frontend](https://github.com/UQ-PAC/basil-gui-frontend).
+It is included here as a git submodule, to use the gui ensure this submodule is checked out:
+
+```
+git submodule init
+git submodule update
+```
+
+Then run basil with the server entrypoint:
+
+```shell
+./mill runMain server.ApiServer <reguar basil args>
+```
+
+And open `http://localhost:8080` in a browser.
+
+## Adding Additional Snapshots
+
+Most epoch logic is placed in src/main/scala/util/RunUtils.scala or a related helper.
+
+The collectedSnapshots arrabuffer is passed through runutils, the following can be used to wrap
+a transform function so that it logs the diff (this is automatically disabled when the server is
+not runnign but the transform is still applied).
+
+```scala
+logTransform[T](collectedSnapshots)("unique-transform-name", transformFunc: IRContext => T)(ctx)
+```
+
+
+### Naming Conventions
+
+The epoch name (e.g., "name_of_the_new_transform") must be a unique and URI-compatible (not contain "/"), 
+string that accurately describes the transformation that just took place.
+This name is what the front-end uses to identify and fetch the corresponding program state pair.

src/main/scala/Main.scala

@@ -1,4 +1,4 @@
-// package scala
+package basil.main
 
 import gtirb.GTIRBReadELF
 import ir.{FrontendMode, IRLoading}
@@ -267,15 +267,15 @@ object Main {
     noDebug: Flag
   )
 
-  def main(args: Array[String]): Unit = {
+  def configOfArgs(args: Array[String]): (Config, BASILConfig) = {
     val parser = ParserForClass[Config]
     val parsed = parser.constructEither(args.toSeq, autoPrintHelpAndExit = None)
 
     val conf = parsed match {
       case Right(r) => r
       case Left(l) =>
         println(l)
-        return
+        throw IllegalArgumentException()
     }
 
     if (conf.help.value) {
@@ -285,12 +285,12 @@ object Main {
       println("  -i prog.gtirb --lifter --verify -o prog.bpl         # output prog.bpl and run Boogie")
       println("  -i prog.gtirb --lifter --dsa= --transform-memory    # simplify and partition mem into regions")
       println("  --load-directory-gtirb <dir> --interpret            # interpret the program")
-      return
+      throw IllegalArgumentException()
     }
 
     if (conf.version.value) {
       println(programNameVersionHeader)
-      return
+      throw IllegalArgumentException()
     }
 
     Logger.setLevel(LogLevel.INFO, false)
@@ -423,7 +423,7 @@ object Main {
 
         // skip writing files if the given path is an empty string. this checks compatibility and exits.
         if (relfOut.trim.isEmpty)
-          return
+          throw IllegalArgumentException()
 
         relf match {
           case Some(relf) =>
@@ -440,7 +440,7 @@ object Main {
           case Some(relf) => writeToFile(relf.sorted.toScala, relfOut + "-gtsrelf.scala")
           case None => Logger.warn(s"Failed to load GTIRB information, $relfOut-gtsrelf.scala not written")
         }
-        return
+        throw IllegalArgumentException()
     }
 
     // patch in gtirb-as-relf if directed or if relf is omitted but we are using gtirb.
@@ -489,6 +489,13 @@ object Main {
       memoryTransform = conf.memoryTransform.value,
       assertCalleeSaved = calleeSaved
     )
+    (conf, q)
+  }
+
+  def main(args: Array[String]): Unit = {
+    val (conf, q) =
+      try configOfArgs(args)
+      catch case _: IllegalArgumentException => return
 
     Logger.info(programNameVersionHeader)
 

src/main/scala/ir/transforms/SimplifyPipeline.scala

@@ -2,51 +2,65 @@ package ir.transforms
 
 import analysis.{AnalysisManager, Interval as _, *}
 import ir.*
+import ir.dsl.IRToDSL
+import server.IREpoch
 import translating.PrettyPrinter.*
+import util.RunUtils.logTransform
 import util.{DebugDumpIRLogger, Logger, PerformanceTimer}
 
 import java.io.{BufferedWriter, File, FileWriter}
-
-def doSimplify(ctx: IRContext, dumpILToPath: Option[String] = None): Unit = {
+import scala.collection.mutable.ArrayBuffer
+
+def doSimplify(
+  ctx: IRContext,
+  dumpILToPath: Option[String] = None,
+  collectedSnapshots: Option[ArrayBuffer[IREpoch]] = None
+): Unit = {
+  // writeToFile(dotBlockGraph(program, program.filter(_.isInstanceOf[Block]).map(b => b -> b.toString).toMap), s"blockgraph-before-simp.dot")
   Logger.info("[!] Running Simplify")
   val timer = PerformanceTimer("Simplify")
   val program = ctx.program
 
-  IrreducibleLoops.transform_all_and_update(program)
+  logTransform(collectedSnapshots)("irreducible_loops", ctx => IrreducibleLoops.transform_all_and_update(ctx.program))(
+    ctx
+  )
 
-  for (p <- program.procedures) {
-    p.normaliseBlockNames()
-  }
+  logTransform(collectedSnapshots)("normalise block names", _.program.procedures.foreach(p => p.normaliseBlockNames()))(
+    ctx
+  )
 
   ctx.program.sortProceduresRPO()
 
-  transforms.liftSVComp(ctx.program)
+  val beforeLiftSVComp = IRToDSL.convertProgram(ctx.program).resolve
+  logTransform(collectedSnapshots)("lift_svcomp", c => transforms.liftSVComp(c.program))(ctx)
 
   dumpILToPath.foreach { s =>
     DebugDumpIRLogger.writeToFile(File(s"${s}_il-before-simp.il"), pp_prog(program))
   }
 
   transforms.applyRPO(program)
 
-  // example of printing a simple analysis
-
-  transforms.removeEmptyBlocks(program)
-  transforms.coalesceBlocks(program)
-  transforms.removeEmptyBlocks(program)
-
-  // transforms.coalesceBlocksCrossBranchDependency(program)
+  logTransform(collectedSnapshots)(
+    "simplifyCFG",
+    c => {
+      transforms.removeEmptyBlocks(c.program)
+      transforms.coalesceBlocks(c.program)
+      transforms.removeEmptyBlocks(c.program)
+    }
+  )(ctx)
 
   Logger.info("[!] Simplify :: DynamicSingleAssignment")
   dumpILToPath.foreach { s =>
     DebugDumpIRLogger.writeToFile(File(s"${s}_il-before-dsa.il"), pp_prog(program))
   }
 
-  transforms.OnePassDSA().applyTransform(program)
+  logTransform(collectedSnapshots)("SSA-DSA", c => transforms.OnePassDSA().applyTransform(c.program))(ctx)
 
-  // fixme: this used to be a plain function but now we have to supply an analysis manager!
-  transforms.inlinePLTLaunchpad(ctx, AnalysisManager(ctx.program))
+  logTransform(collectedSnapshots)("inline PLT", c => transforms.inlinePLTLaunchpad(ctx, AnalysisManager(ctx.program)))(
+    ctx
+  )
 
-  transforms.removeEmptyBlocks(program)
+  logTransform(collectedSnapshots)("removeEmptyBlock", c => transforms.removeEmptyBlocks(c.program))(ctx)
 
   dumpILToPath.foreach { s =>
     DebugDumpIRLogger.writeToFile(File(s"${s}_il-after-dsa.il"), pp_prog(program))
@@ -76,12 +90,19 @@ def doSimplify(ctx: IRContext, dumpILToPath: Option[String] = None): Unit = {
   // assert(program.procedures.forall(transforms.rdDSAProperty))
 
   Logger.info("Copyprop Start")
-  transforms.copyPropParamFixedPoint(program, ctx.globalOffsets)
-
-  transforms.fixupGuards(program)
-  transforms.removeDuplicateGuard(program)
-
-  transforms.liftLinuxAssertFail(ctx)
+  logTransform(collectedSnapshots)(
+    "linear expr prop",
+    c => { transforms.copyPropParamFixedPoint(c.program, c.globalOffsets); c }
+  )(ctx)
+
+  logTransform(collectedSnapshots)(
+    "simplify guards",
+    c => {
+      transforms.fixupGuards(c.program)
+      transforms.removeDuplicateGuard(c.program)
+    }
+  )(ctx)
+  logTransform(collectedSnapshots)("lift linux assert", transforms.liftLinuxAssertFail)(ctx)
 
   // assert(program.procedures.forall(transforms.rdDSAProperty))