Add Windows Support

.gitignore

@@ -1,6 +1,7 @@
 *.dylib
 *.so
 *.dSYM
+*.dll
 tools/
 out/
 lldb/
@@ -12,4 +13,4 @@ node_modules/
 
 # Generated by scripts/configure.js
 config.gypi
-llnode.sh
+llnode.js

README.md

@@ -81,6 +81,17 @@ version is LLDB 3.9 and above.
   ln -s /usr/local/bin/lldb39 /usr/bin/lldb
   ```
 
+- Windows
+  - You can install a [binary distribution of LLVM](http://releases.llvm.org/download.html)
+    directly or using [Chocolatey](https://chocolatey.org/install#installing-chocolatey):
+
+    ```bat
+    cinst -y visualstudio2017buildtools visualstudio2017-workload-vctools llvm git
+    ```
+
+    Visual Studio is required for MSBuild and headers when building llnode. Git
+    is required to download the lldb headers.
+
 ### Install the Plugin
 
 #### Install llnode globally via npm

binding.gyp

@@ -50,7 +50,19 @@
             },
           }],
         ],
-      }]
+      }],
+      [ "OS == 'win'", {
+        "sources": [
+          "<(lldb_include_dir)/../source/Host/common/GetOptInc.cpp",
+          "windows/llnode.def",
+        ],
+        "include_dirs": [
+          "windows/include",
+        ],
+        "libraries": [
+          "<(lldb_lib_dir)/<(lldb_lib)",
+        ],
+      }],
     ]
   },
 

package.json

@@ -7,11 +7,11 @@
     "test": "test"
   },
   "bin": {
-    "llnode": "llnode.sh"
+    "llnode": "llnode.js"
   },
   "scripts": {
     "preinstall": "node scripts/configure.js",
-    "install": "node-gyp rebuild",
+    "install": "node scripts/install.js",
     "postinstall": "node scripts/cleanup.js",
     "test": "tape test/*-test.js"
   },

scripts/cleanup.js

@@ -2,8 +2,16 @@
 
 const fs = require('fs');
 const cwd = process.cwd();
+const osName = require('os').type();
 
-const libExt = require('os').type() === 'Darwin' ? 'dylib' : 'so';
+let libExt;
+if (osName === 'Darwin') {
+  libExt = 'dylib';
+} else if (osName === 'Windows_NT') {
+  libExt = 'dll';
+} else {
+  libExt = 'so';
+}
 const llnodeLib = `plugin.${libExt}`;
 const destLib = `llnode.${libExt}`;
 

scripts/configure.js

@@ -49,6 +49,10 @@ function configureInstallation(osName, buildDir) {
   } else if (osName === 'FreeBSD') {
     installation = require('./freebsd').getLldbInstallation();
     config.variables['lldb_lib_dir%'] = installation.libDir;
+  } else if (osName === 'Windows_NT') {
+    installation = require('./windows').getLldbInstallation();
+    config.variables['lldb_lib_dir%'] = installation.libDir;
+    config.variables['lldb_lib%'] = installation.libName;
   } else {
     console.log(`Unsupported OS: ${osName}`);
     process.exit(1);
@@ -75,8 +79,8 @@ function configureInstallation(osName, buildDir) {
  */
 function writeLlnodeScript(buildDir, lldbExe, osName) {
   const text = scriptText(osName, lldbExe);
-  const scriptPath = path.join(buildDir, 'llnode.sh');
-  console.log(`Writing llnode.sh shortcut to ${scriptPath}`);
+  const scriptPath = path.join(buildDir, 'llnode.js');
+  console.log(`Writing llnode.js shortcut to ${scriptPath}`);
   fs.writeFileSync(scriptPath, text);
 }
 
@@ -92,25 +96,50 @@ function writeConfig(config) {
 }
 
 function scriptText(osName, lldbExe) {
-  let lib = 'llnode.so';
-  if (osName === 'Darwin') { lib = 'llnode.dylib'; }
+  let lib;
+  if (osName === 'Darwin') {
+    lib = 'llnode.dylib';
+  } else if (osName === 'Windows_NT') {
+    lib = 'llnode.dll';
+    lldbExe = lldbExe.replace(/\\/g, '\\\\');
+  } else {
+    lib = 'llnode.so';
+  }
 
-  return `#!/bin/sh
+  return `#!/usr/bin/env node
 
-LLNODE_SCRIPT=\`node -p "require('path').resolve('$0')"\`
+const child_process = require('child_process');
+const fs = require('fs');
+const path = require('path');
 
-SCRIPT_PATH=\`dirname $LLNODE_SCRIPT\`
-if [ \`basename $SCRIPT_PATH\` = ".bin" ]; then
-  # llnode installed locally in node_modules/.bin
-  LLNODE_PLUGIN="$SCRIPT_PATH/../llnode/${lib}"
-elif [ -e $SCRIPT_PATH/../lib/node_modules/llnode/${lib} ]; then
-  # llnode installed globally in lib/node_modules
-  LLNODE_PLUGIN="$SCRIPT_PATH/../lib/node_modules/llnode/${lib}"
-else
-  # The scrips is invoked directly
-  LLNODE_PLUGIN="$SCRIPT_PATH/${lib}"
-fi
+const scriptPath = path.dirname(__filename);
+const globalPath = path.resolve(
+  scriptPath, '..', 'lib', 'node_modules', 'llnode', '${lib}');
 
-${lldbExe} --one-line "plugin load $LLNODE_PLUGIN" --one-line "settings set prompt '(llnode) '" $@
+let llnodePlugin;
+if (path.basename(scriptPath) === '.bin') {
+  // llnode installed locally in node_modules/.bin
+  llnodePlugin = path.resolve(scriptPath, '..', 'llnode', '${lib}');
+} else if (fs.existsSync(globalPath)) {
+  // llnode installed globally in lib/node_modules
+  llnodePlugin = globalPath;
+} else {
+  // The script is invoked directly
+  llnodePlugin = path.join(scriptPath, '${lib}');
+}
+
+try {
+  child_process.execFileSync(
+    '${lldbExe}', [
+      '--one-line',
+      'plugin load \\''+llnodePlugin+'\\'',
+      '--one-line',
+      'settings set prompt \\'(llnode) \\''
+    ].concat(process.argv.slice(2)), {
+      stdio: 'inherit'
+    });
+} catch (err) {
+  process.exit(err.status);
+}
 `;
 }

scripts/install.js

@@ -0,0 +1,59 @@
+'use strict';
+
+const child_process = require('child_process');
+const os = require('os');
+const fs = require('fs');
+const path = require('path');
+
+const lldb = require('./lldb');
+
+main();
+
+function main() {
+  const osName = os.type();
+  if (osName === 'Windows_NT') {
+    return mainWindows();
+  }
+
+  runFile('node-gyp', ['rebuild']);
+}
+
+function mainWindows() {
+  const clangExe = 'clang-cl.exe';
+  const clangDir = lldb.findWindowsExeDir(clangExe);
+
+  if (!clangDir) {
+    console.log(`Could not find ${clangExe}`);
+    process.exit(1);
+  }
+  console.log(`Using ${clangExe} found at ${clangDir}`);
+
+  runShell('node-gyp clean');
+  runShell('node-gyp configure');
+  runShell(`node-gyp build /p:CLToolExe="${clangExe}" /p:CLToolPath="${clangDir}"`);
+}
+
+/**
+ * execFileSync wrapper, exits on error.
+ * @param {string} file Executable to run
+ * @param {string[]} args List of arguments
+ */
+function runFile(file, args) {
+  try {
+    child_process.execFileSync(file, args, { stdio: 'inherit' });
+  } catch (err) {
+    process.exit(err.status);
+  }
+}
+
+/**
+ * execSync wrapper, exits on error.
+ * @param {string} command Command to run
+ */
+function runShell(command) {
+  try {
+    child_process.execSync(command, { stdio: 'inherit' });
+  } catch (err) {
+    process.exit(err.status);
+  }
+}

scripts/lldb.js

@@ -82,6 +82,55 @@ function tryExecutables(exeNames) {
   }
 }
 
+/**
+ * Find a directory containing a LLVM executable in Windows.
+ * The search happens in the following order:
+ * - the directory specified by the user using npm --lldb_exe=...
+ * - using 'where' to find the executable in the PATH
+ * - the default LLVM location in Program Files
+ * Returns undefined if the executable was not found.
+ * @param {string} exeName
+ * @returns {string|undefined}
+ */
+function findWindowsExeDir(exeName) {
+  // Look for exeName at the location of lldb_exe
+  if (process.env.npm_config_lldb_exe !== undefined) {
+    const exeDir = path.dirname(process.env.npm_config_lldb_exe);
+    if (fs.existsSync(path.join(exeDir, exeName))) {
+      return exeDir;
+    }
+    console.log(`Could not find ${exeName} in the directory of lldb_exe`);
+  }
+
+  // Look for exeName in the PATH
+  let exePath;
+  try {
+    exePath = child_process.execSync(
+        `where ${exeName}`,
+        { stdio: 'pipe' }  // to suppress stderr
+    ).toString().trim().split(/[\r\n]+/g)[0].trim();
+  } catch (err) { /* Do nothing. */ }
+  // Ensure the string returned by 'where' is not an error
+  if (exePath && fs.existsSync(exePath)) {
+    return path.dirname(exePath);
+  }
+  console.log(`Could not find ${exeName} in the PATH`);
+
+  // Look for exeName in Program Files
+  if (process.env['ProgramFiles']) {
+    const exeDir = path.join(process.env['ProgramFiles'], 'LLVM', 'bin');
+    if (fs.existsSync(path.join(exeDir, exeName))) {
+      return exeDir;
+    }
+  }
+  if (process.env['ProgramFiles(x86)']) {
+    const exeDir = path.join(process.env['ProgramFiles(x86)'], 'LLVM', 'bin');
+    if (fs.existsSync(path.join(exeDir, exeName))) {
+      return exeDir;
+    }
+  }
+}
+
 /**
  * Get the lldb version from the lldb executable, exit the process with 1
  * if failed.
@@ -112,5 +161,6 @@ module.exports = {
   getLibPath,
   cloneHeaders,
   tryExecutables,
+  findWindowsExeDir,
   getLldbVersion
 };

scripts/windows.js

@@ -0,0 +1,88 @@
+'use strict';
+
+const child_process = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const lldb = require('./lldb');
+
+/**
+ * Find the lldb to use in the installation of LLVM.
+ * @returns {string} Path to the lldb executable or undefined
+ */
+function getLldbExecutable() {
+  if (process.env.npm_config_lldb_exe !== undefined) {
+    return process.env.npm_config_lldb_exe;
+  }
+
+  const lldbDir = lldb.findWindowsExeDir('lldb.exe');
+  if (lldbDir) {
+    return path.join(lldbDir, 'lldb.exe');
+  }
+}
+
+/**
+ * Get the directory containing the lldb library.
+ * @param {string} lldbExe Path to the corresponding lldb executable
+ * @returns {{dir:string, name:string}}
+ */
+function getLib(lldbExe) {
+  const libName = 'liblldb.lib';
+  const libDir = path.resolve(path.dirname(lldbExe), '..', 'lib');
+
+  if (!fs.existsSync(path.join(libDir, libName))) {
+    return {
+      dir: undefined,
+      name: libName
+    };
+  }
+
+  return {
+    dir: libDir,
+    name: libName
+  };
+}
+
+/**
+ * Get the lldb installation. If prefix is undefined, the headers need to
+ * be downloaded.
+ * The version string will be in the form like '3.9'
+ */
+function getLldbInstallation() {
+  console.log('Looking for lldb executable...');
+  const lldbExe = getLldbExecutable();
+  if (!lldbExe) {
+    console.log('Could not find any usable lldb executable');
+    console.log('Please see the README.md on how to install lldb');
+    process.exit(1);
+  }
+  console.log(`Found lldb executable ${lldbExe}`);
+
+  console.log('\nReading lldb version...');
+  const lldbVersion = lldb.getLldbVersion(lldbExe);
+  if (!lldbVersion) {
+    console.log(`Unable to get the version from the lldb binary ${lldbExe}`);
+    process.exit(1);
+  }
+  console.log(`Installing llnode for ${lldbExe}, lldb version ${lldbVersion}`);
+
+  console.log(`\nLooking for shared libraries for lldb ${lldbVersion}...`);
+  const lib = getLib(lldbExe);
+  if (!lib.dir) {
+    console.log(`Could not find ${lib.name} in the same path as the lldb executable`);
+    process.exit(1);
+  } else {
+    console.log(`Found ${lib.name} in ${lib.dir}`);
+  }
+
+  return {
+    executable: lldbExe,
+    version: lldbVersion,
+    includeDir: undefined, // Windows binary distribution does not contain headers
+    libDir: lib.dir,
+    libName: lib.name
+  };
+}
+
+module.exports = {
+  getLldbInstallation
+};

test/common.js

@@ -25,7 +25,7 @@ const debug = exports.debug =
 let pluginName;
 if (process.platform === 'darwin')
   pluginName = 'llnode.dylib';
-else if (process.platform === 'windows')
+else if (process.platform === 'win32')
   pluginName = 'llnode.dll';
 else
   pluginName = 'llnode.so';

windows/include/getopt.h

@@ -0,0 +1 @@
+#include <lldb/Host/common/GetOptInc.h>