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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
// Copyright 2021-2024 Vector 35 Inc.
//
// 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.

//! Interfaces for the various kinds of symbols in a binary.

use std::fmt;
use std::hash::{Hash, Hasher};
use std::ptr;

use crate::rc::*;
use crate::string::*;
use binaryninjacore_sys::*;

// TODO : Rename
#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
pub enum SymbolType {
    Function,
    LibraryFunction,
    ImportAddress,
    ImportedFunction,
    Data,
    ImportedData,
    External,
    Symbolic,
    LocalLabel,
}

impl From<BNSymbolType> for SymbolType {
    fn from(bn: BNSymbolType) -> SymbolType {
        use self::BNSymbolType::*;

        match bn {
            FunctionSymbol => SymbolType::Function,
            LibraryFunctionSymbol => SymbolType::LibraryFunction,
            ImportAddressSymbol => SymbolType::ImportAddress,
            ImportedFunctionSymbol => SymbolType::ImportedFunction,
            DataSymbol => SymbolType::Data,
            ImportedDataSymbol => SymbolType::ImportedData,
            ExternalSymbol => SymbolType::External,
            SymbolicFunctionSymbol => SymbolType::Symbolic,
            LocalLabelSymbol => SymbolType::LocalLabel,
        }
    }
}

impl From<SymbolType> for BNSymbolType {
    fn from(symbol_type: SymbolType) -> Self {
        use self::BNSymbolType::*;

        match symbol_type {
            SymbolType::Function => FunctionSymbol,
            SymbolType::LibraryFunction => LibraryFunctionSymbol,
            SymbolType::ImportAddress => ImportAddressSymbol,
            SymbolType::ImportedFunction => ImportedFunctionSymbol,
            SymbolType::Data => DataSymbol,
            SymbolType::ImportedData => ImportedDataSymbol,
            SymbolType::External => ExternalSymbol,
            SymbolType::Symbolic => SymbolicFunctionSymbol,
            SymbolType::LocalLabel => LocalLabelSymbol,
        }
    }
}

#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
pub enum Binding {
    None,
    Local,
    Global,
    Weak,
}

impl From<BNSymbolBinding> for Binding {
    fn from(bn: BNSymbolBinding) -> Binding {
        use self::BNSymbolBinding::*;

        match bn {
            NoBinding => Binding::None,
            LocalBinding => Binding::Local,
            GlobalBinding => Binding::Global,
            WeakBinding => Binding::Weak,
        }
    }
}

impl From<Binding> for BNSymbolBinding {
    fn from(binding: Binding) -> Self {
        use self::BNSymbolBinding::*;

        match binding {
            Binding::None => NoBinding,
            Binding::Local => LocalBinding,
            Binding::Global => GlobalBinding,
            Binding::Weak => WeakBinding,
        }
    }
}

// TODO : Clean this up
#[must_use]
pub struct SymbolBuilder {
    ty: SymbolType,
    binding: Binding,
    addr: u64,
    raw_name: String,
    short_name: Option<String>,
    full_name: Option<String>,
    ordinal: u64,
}

impl SymbolBuilder {
    pub fn new(ty: SymbolType, raw_name: &str, addr: u64) -> Self {
        Self {
            ty,
            binding: Binding::None,
            addr,
            raw_name: raw_name.to_owned(),
            short_name: None,
            full_name: None,
            ordinal: 0,
        }
    }

    pub fn binding(mut self, binding: Binding) -> Self {
        self.binding = binding;
        self
    }

    pub fn short_name(mut self, short_name: &str) -> Self {
        self.short_name = Some(short_name.to_owned());
        self
    }

    pub fn full_name(mut self, full_name: &str) -> Self {
        self.full_name = Some(full_name.to_owned());
        self
    }

    pub fn ordinal(mut self, ordinal: u64) -> Self {
        self.ordinal = ordinal;
        self
    }

    pub fn create(self) -> Ref<Symbol> {
        let raw_name = self.raw_name.into_bytes_with_nul();
        let short_name = self.short_name.map(|s| s.into_bytes_with_nul());
        let full_name = self.full_name.map(|s| s.into_bytes_with_nul());

        // Lifetimes, man
        let raw_name = raw_name.as_ptr() as _;
        unsafe {
            if let Some(short_name) = short_name {
                if let Some(full_name) = full_name {
                    let res = BNCreateSymbol(
                        self.ty.into(),
                        short_name.as_ptr() as _,
                        full_name.as_ptr() as _,
                        raw_name,
                        self.addr,
                        self.binding.into(),
                        ptr::null_mut(),
                        self.ordinal,
                    );
                    Symbol::ref_from_raw(res)
                } else {
                    let res = BNCreateSymbol(
                        self.ty.into(),
                        short_name.as_ptr() as _,
                        raw_name,
                        raw_name,
                        self.addr,
                        self.binding.into(),
                        ptr::null_mut(),
                        self.ordinal,
                    );
                    Symbol::ref_from_raw(res)
                }
            } else if let Some(full_name) = full_name {
                let res = BNCreateSymbol(
                    self.ty.into(),
                    raw_name,
                    full_name.as_ptr() as _,
                    raw_name,
                    self.addr,
                    self.binding.into(),
                    ptr::null_mut(),
                    self.ordinal,
                );
                Symbol::ref_from_raw(res)
            } else {
                let res = BNCreateSymbol(
                    self.ty.into(),
                    raw_name,
                    raw_name,
                    raw_name,
                    self.addr,
                    self.binding.into(),
                    ptr::null_mut(),
                    self.ordinal,
                );
                Symbol::ref_from_raw(res)
            }
        }
    }
}

#[derive(Eq)]
pub struct Symbol {
    pub(crate) handle: *mut BNSymbol,
}

impl Symbol {
    pub(crate) unsafe fn ref_from_raw(raw: *mut BNSymbol) -> Ref<Self> {
        Ref::new(Self { handle: raw })
    }

    pub(crate) unsafe fn from_raw(raw: *mut BNSymbol) -> Self {
        Self { handle: raw }
    }

    /// To create a new symbol, you need to create a symbol builder, customize that symbol, then add `SymbolBuilder::create` it into a `Ref<Symbol>`:
    ///
    /// ```no_run
    /// # use binaryninja::symbol::Symbol;
    /// # use binaryninja::symbol::SymbolType;
    /// Symbol::builder(SymbolType::Data, "hello", 0x1337).short_name("hello").full_name("hello").create();
    /// ```
    pub fn builder(ty: SymbolType, raw_name: &str, addr: u64) -> SymbolBuilder {
        SymbolBuilder::new(ty, raw_name, addr)
    }

    pub fn sym_type(&self) -> SymbolType {
        unsafe { BNGetSymbolType(self.handle).into() }
    }

    pub fn binding(&self) -> Binding {
        unsafe { BNGetSymbolBinding(self.handle).into() }
    }

    pub fn full_name(&self) -> BnString {
        unsafe { BnString::from_raw(BNGetSymbolFullName(self.handle)) }
    }

    pub fn short_name(&self) -> BnString {
        unsafe { BnString::from_raw(BNGetSymbolShortName(self.handle)) }
    }

    pub fn raw_name(&self) -> BnString {
        unsafe { BnString::from_raw(BNGetSymbolRawName(self.handle)) }
    }

    pub fn address(&self) -> u64 {
        unsafe { BNGetSymbolAddress(self.handle) }
    }

    pub fn auto_defined(&self) -> bool {
        unsafe { BNIsSymbolAutoDefined(self.handle) }
    }

    /// Wether this symbol has external linkage
    pub fn external(&self) -> bool {
        self.binding() == Binding::Weak || self.binding() == Binding::Global
    }

    pub fn imported_function_from_import_address_symbol(sym: &Symbol, addr: u64) -> Ref<Symbol> {
        unsafe {
            let res = BNImportedFunctionFromImportAddressSymbol(sym.handle, addr);
            Symbol::ref_from_raw(res)
        }
    }
}

unsafe impl Send for Symbol {}
unsafe impl Sync for Symbol {}

impl fmt::Debug for Symbol {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "<sym {:?} '{}' @ {:x} (handle: {:?})>",
            self.sym_type(),
            self.full_name(),
            self.address(),
            self.handle
        )
    }
}

impl ToOwned for Symbol {
    type Owned = Ref<Self>;

    fn to_owned(&self) -> Self::Owned {
        unsafe { RefCountable::inc_ref(self) }
    }
}

unsafe impl RefCountable for Symbol {
    unsafe fn inc_ref(handle: &Self) -> Ref<Self> {
        Ref::new(Self {
            handle: BNNewSymbolReference(handle.handle),
        })
    }

    unsafe fn dec_ref(handle: &Self) {
        BNFreeSymbol(handle.handle);
    }
}

impl CoreArrayProvider for Symbol {
    type Raw = *mut BNSymbol;
    type Context = ();
    type Wrapped<'a> = Guard<'a, Symbol>;
}

unsafe impl CoreArrayProviderInner for Symbol {
    unsafe fn free(raw: *mut Self::Raw, count: usize, _context: &Self::Context) {
        BNFreeSymbolList(raw, count);
    }
    unsafe fn wrap_raw<'a>(raw: &'a Self::Raw, context: &'a Self::Context) -> Self::Wrapped<'a> {
        Guard::new(Symbol::from_raw(*raw), context)
    }
}

impl Hash for Symbol {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.handle.hash(state);
    }
}

impl PartialEq for Symbol {
    fn eq(&self, other: &Self) -> bool {
        self.handle == other.handle
    }
}