]> git.lizzy.rs Git - rust.git/blob - src/librustc_llvm/build.rs
rustbuild: allow dynamically linking LLVM
[rust.git] / src / librustc_llvm / build.rs
1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 extern crate gcc;
12 extern crate build_helper;
13
14 use std::process::Command;
15 use std::env;
16 use std::path::{PathBuf, Path};
17
18 use build_helper::output;
19
20 fn main() {
21     println!("cargo:rustc-cfg=cargobuild");
22
23     let target = env::var("TARGET").expect("TARGET was not set");
24     let llvm_config = env::var_os("LLVM_CONFIG")
25         .map(PathBuf::from)
26         .unwrap_or_else(|| {
27             if let Some(dir) = env::var_os("CARGO_TARGET_DIR").map(PathBuf::from) {
28                 let to_test = dir.parent()
29                     .unwrap()
30                     .parent()
31                     .unwrap()
32                     .join(&target)
33                     .join("llvm/bin/llvm-config");
34                 if Command::new(&to_test).output().is_ok() {
35                     return to_test;
36                 }
37             }
38             PathBuf::from("llvm-config")
39         });
40
41     println!("cargo:rerun-if-changed={}", llvm_config.display());
42
43     // Test whether we're cross-compiling LLVM. This is a pretty rare case
44     // currently where we're producing an LLVM for a different platform than
45     // what this build script is currently running on.
46     //
47     // In that case, there's no guarantee that we can actually run the target,
48     // so the build system works around this by giving us the LLVM_CONFIG for
49     // the host platform. This only really works if the host LLVM and target
50     // LLVM are compiled the same way, but for us that's typically the case.
51     //
52     // We *want* detect this cross compiling situation by asking llvm-config
53     // what it's host-target is. If that's not the TARGET, then we're cross
54     // compiling. Unfortunately `llvm-config` seems either be buggy, or we're
55     // misconfiguring it, because the `i686-pc-windows-gnu` build of LLVM will
56     // report itself with a `--host-target` of `x86_64-pc-windows-gnu`. This
57     // tricks us into thinking we're doing a cross build when we aren't, so
58     // havoc ensues.
59     //
60     // In any case, if we're cross compiling, this generally just means that we
61     // can't trust all the output of llvm-config becaues it might be targeted
62     // for the host rather than the target. As a result a bunch of blocks below
63     // are gated on `if !is_crossed`
64     let target = env::var("TARGET").expect("TARGET was not set");
65     let host = env::var("HOST").expect("HOST was not set");
66     let is_crossed = target != host;
67
68     let optional_components =
69         ["x86", "arm", "aarch64", "mips", "powerpc", "pnacl", "systemz", "jsbackend", "msp430"];
70
71     // FIXME: surely we don't need all these components, right? Stuff like mcjit
72     //        or interpreter the compiler itself never uses.
73     let required_components = &["ipo",
74                                 "bitreader",
75                                 "bitwriter",
76                                 "linker",
77                                 "asmparser",
78                                 "mcjit",
79                                 "interpreter",
80                                 "instrumentation"];
81
82     let components = output(Command::new(&llvm_config).arg("--components"));
83     let mut components = components.split_whitespace().collect::<Vec<_>>();
84     components.retain(|c| optional_components.contains(c) || required_components.contains(c));
85
86     for component in required_components {
87         if !components.contains(component) {
88             panic!("require llvm component {} but wasn't found", component);
89         }
90     }
91
92     for component in components.iter() {
93         println!("cargo:rustc-cfg=llvm_component=\"{}\"", component);
94     }
95
96     // Link in our own LLVM shims, compiled with the same flags as LLVM
97     let mut cmd = Command::new(&llvm_config);
98     cmd.arg("--cxxflags");
99     let cxxflags = output(&mut cmd);
100     let mut cfg = gcc::Config::new();
101     for flag in cxxflags.split_whitespace() {
102         // Ignore flags like `-m64` when we're doing a cross build
103         if is_crossed && flag.starts_with("-m") {
104             continue;
105         }
106         cfg.flag(flag);
107     }
108
109     for component in &components[..] {
110         let mut flag = String::from("-DLLVM_COMPONENT_");
111         flag.push_str(&component.to_uppercase());
112         cfg.flag(&flag);
113     }
114
115     if env::var_os("LLVM_RUSTLLVM").is_some() {
116         cfg.flag("-DLLVM_RUSTLLVM");
117     }
118
119     cfg.file("../rustllvm/PassWrapper.cpp")
120        .file("../rustllvm/RustWrapper.cpp")
121        .file("../rustllvm/ArchiveWrapper.cpp")
122        .cpp(true)
123        .cpp_link_stdlib(None) // we handle this below
124        .compile("librustllvm.a");
125
126     // Find out LLVM's default linking mode.
127     let mut cmd = Command::new(&llvm_config);
128     cmd.arg("--shared-mode");
129     let mut llvm_kind = if output(&mut cmd).trim() == "shared" {
130         "dylib"
131     } else {
132         "static"
133     };
134
135     // Link in all LLVM libraries, if we're uwring the "wrong" llvm-config then
136     // we don't pick up system libs because unfortunately they're for the host
137     // of llvm-config, not the target that we're attempting to link.
138     let mut cmd = Command::new(&llvm_config);
139     cmd.arg("--libs");
140
141     // Force static linking with "--link-static" if available, or
142     // force "--link-shared" if the configuration requested it.
143     let llvm_link_shared = env::var_os("LLVM_LINK_SHARED").is_some();
144     let mut version_cmd = Command::new(&llvm_config);
145     version_cmd.arg("--version");
146     let version_output = output(&mut version_cmd);
147     let mut parts = version_output.split('.');
148     if let (Some(major), Some(minor)) = (parts.next().and_then(|s| s.parse::<u32>().ok()),
149                                          parts.next().and_then(|s| s.parse::<u32>().ok())) {
150         if major > 3 || (major == 3 && minor >= 9) {
151             if llvm_link_shared {
152                 cmd.arg("--link-shared");
153                 llvm_kind = "dylib";
154             } else {
155                 cmd.arg("--link-static");
156                 llvm_kind = "static";
157             }
158         }
159     }
160
161     if !is_crossed {
162         cmd.arg("--system-libs");
163     }
164     cmd.args(&components[..]);
165
166     for lib in output(&mut cmd).split_whitespace() {
167         let name = if lib.starts_with("-l") {
168             &lib[2..]
169         } else if lib.starts_with("-") {
170             &lib[1..]
171         } else if Path::new(lib).exists() {
172             // On MSVC llvm-config will print the full name to libraries, but
173             // we're only interested in the name part
174             let name = Path::new(lib).file_name().unwrap().to_str().unwrap();
175             name.trim_right_matches(".lib")
176         } else if lib.ends_with(".lib") {
177             // Some MSVC libraries just come up with `.lib` tacked on, so chop
178             // that off
179             lib.trim_right_matches(".lib")
180         } else {
181             continue;
182         };
183
184         // Don't need or want this library, but LLVM's CMake build system
185         // doesn't provide a way to disable it, so filter it here even though we
186         // may or may not have built it. We don't reference anything from this
187         // library and it otherwise may just pull in extra dependencies on
188         // libedit which we don't want
189         if name == "LLVMLineEditor" {
190             continue;
191         }
192
193         let kind = if name.starts_with("LLVM") {
194             llvm_kind
195         } else {
196             "dylib"
197         };
198         println!("cargo:rustc-link-lib={}={}", kind, name);
199     }
200
201     // LLVM ldflags
202     //
203     // If we're a cross-compile of LLVM then unfortunately we can't trust these
204     // ldflags (largely where all the LLVM libs are located). Currently just
205     // hack around this by replacing the host triple with the target and pray
206     // that those -L directories are the same!
207     let mut cmd = Command::new(&llvm_config);
208     cmd.arg("--ldflags");
209     for lib in output(&mut cmd).split_whitespace() {
210         if lib.starts_with("-LIBPATH:") {
211             println!("cargo:rustc-link-search=native={}", &lib[9..]);
212         } else if is_crossed {
213             if lib.starts_with("-L") {
214                 println!("cargo:rustc-link-search=native={}",
215                          lib[2..].replace(&host, &target));
216             }
217         } else if lib.starts_with("-l") {
218             println!("cargo:rustc-link-lib={}", &lib[2..]);
219         } else if lib.starts_with("-L") {
220             println!("cargo:rustc-link-search=native={}", &lib[2..]);
221         }
222     }
223
224     // C++ runtime library
225     if !target.contains("msvc") {
226         if let Some(s) = env::var_os("LLVM_STATIC_STDCPP") {
227             assert!(!cxxflags.contains("stdlib=libc++"));
228             let path = PathBuf::from(s);
229             println!("cargo:rustc-link-search=native={}",
230                      path.parent().unwrap().display());
231             println!("cargo:rustc-link-lib=static=stdc++");
232         } else if cxxflags.contains("stdlib=libc++") {
233             println!("cargo:rustc-link-lib=c++");
234         } else {
235             println!("cargo:rustc-link-lib=stdc++");
236         }
237     }
238 }