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
use crate::{
bindings::{
char_t,
consts::UNMANAGED_CALLERS_ONLY_METHOD,
hostfxr::{
component_entry_point_fn, get_function_pointer_fn,
load_assembly_and_get_function_pointer_fn,
},
},
pdcstring::PdCStr,
Error,
};
use std::{
mem::{self, MaybeUninit},
ptr,
};
use super::HostExitCode;
/// A function pointer for a method with the default signature.
pub type MethodWithDefaultSignature = component_entry_point_fn;
pub enum SomeMethod {}
/// A function pointer for a method with an unknown signature.
pub type MethodWithUnknownSignature = *const SomeMethod;
/// A struct for loading pointers to managed functions for a given [`HostfxrContext`].
///
/// [`HostfxrContext`]: super::HostfxrContext
#[derive(Copy, Clone)]
pub struct DelegateLoader {
pub(crate) get_load_assembly_and_get_function_pointer:
load_assembly_and_get_function_pointer_fn,
pub(crate) get_function_pointer: get_function_pointer_fn,
}
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<MethodWithUnknownSignature, Error> {
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(),
)
};
HostExitCode::from(result).to_result()?;
Ok(unsafe { mem::transmute(delegate.assume_init()) })
}
unsafe fn _get_function_pointer(
&self,
type_name: *const char_t,
method_name: *const char_t,
delegate_type_name: *const char_t,
) -> Result<MethodWithUnknownSignature, Error> {
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(),
)
};
HostExitCode::from(result).to_result()?;
Ok(unsafe { mem::transmute(delegate.assume_init()) })
}
/// 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_pointer(
&self,
assembly_path: impl AsRef<PdCStr>,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
delegate_type_name: impl AsRef<PdCStr>,
) -> Result<MethodWithUnknownSignature, Error> {
unsafe {
self._load_assembly_and_get_function_pointer(
assembly_path.as_ref().as_ptr(),
type_name.as_ref().as_ptr(),
method_name.as_ref().as_ptr(),
delegate_type_name.as_ref().as_ptr(),
)
}
}
/// 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_pointer_with_default_signature(
&self,
assembly_path: impl AsRef<PdCStr>,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
) -> Result<MethodWithDefaultSignature, Error> {
unsafe {
self._load_assembly_and_get_function_pointer(
assembly_path.as_ref().as_ptr(),
type_name.as_ref().as_ptr(),
method_name.as_ref().as_ptr(),
ptr::null(),
)
.map(|fn_ptr| mem::transmute(fn_ptr))
}
}
/// 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
pub fn load_assembly_and_get_function_pointer_for_unmanaged_callers_only_method(
&self,
assembly_path: impl AsRef<PdCStr>,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
) -> Result<MethodWithUnknownSignature, Error> {
unsafe {
self._load_assembly_and_get_function_pointer(
assembly_path.as_ref().as_ptr(),
type_name.as_ref().as_ptr(),
method_name.as_ref().as_ptr(),
UNMANAGED_CALLERS_ONLY_METHOD,
)
}
}
/// 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.
pub fn get_function_pointer(
&self,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
delegate_type_name: impl AsRef<PdCStr>,
) -> Result<MethodWithUnknownSignature, Error> {
unsafe {
self._get_function_pointer(
type_name.as_ref().as_ptr(),
method_name.as_ref().as_ptr(),
delegate_type_name.as_ref().as_ptr(),
)
}
}
/// 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);`
pub fn get_function_pointer_with_default_signature(
&self,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
) -> Result<MethodWithDefaultSignature, Error> {
unsafe {
self._get_function_pointer(
type_name.as_ref().as_ptr(),
method_name.as_ref().as_ptr(),
ptr::null(),
)
.map(|fn_ptr| mem::transmute(fn_ptr))
}
}
/// 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
pub fn get_function_pointer_for_unmanaged_callers_only_method(
&self,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
) -> Result<MethodWithUnknownSignature, Error> {
unsafe {
self._get_function_pointer(
type_name.as_ref().as_ptr(),
method_name.as_ref().as_ptr(),
UNMANAGED_CALLERS_ONLY_METHOD,
)
}
}
}
/// 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
pub struct AssemblyDelegateLoader<A: AsRef<PdCStr>> {
loader: DelegateLoader,
assembly_path: A,
}
impl<A: AsRef<PdCStr>> AssemblyDelegateLoader<A> {
/// 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: A) -> Self {
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_pointer(
&self,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
delegate_type_name: impl AsRef<PdCStr>,
) -> Result<MethodWithUnknownSignature, Error> {
self.loader.load_assembly_and_get_function_pointer(
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_pointer_with_default_signature(
&self,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
) -> Result<MethodWithDefaultSignature, Error> {
self.loader
.load_assembly_and_get_function_pointer_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
pub fn get_function_pointer_for_unmanaged_callers_only_method(
&self,
type_name: impl AsRef<PdCStr>,
method_name: impl AsRef<PdCStr>,
) -> Result<MethodWithUnknownSignature, Error> {
self.loader
.load_assembly_and_get_function_pointer_for_unmanaged_callers_only_method(
self.assembly_path.as_ref(),
type_name,
method_name,
)
}
}