alloc-compose 0.5.0

//! Structures to collect allocator statistics.
//!
//! Please see the [`Proxy`] documentation for examples.
//!
//! [`Proxy`]: crate::Proxy

use crate::CallbackRef;
use core::{
    alloc::{AllocErr, Layout},
    cell::Cell,
    ptr::NonNull,
    sync::atomic::{AtomicU64, Ordering::Relaxed},
};

#[repr(usize)]
#[derive(Copy, Clone, PartialEq)]
enum Stat {
    Allocs = 0,
    Deallocs = 1,
    Grows = 2,
    Shrinks = 3,
    Owns = 4,
}
const STAT_COUNT: usize = 5;

/// A primitive counter for collectiong statistics.
#[derive(Debug, Default, PartialEq, Eq)]
pub struct Counter {
    stats: [Cell<u64>; STAT_COUNT],
}

impl PartialEq<AtomicCounter> for Counter {
    fn eq(&self, other: &AtomicCounter) -> bool {
        self.stats
            .iter()
            .zip(other.stats.iter())
            .all(|(lhs, rhs)| lhs.get() == rhs.load(Relaxed))
    }
}

impl Counter {
    fn increment_stat(&self, stat: Stat, additional: u64) {
        self.stats[stat as usize].set(self.stats[stat as usize].get() + additional)
    }
    fn get(&self, stat: Stat) -> u64 {
        self.stats[stat as usize].get()
    }
}

/// An atomic counter for collectiong statistics which can be shared between threads.
#[derive(Debug, Default)]
pub struct AtomicCounter {
    stats: [AtomicU64; STAT_COUNT],
}

impl PartialEq for AtomicCounter {
    fn eq(&self, other: &Self) -> bool {
        self.stats
            .iter()
            .zip(other.stats.iter())
            .all(|(lhs, rhs)| lhs.load(Relaxed) == rhs.load(Relaxed))
    }
}

impl PartialEq<Counter> for AtomicCounter {
    fn eq(&self, other: &Counter) -> bool {
        self.stats
            .iter()
            .zip(other.stats.iter())
            .all(|(lhs, rhs)| lhs.load(Relaxed) == rhs.get())
    }
}

impl AtomicCounter {
    fn increment_stat(&self, stat: Stat, additional: u64) {
        self.stats[stat as usize].fetch_add(additional, Relaxed);
    }
    fn get(&self, stat: Stat) -> u64 {
        self.stats[stat as usize].load(Relaxed)
    }
}

macro_rules! impl_callback_ref {
    ($tt:tt) => {
        impl $tt {
            /// Returns the number of `alloc` calls.
            #[inline]
            pub fn num_allocs(&self) -> u64 {
                self.get(Stat::Allocs)
            }

            /// Returns the number of `dealloc` calls.
            #[inline]
            pub fn num_deallocs(&self) -> u64 {
                self.get(Stat::Deallocs)
            }

            /// Returns the number of `grow` calls.
            #[inline]
            pub fn num_grows(&self) -> u64 {
                self.get(Stat::Grows)
            }

            /// Returns the number of `shrink` calls.
            #[inline]
            pub fn num_shrinks(&self) -> u64 {
                self.get(Stat::Shrinks)
            }

            /// Returns the number of `owns` calls.
            #[inline]
            pub fn num_owns(&self) -> u64 {
                self.get(Stat::Owns)
            }
        }

        unsafe impl CallbackRef for $tt {
            #[inline]
            fn after_alloc(&self, _layout: Layout, _result: Result<NonNull<[u8]>, AllocErr>) {
                self.increment_stat(Stat::Allocs, 1)
            }
            #[inline]
            fn after_alloc_zeroed(
                &self,
                _layout: Layout,
                _result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                self.increment_stat(Stat::Allocs, 1)
            }
            #[inline]
            fn after_alloc_all(&self, _layout: Layout, _result: Result<NonNull<[u8]>, AllocErr>) {
                self.increment_stat(Stat::Allocs, 1)
            }
            #[inline]
            fn after_alloc_all_zeroed(
                &self,
                _layout: Layout,
                _result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                self.increment_stat(Stat::Allocs, 1)
            }

            #[inline]
            fn before_dealloc(&self, _ptr: NonNull<u8>, _layout: Layout) {
                self.increment_stat(Stat::Deallocs, 1);
            }

            #[inline]
            fn before_dealloc_all(&self) {
                self.increment_stat(Stat::Deallocs, 1);
            }

            fn after_grow(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                _result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                self.increment_stat(Stat::Grows, 1)
            }

            fn after_grow_zeroed(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                _result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                self.increment_stat(Stat::Grows, 1)
            }

            fn after_grow_in_place(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                _result: Result<usize, AllocErr>,
            ) {
                self.increment_stat(Stat::Grows, 1)
            }

            fn after_grow_in_place_zeroed(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                _result: Result<usize, AllocErr>,
            ) {
                self.increment_stat(Stat::Grows, 1)
            }

            #[inline]
            fn after_shrink(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                _result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                self.increment_stat(Stat::Shrinks, 1)
            }

            #[inline]
            fn after_shrink_in_place(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                _result: Result<usize, AllocErr>,
            ) {
                self.increment_stat(Stat::Shrinks, 1)
            }

            #[inline]
            fn after_owns(&self, _success: bool) {
                self.increment_stat(Stat::Owns, 1)
            }
        }
    };
}

impl_callback_ref!(Counter);
impl_callback_ref!(AtomicCounter);

#[repr(usize)]
#[derive(Copy, Clone, PartialEq)]
enum FilteredStat {
    AllocsUninitializedOk = 0,
    AllocsUninitializedErr = 1,
    AllocsZeroedOk = 2,
    AllocsZeroedErr = 3,
    Deallocs = 4,
    GrowsMayMoveUninitializedOk = 5,
    GrowsMayMoveUninitializedErr = 6,
    GrowsInPlaceUninitializedOk = 7,
    GrowsInPlaceUninitializedErr = 8,
    GrowsMayMoveZeroedOk = 9,
    GrowsMayMoveZeroedErr = 10,
    GrowsInPlaceZeroedOk = 11,
    GrowsInPlaceZeroedErr = 12,
    ShrinksMayMoveOk = 13,
    ShrinksMayMoveErr = 14,
    ShrinksInPlaceOk = 15,
    ShrinksInPlaceErr = 16,
    OwnsTrue = 17,
    OwnsFalse = 18,
}
const FILTERED_STAT_COUNT: usize = 19;

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum AllocInitFilter {
    None,
    Uninitialized,
    Zeroed,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum ReallocPlacementFilter {
    None,
    MayMove,
    InPlace,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum ResultFilter {
    None,
    Ok,
    Err,
}

impl From<bool> for ResultFilter {
    fn from(success: bool) -> Self {
        if success { Self::Ok } else { Self::Err }
    }
}

/// A counter for collectiong and filtering statistics.
#[derive(Debug, Default, PartialEq, Eq)]
pub struct FilteredCounter {
    stats: [Cell<u64>; FILTERED_STAT_COUNT],
}

impl FilteredCounter {
    fn increment_stat(&self, stat: FilteredStat, additional: u64) {
        self.stats[stat as usize].set(self.stats[stat as usize].get() + additional)
    }
    fn get(&self, stat: FilteredStat) -> u64 {
        self.stats[stat as usize].get()
    }
}

impl PartialEq<FilteredAtomicCounter> for FilteredCounter {
    fn eq(&self, other: &FilteredAtomicCounter) -> bool {
        self.stats
            .iter()
            .zip(other.stats.iter())
            .all(|(lhs, rhs)| lhs.get() == rhs.load(Relaxed))
    }
}

/// An atomic counter for collectiong and filtering statistics which can be shared between threads.
#[derive(Debug, Default)]
pub struct FilteredAtomicCounter {
    stats: [AtomicU64; FILTERED_STAT_COUNT],
}

impl FilteredAtomicCounter {
    fn increment_stat(&self, stat: FilteredStat, additional: u64) {
        self.stats[stat as usize].fetch_add(additional, Relaxed);
    }
    fn get(&self, stat: FilteredStat) -> u64 {
        self.stats[stat as usize].load(Relaxed)
    }
}

impl PartialEq for FilteredAtomicCounter {
    fn eq(&self, other: &Self) -> bool {
        self.stats
            .iter()
            .zip(other.stats.iter())
            .all(|(lhs, rhs)| lhs.load(Relaxed) == rhs.load(Relaxed))
    }
}

impl PartialEq<FilteredCounter> for FilteredAtomicCounter {
    fn eq(&self, other: &FilteredCounter) -> bool {
        self.stats
            .iter()
            .zip(other.stats.iter())
            .all(|(lhs, rhs)| lhs.load(Relaxed) == rhs.get())
    }
}

macro_rules! impl_filtered_callback_ref {
    ($tt:tt) => {
        impl $tt {
            /// Returns the total number of `alloc` calls.
            #[inline]
            pub fn num_allocs(&self) -> u64 {
                self.num_allocs_filter(AllocInitFilter::None, ResultFilter::None)
            }

            /// Returns the filtered number of `alloc` calls.
            pub fn num_allocs_filter(
                &self,
                init: impl Into<AllocInitFilter>,
                result: impl Into<ResultFilter>,
            ) -> u64 {
                match (init.into(), result.into()) {
                    (AllocInitFilter::Uninitialized, ResultFilter::Ok) => {
                        self.get(FilteredStat::AllocsUninitializedOk)
                    }
                    (AllocInitFilter::Uninitialized, ResultFilter::Err) => {
                        self.get(FilteredStat::AllocsUninitializedErr)
                    }
                    (AllocInitFilter::Zeroed, ResultFilter::Ok) => {
                        self.get(FilteredStat::AllocsZeroedOk)
                    }
                    (AllocInitFilter::Zeroed, ResultFilter::Err) => {
                        self.get(FilteredStat::AllocsZeroedErr)
                    }
                    (AllocInitFilter::None, result) => {
                        self.num_allocs_filter(AllocInitFilter::Uninitialized, result)
                            + self.num_allocs_filter(AllocInitFilter::Zeroed, result)
                    }
                    (i, ResultFilter::None) => {
                        self.num_allocs_filter(i, ResultFilter::Ok)
                            + self.num_allocs_filter(i, ResultFilter::Err)
                    }
                }
            }

            /// Returns the total number of `dealloc` calls.
            #[inline]
            pub fn num_deallocs(&self) -> u64 {
                self.get(FilteredStat::Deallocs)
            }

            /// Returns the total number of `grow` calls.
            #[inline]
            pub fn num_grows(&self) -> u64 {
                self.num_grows_filter(
                    ReallocPlacementFilter::None,
                    AllocInitFilter::None,
                    ResultFilter::None,
                )
            }

            /// Returns the filtered number of `grow` calls.
            pub fn num_grows_filter(
                &self,
                placement: impl Into<ReallocPlacementFilter>,
                init: impl Into<AllocInitFilter>,
                result: impl Into<ResultFilter>,
            ) -> u64 {
                match (placement.into(), init.into(), result.into()) {
                    (
                        ReallocPlacementFilter::MayMove,
                        AllocInitFilter::Uninitialized,
                        ResultFilter::Ok,
                    ) => self.get(FilteredStat::GrowsMayMoveUninitializedOk),
                    (
                        ReallocPlacementFilter::MayMove,
                        AllocInitFilter::Uninitialized,
                        ResultFilter::Err,
                    ) => self.get(FilteredStat::GrowsMayMoveUninitializedErr),
                    (
                        ReallocPlacementFilter::MayMove,
                        AllocInitFilter::Zeroed,
                        ResultFilter::Ok,
                    ) => self.get(FilteredStat::GrowsMayMoveZeroedOk),
                    (
                        ReallocPlacementFilter::MayMove,
                        AllocInitFilter::Zeroed,
                        ResultFilter::Err,
                    ) => self.get(FilteredStat::GrowsMayMoveZeroedErr),
                    (
                        ReallocPlacementFilter::InPlace,
                        AllocInitFilter::Uninitialized,
                        ResultFilter::Ok,
                    ) => self.get(FilteredStat::GrowsInPlaceUninitializedOk),
                    (
                        ReallocPlacementFilter::InPlace,
                        AllocInitFilter::Uninitialized,
                        ResultFilter::Err,
                    ) => self.get(FilteredStat::GrowsInPlaceUninitializedErr),
                    (
                        ReallocPlacementFilter::InPlace,
                        AllocInitFilter::Zeroed,
                        ResultFilter::Ok,
                    ) => self.get(FilteredStat::GrowsInPlaceZeroedOk),
                    (
                        ReallocPlacementFilter::InPlace,
                        AllocInitFilter::Zeroed,
                        ResultFilter::Err,
                    ) => self.get(FilteredStat::GrowsInPlaceZeroedErr),
                    (ReallocPlacementFilter::None, i, result) => {
                        self.num_grows_filter(ReallocPlacementFilter::MayMove, i, result)
                            + self.num_grows_filter(ReallocPlacementFilter::InPlace, i, result)
                    }
                    (p, AllocInitFilter::None, result) => {
                        self.num_grows_filter(p, AllocInitFilter::Uninitialized, result)
                            + self.num_grows_filter(p, AllocInitFilter::Zeroed, result)
                    }
                    (p, i, ResultFilter::None) => {
                        self.num_grows_filter(p, i, ResultFilter::Ok)
                            + self.num_grows_filter(p, i, ResultFilter::Err)
                    }
                }
            }

            /// Returns the total number of `shrink` calls.
            #[inline]
            pub fn num_shrinks(&self) -> u64 {
                self.num_shrinks_filter(ReallocPlacementFilter::None, ResultFilter::None)
            }

            /// Returns the filtered number of `shrink` calls.
            pub fn num_shrinks_filter(
                &self,
                placement: ReallocPlacementFilter,
                result: impl Into<ResultFilter>,
            ) -> u64 {
                match (placement, result.into()) {
                    (ReallocPlacementFilter::MayMove, ResultFilter::Ok) => {
                        self.get(FilteredStat::ShrinksMayMoveOk)
                    }
                    (ReallocPlacementFilter::MayMove, ResultFilter::Err) => {
                        self.get(FilteredStat::ShrinksMayMoveErr)
                    }
                    (ReallocPlacementFilter::InPlace, ResultFilter::Ok) => {
                        self.get(FilteredStat::ShrinksInPlaceOk)
                    }
                    (ReallocPlacementFilter::InPlace, ResultFilter::Err) => {
                        self.get(FilteredStat::ShrinksInPlaceErr)
                    }
                    (ReallocPlacementFilter::None, result) => {
                        self.num_shrinks_filter(ReallocPlacementFilter::MayMove, result)
                            + self.num_shrinks_filter(ReallocPlacementFilter::InPlace, result)
                    }
                    (p, ResultFilter::None) => {
                        self.num_shrinks_filter(p, ResultFilter::Ok)
                            + self.num_shrinks_filter(p, ResultFilter::Err)
                    }
                }
            }

            /// Returns the total number of `owns` calls.
            #[inline]
            pub fn num_owns(&self) -> u64 {
                self.num_owns_filter(true) + self.num_owns_filter(false)
            }

            /// Returns the filtered number of `owns` calls.
            pub fn num_owns_filter(&self, success: bool) -> u64 {
                if success {
                    self.get(FilteredStat::OwnsTrue)
                } else {
                    self.get(FilteredStat::OwnsFalse)
                }
            }
        }

        unsafe impl CallbackRef for $tt {
            #[inline]
            fn after_alloc(&self, _layout: Layout, result: Result<NonNull<[u8]>, AllocErr>) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::AllocsUninitializedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::AllocsUninitializedErr, 1)
                }
            }

            #[inline]
            fn after_alloc_zeroed(&self, _layout: Layout, result: Result<NonNull<[u8]>, AllocErr>) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::AllocsZeroedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::AllocsZeroedErr, 1)
                }
            }

            #[inline]
            fn after_alloc_all(&self, _layout: Layout, result: Result<NonNull<[u8]>, AllocErr>) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::AllocsUninitializedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::AllocsUninitializedErr, 1)
                }
            }

            #[inline]
            fn after_alloc_all_zeroed(
                &self,
                _layout: Layout,
                result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::AllocsZeroedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::AllocsZeroedErr, 1)
                }
            }

            #[inline]
            fn before_dealloc(&self, _ptr: NonNull<u8>, _layout: Layout) {
                self.increment_stat(FilteredStat::Deallocs, 1);
            }

            #[inline]
            fn before_dealloc_all(&self) {
                self.increment_stat(FilteredStat::Deallocs, 1);
            }

            fn after_grow(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::GrowsMayMoveUninitializedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::GrowsMayMoveUninitializedErr, 1)
                }
            }

            fn after_grow_zeroed(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::GrowsMayMoveZeroedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::GrowsMayMoveZeroedErr, 1)
                }
            }

            fn after_grow_in_place(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                result: Result<usize, AllocErr>,
            ) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::GrowsInPlaceUninitializedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::GrowsInPlaceUninitializedErr, 1)
                }
            }

            fn after_grow_in_place_zeroed(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                result: Result<usize, AllocErr>,
            ) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::GrowsInPlaceZeroedOk, 1)
                } else {
                    self.increment_stat(FilteredStat::GrowsInPlaceZeroedErr, 1)
                }
            }

            #[inline]
            fn after_shrink(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                result: Result<NonNull<[u8]>, AllocErr>,
            ) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::ShrinksMayMoveOk, 1)
                } else {
                    self.increment_stat(FilteredStat::ShrinksMayMoveErr, 1)
                }
            }

            #[inline]
            fn after_shrink_in_place(
                &self,
                _ptr: NonNull<u8>,
                _layout: Layout,
                _new_size: usize,
                result: Result<usize, AllocErr>,
            ) {
                if result.is_ok() {
                    self.increment_stat(FilteredStat::ShrinksInPlaceOk, 1)
                } else {
                    self.increment_stat(FilteredStat::ShrinksInPlaceErr, 1)
                }
            }

            #[inline]
            fn after_owns(&self, success: bool) {
                if success {
                    self.increment_stat(FilteredStat::OwnsTrue, 1)
                } else {
                    self.increment_stat(FilteredStat::OwnsFalse, 1)
                }
            }
        }
    };
}
impl_filtered_callback_ref!(FilteredCounter);
impl_filtered_callback_ref!(FilteredAtomicCounter);

#[cfg(test)]
mod tests {
    use super::{AtomicCounter, Counter, FilteredAtomicCounter, FilteredCounter};
    use crate::{helper, CallbackRef, Owns, Proxy, ReallocInPlace, Region};
    use std::{
        alloc::{AllocRef, Layout},
        mem::MaybeUninit,
    };

    #[allow(clippy::too_many_lines)]
    fn run_suite(callbacks: &impl CallbackRef) {
        let mut region = [MaybeUninit::new(0); 32];
        let mut alloc = Proxy {
            alloc: helper::tracker(Region::new(&mut region)),
            callbacks,
        };

        assert!(alloc.alloc(Layout::new::<[u8; 64]>()).is_err());
        assert!(alloc.alloc_zeroed(Layout::new::<[u8; 64]>()).is_err());

        unsafe {
            let memory = alloc.alloc(Layout::new::<[u8; 4]>()).unwrap();
            let memory_tmp = alloc.alloc_zeroed(Layout::new::<[u8; 4]>()).unwrap();
            assert!(
                alloc
                    .shrink_in_place(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 2,)
                    .is_err()
            );
            alloc.dealloc(memory_tmp.as_non_null_ptr(), Layout::new::<[u8; 4]>());

            assert!(
                alloc
                    .grow_zeroed(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 80,)
                    .is_err()
            );
            assert!(
                alloc
                    .grow_in_place_zeroed(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 80,)
                    .is_err()
            );
            assert!(
                alloc
                    .grow(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 80,)
                    .is_err()
            );
            assert!(
                alloc
                    .grow_in_place(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 80,)
                    .is_err()
            );
            let memory = alloc
                .grow_zeroed(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 8)
                .unwrap();
            let memory = alloc
                .grow(memory.as_non_null_ptr(), Layout::new::<[u8; 8]>(), 16)
                .unwrap();
            let memory = alloc
                .shrink(memory.as_non_null_ptr(), Layout::new::<[u8; 16]>(), 4)
                .unwrap();

            alloc
                .grow_in_place_zeroed(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 4)
                .unwrap();
            alloc
                .grow_in_place(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 4)
                .unwrap();
            alloc
                .shrink_in_place(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>(), 4)
                .unwrap();

            assert!(alloc.owns(memory));
            alloc.dealloc(memory.as_non_null_ptr(), Layout::new::<[u8; 4]>());
            assert!(!alloc.owns(memory));
        }
    }

    #[test]
    #[rustfmt::skip]
    fn counter() {
        let counter = Counter::default();
        run_suite(counter.by_ref());

        assert_eq!(counter.num_allocs(), 4);
        assert_eq!(counter.num_grows(), 8);
        assert_eq!(counter.num_shrinks(), 3);
        assert_eq!(counter.num_owns(), 2);
        assert_eq!(counter.num_deallocs(), 2);

        let atomic_counter = AtomicCounter::default();
        run_suite(atomic_counter.by_ref());

        assert_eq!(atomic_counter.num_allocs(), 4);
        assert_eq!(atomic_counter.num_grows(), 8);
        assert_eq!(atomic_counter.num_shrinks(), 3);
        assert_eq!(atomic_counter.num_owns(), 2);
        assert_eq!(atomic_counter.num_deallocs(), 2);

        assert_eq!(counter, atomic_counter);
        assert_eq!(atomic_counter, counter);
        assert_eq!(atomic_counter, atomic_counter);
    }

    #[test]
    #[rustfmt::skip]
    #[allow(clippy::cognitive_complexity)]
    fn filtered_counter() {
        use super::AllocInitFilter::*;
        use super::ReallocPlacementFilter::*;

        let counter = FilteredCounter::default();
        run_suite(counter.by_ref());

        assert_eq!(counter.num_allocs_filter(Uninitialized, false), 1);
        assert_eq!(counter.num_allocs_filter(Zeroed, false), 1);
        assert_eq!(counter.num_allocs_filter(Uninitialized, true), 1);
        assert_eq!(counter.num_allocs_filter(Zeroed, true), 1);
        assert_eq!(counter.num_allocs(), 4);
        assert_eq!(counter.num_grows_filter(MayMove, Uninitialized, false), 1);
        assert_eq!(counter.num_grows_filter(MayMove, Uninitialized, true), 1);
        assert_eq!(counter.num_grows_filter(MayMove, Zeroed, false), 1);
        assert_eq!(counter.num_grows_filter(MayMove, Zeroed, true), 1);
        assert_eq!(counter.num_grows_filter(InPlace, Uninitialized, false), 1);
        assert_eq!(counter.num_grows_filter(InPlace, Uninitialized, true), 1);
        assert_eq!(counter.num_grows_filter(InPlace, Zeroed, false), 1);
        assert_eq!(counter.num_grows_filter(InPlace, Zeroed, true), 1);
        assert_eq!(counter.num_grows(), 8);
        assert_eq!(counter.num_shrinks_filter(MayMove, false), 0);
        assert_eq!(counter.num_shrinks_filter(MayMove, true), 1);
        assert_eq!(counter.num_shrinks_filter(InPlace, false), 1);
        assert_eq!(counter.num_shrinks_filter(InPlace, true), 1);
        assert_eq!(counter.num_shrinks(), 3);
        assert_eq!(counter.num_owns_filter(true), 1);
        assert_eq!(counter.num_owns_filter(false), 1);
        assert_eq!(counter.num_owns(), 2);
        assert_eq!(counter.num_deallocs(), 2);

        let atomic_counter = FilteredAtomicCounter::default();
        run_suite(atomic_counter.by_ref());

        assert_eq!(atomic_counter.num_allocs_filter(Uninitialized, false), 1);
        assert_eq!(atomic_counter.num_allocs_filter(Zeroed, false), 1);
        assert_eq!(atomic_counter.num_allocs_filter(Uninitialized, true), 1);
        assert_eq!(atomic_counter.num_allocs_filter(Zeroed, true), 1);
        assert_eq!(atomic_counter.num_allocs(), 4);
        assert_eq!(atomic_counter.num_grows_filter(MayMove, Uninitialized, false), 1);
        assert_eq!(atomic_counter.num_grows_filter(MayMove, Uninitialized, true), 1);
        assert_eq!(atomic_counter.num_grows_filter(MayMove, Zeroed, false), 1);
        assert_eq!(atomic_counter.num_grows_filter(MayMove, Zeroed, true), 1);
        assert_eq!(atomic_counter.num_grows_filter(InPlace, Uninitialized, false), 1);
        assert_eq!(atomic_counter.num_grows_filter(InPlace, Uninitialized, true), 1);
        assert_eq!(atomic_counter.num_grows_filter(InPlace, Zeroed, false), 1);
        assert_eq!(atomic_counter.num_grows_filter(InPlace, Zeroed, true), 1);
        assert_eq!(atomic_counter.num_grows(), 8);
        assert_eq!(atomic_counter.num_shrinks_filter(MayMove, false), 0);
        assert_eq!(atomic_counter.num_shrinks_filter(MayMove, true), 1);
        assert_eq!(atomic_counter.num_shrinks_filter(InPlace, false), 1);
        assert_eq!(atomic_counter.num_shrinks_filter(InPlace, true), 1);
        assert_eq!(atomic_counter.num_shrinks(), 3);
        assert_eq!(atomic_counter.num_owns_filter(true), 1);
        assert_eq!(atomic_counter.num_owns_filter(false), 1);
        assert_eq!(atomic_counter.num_owns(), 2);
        assert_eq!(atomic_counter.num_deallocs(), 2);

        assert_eq!(counter, atomic_counter);
        assert_eq!(atomic_counter, counter);
        assert_eq!(atomic_counter, atomic_counter);
    }
}