bartleby 0.2.3

A symbol renaming toolkit, based on LLVM
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

// Copyright 2023 SandboxAQ
//
// 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.

//! Bartleby Rust library, based on the C API.

extern "C" {
    pub fn free(ptr: *mut std::ffi::c_void);
}

/// Mutable pointer to a Bartleby handle.
type BartlebyHandleMutPtr = *mut std::ffi::c_void;

extern "C" {
    fn saq_bartleby_new() -> BartlebyHandleMutPtr;
    fn saq_bartleby_free(bh: BartlebyHandleMutPtr);
    fn saq_bartleby_set_prefix(bh: BartlebyHandleMutPtr, prefix: *const i8) -> std::ffi::c_int;
    fn saq_bartleby_add_binary(
        bh: BartlebyHandleMutPtr,
        s: *const std::ffi::c_void,
        n: usize,
    ) -> std::ffi::c_int;
    fn saq_bartleby_build_archive(
        bh: BartlebyHandleMutPtr,
        s: *mut *mut std::ffi::c_void,
        n: *mut usize,
    ) -> std::ffi::c_int;
}

/// The final archive.
/// This structure wraps a buffer allocated by C using `malloc` to avoid a
/// copy.
#[derive(Debug)]
pub struct Archive {
    /// The buffer.
    buffer: *mut std::ffi::c_void,

    /// The size of `buffer`.
    size: usize,
}

/// Implements [`std::ops::Drop`] for [`Archive`].
impl std::ops::Drop for Archive {
    fn drop(&mut self) {
        unsafe {
            free(self.buffer);
        }
        self.buffer = std::ptr::null_mut();
    }
}

/// Implements [`std::convert::AsRef`] for [`Archive`].
impl std::convert::AsRef<[u8]> for Archive {
    fn as_ref(&self) -> &[u8] {
        unsafe { std::slice::from_raw_parts(self.buffer.cast(), self.size) }
    }
}

/// A Bartleby handle.
pub struct Bartleby(BartlebyHandleMutPtr);

/// Implements [`std::fmt::Display`] for [`Bartleby`].
impl std::fmt::Debug for Bartleby {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "Bartleby(c_ptr={:p})", self.0)
    }
}

/// Implements [`std::ops::Drop`] for [`Bartleby`].
impl std::ops::Drop for Bartleby {
    fn drop(&mut self) {
        unsafe {
            saq_bartleby_free(self.0);
        }
        self.0 = std::ptr::null_mut();
    }
}

/// Implements [`Bartleby`].
impl Bartleby {
    /// Constructs a new Bartleby.
    pub fn try_new() -> Result<Self, String> {
        let bh = unsafe { saq_bartleby_new() };
        if bh.is_null() {
            Err("`saq_bartleby_new` returned a null pointer.".into())
        } else {
            Ok(Self(bh))
        }
    }

    /// Applies a prefix to the global and defined symbols.
    pub fn set_prefix(&mut self, prefix: impl std::convert::AsRef<str>) -> Result<(), String> {
        let cstring = std::ffi::CString::new(prefix.as_ref())
            .map_err(|e| format!("`CString::new` failed: {e}"))?;

        match unsafe { saq_bartleby_set_prefix(self.0, cstring.as_ptr()) } {
            0 => Ok(()),
            n => Err(format!("`saq_bartleby_set_prefix` returned {n}")),
        }
    }

    /// Adds a binary to Bartleby.
    pub fn add_binary(&mut self, bin: impl std::convert::AsRef<[u8]>) -> Result<(), String> {
        let buf = bin.as_ref();
        match unsafe { saq_bartleby_add_binary(self.0, buf.as_ptr().cast(), buf.len()) } {
            0 => Ok(()),
            n => Err(format!("`saq_bartleby_add_binary` returned {n}")),
        }
    }

    /// Builds the final archive.
    pub fn into_archive(mut self) -> Result<Archive, String> {
        let mut out: *mut std::ffi::c_void = std::ptr::null_mut();
        let mut out_size: usize = 0;

        let r = unsafe {
            saq_bartleby_build_archive(self.0, &mut out as *mut _, &mut out_size as *mut _)
        };
        self.0 = std::ptr::null_mut();
        match r {
            0 => Ok(Archive {
                buffer: out,
                size: out_size,
            }),
            n => Err(format!("`saq_bartleby_build_archive` returned {n}")),
        }
    }
}