crabgrind 0.4.0

Rust bindings to "Valgrind Client Request" interface
Documentation 
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

#![doc = include_str!("../README.md")]
#![warn(missing_docs)]
#![cfg_attr(not(feature = "valgrind"), allow(unused, missing_docs, clippy::needless_pass_by_value))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![no_std]

#[cfg(feature = "opt-out")]
compile_error!("`opt-out` was removed (v0.3). Use `default-features = false`.");

#[doc(hidden)]
#[cfg(feature = "alloc")]
pub extern crate alloc;

#[cfg(feature = "valgrind")]
mod bindings;
mod requests;

pub use requests::{ScopeGuard, cachegrind, callgrind, dhat, drd, helgrind, memcheck, valgrind};

/// Valgrind version this crate was compiled against.
pub const VALGRIND_VERSION: (u32, u32) = imp::VALGRIND_VERSION;
#[doc = include_str!("../doc/VALGRIND_AVAILABLE.md")]
pub const VALGRIND_AVAILABLE: bool = VALGRIND_VERSION.0 != 0xBEDA_BEDA;

/// Printing to the Valgrind output channel
#[inline(always)]
pub fn vg_print<C>(t: &C)
where
    C: AsRef<core::ffi::CStr> + ?Sized,
{
    #[cfg(feature = "valgrind")]
    unsafe {
        bindings::vg_print(t.as_ref().as_ptr())
    };
}

/// Printing to the Valgrind output channel with a stack trace attached
#[inline(always)]
pub fn vg_print_stacktrace<C>(t: &C)
where
    C: AsRef<core::ffi::CStr> + ?Sized,
{
    #[cfg(feature = "valgrind")]
    unsafe {
        bindings::vg_print_backtrace(t.as_ref().as_ptr())
    };
}

#[doc(hidden)]
#[cfg(feature = "valgrind")]
pub mod imp {

    pub const VALGRIND_VERSION: (u32, u32) =
        (super::bindings::__VALGRIND_MAJOR__, super::bindings::__VALGRIND_MINOR__);

    #[cfg(feature = "alloc")]
    #[doc = include_str!("../doc/println.md")]
    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
    #[macro_export]
    macro_rules! println{
        ($($arg:tt)+) => {{
            let msg = $crate::alloc::format!("{}\n\0", format_args!($($arg)+));

            let msg = unsafe { core::ffi::CStr::from_ptr(msg.as_bytes().as_ptr().cast()) };
            $crate::vg_print(msg);
        }};
    }

    #[cfg(feature = "alloc")]
    #[doc = include_str!("../doc/println_stacktrace.md")]
    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
    #[macro_export]
    macro_rules! print_stacktrace{
        ($($arg:tt)+) => {{
            let msg = $crate::alloc::format!("{}\0", format_args!($($arg)+));

            let msg = unsafe { core::ffi::CStr::from_ptr(msg.as_bytes().as_ptr().cast()) };
            $crate::vg_print_stacktrace(msg);
        }};
    }
}

#[cfg(not(feature = "valgrind"))]
mod imp {
    pub const VALGRIND_VERSION: (u32, u32) = (0xBEDA_BEDA, 0xBEDA_BEDA);

    #[cfg(feature = "alloc")]
    #[doc = include_str!("../doc/println.md")]
    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
    #[macro_export]
    macro_rules! println {
        ($($arg:tt)+) => {
            ()
        };
    }

    #[cfg(feature = "alloc")]
    #[doc = include_str!("../doc/println_stacktrace.md")]
    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
    #[macro_export]
    macro_rules! print_stacktrace {
        ($($arg:tt)+) => {
            ()
        };
    }
}