]> git.lizzy.rs Git - rust.git/blob - src/bootstrap/native.rs
Rollup merge of #60766 - vorner:weak-into-raw, r=sfackler
[rust.git] / src / bootstrap / native.rs
1 //! Compilation of native dependencies like LLVM.
2 //!
3 //! Native projects like LLVM unfortunately aren't suited just yet for
4 //! compilation in build scripts that Cargo has. This is because the
5 //! compilation takes a *very* long time but also because we don't want to
6 //! compile LLVM 3 times as part of a normal bootstrap (we want it cached).
7 //!
8 //! LLVM and compiler-rt are essentially just wired up to everything else to
9 //! ensure that they're always in place if needed.
10
11 use std::env;
12 use std::ffi::OsString;
13 use std::fs::{self, File};
14 use std::path::{Path, PathBuf};
15 use std::process::Command;
16
17 use build_helper::{output, t};
18 use cmake;
19 use cc;
20
21 use crate::channel;
22 use crate::util::{self, exe};
23 use build_helper::up_to_date;
24 use crate::builder::{Builder, RunConfig, ShouldRun, Step};
25 use crate::cache::Interned;
26 use crate::GitRepo;
27
28 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
29 pub struct Llvm {
30     pub target: Interned<String>,
31     pub emscripten: bool,
32 }
33
34 impl Step for Llvm {
35     type Output = PathBuf; // path to llvm-config
36
37     const ONLY_HOSTS: bool = true;
38
39     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
40         run.path("src/llvm-project")
41             .path("src/llvm-project/llvm")
42             .path("src/llvm")
43             .path("src/llvm-emscripten")
44     }
45
46     fn make_run(run: RunConfig<'_>) {
47         let emscripten = run.path.ends_with("llvm-emscripten");
48         run.builder.ensure(Llvm {
49             target: run.target,
50             emscripten,
51         });
52     }
53
54     /// Compile LLVM for `target`.
55     fn run(self, builder: &Builder<'_>) -> PathBuf {
56         let target = self.target;
57         let emscripten = self.emscripten;
58
59         // If we're using a custom LLVM bail out here, but we can only use a
60         // custom LLVM for the build triple.
61         if !self.emscripten {
62             if let Some(config) = builder.config.target_config.get(&target) {
63                 if let Some(ref s) = config.llvm_config {
64                     check_llvm_version(builder, s);
65                     return s.to_path_buf()
66                 }
67             }
68         }
69
70         let (llvm_info, root, out_dir, llvm_config_ret_dir) = if emscripten {
71             let info = &builder.emscripten_llvm_info;
72             let dir = builder.emscripten_llvm_out(target);
73             let config_dir = dir.join("bin");
74             (info, "src/llvm-emscripten", dir, config_dir)
75         } else {
76             let info = &builder.in_tree_llvm_info;
77             let mut dir = builder.llvm_out(builder.config.build);
78             if !builder.config.build.contains("msvc") || builder.config.ninja {
79                 dir.push("build");
80             }
81             (info, "src/llvm-project/llvm", builder.llvm_out(target), dir.join("bin"))
82         };
83
84         if !llvm_info.is_git() {
85             println!(
86                 "git could not determine the LLVM submodule commit hash. \
87                 Assuming that an LLVM build is necessary.",
88             );
89         }
90
91         let build_llvm_config = llvm_config_ret_dir
92             .join(exe("llvm-config", &*builder.config.build));
93         let done_stamp = out_dir.join("llvm-finished-building");
94
95         if let Some(llvm_commit) = llvm_info.sha() {
96             if done_stamp.exists() {
97                 let done_contents = t!(fs::read(&done_stamp));
98
99                 // If LLVM was already built previously and the submodule's commit didn't change
100                 // from the previous build, then no action is required.
101                 if done_contents == llvm_commit.as_bytes() {
102                     return build_llvm_config
103                 }
104             }
105         }
106
107         let _folder = builder.fold_output(|| "llvm");
108         let descriptor = if emscripten { "Emscripten " } else { "" };
109         builder.info(&format!("Building {}LLVM for {}", descriptor, target));
110         let _time = util::timeit(&builder);
111         t!(fs::create_dir_all(&out_dir));
112
113         // http://llvm.org/docs/CMake.html
114         let mut cfg = cmake::Config::new(builder.src.join(root));
115
116         let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
117             (false, _) => "Debug",
118             (true, false) => "Release",
119             (true, true) => "RelWithDebInfo",
120         };
121
122         // NOTE: remember to also update `config.toml.example` when changing the
123         // defaults!
124         let llvm_targets = if self.emscripten {
125             "JSBackend"
126         } else {
127             match builder.config.llvm_targets {
128                 Some(ref s) => s,
129                 None => "X86;ARM;AArch64;Mips;PowerPC;SystemZ;MSP430;Sparc;NVPTX;Hexagon",
130             }
131         };
132
133         let llvm_exp_targets = if self.emscripten {
134             ""
135         } else {
136             &builder.config.llvm_experimental_targets[..]
137         };
138
139         let assertions = if builder.config.llvm_assertions {"ON"} else {"OFF"};
140
141         cfg.out_dir(&out_dir)
142            .profile(profile)
143            .define("LLVM_ENABLE_ASSERTIONS", assertions)
144            .define("LLVM_TARGETS_TO_BUILD", llvm_targets)
145            .define("LLVM_EXPERIMENTAL_TARGETS_TO_BUILD", llvm_exp_targets)
146            .define("LLVM_INCLUDE_EXAMPLES", "OFF")
147            .define("LLVM_INCLUDE_TESTS", "OFF")
148            .define("LLVM_INCLUDE_DOCS", "OFF")
149            .define("LLVM_INCLUDE_BENCHMARKS", "OFF")
150            .define("LLVM_ENABLE_ZLIB", "OFF")
151            .define("WITH_POLLY", "OFF")
152            .define("LLVM_ENABLE_TERMINFO", "OFF")
153            .define("LLVM_ENABLE_LIBEDIT", "OFF")
154            .define("LLVM_PARALLEL_COMPILE_JOBS", builder.jobs().to_string())
155            .define("LLVM_TARGET_ARCH", target.split('-').next().unwrap())
156            .define("LLVM_DEFAULT_TARGET_TRIPLE", target);
157
158         if builder.config.llvm_thin_lto && !emscripten {
159             cfg.define("LLVM_ENABLE_LTO", "Thin");
160             if !target.contains("apple") {
161                cfg.define("LLVM_ENABLE_LLD", "ON");
162             }
163         }
164
165         // By default, LLVM will automatically find OCaml and, if it finds it,
166         // install the LLVM bindings in LLVM_OCAML_INSTALL_PATH, which defaults
167         // to /usr/bin/ocaml.
168         // This causes problem for non-root builds of Rust. Side-step the issue
169         // by setting LLVM_OCAML_INSTALL_PATH to a relative path, so it installs
170         // in the prefix.
171         cfg.define("LLVM_OCAML_INSTALL_PATH",
172             env::var_os("LLVM_OCAML_INSTALL_PATH").unwrap_or_else(|| "usr/lib/ocaml".into()));
173
174         let want_lldb = builder.config.lldb_enabled && !self.emscripten;
175
176         // This setting makes the LLVM tools link to the dynamic LLVM library,
177         // which saves both memory during parallel links and overall disk space
178         // for the tools. We don't do this on every platform as it doesn't work
179         // equally well everywhere.
180         if builder.llvm_link_tools_dynamically(target) && !emscripten {
181             cfg.define("LLVM_LINK_LLVM_DYLIB", "ON");
182         }
183
184         // For distribution we want the LLVM tools to be *statically* linked to libstdc++
185         if builder.config.llvm_tools_enabled || want_lldb {
186             if !target.contains("windows") {
187                 if target.contains("apple") {
188                     cfg.define("CMAKE_EXE_LINKER_FLAGS", "-static-libstdc++");
189                 } else {
190                     cfg.define("CMAKE_EXE_LINKER_FLAGS", "-Wl,-Bsymbolic -static-libstdc++");
191                 }
192             }
193         }
194
195         if target.contains("msvc") {
196             cfg.define("LLVM_USE_CRT_DEBUG", "MT");
197             cfg.define("LLVM_USE_CRT_RELEASE", "MT");
198             cfg.define("LLVM_USE_CRT_RELWITHDEBINFO", "MT");
199             cfg.static_crt(true);
200         }
201
202         if target.starts_with("i686") {
203             cfg.define("LLVM_BUILD_32_BITS", "ON");
204         }
205
206         let mut enabled_llvm_projects = Vec::new();
207
208         if util::forcing_clang_based_tests() {
209             enabled_llvm_projects.push("clang");
210             enabled_llvm_projects.push("compiler-rt");
211         }
212
213         if want_lldb {
214             enabled_llvm_projects.push("clang");
215             enabled_llvm_projects.push("lldb");
216             // For the time being, disable code signing.
217             cfg.define("LLDB_CODESIGN_IDENTITY", "");
218             cfg.define("LLDB_NO_DEBUGSERVER", "ON");
219         } else {
220             // LLDB requires libxml2; but otherwise we want it to be disabled.
221             // See https://github.com/rust-lang/rust/pull/50104
222             cfg.define("LLVM_ENABLE_LIBXML2", "OFF");
223         }
224
225         if enabled_llvm_projects.len() > 0 {
226             enabled_llvm_projects.sort();
227             enabled_llvm_projects.dedup();
228             cfg.define("LLVM_ENABLE_PROJECTS", enabled_llvm_projects.join(";"));
229         }
230
231         if let Some(num_linkers) = builder.config.llvm_link_jobs {
232             if num_linkers > 0 {
233                 cfg.define("LLVM_PARALLEL_LINK_JOBS", num_linkers.to_string());
234             }
235         }
236
237         // http://llvm.org/docs/HowToCrossCompileLLVM.html
238         if target != builder.config.build && !emscripten {
239             builder.ensure(Llvm {
240                 target: builder.config.build,
241                 emscripten: false,
242             });
243             // FIXME: if the llvm root for the build triple is overridden then we
244             //        should use llvm-tblgen from there, also should verify that it
245             //        actually exists most of the time in normal installs of LLVM.
246             let host = builder.llvm_out(builder.config.build).join("bin/llvm-tblgen");
247             cfg.define("CMAKE_CROSSCOMPILING", "True")
248                .define("LLVM_TABLEGEN", &host);
249
250             if target.contains("netbsd") {
251                cfg.define("CMAKE_SYSTEM_NAME", "NetBSD");
252             } else if target.contains("freebsd") {
253                cfg.define("CMAKE_SYSTEM_NAME", "FreeBSD");
254             }
255
256             cfg.define("LLVM_NATIVE_BUILD", builder.llvm_out(builder.config.build).join("build"));
257         }
258
259         if let Some(ref suffix) = builder.config.llvm_version_suffix {
260             // Allow version-suffix="" to not define a version suffix at all.
261             if !suffix.is_empty() {
262                 cfg.define("LLVM_VERSION_SUFFIX", suffix);
263             }
264         } else {
265             let mut default_suffix = format!(
266                 "-rust-{}-{}",
267                 channel::CFG_RELEASE_NUM,
268                 builder.config.channel,
269             );
270             if let Some(sha) = llvm_info.sha_short() {
271                 default_suffix.push_str("-");
272                 default_suffix.push_str(sha);
273             }
274             cfg.define("LLVM_VERSION_SUFFIX", default_suffix);
275         }
276
277         if let Some(ref linker) = builder.config.llvm_use_linker {
278             cfg.define("LLVM_USE_LINKER", linker);
279         }
280
281         if let Some(true) = builder.config.llvm_allow_old_toolchain {
282             cfg.define("LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN", "YES");
283         }
284
285         if let Some(ref python) = builder.config.python {
286             cfg.define("PYTHON_EXECUTABLE", python);
287         }
288
289         configure_cmake(builder, target, &mut cfg);
290
291         // FIXME: we don't actually need to build all LLVM tools and all LLVM
292         //        libraries here, e.g., we just want a few components and a few
293         //        tools. Figure out how to filter them down and only build the right
294         //        tools and libs on all platforms.
295
296         if builder.config.dry_run {
297             return build_llvm_config;
298         }
299
300         cfg.build();
301
302         if let Some(llvm_commit) = llvm_info.sha() {
303             t!(fs::write(&done_stamp, llvm_commit));
304         }
305
306         build_llvm_config
307     }
308 }
309
310 fn check_llvm_version(builder: &Builder<'_>, llvm_config: &Path) {
311     if !builder.config.llvm_version_check {
312         return
313     }
314
315     if builder.config.dry_run {
316         return;
317     }
318
319     let mut cmd = Command::new(llvm_config);
320     let version = output(cmd.arg("--version"));
321     let mut parts = version.split('.').take(2)
322         .filter_map(|s| s.parse::<u32>().ok());
323     if let (Some(major), Some(_minor)) = (parts.next(), parts.next()) {
324         if major >= 6 {
325             return
326         }
327     }
328     panic!("\n\nbad LLVM version: {}, need >=6.0\n\n", version)
329 }
330
331 fn configure_cmake(builder: &Builder<'_>,
332                    target: Interned<String>,
333                    cfg: &mut cmake::Config) {
334     // Do not print installation messages for up-to-date files.
335     // LLVM and LLD builds can produce a lot of those and hit CI limits on log size.
336     cfg.define("CMAKE_INSTALL_MESSAGE", "LAZY");
337
338     if builder.config.ninja {
339         cfg.generator("Ninja");
340     }
341     cfg.target(&target)
342        .host(&builder.config.build);
343
344     let sanitize_cc = |cc: &Path| {
345         if target.contains("msvc") {
346             OsString::from(cc.to_str().unwrap().replace("\\", "/"))
347         } else {
348             cc.as_os_str().to_owned()
349         }
350     };
351
352     // MSVC with CMake uses msbuild by default which doesn't respect these
353     // vars that we'd otherwise configure. In that case we just skip this
354     // entirely.
355     if target.contains("msvc") && !builder.config.ninja {
356         return
357     }
358
359     let (cc, cxx) = match builder.config.llvm_clang_cl {
360         Some(ref cl) => (cl.as_ref(), cl.as_ref()),
361         None => (builder.cc(target), builder.cxx(target).unwrap()),
362     };
363
364     // Handle msvc + ninja + ccache specially (this is what the bots use)
365     if target.contains("msvc") &&
366        builder.config.ninja &&
367        builder.config.ccache.is_some()
368     {
369        let mut wrap_cc = env::current_exe().expect("failed to get cwd");
370        wrap_cc.set_file_name("sccache-plus-cl.exe");
371
372        cfg.define("CMAKE_C_COMPILER", sanitize_cc(&wrap_cc))
373           .define("CMAKE_CXX_COMPILER", sanitize_cc(&wrap_cc));
374        cfg.env("SCCACHE_PATH",
375                builder.config.ccache.as_ref().unwrap())
376           .env("SCCACHE_TARGET", target)
377           .env("SCCACHE_CC", &cc)
378           .env("SCCACHE_CXX", &cxx);
379
380        // Building LLVM on MSVC can be a little ludicrous at times. We're so far
381        // off the beaten path here that I'm not really sure this is even half
382        // supported any more. Here we're trying to:
383        //
384        // * Build LLVM on MSVC
385        // * Build LLVM with `clang-cl` instead of `cl.exe`
386        // * Build a project with `sccache`
387        // * Build for 32-bit as well
388        // * Build with Ninja
389        //
390        // For `cl.exe` there are different binaries to compile 32/64 bit which
391        // we use but for `clang-cl` there's only one which internally
392        // multiplexes via flags. As a result it appears that CMake's detection
393        // of a compiler's architecture and such on MSVC **doesn't** pass any
394        // custom flags we pass in CMAKE_CXX_FLAGS below. This means that if we
395        // use `clang-cl.exe` it's always diagnosed as a 64-bit compiler which
396        // definitely causes problems since all the env vars are pointing to
397        // 32-bit libraries.
398        //
399        // To hack around this... again... we pass an argument that's
400        // unconditionally passed in the sccache shim. This'll get CMake to
401        // correctly diagnose it's doing a 32-bit compilation and LLVM will
402        // internally configure itself appropriately.
403        if builder.config.llvm_clang_cl.is_some() && target.contains("i686") {
404            cfg.env("SCCACHE_EXTRA_ARGS", "-m32");
405        }
406     } else {
407        // If ccache is configured we inform the build a little differently how
408        // to invoke ccache while also invoking our compilers.
409        if let Some(ref ccache) = builder.config.ccache {
410          cfg.define("CMAKE_C_COMPILER_LAUNCHER", ccache)
411             .define("CMAKE_CXX_COMPILER_LAUNCHER", ccache);
412        }
413        cfg.define("CMAKE_C_COMPILER", sanitize_cc(cc))
414           .define("CMAKE_CXX_COMPILER", sanitize_cc(cxx));
415     }
416
417     cfg.build_arg("-j").build_arg(builder.jobs().to_string());
418     let mut cflags = builder.cflags(target, GitRepo::Llvm).join(" ");
419     if let Some(ref s) = builder.config.llvm_cxxflags {
420         cflags.push_str(&format!(" {}", s));
421     }
422     cfg.define("CMAKE_C_FLAGS", cflags);
423     let mut cxxflags = builder.cflags(target, GitRepo::Llvm).join(" ");
424     if builder.config.llvm_static_stdcpp &&
425         !target.contains("windows") &&
426         !target.contains("netbsd")
427     {
428         cxxflags.push_str(" -static-libstdc++");
429     }
430     if let Some(ref s) = builder.config.llvm_cxxflags {
431         cxxflags.push_str(&format!(" {}", s));
432     }
433     cfg.define("CMAKE_CXX_FLAGS", cxxflags);
434     if let Some(ar) = builder.ar(target) {
435         if ar.is_absolute() {
436             // LLVM build breaks if `CMAKE_AR` is a relative path, for some reason it
437             // tries to resolve this path in the LLVM build directory.
438             cfg.define("CMAKE_AR", sanitize_cc(ar));
439         }
440     }
441
442     if let Some(ranlib) = builder.ranlib(target) {
443         if ranlib.is_absolute() {
444             // LLVM build breaks if `CMAKE_RANLIB` is a relative path, for some reason it
445             // tries to resolve this path in the LLVM build directory.
446             cfg.define("CMAKE_RANLIB", sanitize_cc(ranlib));
447         }
448     }
449
450     if let Some(ref s) = builder.config.llvm_ldflags {
451         cfg.define("CMAKE_SHARED_LINKER_FLAGS", s);
452         cfg.define("CMAKE_MODULE_LINKER_FLAGS", s);
453         cfg.define("CMAKE_EXE_LINKER_FLAGS", s);
454     }
455
456     if env::var_os("SCCACHE_ERROR_LOG").is_some() {
457         cfg.env("RUSTC_LOG", "sccache=warn");
458     }
459 }
460
461 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
462 pub struct Lld {
463     pub target: Interned<String>,
464 }
465
466 impl Step for Lld {
467     type Output = PathBuf;
468     const ONLY_HOSTS: bool = true;
469
470     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
471         run.path("src/llvm-project/lld").path("src/tools/lld")
472     }
473
474     fn make_run(run: RunConfig<'_>) {
475         run.builder.ensure(Lld { target: run.target });
476     }
477
478     /// Compile LLVM for `target`.
479     fn run(self, builder: &Builder<'_>) -> PathBuf {
480         if builder.config.dry_run {
481             return PathBuf::from("lld-out-dir-test-gen");
482         }
483         let target = self.target;
484
485         let llvm_config = builder.ensure(Llvm {
486             target: self.target,
487             emscripten: false,
488         });
489
490         let out_dir = builder.lld_out(target);
491         let done_stamp = out_dir.join("lld-finished-building");
492         if done_stamp.exists() {
493             return out_dir
494         }
495
496         let _folder = builder.fold_output(|| "lld");
497         builder.info(&format!("Building LLD for {}", target));
498         let _time = util::timeit(&builder);
499         t!(fs::create_dir_all(&out_dir));
500
501         let mut cfg = cmake::Config::new(builder.src.join("src/llvm-project/lld"));
502         configure_cmake(builder, target, &mut cfg);
503
504         // This is an awful, awful hack. Discovered when we migrated to using
505         // clang-cl to compile LLVM/LLD it turns out that LLD, when built out of
506         // tree, will execute `llvm-config --cmakedir` and then tell CMake about
507         // that directory for later processing. Unfortunately if this path has
508         // forward slashes in it (which it basically always does on Windows)
509         // then CMake will hit a syntax error later on as... something isn't
510         // escaped it seems?
511         //
512         // Instead of attempting to fix this problem in upstream CMake and/or
513         // LLVM/LLD we just hack around it here. This thin wrapper will take the
514         // output from llvm-config and replace all instances of `\` with `/` to
515         // ensure we don't hit the same bugs with escaping. It means that you
516         // can't build on a system where your paths require `\` on Windows, but
517         // there's probably a lot of reasons you can't do that other than this.
518         let llvm_config_shim = env::current_exe()
519             .unwrap()
520             .with_file_name("llvm-config-wrapper");
521         cfg.out_dir(&out_dir)
522            .profile("Release")
523            .env("LLVM_CONFIG_REAL", llvm_config)
524            .define("LLVM_CONFIG_PATH", llvm_config_shim)
525            .define("LLVM_INCLUDE_TESTS", "OFF");
526
527         cfg.build();
528
529         t!(File::create(&done_stamp));
530         out_dir
531     }
532 }
533
534 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
535 pub struct TestHelpers {
536     pub target: Interned<String>,
537 }
538
539 impl Step for TestHelpers {
540     type Output = ();
541
542     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
543         run.path("src/test/auxiliary/rust_test_helpers.c")
544     }
545
546     fn make_run(run: RunConfig<'_>) {
547         run.builder.ensure(TestHelpers { target: run.target })
548     }
549
550     /// Compiles the `rust_test_helpers.c` library which we used in various
551     /// `run-pass` test suites for ABI testing.
552     fn run(self, builder: &Builder<'_>) {
553         if builder.config.dry_run {
554             return;
555         }
556         let target = self.target;
557         let dst = builder.test_helpers_out(target);
558         let src = builder.src.join("src/test/auxiliary/rust_test_helpers.c");
559         if up_to_date(&src, &dst.join("librust_test_helpers.a")) {
560             return
561         }
562
563         let _folder = builder.fold_output(|| "build_test_helpers");
564         builder.info("Building test helpers");
565         t!(fs::create_dir_all(&dst));
566         let mut cfg = cc::Build::new();
567
568         // We may have found various cross-compilers a little differently due to our
569         // extra configuration, so inform gcc of these compilers. Note, though, that
570         // on MSVC we still need gcc's detection of env vars (ugh).
571         if !target.contains("msvc") {
572             if let Some(ar) = builder.ar(target) {
573                 cfg.archiver(ar);
574             }
575             cfg.compiler(builder.cc(target));
576         }
577
578         cfg.cargo_metadata(false)
579            .out_dir(&dst)
580            .target(&target)
581            .host(&builder.config.build)
582            .opt_level(0)
583            .warnings(false)
584            .debug(false)
585            .file(builder.src.join("src/test/auxiliary/rust_test_helpers.c"))
586            .compile("rust_test_helpers");
587     }
588 }