From f7f121d60d0f6b8f280e09397b14a8afd0a369c1 Mon Sep 17 00:00:00 2001 From: Edwin Cheng Date: Sat, 4 Apr 2020 16:09:36 +0800 Subject: Add dylib loading code --- crates/ra_proc_macro_srv/src/dylib.rs | 220 ++++++++++++++++++++++++++++++++++ 1 file changed, 220 insertions(+) create mode 100644 crates/ra_proc_macro_srv/src/dylib.rs (limited to 'crates/ra_proc_macro_srv/src/dylib.rs') diff --git a/crates/ra_proc_macro_srv/src/dylib.rs b/crates/ra_proc_macro_srv/src/dylib.rs new file mode 100644 index 000000000..525c7ac7b --- /dev/null +++ b/crates/ra_proc_macro_srv/src/dylib.rs @@ -0,0 +1,220 @@ +//! Handles dynamic library loading for proc macro + +use crate::{proc_macro::bridge, rustc_server::TokenStream}; +use std::fs::File; +use std::io::Read; +use std::path::Path; + +use goblin::{mach::Mach, Object}; +use libloading::Library; +use ra_proc_macro::ProcMacroKind; + +static NEW_REGISTRAR_SYMBOL: &str = "__rustc_proc_macro_decls_"; +static _OLD_REGISTRAR_SYMBOL: &str = "__rustc_derive_registrar_"; + +fn read_bytes(file: &Path) -> Option> { + let mut fd = File::open(file).ok()?; + let mut buffer = Vec::new(); + fd.read_to_end(&mut buffer).ok()?; + + Some(buffer) +} + +fn get_symbols_from_lib(file: &Path) -> Option> { + let buffer = read_bytes(file)?; + let object = Object::parse(&buffer).ok()?; + + return match object { + Object::Elf(elf) => { + let symbols = elf.dynstrtab.to_vec().ok()?; + let names = symbols.iter().map(|s| s.to_string()).collect(); + + Some(names) + } + + Object::PE(pe) => { + let symbol_names = + pe.exports.iter().flat_map(|s| s.name).map(|n| n.to_string()).collect(); + Some(symbol_names) + } + + Object::Mach(mach) => match mach { + Mach::Binary(binary) => { + let exports = binary.exports().ok()?; + let names = exports.iter().map(|s| s.name.clone()).collect(); + + Some(names) + } + + Mach::Fat(_) => None, + }, + + Object::Archive(_) | Object::Unknown(_) => None, + }; +} + +fn is_derive_registrar_symbol(symbol: &str) -> bool { + symbol.contains(NEW_REGISTRAR_SYMBOL) +} + +fn find_registrar_symbol(file: &Path) -> Option { + let symbols = get_symbols_from_lib(file)?; + + symbols.iter().find(|s| is_derive_registrar_symbol(s)).map(|s| s.to_string()) +} + +/// Loads dynamic library in platform dependent manner. +/// +/// For unix, you have to use RTLD_DEEPBIND flag to escape problems described +/// [here](https://github.com/fedochet/rust-proc-macro-panic-inside-panic-expample) +/// and [here](https://github.com/rust-lang/rust/issues/60593). +/// +/// Usage of RTLD_DEEPBIND +/// [here](https://github.com/fedochet/rust-proc-macro-panic-inside-panic-expample/issues/1) +/// +/// It seems that on Windows that behaviour is default, so we do nothing in that case. +#[cfg(windows)] +fn load_library(file: &Path) -> Result { + Library::new(file) +} + +#[cfg(unix)] +fn load_library(file: &Path) -> Result { + use libloading::os::unix::Library as UnixLibrary; + use std::os::raw::c_int; + + const RTLD_NOW: c_int = 0x00002; + const RTLD_DEEPBIND: c_int = 0x00008; + + UnixLibrary::open(Some(file), RTLD_NOW | RTLD_DEEPBIND).map(|lib| lib.into()) +} + +struct ProcMacroLibraryLibloading { + // Hold the dylib to prevent it for unloadeding + #[allow(dead_code)] + lib: Library, + exported_macros: Vec, +} + +impl ProcMacroLibraryLibloading { + fn open(file: &Path) -> Result { + let symbol_name = find_registrar_symbol(file) + .ok_or(format!("Cannot find registrar symbol in file {:?}", file))?; + + let lib = load_library(file).map_err(|e| e.to_string())?; + + let exported_macros = { + let macros: libloading::Symbol<&&[bridge::client::ProcMacro]> = + unsafe { lib.get(symbol_name.as_bytes()) }.map_err(|e| e.to_string())?; + + macros.to_vec() + }; + + Ok(ProcMacroLibraryLibloading { lib, exported_macros }) + } +} + +type ProcMacroLibraryImpl = ProcMacroLibraryLibloading; + +pub struct Expander { + libs: Vec, +} + +impl Expander { + pub fn new>(lib: &P) -> Result { + let mut libs = vec![]; + + /* Some libraries for dynamic loading require canonicalized path (even when it is + already absolute + */ + let lib = + lib.as_ref().canonicalize().expect(&format!("Cannot canonicalize {:?}", lib.as_ref())); + + let library = ProcMacroLibraryImpl::open(&lib)?; + libs.push(library); + + Ok(Expander { libs }) + } + + pub fn expand( + &self, + macro_name: &str, + macro_body: &ra_tt::Subtree, + attributes: Option<&ra_tt::Subtree>, + ) -> Result { + let parsed_body = TokenStream::with_subtree(macro_body.clone()); + + let parsed_attributes = attributes + .map_or(crate::rustc_server::TokenStream::new(), |attr| { + TokenStream::with_subtree(attr.clone()) + }); + + for lib in &self.libs { + for proc_macro in &lib.exported_macros { + match proc_macro { + bridge::client::ProcMacro::CustomDerive { trait_name, client, .. } + if *trait_name == macro_name => + { + let res = client.run( + &crate::proc_macro::bridge::server::SameThread, + crate::rustc_server::Rustc::default(), + parsed_body, + ); + + return res.map(|it| it.subtree); + } + + bridge::client::ProcMacro::Bang { name, client } if *name == macro_name => { + let res = client.run( + &crate::proc_macro::bridge::server::SameThread, + crate::rustc_server::Rustc::default(), + parsed_body, + ); + + return res.map(|it| it.subtree); + } + + bridge::client::ProcMacro::Attr { name, client } if *name == macro_name => { + let res = client.run( + &crate::proc_macro::bridge::server::SameThread, + crate::rustc_server::Rustc::default(), + parsed_attributes, + parsed_body, + ); + + return res.map(|it| it.subtree); + } + + _ => { + continue; + } + } + } + } + + Err(bridge::PanicMessage::String("Nothing to expand".to_string())) + } + + pub fn list_macros(&self) -> Result, bridge::PanicMessage> { + let mut result = vec![]; + + for lib in &self.libs { + for proc_macro in &lib.exported_macros { + let res = match proc_macro { + bridge::client::ProcMacro::CustomDerive { trait_name, .. } => { + (trait_name.to_string(), ProcMacroKind::CustomDerive) + } + bridge::client::ProcMacro::Bang { name, .. } => { + (name.to_string(), ProcMacroKind::FuncLike) + } + bridge::client::ProcMacro::Attr { name, .. } => { + (name.to_string(), ProcMacroKind::Attr) + } + }; + result.push(res); + } + } + + Ok(result) + } +} -- cgit v1.2.3 From 197039b9fe2b14fbaa81cae18fff855625f07def Mon Sep 17 00:00:00 2001 From: Edwin Cheng Date: Fri, 10 Apr 2020 02:06:14 +0800 Subject: Remove allow(unused) --- crates/ra_proc_macro_srv/src/dylib.rs | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'crates/ra_proc_macro_srv/src/dylib.rs') diff --git a/crates/ra_proc_macro_srv/src/dylib.rs b/crates/ra_proc_macro_srv/src/dylib.rs index 525c7ac7b..738b10d56 100644 --- a/crates/ra_proc_macro_srv/src/dylib.rs +++ b/crates/ra_proc_macro_srv/src/dylib.rs @@ -91,8 +91,7 @@ fn load_library(file: &Path) -> Result { struct ProcMacroLibraryLibloading { // Hold the dylib to prevent it for unloadeding - #[allow(dead_code)] - lib: Library, + _lib: Library, exported_macros: Vec, } @@ -110,7 +109,7 @@ impl ProcMacroLibraryLibloading { macros.to_vec() }; - Ok(ProcMacroLibraryLibloading { lib, exported_macros }) + Ok(ProcMacroLibraryLibloading { _lib: lib, exported_macros }) } } -- cgit v1.2.3 From 857c03df079f919ddc0ea1c7c0a24313a66f2e2f Mon Sep 17 00:00:00 2001 From: Edwin Cheng Date: Fri, 10 Apr 2020 04:09:11 +0800 Subject: Fix macos symbol name bug --- crates/ra_proc_macro_srv/src/dylib.rs | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) (limited to 'crates/ra_proc_macro_srv/src/dylib.rs') diff --git a/crates/ra_proc_macro_srv/src/dylib.rs b/crates/ra_proc_macro_srv/src/dylib.rs index 738b10d56..eca9c8576 100644 --- a/crates/ra_proc_macro_srv/src/dylib.rs +++ b/crates/ra_proc_macro_srv/src/dylib.rs @@ -57,10 +57,28 @@ fn is_derive_registrar_symbol(symbol: &str) -> bool { symbol.contains(NEW_REGISTRAR_SYMBOL) } +#[cfg(not(target_os = "macos"))] +fn adjust_symbol_name(name: &str) -> String { + name.to_string() +} + +#[cfg(target_os = "macos")] +fn adjust_symbol_name(s: &str) -> String { + // In macos doc: + // https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/dlsym.3.html + // Unlike other dyld API's, the symbol name passed to dlsym() must NOT be + // prepended with an underscore. + if s.starts_with("_") { + s[1..s.len()].to_string() + } else { + s.to_string() + } +} + fn find_registrar_symbol(file: &Path) -> Option { let symbols = get_symbols_from_lib(file)?; - symbols.iter().find(|s| is_derive_registrar_symbol(s)).map(|s| s.to_string()) + symbols.iter().find(|s| is_derive_registrar_symbol(s)).map(|s| adjust_symbol_name(&s)) } /// Loads dynamic library in platform dependent manner. -- cgit v1.2.3 From 5fc8f90a216adbd557fdf7fff08de1c49d91b5a3 Mon Sep 17 00:00:00 2001 From: Edwin Cheng Date: Fri, 10 Apr 2020 19:06:53 +0800 Subject: tidy up a bit --- crates/ra_proc_macro_srv/src/dylib.rs | 68 ++++++++++------------------------- 1 file changed, 18 insertions(+), 50 deletions(-) (limited to 'crates/ra_proc_macro_srv/src/dylib.rs') diff --git a/crates/ra_proc_macro_srv/src/dylib.rs b/crates/ra_proc_macro_srv/src/dylib.rs index eca9c8576..8403187b9 100644 --- a/crates/ra_proc_macro_srv/src/dylib.rs +++ b/crates/ra_proc_macro_srv/src/dylib.rs @@ -1,54 +1,50 @@ //! Handles dynamic library loading for proc macro use crate::{proc_macro::bridge, rustc_server::TokenStream}; -use std::fs::File; -use std::io::Read; use std::path::Path; use goblin::{mach::Mach, Object}; use libloading::Library; use ra_proc_macro::ProcMacroKind; -static NEW_REGISTRAR_SYMBOL: &str = "__rustc_proc_macro_decls_"; -static _OLD_REGISTRAR_SYMBOL: &str = "__rustc_derive_registrar_"; - -fn read_bytes(file: &Path) -> Option> { - let mut fd = File::open(file).ok()?; - let mut buffer = Vec::new(); - fd.read_to_end(&mut buffer).ok()?; - - Some(buffer) -} +static NEW_REGISTRAR_SYMBOL: &str = "_rustc_proc_macro_decls_"; fn get_symbols_from_lib(file: &Path) -> Option> { - let buffer = read_bytes(file)?; + let buffer = std::fs::read(file).ok()?; let object = Object::parse(&buffer).ok()?; return match object { Object::Elf(elf) => { let symbols = elf.dynstrtab.to_vec().ok()?; let names = symbols.iter().map(|s| s.to_string()).collect(); - Some(names) } - Object::PE(pe) => { let symbol_names = pe.exports.iter().flat_map(|s| s.name).map(|n| n.to_string()).collect(); Some(symbol_names) } - Object::Mach(mach) => match mach { Mach::Binary(binary) => { let exports = binary.exports().ok()?; - let names = exports.iter().map(|s| s.name.clone()).collect(); - + let names = exports + .iter() + .map(|s| { + // In macos doc: + // https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/dlsym.3.html + // Unlike other dyld API's, the symbol name passed to dlsym() must NOT be + // prepended with an underscore. + if s.name.starts_with("_") { + s.name[1..].to_string() + } else { + s.name.to_string() + } + }) + .collect(); Some(names) } - Mach::Fat(_) => None, }, - Object::Archive(_) | Object::Unknown(_) => None, }; } @@ -57,28 +53,10 @@ fn is_derive_registrar_symbol(symbol: &str) -> bool { symbol.contains(NEW_REGISTRAR_SYMBOL) } -#[cfg(not(target_os = "macos"))] -fn adjust_symbol_name(name: &str) -> String { - name.to_string() -} - -#[cfg(target_os = "macos")] -fn adjust_symbol_name(s: &str) -> String { - // In macos doc: - // https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/dlsym.3.html - // Unlike other dyld API's, the symbol name passed to dlsym() must NOT be - // prepended with an underscore. - if s.starts_with("_") { - s[1..s.len()].to_string() - } else { - s.to_string() - } -} - fn find_registrar_symbol(file: &Path) -> Option { let symbols = get_symbols_from_lib(file)?; - symbols.iter().find(|s| is_derive_registrar_symbol(s)).map(|s| adjust_symbol_name(&s)) + symbols.iter().find(|s| is_derive_registrar_symbol(s)).map(|s| s.clone()) } /// Loads dynamic library in platform dependent manner. @@ -119,11 +97,9 @@ impl ProcMacroLibraryLibloading { .ok_or(format!("Cannot find registrar symbol in file {:?}", file))?; let lib = load_library(file).map_err(|e| e.to_string())?; - let exported_macros = { let macros: libloading::Symbol<&&[bridge::client::ProcMacro]> = unsafe { lib.get(symbol_name.as_bytes()) }.map_err(|e| e.to_string())?; - macros.to_vec() }; @@ -140,7 +116,6 @@ pub struct Expander { impl Expander { pub fn new>(lib: &P) -> Result { let mut libs = vec![]; - /* Some libraries for dynamic loading require canonicalized path (even when it is already absolute */ @@ -177,20 +152,16 @@ impl Expander { crate::rustc_server::Rustc::default(), parsed_body, ); - return res.map(|it| it.subtree); } - bridge::client::ProcMacro::Bang { name, client } if *name == macro_name => { let res = client.run( &crate::proc_macro::bridge::server::SameThread, crate::rustc_server::Rustc::default(), parsed_body, ); - return res.map(|it| it.subtree); } - bridge::client::ProcMacro::Attr { name, client } if *name == macro_name => { let res = client.run( &crate::proc_macro::bridge::server::SameThread, @@ -201,10 +172,7 @@ impl Expander { return res.map(|it| it.subtree); } - - _ => { - continue; - } + _ => continue, } } } -- cgit v1.2.3 From 31d163aa3be9c938ffe713534e4f648550a35f6c Mon Sep 17 00:00:00 2001 From: Edwin Cheng Date: Sat, 11 Apr 2020 14:53:13 +0800 Subject: Improve error handling --- crates/ra_proc_macro_srv/src/dylib.rs | 54 +++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 24 deletions(-) (limited to 'crates/ra_proc_macro_srv/src/dylib.rs') diff --git a/crates/ra_proc_macro_srv/src/dylib.rs b/crates/ra_proc_macro_srv/src/dylib.rs index 8403187b9..ec63d587b 100644 --- a/crates/ra_proc_macro_srv/src/dylib.rs +++ b/crates/ra_proc_macro_srv/src/dylib.rs @@ -7,28 +7,35 @@ use goblin::{mach::Mach, Object}; use libloading::Library; use ra_proc_macro::ProcMacroKind; -static NEW_REGISTRAR_SYMBOL: &str = "_rustc_proc_macro_decls_"; +use std::io::Error as IoError; +use std::io::ErrorKind as IoErrorKind; -fn get_symbols_from_lib(file: &Path) -> Option> { - let buffer = std::fs::read(file).ok()?; - let object = Object::parse(&buffer).ok()?; +const NEW_REGISTRAR_SYMBOL: &str = "_rustc_proc_macro_decls_"; - return match object { +fn invalid_data_err(e: impl Into>) -> IoError { + IoError::new(IoErrorKind::InvalidData, e) +} + +fn get_symbols_from_lib(file: &Path) -> Result, IoError> { + let buffer = std::fs::read(file)?; + let object = Object::parse(&buffer).map_err(invalid_data_err)?; + + match object { Object::Elf(elf) => { - let symbols = elf.dynstrtab.to_vec().ok()?; + let symbols = elf.dynstrtab.to_vec().map_err(invalid_data_err)?; let names = symbols.iter().map(|s| s.to_string()).collect(); - Some(names) + Ok(names) } Object::PE(pe) => { let symbol_names = pe.exports.iter().flat_map(|s| s.name).map(|n| n.to_string()).collect(); - Some(symbol_names) + Ok(symbol_names) } Object::Mach(mach) => match mach { Mach::Binary(binary) => { - let exports = binary.exports().ok()?; + let exports = binary.exports().map_err(invalid_data_err)?; let names = exports - .iter() + .into_iter() .map(|s| { // In macos doc: // https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/dlsym.3.html @@ -37,26 +44,25 @@ fn get_symbols_from_lib(file: &Path) -> Option> { if s.name.starts_with("_") { s.name[1..].to_string() } else { - s.name.to_string() + s.name } }) .collect(); - Some(names) + Ok(names) } - Mach::Fat(_) => None, + Mach::Fat(_) => Ok(vec![]), }, - Object::Archive(_) | Object::Unknown(_) => None, - }; + Object::Archive(_) | Object::Unknown(_) => Ok(vec![]), + } } fn is_derive_registrar_symbol(symbol: &str) -> bool { symbol.contains(NEW_REGISTRAR_SYMBOL) } -fn find_registrar_symbol(file: &Path) -> Option { +fn find_registrar_symbol(file: &Path) -> Result, IoError> { let symbols = get_symbols_from_lib(file)?; - - symbols.iter().find(|s| is_derive_registrar_symbol(s)).map(|s| s.clone()) + Ok(symbols.into_iter().find(|s| is_derive_registrar_symbol(s))) } /// Loads dynamic library in platform dependent manner. @@ -92,14 +98,14 @@ struct ProcMacroLibraryLibloading { } impl ProcMacroLibraryLibloading { - fn open(file: &Path) -> Result { - let symbol_name = find_registrar_symbol(file) - .ok_or(format!("Cannot find registrar symbol in file {:?}", file))?; + fn open(file: &Path) -> Result { + let symbol_name = find_registrar_symbol(file)? + .ok_or(invalid_data_err(format!("Cannot find registrar symbol in file {:?}", file)))?; - let lib = load_library(file).map_err(|e| e.to_string())?; + let lib = load_library(file).map_err(invalid_data_err)?; let exported_macros = { let macros: libloading::Symbol<&&[bridge::client::ProcMacro]> = - unsafe { lib.get(symbol_name.as_bytes()) }.map_err(|e| e.to_string())?; + unsafe { lib.get(symbol_name.as_bytes()) }.map_err(invalid_data_err)?; macros.to_vec() }; @@ -122,7 +128,7 @@ impl Expander { let lib = lib.as_ref().canonicalize().expect(&format!("Cannot canonicalize {:?}", lib.as_ref())); - let library = ProcMacroLibraryImpl::open(&lib)?; + let library = ProcMacroLibraryImpl::open(&lib).map_err(|e| e.to_string())?; libs.push(library); Ok(Expander { libs }) -- cgit v1.2.3