binaryninja/
flowgraph.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
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
// Copyright 2021-2025 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 creating and displaying pretty CFGs in Binary Ninja.

use binaryninjacore_sys::*;

use crate::high_level_il::HighLevelILFunction;
use crate::low_level_il::LowLevelILRegularFunction;
use crate::medium_level_il::MediumLevelILFunction;
use crate::rc::*;
use crate::render_layer::CoreRenderLayer;

pub mod edge;
pub mod node;

use crate::binary_view::BinaryView;
use crate::function::Function;
use crate::string::IntoCStr;
pub use edge::EdgeStyle;
pub use edge::FlowGraphEdge;
pub use node::FlowGraphNode;

pub type BranchType = BNBranchType;
pub type EdgePenStyle = BNEdgePenStyle;
pub type ThemeColor = BNThemeColor;
pub type FlowGraphOption = BNFlowGraphOption;

#[derive(PartialEq, Eq, Hash)]
pub struct FlowGraph {
    pub(crate) handle: *mut BNFlowGraph,
}

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

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

    pub fn new() -> Ref<Self> {
        unsafe { FlowGraph::ref_from_raw(BNCreateFlowGraph()) }
    }

    pub fn has_updates(&self) -> bool {
        let query_mode = unsafe { BNFlowGraphUpdateQueryMode(self.handle) };
        match query_mode {
            true => unsafe { BNFlowGraphHasUpdates(self.handle) },
            false => false,
        }
    }

    pub fn update(&self) -> Option<Ref<Self>> {
        let new_graph = unsafe { BNUpdateFlowGraph(self.handle) };
        if new_graph.is_null() {
            return None;
        }
        Some(unsafe { FlowGraph::ref_from_raw(new_graph) })
    }

    pub fn show(&self, title: &str) {
        let raw_title = title.to_cstr();
        match self.view() {
            None => unsafe {
                BNShowGraphReport(std::ptr::null_mut(), raw_title.as_ptr(), self.handle);
            },
            Some(view) => unsafe {
                BNShowGraphReport(view.handle, raw_title.as_ptr(), self.handle);
            },
        }
    }

    /// Whether flow graph layout is complete.
    pub fn is_layout_complete(&self) -> bool {
        unsafe { BNIsFlowGraphLayoutComplete(self.handle) }
    }

    pub fn nodes(&self) -> Array<FlowGraphNode> {
        let mut count: usize = 0;
        let nodes_ptr = unsafe { BNGetFlowGraphNodes(self.handle, &mut count as *mut usize) };
        unsafe { Array::new(nodes_ptr, count, ()) }
    }

    pub fn function(&self) -> Option<Ref<Function>> {
        unsafe {
            let func_ptr = BNGetFunctionForFlowGraph(self.handle);
            match func_ptr.is_null() {
                false => Some(Function::ref_from_raw(func_ptr)),
                true => None,
            }
        }
    }

    pub fn set_function(&self, func: Option<&Function>) {
        let func_ptr = func.map(|f| f.handle).unwrap_or(std::ptr::null_mut());
        unsafe { BNSetFunctionForFlowGraph(self.handle, func_ptr) }
    }

    pub fn view(&self) -> Option<Ref<BinaryView>> {
        unsafe {
            let view_ptr = BNGetViewForFlowGraph(self.handle);
            match view_ptr.is_null() {
                false => Some(BinaryView::ref_from_raw(view_ptr)),
                true => None,
            }
        }
    }

    pub fn set_view(&self, view: Option<&BinaryView>) {
        let view_ptr = view.map(|v| v.handle).unwrap_or(std::ptr::null_mut());
        unsafe { BNSetViewForFlowGraph(self.handle, view_ptr) }
    }

    pub fn low_level_il(&self) -> Option<Ref<LowLevelILRegularFunction>> {
        unsafe {
            let llil_ptr = BNGetFlowGraphLowLevelILFunction(self.handle);
            match llil_ptr.is_null() {
                false => Some(LowLevelILRegularFunction::ref_from_raw(llil_ptr)),
                true => None,
            }
        }
    }

    pub fn medium_level_il(&self) -> Option<Ref<MediumLevelILFunction>> {
        unsafe {
            let mlil_ptr = BNGetFlowGraphMediumLevelILFunction(self.handle);
            match mlil_ptr.is_null() {
                false => Some(MediumLevelILFunction::ref_from_raw(mlil_ptr)),
                true => None,
            }
        }
    }

    pub fn high_level_il(&self, full_ast: bool) -> Option<Ref<HighLevelILFunction>> {
        unsafe {
            let hlil_ptr = BNGetFlowGraphHighLevelILFunction(self.handle);
            match hlil_ptr.is_null() {
                false => Some(HighLevelILFunction::ref_from_raw(hlil_ptr, full_ast)),
                true => None,
            }
        }
    }

    pub fn get_node(&self, i: usize) -> Option<Ref<FlowGraphNode>> {
        let node_ptr = unsafe { BNGetFlowGraphNode(self.handle, i) };
        if node_ptr.is_null() {
            None
        } else {
            Some(unsafe { FlowGraphNode::ref_from_raw(node_ptr) })
        }
    }

    pub fn get_node_count(&self) -> usize {
        unsafe { BNGetFlowGraphNodeCount(self.handle) }
    }

    pub fn has_nodes(&self) -> bool {
        unsafe { BNFlowGraphHasNodes(self.handle) }
    }

    /// Returns the graph size in width, height form.
    pub fn size(&self) -> (i32, i32) {
        let width = unsafe { BNGetFlowGraphWidth(self.handle) };
        let height = unsafe { BNGetFlowGraphHeight(self.handle) };
        (width, height)
    }

    /// Returns the graph margins between nodes.
    pub fn node_margins(&self) -> (i32, i32) {
        let horizontal = unsafe { BNGetHorizontalFlowGraphNodeMargin(self.handle) };
        let vertical = unsafe { BNGetVerticalFlowGraphNodeMargin(self.handle) };
        (horizontal, vertical)
    }

    /// Sets the graph margins between nodes.
    pub fn set_node_margins(&self, horizontal: i32, vertical: i32) {
        unsafe { BNSetFlowGraphNodeMargins(self.handle, horizontal, vertical) };
    }

    pub fn append(&self, node: &FlowGraphNode) -> usize {
        unsafe { BNAddFlowGraphNode(self.handle, node.handle) }
    }

    pub fn replace(&self, index: usize, node: &FlowGraphNode) {
        unsafe { BNReplaceFlowGraphNode(self.handle, index, node.handle) }
    }

    pub fn clear(&self) {
        unsafe { BNClearFlowGraphNodes(self.handle) }
    }

    pub fn set_option(&self, option: FlowGraphOption, value: bool) {
        unsafe { BNSetFlowGraphOption(self.handle, option, value) }
    }

    pub fn is_option_set(&self, option: FlowGraphOption) -> bool {
        unsafe { BNIsFlowGraphOptionSet(self.handle, option) }
    }

    /// A list of the currently applied [`CoreRenderLayer`]'s
    pub fn render_layers(&self) -> Array<CoreRenderLayer> {
        let mut count: usize = 0;
        unsafe {
            let handles = BNGetFlowGraphRenderLayers(self.handle, &mut count);
            Array::new(handles, count, ())
        }
    }

    /// Add a Render Layer to be applied to this [`FlowGraph`].
    ///
    /// NOTE: Layers will be applied in the order in which they are added.
    pub fn add_render_layer(&self, layer: &CoreRenderLayer) {
        unsafe { BNAddFlowGraphRenderLayer(self.handle, layer.handle.as_ptr()) };
    }

    /// Remove a Render Layer from being applied to this [`FlowGraph`].
    pub fn remove_render_layer(&self, layer: &CoreRenderLayer) {
        unsafe { BNRemoveFlowGraphRenderLayer(self.handle, layer.handle.as_ptr()) };
    }
}

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

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

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

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