error_chain/
backtrace.rs

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
pub use self::imp::{Backtrace, InternalBacktrace};

#[cfg(feature = "backtrace")]
mod imp {
    extern crate backtrace;

    use std::cell::UnsafeCell;
    use std::env;
    use std::fmt;
    use std::sync::atomic::{AtomicUsize, ATOMIC_USIZE_INIT, Ordering};
    use std::sync::{Arc, Mutex};

    /// Internal representation of a backtrace
    #[doc(hidden)]
    #[derive(Clone)]
    pub struct InternalBacktrace {
        backtrace: Option<Arc<MaybeResolved>>,
    }

    struct MaybeResolved {
        resolved: Mutex<bool>,
        backtrace: UnsafeCell<Backtrace>,
    }

    unsafe impl Send for MaybeResolved {}
    unsafe impl Sync for MaybeResolved {}

    pub use self::backtrace::Backtrace;

    impl InternalBacktrace {
        /// Returns a backtrace of the current call stack if `RUST_BACKTRACE`
        /// is set to anything but ``0``, and `None` otherwise.  This is used
        /// in the generated error implementations.
        #[doc(hidden)]
        pub fn new() -> InternalBacktrace {
            static ENABLED: AtomicUsize = ATOMIC_USIZE_INIT;

            match ENABLED.load(Ordering::SeqCst) {
                0 => {
                    let enabled = match env::var_os("RUST_BACKTRACE") {
                        Some(ref val) if val != "0" => true,
                        _ => false,
                    };
                    ENABLED.store(enabled as usize + 1, Ordering::SeqCst);
                    if !enabled {
                        return InternalBacktrace { backtrace: None }
                    }
                }
                1 => return InternalBacktrace { backtrace: None },
                _ => {}
            }

            InternalBacktrace {
                backtrace: Some(Arc::new(MaybeResolved {
                    resolved: Mutex::new(false),
                    backtrace: UnsafeCell::new(Backtrace::new_unresolved()),
                })),
            }
        }

        /// Acquire the internal backtrace
        #[doc(hidden)]
        pub fn as_backtrace(&self) -> Option<&Backtrace> {
            let bt = match self.backtrace {
                Some(ref bt) => bt,
                None => return None,
            };
            let mut resolved = bt.resolved.lock().unwrap();
            unsafe {
                if !*resolved {
                    (*bt.backtrace.get()).resolve();
                    *resolved = true;
                }
                Some(&*bt.backtrace.get())
            }
        }
    }

    impl fmt::Debug for InternalBacktrace {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            f.debug_struct("InternalBacktrace")
                .field("backtrace", &self.as_backtrace())
                .finish()
        }
    }
}

#[cfg(not(feature = "backtrace"))]
mod imp {
    /// Dummy type used when the `backtrace` feature is disabled.
    pub type Backtrace = ();

    /// Internal representation of a backtrace
    #[doc(hidden)]
    #[derive(Clone, Debug)]
    pub struct InternalBacktrace {}

    impl InternalBacktrace {
        /// Returns a new backtrace
        #[doc(hidden)]
        pub fn new() -> InternalBacktrace {
            InternalBacktrace {}
        }

        /// Returns the internal backtrace
        #[doc(hidden)]
        pub fn as_backtrace(&self) -> Option<&Backtrace> {
            None
        }
    }
}