Merge https://github.com/Vector35/binaryninja-api into dev

Author: v1X3Q0

.github/workflows/rust.yml

@@ -13,6 +13,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          submodules: true
 
       - name: Install Clang
         run: |
@@ -29,7 +31,7 @@ jobs:
 
       - name: cargo check
         working-directory: ./rust
-        run: cargo check --workspace
+        run: cargo check --workspace --all-features
 
       - name: cargo clippy
         working-directory: ./rust

basicblock.cpp

@@ -102,6 +102,18 @@ void DisassemblySettings::SetAddressMode(BNDisassemblyAddressMode mode)
 }
 
 
+uint64_t DisassemblySettings::GetAddressBaseOffset() const
+{
+	return BNGetDisassemblyAddressBaseOffset(m_object);
+}
+
+
+void DisassemblySettings::SetAddressBaseOffset(uint64_t addressBaseOffset)
+{
+	BNSetDisassemblyAddressBaseOffset(m_object, addressBaseOffset);
+}
+
+
 DisassemblyTextLine::DisassemblyTextLine()
 {
 	addr = 0;

binaryninjaapi.h

@@ -9722,6 +9722,8 @@ namespace BinaryNinja {
 		void SetGutterWidth(size_t width);
 		BNDisassemblyAddressMode GetAddressMode() const;
 		void SetAddressMode(BNDisassemblyAddressMode mode);
+		uint64_t GetAddressBaseOffset() const;
+		void SetAddressBaseOffset(uint64_t addressBaseOffset);
 	};
 
 	/*!

binaryninjacore.h

@@ -708,6 +708,7 @@ extern "C"
 		RelativeToSegmentStartDisassemblyAddressMode,
 		RelativeToSectionStartDisassemblyAddressMode,
 		RelativeToFunctionStartDisassemblyAddressMode,
+		RelativeToAddressBaseOffsetDisassemblyAddressMode,
 		DisassemblyAddressModeMask = 0xFFFF,
 
 		IncludeNameDisassemblyAddressModeFlag = 0x10000,
@@ -5079,6 +5080,8 @@ extern "C"
 	BINARYNINJACOREAPI void BNSetDisassemblyGutterWidth(BNDisassemblySettings* settings, size_t width);
 	BINARYNINJACOREAPI BNDisassemblyAddressMode BNGetDisassemblyAddressMode(BNDisassemblySettings* settings);
 	BINARYNINJACOREAPI void BNSetDisassemblyAddressMode(BNDisassemblySettings* settings, BNDisassemblyAddressMode mode);
+	BINARYNINJACOREAPI uint64_t BNGetDisassemblyAddressBaseOffset(BNDisassemblySettings* settings);
+	BINARYNINJACOREAPI void BNSetDisassemblyAddressBaseOffset(BNDisassemblySettings* settings, uint64_t addressBaseOffset);
 
 	// Flow graphs
 	BINARYNINJACOREAPI BNFlowGraph* BNCreateFlowGraph(void);

docs/guide/types/index.md

@@ -13,6 +13,5 @@ Additionally, several types of containers for type information are documented he
 - [Platform Types](platformtypes.md): Types that automatically apply to a platform
 - [Type Archives](typearchives.md): How you can use type archives to share types between analysis databases
 - [Signature Libraries](../../dev/annotation.md#signature-library): Signature libraries are used to match names of functions with signatures for code that is statically compiled
-- [Platform Types](platformtypes.md): Platform types are base types that apply to all binaries on a particular platform
 
-Additionally, make sure to see the [applying annotations](../../dev/annotation.md) section of the developer guide for information about using the API with types and covering the creation of many of the items described below.
+Additionally, make sure to see the [applying annotations](../../dev/annotation.md) section of the developer guide for information about using the API with types and covering the creation of many of the items described below.

python/highlevelil.py

@@ -43,7 +43,7 @@
 from .commonil import (
     BaseILInstruction, Tailcall, Syscall, Localcall, Comparison, Signed, UnaryOperation, BinaryOperation, SSA, Phi,
     Loop, ControlFlow, Memory, Constant, Arithmetic, DoublePrecision, Terminal, FloatingPoint, Intrinsic, Return,
-    VariableInstruction, SSAVariableInstruction
+    VariableInstruction, SSAVariableInstruction, SetVar
 )
 from . import deprecation
 
@@ -1267,7 +1267,7 @@ def detailed_operands(self) -> List[Tuple[str, HighLevelILOperandType, str]]:
 
 
 @dataclass(frozen=True, repr=False, eq=False)
-class HighLevelILVarInit(HighLevelILInstruction):
+class HighLevelILVarInit(HighLevelILInstruction, SetVar):
 	@property
 	def dest(self) -> 'variable.Variable':
 		return self.get_var(0)
@@ -1289,7 +1289,7 @@ def vars_written(self) -> VariablesList:
 
 
 @dataclass(frozen=True, repr=False, eq=False)
-class HighLevelILVarInitSsa(HighLevelILInstruction, SSA):
+class HighLevelILVarInitSsa(HighLevelILInstruction, SetVar, SSA):
 	@property
 	def dest(self) -> 'mediumlevelil.SSAVariable':
 		return self.get_var_ssa(0, 1)
@@ -1311,7 +1311,7 @@ def vars_written(self) -> VariablesList:
 
 
 @dataclass(frozen=True, repr=False, eq=False)
-class HighLevelILAssign(HighLevelILInstruction):
+class HighLevelILAssign(HighLevelILInstruction, SetVar):
 	@property
 	def dest(self) -> HighLevelILInstruction:
 		return self.get_expr(0)
@@ -1338,7 +1338,7 @@ def vars_written(self) -> VariablesList:
 
 
 @dataclass(frozen=True, repr=False, eq=False)
-class HighLevelILAssignUnpack(HighLevelILInstruction):
+class HighLevelILAssignUnpack(HighLevelILInstruction, SetVar):
 	@property
 	def dest(self) -> List[HighLevelILInstruction]:
 		return self.get_expr_list(0, 1)
@@ -1448,7 +1448,7 @@ def detailed_operands(self) -> List[Tuple[str, HighLevelILOperandType, str]]:
 
 
 @dataclass(frozen=True, repr=False, eq=False)
-class HighLevelILVarPhi(HighLevelILInstruction, Phi):
+class HighLevelILVarPhi(HighLevelILInstruction, Phi, SetVar):
 	@property
 	def dest(self) -> 'mediumlevelil.SSAVariable':
 		return self.get_var_ssa(0, 1)

python/mediumlevelil.py

@@ -80,25 +80,32 @@ def type(self) -> 'types.Type':
 
 	@property
 	def function(self) -> 'function.Function':
+		"""returns the source Function object which this variable belongs to"""
 		return self.var.function
 
+	@property
+	def il_function(self) -> 'function.ILFunctionType':
+		"""returns the il Function object which this variable belongs to"""
+		return self.var._il_function
+
 	@property
 	def dead_store_elimination(self) -> DeadStoreElimination:
+		"""returns the dead store elimination setting for this variable (read-only)"""
 		return self.var.dead_store_elimination
 
 	@property
-	def def_site(self) -> Optional['MediumLevelILInstruction']:
+	def def_site(self) -> Optional[Union['MediumLevelILInstruction', 'highlevelil.HighLevelILInstruction']]:
 		"""
-		Gets the MediumLevelILInstruction where this SSAVariable is defined.
+		Gets the IL instructions where this SSAVariable is defined.
 		"""
-		return self.var.function.get_ssa_var_definition(self)
+		return self.il_function.get_ssa_var_definition(self)
 
 	@property
-	def use_sites(self) -> List['MediumLevelILInstruction']:
+	def use_sites(self) -> List[Union['MediumLevelILInstruction', 'highlevelil.HighLevelILInstruction']]:
 		"""
-		Gets the list of MediumLevelILInstructions where this SSAVariable is used inside of this function.
+		Gets the list of IL instructions where this SSAVariable is used inside of this function.
 		"""
-		return self.var.function.get_ssa_var_uses(self)
+		return self.il_function.get_ssa_var_uses(self)
 
 
 class MediumLevelILLabel:

python/variable.py

@@ -886,6 +886,11 @@ def function(self) -> 'binaryninja.function.Function':
 		"""returns the source Function object which this variable belongs to"""
 		return self._function
 
+	@property
+	def il_function(self) -> 'function.ILFunctionType':
+		"""returns the IL Function object which this variable belongs to"""
+		return self.var._il_function
+
 	def set_name_async(self, name: Optional[str]) -> None:
 		"""
 		``set_name_async`` provides a way to asynchronously set the name of a variable. This method should be used

rust/examples/decompile/src/main.rs

@@ -26,7 +26,7 @@ fn decompile_to_c(view: &BinaryView, func: &Function) {
     let last = view.get_next_linear_disassembly_lines(&mut cursor.duplicate());
     let first = view.get_previous_linear_disassembly_lines(&mut cursor);
 
-    let lines = first.into_iter().chain(last.into_iter());
+    let lines = first.into_iter().chain(&last);
 
     for line in lines {
         println!("{}", line.as_ref());

rust/examples/dwarf/dwarf_export/src/lib.rs

@@ -522,13 +522,11 @@ fn export_data_vars(
 
     for data_variable in &bv.data_variables() {
         if let Some(symbol) = data_variable.symbol(bv) {
-            if symbol.sym_type() == SymbolType::External {
-                continue;
-            } else if symbol.sym_type() == SymbolType::Function {
-                continue;
-            } else if symbol.sym_type() == SymbolType::ImportedFunction {
-                continue;
-            } else if symbol.sym_type() == SymbolType::LibraryFunction {
+            if let SymbolType::External
+            | SymbolType::Function
+            | SymbolType::ImportedFunction
+            | SymbolType::LibraryFunction = symbol.sym_type()
+            {
                 continue;
             }
         }