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 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
use crate::{
bindings::{
char_t,
hostfxr::{component_entry_point_fn, load_assembly_and_get_function_pointer_fn},
},
error::{HostingError, HostingResult, HostingSuccess},
pdcstring::{PdCStr, PdCString},
};
use num_enum::TryFromPrimitive;
use std::{convert::TryFrom, mem::MaybeUninit, path::Path, ptr};
use thiserror::Error;
use super::{FunctionPtr, ManagedFunction, RawFunctionPtr, SharedHostfxrLibrary};
#[cfg(feature = "net5_0")]
use crate::bindings::hostfxr::{get_function_pointer_fn, UNMANAGED_CALLERS_ONLY_METHOD};
/// A pointer to a function with the default signature.
pub type ManagedFunctionWithDefaultSignature = ManagedFunction<component_entry_point_fn>;
/// A pointer to a function with an unknown signature.
pub type ManagedFunctionWithUnknownSignature = ManagedFunction<RawFunctionPtr>;
/// A struct for loading pointers to managed functions for a given [`HostfxrContext`].
///
/// [`HostfxrContext`]: super::HostfxrContext
#[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "netcore3_0")))]
pub struct DelegateLoader {
pub(crate) get_load_assembly_and_get_function_pointer:
load_assembly_and_get_function_pointer_fn,
#[cfg(feature = "net5_0")]
pub(crate) get_function_pointer: get_function_pointer_fn,
#[allow(unused)]
pub(crate) hostfxr: SharedHostfxrLibrary,
}
impl Clone for DelegateLoader {
fn clone(&self) -> Self {
Self {
get_load_assembly_and_get_function_pointer: self
.get_load_assembly_and_get_function_pointer,
#[cfg(feature = "net5_0")]
get_function_pointer: self.get_function_pointer,
hostfxr: self.hostfxr.clone(),
}
}
}
impl DelegateLoader {
unsafe fn _load_assembly_and_get_function_pointer(
&self,
assembly_path: *const char_t,
type_name: *const char_t,
method_name: *const char_t,
delegate_type_name: *const char_t,
) -> Result<RawFunctionPtr, GetManagedFunctionError> {
let mut delegate = MaybeUninit::uninit();
let result = unsafe {
(self.get_load_assembly_and_get_function_pointer)(
assembly_path,
type_name,
method_name,
delegate_type_name,
ptr::null(),
delegate.as_mut_ptr(),
)
};
GetManagedFunctionError::from_status_code(result)?;
Ok(unsafe { delegate.assume_init() }.cast())
}
fn _validate_assembly_path(
assembly_path: impl AsRef<PdCStr>,
) -> Result<(), GetManagedFunctionError> {
#[cfg(windows)]
let assembly_path = assembly_path.as_ref().to_os_string();
#[cfg(not(windows))]
let assembly_path = <std::ffi::OsStr as std::os::unix::prelude::OsStrExt>::from_bytes(
assembly_path.as_ref().as_slice(),
);
if Path::new(&assembly_path).exists() {
Ok(())
} else {
Err(GetManagedFunctionError::AssemblyNotFound)
}
}
#[cfg(feature = "net5_0")]
unsafe fn _get_function_pointer(
&self,
type_name: *const char_t,
method_name: *const char_t,
delegate_type_name: *const char_t,
) -> Result<RawFunctionPtr, GetManagedFunctionError> {
let mut delegate = MaybeUninit::uninit();
let result = unsafe {
(self.get_function_pointer)(
type_name,
method_name,
delegate_type_name,
ptr::null(),
ptr::null(),
delegate.as_mut_ptr(),
)
};
GetManagedFunctionError::from_status_code(result)?;
Ok(unsafe { delegate.assume_init() }.cast())
}
/// Calling this function will load the specified assembly in isolation (into its own `AssemblyLoadContext`)
/// and it will use `AssemblyDependencyResolver` on it to provide dependency resolution.
/// Once loaded it will find the specified type and method and return a native function pointer
/// to that method.
///
/// # Arguments
/// * `assembly_path`:
/// Path to the assembly to load.
/// In case of complex component, this should be the main assembly of the component (the one with the .deps.json next to it).
/// Note that this does not have to be the assembly from which the `type_name` and `method_name` are.
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match the signature of `delegate_type_name`.
/// * `delegate_type_name`:
/// Assembly qualified delegate type name for the method signature.
pub fn load_assembly_and_get_function<F: FunctionPtr>(
&self,
assembly_path: &PdCStr,
type_name: &PdCStr,
method_name: &PdCStr,
delegate_type_name: &PdCStr,
) -> Result<ManagedFunction<F::Managed>, GetManagedFunctionError> {
Self::_validate_assembly_path(assembly_path)?;
let function = unsafe {
self._load_assembly_and_get_function_pointer(
assembly_path.as_ptr(),
type_name.as_ptr(),
method_name.as_ptr(),
delegate_type_name.as_ptr(),
)
}?;
Ok(ManagedFunction(unsafe { F::Managed::from_ptr(function) }))
}
/// Calling this function will load the specified assembly in isolation (into its own `AssemblyLoadContext`)
/// and it will use `AssemblyDependencyResolver` on it to provide dependency resolution.
/// Once loaded it will find the specified type and method and return a native function pointer
/// to that method.
///
/// # Arguments
/// * `assembly_path`:
/// Path to the assembly to load.
/// In case of complex component, this should be the main assembly of the component (the one with the .deps.json next to it).
/// Note that this does not have to be the assembly from which the `type_name` and `method_name` are.
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match the following signature:
/// `public delegate int ComponentEntryPoint(IntPtr args, int sizeBytes);`
pub fn load_assembly_and_get_function_with_default_signature(
&self,
assembly_path: &PdCStr,
type_name: &PdCStr,
method_name: &PdCStr,
) -> Result<ManagedFunctionWithDefaultSignature, GetManagedFunctionError> {
Self::_validate_assembly_path(assembly_path)?;
let function = unsafe {
self._load_assembly_and_get_function_pointer(
assembly_path.as_ptr(),
type_name.as_ptr(),
method_name.as_ptr(),
ptr::null(),
)
}?;
Ok(ManagedFunction(unsafe { FunctionPtr::from_ptr(function) }))
}
/// Calling this function will load the specified assembly in isolation (into its own `AssemblyLoadContext`)
/// and it will use `AssemblyDependencyResolver` on it to provide dependency resolution.
/// Once loaded it will find the specified type and method and return a native function pointer
/// to that method. The target method has to be annotated with the [`UnmanagedCallersOnlyAttribute`].
///
/// # Arguments
/// * `assembly_path`:
/// Path to the assembly to load.
/// In case of complex component, this should be the main assembly of the component (the one with the .deps.json next to it).
/// Note that this does not have to be the assembly from which the `type_name` and `method_name` are.
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match be annotated with [`\[UnmanagedCallersOnly\]`].
///
/// [`UnmanagedCallersOnlyAttribute`]: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
/// [`UnmanagedCallersOnly`]: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
#[cfg(feature = "net5_0")]
#[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "net5_0")))]
pub fn load_assembly_and_get_function_with_unmanaged_callers_only<F: FunctionPtr>(
&self,
assembly_path: &PdCStr,
type_name: &PdCStr,
method_name: &PdCStr,
) -> Result<ManagedFunction<F::Managed>, GetManagedFunctionError> {
Self::_validate_assembly_path(assembly_path)?;
let function = unsafe {
self._load_assembly_and_get_function_pointer(
assembly_path.as_ptr(),
type_name.as_ptr(),
method_name.as_ptr(),
UNMANAGED_CALLERS_ONLY_METHOD,
)
}?;
Ok(ManagedFunction(unsafe { F::Managed::from_ptr(function) }))
}
/// Calling this function will find the specified type and method and return a native function pointer to that method.
/// This will **NOT** load the containing assembly.
///
/// # Arguments
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match the signature of `delegate_type_name`.
/// * `delegate_type_name`:
/// Assembly qualified delegate type name for the method signature.
#[cfg(feature = "net5_0")]
#[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "net5_0")))]
pub fn get_function<F: FunctionPtr>(
&self,
type_name: &PdCStr,
method_name: &PdCStr,
delegate_type_name: &PdCStr,
) -> Result<ManagedFunction<F::Managed>, GetManagedFunctionError> {
let function = unsafe {
self._get_function_pointer(
type_name.as_ptr(),
method_name.as_ptr(),
delegate_type_name.as_ptr(),
)
}?;
Ok(ManagedFunction(unsafe { F::Managed::from_ptr(function) }))
}
/// Calling this function will find the specified type and method and return a native function pointer to that method.
/// This will **NOT** load the containing assembly.
///
/// # Arguments
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match the following signature:
/// `public delegate int ComponentEntryPoint(IntPtr args, int sizeBytes);`
#[cfg(feature = "net5_0")]
pub fn get_function_with_default_signature(
&self,
type_name: &PdCStr,
method_name: &PdCStr,
) -> Result<ManagedFunctionWithDefaultSignature, GetManagedFunctionError> {
let function = unsafe {
self._get_function_pointer(type_name.as_ptr(), method_name.as_ptr(), ptr::null())
}?;
Ok(ManagedFunction(unsafe { FunctionPtr::from_ptr(function) }))
}
/// Calling this function will find the specified type and method and return a native function pointer to that method.
/// This will **NOT** load the containing assembly.
///
/// # Arguments
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match be annotated with [`UnmanagedCallersOnly`].
///
/// [`UnmanagedCallersOnlyAttribute`]: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
/// [`UnmanagedCallersOnly`]: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
#[cfg(feature = "net5_0")]
#[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "net5_0")))]
pub fn get_function_with_unmanaged_callers_only<F: FunctionPtr>(
&self,
type_name: &PdCStr,
method_name: &PdCStr,
) -> Result<ManagedFunction<F::Managed>, GetManagedFunctionError> {
let function = unsafe {
self._get_function_pointer(
type_name.as_ptr(),
method_name.as_ptr(),
UNMANAGED_CALLERS_ONLY_METHOD,
)
}?;
Ok(ManagedFunction(unsafe { F::Managed::from_ptr(function) }))
}
}
/// A struct for loading pointers to managed functions for a given [`HostfxrContext`] which automatically loads the
/// assembly from the given path on the first access.
///
/// [`HostfxrContext`]: super::HostfxrContext
#[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "netcore3_0")))]
#[derive(Clone)]
pub struct AssemblyDelegateLoader {
loader: DelegateLoader,
assembly_path: PdCString,
}
impl AssemblyDelegateLoader {
/// Creates a new [`AssemblyDelegateLoader`] wrapping the given [`DelegateLoader`] loading the assembly
/// from the given path on the first access.
pub fn new(loader: DelegateLoader, assembly_path: impl Into<PdCString>) -> Self {
let assembly_path = assembly_path.into();
Self {
loader,
assembly_path,
}
}
/// If this is the first loaded function pointer, calling this function will load the specified assembly in
/// isolation (into its own `AssemblyLoadContext`) and it will use `AssemblyDependencyResolver` on it to provide
/// dependency resolution.
/// Otherwise or once loaded it will find the specified type and method and return a native function pointer to that method.
/// Calling this function will find the specified type and method and return a native function pointer to that method.
///
/// # Arguments
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match the signature of `delegate_type_name`.
/// * `delegate_type_name`:
/// Assembly qualified delegate type name for the method signature.
pub fn get_function<F: FunctionPtr>(
&self,
type_name: &PdCStr,
method_name: &PdCStr,
delegate_type_name: &PdCStr,
) -> Result<ManagedFunction<F::Managed>, GetManagedFunctionError> {
self.loader.load_assembly_and_get_function::<F>(
self.assembly_path.as_ref(),
type_name,
method_name,
delegate_type_name,
)
}
/// If this is the first loaded function pointer, calling this function will load the specified assembly in
/// isolation (into its own `AssemblyLoadContext`) and it will use `AssemblyDependencyResolver` on it to provide
/// dependency resolution.
/// Otherwise or once loaded it will find the specified type and method and return a native function pointer to that method.
/// Calling this function will find the specified type and method and return a native function pointer to that method.
///
/// # Arguments
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match the following signature:
/// `public delegate int ComponentEntryPoint(IntPtr args, int sizeBytes);`
pub fn get_function_with_default_signature(
&self,
type_name: &PdCStr,
method_name: &PdCStr,
) -> Result<ManagedFunctionWithDefaultSignature, GetManagedFunctionError> {
self.loader
.load_assembly_and_get_function_with_default_signature(
self.assembly_path.as_ref(),
type_name,
method_name,
)
}
/// If this is the first loaded function pointer, calling this function will load the specified assembly in
/// isolation (into its own `AssemblyLoadContext`) and it will use `AssemblyDependencyResolver` on it to provide
/// dependency resolution.
/// Otherwise or once loaded it will find the specified type and method and return a native function pointer to that method.
/// Calling this function will find the specified type and method and return a native function pointer to that method.
///
/// # Arguments
/// * `type_name`:
/// Assembly qualified type name to find
/// * `method_name`:
/// Name of the method on the `type_name` to find. The method must be static and must match be annotated with [`UnmanagedCallersOnly`].
///
/// [`UnmanagedCallersOnlyAttribute`]: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
/// [`UnmanagedCallersOnly`]: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
#[cfg(feature = "net5_0")]
#[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "net5_0")))]
pub fn get_function_with_unmanaged_callers_only<F: FunctionPtr>(
&self,
type_name: &PdCStr,
method_name: &PdCStr,
) -> Result<ManagedFunction<F::Managed>, GetManagedFunctionError> {
self.loader
.load_assembly_and_get_function_with_unmanaged_callers_only::<F>(
self.assembly_path.as_ref(),
type_name,
method_name,
)
}
}
/// Enum for errors that can occur while loading a managed assembly or managed function pointers.
#[derive(Error, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "netcore3_0")))]
pub enum GetManagedFunctionError {
/// An error occured inside the hosting components.
#[error("Error from hosting components: {}.", .0)]
Hosting(#[from] HostingError),
/// A type with the specified name could not be found or loaded.
#[error("Failed to load type containing method of delegate type.")]
TypeNotFound,
/// A method with the required signature and name could not be found.
#[error("Specified method does not exists or has an incompatible signature.")]
MissingMethod,
/// The specified assembly could not be found.
#[error("The specified assembly could not be found.")]
AssemblyNotFound,
/// The target method is not annotated with [`UnmanagedCallersOnly`](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute).
#[error("The target method is not annotated with UnmanagedCallersOnly.")]
MethodNotUnmanagedCallersOnly,
/// Some other unknown error occured.
#[error("Unknown error code: {}", format!("{:#08X}", .0))]
Other(u32),
}
impl GetManagedFunctionError {
/// Converts the given staus code to a [`GetManagedFunctionError`].
pub fn from_status_code(code: i32) -> Result<HostingSuccess, Self> {
let code = code as u32;
match HostingResult::known_from_status_code(code) {
Ok(HostingResult(Ok(code))) => return Ok(code),
Ok(HostingResult(Err(code))) => return Err(GetManagedFunctionError::Hosting(code)),
_ => {}
}
match HResult::try_from(code) {
Ok(HResult::COR_E_TYPELOAD) => return Err(Self::TypeNotFound),
Ok(HResult::COR_E_MISSINGMETHOD | HResult::COR_E_ARGUMENT) => {
return Err(Self::MissingMethod)
}
Ok(HResult::FILE_NOT_FOUND) => return Err(Self::AssemblyNotFound),
Ok(HResult::COR_E_INVALIDOPERATION) => return Err(Self::MethodNotUnmanagedCallersOnly),
_ => {}
}
Err(Self::Other(code))
}
}
#[repr(u32)]
#[non_exhaustive]
#[derive(TryFromPrimitive, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[allow(non_camel_case_types)]
#[rustfmt::skip]
enum HResult {
E_POINTER = 0x8000_4003, // System.ArgumentNullException
COR_E_ARGUMENTOUTOFRANGE = 0x8013_1502, // System.ArgumentOutOfRangeException (reserved was not 0)
COR_E_TYPELOAD = 0x8013_1522, // invalid type
COR_E_MISSINGMETHOD = 0x8013_1513, // invalid method
/*COR_E_*/FILE_NOT_FOUND = 0x8007_0002, // assembly with specified name not found (from type name)
COR_E_ARGUMENT = 0x8007_0057, // invalid method signature or method not found
COR_E_INVALIDOPERATION = 0x8013_1509, // invalid assembly path or not unmanaged,
}