1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
use core::{
fmt::Debug,
marker::{self, PhantomData},
ops,
};
use alloc::{boxed::Box, format, sync::Arc, vec::Vec};
use elf::string_table::StringTable;
use crate::{
file::ELFFile, hashtable::ELFHashTable, relocation::ELFRelocation, segment::ELFSegments,
unwind::ELFUnwind, ELFSymbol, Error, Result,
};
#[derive(Debug)]
#[allow(unused)]
pub(crate) struct ELFLibraryInner {
pub(crate) common: CommonInner,
/// rela.dyn and rela.plt
pub(crate) relocation: ELFRelocation,
/// .init
pub(crate) init_fn: Option<extern "C" fn()>,
/// .init_array
pub(crate) init_array_fn: Option<&'static [extern "C" fn()]>,
/// needed libs' name
pub(crate) needed_libs: Vec<&'static str>,
}
#[derive(Debug)]
#[allow(unused)]
pub(crate) struct CommonInner {
/// .gnu.hash
pub(crate) hashtab: ELFHashTable,
/// .dynsym
pub(crate) symtab: *const ELFSymbol,
/// .dynstr
pub(crate) strtab: elf::string_table::StringTable<'static>,
/// .eh_frame
pub(crate) unwind: Option<ELFUnwind>,
/// semgents
pub(crate) segments: ELFSegments,
/// .fini
pub(crate) fini_fn: Option<extern "C" fn()>,
/// .fini_array
pub(crate) fini_array_fn: Option<&'static [extern "C" fn()]>,
/// .tbss and .tdata
#[cfg(feature = "tls")]
pub(crate) tls: Option<Box<crate::tls::ELFTLS>>,
}
impl CommonInner {
pub(crate) fn get_sym(&self, name: &str) -> Option<&ELFSymbol> {
let bytes = name.as_bytes();
let name = if *bytes.last().unwrap() == 0 {
&bytes[..bytes.len() - 1]
} else {
bytes
};
let symbol = unsafe { self.hashtab.find(name, self.symtab, &self.strtab) };
symbol
}
}
#[derive(Debug)]
pub struct ELFLibrary {
pub(crate) inner: ELFLibraryInner,
}
impl ELFLibrary {
/// Find and load a elf dynamic library from path.
///
/// The `filename` argument may be either:
///
/// * A library filename;
/// * The absolute path to the library;
/// * A relative (to the current working directory) path to the library.
/// # Examples
///
///
/// ```no_run
/// # use ::dlopen_rs::ELFLibrary;
/// let lib = ELFLibrary::from_file("/path/to/awesome.module")
/// .unwrap();
/// ```
///
#[cfg(feature = "std")]
pub fn from_file<P: AsRef<std::ffi::OsStr>>(path: P) -> Result<ELFLibrary> {
let file = ELFFile::from_file(path.as_ref())?;
let inner = ELFLibraryInner::load_library(file)?;
Ok(ELFLibrary { inner })
}
/// load a elf dynamic library from bytes
/// # Examples
///
/// ```no_run
/// # use ::dlopen_rs::ELFLibrary;
/// let path = Path::new("/path/to/awesome.module");
/// let bytes = std::fs::read(path).unwrap();
/// let lib = ELFLibrary::from_binary(&bytes).unwarp();
/// ```
pub fn from_binary(bytes: &[u8]) -> Result<ELFLibrary> {
let file = ELFFile::from_binary(bytes);
let inner = ELFLibraryInner::load_library(file)?;
Ok(ELFLibrary { inner })
}
pub fn needed_libs(&self) -> &Vec<&str> {
&self.inner.needed_libs
}
#[inline]
pub(crate) fn relocation(&self) -> &ELFRelocation {
&self.inner.relocation
}
#[inline]
pub(crate) fn symtab(&self) -> *const ELFSymbol {
self.inner.common.symtab
}
#[inline]
pub(crate) fn strtab(&self) -> &StringTable {
&self.inner.common.strtab
}
#[inline]
pub(crate) fn segments(&self) -> &ELFSegments {
&self.inner.common.segments
}
#[inline]
#[cfg(feature = "tls")]
pub(crate) fn tls(&self) -> *const crate::tls::ELFTLS {
self.inner.common.tls.as_ref().unwrap().as_ref() as *const crate::tls::ELFTLS
}
#[inline]
pub(crate) fn init_fn(&self) -> &Option<extern "C" fn()> {
&self.inner.init_fn
}
#[inline]
pub(crate) fn init_array_fn(&self) -> &Option<&'static [extern "C" fn()]> {
&self.inner.init_array_fn
}
}
#[derive(Debug)]
#[allow(unused)]
pub(crate) struct RelocatedLibraryInner {
pub(crate) common: CommonInner,
pub(crate) internal_libs: Vec<RelocatedLibrary>,
pub(crate) external_libs: Option<Vec<Box<dyn ExternLibrary>>>,
}
#[derive(Debug, Clone)]
pub struct RelocatedLibrary {
pub(crate) inner: Arc<RelocatedLibraryInner>,
}
impl RelocatedLibrary {
pub(crate) fn new(
lib: ELFLibrary,
internal_libs: Vec<RelocatedLibrary>,
external_libs: Option<Vec<Box<dyn ExternLibrary>>>,
) -> RelocatedLibrary {
let inner = RelocatedLibraryInner {
common: lib.inner.common,
internal_libs,
external_libs,
};
RelocatedLibrary {
inner: Arc::new(inner),
}
}
pub(crate) fn get_sym(&self, name: &str) -> Option<*const ()> {
self.inner.common.get_sym(name).map(|sym| unsafe {
self.inner
.common
.segments
.as_mut_ptr()
.add(sym.st_value as usize) as *const ()
})
}
/// Get a pointer to a function or static variable by symbol name.
///
/// The symbol is interpreted as-is; no mangling is done. This means that symbols like `x::y` are
/// most likely invalid.
///
/// # Safety
///
/// Users of this API must specify the correct type of the function or variable loaded.
///
///
/// # Examples
///
/// Given a loaded library:
///
/// ```no_run
/// # use ::dlopen_rs::ELFLibrary;
/// let lib = ELFLibrary::from_file("/path/to/awesome.module")
/// .unwrap()
/// .relocate(&[])
/// .unwrap();
/// ```
///
/// Loading and using a function looks like this:
///
/// ```no_run
/// unsafe {
/// let awesome_function: Symbol<unsafe extern fn(f64) -> f64> =
/// lib.get("awesome_function").unwrap();
/// awesome_function(0.42);
/// }
/// ```
///
/// A static variable may also be loaded and inspected:
///
/// ```no_run
/// unsafe {
/// let awesome_variable: Symbol<*mut f64> = lib.get("awesome_variable").unwrap();
/// **awesome_variable = 42.0;
/// };
/// ```
pub unsafe fn get<'lib, T>(&'lib self, name: &str) -> Result<Symbol<'lib, T>> {
self.get_sym(name)
.map(|sym| Symbol {
ptr: sym as _,
pd: PhantomData,
})
.ok_or(Error::FindSymbolError {
msg: format!("can not find symbol:{}", name),
})
}
}
impl Drop for RelocatedLibrary {
fn drop(&mut self) {
if let Some(fini) = self.inner.common.fini_fn {
fini();
}
if let Some(fini_array) = self.inner.common.fini_array_fn {
for fini in fini_array {
fini();
}
}
}
}
pub trait ExternLibrary: Debug {
/// Get the symbol of the dynamic library, and the return value is the address of the symbol
/// # Examples
///
/// ```
/// #[derive(Debug, Clone)]
/// struct MyLib(Arc<Library>);
///
/// impl ExternLibrary for MyLib {
/// fn get_sym(&self, name: &str) -> Option<*const ()> {
/// let sym: Option<*const ()> = unsafe {
/// self.0.get::<*const usize>(name.as_bytes())
/// .map_or(None, |sym| Some(sym.into_raw().into_raw() as _))
/// };
/// sym
/// }
///}
/// ```
fn get_sym(&self, name: &str) -> Option<*const ()>;
}
#[derive(Debug)]
pub struct Symbol<'lib, T: 'lib> {
ptr: *mut (),
pd: marker::PhantomData<&'lib T>,
}
impl<'lib, T> ops::Deref for Symbol<'lib, T> {
type Target = T;
fn deref(&self) -> &T {
unsafe { &*(&self.ptr as *const *mut _ as *const T) }
}
}