merge with main

Author: v1X3Q0

CMakeLists.txt

@@ -33,10 +33,41 @@ add_library(binaryninjaapi STATIC ${BN_API_SOURCES})
 target_include_directories(binaryninjaapi
     PUBLIC ${PROJECT_SOURCE_DIR})
 
-find_package(BinaryNinjaCore REQUIRED)
-target_link_libraries(binaryninjaapi PUBLIC ${BinaryNinjaCore_LIBRARIES})
-target_link_directories(binaryninjaapi PUBLIC ${BinaryNinjaCore_LIBRARY_DIRS})
-target_compile_definitions(binaryninjaapi PUBLIC ${BinaryNinjaCore_DEFINITIONS})
+find_package(BinaryNinjaCore)
+if(BinaryNinjaCore_FOUND)
+    target_link_libraries(binaryninjaapi PUBLIC ${BinaryNinjaCore_LIBRARIES})
+    target_link_directories(binaryninjaapi PUBLIC ${BinaryNinjaCore_LIBRARY_DIRS})
+    target_compile_definitions(binaryninjaapi PUBLIC ${BinaryNinjaCore_DEFINITIONS})
+else()
+    if(APPLE)
+        target_link_options(binaryninjaapi PUBLIC -undefined dynamic_lookup)
+    elseif(MSVC)
+        # Generate stubs.cpp with implementations of all the BNAPI functions
+        execute_process(COMMAND python ${PROJECT_SOURCE_DIR}/cmake/generate_stubs.py ${PROJECT_SOURCE_DIR}/binaryninjacore.h ${PROJECT_BINARY_DIR}/stubs)
+        
+        # Compile those stubs into a stub library we can use to fool the linker
+        add_library(binaryninjacore SHARED ${PROJECT_BINARY_DIR}/stubs/stubs.cpp)
+        set_target_properties(binaryninjacore
+            PROPERTIES OUTPUT_NAME binaryninjacore
+            SOVERSION 1
+            ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/stubs
+            LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/stubs
+            RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/stubs
+        )
+        target_include_directories(binaryninjacore PUBLIC ${PROJECT_SOURCE_DIR})
+        
+        # Be sure to only link against the stubs archive file
+        add_dependencies(binaryninjaapi binaryninjacore)
+        if(${CMAKE_GENERATOR} MATCHES "^Visual Studio")
+            # Visual Studio's generator adds the config to the file path
+            target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore,ARCHIVE_OUTPUT_DIRECTORY>/$<CONFIG>/$<TARGET_PROPERTY:binaryninjacore,OUTPUT_NAME>.lib")
+        else()
+            target_link_libraries(binaryninjaapi PUBLIC "$<TARGET_PROPERTY:binaryninjacore,ARCHIVE_OUTPUT_DIRECTORY>/$<TARGET_PROPERTY:binaryninjacore,OUTPUT_NAME>.lib")
+        endif()
+    else()
+        target_link_options(binaryninjaapi PUBLIC "LINKER:--allow-shlib-undefined")
+    endif()
+endif()
 
 if(BN_REF_COUNT_DEBUG)
     target_compile_definitions(binaryninjaapi PUBLIC BN_REF_COUNT_DEBUG)
@@ -94,16 +125,18 @@ function(bn_install_plugin target)
         list(APPEND CMAKE_MODULE_PATH "${BN_API_SOURCE_DIR}/cmake")
 
         # BinaryNinjaCore has the user plugins dir define that we want
-        find_package(BinaryNinjaCore REQUIRED)
-        if(WIN32)
-            install(TARGETS ${target} RUNTIME
-                DESTINATION ${BinaryNinjaCore_USER_PLUGINS_DIR})
-
-            install(FILES $<TARGET_PDB_FILE:${target}>
-                DESTINATION ${BinaryNinjaCore_USER_PLUGINS_DIR} OPTIONAL)
-        else()
-            install(TARGETS ${target} LIBRARY
-                DESTINATION ${BinaryNinjaCore_USER_PLUGINS_DIR})
+        find_package(BinaryNinjaCore)
+        if(BinaryNinjaCore_FOUND)
+            if(WIN32)
+                install(TARGETS ${target} RUNTIME
+                    DESTINATION ${BinaryNinjaCore_USER_PLUGINS_DIR})
+
+                install(FILES $<TARGET_PDB_FILE:${target}>
+                    DESTINATION ${BinaryNinjaCore_USER_PLUGINS_DIR} OPTIONAL)
+            else()
+                install(TARGETS ${target} LIBRARY
+                    DESTINATION ${BinaryNinjaCore_USER_PLUGINS_DIR})
+            endif()
         endif()
     endif()
 endfunction()

README.md

@@ -15,14 +15,10 @@ Online documentation is available for the following APIs:
 - [Rust API, Stable Branch](https://rust.binary.ninja/)
 - [Rust API, Dev Branch](https://rust-dev.binary.ninja/)
 
-## Branches
-
-This repository has two primary branches [`dev`](/Vector35/binaryninja-api/tree/dev/) and [`master`](/Vector35/binaryninja-api/tree/master/).
-
-The `dev` branch has the latest updates and tracks the latest development build of Binary Ninja; pull requests should be made against this branch. The `master` branch tracks the stable build of Binary Ninja. If you have just installed Binary Ninja for the first time, you are likely on the stable release channel.
-
 ## Usage and Build Instructions
 
+**In order to build the Binary Ninja API, you will need to use the specific revision that matches the hash from the file `api_REVISION.txt`.** This file should be located in the root install folder for Linux and Windows or the `Contents/Resources` sub-folder of the app on macOS. The easiest way to do this is by cloning this repository (or adding it as a submodule) and doing something like `git checkout $(cat api_REVISION.txt | awk -F/ '{print $NF}')`. Documentation for how to set this up with something like `cmake` can be found [here](https://docs.binary.ninja/dev/plugins.html?h=api_#cmake-setup).
+
 To write Binary Ninja plugins using C++, you'll need to build the C++ API. Building the API library is done similarly to most CMake-based projects; the basic steps are outlined as follows:
 
 ```Bash
@@ -70,13 +66,18 @@ There are many examples available. The [Python examples folder](https://github.c
 
 The issue tracker for this repository tracks not only issues with the source code contained here but also the broader Binary Ninja product.
 
+## Branches
+
+This repository has two primary branches [`dev`](/Vector35/binaryninja-api/tree/dev/) and [`master`](/Vector35/binaryninja-api/tree/master/).
+
+The `dev` branch has the latest updates and tracks the latest development build of Binary Ninja; pull requests should be made against this branch. The `master` branch tracks the stable build of Binary Ninja. If you have just installed Binary Ninja for the first time, you are likely on the stable release channel.
+
 ## Contributing
 
 Public contributions are welcome to this repository. Most of the API and documentation in this repository is licensed under an MIT license, however, the API interfaces with a closed-source commercial application, [Binary Ninja](https://binary.ninja). Additionally, the [Rust API](https://github.com/Vector35/binaryninja-api/tree/dev/rust) is [licensed](https://github.com/Vector35/binaryninja-api/tree/dev/rust/LICENSE) under a Apache 2.0 license.
 
 If you're interested in contributing when you submit your first PR, you'll receive a notice from [CLA Assistant](https://cla-assistant.io/) that allows you to sign our [Contribution License Agreement](https://binary.ninja/cla.pdf) online.
 
-
 ## Platforms
 
 This repository contains all of our Platform plugins available here:
@@ -91,14 +92,15 @@ This repository contains all of our Platform plugins available here:
 
 ## Architectures
 
-This repository contains all of our Architecture plugins available here:
+This repository contains all of the Architecture plugins available in Personal and Commercial editions of Binary Ninja. You can find each architecture here:
 
+* [x86/x86_64](https://github.com/Vector35/binaryninja-api/tree/dev/arch/x86)
+* [ARM64](https://github.com/Vector35/binaryninja-api/tree/dev/arch/arm64)
 * [ARMv7](https://github.com/Vector35/binaryninja-api/tree/dev/arch/armv7)
 * [PPC](https://github.com/Vector35/binaryninja-api/tree/dev/arch/powerpc)
-* [MIPS32](https://github.com/Vector35/binaryninja-api/tree/dev/arch/mips)
-* [ARM64](https://github.com/Vector35/binaryninja-api/tree/dev/arch/arm64)
-* [x86/x86_64](https://github.com/Vector35/binaryninja-api/tree/dev/arch/x86)
-* [RISCV](https://github.com/Vector35/binaryninja-api/tree/dev/arch/riscv)
+* [MIPS](https://github.com/Vector35/binaryninja-api/tree/dev/arch/mips)
+* [RISC-V](https://github.com/Vector35/binaryninja-api/tree/dev/arch/riscv)
+* [MSP430](https://github.com/Vector35/binaryninja-api/tree/dev/arch/msp430)
 
 
 ## BinaryViewTypes
@@ -114,6 +116,8 @@ This repository contains all of our Binary View Type plugins available here:
 ## DebugInfo
 
 * [DWARF Import](https://github.com/Vector35/binaryninja-api/tree/dev/rust/examples/dwarf/dwarf_import)
+* [PDB Import](https://github.com/Vector35/binaryninja-api/tree/dev/rust/examples/pdb-ng)
+* [IDB Import](https://github.com/Vector35/binaryninja-api/tree/dev/rust/examples/idb_import)
 
 
 ## Related Repositories

api-docs/source/conf.py

@@ -229,7 +229,8 @@ def generaterst():
 #
 # The short X.Y version.
 version = u'.'.join(str(binaryninja.core_version()).split('.')[0:2])
-release = str(binaryninja.core_version())
+# The longer X.Y.Z-channel version. (We intentionally strip the edition.)
+release = str(binaryninja.core_version().split(' ')[0])
 
 language = 'en'
 

arch/arm64/arch_arm64.cpp

@@ -1040,7 +1040,7 @@ class Arm64Architecture : public Architecture
 		// on it to fill the next array.
 		static_assert(Arm64Intrinsic::ARM64_INTRIN_AUTDA == 0,
 			"Invalid first Arm64Intrinsic value. Please add your intrinsic further in the enum.");
-		
+
 		// Normal intrinsics.
 		for (uint32_t id = Arm64Intrinsic::ARM64_INTRIN_AUTDA; id < Arm64Intrinsic::ARM64_INTRIN_NORMAL_END; id++) {
 			result.push_back(id);
@@ -1856,7 +1856,7 @@ class Arm64Architecture : public Architecture
 			REG_TRCCIDCVR5, REG_TRCVMIDCVR5, REG_TRCCIDCVR6, REG_TRCVMIDCVR6,
 			REG_TRCCIDCVR7, REG_TRCVMIDCVR7, REG_TRCITCTRL, REG_TRCCLAIMSET,
 			REG_TRCCLAIMCLR, REG_TRCLAR, REG_TEECR32_EL1, REG_TEEHBR32_EL1, REG_DBGDTR_EL0,
-			REG_DBGDTRTX_EL0, REG_DBGVCR32_EL2, REG_SCTLR_EL1, REG_ACTLR_EL1,
+			REG_DBGDTRTX_EL0, REG_DBGVCR32_EL2, REG_MPIDR_EL1, REG_SCTLR_EL1, REG_ACTLR_EL1,
 			REG_CPACR_EL1, REG_RGSR_EL1, REG_GCR_EL1, REG_TRFCR_EL1, REG_TTBR0_EL1,
 			REG_TTBR1_EL1, REG_TCR_EL1, REG_APIAKEYLO_EL1, REG_APIAKEYHI_EL1,
 			REG_APIBKEYLO_EL1, REG_APIBKEYHI_EL1, REG_APDAKEYLO_EL1, REG_APDAKEYHI_EL1,
@@ -3021,11 +3021,18 @@ class Arm64ElfRelocationHandler : public RelocationHandler
 		auto info = reloc->GetInfo();
 		if (len < info.size)
 			return false;
-		uint64_t* dest64 = (uint64_t*)dest;
-		uint32_t* dest32 = (uint32_t*)dest;
-		uint16_t* dest16 = (uint16_t*)dest;
-		// auto swap = [&arch](uint32_t x) { return (arch->GetEndianness() == LittleEndian)? x :
-		// bswap32(x); };
+
+		BNEndianness endianness = view->GetDefaultEndianness();
+		auto write64 = [&endianness](uint64_t* dest64, uint64_t val) {
+			*dest64 = endianness == LittleEndian ? val : ToBE64(val);
+		};
+		auto write32 = [&endianness](uint32_t* dest32, uint32_t val) {
+			*dest32 = endianness == LittleEndian ? val : ToBE32(val);
+		};
+		auto write16 = [&endianness](uint16_t* dest16, uint16_t val) {
+			*dest16 = endianness == LittleEndian ? val : ToBE16(val);
+		};
+
 		uint64_t target = reloc->GetTarget();
 		Instruction inst;
 		switch (info.nativeType)
@@ -3036,12 +3043,12 @@ class Arm64ElfRelocationHandler : public RelocationHandler
 		case R_AARCH64_P32_COPY:
 		case R_AARCH64_P32_GLOB_DAT:
 		case R_AARCH64_P32_JUMP_SLOT:
-			dest32[0] = target;
+			write32((uint32_t*)dest, target);
 			break;
 		case R_AARCH64_COPY:
 		case R_AARCH64_GLOB_DAT:
 		case R_AARCH64_JUMP_SLOT:
-			dest64[0] = target;
+			write64((uint64_t*)dest, target);
 			break;
 		case R_AARCH64_ADR_PREL_LO21:
 			break;
@@ -3058,41 +3065,41 @@ class Arm64ElfRelocationHandler : public RelocationHandler
 		case R_AARCH64_ADD_ABS_LO12_NC:
 		{
 			ADD_SUB_IMM* decode = (ADD_SUB_IMM*)dest;
-			aarch64_decompose(dest32[0], &inst, reloc->GetAddress());
+			aarch64_decompose(*(uint32_t*)dest, &inst, reloc->GetAddress());
 			decode->imm = target + info.addend;
 			break;
 		}
 		case R_AARCH64_CALL26:
 		case R_AARCH64_JUMP26:
 		{
 			UNCONDITIONAL_BRANCH* decode = (UNCONDITIONAL_BRANCH*)dest;
-			aarch64_decompose(dest32[0], &inst, 0);
+			aarch64_decompose(*(uint32_t*)dest, &inst, 0);
 			decode->imm = (target + info.addend - reloc->GetAddress()) >> 2;
 			break;
 		}
 		case R_AARCH64_ABS16:
-			dest16[0] = (uint16_t)(target + info.addend);
+			write16((uint16_t*)dest, target + info.addend);
 			break;
 		case R_AARCH64_ABS32:
-			dest32[0] = (uint32_t)(target + info.addend);
+			write32((uint32_t*)dest, target + info.addend);
 			break;
 		case R_AARCH64_ABS64:
-			dest64[0] = target + info.addend;
+			write64((uint64_t*)dest, target + info.addend);
 			break;
 		case R_AARCH64_PREL16:
-			dest16[0] = (uint16_t)(info.addend + target - reloc->GetAddress());
+			write16((uint16_t*)dest, info.addend + target - reloc->GetAddress());
 			break;
 		case R_AARCH64_PREL32:
-			dest32[0] = (uint32_t)(info.addend + target - reloc->GetAddress());
+			write32((uint32_t*)dest, info.addend + target - reloc->GetAddress());
 			break;
 		case R_AARCH64_PREL64:
-			dest64[0] = info.addend + target - reloc->GetAddress();
+			write64((uint64_t*)dest, info.addend + target - reloc->GetAddress());
 			break;
 		case R_AARCH64_P32_RELATIVE:
-			dest32[0] = target + info.addend;
+			write32((uint32_t*)dest, target + info.addend);
 			break;
 		case R_AARCH64_RELATIVE:
-			dest64[0] = target + info.addend;
+			write64((uint64_t*)dest, target + info.addend);
 			break;
 		case R_AARCH64_LDST8_ABS_LO12_NC:
 		{
@@ -3537,7 +3544,7 @@ extern "C"
 {
 	BN_DECLARE_CORE_ABI_VERSION
 
-#ifndef DEMO_VERSION
+#ifndef DEMO_EDITION
 	BINARYNINJAPLUGIN void CorePluginDependencies()
 	{
 		AddOptionalPluginDependency("view_elf");
@@ -3546,7 +3553,7 @@ extern "C"
 	}
 #endif
 
-#ifdef DEMO_VERSION
+#ifdef DEMO_EDITION
 	bool Arm64PluginInit()
 #else
 	BINARYNINJAPLUGIN bool CorePluginInit()

arch/arm64/disassembler/format.c

@@ -420,7 +420,7 @@ uint32_t get_sme_tile(const InstructionOperand *operand, char *outBuffer, uint32
 		if(operand->arrSpec == ARRSPEC_FULL)
 			snprintf(base_offset, sizeof(base_offset), "[%s]", get_register_name(operand->reg[0]));
 		else
-			snprintf(base_offset, sizeof(base_offset), "[%s, #%llu]", get_register_name(operand->reg[0]), operand->immediate);
+			snprintf(base_offset, sizeof(base_offset), "[%s, #%" PRIu64 "]", get_register_name(operand->reg[0]), operand->immediate);
 	}
 
 	char *slice = "";
@@ -445,9 +445,9 @@ uint32_t get_indexed_element(const InstructionOperand *operand, char *outBuffer,
 	// make the "{, #<imm>}"
 	char optional_comma_and[32];
 	if(operand->immediate)
-		if(snprintf(optional_comma_and, 32, ", #%llu", operand->immediate) >= 32)
+		if(snprintf(optional_comma_and, 32, ", #%" PRIu64 "", operand->immediate) >= 32)
 			return FAILED_TO_DISASSEMBLE_OPERAND;
-	
+
 	// <Pn>.<T>[<Wm>{, #<imm>}]
 	if(snprintf(outBuffer, outBufferSize, "%s%s[%s%s]",
 		get_register_name(operand->reg[0]),
@@ -462,7 +462,7 @@ uint32_t get_indexed_element(const InstructionOperand *operand, char *outBuffer,
 
 uint32_t get_accum_array(const InstructionOperand *operand, char *outBuffer, uint32_t outBufferSize)
 {
-	if(snprintf(outBuffer, outBufferSize, "ZA[%s, #%llu]",
+	if(snprintf(outBuffer, outBufferSize, "ZA[%s, #%" PRIu64 "]",
 	  get_register_name(operand->reg[0]), operand->immediate
 	  ) >= outBufferSize)
 		return FAILED_TO_DISASSEMBLE_OPERAND;
@@ -580,7 +580,7 @@ int aarch64_disassemble(Instruction *instruction, char *buf, size_t buf_sz)
 					sizeof(tmpOperandString)) != DISASM_SUCCESS)
 					return FAILED_TO_DISASSEMBLE_OPERAND;
 				operand = tmpOperandString;
-				break;				
+				break;
 			case NAME:
 				operand = instruction->operands[i].name;
 				break;

arch/arm64/disassembler/sysregs.c

@@ -264,6 +264,7 @@ const char *get_system_register_name(enum SystemReg sr)
 		case 38944: return "dbgdtr_el0";
 		case 38952: return "dbgdtrtx_el0";
 		case 41016: return "dbgvcr32_el2";
+		case 49157: return "mpidr_el1";
 		case 49280: return "sctlr_el1";
 		case 49281: return "actlr_el1";
 		case 49282: return "cpacr_el1";

arch/arm64/disassembler/sysregs.h

@@ -259,6 +259,7 @@ enum SystemReg {
 	REG_DBGDTR_EL0=38944,
 	REG_DBGDTRTX_EL0=38952,
 	REG_DBGVCR32_EL2=41016,
+	REG_MPIDR_EL1=49157,
 	REG_SCTLR_EL1=49280,
 	REG_ACTLR_EL1=49281,
 	REG_CPACR_EL1=49282,

arch/armv7/arch_armv7.cpp

@@ -3229,7 +3229,7 @@ extern "C"
 {
 	BN_DECLARE_CORE_ABI_VERSION
 
-#ifndef DEMO_VERSION
+#ifndef DEMO_EDITION
 	BINARYNINJAPLUGIN void CorePluginDependencies()
 	{
 		AddOptionalPluginDependency("view_elf");
@@ -3238,7 +3238,7 @@ extern "C"
 	}
 #endif
 
-#ifdef DEMO_VERSION
+#ifdef DEMO_EDITION
 	bool ARMv7PluginInit()
 #else
 	BINARYNINJAPLUGIN bool CorePluginInit()

arch/armv7/il.cpp

@@ -4874,7 +4874,7 @@ bool GetLowLevelILForArmInstruction(Architecture* arch, uint64_t addr, LowLevelI
 					il.DivUnsigned(get_register_size(op2.reg), ReadRegisterOrPointer(il, op2, addr), ReadRegisterOrPointer(il, op3, addr))));
 			break;
 		case ARMV7_VADD:
-			if((instr.dataType != DT_F32) && (instr.dataType != DT_F32) && (instr.dataType != DT_F64))
+			if((instr.dataType != DT_F32) && (instr.dataType != DT_F64))
 				break;
 
 			ConditionExecute(il, instr.cond,
@@ -4887,7 +4887,7 @@ bool GetLowLevelILForArmInstruction(Architecture* arch, uint64_t addr, LowLevelI
 			);
 			break;
 		case ARMV7_VDIV:
-			if((instr.dataType != DT_F32) && (instr.dataType != DT_F32) && (instr.dataType != DT_F64))
+			if((instr.dataType != DT_F32) && (instr.dataType != DT_F64))
 				break;
 
 			ConditionExecute(il, instr.cond,
@@ -4935,7 +4935,7 @@ bool GetLowLevelILForArmInstruction(Architecture* arch, uint64_t addr, LowLevelI
 			}
 			break;
 		case ARMV7_VMUL:
-			if((instr.dataType != DT_F32) && (instr.dataType != DT_F32) && (instr.dataType != DT_F64))
+			if((instr.dataType != DT_F32) && (instr.dataType != DT_F64))
 				break;
 
 			ConditionExecute(il, instr.cond,
@@ -4957,7 +4957,7 @@ bool GetLowLevelILForArmInstruction(Architecture* arch, uint64_t addr, LowLevelI
 					});
 			break;
 		case ARMV7_VSUB:
-			if((instr.dataType != DT_F32) && (instr.dataType != DT_F32) && (instr.dataType != DT_F64))
+			if((instr.dataType != DT_F32) && (instr.dataType != DT_F64))
 				break;
 
 			ConditionExecute(il, instr.cond,

arch/armv7/test_lift.py

@@ -122,7 +122,9 @@
     ('T', b'\x41\xf3\x41\x00', 'LLIL_SET_REG.d(r0,LLIL_ASR.d(LLIL_LSL.d(LLIL_REG.d(r1),LLIL_CONST.b(0x1D)),LLIL_CONST.b(0x1E)))'),
     # sbfx r0, r1, 20, 30 (starting at b20, width 30... gets clamped, so b31b30...b20
     # just r0 = r1 >> 20, no left shift required
-    ('T', b'\x41\xf3\x1d\x50', 'LLIL_SET_REG.d(r0,LLIL_ASR.d(LLIL_REG.d(r1),LLIL_CONST.b(0x14)))')
+    ('T', b'\x41\xf3\x1d\x50', 'LLIL_SET_REG.d(r0,LLIL_ASR.d(LLIL_REG.d(r1),LLIL_CONST.b(0x14)))'),
+    # rev r1, r1
+    ('T', b'\x09\xba',         'LLIL_SET_REG.d(r1,LLIL_OR.d(LLIL_LSR.d(LLIL_REG.d(r1),LLIL_CONST.d(0x18)),LLIL_OR.d(LLIL_LSL.d(LLIL_AND.d(LLIL_LSR.d(LLIL_REG.d(r1),LLIL_CONST.d(0x10)),LLIL_CONST.d(0xFF)),LLIL_CONST.d(0x8)),LLIL_OR.d(LLIL_LSL.d(LLIL_AND.d(LLIL_LSR.d(LLIL_REG.d(r1),LLIL_CONST.d(0x8)),LLIL_CONST.d(0xFF)),LLIL_CONST.d(0x10)),LLIL_LSL.d(LLIL_AND.d(LLIL_REG.d(r1),LLIL_CONST.d(0xFF)),LLIL_CONST.d(0x18))))))'),
 ]
 
 import re