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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
//! Global library api. //! //! # Example //! //! ```no_run //! use emf_core_base_rs::global::{LockToken, Unlock, library}; //! use emf_core_base_rs::library::{DEFAULT_HANDLE, Symbol}; //! use std::path::Path; //! use std::ffi::CString; //! //! # use emf_core_base_rs::library::Error; //! # fn main() -> Result<(), Error> { //! let mut lock = LockToken::<Unlock>::lock(); //! //! let library_path = Path::new("path to my library"); //! let symbol_name = CString::new("add_function").unwrap(); //! //! let mut library = library::load(&mut lock, &DEFAULT_HANDLE, &library_path)?; //! let symbol: Symbol<extern "C" fn(i32, i32) -> i32> = //! library::get_function_symbol( //! &lock, //! &library, //! &symbol_name, //! |f| unsafe { std::mem::transmute(f) } //! )?; //! //! assert_eq!(symbol.as_ref()(5, 8), 13); //! # Ok(()) //! # } //! ``` use crate::ffi::collections::NonNullConst; use crate::ffi::CBaseFn; use crate::global::{get_interface, get_mut_interface, LockToken}; use crate::library::library_loader::{LibraryLoader, LibraryLoaderABICompat, LibraryLoaderAPI}; use crate::library::{Error, InternalLibrary, Library, LibraryAPI, LibraryType, Loader, Symbol}; use crate::ownership::{BorrowMutable, ImmutableAccessIdentifier, MutableAccessIdentifier, Owned}; use std::ffi::{c_void, CStr}; use std::path::Path; /// Registers a new loader. /// /// The loader can load libraries of the type `lib_type`. /// The loader must outlive the binding to the interface. /// /// # Failure /// /// The function fails if the library type already exists. /// /// # Return /// /// Handle on success, error otherwise. #[inline] pub fn register_loader<'loader, L, LT, T>( _token: &mut LockToken<L>, loader: &'loader LT, lib_type: &impl AsRef<str>, ) -> Result<Loader<'static, Owned>, Error> where T: LibraryLoaderAPI<'static>, LibraryLoader<T, Owned>: From<&'loader LT>, { LibraryAPI::register_loader(get_mut_interface(), loader, lib_type) } /// Unregisters an existing loader. /// /// # Failure /// /// The function fails if `loader` is invalid. /// /// # Return /// /// Error on failure. #[inline] pub fn unregister_loader<L>( _token: &mut LockToken<L>, loader: Loader<'_, Owned>, ) -> Result<(), Error> { LibraryAPI::unregister_loader(get_mut_interface(), loader) } /// Fetches the interface of a library loader. /// /// # Failure /// /// The function fails if `loader` is invalid. /// /// # Return /// /// Interface on success, error otherwise. #[inline] pub fn get_loader_interface<'loader, L, O, T>( _token: &mut LockToken<L>, loader: &Loader<'loader, O>, ) -> Result<LibraryLoader<T, O>, Error> where O: ImmutableAccessIdentifier, T: LibraryLoaderAPI<'loader> + LibraryLoaderABICompat, { LibraryAPI::get_loader_interface(get_mut_interface(), loader) } /// Fetches the loader handle associated with the library type. /// /// # Failure /// /// The function fails if `lib_type` is not registered. /// /// # Return /// /// Handle on success, error otherwise. #[inline] pub fn get_loader_handle_from_type<'tok, L>( _token: &'tok LockToken<L>, lib_type: &impl AsRef<str>, ) -> Result<Loader<'static, BorrowMutable<'tok>>, Error> { LibraryAPI::get_loader_handle_from_type(get_interface(), lib_type) } /// Fetches the loader handle linked with the library handle. /// /// # Failure /// /// The function fails if `library` is invalid. /// /// # Return /// /// Handle on success, error otherwise. #[inline] pub fn get_loader_handle_from_library<'l, 'library, L, O>( _token: &'l LockToken<L>, library: &Library<'library, O>, ) -> Result<Loader<'library, BorrowMutable<'l>>, Error> where O: ImmutableAccessIdentifier, { LibraryAPI::get_loader_handle_from_library(get_interface(), library) } /// Fetches the number of registered loaders. /// /// # Return /// /// Number of registered loaders. #[inline] pub fn get_num_loaders<L>(_token: &LockToken<L>) -> usize { LibraryAPI::get_num_loaders(get_interface()) } /// Checks if a the library handle is valid. /// /// # Return /// /// [true] if the handle is valid, [false] otherwise. #[inline] pub fn library_exists<'library, L, O>(_token: &LockToken<L>, library: &Library<'library, O>) -> bool where O: ImmutableAccessIdentifier, { LibraryAPI::library_exists(get_interface(), library) } /// Checks if a library type exists. /// /// # Return /// /// [true] if the type exists, [false] otherwise. #[inline] pub fn type_exists<L>(_token: &LockToken<L>, lib_type: &impl AsRef<str>) -> Result<bool, Error> { LibraryAPI::type_exists(get_interface(), lib_type) } /// Copies the strings of the registered library types into a buffer. /// /// # Failure /// /// The function fails if `buffer.as_ref().len() < get_num_loaders()`. /// /// # Return /// /// Number of written types on success, error otherwise. #[inline] pub fn get_library_types<L>( _token: &LockToken<L>, buffer: impl AsMut<[LibraryType]>, ) -> Result<usize, Error> { LibraryAPI::get_library_types(get_interface(), buffer) } /// Creates a new unlinked library handle. /// /// # Return /// /// Library handle. /// /// # Safety /// /// The handle must be linked before use. #[inline] pub unsafe fn create_library_handle<L>(_token: &mut LockToken<L>) -> Library<'static, Owned> { LibraryAPI::create_library_handle(get_mut_interface()) } /// Removes an existing library handle. /// /// # Failure /// /// The function fails if `library` is invalid. /// /// # Return /// /// Error on failure. /// /// # Safety /// /// Removing the handle does not unload the library. #[inline] pub unsafe fn remove_library_handle<L>( _token: &mut LockToken<L>, library: Library<'_, Owned>, ) -> Result<(), Error> { LibraryAPI::remove_library_handle(get_mut_interface(), library) } /// Links a library handle to an internal library handle. /// /// Overrides the internal link of the library handle by setting /// it to the new library loader and internal handle. /// /// # Failure /// /// The function fails if `library` or `loader` are invalid. /// /// # Return /// /// Error on failure. /// /// # Safety /// /// Incorrect usage can lead to dangling handles or use-after-free errors. #[inline] pub unsafe fn link_library<'library, 'loader, L, O, LO, IO>( _token: &mut LockToken<L>, library: &Library<'library, O>, loader: &Loader<'loader, LO>, internal: &InternalLibrary<IO>, ) -> Result<(), Error> where 'loader: 'library, O: MutableAccessIdentifier, LO: ImmutableAccessIdentifier, IO: ImmutableAccessIdentifier, { LibraryAPI::link_library(get_mut_interface(), library, loader, internal) } /// Fetches the internal handle linked with the library handle. /// /// # Failure /// /// The function fails if `handle` is invalid. /// /// # Return /// /// Handle on success, error otherwise. #[inline] pub fn get_internal_library_handle<'library, L, O>( _token: &LockToken<L>, library: &Library<'library, O>, ) -> Result<InternalLibrary<O>, Error> where O: ImmutableAccessIdentifier, { LibraryAPI::get_internal_library_handle(get_interface(), library) } /// Loads a library. The resulting handle is unique. /// /// # Failure /// /// The function fails if `loader` or `path` is invalid or /// the type of the library can not be loaded with the loader. /// /// # Return /// /// Handle on success, error otherwise. #[inline] pub fn load<L, O>( _token: &mut LockToken<L>, loader: &Loader<'static, O>, path: &impl AsRef<Path>, ) -> Result<Library<'static, Owned>, Error> where O: MutableAccessIdentifier, { LibraryAPI::load(get_mut_interface(), loader, path) } /// Unloads a library. /// /// # Failure /// /// The function fails if `library` is invalid. /// /// # Return /// /// Error on failure. #[inline] pub fn unload<L>(_token: &mut LockToken<L>, library: Library<'_, Owned>) -> Result<(), Error> { LibraryAPI::unload(get_mut_interface(), library) } /// Fetches a data symbol from a library. /// /// # Failure /// /// The function fails if `library` is invalid or library does not contain `symbol`. /// /// # Note /// /// Some platforms may differentiate between a `function-pointer` and a `data-pointer`. /// See [get_function_symbol()] for fetching a function. /// /// # Return /// /// Symbol on success, error otherwise. #[inline] pub fn get_data_symbol<'library, 'handle, L, O, U>( _token: &LockToken<L>, library: &'handle Library<'library, O>, symbol: &impl AsRef<CStr>, caster: impl FnOnce(NonNullConst<c_void>) -> &'library U, ) -> Result<Symbol<'handle, &'library U>, Error> where O: ImmutableAccessIdentifier, { LibraryAPI::get_data_symbol(get_interface(), library, symbol, caster) } /// Fetches a function symbol from a library. /// /// # Failure /// /// The function fails if `library` is invalid or library does not contain `symbol`. /// /// # Note /// /// Some platforms may differentiate between a `function-pointer` and a `data-pointer`. /// See [get_data_symbol()] for fetching some data. /// /// # Return /// /// Symbol on success, error otherwise. #[inline] pub fn get_function_symbol<'library, 'handle, L, O, U>( _token: &LockToken<L>, library: &'handle Library<'library, O>, symbol: &impl AsRef<CStr>, caster: impl FnOnce(CBaseFn) -> U, ) -> Result<Symbol<'handle, U>, Error> where O: ImmutableAccessIdentifier, { LibraryAPI::get_function_symbol(get_interface(), library, symbol, caster) }