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
pub use crate::fns::EntryFunctions;
use crate::{
instance::{InstanceExtensions, LayerProperties},
ExtensionProperties, OomError, SafeDeref, Version, VulkanError,
};
use libloading::{Error as LibloadingError, Library};
use std::{
error::Error,
ffi::{CStr, CString},
fmt::{Debug, Display, Error as FmtError, Formatter},
mem::transmute,
os::raw::c_char,
path::Path,
ptr,
sync::Arc,
};
#[derive(Debug)]
pub struct VulkanLibrary {
loader: Box<dyn Loader>,
fns: EntryFunctions,
api_version: Version,
extension_properties: Vec<ExtensionProperties>,
supported_extensions: InstanceExtensions,
}
impl VulkanLibrary {
pub fn new() -> Result<Arc<Self>, LoadingError> {
#[cfg(target_os = "ios")]
#[allow(non_snake_case)]
fn def_loader_impl() -> Result<Box<dyn Loader>, LoadingError> {
let loader = crate::statically_linked_vulkan_loader!();
Ok(Box::new(loader))
}
#[cfg(not(target_os = "ios"))]
fn def_loader_impl() -> Result<Box<dyn Loader>, LoadingError> {
#[cfg(windows)]
fn get_path() -> &'static Path {
Path::new("vulkan-1.dll")
}
#[cfg(all(unix, not(target_os = "android"), not(target_os = "macos")))]
fn get_path() -> &'static Path {
Path::new("libvulkan.so.1")
}
#[cfg(target_os = "macos")]
fn get_path() -> &'static Path {
Path::new("libvulkan.1.dylib")
}
#[cfg(target_os = "android")]
fn get_path() -> &'static Path {
Path::new("libvulkan.so")
}
let loader = unsafe { DynamicLibraryLoader::new(get_path())? };
Ok(Box::new(loader))
}
def_loader_impl().and_then(VulkanLibrary::with_loader)
}
pub fn with_loader(loader: impl Loader + 'static) -> Result<Arc<Self>, LoadingError> {
let fns = EntryFunctions::load(|name| unsafe {
loader
.get_instance_proc_addr(ash::vk::Instance::null(), name.as_ptr())
.map_or(ptr::null(), |func| func as _)
});
let api_version = unsafe { Self::get_api_version(&loader)? };
let extension_properties = unsafe { Self::get_extension_properties(&fns, None)? };
let supported_extensions = extension_properties
.iter()
.map(|property| property.extension_name.as_str())
.collect();
Ok(Arc::new(VulkanLibrary {
loader: Box::new(loader),
fns,
api_version,
extension_properties,
supported_extensions,
}))
}
unsafe fn get_api_version(loader: &impl Loader) -> Result<Version, VulkanError> {
let name = CStr::from_bytes_with_nul_unchecked(b"vkEnumerateInstanceVersion\0");
let func = loader.get_instance_proc_addr(ash::vk::Instance::null(), name.as_ptr());
let version = if let Some(func) = func {
let func: ash::vk::PFN_vkEnumerateInstanceVersion = transmute(func);
let mut api_version = 0;
func(&mut api_version).result().map_err(VulkanError::from)?;
Version::from(api_version)
} else {
Version {
major: 1,
minor: 0,
patch: 0,
}
};
Ok(version)
}
unsafe fn get_extension_properties(
fns: &EntryFunctions,
layer: Option<&str>,
) -> Result<Vec<ExtensionProperties>, VulkanError> {
let layer_vk = layer.map(|layer| CString::new(layer).unwrap());
loop {
let mut count = 0;
(fns.v1_0.enumerate_instance_extension_properties)(
layer_vk
.as_ref()
.map_or(ptr::null(), |layer| layer.as_ptr()),
&mut count,
ptr::null_mut(),
)
.result()
.map_err(VulkanError::from)?;
let mut output = Vec::with_capacity(count as usize);
let result = (fns.v1_0.enumerate_instance_extension_properties)(
layer_vk
.as_ref()
.map_or(ptr::null(), |layer| layer.as_ptr()),
&mut count,
output.as_mut_ptr(),
);
match result {
ash::vk::Result::SUCCESS => {
output.set_len(count as usize);
return Ok(output.into_iter().map(Into::into).collect());
}
ash::vk::Result::INCOMPLETE => (),
err => return Err(VulkanError::from(err)),
}
}
}
#[inline]
pub fn fns(&self) -> &EntryFunctions {
&self.fns
}
#[inline]
pub fn api_version(&self) -> Version {
self.api_version
}
#[inline]
pub fn extension_properties(&self) -> &[ExtensionProperties] {
&self.extension_properties
}
#[inline]
pub fn supported_extensions(&self) -> &InstanceExtensions {
&self.supported_extensions
}
pub fn layer_properties(
&self,
) -> Result<impl ExactSizeIterator<Item = LayerProperties>, OomError> {
let fns = self.fns();
let layer_properties = unsafe {
loop {
let mut count = 0;
(fns.v1_0.enumerate_instance_layer_properties)(&mut count, ptr::null_mut())
.result()
.map_err(VulkanError::from)?;
let mut properties = Vec::with_capacity(count as usize);
let result = (fns.v1_0.enumerate_instance_layer_properties)(
&mut count,
properties.as_mut_ptr(),
);
match result {
ash::vk::Result::SUCCESS => {
properties.set_len(count as usize);
break properties;
}
ash::vk::Result::INCOMPLETE => (),
err => return Err(VulkanError::from(err).into()),
}
}
};
Ok(layer_properties
.into_iter()
.map(|p| LayerProperties { props: p }))
}
#[inline]
pub fn layer_extension_properties(
&self,
layer: &str,
) -> Result<Vec<ExtensionProperties>, VulkanError> {
unsafe { Self::get_extension_properties(&self.fns, Some(layer)) }
}
#[inline]
pub fn supported_layer_extensions(
&self,
layer: &str,
) -> Result<InstanceExtensions, VulkanError> {
Ok(self
.layer_extension_properties(layer)?
.iter()
.map(|property| property.extension_name.as_str())
.collect())
}
#[inline]
pub fn supported_extensions_with_layers<'a>(
&self,
layers: impl IntoIterator<Item = &'a str>,
) -> Result<InstanceExtensions, VulkanError> {
layers
.into_iter()
.try_fold(self.supported_extensions, |extensions, layer| {
self.supported_layer_extensions(layer)
.map(|layer_extensions| extensions.union(&layer_extensions))
})
}
#[inline]
pub unsafe fn get_instance_proc_addr(
&self,
instance: ash::vk::Instance,
name: *const c_char,
) -> ash::vk::PFN_vkVoidFunction {
self.loader.get_instance_proc_addr(instance, name)
}
}
pub unsafe trait Loader: Send + Sync {
unsafe fn get_instance_proc_addr(
&self,
instance: ash::vk::Instance,
name: *const c_char,
) -> ash::vk::PFN_vkVoidFunction;
}
unsafe impl<T> Loader for T
where
T: SafeDeref + Send + Sync,
T::Target: Loader,
{
unsafe fn get_instance_proc_addr(
&self,
instance: ash::vk::Instance,
name: *const c_char,
) -> ash::vk::PFN_vkVoidFunction {
(**self).get_instance_proc_addr(instance, name)
}
}
impl Debug for dyn Loader {
fn fmt(&self, _f: &mut Formatter<'_>) -> Result<(), FmtError> {
Ok(())
}
}
pub struct DynamicLibraryLoader {
_vk_lib: Library,
get_instance_proc_addr: ash::vk::PFN_vkGetInstanceProcAddr,
}
impl DynamicLibraryLoader {
pub unsafe fn new(path: impl AsRef<Path>) -> Result<DynamicLibraryLoader, LoadingError> {
let vk_lib = Library::new(path.as_ref()).map_err(LoadingError::LibraryLoadFailure)?;
let get_instance_proc_addr = *vk_lib
.get(b"vkGetInstanceProcAddr")
.map_err(LoadingError::LibraryLoadFailure)?;
Ok(DynamicLibraryLoader {
_vk_lib: vk_lib,
get_instance_proc_addr,
})
}
}
unsafe impl Loader for DynamicLibraryLoader {
#[inline]
unsafe fn get_instance_proc_addr(
&self,
instance: ash::vk::Instance,
name: *const c_char,
) -> ash::vk::PFN_vkVoidFunction {
(self.get_instance_proc_addr)(instance, name)
}
}
#[macro_export]
macro_rules! statically_linked_vulkan_loader {
() => {{
extern "C" {
fn vkGetInstanceProcAddr(
instance: ash::vk::Instance,
pName: *const c_char,
) -> ash::vk::PFN_vkVoidFunction;
}
struct StaticallyLinkedVulkanLoader;
unsafe impl Loader for StaticallyLinkedVulkanLoader {
unsafe fn get_instance_proc_addr(
&self,
instance: ash::vk::Instance,
name: *const c_char,
) -> ash::vk::PFN_vkVoidFunction {
vkGetInstanceProcAddr(instance, name)
}
}
StaticallyLinkedVulkanLoader
}};
}
#[derive(Debug)]
pub enum LoadingError {
LibraryLoadFailure(LibloadingError),
OomError(OomError),
}
impl Error for LoadingError {
fn source(&self) -> Option<&(dyn Error + 'static)> {
match self {
Self::OomError(err) => Some(err),
_ => None,
}
}
}
impl Display for LoadingError {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
write!(
f,
"{}",
match self {
Self::LibraryLoadFailure(_) => "failed to load the Vulkan shared library",
Self::OomError(_) => "not enough memory available",
}
)
}
}
impl From<VulkanError> for LoadingError {
fn from(err: VulkanError) -> Self {
match err {
err @ VulkanError::OutOfHostMemory => Self::OomError(OomError::from(err)),
err @ VulkanError::OutOfDeviceMemory => Self::OomError(OomError::from(err)),
_ => panic!("unexpected error: {:?}", err),
}
}
}
#[cfg(test)]
mod tests {
use super::{DynamicLibraryLoader, LoadingError};
#[test]
fn dl_open_error() {
unsafe {
match DynamicLibraryLoader::new("_non_existing_library.void") {
Err(LoadingError::LibraryLoadFailure(_)) => (),
_ => panic!(),
}
}
}
}