Add source line render layer plugin

Author: psifertex

plugins/source_line_render_layer/CMakeLists.txt

@@ -0,0 +1,46 @@
+cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
+
+project(source_line_render_layer)
+
+file(GLOB SOURCES CONFIGURE_DEPENDS
+        *.cpp
+        *.c
+        *.h)
+
+if(DEMO)
+    add_library(${PROJECT_NAME} STATIC ${SOURCES})
+else()
+    add_library(${PROJECT_NAME} SHARED ${SOURCES})
+endif()
+
+if(NOT BN_INTERNAL_BUILD)
+    # Out-of-tree build
+    find_path(
+            BN_API_PATH
+            NAMES binaryninjaapi.h
+            HINTS ../../.. binaryninjaapi $ENV{BN_API_PATH}
+            REQUIRED
+    )
+    add_subdirectory(${BN_API_PATH} api)
+endif()
+
+target_link_libraries(${PROJECT_NAME} binaryninjaapi)
+
+set_target_properties(${PROJECT_NAME} PROPERTIES
+        CXX_STANDARD 20
+        CXX_VISIBILITY_PRESET hidden
+        CXX_STANDARD_REQUIRED ON
+        C_STANDARD 99
+        C_STANDARD_REQUIRED ON
+        C_VISIBILITY_PRESET hidden
+        VISIBILITY_INLINES_HIDDEN ON
+        POSITION_INDEPENDENT_CODE ON)
+
+if(BN_INTERNAL_BUILD)
+    plugin_rpath(${PROJECT_NAME})
+    set_target_properties(${PROJECT_NAME} PROPERTIES
+            LIBRARY_OUTPUT_DIRECTORY ${BN_CORE_PLUGIN_DIR}
+            RUNTIME_OUTPUT_DIRECTORY ${BN_CORE_PLUGIN_DIR})
+else()
+    bn_install_plugin(${PROJECT_NAME})
+endif()

plugins/source_line_render_layer/plugin.cpp

@@ -0,0 +1,109 @@
+#include <binaryninjaapi.h>
+
+using namespace BinaryNinja;
+
+
+class SourceLineRenderLayer: public RenderLayer
+{
+	static std::string DisplayPath(const std::string& path)
+	{
+		size_t pos = path.find_last_of("/\\");
+		if (pos == std::string::npos)
+			return path;
+		return path.substr(pos + 1);
+	}
+
+	static bool HasAddressSeparator(const DisassemblyTextLine& line)
+	{
+		for (const auto& token : line.tokens)
+		{
+			if (token.type == AddressSeparatorToken)
+				return true;
+		}
+		return false;
+	}
+
+	static void ApplyToLine(Ref<DebugInfo> debugInfo, DisassemblyTextLine& line, bool requireAddressSeparator)
+	{
+		if (line.tokens.empty())
+			return;
+
+		if (requireAddressSeparator && !HasAddressSeparator(line))
+			return;
+
+		auto sourceLines = debugInfo->GetSourceLinesByAddress(line.addr);
+		if (sourceLines.empty())
+			return;
+
+		const auto& sourceLine = std::get<1>(sourceLines.front());
+		std::string text = "  // " + DisplayPath(sourceLine.sourceFile) + ":" + std::to_string(sourceLine.line);
+		if (sourceLine.column != 0)
+			text += ":" + std::to_string(sourceLine.column);
+
+		line.tokens.emplace_back(CommentToken, text, line.addr);
+	}
+
+	void ApplyToLines(Ref<BasicBlock> block, std::vector<DisassemblyTextLine>& lines, bool requireAddressSeparator = true)
+	{
+		Ref<DebugInfo> debugInfo = block->GetFunction()->GetView()->GetDebugInfo();
+		if (!debugInfo)
+			return;
+
+		for (auto& line : lines)
+			ApplyToLine(debugInfo, line, requireAddressSeparator);
+	}
+
+public:
+	SourceLineRenderLayer(): RenderLayer("Source Line Annotations") {}
+
+	void ApplyToDisassemblyBlock(Ref<BasicBlock> block, std::vector<DisassemblyTextLine>& lines) override
+	{
+		ApplyToLines(block, lines);
+	}
+
+	void ApplyToLowLevelILBlock(Ref<BasicBlock> block, std::vector<DisassemblyTextLine>& lines) override
+	{
+		ApplyToLines(block, lines);
+	}
+
+	void ApplyToMediumLevelILBlock(Ref<BasicBlock> block, std::vector<DisassemblyTextLine>& lines) override
+	{
+		ApplyToLines(block, lines);
+	}
+
+	void ApplyToHighLevelILBlock(Ref<BasicBlock> block, std::vector<DisassemblyTextLine>& lines) override
+	{
+		ApplyToLines(block, lines, false);
+	}
+
+	void ApplyToHighLevelILBody(Ref<Function> function, std::vector<LinearDisassemblyLine>& lines) override
+	{
+		Ref<DebugInfo> debugInfo = function->GetView()->GetDebugInfo();
+		if (!debugInfo)
+			return;
+
+		for (auto& line : lines)
+		{
+			if (line.type != CodeDisassemblyLineType)
+				continue;
+
+			ApplyToLine(debugInfo, line.contents, false);
+		}
+	}
+};
+
+
+extern "C" {
+	BN_DECLARE_CORE_ABI_VERSION
+
+#ifdef DEMO_EDITION
+	bool SourceLineRenderLayerPluginInit()
+#else
+	BINARYNINJAPLUGIN bool CorePluginInit()
+#endif
+	{
+		static SourceLineRenderLayer* layer = new SourceLineRenderLayer();
+		RenderLayer::Register(layer, DisabledByDefaultRenderLayerDefaultEnableState);
+		return true;
+	}
+}