1 use rustc_attr as attr;
2 use rustc_data_structures::fx::FxHashSet;
3 use rustc_errors::struct_span_err;
5 use rustc_hir::itemlikevisit::ItemLikeVisitor;
6 use rustc_middle::middle::cstore::{self, NativeLibrary};
7 use rustc_middle::ty::TyCtxt;
8 use rustc_session::parse::feature_err;
9 use rustc_session::Session;
10 use rustc_span::source_map::Span;
11 use rustc_span::symbol::{kw, sym, Symbol};
12 use rustc_target::spec::abi::Abi;
14 crate fn collect(tcx: TyCtxt<'_>) -> Vec<NativeLibrary> {
15 let mut collector = Collector { tcx, libs: Vec::new() };
16 tcx.hir().krate().visit_all_item_likes(&mut collector);
17 collector.process_command_line();
21 crate fn relevant_lib(sess: &Session, lib: &NativeLibrary) -> bool {
23 Some(ref cfg) => attr::cfg_matches(cfg, &sess.parse_sess, None),
28 struct Collector<'tcx> {
30 libs: Vec<NativeLibrary>,
33 impl ItemLikeVisitor<'tcx> for Collector<'tcx> {
34 fn visit_item(&mut self, it: &'tcx hir::Item<'tcx>) {
35 let fm = match it.kind {
36 hir::ItemKind::ForeignMod(ref fm) => fm,
40 if fm.abi == Abi::Rust || fm.abi == Abi::RustIntrinsic || fm.abi == Abi::PlatformIntrinsic {
44 // Process all of the #[link(..)]-style arguments
45 for m in it.attrs.iter().filter(|a| a.check_name(sym::link)) {
46 let items = match m.meta_item_list() {
50 let mut lib = NativeLibrary {
52 kind: cstore::NativeUnknown,
54 foreign_module: Some(self.tcx.hir().local_def_id(it.hir_id).to_def_id()),
55 wasm_import_module: None,
57 let mut kind_specified = false;
59 for item in items.iter() {
60 if item.check_name(sym::kind) {
61 kind_specified = true;
62 let kind = match item.value_str() {
64 None => continue, // skip like historical compilers
66 lib.kind = match &*kind.as_str() {
67 "static" => cstore::NativeStatic,
68 "static-nobundle" => cstore::NativeStaticNobundle,
69 "dylib" => cstore::NativeUnknown,
70 "framework" => cstore::NativeFramework,
71 "raw-dylib" => cstore::NativeRawDylib,
80 .span_label(item.span(), "unknown kind")
81 .span_label(m.span, "")
86 } else if item.check_name(sym::name) {
87 lib.name = item.value_str();
88 } else if item.check_name(sym::cfg) {
89 let cfg = match item.meta_item_list() {
91 None => continue, // skip like historical compilers
94 self.tcx.sess.span_err(item.span(), "`cfg()` must have an argument");
95 } else if let cfg @ Some(..) = cfg[0].meta_item() {
96 lib.cfg = cfg.cloned();
98 self.tcx.sess.span_err(cfg[0].span(), "invalid argument for `cfg(..)`");
100 } else if item.check_name(sym::wasm_import_module) {
101 match item.value_str() {
102 Some(s) => lib.wasm_import_module = Some(s),
104 let msg = "must be of the form `#[link(wasm_import_module = \"...\")]`";
105 self.tcx.sess.span_err(item.span(), msg);
109 // currently, like past compilers, ignore unknown
114 // In general we require #[link(name = "...")] but we allow
115 // #[link(wasm_import_module = "...")] without the `name`.
116 let requires_name = kind_specified || lib.wasm_import_module.is_none();
117 if lib.name.is_none() && requires_name {
122 "`#[link(...)]` specified without \
125 .span_label(m.span, "missing `name` argument")
128 self.register_native_lib(Some(m.span), lib);
132 fn visit_trait_item(&mut self, _it: &'tcx hir::TraitItem<'tcx>) {}
133 fn visit_impl_item(&mut self, _it: &'tcx hir::ImplItem<'tcx>) {}
136 impl Collector<'tcx> {
137 fn register_native_lib(&mut self, span: Option<Span>, lib: NativeLibrary) {
138 if lib.name.as_ref().map(|&s| s == kw::Invalid).unwrap_or(false) {
145 "`#[link(name = \"\")]` given with empty name"
147 .span_label(span, "empty name given")
151 self.tcx.sess.err("empty library name given via `-l`");
156 let is_osx = self.tcx.sess.target.target.options.is_like_osx;
157 if lib.kind == cstore::NativeFramework && !is_osx {
158 let msg = "native frameworks are only available on macOS targets";
160 Some(span) => struct_span_err!(self.tcx.sess, span, E0455, "{}", msg).emit(),
161 None => self.tcx.sess.err(msg),
164 if lib.cfg.is_some() && !self.tcx.features().link_cfg {
166 &self.tcx.sess.parse_sess,
169 "kind=\"link_cfg\" is unstable",
173 if lib.kind == cstore::NativeStaticNobundle && !self.tcx.features().static_nobundle {
175 &self.tcx.sess.parse_sess,
176 sym::static_nobundle,
177 span.unwrap_or_else(|| rustc_span::DUMMY_SP),
178 "kind=\"static-nobundle\" is unstable",
182 if lib.kind == cstore::NativeRawDylib && !self.tcx.features().raw_dylib {
184 &self.tcx.sess.parse_sess,
186 span.unwrap_or_else(|| rustc_span::DUMMY_SP),
187 "kind=\"raw-dylib\" is unstable",
194 // Process libs passed on the command line
195 fn process_command_line(&mut self) {
196 // First, check for errors
197 let mut renames = FxHashSet::default();
198 for &(ref name, ref new_name, _) in &self.tcx.sess.opts.libs {
199 if let &Some(ref new_name) = new_name {
200 let any_duplicate = self
203 .filter_map(|lib| lib.name.as_ref())
204 .any(|n| n.as_str() == *name);
205 if new_name.is_empty() {
206 self.tcx.sess.err(&format!(
207 "an empty renaming target was specified for library `{}`",
210 } else if !any_duplicate {
211 self.tcx.sess.err(&format!(
212 "renaming of the library `{}` was specified, \
213 however this crate contains no `#[link(...)]` \
214 attributes referencing this library.",
217 } else if !renames.insert(name) {
218 self.tcx.sess.err(&format!(
219 "multiple renamings were \
220 specified for library `{}` .",
227 // Update kind and, optionally, the name of all native libraries
228 // (there may be more than one) with the specified name. If any
229 // library is mentioned more than once, keep the latest mention
230 // of it, so that any possible dependent libraries appear before
231 // it. (This ensures that the linker is able to see symbols from
232 // all possible dependent libraries before linking in the library
234 for &(ref name, ref new_name, kind) in &self.tcx.sess.opts.libs {
235 // If we've already added any native libraries with the same
236 // name, they will be pulled out into `existing`, so that we
237 // can move them to the end of the list below.
238 let mut existing = self
240 .drain_filter(|lib| {
241 if let Some(lib_name) = lib.name {
242 if lib_name.as_str() == *name {
243 if let Some(k) = kind {
246 if let &Some(ref new_name) = new_name {
247 lib.name = Some(Symbol::intern(new_name));
254 .collect::<Vec<_>>();
255 if existing.is_empty() {
257 let new_name = new_name.as_ref().map(|s| &**s); // &Option<String> -> Option<&str>
258 let lib = NativeLibrary {
259 name: Some(Symbol::intern(new_name.unwrap_or(name))),
260 kind: if let Some(k) = kind { k } else { cstore::NativeUnknown },
262 foreign_module: None,
263 wasm_import_module: None,
265 self.register_native_lib(None, lib);
267 // Move all existing libraries with the same name to the
268 // end of the command line.
269 self.libs.append(&mut existing);