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

v1X3Q0 · v1X3Q0 · commit 65d0a3e7ea42 · 2024-05-06T19:06:29.000-04:00
diff --git a/basicblock.cpp b/basicblock.cpp
@@ -90,6 +90,18 @@ void DisassemblySettings::SetGutterWidth(size_t width)
 }
 
 
+BNDisassemblyAddressMode DisassemblySettings::GetAddressMode() const
+{
+	return BNGetDisassemblyAddressMode(m_object);
+}
+
+
+void DisassemblySettings::SetAddressMode(BNDisassemblyAddressMode mode)
+{
+	BNSetDisassemblyAddressMode(m_object, mode);
+}
+
+
 DisassemblyTextLine::DisassemblyTextLine()
 {
 	addr = 0;
diff --git a/binaryninjaapi.h b/binaryninjaapi.h
@@ -1531,6 +1531,26 @@ namespace BinaryNinja {
 		std::function<bool(size_t, size_t)> progress = {}, Ref<Metadata> options = new Metadata(MetadataType::KeyValueDataType),
 		bool isDatabase = false);
 
+	/*! Demangles using LLVM's demangler
+
+		\param[in] mangledName a mangled (msvc/itanium/rust/dlang) name
+		\param[out] outVarName QualifiedName reference to write the output name to.
+		\param[in] simplify Whether to simplify demangled names.
+
+		\ingroup demangle
+	*/
+	bool DemangleLLVM(const std::string& mangledName, QualifiedName& outVarName, const bool simplify = false);
+
+	/*! Demangles using LLVM's demangler
+
+		\param[in] mangledName a mangled (msvc/itanium/rust/dlang) name
+		\param[out] outVarName QualifiedName reference to write the output name to.
+		\param[in] view View to check the analysis.types.templateSimplifier for
+
+		\ingroup demangle
+	*/
+	bool DemangleLLVM(const std::string& mangledName, QualifiedName& outVarName, BinaryView* view);
+
 	/*! Demangles a Microsoft Visual Studio C++ name
 
 	    \param[in] arch Architecture for the symbol. Required for pointer and integer sizes.
@@ -2266,6 +2286,7 @@ namespace BinaryNinja {
 			TextToken                  Used for anything not of another type.
 			CommentToken               Comments
 			TypeNameToken              **Not emitted by architectures**
+			AddressSeparatorToken      **Not emitted by architectures**
 			========================== ============================================
 	*/
 	struct InstructionTextToken
@@ -9699,6 +9720,8 @@ namespace BinaryNinja {
 		void SetMaximumSymbolWidth(size_t width);
 		size_t GetGutterWidth() const;
 		void SetGutterWidth(size_t width);
+		BNDisassemblyAddressMode GetAddressMode() const;
+		void SetAddressMode(BNDisassemblyAddressMode mode);
 	};
 
 	/*!
diff --git a/binaryninjacore.h b/binaryninjacore.h
@@ -37,7 +37,7 @@
 // Current ABI version for linking to the core. This is incremented any time
 // there are changes to the API that affect linking, including new functions,
 // new types, or modifications to existing functions or types.
-#define BN_CURRENT_CORE_ABI_VERSION 60
+#define BN_CURRENT_CORE_ABI_VERSION 61
 
 // Minimum ABI version that is supported for loading of plugins. Plugins that
 // are linked to an ABI version less than this will not be able to load and
@@ -382,7 +382,8 @@ extern "C"
 		AddressDisplayToken = 68,
 		IndirectImportToken = 69,
 		ExternalSymbolToken = 70,
-		StackVariableToken = 71
+		StackVariableToken = 71,
+		AddressSeparatorToken = 72
 	} BNInstructionTextTokenType;
 
 	typedef enum BNInstructionTextTokenContext
@@ -700,6 +701,20 @@ extern "C"
 		ShowILOpcodes = 131,
 	} BNDisassemblyOption;
 
+	typedef enum BNDisassemblyAddressMode
+	{
+		AbsoluteDisassemblyAddressMode,
+		RelativeToBinaryStartDisassemblyAddressMode,
+		RelativeToSegmentStartDisassemblyAddressMode,
+		RelativeToSectionStartDisassemblyAddressMode,
+		RelativeToFunctionStartDisassemblyAddressMode,
+		DisassemblyAddressModeMask = 0xFFFF,
+
+		IncludeNameDisassemblyAddressModeFlag = 0x10000,
+		DecimalDisassemblyAddressModeFlag = 0x20000,
+		DisassemblyAddressModeFlagsMask = 0xFFFF0000,
+	} BNDisassemblyAddressMode;
+
 	typedef enum BNTypeClass
 	{
 		VoidTypeClass = 0,
@@ -1902,6 +1917,8 @@ extern "C"
 		CommentColor,
 		OperationColor,
 		BaseStructureNameColor,
+		IndentationLineColor,
+		IndentationLineHighlightColor,
 
 		// Script console colors
 		ScriptConsoleOutputColor,
@@ -5060,7 +5077,8 @@ extern "C"
 	BINARYNINJACOREAPI void BNSetDisassemblyMaximumSymbolWidth(BNDisassemblySettings* settings, size_t width);
 	BINARYNINJACOREAPI size_t BNGetDisassemblyGutterWidth(BNDisassemblySettings* settings);
 	BINARYNINJACOREAPI void BNSetDisassemblyGutterWidth(BNDisassemblySettings* settings, size_t width);
-
+	BINARYNINJACOREAPI BNDisassemblyAddressMode BNGetDisassemblyAddressMode(BNDisassemblySettings* settings);
+	BINARYNINJACOREAPI void BNSetDisassemblyAddressMode(BNDisassemblySettings* settings, BNDisassemblyAddressMode mode);
 
 	// Flow graphs
 	BINARYNINJACOREAPI BNFlowGraph* BNCreateFlowGraph(void);
@@ -6515,6 +6533,11 @@ extern "C"
 	    char*** outVarName, size_t* outVarNameElements, const BNBinaryView* const view);
 	BINARYNINJACOREAPI void BNFreeDemangledName(char*** name, size_t nameElements);
 
+	BINARYNINJACOREAPI bool BNDemangleLLVM(const char* mangledName,
+		char*** outVarName, size_t* outVarNameElements, const bool simplify);
+	BINARYNINJACOREAPI bool BNDemangleLLVMWithOptions(const char* mangledName,
+	char*** outVarName, size_t* outVarNameElements, const BNBinaryView* const view);
+
 	// Plugin repository APIs
 	BINARYNINJACOREAPI char** BNPluginGetApis(BNRepoPlugin* p, size_t* count);
 	BINARYNINJACOREAPI const char* BNPluginGetAuthor(BNRepoPlugin* p);
diff --git a/demangle.cpp b/demangle.cpp
@@ -3,6 +3,29 @@
 using namespace std;
 
 namespace BinaryNinja {
+	bool DemangleLLVM(const std::string& mangledName, QualifiedName& outVarName,
+		BinaryView* view)
+	{
+		const bool simplify = Settings::Instance()->Get<bool>("analysis.types.templateSimplifier", view);
+		return DemangleLLVM(mangledName, outVarName, simplify);
+	}
+
+	bool DemangleLLVM(const std::string& mangledName, QualifiedName& outVarName,
+		const bool simplify)
+	{
+		BNType* localType = nullptr;
+		char** localVarName = nullptr;
+		size_t localSize = 0;
+		if (!BNDemangleLLVM(mangledName.c_str(), &localVarName, &localSize, simplify))
+			return false;
+		for (size_t i = 0; i < localSize; i++)
+		{
+			outVarName.push_back(localVarName[i]);
+		}
+		BNFreeDemangledName(&localVarName, localSize);
+		return true;
+	}
+
 	bool DemangleMS(Architecture* arch, const std::string& mangledName, Ref<Type>& outType, QualifiedName& outVarName,
 	    BinaryView* view)
 	{
diff --git a/docs/guide/settings.md b/docs/guide/settings.md
@@ -360,6 +360,7 @@ All settings are uniquely identified with an identifier string. Identifiers are
 |ui|Random Theme on Startup|Randomize the theme on application startup.|`boolean`|`False`|[`SettingsUserScope`]|<a id='ui.theme.randomize'>ui.theme.randomize</a>|
 |ui|Match Types by Substring|When changing a type in the change type dialog, if this setting is enabled all substrings will be matched instead of only startsWith style matching|`boolean`|`False`|[`SettingsUserScope`]|<a id='ui.types.substring'>ui.types.substring</a>|
 |ui|Comment Width|Maximum width of comment before wrapping, in characters. A value of 0x0 means no wrapping.|`number`|`80`|[`SettingsUserScope`]|<a id='ui.view.common.commentWidth'>ui.view.common.commentWidth</a>|
+|ui|Minimum Comment Spacing|Minimum amount of characters from the beginning of line before showing comments|`number`|`0`|[`SettingsUserScope`]|<a id='ui.view.common.minimumCommentSpacing'>ui.view.common.minimumCommentSpacing</a>|
 |ui|Disassembly Width|Maximum width of disassembly output, in characters. Not used in cases where disassembly width is automatically calculated, e.g. Linear View.|`number`|`80`|[`SettingsUserScope`]|<a id='ui.view.common.disassemblyWidth'>ui.view.common.disassemblyWidth</a>|
 |ui|Maximum Symbol Name Length|Maximum allowed length of symbol names (in characters) before truncation is used.|`number`|`64`|[`SettingsUserScope`]|<a id='ui.view.common.maxSymbolWidth'>ui.view.common.maxSymbolWidth</a>|
 |ui|Graph View IL Carousel|Specify the IL view types and order for use with the 'Cycle IL' actions in Graph view.|`array`|[`Disassembly`, `HighLevelIL`, `LowLevelIL`, `MediumLevelIL`]|[`SettingsUserScope`]|<a id='ui.view.graph.carousel'>ui.view.graph.carousel</a>|
diff --git a/python/architecture.py b/python/architecture.py
@@ -2808,6 +2808,7 @@ class InstructionTextToken:
 		TextToken                  Used for anything not of another type.
 		CommentToken               Comments
 		TypeNameToken              **Not emitted by architectures**
+		AddressSeparatorToken      **Not emitted by architectures**
 		========================== ============================================
 
 	"""
diff --git a/python/basedetection.py b/python/basedetection.py
@@ -161,7 +161,7 @@ def aborted(self) -> bool:
     def detect_base_address(
         self,
         arch: Optional[str] = "",
-        analysis: Optional[str] = Literal["basic", "controlFlow", "full"],
+        analysis: Optional[Literal["basic", "controlFlow", "full"]] = "full",
         min_strlen: Optional[int] = 10,
         alignment: Optional[int] = 1024,
         low_boundary: Optional[int] = 0,
diff --git a/python/binaryview.py b/python/binaryview.py
@@ -4463,8 +4463,6 @@ def get_functions_by_name(
 			    SymbolType.FunctionSymbol, SymbolType.ImportedFunctionSymbol, SymbolType.LibraryFunctionSymbol
 			]
 
-		if plat == None:
-			plat = self.platform
 		fns = []
 		addresses = [sym.address for sym in self.get_symbols_by_name(name, ordered_filter=ordered_filter)]
 		if len(addresses) == 0 and name.startswith("sub_"):
@@ -4474,7 +4472,9 @@ def get_functions_by_name(
 				addresses = []
 		for address in addresses:
 			for fn in self.get_functions_at(address):
-				if fn.start == address and fn.platform == plat:
+				if fn.start == address:
+					if plat is not None and fn.platform != plat:
+						continue
 					fns.append(fn)
 		return fns
 
diff --git a/python/demangle.py b/python/demangle.py
@@ -46,6 +46,39 @@ def get_qualified_name(names):
 	return "::".join(names)
 
 
+def demangle_llvm(mangled_name: str, options=None):
+	"""
+	``demangle_llvm`` demangles a mangled name to a Type object.
+
+	:param str mangled_name: a mangled (msvc/itanium/rust/dlang) name
+	:param options: (optional) Whether to simplify demangled names : None falls back to user settings, a BinaryView uses that BinaryView's settings, or a boolean to set it directly
+	:type options: Tuple[bool, BinaryView, None]
+	:return: returns demangled name or None on error
+	:rtype: str
+	"""
+	outName = ctypes.POINTER(ctypes.c_char_p)()
+	outSize = ctypes.c_ulonglong()
+	names = []
+	if (
+			isinstance(options, binaryview.BinaryView) and core.BNDemangleLLVMWithOptions(
+		mangled_name, ctypes.byref(outName), ctypes.byref(outSize), options.handle
+	)
+	) or (
+			isinstance(options, bool) and core.BNDemangleLLVM(
+		mangled_name, ctypes.byref(outName), ctypes.byref(outSize), options
+	)
+	) or (
+			options is None and core.BNDemangleLLVMWithOptions(
+		mangled_name, ctypes.byref(outName), ctypes.byref(outSize), None
+	)
+	):
+		for i in range(outSize.value):
+			names.append(outName[i].decode('utf8'))  # type: ignore
+		core.BNFreeDemangledName(ctypes.byref(outName), outSize.value)
+		return names
+	return None
+
+
 def demangle_ms(archOrPlatform:Union[Architecture, Platform], mangled_name:str, options=False):
 	"""
 	``demangle_ms`` demangles a mangled Microsoft Visual Studio C++ name to a Type object.
@@ -75,7 +108,7 @@ def demangle_ms(archOrPlatform:Union[Architecture, Platform], mangled_name:str,
 
 	if (
 	    isinstance(options, binaryview.BinaryView) and demangleWithOptions(
-	        archOrPlatform.handle, mangled_name, ctypes.byref(handle), ctypes.byref(outName), ctypes.byref(outSize), options
+	        archOrPlatform.handle, mangled_name, ctypes.byref(handle), ctypes.byref(outName), ctypes.byref(outSize), options.handle
 	    )
 	) or (
 	    isinstance(options, bool) and demangle(
@@ -112,7 +145,7 @@ def demangle_gnu3(arch, mangled_name, options=None):
 	names = []
 	if (
 	    isinstance(options, binaryview.BinaryView) and core.BNDemangleGNU3WithOptions(
-	        arch.handle, mangled_name, ctypes.byref(handle), ctypes.byref(outName), ctypes.byref(outSize), options
+	        arch.handle, mangled_name, ctypes.byref(handle), ctypes.byref(outName), ctypes.byref(outSize), options.handle
 	    )
 	) or (
 	    isinstance(options, bool) and core.BNDemangleGNU3(
diff --git a/python/examples/export_svg.py b/python/examples/export_svg.py
@@ -258,7 +258,7 @@ def render_svg(function, offset, mode, form, showOpcodes, showAddresses, orignam
 			.BaseStructureNameToken, .BaseStructureSeparatorToken {{
 				fill: {rgbStr('BaseStructureNameColor')};
 			}}
-			.TextToken, .BeginMemoryOperandToken, .EndMemoryOperandToken {{
+			.TextToken, .BeginMemoryOperandToken, .EndMemoryOperandToken, .AddressSeparatorToken {{
 				fill: {rgbStr('TextToken')};
 			}}
 		</style>
diff --git a/python/examples/raw_binary_base_detection.py b/python/examples/raw_binary_base_detection.py
@@ -47,7 +47,7 @@ def _parse_args() -> argparse.Namespace:
     parser.add_argument("path", help="path to the position-dependent raw firmware binary or directory")
     parser.add_argument("--debug", action="store_true", help="enable debug logging")
     parser.add_argument("--reasons", action="store_true", help="show reasons for base address selection")
-    parser.add_argument("--analysis", type=str, help="analysis level", default="basic")
+    parser.add_argument("--analysis", type=str, help="analysis level", default="full")
     parser.add_argument("--arch", type=str, default="", help="architecture of the binary")
     return parser.parse_args()
 
diff --git a/rust/src/demangle.rs b/rust/src/demangle.rs
@@ -26,6 +26,49 @@ use crate::rc::*;
 
 pub type Result<R> = result::Result<R, ()>;
 
+pub fn demangle_llvm<S: BnStrCompatible>(
+    mangled_name: S,
+    simplify: bool,
+) -> Result<Vec<String>> {
+    let mangled_name_bwn = mangled_name.into_bytes_with_nul();
+    let mangled_name_ptr = mangled_name_bwn.as_ref();
+    let mut out_name: *mut *mut std::os::raw::c_char = unsafe { std::mem::zeroed() };
+    let mut out_size: usize = 0;
+    let res = unsafe {
+        BNDemangleLLVM(
+            mangled_name_ptr.as_ptr() as *const c_char,
+            &mut out_name,
+            &mut out_size,
+            simplify,
+        )
+    };
+
+    if !res || out_size == 0 {
+        let cstr = match CStr::from_bytes_with_nul(mangled_name_ptr) {
+            Ok(cstr) => cstr,
+            Err(_) => {
+                log::error!("demangle_llvm: failed to parse mangled name");
+                return Err(());
+            }
+        };
+        return Ok(vec![cstr.to_string_lossy().into_owned()]);
+    }
+
+    if out_name.is_null() {
+        log::error!("demangle_llvm: out_name is NULL");
+        return Err(());
+    }
+
+    let names = unsafe { ArrayGuard::<BnString>::new(out_name, out_size, ()) }
+        .iter()
+        .map(str::to_string)
+        .collect();
+
+    unsafe { BNFreeDemangledName(&mut out_name, out_size) };
+
+    Ok(names)
+}
+
 pub fn demangle_gnu3<S: BnStrCompatible>(
     arch: &CoreArchitecture,
     mangled_name: S,
diff --git a/ui/action.h b/ui/action.h
@@ -43,6 +43,7 @@ struct BINARYNINJAUIAPI HighlightTokenState
 	BinaryNinja::Variable localVar;
 	size_t tokenIndex;
 	size_t characterIndex;
+	size_t indentGroup;
 
 	HighlightTokenState();
 
diff --git a/ui/disassemblyview.h b/ui/disassemblyview.h
@@ -5,6 +5,7 @@
 #include <QtWidgets/QSplitter>
 #include <QtWidgets/QLabel>
 #include <mutex>
+#include <optional>
 #include "binaryninjaapi.h"
 #include "viewframe.h"
 #include "instructionedit.h"
@@ -75,6 +76,8 @@ class BINARYNINJAUIAPI DisassemblyView : public FlowGraphWidget
 
 	void setOption(BNDisassemblyOption option, bool state = true);
 	void toggleOption(BNDisassemblyOption option);
+	void setAddressMode(std::optional<BNDisassemblyAddressMode> mode, std::optional<bool> hex, std::optional<bool> withName);
+	void setDisplayedFileName();
 
 	virtual DisassemblySettingsRef getDisassemblySettings() override;
 	virtual void setDisassemblySettings(DisassemblySettingsRef settings) override;
@@ -129,6 +132,7 @@ class BINARYNINJAUIAPI DisassemblyView : public FlowGraphWidget
 
 	BNFunctionGraphType m_ilViewType;
 	std::set<BNDisassemblyOption> m_options;
+	BNDisassemblyAddressMode m_addressMode;
 	DisassemblyContainer* m_container;
 	SettingsRef m_settings;
 
diff --git a/ui/linearview.h b/ui/linearview.h
@@ -262,7 +262,7 @@ class BINARYNINJAUIAPI LinearView : public QAbstractScrollArea, public View, pub
 	void getHexDumpLineBytes(
 		const BinaryNinja::LinearDisassemblyLine& line, size_t& skippedBytes, size_t& totalBytes, size_t& totalCols);
 
-	void paintHexDumpLine(QPainter& p, const LinearViewLine& line, int xoffset, int y, uint32_t addrLen, int tagOffset);
+	void paintHexDumpLine(QPainter& p, const LinearViewLine& line, int xoffset, int y, int tagOffset);
 	void paintAnalysisWarningLine(QPainter& p, const LinearViewLine& line, int xoffset, int y);
 	void paintTokenLine(QPainter& p, const LinearViewLine& line, int xoffset, int y, QRect eventRect, int tagOffset);
 
@@ -478,6 +478,8 @@ private Q_SLOTS:
 	void setContrast(HexEditorHighlightContrast mode);
 
 	void toggleOption(BNDisassemblyOption option);
+	void setAddressMode(std::optional<BNDisassemblyAddressMode> mode, std::optional<bool> hex, std::optional<bool> withName);
+	void setDisplayedFileName();
 
 	virtual bool goToReference(FunctionRef func, uint64_t source, uint64_t target) override;
 	QFont getFont() override { return m_render.getFont(); }
diff --git a/view/elf/elfview.cpp b/view/elf/elfview.cpp
diff --git a/view/macho/machoview.cpp b/view/macho/machoview.cpp
diff --git a/view/pe/peview.cpp b/view/pe/peview.cpp
