🖨️ Allocator breakdown fmt (#130)

* test debug_print_breakdown

* remove copy-paste lines, code that actually compiles now

* add d3d12 version, sort by size

* remove unused self

* move functions to allocator struct

* modify function to return formatted result

* replace fmt function with new version

* writeln!

* writeln!

* apply suggestions

* extend()

* remove index

* const

* share const between backends

Author: EmilioLaiso

src/allocator/mod.rs

@@ -86,3 +86,21 @@ pub(crate) trait SubAllocator: SubAllocatorBase + std::fmt::Debug {
         self.allocated() == 0
     }
 }
+
+pub(crate) const VISUALIZER_TABLE_MAX_ENTRY_NAME_LEN: usize = 40;
+
+pub(crate) fn fmt_bytes(mut amount: u64) -> String {
+    const SUFFIX: [&str; 5] = ["B", "KB", "MB", "GB", "TB"];
+
+    let mut idx = 0;
+    let mut print_amount = amount as f64;
+    loop {
+        if amount < 1024 {
+            return format!("{:.2} {}", print_amount, SUFFIX[idx]);
+        }
+
+        print_amount = amount as f64 / 1024.0;
+        amount /= 1024;
+        idx += 1;
+    }
+}

src/d3d12/mod.rs

@@ -1,5 +1,7 @@
 #![deny(clippy::unimplemented, clippy::unwrap_used, clippy::ok_expect)]
 
+use std::fmt;
+
 use log::{debug, Level};
 
 use windows::Win32::{Foundation::E_OUTOFMEMORY, Graphics::Direct3D12::*};
@@ -72,7 +74,9 @@ pub use visualizer::AllocatorVisualizer;
 use super::allocator;
 use super::allocator::AllocationType;
 
-use crate::{AllocationError, AllocatorDebugSettings, MemoryLocation, Result};
+use crate::{
+    allocator::fmt_bytes, AllocationError, AllocatorDebugSettings, MemoryLocation, Result,
+};
 
 /// [`ResourceCategory`] is used for supporting [`D3D12_RESOURCE_HEAP_TIER_1`].
 /// [`ResourceCategory`] will be ignored if device supports [`D3D12_RESOURCE_HEAP_TIER_2`].
@@ -536,7 +540,6 @@ impl MemoryType {
     }
 }
 
-#[derive(Debug)]
 pub struct Allocator {
     device: ID3D12Device,
     debug_settings: AllocatorDebugSettings,
@@ -740,6 +743,44 @@ impl Allocator {
     }
 }
 
+impl fmt::Debug for Allocator {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let mut allocation_report = vec![];
+
+        for memory_type in &self.memory_types {
+            for block in memory_type.memory_blocks.iter().flatten() {
+                allocation_report.extend(block.sub_allocator.report_allocations())
+            }
+        }
+
+        let total_size_in_bytes = allocation_report.iter().map(|report| report.size).sum();
+
+        allocation_report.sort_by_key(|alloc| std::cmp::Reverse(alloc.size));
+
+        writeln!(
+            f,
+            "================================================================"
+        )?;
+        writeln!(
+            f,
+            "ALLOCATION BREAKDOWN ({})",
+            fmt_bytes(total_size_in_bytes)
+        )?;
+
+        for alloc in &allocation_report {
+            writeln!(
+                f,
+                "{:max_len$.max_len$}\t- {}",
+                alloc.name,
+                fmt_bytes(alloc.size),
+                max_len = allocator::VISUALIZER_TABLE_MAX_ENTRY_NAME_LEN,
+            )?;
+        }
+
+        Ok(())
+    }
+}
+
 impl Drop for Allocator {
     fn drop(&mut self) {
         if self.debug_settings.log_leaks_on_shutdown {

src/vulkan/mod.rs

@@ -11,7 +11,9 @@ use ash::vk;
 use log::{debug, warn, Level};
 use std::fmt;
 
-use crate::{AllocationError, AllocatorDebugSettings, MemoryLocation, Result};
+use crate::{
+    allocator::fmt_bytes, AllocationError, AllocatorDebugSettings, MemoryLocation, Result,
+};
 
 #[derive(Clone, Debug)]
 pub struct AllocationCreateDesc<'a> {
@@ -453,12 +455,39 @@ pub struct Allocator {
 
 impl fmt::Debug for Allocator {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        f.debug_struct("Allocator")
-            .field("memory_types", &self.memory_types)
-            .field("memory_heaps", &self.memory_heaps)
-            .field("buffer_image_granularity", &self.buffer_image_granularity)
-            .field("debug_settings", &self.debug_settings)
-            .finish()
+        let mut allocation_report = vec![];
+
+        for memory_type in &self.memory_types {
+            for block in memory_type.memory_blocks.iter().flatten() {
+                allocation_report.extend(block.sub_allocator.report_allocations())
+            }
+        }
+
+        let total_size_in_bytes = allocation_report.iter().map(|report| report.size).sum();
+
+        allocation_report.sort_by_key(|alloc| std::cmp::Reverse(alloc.size));
+
+        writeln!(
+            f,
+            "================================================================"
+        )?;
+        writeln!(
+            f,
+            "ALLOCATION BREAKDOWN ({})",
+            fmt_bytes(total_size_in_bytes)
+        )?;
+
+        for alloc in &allocation_report {
+            writeln!(
+                f,
+                "{:max_len$.max_len$}\t- {}",
+                alloc.name,
+                fmt_bytes(alloc.size),
+                max_len = allocator::VISUALIZER_TABLE_MAX_ENTRY_NAME_LEN,
+            )?;
+        }
+
+        Ok(())
     }
 }
 

src/vulkan/visualizer.rs

@@ -1,7 +1,7 @@
 #![allow(clippy::new_without_default)]
 
 use super::Allocator;
-use crate::allocator::resolve_backtrace;
+use crate::allocator::{fmt_bytes, resolve_backtrace};
 use crate::visualizer::ColorScheme;
 use log::error;
 
@@ -308,22 +308,6 @@ impl AllocatorVisualizer {
             total_size_in_bytes = allocation_report.iter().map(|report| report.size).sum();
         }
 
-        let suffix = ["B", "KB", "MB", "GB", "TB"];
-
-        let fmt_bytes = |mut amount: u64| -> String {
-            let mut idx = 0;
-            let mut print_amount = amount as f64;
-            loop {
-                if amount < 1024 {
-                    return format!("{:.2} {}", print_amount, suffix[idx]);
-                }
-
-                print_amount = amount as f64 / 1024.0;
-                amount /= 1024;
-                idx += 1;
-            }
-        };
-
         let mut window = imgui::Window::new(format!(
             "Allocation Breakdown ({})###allocation_breakdown_window",
             fmt_bytes(total_size_in_bytes)