Skip to content

Add support for custom flags based on environment #1031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add support for custom flags based on environment #1031

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
345d982
Add support for custom flags based on environment
marvinborner Jun 1, 2025
c44c6ba
Rename LLVM backend flags to CFLAGS
marvinborner Jun 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions effekt/jvm/src/main/scala/effekt/Runner.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import effekt.util.paths.{File, file}
import effekt.util.{getOrElseAborting, escape, OS, os}
import kiama.util.IO

import scala.util.Properties

/**
* Interface used by [[Driver]] and [[EffektTests]] to run a compiled program.
*
Expand Down Expand Up @@ -34,6 +36,11 @@ trait Runner[Executable] {
*/
def includes(stdlibPath: File): List[File] = Nil

/**
* Additional flags to the backend process.
*/
def flags: Seq[String]

/**
* Modules this backend loads by default.
*
Expand Down Expand Up @@ -94,6 +101,8 @@ trait Runner[Executable] {
*/
def eval(executable: Executable)(using C: Context): Unit = build(executable).foreach { execFile =>
val valgrindArgs = Seq("--leak-check=full", "--undef-value-errors=no", "--quiet", "--log-file=valgrind.log", "--error-exitcode=1")
++ Properties.envOrElse("VALGRIND_FLAGS", "").split(" ").toSeq

val process = if (C.config.valgrind())
Process("valgrind", valgrindArgs ++ (execFile +: Context.config.runArgs()))
else
Expand Down Expand Up @@ -160,6 +169,8 @@ object JSNodeRunner extends Runner[String] {

def standardLibraryPath(root: File): File = root / "libraries" / "common"

val flags = Properties.envOrElse("NODE_FLAGS", "").split(" ").toSeq

override def includes(path: File): List[File] = List(path / ".." / "js")

def checkSetup(): Either[String, Unit] =
Expand All @@ -186,7 +197,7 @@ object JSNodeRunner extends Runner[String] {

os match {
case OS.POSIX =>
val shebang = "#!/usr/bin/env node"
val shebang = s"#!/usr/bin/env -S node ${flags.mkString(" ")}"
Copy link
Member Author

@marvinborner marvinborner Jun 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how reliable env -S is for other platforms, but I do not see another elegant way of adding the flags to the node runner. See https://unix.stackexchange.com/questions/399690/multiple-arguments-in-shebang

Copy link
Member Author

@marvinborner marvinborner Jun 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just remembered, this is very related to one of my first contributions #329, which was deemed inadequate! According to #857, this should be safe by now, though?

val jsScriptFilePath = jsFilePath.stripSuffix(s".$extension")
IO.createFile(jsScriptFilePath, s"$shebang\n$jsScript", true)
Some(jsScriptFilePath)
Expand All @@ -195,8 +206,9 @@ object JSNodeRunner extends Runner[String] {
val jsMainFilePath = jsFilePath.stripSuffix(s".$extension") + "__main.js"
val jsMainFileName = jsFileName.stripSuffix(s".$extension") + "__main.js"
val exePath = jsFilePath.stripSuffix(s".$extension")
val jsArgs = Seq("node", "$SCRIPT_DIR/" + jsMainFileName) ++ flags
IO.createFile(jsMainFilePath, jsScript)
Some(createScript(exePath, "node", "$SCRIPT_DIR/" + jsMainFileName))
Some(createScript(exePath, jsArgs: _*))
}
}
object JSWebRunner extends Runner[String] {
Expand All @@ -205,6 +217,8 @@ object JSWebRunner extends Runner[String] {

def standardLibraryPath(root: File): File = root / "libraries" / "common"

val flags = List()

override def includes(path: File): List[File] = List(path / ".." / "js")

def checkSetup(): Either[String, Unit] =
Expand Down Expand Up @@ -243,6 +257,8 @@ trait ChezRunner extends Runner[String] {

def standardLibraryPath(root: File): File = root / "libraries" / "common"

val flags = Properties.envOrElse("CHEZ_FLAGS", "").split(" ").toSeq

def checkSetup(): Either[String, Unit] =
if canRunExecutable("scheme", "--help") then Right(())
else Left("Cannot find scheme. This is required to use the ChezScheme backend.")
Expand All @@ -256,7 +272,8 @@ trait ChezRunner extends Runner[String] {
val schemeFilePath = (out / path).canonicalPath.escape
val exeScriptPath = schemeFilePath.stripSuffix(s".$extension")
val schemeFileName = ("./" + (path.unixPath.split('/').last)).escape
Some(createScript(exeScriptPath, "scheme", "--script", "$SCRIPT_DIR/" + schemeFileName))
val schemeArgs = Seq("scheme", "--script", "$SCRIPT_DIR/" + schemeFileName) ++ flags
Some(createScript(exeScriptPath, schemeArgs: _*))
}

object ChezMonadicRunner extends ChezRunner {
Expand All @@ -277,6 +294,8 @@ object LLVMRunner extends Runner[String] {

def standardLibraryPath(root: File): File = root / "libraries" / "common"

val flags = Properties.envOrElse("CFLAGS", "").split(" ").toSeq

override def includes(path: File): List[File] = List(path / ".." / "llvm")

lazy val clangCmd = discoverExecutable(List("clang-18", "clang"), List("--version"))
Expand Down Expand Up @@ -357,6 +376,7 @@ object LLVMRunner extends Runner[String] {
clangArgs :+= "-march=native"
}

clangArgs ++= flags
exec(clangArgs: _*)
} else {
exec(opt, llPath, "-O2", "-o", bcPath)
Expand All @@ -367,6 +387,7 @@ object LLVMRunner extends Runner[String] {
if (C.config.valgrind()) clangArgs ++= Seq("-O0", "-g")
else if (C.config.debug()) clangArgs ++= Seq("-fsanitize=address,undefined", "-fstack-protector-all")

clangArgs ++= flags
exec(clangArgs: _*)
}

Expand Down
Loading