Skip to content

Commit

Permalink
auto merge of #13857 : alexcrichton/rust/add-dylib-paths, r=brson
Browse files Browse the repository at this point in the history
When a syntax extension is loaded by the compiler, the dylib that is opened may
have other dylibs that it depends on. The dynamic linker must be able to find
these libraries on the system or else the library will fail to load.

Currently, unix gets by with the use of rpaths. This relies on the dylib not
moving around too drastically relative to its dependencies. For windows,
however, this is no rpath available, and in theory unix should work without
rpaths as well.

This modifies the compiler to add all -L search directories to the dynamic
linker's set of load paths. This is currently managed through environment
variables for each platform.

Closes #13848
  • Loading branch information
bors committed Apr 30, 2014
2 parents cbf1131 + 1a367c6 commit f77784b
Show file tree
Hide file tree
Showing 7 changed files with 114 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/liblibc/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ pub use funcs::bsd43::{shutdown};
#[cfg(windows)] pub use types::os::arch::extra::{HANDLE, BOOL, LPSECURITY_ATTRIBUTES};
#[cfg(windows)] pub use types::os::arch::extra::{LPCSTR, WORD, DWORD, BYTE, FILETIME};
#[cfg(windows)] pub use types::os::arch::extra::{LARGE_INTEGER, LPVOID, LONG};
#[cfg(windows)] pub use types::os::arch::extra::{time64_t, OVERLAPPED};
#[cfg(windows)] pub use types::os::arch::extra::{time64_t, OVERLAPPED, LPCWSTR};
#[cfg(windows)] pub use types::os::arch::extra::{LPOVERLAPPED, SIZE_T, LPDWORD};
#[cfg(windows)] pub use funcs::c95::string::{wcslen};
#[cfg(windows)] pub use funcs::posix88::stat_::{wstat, wutime, wchmod, wrmdir};
Expand Down
8 changes: 8 additions & 0 deletions src/librustc/driver/driver.rs
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,14 @@ pub fn phase_2_configure_and_expand(sess: &Session,
front::config::strip_unconfigured_items(krate));

krate = time(time_passes, "expansion", krate, |krate| {
// Windows dlls do not have rpaths, so they don't know how to find their
// dependencies. It's up to use to tell the system where to find all the
// dependent dlls. Note that this uses cfg!(windows) as opposed to
// targ_cfg because syntax extensions are always loaded for the host
// compiler, not for the target.
if cfg!(windows) {
sess.host_filesearch().add_dylib_search_paths();
}
let cfg = syntax::ext::expand::ExpansionConfig {
loader: loader,
deriving_hash_type_parameter: sess.features.default_type_params.get(),
Expand Down
8 changes: 8 additions & 0 deletions src/librustc/metadata/filesearch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use std::cell::RefCell;
use std::os;
use std::io::fs;
use std::unstable::dynamic_lib::DynamicLibrary;
use collections::HashSet;

use myfs = util::fs;
Expand Down Expand Up @@ -132,6 +133,13 @@ impl<'a> FileSearch<'a> {
triple: triple,
}
}

pub fn add_dylib_search_paths(&self) {
self.for_each_lib_search_path(|lib_search_path| {
DynamicLibrary::add_search_path(lib_search_path);
FileDoesntMatch
})
}
}

pub fn relative_target_lib_path(sysroot: &Path, target_triple: &str) -> Path {
Expand Down
21 changes: 19 additions & 2 deletions src/libstd/unstable/dynamic_lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ Dynamic library facilities.
A simple wrapper over the platform's dynamic library facilities
*/

use c_str::ToCStr;
use cast;
use path;
use ops::*;
use option::*;
use os;
use path::GenericPath;
use path;
use result::*;
use str;

pub struct DynamicLibrary { handle: *u8}

Expand Down Expand Up @@ -59,6 +63,20 @@ impl DynamicLibrary {
}
}

/// Appends a path to the system search path for dynamic libraries
pub fn add_search_path(path: &path::Path) {
let (envvar, sep) = if cfg!(windows) {
("PATH", ';' as u8)
} else if cfg!(target_os = "macos") {
("DYLD_LIBRARY_PATH", ':' as u8)
} else {
("LD_LIBRARY_PATH", ':' as u8)
};
let newenv = os::getenv_as_bytes(envvar).unwrap_or(~[]);
let newenv = newenv + &[sep] + path.as_vec();
os::setenv(envvar, str::from_utf8(newenv).unwrap());
}

/// Access the value at the symbol of the dynamic library
pub unsafe fn symbol<T>(&self, symbol: &str) -> Result<T, ~str> {
// This function should have a lifetime constraint of 'a on
Expand Down Expand Up @@ -237,7 +255,6 @@ pub mod dl {
FreeLibrary(handle as *libc::c_void); ()
}

#[link_name = "kernel32"]
extern "system" {
fn SetLastError(error: libc::size_t);
fn LoadLibraryW(name: *libc::c_void) -> *libc::c_void;
Expand Down
18 changes: 18 additions & 0 deletions src/test/auxiliary/syntax-extension-with-dll-deps-1.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// no-prefer-dynamic
// force-host

#![crate_type = "dylib"]

pub fn the_answer() -> int {
2
}
38 changes: 38 additions & 0 deletions src/test/auxiliary/syntax-extension-with-dll-deps-2.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// force-host
// no-prefer-dynamic

#![crate_type = "dylib"]
#![feature(macro_registrar, quote, globs)]

extern crate other = "syntax-extension-with-dll-deps-1";
extern crate syntax;

use syntax::ast::{Name, TokenTree, Item, MetaItem};
use syntax::codemap::Span;
use syntax::ext::base::*;
use syntax::parse::token;

#[macro_registrar]
pub fn macro_registrar(register: |Name, SyntaxExtension|) {
register(token::intern("foo"),
NormalTT(~BasicMacroExpander {
expander: expand_foo,
span: None,
},
None));
}

fn expand_foo(cx: &mut ExtCtxt, sp: Span, tts: &[TokenTree]) -> ~MacResult {
let answer = other::the_answer();
MacExpr::new(quote_expr!(cx, $answer))
}
22 changes: 22 additions & 0 deletions src/test/run-pass-fulldeps/syntax-extension-with-dll-deps.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// aux-build:syntax-extension-with-dll-deps-1.rs
// aux-build:syntax-extension-with-dll-deps-2.rs
// ignore-stage1

#![feature(phase)]

#[phase(syntax)]
extern crate extension = "syntax-extension-with-dll-deps-2";

fn main() {
foo!();
}

0 comments on commit f77784b

Please sign in to comment.