      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

    // Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    #![allow(bad_style)]

    use std::ffi::{CStr, OsStr};
    use std::mem;
    use std::os::raw::{c_void, c_char, c_int};
    use std::os::unix::prelude::*;
    use std::path::Path;
    use std::ptr;
    use std::sync::atomic::ATOMIC_USIZE_INIT;

    use libc::{self, Dl_info};

    use SymbolName;
    use dylib::Dylib;
    use dylib::Symbol as DylibSymbol;

    #[repr(C)]
    #[derive(Copy, Clone, PartialEq)]
    pub struct CSTypeRef {
        cpp_data: *const c_void,
        cpp_obj: *const c_void
    }

    const CS_NOW: u64 = 0x80000000;
    const CSREF_NULL: CSTypeRef = CSTypeRef {
        cpp_data: 0 as *const c_void,
        cpp_obj: 0 as *const c_void,
    };

    pub enum Symbol {
        Core {
            path: *const c_char,
            lineno: u32,
            name: *const c_char,
            addr: *mut c_void,
        },
        Dladdr(Dl_info),
    }

    impl Symbol {
        pub fn name(&self) -> Option<SymbolName> {
            let name = match *self {
                Symbol::Core { name, .. } => name,
                Symbol::Dladdr(ref info) => info.dli_sname,
            };
            if name.is_null() {
                None
            } else {
                Some(SymbolName::new(unsafe {
                    CStr::from_ptr(name).to_bytes()
                }))
            }
        }

        pub fn addr(&self) -> Option<*mut c_void> {
            match *self {
                Symbol::Core { addr, .. } => Some(addr),
                Symbol::Dladdr(ref info) => Some(info.dli_saddr as *mut _),
            }
        }

        pub fn filename(&self) -> Option<&Path> {
            match *self {
                Symbol::Core { path, .. } => {
                    if path.is_null() {
                        None
                    } else {
                        Some(Path::new(OsStr::from_bytes(unsafe {
                            CStr::from_ptr(path).to_bytes()
                        })))
                    }
                }
                Symbol::Dladdr(_) => None,
            }
        }

        pub fn lineno(&self) -> Option<u32> {
            match *self {
                Symbol::Core { lineno: 0, .. } => None,
                Symbol::Core { lineno, .. } => Some(lineno),
                Symbol::Dladdr(_) => None,
            }
        }
    }

    static CORESYMBOLICATION: Dylib = Dylib { init: ATOMIC_USIZE_INIT };

    macro_rules! dlsym {
        (extern {
            $(fn $name:ident($($arg:ident: $t:ty),*) -> $ret:ty;)*
        }) => ($(
            static $name: ::dylib::Symbol<unsafe extern fn($($t),*) -> $ret> =
                ::dylib::Symbol {
                    name: concat!(stringify!($name), "\0"),
                    addr: ::std::sync::atomic::ATOMIC_USIZE_INIT,
                    _marker: ::std::marker::PhantomData,
                };
        )*)
    }

    dlsym! {
        extern {
            fn CSSymbolicatorCreateWithPid(pid: c_int) -> CSTypeRef;
            fn CSRelease(rf: CSTypeRef) -> c_void;
            fn CSSymbolicatorGetSymbolWithAddressAtTime(
                cs: CSTypeRef, addr: *const c_void, time: u64) -> CSTypeRef;
            fn CSSymbolicatorGetSourceInfoWithAddressAtTime(
                cs: CSTypeRef, addr: *const c_void, time: u64) -> CSTypeRef;
            fn CSSourceInfoGetLineNumber(info: CSTypeRef) -> c_int;
            fn CSSourceInfoGetPath(info: CSTypeRef) -> *const c_char;
            fn CSSourceInfoGetSymbol(info: CSTypeRef) -> CSTypeRef;
            fn CSSymbolGetName(sym: CSTypeRef) -> *const c_char;
            fn CSSymbolGetSymbolOwner(sym: CSTypeRef) -> CSTypeRef;
            fn CSSymbolOwnerGetBaseAddress(symowner: CSTypeRef) -> *mut c_void;
        }
    }

    unsafe fn get<T>(sym: &DylibSymbol<T>) -> &T {
        CORESYMBOLICATION.get(sym).unwrap()
    }

    unsafe fn try_resolve(addr: *mut c_void, cb: &mut FnMut(&super::Symbol)) -> bool {
        let path = "/System/Library/PrivateFrameworks/CoreSymbolication.framework\
                    /Versions/A/CoreSymbolication";
        if !CORESYMBOLICATION.init(path) {
            return false;
        }

        let cs = get(&CSSymbolicatorCreateWithPid)(libc::getpid());
        if cs == CSREF_NULL {
            return false
        }

        let info = get(&CSSymbolicatorGetSourceInfoWithAddressAtTime)(
            cs, addr, CS_NOW);
        let sym = if info == CSREF_NULL {
            get(&CSSymbolicatorGetSymbolWithAddressAtTime)(cs, addr, CS_NOW)
        } else {
            get(&CSSourceInfoGetSymbol)(info)
        };

        let mut rv = false;
        if sym != CSREF_NULL {
            let owner = get(&CSSymbolGetSymbolOwner)(sym);
            if owner != CSREF_NULL {
                cb(&super::Symbol {
                    inner: Symbol::Core {
                        path: if info != CSREF_NULL {
                            get(&CSSourceInfoGetPath)(info)
                        } else {
                            ptr::null()
                        },
                        lineno: if info != CSREF_NULL {
                            get(&CSSourceInfoGetLineNumber)(info) as u32
                        } else {
                            0
                        },
                        name: get(&CSSymbolGetName)(sym),
                        addr: get(&CSSymbolOwnerGetBaseAddress)(owner),
                    },
                });
                rv = true;
            }
        }
        get(&CSRelease)(cs);

        rv
    }

    pub fn resolve(addr: *mut c_void, cb: &mut FnMut(&super::Symbol)) {
        unsafe {
            if try_resolve(addr, cb) {
                return
            }
            let mut info: Dl_info = mem::zeroed();
            if libc::dladdr(addr as *mut _, &mut info) != 0 {
                cb(&super::Symbol {
                    inner: Symbol::Dladdr(info),
                });
            }
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)