feat: allow setting rust min stack size

Signed-off-by: Victor Adossi <vadossi@cosmonic.com>

Author: vados-cosmonic

README.md

@@ -111,6 +111,12 @@ The component iself can be executed in any component runtime, see the [example](
 
 To enable AOT compilation, set the `enableAot: true` option to run [Weval][weval] ahead-of-time compilation.
 
+AOT compilation can also be configured with the following options:
+
+| Option                 | Type                                | Example         | Description                                                              |
+|------------------------|-------------------------------------|-----------------|--------------------------------------------------------------------------|
+| `aotMinStackSizeBytes` | `nubmer | Number | bigint | BigInt` | `2_007_846_092` | The minimum stack size (via `RUST_MIN_STACK` to set when running `weval` |
+
 [weval]: https://github.com/bytecodealliance/weval
 
 ### Custom `weval` binary

src/componentize.js

@@ -1,3 +1,4 @@
+import { freemem } from "node:os";
 import wizer from '@bytecodealliance/wizer';
 import getWeval from '@bytecodealliance/weval';
 import {
@@ -19,7 +20,7 @@ import { fileURLToPath } from 'node:url';
 import { stdout, stderr, exit, platform } from 'node:process';
 import { init as lexerInit, parse } from 'es-module-lexer';
 export const { version } = JSON.parse(
-  await readFile(new URL('../package.json', import.meta.url), 'utf8')
+  await readFile(new URL('../package.json', import.meta.url), 'utf8'),
 );
 const isWindows = platform === 'win32';
 const DEBUG_BINDINGS = false;
@@ -32,6 +33,24 @@ function maybeWindowsPath(path) {
   return '//?/' + resolve(path).replace(/\\/g, '/');
 }
 
+/**
+ * Check whether a value is numeric (including BigInt)
+ *
+ * @param {any} n
+ * @returns {boolean} whether the value is numeric
+ */
+function isNumeric(n) {
+  switch (typeof n) {
+    case 'bigint':
+    case 'number':
+      return true;
+    case 'object':
+      return n.constructor == BigInt || n.constructor == Number;
+    default:
+      return false;
+  }
+}
+
 export async function componentize(jsSource, witWorld, opts) {
   if (typeof witWorld === 'object') {
     opts = witWorld;
@@ -48,7 +67,7 @@ export async function componentize(jsSource, witWorld, opts) {
     debugBuild = false,
     runtimeArgs,
     aotCache = fileURLToPath(
-      new URL(`../lib/starlingmonkey_ics.wevalcache`, import.meta.url)
+      new URL(`../lib/starlingmonkey_ics.wevalcache`, import.meta.url),
     ),
   } = opts;
 
@@ -58,11 +77,9 @@ export async function componentize(jsSource, witWorld, opts) {
       new URL(
         opts.enableAot
           ? `../lib/starlingmonkey_embedding_weval.wasm`
-          : `../lib/starlingmonkey_embedding${
-              debugBuild ? '.debug' : ''
-            }.wasm`,
-        import.meta.url
-      )
+          : `../lib/starlingmonkey_embedding${debugBuild ? '.debug' : ''}.wasm`,
+        import.meta.url,
+      ),
     );
 
   await lexerInit;
@@ -108,7 +125,7 @@ export async function componentize(jsSource, witWorld, opts) {
     guestImports,
     guestExports,
     features,
-    false
+    false,
   );
 
   if (DEBUG_BINDINGS) {
@@ -119,7 +136,7 @@ export async function componentize(jsSource, witWorld, opts) {
       jsBindings
         .split('\n')
         .map((ln, idx) => `${(idx + 1).toString().padStart(4, ' ')} | ${ln}`)
-        .join('\n')
+        .join('\n'),
     );
     console.log('--- JS Imports ---');
     console.log(imports);
@@ -133,7 +150,7 @@ export async function componentize(jsSource, witWorld, opts) {
     createHash('sha256')
       .update(Math.random().toString())
       .digest('hex')
-      .slice(0, 12)
+      .slice(0, 12),
   );
   await mkdir(tmpDir);
 
@@ -158,8 +175,8 @@ export async function componentize(jsSource, witWorld, opts) {
         ]
           .map((impt) => `'${impt}'`)
           .join(
-            ', '
-          )}.\nMake sure to use a bundler for JS dependencies such as esbuild or RollupJS.`
+            ', ',
+          )}.\nMake sure to use a bundler for JS dependencies such as esbuild or RollupJS.`,
       );
     }
     const specifier = jsSource.slice(jsImpt.s, jsImpt.e);
@@ -186,8 +203,8 @@ export async function componentize(jsSource, witWorld, opts) {
         source,
       ]),
     ].map(async ([sourceName, source]) =>
-      writeFile(join(sourceDir, sourceName), source)
-    )
+      writeFile(join(sourceDir, sourceName), source),
+    ),
   );
 
   let hostenv = {};
@@ -224,7 +241,9 @@ export async function componentize(jsSource, witWorld, opts) {
     console.log(env);
   }
 
-  let sourcePath = maybeWindowsPath(join(sourceDir, sourceName.slice(0, -3) + '.bindings.js'));
+  let sourcePath = maybeWindowsPath(
+    join(sourceDir, sourceName.slice(0, -3) + '.bindings.js'),
+  );
   runtimeArgs = runtimeArgs ? `${runtimeArgs} ${sourcePath}` : sourcePath;
 
   if (opts.enableAot) {
@@ -236,6 +255,18 @@ export async function componentize(jsSource, witWorld, opts) {
       wevalBin = await getWeval();
     }
 
+    // Set the min stack size, if one was provided
+    if (opts.aotMinStackSizeBytes) {
+      if (!isNumeric(opts.aotMinStackSizeBytes)) {
+        throw new TypeError(
+          `aotMinStackSizeBytes must be a numeric value, received [${opts.aotMinStackSizeBytes}] (type ${typeof opts.aotMinStackSizeBytes})`,
+        );
+      }
+      env.RUST_MIN_STACK = opts.aotMinStackSizeBytes;
+    } else {
+      env.RUST_MIN_STACK = defaultMinStackSize();
+    }
+
     try {
       let wevalProcess = spawnSync(
         wevalBin,
@@ -255,7 +286,7 @@ export async function componentize(jsSource, witWorld, opts) {
           input: runtimeArgs,
           shell: true,
           encoding: 'utf-8',
-        }
+        },
       );
       if (wevalProcess.status !== 0)
         throw new Error('Wevaling failed to complete');
@@ -290,7 +321,7 @@ export async function componentize(jsSource, witWorld, opts) {
           input: runtimeArgs,
           shell: true,
           encoding: 'utf-8',
-        }
+        },
       );
       if (wizerProcess.status !== 0)
         throw new Error('Wizering failed to complete');
@@ -326,7 +357,7 @@ export async function componentize(jsSource, witWorld, opts) {
   async function initWasm(bin) {
     const eep = (name) => () => {
       throw new Error(
-        `Internal error: unexpected call to "${name}" during Wasm verification`
+        `Internal error: unexpected call to "${name}" during Wasm verification`,
       );
     };
 
@@ -346,7 +377,7 @@ export async function componentize(jsSource, witWorld, opts) {
             const bufPtr = mem.getUint32(iovs + i * 8, true);
             const bufLen = mem.getUint32(iovs + 4 + i * 8, true);
             stderr += new TextDecoder().decode(
-              new Uint8Array(exports.memory.buffer, bufPtr, bufLen)
+              new Uint8Array(exports.memory.buffer, bufPtr, bufLen),
             );
             written += bufLen;
           }
@@ -372,7 +403,7 @@ export async function componentize(jsSource, witWorld, opts) {
 
   // convert CABI import conventiosn to ESM import conventions
   imports = imports.map(([specifier, impt]) =>
-    specifier === '$root' ? [impt, 'default'] : [specifier, impt]
+    specifier === '$root' ? [impt, 'default'] : [specifier, impt],
   );
 
   const INIT_OK = 0;
@@ -409,7 +440,7 @@ export async function componentize(jsSource, witWorld, opts) {
     features,
     witWorld,
     maybeWindowsPath(witPath),
-    worldName
+    worldName,
   );
 
   if (DEBUG_BINARY) {
@@ -422,16 +453,27 @@ export async function componentize(jsSource, witWorld, opts) {
       Object.entries({
         wasi_snapshot_preview1: await readFile(preview2Adapter),
       }),
-      false
+      false,
     ),
     Object.entries({
       language: [['JavaScript', '']],
       'processed-by': [['ComponentizeJS', version]],
-    })
+    }),
   );
 
   return {
     component,
     imports,
   };
 }
+
+/**
+ * Calculate the min stack size depending on free memory
+ *
+ * @param {number} freeMemoryBytes - Amount of free memory in the system, in bytes  (if not provided, os.freemem() is used)
+ * @returns {number} The minimum stack size that should be used as a default.
+ */
+function defaultMinStackSize(freeMemoryBytes) {
+  freeMemoryBytes = freeMemoryBytes ?? freemem();
+  return Math.max(8 * 1024 * 1024, Math.floor(freeMemoryBytes * 0.1));
+}