Fix partial initialization of DisassemblyTextLine

The usage of `DisassemblyTextLine` in the FFI was unsound, we would forget to initialize some fields causing a myriad of issues where round-tripping through the FFI was losing information.

Author: emesare

architecture.cpp

@@ -24,6 +24,7 @@
 #include <inttypes.h>
 #include <vector>
 #include "binaryninjaapi.h"
+#include "ffi.h"
 
 using namespace BinaryNinja;
 using namespace std;
@@ -2441,17 +2442,7 @@ bool DisassemblyTextRenderer::GetInstructionText(uint64_t addr, size_t& len, vec
 	if (!BNGetDisassemblyTextRendererInstructionText(m_object, addr, &len, &result, &count))
 		return false;
 
-	for (size_t i = 0; i < count; i++)
-	{
-		DisassemblyTextLine line;
-		line.addr = result[i].addr;
-		line.instrIndex = result[i].instrIndex;
-		line.highlight = result[i].highlight;
-		line.tokens = InstructionTextToken::ConvertInstructionTextTokenList(result[i].tokens, result[i].count);
-		line.tags = Tag::ConvertTagList(result[i].tags, result[i].tagCount);
-		lines.push_back(line);
-	}
-
+	lines = ParseAPIObjectList<DisassemblyTextLine>(result, count);
 	BNFreeDisassemblyTextLines(result, count);
 	return true;
 }
@@ -2460,41 +2451,15 @@ bool DisassemblyTextRenderer::GetInstructionText(uint64_t addr, size_t& len, vec
 vector<DisassemblyTextLine> DisassemblyTextRenderer::PostProcessInstructionTextLines(
     uint64_t addr, size_t len, const vector<DisassemblyTextLine>& lines, const string& indentSpaces)
 {
-	BNDisassemblyTextLine* inLines = new BNDisassemblyTextLine[lines.size()];
-	for (size_t i = 0; i < lines.size(); i++)
-	{
-		inLines[i].addr = lines[i].addr;
-		inLines[i].instrIndex = lines[i].instrIndex;
-		inLines[i].highlight = lines[i].highlight;
-		inLines[i].tokens = InstructionTextToken::CreateInstructionTextTokenList(lines[i].tokens);
-		inLines[i].count = lines[i].tokens.size();
-		inLines[i].tags = Tag::CreateTagList(lines[i].tags, &inLines[i].tagCount);
-	}
-
+	size_t inCount = 0;
+	BNDisassemblyTextLine* inLines = AllocAPIObjectList<DisassemblyTextLine>(lines, &inCount);
 	BNDisassemblyTextLine* result = nullptr;
 	size_t count = 0;
 	result = BNPostProcessDisassemblyTextRendererLines(
-	    m_object, addr, len, inLines, lines.size(), &count, indentSpaces.c_str());
-
-	for (size_t i = 0; i < lines.size(); i++)
-	{
-		InstructionTextToken::FreeInstructionTextTokenList(inLines[i].tokens, inLines[i].count);
-		Tag::FreeTagList(inLines[i].tags, inLines[i].tagCount);
-	}
-	delete[] inLines;
-
-	vector<DisassemblyTextLine> outLines;
-	for (size_t i = 0; i < count; i++)
-	{
-		DisassemblyTextLine line;
-		line.addr = result[i].addr;
-		line.instrIndex = result[i].instrIndex;
-		line.highlight = result[i].highlight;
-		line.tokens = InstructionTextToken::ConvertInstructionTextTokenList(result[i].tokens, result[i].count);
-		line.tags = Tag::ConvertTagList(result[i].tags, result[i].tagCount);
-		outLines.push_back(line);
-	}
+	    m_object, addr, len, inLines, inCount, &count, indentSpaces.c_str());
 
+	vector<DisassemblyTextLine> outLines = ParseAPIObjectList<DisassemblyTextLine>(result, count);
+	FreeAPIObjectList<DisassemblyTextLine>(inLines, inCount);
 	BNFreeDisassemblyTextLines(result, count);
 	return outLines;
 }
@@ -2507,17 +2472,7 @@ bool DisassemblyTextRenderer::GetDisassemblyText(uint64_t addr, size_t& len, vec
 	if (!BNGetDisassemblyTextRendererLines(m_object, addr, &len, &result, &count))
 		return false;
 
-	for (size_t i = 0; i < count; i++)
-	{
-		DisassemblyTextLine line;
-		line.addr = result[i].addr;
-		line.instrIndex = result[i].instrIndex;
-		line.highlight = result[i].highlight;
-		line.tokens = InstructionTextToken::ConvertInstructionTextTokenList(result[i].tokens, result[i].count);
-		line.tags = Tag::ConvertTagList(result[i].tags, result[i].tagCount);
-		lines.push_back(line);
-	}
-
+	lines = ParseAPIObjectList<DisassemblyTextLine>(result, count);
 	BNFreeDisassemblyTextLines(result, count);
 	return true;
 }
@@ -2614,31 +2569,14 @@ void DisassemblyTextRenderer::AddIntegerToken(
 void DisassemblyTextRenderer::WrapComment(DisassemblyTextLine& line, vector<DisassemblyTextLine>& lines,
     const string& comment, bool hasAutoAnnotations, const string& leadingSpaces, const string& indentSpaces)
 {
-	BNDisassemblyTextLine inLine;
-	inLine.addr = line.addr;
-	inLine.instrIndex = line.instrIndex;
-	inLine.highlight = line.highlight;
-	inLine.count = line.tokens.size();
-	inLine.tokens = InstructionTextToken::CreateInstructionTextTokenList(line.tokens);
-	inLine.tags = Tag::CreateTagList(line.tags, &inLine.tagCount);
-
+	BNDisassemblyTextLine inLine = line.GetAPIObject();
 	size_t count = 0;
 	BNDisassemblyTextLine* result = BNDisassemblyTextRendererWrapComment(
 	    m_object, &inLine, &count, comment.c_str(), hasAutoAnnotations, leadingSpaces.c_str(), indentSpaces.c_str());
 
-	for (size_t i = 0; i < count; i++)
-	{
-		DisassemblyTextLine line;
-		line.addr = result[i].addr;
-		line.instrIndex = result[i].instrIndex;
-		line.highlight = result[i].highlight;
-		line.tokens = InstructionTextToken::ConvertInstructionTextTokenList(result[i].tokens, result[i].count);
-		line.tags = Tag::ConvertTagList(result[i].tags, result[i].tagCount);
-		lines.push_back(line);
-	}
-
+	lines = ParseAPIObjectList<DisassemblyTextLine>(result, count);
 	BNFreeDisassemblyTextLines(result, count);
-	BNFreeInstructionText(inLine.tokens, inLine.count);
+	DisassemblyTextLine::FreeAPIObject(&inLine);
 }
 
 

basicblock.cpp

@@ -19,6 +19,7 @@
 // IN THE SOFTWARE.
 
 #include "binaryninjaapi.h"
+#include "ffi.h"
 
 using namespace BinaryNinja;
 using namespace std;
@@ -143,6 +144,34 @@ void DisassemblySettings::SetCallParameterHints(BNDisassemblyCallParameterHints
 }
 
 
+BNDisassemblyTextLineTypeInfo DisassemblyTextLineTypeInfo::GetAPIObject() const
+{
+	BNDisassemblyTextLineTypeInfo result;
+	result.hasTypeInfo = this->hasTypeInfo;
+	result.parentType = this->parentType ? BNNewTypeReference(this->parentType->GetObject()) : nullptr;
+	result.fieldIndex = this->fieldIndex;
+	result.offset = this->offset;
+	return result;
+}
+
+
+void DisassemblyTextLineTypeInfo::FreeAPIObject(BNDisassemblyTextLineTypeInfo *value)
+{
+	BNFreeType(value->parentType);
+}
+
+
+DisassemblyTextLineTypeInfo DisassemblyTextLineTypeInfo::FromAPIObject(const BNDisassemblyTextLineTypeInfo *value)
+{
+	DisassemblyTextLineTypeInfo result;
+	result.hasTypeInfo = value->hasTypeInfo;
+	result.fieldIndex = value->fieldIndex;
+	result.parentType = value->parentType ? new Type(BNNewTypeReference(value->parentType)) : nullptr;
+	result.offset = value->offset;
+	return result;
+}
+
+
 DisassemblyTextLine::DisassemblyTextLine()
 {
 	addr = 0;
@@ -162,6 +191,41 @@ DisassemblyTextLine::DisassemblyTextLine()
 }
 
 
+BNDisassemblyTextLine DisassemblyTextLine::GetAPIObject() const
+{
+	BNDisassemblyTextLine result;
+	result.addr = this->addr;
+	result.instrIndex = this->instrIndex;
+	result.highlight = this->highlight;
+	result.tokens = InstructionTextToken::CreateInstructionTextTokenList(this->tokens);
+	result.count = this->tokens.size();
+	result.tags = Tag::CreateTagList(this->tags, &(result.tagCount));
+	result.typeInfo = this->typeInfo.GetAPIObject();
+	return result;
+}
+
+
+void DisassemblyTextLine::FreeAPIObject(BNDisassemblyTextLine *value)
+{
+	InstructionTextToken::FreeInstructionTextTokenList(value->tokens, value->count);
+	Tag::FreeTagList(value->tags, value->tagCount);
+	DisassemblyTextLineTypeInfo::FreeAPIObject(&value->typeInfo);
+}
+
+
+DisassemblyTextLine DisassemblyTextLine::FromAPIObject(const BNDisassemblyTextLine *value)
+{
+	DisassemblyTextLine result;
+	result.addr = value->addr;
+	result.instrIndex = value->instrIndex;
+	result.highlight = value->highlight;
+	result.tokens = InstructionTextToken::ConvertInstructionTextTokenList(value->tokens, value->count);
+	result.tags = Tag::ConvertTagList(value->tags, value->tagCount);
+	result.typeInfo = DisassemblyTextLineTypeInfo::FromAPIObject(&value->typeInfo);
+	return result;
+}
+
+
 size_t DisassemblyTextLine::GetTotalWidth() const
 {
 	size_t result = 0;
@@ -435,19 +499,7 @@ vector<DisassemblyTextLine> BasicBlock::GetDisassemblyText(DisassemblySettings*
 	size_t count;
 	BNDisassemblyTextLine* lines = BNGetBasicBlockDisassemblyText(m_object, settings->GetObject(), &count);
 
-	vector<DisassemblyTextLine> result;
-	result.reserve(count);
-	for (size_t i = 0; i < count; i++)
-	{
-		DisassemblyTextLine line;
-		line.addr = lines[i].addr;
-		line.instrIndex = lines[i].instrIndex;
-		line.highlight = lines[i].highlight;
-		line.tokens = InstructionTextToken::ConvertInstructionTextTokenList(lines[i].tokens, lines[i].count);
-		line.tags = Tag::ConvertTagList(lines[i].tags, lines[i].tagCount);
-		result.push_back(line);
-	}
-
+	vector<DisassemblyTextLine> result = ParseAPIObjectList<DisassemblyTextLine>(lines, count);;
 	BNFreeDisassemblyTextLines(lines, count);
 	return result;
 }

binaryninjaapi.h

@@ -4045,10 +4045,14 @@ namespace BinaryNinja {
 	struct DisassemblyTextLineTypeInfo
 	{
 		bool hasTypeInfo;
-		BinaryNinja::Ref<BinaryNinja::Type> parentType;
+		Ref<Type> parentType;
 		size_t fieldIndex;
 		uint64_t offset;
 
+		BNDisassemblyTextLineTypeInfo GetAPIObject() const;
+		static void FreeAPIObject(BNDisassemblyTextLineTypeInfo* value);
+		static DisassemblyTextLineTypeInfo FromAPIObject(const BNDisassemblyTextLineTypeInfo* value);
+
 		DisassemblyTextLineTypeInfo() : hasTypeInfo(false), parentType(nullptr), fieldIndex(-1), offset(0) {}
 	};
 
@@ -4063,6 +4067,10 @@ namespace BinaryNinja {
 
 		DisassemblyTextLine();
 
+		BNDisassemblyTextLine GetAPIObject() const;
+		static void FreeAPIObject(BNDisassemblyTextLine* value);
+		static DisassemblyTextLine FromAPIObject(const BNDisassemblyTextLine* value);
+
 		size_t GetTotalWidth() const;
 		size_t GetAddressAndIndentationWidth() const;
 		std::vector<InstructionTextToken> GetAddressAndIndentationTokens() const;

datarenderer.cpp

@@ -1,4 +1,5 @@
 #include "binaryninjaapi.h"
+#include "ffi.h"
 
 using namespace std;
 using namespace BinaryNinja;
@@ -82,22 +83,10 @@ BNDisassemblyTextLine* DataRenderer::GetLinesForDataCallback(void* ctxt, BNBinar
 	}
 	auto lines = renderer->GetLinesForData(viewObj, addr, typeObj, prefixes, width, context,
 		language ? language : string());
-	*count = lines.size();
-	BNDisassemblyTextLine* buf = new BNDisassemblyTextLine[lines.size()];
-	for (size_t i = 0; i < lines.size(); i++)
-	{
-		const DisassemblyTextLine& line = lines[i];
-		buf[i].addr = line.addr;
-		buf[i].instrIndex = line.instrIndex;
-		buf[i].highlight = line.highlight;
-		buf[i].tokens = InstructionTextToken::CreateInstructionTextTokenList(line.tokens);
-		buf[i].count = line.tokens.size();
-		buf[i].tags = Tag::CreateTagList(line.tags, &(buf[i].tagCount));
-	}
-
+	BNDisassemblyTextLine* result = AllocAPIObjectList(lines, count);
 	for (size_t i = 0; i < ctxCount; i++)
 		context[i].first->Release();
-	return buf;
+	return result;
 }
 
 
@@ -110,12 +99,7 @@ void DataRenderer::FreeCallback(void* ctxt)
 
 void DataRenderer::FreeLinesCallback(void* ctxt, BNDisassemblyTextLine* lines, size_t count)
 {
-	for (size_t i = 0; i < count; i++)
-	{
-		InstructionTextToken::FreeInstructionTextTokenList(lines[i].tokens, lines[i].count);
-		Tag::FreeTagList(lines[i].tags, lines[i].tagCount);
-	}
-	delete[] lines;
+	FreeAPIObjectList<DisassemblyTextLine>(lines, count);
 }
 
 
@@ -157,18 +141,7 @@ vector<DisassemblyTextLine> DataRenderer::GetLinesForData(BinaryView* data, uint
 	}
 	delete[] prefixes;
 
-	vector<DisassemblyTextLine> result;
-	result.reserve(count);
-	for (size_t i = 0; i < count; i++)
-	{
-		DisassemblyTextLine line;
-		line.addr = lines[i].addr;
-		line.instrIndex = lines[i].instrIndex;
-		line.highlight = lines[i].highlight;
-		line.tokens = InstructionTextToken::ConvertAndFreeInstructionTextTokenList(lines[i].tokens, lines[i].count);
-		line.tags = Tag::ConvertAndFreeTagList(lines[i].tags, lines[i].tagCount);
-		result.push_back(line);
-	}
+	vector<DisassemblyTextLine> result = ParseAPIObjectList<DisassemblyTextLine>(lines, count);
 	BNFreeDisassemblyTextLines(lines, count);
 	return result;
 }
@@ -199,19 +172,7 @@ vector<DisassemblyTextLine> DataRenderer::RenderLinesForData(BinaryView* data, u
 	}
 	delete[] prefixes;
 
-	vector<DisassemblyTextLine> result;
-	result.reserve(count);
-	for (size_t i = 0; i < count; i++)
-	{
-		DisassemblyTextLine line;
-		line.addr = lines[i].addr;
-		line.instrIndex = lines[i].instrIndex;
-		line.highlight = lines[i].highlight;
-		line.tokens = InstructionTextToken::ConvertAndFreeInstructionTextTokenList(lines[i].tokens, lines[i].count);
-		line.tags = Tag::ConvertAndFreeTagList(lines[i].tags, lines[i].tagCount);
-		result.push_back(line);
-	}
-
+	vector<DisassemblyTextLine> result = ParseAPIObjectList<DisassemblyTextLine>(lines, count);
 	BNFreeDisassemblyTextLines(lines, count);
 	return result;
 }