Detect and use ccache in cmake-rn

Author: kraenhansen

packages/cmake-rn/scripts/ccache-clang++.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# reference for xcode specific cacche settings: reactnative docs and ccache manpage
+# https://reactnative.dev/docs/build-speed#xcode-specific-setup
+# https://ccache.dev/manual/4.3.html
+
+export CCACHE_MAXSIZE=10G
+export CCACHE_CPP2=true
+export CCACHE_DIRECT=true
+export CCACHE_DEPEND=true
+export CCACHE_HARDLINK=true
+export CCACHE_FILECLONE=true
+export CCACHE_INODECACHE=true
+export CCACHE_SLOPPINESS=file_macro,time_macros,include_file_mtime,include_file_ctime,file_stat_matches,modules,ivfsoverlay,pch_defines,system_headers
+
+exec ccache clang++ "$@"

packages/cmake-rn/scripts/ccache-clang.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# reference for xcode specific cacche settings: reactnative docs and ccache manpage
+# https://reactnative.dev/docs/build-speed#xcode-specific-setup
+# https://ccache.dev/manual/4.3.html
+
+export CCACHE_MAXSIZE=10G
+export CCACHE_CPP2=true
+export CCACHE_DIRECT=true
+export CCACHE_DEPEND=true
+export CCACHE_HARDLINK=true
+export CCACHE_FILECLONE=true
+export CCACHE_INODECACHE=true
+export CCACHE_SLOPPINESS=file_macro,time_macros,include_file_mtime,include_file_ctime,file_stat_matches,modules,ivfsoverlay,pch_defines,system_headers
+
+exec ccache clang "$@"

packages/cmake-rn/src/android.ts

@@ -24,12 +24,14 @@ type AndroidConfigureOptions = {
   triplet: AndroidTriplet;
   ndkVersion: string;
   sdkVersion: string;
+  ccache: boolean;
 };
 
 export function getAndroidConfigureCmakeArgs({
   triplet,
   ndkVersion,
   sdkVersion,
+  ccache,
 }: AndroidConfigureOptions) {
   const { ANDROID_HOME } = process.env;
   assert(typeof ANDROID_HOME === "string", "Missing env variable ANDROID_HOME");
@@ -72,10 +74,14 @@ export function getAndroidConfigureCmakeArgs({
     // `CMAKE_BUILD_TYPE=${configuration}`,
     "-D",
     "CMAKE_MAKE_PROGRAM=ninja",
-    // "-D",
-    // "CMAKE_C_COMPILER_LAUNCHER=ccache",
-    // "-D",
-    // "CMAKE_CXX_COMPILER_LAUNCHER=ccache",
+    ...(ccache
+      ? [
+          "-D",
+          "CMAKE_C_COMPILER_LAUNCHER=ccache",
+          "-D",
+          "CMAKE_CXX_COMPILER_LAUNCHER=ccache",
+        ]
+      : []),
     "-D",
     `ANDROID_NDK=${ndkPath}`,
     "-D",

packages/cmake-rn/src/apple.ts

@@ -1,7 +1,12 @@
 import assert from "node:assert/strict";
+import path from "node:path";
 
 import { AppleTriplet, isAppleTriplet } from "react-native-node-api";
 
+const scriptsPath = path.join(import.meta.dirname, "..", "scripts");
+const ccacheClangPath = path.join(scriptsPath, "ccache-clang.sh");
+const ccacheClangPPPath = path.join(scriptsPath, "ccache-clang++.sh");
+
 export const DEFAULT_APPLE_TRIPLETS = [
   "arm64;x86_64-apple-darwin",
   "arm64-apple-ios",
@@ -82,9 +87,13 @@ export function createPlistContent(values: Record<string, string>) {
 
 type AppleConfigureOptions = {
   triplet: AppleTriplet;
+  ccache: boolean;
 };
 
-export function getAppleConfigureCmakeArgs({ triplet }: AppleConfigureOptions) {
+export function getAppleConfigureCmakeArgs({
+  triplet,
+  ccache,
+}: AppleConfigureOptions) {
   assert(isAppleTriplet(triplet));
   const systemName = CMAKE_SYSTEM_NAMES[triplet];
 
@@ -100,6 +109,18 @@ export function getAppleConfigureCmakeArgs({ triplet }: AppleConfigureOptions) {
     // Set the target architecture
     "-D",
     `CMAKE_OSX_ARCHITECTURES=${APPLE_ARCHITECTURES[triplet]}`,
+    ...(ccache
+      ? [
+          "-D",
+          `CMAKE_XCODE_ATTRIBUTE_CC=${ccacheClangPath}`,
+          "-D",
+          `CMAKE_XCODE_ATTRIBUTE_CXX=${ccacheClangPPPath}`,
+          "-D",
+          `CMAKE_XCODE_ATTRIBUTE_LD=${ccacheClangPath}`,
+          "-D",
+          `CMAKE_XCODE_ATTRIBUTE_LDPLUSPLUS=${ccacheClangPPPath}`,
+        ]
+      : []),
   ];
 }
 

packages/cmake-rn/src/ccache.ts

@@ -0,0 +1,10 @@
+import cp from "node:child_process";
+
+export function getCcacheVersion(): string | undefined {
+  const { status, stdout } = cp.spawnSync("ccache", ["--print-version"], {
+    encoding: "utf8",
+  });
+  if (status === 0) {
+    return stdout.trim();
+  }
+}

packages/cmake-rn/src/cli.ts

@@ -33,6 +33,7 @@ import {
   createXCframework,
   determineXCFrameworkFilename,
 } from "react-native-node-api";
+import { getCcacheVersion } from "./ccache.js";
 
 // We're attaching a lot of listeners when spawning in parallel
 EventEmitter.defaultMaxListeners = 100;
@@ -109,6 +110,11 @@ const xcframeworkExtensionOption = new Option(
   "Don't rename the xcframework to .apple.node"
 ).default(false);
 
+const noCcacheOption = new Option(
+  "--no-ccache",
+  "Don't detect and use ccache to speed up builds"
+);
+
 export const program = new Command("cmake-rn")
   .description("Build React Native Node API modules with CMake")
   .addOption(verboseOption)
@@ -120,13 +126,24 @@ export const program = new Command("cmake-rn")
   .addOption(buildPathOption)
   .addOption(outPathOption)
   .addOption(cleanOption)
+  .addOption(noCcacheOption)
   .addOption(ndkVersionOption)
   .addOption(androidSdkVersionOption)
   .addOption(noAutoLinkOption)
   .addOption(noWeakNodeApiLinkageOption)
   .addOption(xcframeworkExtensionOption)
   .action(async ({ triplet: tripletValues, ...globalContext }) => {
     try {
+      const ccacheVersion = globalContext.ccache
+        ? getCcacheVersion()
+        : undefined;
+      if (ccacheVersion) {
+        console.log("⚡️Using ccache", chalk.dim(`(${ccacheVersion})`));
+      } else {
+        // Disable ccache if not found
+        globalContext.ccache = false;
+      }
+
       const buildPath = getBuildPath(globalContext);
       if (globalContext.clean) {
         await fs.promises.rm(buildPath, { recursive: true, force: true });
@@ -364,19 +381,21 @@ function getTripletConfigureCmakeArgs(
   {
     ndkVersion,
     androidSdkVersion,
+    ccache,
   }: Pick<
     GlobalContext,
-    "ndkVersion" | "androidSdkVersion" | "weakNodeApiLinkage"
+    "ndkVersion" | "androidSdkVersion" | "weakNodeApiLinkage" | "ccache"
   >
 ) {
   if (isAndroidTriplet(triplet)) {
     return getAndroidConfigureCmakeArgs({
       triplet,
       ndkVersion,
       sdkVersion: androidSdkVersion,
+      ccache,
     });
   } else if (isAppleTriplet(triplet)) {
-    return getAppleConfigureCmakeArgs({ triplet });
+    return getAppleConfigureCmakeArgs({ triplet, ccache });
   } else {
     throw new Error(`Support for '${triplet}' is not implemented yet`);
   }
@@ -398,6 +417,7 @@ async function configureProject(context: TripletScopedContext) {
     triplet,
     tripletBuildPath,
     source,
+    ccache,
     ndkVersion,
     androidSdkVersion,
     weakNodeApiLinkage,
@@ -411,6 +431,7 @@ async function configureProject(context: TripletScopedContext) {
       tripletBuildPath,
       ...getVariablesArgs(getVariables(context)),
       ...getTripletConfigureCmakeArgs(triplet, {
+        ccache,
         ndkVersion,
         weakNodeApiLinkage,
         androidSdkVersion,