ptools 0.2.23

Utilities for inspecting Linux processes
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

//
//   Copyright (c) 2017 Steven Fackler
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
//

use std::cell::UnsafeCell;
use std::ptr;

use libc::c_char;
use libc::c_int;
use libc::c_void;

/// Callbacks used to configure the behavior of a `Dwfl`.
pub struct Callbacks(UnsafeCell<crate::dw_sys::Dwfl_Callbacks>);

unsafe impl Sync for Callbacks {}
unsafe impl Send for Callbacks {}

impl Callbacks {
    /// Creates a new callback set.
    ///
    /// The find_elf and find_debuginfo callbacks are required. The section address callback and debuginfo_path
    /// value are initialized to NULL.
    pub fn new(find_elf: FindElf, find_debuginfo: FindDebuginfo) -> Callbacks {
        Callbacks(UnsafeCell::new(crate::dw_sys::Dwfl_Callbacks {
            find_elf: Some(find_elf.0),
            find_debuginfo: Some(find_debuginfo.0),
            section_address: None,
            debuginfo_path: ptr::null_mut(),
        }))
    }

    /// Returns the pointer representation of the callbacks.
    pub fn as_ptr(&self) -> *const crate::dw_sys::Dwfl_Callbacks {
        self.0.get()
    }
}

/// The callback responsible for locating the ELF images of a process.
#[derive(Copy, Clone)]
pub struct FindElf(
    unsafe extern "C" fn(
        *mut crate::dw_sys::Dwfl_Module,
        *mut *mut c_void,
        *const c_char,
        crate::dw_sys::Dwarf_Addr,
        *mut *mut c_char,
        *mut *mut crate::dw_sys::Elf,
    ) -> c_int,
);

impl FindElf {
    /// A standard callback used with `Register::linux_proc`.
    pub const LINUX_PROC: FindElf = FindElf(crate::dw_sys::dwfl_linux_proc_find_elf);

    /// A callback that locates ELF images by build ID.
    ///
    /// Used with `Report::core_file` for core dump analysis.
    pub const BUILD_ID: FindElf = FindElf(crate::dw_sys::dwfl_build_id_find_elf);
}

/// The callback responsible for locating the debuginfo of a process.
#[derive(Copy, Clone)]
pub struct FindDebuginfo(
    unsafe extern "C" fn(
        *mut crate::dw_sys::Dwfl_Module,
        *mut *mut c_void,
        *const c_char,
        crate::dw_sys::Dwarf_Addr,
        *const c_char,
        *const c_char,
        crate::dw_sys::GElf_Word,
        *mut *mut c_char,
    ) -> c_int,
);

impl FindDebuginfo {
    /// The standard callback.
    pub const STANDARD: FindDebuginfo = FindDebuginfo(crate::dw_sys::dwfl_standard_find_debuginfo);
}