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 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
// Copyright (c) 2016 The vulkano developers
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>,
// at your option. All files in the project carrying such
// notice may not be copied, modified, or distributed except
// according to those terms.
//! Debug messenger called by intermediate layers or by the driver.
//!
//! When working on an application, it is recommended to register a debug messenger. For example if
//! you enable the validation layers provided by the official Vulkan SDK, they will warn you about
//! invalid API usages or performance problems by calling this callback. The callback can also
//! be called by the driver or by whatever intermediate layer is activated.
//!
//! Note that the vulkano library can also emit messages to warn you about performance issues.
//! TODO: ^ that's not the case yet, need to choose whether we keep this idea
//!
//! # Examples
//!
//! ```
//! # use vulkano::instance::Instance;
//! # use std::sync::Arc;
//! # let instance: Arc<Instance> = return;
//! use vulkano::instance::debug::{
//! DebugUtilsMessenger, DebugUtilsMessengerCallback, DebugUtilsMessengerCreateInfo,
//! };
//!
//! let _callback = unsafe {
//! DebugUtilsMessenger::new(
//! instance,
//! DebugUtilsMessengerCreateInfo::user_callback(
//! DebugUtilsMessengerCallback::new(|message_severity, message_type, callback_data| {
//! println!("Debug callback: {:?}", callback_data.message);
//! }),
//! ),
//! ).ok()
//! };
//! ```
//!
//! Note that you must keep the `_callback` object alive for as long as you want your callback to
//! be callable. If you don't store the return value of `DebugUtilsMessenger`'s constructor in a
//! variable, it will be immediately destroyed and your callback will not work.
use super::{Instance, InstanceExtensions};
use crate::{
macros::{vulkan_bitflags, vulkan_enum},
DebugWrapper, Requires, RequiresAllOf, RequiresOneOf, Validated, ValidationError, Version,
VulkanError, VulkanObject,
};
use std::{
ffi::{c_void, CStr},
fmt::{Debug, Error as FmtError, Formatter},
mem::MaybeUninit,
panic::{catch_unwind, AssertUnwindSafe, RefUnwindSafe},
ptr, slice,
sync::Arc,
};
/// Registration of a callback called by validation layers.
///
/// The callback can be called as long as this object is alive.
#[must_use = "The DebugUtilsMessenger object must be kept alive for as long as you want your callback to be called"]
pub struct DebugUtilsMessenger {
handle: ash::vk::DebugUtilsMessengerEXT,
instance: DebugWrapper<Arc<Instance>>,
_user_callback: Arc<DebugUtilsMessengerCallback>,
}
impl DebugUtilsMessenger {
/// Initializes a debug callback.
#[inline]
pub fn new(
instance: Arc<Instance>,
create_info: DebugUtilsMessengerCreateInfo,
) -> Result<Self, Validated<VulkanError>> {
Self::validate_new(&instance, &create_info)?;
unsafe { Ok(Self::new_unchecked(instance, create_info)?) }
}
fn validate_new(
instance: &Instance,
create_info: &DebugUtilsMessengerCreateInfo,
) -> Result<(), Box<ValidationError>> {
if !instance.enabled_extensions().ext_debug_utils {
return Err(Box::new(ValidationError {
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::InstanceExtension(
"ext_debug_utils",
)])]),
..Default::default()
}));
}
create_info
.validate(instance)
.map_err(|err| err.add_context("create_info"))?;
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn new_unchecked(
instance: Arc<Instance>,
create_info: DebugUtilsMessengerCreateInfo,
) -> Result<Self, VulkanError> {
let DebugUtilsMessengerCreateInfo {
message_severity,
message_type,
user_callback,
_ne: _,
} = create_info;
let create_info_vk = ash::vk::DebugUtilsMessengerCreateInfoEXT {
flags: ash::vk::DebugUtilsMessengerCreateFlagsEXT::empty(),
message_severity: message_severity.into(),
message_type: message_type.into(),
pfn_user_callback: Some(trampoline),
p_user_data: user_callback.as_ptr() as *const c_void as *mut _,
..Default::default()
};
let handle = {
let fns = instance.fns();
let mut output = MaybeUninit::uninit();
(fns.ext_debug_utils.create_debug_utils_messenger_ext)(
instance.handle(),
&create_info_vk,
ptr::null(),
output.as_mut_ptr(),
)
.result()
.map_err(VulkanError::from)?;
output.assume_init()
};
Ok(DebugUtilsMessenger {
handle,
instance: DebugWrapper(instance),
_user_callback: user_callback,
})
}
}
impl Drop for DebugUtilsMessenger {
#[inline]
fn drop(&mut self) {
unsafe {
let fns = self.instance.fns();
(fns.ext_debug_utils.destroy_debug_utils_messenger_ext)(
self.instance.handle(),
self.handle,
ptr::null(),
);
}
}
}
impl Debug for DebugUtilsMessenger {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
let Self {
handle,
instance,
_user_callback: _,
} = self;
f.debug_struct("DebugUtilsMessenger")
.field("handle", handle)
.field("instance", instance)
.finish_non_exhaustive()
}
}
/// Parameters to create a `DebugUtilsMessenger`.
#[derive(Clone)]
pub struct DebugUtilsMessengerCreateInfo {
/// The message severity types that the callback should be called for.
///
/// The value must not be empty.
///
/// The default value is `MessageSeverity::errors_and_warnings()`.
pub message_severity: DebugUtilsMessageSeverity,
/// The message types that the callback should be called for.
///
/// The value must not be empty.
///
/// The default value is `MessageType::general()`.
pub message_type: DebugUtilsMessageType,
/// The closure that should be called.
///
/// The closure must not make any calls to the Vulkan API.
/// If the closure panics, the panic is caught and ignored.
pub user_callback: Arc<DebugUtilsMessengerCallback>,
pub _ne: crate::NonExhaustive,
}
impl DebugUtilsMessengerCreateInfo {
/// Returns a `DebugUtilsMessengerCreateInfo` with the specified `user_callback`.
#[inline]
pub fn user_callback(user_callback: Arc<DebugUtilsMessengerCallback>) -> Self {
Self {
message_severity: DebugUtilsMessageSeverity::ERROR | DebugUtilsMessageSeverity::WARNING,
message_type: DebugUtilsMessageType::GENERAL,
user_callback,
_ne: crate::NonExhaustive(()),
}
}
#[inline]
pub(crate) fn validate(&self, instance: &Instance) -> Result<(), Box<ValidationError>> {
self.validate_raw(instance.api_version(), instance.enabled_extensions())
}
pub(crate) fn validate_raw(
&self,
instance_api_version: Version,
instance_extensions: &InstanceExtensions,
) -> Result<(), Box<ValidationError>> {
let &DebugUtilsMessengerCreateInfo {
message_severity,
message_type,
user_callback: _,
_ne: _,
} = self;
message_severity
.validate_instance_raw(instance_api_version, instance_extensions)
.map_err(|err| {
err.add_context("message_severity").set_vuids(&[
"VUID-VkDebugUtilsMessengerCreateInfoEXT-messageSeverity-parameter",
])
})?;
if message_severity.is_empty() {
return Err(Box::new(ValidationError {
context: "message_severity".into(),
problem: "is empty".into(),
vuids: &["VUID-VkDebugUtilsMessengerCreateInfoEXT-messageSeverity-requiredbitmask"],
..Default::default()
}));
}
message_type
.validate_instance_raw(instance_api_version, instance_extensions)
.map_err(|err| {
err.add_context("message_type")
.set_vuids(&["VUID-VkDebugUtilsMessengerCreateInfoEXT-messageType-parameter"])
})?;
if message_type.is_empty() {
return Err(Box::new(ValidationError {
context: "message_type".into(),
problem: "is empty".into(),
vuids: &["VUID-VkDebugUtilsMessengerCreateInfoEXT-messageType-requiredbitmask"],
..Default::default()
}));
}
// VUID-PFN_vkDebugUtilsMessengerCallbackEXT-None-04769
// Can't be checked, creation is unsafe.
Ok(())
}
}
impl Debug for DebugUtilsMessengerCreateInfo {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
let Self {
message_severity,
message_type,
user_callback: _,
_ne: _,
} = self;
f.debug_struct("DebugUtilsMessengerCreateInfo")
.field("message_severity", message_severity)
.field("message_type", message_type)
.finish_non_exhaustive()
}
}
/// The callback function for debug messages.
pub struct DebugUtilsMessengerCallback(CallbackData);
type CallbackData = Box<
dyn Fn(DebugUtilsMessageSeverity, DebugUtilsMessageType, DebugUtilsMessengerCallbackData<'_>)
+ RefUnwindSafe
+ Send
+ Sync,
>;
impl DebugUtilsMessengerCallback {
/// Returns a new `DebugUtilsMessengerCallback` wrapping the provided function.
///
/// # Safety
///
/// - `func` must not make any calls to the Vulkan API.
pub unsafe fn new(
func: impl Fn(
DebugUtilsMessageSeverity,
DebugUtilsMessageType,
DebugUtilsMessengerCallbackData<'_>,
) + RefUnwindSafe
+ Send
+ Sync
+ 'static,
) -> Arc<Self> {
Arc::new(Self(Box::new(func)))
}
pub(crate) fn as_ptr(&self) -> *const CallbackData {
&self.0 as _
}
}
pub(super) unsafe extern "system" fn trampoline(
message_severity_vk: ash::vk::DebugUtilsMessageSeverityFlagsEXT,
message_types_vk: ash::vk::DebugUtilsMessageTypeFlagsEXT,
callback_data_vk: *const ash::vk::DebugUtilsMessengerCallbackDataEXT,
user_data_vk: *mut c_void,
) -> ash::vk::Bool32 {
// Since we box the closure, the type system doesn't detect that the `UnwindSafe`
// bound is enforced. Therefore we enforce it manually.
let _ = catch_unwind(AssertUnwindSafe(move || {
let ash::vk::DebugUtilsMessengerCallbackDataEXT {
s_type: _,
p_next: _,
flags: _,
p_message_id_name,
message_id_number,
p_message,
queue_label_count,
p_queue_labels,
cmd_buf_label_count,
p_cmd_buf_labels,
object_count,
p_objects,
} = *callback_data_vk;
let callback_data = DebugUtilsMessengerCallbackData {
message_id_name: p_message_id_name
.as_ref()
.map(|p_message_id_name| CStr::from_ptr(p_message_id_name).to_str().unwrap()),
message_id_number,
message: CStr::from_ptr(p_message).to_str().unwrap(),
queue_labels: DebugUtilsMessengerCallbackLabelIter(
slice::from_raw_parts(p_queue_labels, queue_label_count as usize).iter(),
),
cmd_buf_labels: DebugUtilsMessengerCallbackLabelIter(
slice::from_raw_parts(p_cmd_buf_labels, cmd_buf_label_count as usize).iter(),
),
objects: DebugUtilsMessengerCallbackObjectNameInfoIter(
slice::from_raw_parts(p_objects, object_count as usize).iter(),
),
};
let user_callback = &*(user_data_vk as *mut CallbackData as *const CallbackData);
user_callback(
message_severity_vk.into(),
message_types_vk.into(),
callback_data,
);
}));
ash::vk::FALSE
}
/// The data of a message received by the user callback.
#[non_exhaustive]
pub struct DebugUtilsMessengerCallbackData<'a> {
/// The particular message ID that is associated with the provided message.
///
/// If the message is from a validation layer, then this may specify the part of the Vulkan
/// specification that was validated.
pub message_id_name: Option<&'a str>,
/// The ID number of the message.
pub message_id_number: i32,
/// The message detailing the conditions.
pub message: &'a str,
/// Labels that were active in the current queue when the callback was triggered.
pub queue_labels: DebugUtilsMessengerCallbackLabelIter<'a>,
/// Labels that were active in the current command buffer when the callback was triggered.
pub cmd_buf_labels: DebugUtilsMessengerCallbackLabelIter<'a>,
/// Objects related to the message.
pub objects: DebugUtilsMessengerCallbackObjectNameInfoIter<'a>,
}
/// The values of [`DebugUtilsLabel`], as returned to a messenger callback.
#[non_exhaustive]
pub struct DebugUtilsMessengerCallbackLabel<'a> {
/// The name of the label.
pub label_name: &'a str,
/// An RGBA color value that is associated with the label, with values in the range `0.0..=1.0`.
pub color: &'a [f32; 4],
}
#[derive(Clone, Debug)]
pub struct DebugUtilsMessengerCallbackLabelIter<'a>(slice::Iter<'a, ash::vk::DebugUtilsLabelEXT>);
impl<'a> Iterator for DebugUtilsMessengerCallbackLabelIter<'a> {
type Item = DebugUtilsMessengerCallbackLabel<'a>;
fn next(&mut self) -> Option<Self::Item> {
self.0.next().map(|label| unsafe {
let &ash::vk::DebugUtilsLabelEXT {
s_type: _,
p_next: _,
p_label_name,
ref color,
} = label;
DebugUtilsMessengerCallbackLabel {
label_name: CStr::from_ptr(p_label_name).to_str().unwrap(),
color,
}
})
}
}
/// An object that triggered a callback.
#[non_exhaustive]
pub struct DebugUtilsMessengerCallbackObjectNameInfo<'a> {
/// The type of object.
pub object_type: ash::vk::ObjectType,
/// The handle of the object.
pub object_handle: u64,
/// The name of the object, if previously set.
pub object_name: Option<&'a str>,
}
#[derive(Clone, Debug)]
pub struct DebugUtilsMessengerCallbackObjectNameInfoIter<'a>(
slice::Iter<'a, ash::vk::DebugUtilsObjectNameInfoEXT>,
);
impl<'a> Iterator for DebugUtilsMessengerCallbackObjectNameInfoIter<'a> {
type Item = DebugUtilsMessengerCallbackObjectNameInfo<'a>;
fn next(&mut self) -> Option<Self::Item> {
self.0.next().map(|info| unsafe {
let &ash::vk::DebugUtilsObjectNameInfoEXT {
s_type: _,
p_next: _,
object_type,
object_handle,
p_object_name,
} = info;
DebugUtilsMessengerCallbackObjectNameInfo {
object_type,
object_handle,
object_name: p_object_name
.as_ref()
.map(|p_object_name| CStr::from_ptr(p_object_name).to_str().unwrap()),
}
})
}
}
vulkan_bitflags! {
#[non_exhaustive]
/// Severity of message.
DebugUtilsMessageSeverity = DebugUtilsMessageSeverityFlagsEXT(u32);
/// An error that may cause undefined results, including an application crash.
ERROR = ERROR,
/// An unexpected use.
WARNING = WARNING,
/// An informational message that may be handy when debugging an application.
INFO = INFO,
/// Diagnostic information from the loader and layers.
VERBOSE = VERBOSE,
}
vulkan_bitflags! {
#[non_exhaustive]
/// Type of message.
DebugUtilsMessageType = DebugUtilsMessageTypeFlagsEXT(u32);
/// Specifies that some general event has occurred.
GENERAL = GENERAL,
/// Specifies that something has occurred during validation against the vulkan specification
VALIDATION = VALIDATION,
/// Specifies a potentially non-optimal use of Vulkan
PERFORMANCE = PERFORMANCE,
}
/// A label to associate with a span of work in a queue.
///
/// When debugging, labels can be useful to identify which queue, or where in a specific queue,
/// something happened.
#[derive(Clone, Debug)]
pub struct DebugUtilsLabel {
/// The name of the label.
///
/// The default value is empty.
pub label_name: String,
/// An RGBA color value that is associated with the label, with values in the range `0.0..=1.0`.
///
/// If set to `[0.0; 4]`, the value is ignored.
///
/// The default value is `[0.0; 4]`.
pub color: [f32; 4],
pub _ne: crate::NonExhaustive,
}
impl Default for DebugUtilsLabel {
#[inline]
fn default() -> Self {
Self {
label_name: String::new(),
color: [0.0; 4],
_ne: crate::NonExhaustive(()),
}
}
}
vulkan_enum! {
#[non_exhaustive]
/// Features of the validation layer to enable.
ValidationFeatureEnable = ValidationFeatureEnableEXT(i32);
/// The validation layer will use shader programs running on the GPU to provide additional
/// validation.
///
/// This must not be used together with `DebugPrintf`.
GpuAssisted = GPU_ASSISTED,
/// The validation layer will reserve and use one descriptor set slot for its own use.
/// The limit reported by
/// [`max_bound_descriptor_sets`](crate::device::Properties::max_bound_descriptor_sets)
/// will be reduced by 1.
///
/// `GpuAssisted` must also be enabled.
GpuAssistedReserveBindingSlot = GPU_ASSISTED_RESERVE_BINDING_SLOT,
/// The validation layer will report recommendations that are not strictly errors,
/// but that may be considered good Vulkan practice.
BestPractices = BEST_PRACTICES,
/// The validation layer will process `debugPrintfEXT` operations in shaders, and send them
/// to the debug callback.
///
/// This must not be used together with `GpuAssisted`.
DebugPrintf = DEBUG_PRINTF,
/// The validation layer will report errors relating to synchronization, such as data races and
/// the use of synchronization primitives.
SynchronizationValidation = SYNCHRONIZATION_VALIDATION,
}
vulkan_enum! {
#[non_exhaustive]
/// Features of the validation layer to disable.
ValidationFeatureDisable = ValidationFeatureDisableEXT(i32);
/// All validation is disabled.
All = ALL,
/// Shader validation is disabled.
Shaders = SHADERS,
/// Thread safety validation is disabled.
ThreadSafety = THREAD_SAFETY,
/// Stateless parameter validation is disabled.
ApiParameters = API_PARAMETERS,
/// Object lifetime validation is disabled.
ObjectLifetimes = OBJECT_LIFETIMES,
/// Core validation checks are disabled.
///
/// This also disables shader validation and GPU-assisted validation.
CoreChecks = CORE_CHECKS,
/// Protection against duplicate non-dispatchable handles is disabled.
UniqueHandles = UNIQUE_HANDLES,
/// Results of shader validation will not be cached, and are validated from scratch each time.
ShaderValidationCache = SHADER_VALIDATION_CACHE,
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{
instance::{InstanceCreateInfo, InstanceExtensions},
VulkanLibrary,
};
use std::thread;
#[test]
fn ensure_sendable() {
// It's useful to be able to initialize a DebugUtilsMessenger on one thread
// and keep it alive on another thread.
let instance = {
let library = match VulkanLibrary::new() {
Ok(x) => x,
Err(_) => return,
};
match Instance::new(
library,
InstanceCreateInfo {
enabled_extensions: InstanceExtensions {
ext_debug_utils: true,
..InstanceExtensions::empty()
},
..Default::default()
},
) {
Ok(x) => x,
Err(_) => return,
}
};
let callback = unsafe {
DebugUtilsMessenger::new(
instance,
DebugUtilsMessengerCreateInfo {
message_severity: DebugUtilsMessageSeverity::ERROR,
message_type: DebugUtilsMessageType::GENERAL
| DebugUtilsMessageType::VALIDATION
| DebugUtilsMessageType::PERFORMANCE,
..DebugUtilsMessengerCreateInfo::user_callback(
DebugUtilsMessengerCallback::new(|_, _, _| {}),
)
},
)
}
.unwrap();
thread::spawn(move || {
drop(callback);
});
}
}