Deno/rusty_v8
1
0
Fork 0
mirror of https://github.com/denoland/rusty_v8.git synced 2024-11-21 12:18:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: remove unnecessary complexity from build.rs (#963)

Browse Source 
- remove friendly build script output in favor of brevity
- Revert "Add support for generating a `clangd` compilation database (#823)"
- simplify subprocess invocations
This commit is contained in:
Ryan Dahl 2022-07-26 13:21:23 -04:00 committed by GitHub
parent 9f8abf5350
commit 3fbf87aa4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 25 additions and 307 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.clangd
View File

@ -1,2 +0,0 @@
CompileFlags:
Remove: -imsvc*

2
.gitignore vendored
View File

@ -3,9 +3,7 @@
/.vscode/
/.idea/
/.cache
/target/
/compile_commands.json
third_party/android_ndk
third_party/android_platform

22
README.md
View File

@ -120,28 +120,6 @@ Arguments can be passed to `gn` by setting the `$GN_ARGS` environmental variable
Env vars used in when building from source: `SCCACHE`, `CCACHE`, `GN`, `NINJA`,
`CLANG_BASE_PATH`, `GN_ARGS`
## C++ IDE integration
`rusty_v8` supports IDE integration for the C++ bindings through the use of the
`clangd` language server, bringing features such as diagnostics, code completion
and code navigations to your editor. [See the instructions for how to set it up
with your favorite editor.](https://clangd.llvm.org/installation.html#editor-plugins)
Before you can use `clangd` with `rusty_v8`, you must first generate the
compilation database:
```sh
V8_FROM_SOURCE=1 GENERATE_COMPDB= cargo build
```
This will write the `clang` compilation database as the `compile_commands.json`
file at the root of the project repository. You can pass a path to the
`GENERATE_COMPDB` environment variable to change the location where the
compilation database will be written.
You must pass the `GENERATE_COMPDB` environment variable to regenerate the
compilation database, it will not be regenerated automatically.
## FAQ
**Building V8 takes over 30 minutes, this is too slow for me to use this crate.

113
build.rs
View File

@ -24,7 +24,6 @@ fn main() {
"CLANG_BASE_PATH",
"DENO_TRYBUILD",
"DOCS_RS",
"GENERATE_COMPDB",
"GN",
"GN_ARGS",
"HOST",
@ -240,12 +239,12 @@ fn maybe_clone_repo(dest: &str, repo: &str) {
fn maybe_install_sysroot(arch: &str) {
let sysroot_path = format!("build/linux/debian_sid_{}-sysroot", arch);
if !PathBuf::from(sysroot_path).is_dir() {
let status = Command::new("python")
assert!(Command::new("python")
.arg("./build/linux/sysroot_scripts/install-sysroot.py")
.arg(format!("--arch={}", arch))
.status()
.unwrap_or_else(|_| panic!("sysroot download failed: {}", arch));
assert!(status.success());
.unwrap()
.success());
}
}
@ -277,13 +276,13 @@ fn download_ninja_gn_binaries() {
let ninja = ninja.with_extension("exe");
if !gn.exists() || !ninja.exists() {
let status = Command::new("python")
assert!(Command::new("python")
.arg("./tools/ninja_gn_binaries.py")
.arg("--dir")
.arg(&target_dir)
.status()
.expect("ninja_gn_binaries.py download failed");
assert!(status.success());
.unwrap()
.success());
}
assert!(gn.exists());
assert!(ninja.exists());
@ -530,13 +529,13 @@ fn find_compatible_system_clang() -> Option<PathBuf> {
fn clang_download() -> PathBuf {
let clang_base_path = build_dir().join("clang");
println!("clang_base_path {}", clang_base_path.display());
let status = Command::new("python")
assert!(Command::new("python")
.arg("./tools/clang/scripts/update.py")
.arg("--output-dir")
.arg(&clang_base_path)
.status()
.expect("clang download failed");
assert!(status.success());
.unwrap()
.success());
assert!(clang_base_path.exists());
clang_base_path
}
@ -652,37 +651,6 @@ fn ninja(gn_out_dir: &Path, maybe_env: Option<NinjaEnv>) -> Command {
cmd
}
fn generate_compdb(
gn_out_dir: &Path,
target: &str,
output_path: Option<&Path>,
) {
let mut cmd = Command::new("python");
cmd.arg("tools/generate_compdb.py");
cmd.arg("-p");
cmd.arg(&gn_out_dir);
cmd.arg(target);
cmd.arg("-o");
cmd.arg(output_path.unwrap_or_else(|| Path::new("compile_commands.json")));
cmd.envs(env::vars());
cmd.stdout(Stdio::inherit());
cmd.stderr(Stdio::inherit());
if let Ok(ninja_path) = env::var("NINJA") {
let ninja_folder = Path::new(&ninja_path).parent().unwrap();
// Add `ninja_folder` to the PATH envvar.
let original_path = env::var_os("PATH").unwrap();
let new_path = env::join_paths(
env::split_paths(&original_path)
.chain(std::iter::once(ninja_folder.to_owned())),
)
.unwrap();
cmd.env("PATH", new_path);
}
run(&mut cmd, "python");
}
pub type GnArgs = Vec<String>;
pub fn maybe_gen(manifest_dir: &str, gn_args: GnArgs) -> PathBuf {
@ -699,15 +667,17 @@ pub fn maybe_gen(manifest_dir: &str, gn_args: GnArgs) -> PathBuf {
dirs.root.display(),
gn_out_dir.display()
);
let mut cmd = Command::new(gn());
cmd.arg(format!("--root={}", dirs.root.display()));
cmd.arg("gen");
cmd.arg(&gn_out_dir);
cmd.arg("--args=".to_owned() + &args);
cmd.stdout(Stdio::inherit());
cmd.stderr(Stdio::inherit());
cmd.envs(env::vars());
run(&mut cmd, "gn gen");
assert!(Command::new(gn())
.arg(format!("--root={}", dirs.root.display()))
.arg("gen")
.arg(&gn_out_dir)
.arg("--args=".to_owned() + &args)
.stdout(Stdio::inherit())
.stderr(Stdio::inherit())
.envs(env::vars())
.status()
.unwrap()
.success());
}
gn_out_dir
}
@ -720,19 +690,11 @@ pub fn build(target: &str, maybe_env: Option<NinjaEnv>) {
// This helps Rust source files locate the snapshot, source map etc.
println!("cargo:rustc-env=GN_OUT_DIR={}", gn_out_dir.display());
let mut cmd = ninja(&gn_out_dir, maybe_env);
cmd.arg(target);
run(&mut cmd, "ninja");
if let Some(compdb_env) = std::env::var_os("GENERATE_COMPDB") {
// Only use compdb_path if it's not empty.
let compdb_path = if !compdb_env.is_empty() {
Some(Path::new(&compdb_env))
} else {
None
};
generate_compdb(&gn_out_dir, target, compdb_path);
}
assert!(ninja(&gn_out_dir, maybe_env)
.arg(target)
.status()
.unwrap()
.success());
// TODO This is not sufficent. We need to use "gn desc" to query the target
// and figure out what else we need to add to the link.
@ -753,31 +715,6 @@ fn rerun_if_changed(out_dir: &Path, maybe_env: Option<NinjaEnv>, target: &str) {
}
}
fn run(cmd: &mut Command, program: &str) {
use std::io::ErrorKind;
println!("running: {:?}", cmd);
let status = match cmd.status() {
Ok(status) => status,
Err(ref e) if e.kind() == ErrorKind::NotFound => {
fail(&format!(
"failed to execute command: {}\nis `{}` not installed?",
e, program
));
}
Err(e) => fail(&format!("failed to execute command: {}", e)),
};
if !status.success() {
fail(&format!(
"command did not execute successfully, got: {}",
status
));
}
}
fn fail(s: &str) -> ! {
panic!("\n{}\n\nbuild script failed, must exit now", s)
}
fn ninja_get_deps(
out_dir: &Path,
maybe_env: Option<NinjaEnv>,

193
tools/generate_compdb.py
View File

@ -1,193 +0,0 @@
#!/usr/bin/env python
# Copyright 2014 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
# This file is a combination of tools/clang/scripts/generate_compdb.py and
# tools/clang/pylib/clang/compile_db.py from the Chromium source code.
# They are modified to use the ninja executable in PATH, rather than finding
# the binary in the Chromium directory structure.
#
# Delete when tools/clang is updated to include this commit:
# https://chromium.googlesource.com/chromium/src/tools/clang.git/+/d324a17c34dba948e42565378bcdfdac919e62c2
"""
Helper for generating compile DBs for clang tooling. On non-Windows platforms,
this is pretty straightforward. On Windows, the tool does a bit of extra work to
integrate the content of response files, force clang tooling to run in clang-cl
mode, etc.
"""
import argparse
import json
import os
import re
import sys
import subprocess
_RSP_RE = re.compile(r' (@(.+?\.rsp)) ')
_CMD_LINE_RE = re.compile(
r'^(?P<gomacc>.*gomacc(\.exe)?"?\s+)?(?P<clang>\S*clang\S*)\s+(?P<args>.*)$'
)
_debugging = False
def _IsTargettingWindows(target_os):
if target_os is not None:
# Available choices are based on: gn help target_os
assert target_os in [
'android', 'chromeos', 'ios', 'linux', 'nacl', 'mac', 'win'
]
return target_os == 'win'
return sys.platform == 'win32'
def _ProcessCommand(command, target_os):
"""Removes gomacc(.exe). On Windows inserts --driver-mode=cl as the first arg.
Note that we deliberately don't use shlex.split here, because it doesn't work
predictably for Windows commands (specifically, it doesn't parse args the same
way that Clang does on Windows).
Instead, we just use a regex, with the simplifying assumption that the path to
clang-cl.exe contains no spaces.
"""
# If the driver mode is not already set then define it. Driver mode is
# automatically included in the compile db by clang starting with release
# 9.0.0.
driver_mode = ''
# Only specify for Windows. Other platforms do fine without it.
if _IsTargettingWindows(target_os) and '--driver-mode' not in command:
driver_mode = '--driver-mode=cl'
match = _CMD_LINE_RE.search(command)
if match:
match_dict = match.groupdict()
command = ' '.join(
[match_dict['clang'], driver_mode, match_dict['args']])
elif _debugging:
print('Compile command didn\'t match expected regex!')
print('Command:', command)
print('Regex:', _CMD_LINE_RE.pattern)
# Remove some blocklisted arguments. These are VisualStudio specific arguments
# not recognized or used by clangd. They only suppress or activate graphical
# output anyway.
blocklisted_arguments = ['/nologo', '/showIncludes']
command_parts = filter(lambda arg: arg not in blocklisted_arguments,
command.split())
return " ".join(command_parts)
def _ProcessEntry(entry, target_os):
"""Transforms one entry in a Windows compile db to be clang-tool friendly."""
entry['command'] = _ProcessCommand(entry['command'], target_os)
# Expand the contents of the response file, if any.
# http://llvm.org/bugs/show_bug.cgi?id=21634
try:
match = _RSP_RE.search(entry['command'])
if match:
rsp_path = os.path.join(entry['directory'], match.group(2))
rsp_contents = open(rsp_path).read()
entry['command'] = ''.join([
entry['command'][:match.start(1)],
rsp_contents,
entry['command'][match.end(1):]])
except IOError:
if _debugging:
print('Couldn\'t read response file for %s' % entry['file'])
return entry
def ProcessCompileDatabaseIfNeeded(compile_db, target_os=None):
"""Make the compile db generated by ninja on Windows more clang-tool friendly.
Args:
compile_db: The compile database parsed as a Python dictionary.
Returns:
A postprocessed compile db that clang tooling can use.
"""
compile_db = [_ProcessEntry(e, target_os) for e in compile_db]
if not _IsTargettingWindows(target_os):
return compile_db
if _debugging:
print('Read in %d entries from the compile db' % len(compile_db))
original_length = len(compile_db)
# Filter out NaCl stuff. The clang tooling chokes on them.
# TODO(dcheng): This doesn't appear to do anything anymore, remove?
compile_db = [e for e in compile_db if '_nacl.cc.pdb' not in e['command']
and '_nacl_win64.cc.pdb' not in e['command']]
if _debugging:
print('Filtered out %d entries...' %
(original_length - len(compile_db)))
# TODO(dcheng): Also filter out multiple commands for the same file. Not sure
# how that happens, but apparently it's an issue on Windows.
return compile_db
def GetNinjaExecutable():
return 'ninja.exe' if sys.platform == 'win32' else 'ninja'
# FIXME: This really should be a build target, rather than generated at runtime.
def GenerateWithNinja(path, targets=[]):
"""Generates a compile database using ninja.
Args:
path: The build directory to generate a compile database for.
targets: Additional targets to pass to ninja.
Returns:
List of the contents of the compile database.
"""
# TODO(dcheng): Ensure that clang is enabled somehow.
# First, generate the compile database.
json_compile_db = subprocess.check_output(
[GetNinjaExecutable(), '-C', path] + targets +
['-t', 'compdb', 'cc', 'cxx', 'objc', 'objcxx'])
return json.loads(json_compile_db)
def main(argv):
parser = argparse.ArgumentParser()
parser.add_argument(
'-p',
required=True,
help='Path to build directory')
parser.add_argument(
'targets',
nargs='*',
help='Additional targets to pass to ninja')
parser.add_argument(
'--target_os',
choices=['android', 'chromeos', 'ios', 'linux', 'nacl', 'mac', 'win'],
help='Target OS - see `gn help target_os`. Set to "win" when ' +
'cross-compiling Windows from Linux or another host')
parser.add_argument(
'-o',
help='File to write the compilation database to. Defaults to stdout')
args = parser.parse_args()
compdb_text = json.dumps(ProcessCompileDatabaseIfNeeded(
GenerateWithNinja(args.p, args.targets), args.target_os),
indent=2)
if args.o is None:
print(compdb_text)
else:
with open(args.o, 'w') as f:
f.write(compdb_text)
if __name__ == '__main__':
sys.exit(main(sys.argv[1:]))