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
use crate::instance::Instance;
use ash::extensions::ext;
use ash::vk;
use std::error::Error;
use std::ffi::CStr;
use std::fmt;
use std::os::raw::{c_char, c_void};
use std::sync::Arc;

#[derive(Debug, Copy, Clone)]
pub enum MessageLevel {
    Information,
    Warning,
    Perfomance,
    Error,
    Debug,
}

impl From<vk::DebugReportFlagsEXT> for MessageLevel {
    fn from(flags: vk::DebugReportFlagsEXT) -> Self {
        if flags.contains(vk::DebugReportFlagsEXT::ERROR) {
            return Self::Error;
        }

        if flags.contains(vk::DebugReportFlagsEXT::WARNING) {
            return Self::Warning;
        }

        if flags.contains(vk::DebugReportFlagsEXT::PERFORMANCE_WARNING) {
            return Self::Perfomance;
        }

        if flags.contains(vk::DebugReportFlagsEXT::DEBUG) {
            return Self::Debug;
        }

        if flags.contains(vk::DebugReportFlagsEXT::INFORMATION) {
            return Self::Information;
        }

        Self::Error
    }
}

impl fmt::Display for MessageLevel {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match &self {
            MessageLevel::Information => write!(f, "INFO"),
            MessageLevel::Warning => write!(f, "WARN"),
            MessageLevel::Perfomance => write!(f, "PERF"),
            MessageLevel::Error => write!(f, "ERRO"),
            MessageLevel::Debug => write!(f, "DEBG"),
        }
    }
}

impl From<MessageLevel> for log::Level {
    fn from(ml: MessageLevel) -> Self {
        match ml {
            MessageLevel::Information => log::Level::Info,
            MessageLevel::Warning => log::Level::Warn,
            MessageLevel::Perfomance => log::Level::Warn,
            MessageLevel::Error => log::Level::Error,
            MessageLevel::Debug => log::Level::Debug,
        }
    }
}

pub struct Callback(pub Box<dyn Fn(String, MessageLevel) + 'static>);

pub struct DebugReportBuilder {
    callback: Callback,
    flags: vk::DebugReportFlagsEXT,
}

impl Default for DebugReportBuilder {
    fn default() -> Self {
        let callback = |msg, level| println!("Vulkan callback report [{}]: {}", level, msg);
        Self {
            callback: Callback(Box::new(callback)),
            flags: vk::DebugReportFlagsEXT::all(),
        }
    }
}

impl DebugReportBuilder {
    pub fn with_flags(mut self, flags: vk::DebugReportFlagsEXT) -> Self {
        self.flags = flags;
        self
    }

    pub fn with_callback(mut self, callback: Callback) -> Self {
        self.callback = callback;
        self
    }

    pub fn build(self, instance: Instance) -> DebugReportResult<DebugReport> {
        let cb = Box::new(self.callback);
        let ud = Box::leak(cb) as *mut Callback;
        let ud_void = ud as *mut c_void;

        let create_info = vk::DebugReportCallbackCreateInfoEXT {
            flags: self.flags,
            pfn_callback: Some(debug_report_callback),
            p_user_data: ud_void,
            ..Default::default()
        };

        DebugReport::new(instance, &create_info, ud)
    }

    pub fn default_logger_callback() -> Callback {
        let callback = |msg, level: MessageLevel| {
            log::log!(level.into(), "Vulkan report: {}", msg);
        };
        Callback(Box::new(callback))
    }
}

unsafe extern "system" fn debug_report_callback(
    flags: vk::DebugReportFlagsEXT,
    _: vk::DebugReportObjectTypeEXT,
    _: u64,
    _: usize,
    _: i32,
    _: *const c_char,
    p_message: *const c_char,
    p_user_data: *mut c_void,
) -> vk::Bool32 {
    let callback: *mut Callback = p_user_data.cast();
    let callback_ref = callback.as_ref();
    let msg = CStr::from_ptr(p_message);
    let str = msg.to_string_lossy();
    let level = flags.into();
    match callback_ref {
        Some(cb) => cb.0(format!("{}", str), level),
        None => eprintln!("Can't dereference vk debug report callback pointer"),
    }

    vk::FALSE
}

#[derive(Clone)]
pub struct DebugReport {
    unique_debug_report: Arc<UniqueDebugReport>,
}

impl DebugReport {
    pub fn new(
        instance: Instance,
        create_info: &vk::DebugReportCallbackCreateInfoEXT,
        callback: *mut Callback,
    ) -> DebugReportResult<Self> {
        UniqueDebugReport::new(instance, create_info, callback).map(|uniq| Self {
            unique_debug_report: Arc::new(uniq),
        })
    }

    ///# Safety
    /// TODO
    pub unsafe fn handle(&self) -> &vk::DebugReportCallbackEXT {
        &self.unique_debug_report.handle()
    }

    pub fn instance(&self) -> &Instance {
        &self.unique_debug_report.instance()
    }
}

struct UniqueDebugReport {
    instance: Instance,
    debug_report: ext::DebugReport,
    handle: vk::DebugReportCallbackEXT,
    callback: *mut Callback,
}

impl UniqueDebugReport {
    pub fn new(
        instance: Instance,
        create_info: &vk::DebugReportCallbackCreateInfoEXT,
        callback: *mut Callback,
    ) -> DebugReportResult<Self> {
        let level: MessageLevel = create_info.flags.into();
        log::trace!("Creating vk debug report with level: {}", level);
        let instance_raw = unsafe { instance.handle() }.clone();
        let debug_report = ext::DebugReport::new(instance.entry(), &instance_raw);
        let handle = unsafe { debug_report.create_debug_report_callback(create_info, None)? };
        Ok(Self {
            debug_report,
            handle,
            instance,
            callback,
        })
    }

    pub unsafe fn handle(&self) -> &vk::DebugReportCallbackEXT {
        &self.handle
    }

    pub fn instance(&self) -> &Instance {
        &self.instance
    }
}

impl Drop for UniqueDebugReport {
    fn drop(&mut self) {
        log::trace!("Destroying vk debug report with it's callback");
        unsafe {
            self.debug_report
                .destroy_debug_report_callback(self.handle, None);
            let _cb = Box::from_raw(self.callback);
        }
    }
}

pub type DebugReportResult<T> = Result<T, CreateDebugReportError>;

#[derive(Debug)]
pub enum CreateDebugReportError {
    VkError(vk::Result),
}

impl Error for CreateDebugReportError {}

impl fmt::Display for CreateDebugReportError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            CreateDebugReportError::VkError(e) => {
                write!(f, "Vulkan debug report creation failed: {}", e)
            }
        }
    }
}

impl From<vk::Result> for CreateDebugReportError {
    fn from(e: vk::Result) -> Self {
        Self::VkError(e)
    }
}