Refactor wsl-perf as Nim

Author: sirredbeard

.github/workflows/release-artifacts.yml

@@ -25,15 +25,32 @@ jobs:
           echo "version=$version" >> "$env:GITHUB_ENV"
           echo "version=$version"
 
-      - name: Set up PowerShell
+      - name: Configure PowerShell
         run: |
           Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
 
-      - name: Install ps2exe module
+      - name: Install ps2exe module to compile PowerShell scripts
         run: |
           Install-Module -Name ps2exe -Scope CurrentUser -Force
 
-      - name: Compile and release scripts
+      - name: Install Scoop to install Nim
+        run: |
+          iex "& {$(irm get.scoop.sh)} -RunAsAdmin"
+
+      - name: Install Nim to compile Nim applications
+        run: |
+          scoop install nim
+
+      - name: Install Nim dependencies for Nim applications
+        run: |
+          nimble update -y
+          nimble install -y puppy
+
+      - name: Compile Nim applications
+        run: |
+          nim c -d:release -d:static -o:bin\wsl-perf.exe wslperf.nim
+
+      - name: Compile PowerShell scripts
         run: |
           echo "Compile version ${{ env.version }}"
           Get-ChildItem -Path . -Filter '*.ps1' -Recurse -Exclude build-wslinternals.ps1,sched-wsl-dist-update.ps1 | ForEach-Object {

README.md

@@ -68,6 +68,8 @@ On first run, wsl-perf will download and build the perf tool from source and sav
 
 wsl-perf will pass any command line arguments to perf.elf, which is run as root in the WSL2 System Distro.
 
+Unlike the other applications here, wsl-perf is built with [Nim](https://nim-lang.org/) due to limitations in argument parsing in PS2EXE.
+
 ## wsl-reset
 
 A troubleshooting utility that resets the WSL 2 stack to various degrees.

build-wslinternals.ps1

@@ -1,8 +1,30 @@
 # Install ps2exe module if not already installed
 if (-not (Get-Module -Name ps2exe -ListAvailable)) {
+    Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
     Install-Module -Name ps2exe -Scope CurrentUser -Force
 }
 
+# Install Scoop and Nim if not already installed
+if (-not (Get-Command nim -ErrorAction SilentlyContinue)) {
+    Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
+    Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
+    scoop install nim
+    nimble update -y
+    nimble install puppy -y
+}
+
+# Check if cl.exe is available
+if (-not (Get-Command cl -ErrorAction SilentlyContinue)) {
+    Write-Host "cl.exe not found. Please install Visual Studio Build Tools 2019 or Visual Studio 2019 and try again."
+    exit 1
+}
+
+# Check if Windows SDK is available
+if (-not (Get-Command rc.exe -ErrorAction SilentlyContinue)) {
+    Write-Host "rc.exe not found. Please install Windows SDK and try again."
+    exit 1
+}
+
 # Create /bin/ subdirectory if it does not exist
 if (-not (Test-Path -Path ".\bin\" -PathType Container)) {
     New-Item -ItemType Directory -Path ".\bin\"
@@ -19,4 +41,7 @@ foreach ($ps1File in $ps1Files) {
     }
     $exeFile = ".\bin\" + $ps1File.Name.Replace(".ps1", ".exe")
     ps2exe -inputFile $ps1File.FullName -outputFile $exeFile
-}
+}
+
+# Compile wslperf.nim to wsl-perf.exe
+nim c -d:release -d:static -o:bin\wsl-perf.exe wslperf.nim

wsl-perf.ps1

@@ -0,0 +1,59 @@
+import os, osproc, strutils, json, puppy
+
+let tempDir = getEnv("TEMP")
+let wslTempDir = "/mnt/" & tempDir[0].toLowerAscii() & tempDir[2..^1].replace("\\", "/")
+
+proc runCommand(cmd: string): (int, string, string) =
+  let result = execCmdEx(cmd, options = {poUsePath, poStdErrToStdOut})
+  echo result.output
+  return (result.exitCode, result.output, result.output)
+
+proc downloadKernel() =
+  
+  # Get latest kernel version of Microsoft/WSL2-Linux-Kernel from GitHub API
+  let response = get("https://api.github.com/repos/microsoft/WSL2-Linux-Kernel/releases/latest")
+  let json = parseJson(response.body)
+  let kernelVersion = json["tag_name"].str
+  # Get download url for kernel tar.gz
+  let downloadUrl = "https://github.com/microsoft/WSL2-Linux-Kernel/archive/refs/tags/" & kernelVersion & ".tar.gz"
+  # Use puppy library to download kernel tar.gz
+  let download = get(downloadUrl)
+  let kernelTar = open(tempDir & "/kernel.tar.gz", fmWrite)
+  kernelTar.write(download.body)
+  kernelTar.close()
+
+let perfElfExists = fileExists("perf.elf")
+
+if perfElfExists:
+  let (output, exitCode) = execCmdEx("wsl.exe --system --user root ./perf.elf " & commandLineParams().join(" "))
+  echo output
+  if exitCode != 0:
+    quit(exitCode)
+else:
+  echo "perf does not exist. Do you want to build and install perf? [Y/n]"
+  let response = readLine(stdin)
+  if response in ["", "Y", "y"]:
+    echo "Installing perf"
+    discard runCommand("wsl.exe --system --user root sh -c \"while true; do sleep 1000; done\"&")
+    echo "Installing dependencies"
+    discard runCommand("wsl.exe --system --user root tdnf install -y gcc glibc-devel make gawk tar kernel-headers binutils flex bison glibc-static diffutils elfutils-libelf-devel libnuma-devel libbabeltrace2-devel python3")
+    echo "Downloading perf sources"
+    downloadKernel()
+    echo "Copying perf sources to WSL System Distro"
+    discard runCommand("wsl --system --user root cp " & wslTempDir & "/kernel.tar.gz ~/kernel.tar.gz")
+    echo "Extracting perf sources"
+    discard runCommand("wsl --system --user root tar -xzf ~/kernel.tar.gz -C ~")
+    echo "Building perf"
+    discard runCommand("wsl --system --user root sh -c \"cd ~/WSL2-Linux-Kernel-* && make -C tools/perf LDFLAGS='-static'\"")
+    echo "Copying perf to local directory"
+    discard runCommand("wsl --system --user root cp ~/WSL2-Linux-Kernel-*/tools/perf/perf ./perf.elf")
+    echo "Cleaning up"
+    discard runCommand("wsl --system --user root pkill sleep")
+    removeFile(getEnv("TEMP") & "/kernel.tar.gz")
+    echo "perf installed: ", fileExists("perf.elf")
+    let (output, exitCode) = execCmdEx("wsl.exe --system --user root ./perf.elf " & commandLineParams().join(" "))
+    echo output
+    if exitCode != 0:
+      quit(exitCode)
+  else:
+    echo "Exiting..."