fix: detect running under Rosetta on Apple Silicone and show an error message instead of crashing

Author: giladgd

src/cli/commands/OnPostInstallCommand.ts

@@ -1,7 +1,10 @@
 import {CommandModule} from "yargs";
-import {defaultSkipDownload} from "../../config.js";
+import chalk from "chalk";
+import {defaultSkipDownload, documentationPageUrls} from "../../config.js";
 import {getLlamaForOptions} from "../../bindings/getLlama.js";
 import {setForceShowConsoleLogPrefix} from "../../state.js";
+import {isRunningUnderRosetta} from "../utils/isRunningUnderRosetta.js";
+import {getConsoleLogPrefix} from "../../utils/getConsoleLogPrefix.js";
 
 type OnPostInstallCommand = null;
 
@@ -12,7 +15,26 @@ export const OnPostInstallCommand: CommandModule<object, OnPostInstallCommand> =
         if (defaultSkipDownload)
             return;
 
-        setForceShowConsoleLogPrefix(false);
+        setForceShowConsoleLogPrefix(true);
+
+        if (await isRunningUnderRosetta()) {
+            console.error(
+                getConsoleLogPrefix(false, false),
+                chalk.red(
+                    "llama.cpp is not supported on Rosetta on Apple Silicone Macs. " +
+                    "Ensure that you're using a native arm64 node.js installation.")
+            );
+            console.error(
+                getConsoleLogPrefix(false, false),
+                "process.platform: " + process.platform + ", process.arch: " + process.arch
+            );
+            console.error(
+                getConsoleLogPrefix(false, false),
+                "troubleshooting: " + documentationPageUrls.troubleshooting.RosettaIllegalHardwareInstruction
+            );
+
+            process.exit(1);
+        }
 
         try {
             await getLlamaForOptions({

src/cli/utils/isRunningUnderRosetta.ts

@@ -0,0 +1,23 @@
+import path from "path";
+import {fileURLToPath} from "url";
+import process from "process";
+import {getPlatform} from "../../bindings/utils/getPlatform.js";
+import {spawnCommand} from "../../utils/spawnCommand.js";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export async function isRunningUnderRosetta() {
+    const platform = getPlatform();
+
+    // // only check for rosetta on macOS when x64 is detected
+    if (platform !== "mac" || process.arch !== "x64")
+        return false;
+
+    try {
+        const res = await spawnCommand("sysctl", ["-n", "sysctl.proc_translated"], __dirname, process.env, false);
+
+        return res.combinedStd.trim() === "1";
+    } catch (err) {
+        return false;
+    }
+}

src/config.ts

@@ -117,6 +117,9 @@ export const documentationPageUrls = {
             Build: documentationCliUrl + "/source/build",
             Clear: documentationCliUrl + "/source/clear"
         }
+    },
+    troubleshooting: {
+        RosettaIllegalHardwareInstruction: documentationUrl + "/guide/troubleshooting#illegal-hardware-instruction"
     }
 } as const;
 export const recommendedBaseDockerImage = "node:20";