Use bn::base::function_ref instead of std::function for parameters that are not stored

bdash · bdash · commit afacb9665201 · 2025-12-11T22:45:56.000-08:00
This avoids the overhead of constructing a `std::function`, which may
require a heap allocation, when calling functions that immediately
invokes a function object.
diff --git a/genericrange.h b/genericrange.h
@@ -21,6 +21,8 @@
 
 #pragma once
 
+#include "base/function_ref.h"
+
 #ifdef BINARYNINJACORE_LIBRARY
 #include "binaryninjacore_global.h"
 namespace BinaryNinjaCore
@@ -157,16 +159,13 @@ using namespace std;
 			populateRangeMap();
 		}
 
-		GenericRangeMap(const vector<GenericRange<T>>& ranges, std::function<void(vector<T>&)> orderingStrategy)
+		GenericRangeMap(const vector<GenericRange<T>>& ranges, bn::base::function_ref<void(vector<T>&)> orderingStrategy)
 		{
 			m_sourceRanges = ranges;
 			m_flattenedRanges = ranges;
 			flatten(m_flattenedRanges);
-			if (orderingStrategy)
-			{
-				for (auto& i : m_flattenedRanges)
-					orderingStrategy(i.GetMutableItems());
-			}
+			for (auto& i : m_flattenedRanges)
+				orderingStrategy(i.GetMutableItems());
 			populateRangeMap();
 		}
 
@@ -206,7 +205,7 @@ using namespace std;
 			throw std::out_of_range("GenericRangeMap::GetMutableGenericRangeAt - Address not found in any range!");
 		}
 
-		std::optional<std::pair<uint64_t, uint64_t>> GetNextValidRange(uint64_t addr, std::function<bool(const GenericRange<T>&)> predicate) const
+		std::optional<std::pair<uint64_t, uint64_t>> GetNextValidRange(uint64_t addr, bn::base::function_ref<bool(const GenericRange<T>&)> predicate) const
 		{
 			auto itr = m_rangeMap.upper_bound(addr);
 			if (itr != m_rangeMap.begin())
@@ -222,7 +221,7 @@ using namespace std;
 			return std::nullopt;
 		}
 
-		std::optional<std::pair<uint64_t, uint64_t>> GetPreviousValidRange(uint64_t addr, std::function<bool(const GenericRange<T>&)> predicate) const
+		std::optional<std::pair<uint64_t, uint64_t>> GetPreviousValidRange(uint64_t addr, bn::base::function_ref<bool(const GenericRange<T>&)> predicate) const
 		{
 			auto itr = m_rangeMap.upper_bound(addr);
 			if (itr != m_rangeMap.begin())
diff --git a/highlevelilinstruction.cpp b/highlevelilinstruction.cpp
@@ -1342,7 +1342,7 @@ void HighLevelILInstruction::CollectSubExprs(stack<size_t>& toProcess) const
 }
 
 
-void HighLevelILInstruction::VisitExprs(const std::function<bool(const HighLevelILInstruction& expr)>& func) const
+void HighLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const HighLevelILInstruction& expr)> func) const
 {
 	stack<size_t> toProcess;
 	toProcess.push(exprIndex);
@@ -1357,8 +1357,8 @@ void HighLevelILInstruction::VisitExprs(const std::function<bool(const HighLevel
 }
 
 
-void HighLevelILInstruction::VisitExprs(const std::function<bool(const HighLevelILInstruction& expr)>& preFunc,
-	const std::function<void(const HighLevelILInstruction& expr)>& postFunc) const
+void HighLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const HighLevelILInstruction& expr)> preFunc,
+	bn::base::function_ref<void(const HighLevelILInstruction& expr)> postFunc) const
 {
 	stack<std::pair<HighLevelILInstruction, stack<size_t>>> toProcess;
 	HighLevelILInstruction cur = *this;
@@ -1404,7 +1404,7 @@ ExprId HighLevelILInstruction::CopyTo(HighLevelILFunction* dest, const ILSourceL
 
 
 ExprId HighLevelILInstruction::CopyTo(
-    HighLevelILFunction* dest, const std::function<ExprId(const HighLevelILInstruction& subExpr)>& subExprHandler, const ILSourceLocation& sourceLocation) const
+    HighLevelILFunction* dest, bn::base::function_ref<ExprId(const HighLevelILInstruction& subExpr)> subExprHandler, const ILSourceLocation& sourceLocation) const
 {
 	vector<ExprId> output, params;
 
diff --git a/highlevelilinstruction.h b/highlevelilinstruction.h
@@ -20,16 +20,19 @@
 
 #pragma once
 
-#include <functional>
-#include <unordered_map>
-#include <vector>
+#include "base/function_ref.h"
+#include "mediumlevelilinstruction.h"
+
 #ifdef BINARYNINJACORE_LIBRARY
 	#include "variable.h"
 	#include "ilsourcelocation.h"
 #else
 	#include "binaryninjaapi.h"
 #endif
-#include "mediumlevelilinstruction.h"
+
+#include <unordered_map>
+#include <vector>
+
 #include <fmt/core.h>
 
 #ifdef BINARYNINJACORE_LIBRARY
@@ -480,13 +483,13 @@ namespace BinaryNinja
 		HighLevelILInstruction(const HighLevelILInstructionBase& instr);
 
 		void CollectSubExprs(_STD_STACK<size_t>& toProcess) const;
-		void VisitExprs(const std::function<bool(const HighLevelILInstruction& expr)>& func) const;
-		void VisitExprs(const std::function<bool(const HighLevelILInstruction& expr)>& preFunc,
-			const std::function<void(const HighLevelILInstruction& expr)>& postFunc) const;
+		void VisitExprs(bn::base::function_ref<bool(const HighLevelILInstruction& expr)> func) const;
+		void VisitExprs(bn::base::function_ref<bool(const HighLevelILInstruction& expr)> preFunc,
+			bn::base::function_ref<void(const HighLevelILInstruction& expr)> postFunc) const;
 
 		ExprId CopyTo(HighLevelILFunction* dest, const ILSourceLocation& sourceLocation = {}) const;
 		ExprId CopyTo(HighLevelILFunction* dest,
-		    const std::function<ExprId(const HighLevelILInstruction& subExpr)>& subExprHandler,
+		    bn::base::function_ref<ExprId(const HighLevelILInstruction& subExpr)> subExprHandler,
 			const ILSourceLocation& sourceLocation = {}) const;
 
 		bool operator<(const HighLevelILInstruction& other) const;
diff --git a/lowlevelilinstruction.cpp b/lowlevelilinstruction.cpp
@@ -1885,7 +1885,7 @@ void LowLevelILInstructionBase::ClearAttribute(BNILInstructionAttribute attribut
 }
 
 
-void LowLevelILInstruction::VisitExprs(const std::function<bool(const LowLevelILInstruction& expr)>& func) const
+void LowLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const LowLevelILInstruction& expr)> func) const
 {
 	if (!func(*this))
 		return;
@@ -2096,7 +2096,7 @@ ExprId LowLevelILInstruction::CopyTo(LowLevelILFunction* dest, const ILSourceLoc
 
 
 ExprId LowLevelILInstruction::CopyTo(
-    LowLevelILFunction* dest, const std::function<ExprId(const LowLevelILInstruction& subExpr)>& subExprHandler, const ILSourceLocation& sourceLocation) const
+    LowLevelILFunction* dest, bn::base::function_ref<ExprId(const LowLevelILInstruction& subExpr)> subExprHandler, const ILSourceLocation& sourceLocation) const
 {
 	vector<ExprId> params;
 	BNLowLevelILLabel* labelA;
diff --git a/lowlevelilinstruction.h b/lowlevelilinstruction.h
@@ -20,16 +20,18 @@
 
 #pragma once
 
-#include <functional>
-#include <unordered_map>
-#include <vector>
 #ifdef BINARYNINJACORE_LIBRARY
 	#include "ilsourcelocation.h"
 	#include "type.h"
 #else
 	#include "binaryninjaapi.h"
 #endif
 
+#include "base/function_ref.h"
+
+#include <unordered_map>
+#include <vector>
+
 #ifdef BINARYNINJACORE_LIBRARY
 namespace BinaryNinjaCore
 #else
@@ -866,11 +868,11 @@ namespace BinaryNinja
 		    LowLevelILFunction* func, const BNLowLevelILInstruction& instr, size_t expr, size_t instrIdx);
 		LowLevelILInstruction(const LowLevelILInstructionBase& instr);
 
-		void VisitExprs(const std::function<bool(const LowLevelILInstruction& expr)>& func) const;
+		void VisitExprs(bn::base::function_ref<bool(const LowLevelILInstruction& expr)> func) const;
 
 		ExprId CopyTo(LowLevelILFunction* dest, const ILSourceLocation& sourceLocation = {}) const;
 		ExprId CopyTo(LowLevelILFunction* dest,
-			const std::function<ExprId(const LowLevelILInstruction& subExpr)>& subExprHandler,
+			bn::base::function_ref<ExprId(const LowLevelILInstruction& subExpr)> subExprHandler,
 			const ILSourceLocation& sourceLocation = {}) const;
 
 		// Templated accessors for instruction operands, use these for efficient access to a known instruction
diff --git a/mediumlevelilinstruction.cpp b/mediumlevelilinstruction.cpp
@@ -1350,7 +1350,7 @@ void MediumLevelILInstructionBase::ClearAttribute(BNILInstructionAttribute attri
 }
 
 
-void MediumLevelILInstruction::VisitExprs(const std::function<bool(const MediumLevelILInstruction& expr)>& func) const
+void MediumLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const MediumLevelILInstruction& expr)> func) const
 {
 	if (!func(*this))
 		return;
@@ -1569,7 +1569,7 @@ ExprId MediumLevelILInstruction::CopyTo(MediumLevelILFunction* dest, const ILSou
 
 
 ExprId MediumLevelILInstruction::CopyTo(MediumLevelILFunction* dest,
-    const std::function<ExprId(const MediumLevelILInstruction& subExpr)>& subExprHandler,
+    bn::base::function_ref<ExprId(const MediumLevelILInstruction& subExpr)> subExprHandler,
 	const ILSourceLocation& sourceLocation) const
 {
 	vector<ExprId> params;
diff --git a/mediumlevelilinstruction.h b/mediumlevelilinstruction.h
@@ -20,9 +20,6 @@
 
 #pragma once
 
-#include <functional>
-#include <unordered_map>
-#include <vector>
 #ifdef BINARYNINJACORE_LIBRARY
 	#include "constantdata.h"
 	#include "variable.h"
@@ -31,6 +28,11 @@
 	#include "binaryninjaapi.h"
 #endif
 
+#include "base/function_ref.h"
+
+#include <unordered_map>
+#include <vector>
+
 #ifdef BINARYNINJACORE_LIBRARY
 namespace BinaryNinjaCore
 #else
@@ -617,11 +619,11 @@ namespace BinaryNinja
 		    MediumLevelILFunction* func, const BNMediumLevelILInstruction& instr, size_t expr, size_t instrIdx);
 		MediumLevelILInstruction(const MediumLevelILInstructionBase& instr);
 
-		void VisitExprs(const std::function<bool(const MediumLevelILInstruction& expr)>& func) const;
+		void VisitExprs(bn::base::function_ref<bool(const MediumLevelILInstruction& expr)> func) const;
 
 		ExprId CopyTo(MediumLevelILFunction* dest, const ILSourceLocation& sourceLocation = {}) const;
 		ExprId CopyTo(MediumLevelILFunction* dest,
-		    const std::function<ExprId(const MediumLevelILInstruction& subExpr)>& subExprHandler,
+		    bn::base::function_ref<ExprId(const MediumLevelILInstruction& subExpr)> subExprHandler,
 			const ILSourceLocation& sourceLocation = {}) const;
 
 		// Templated accessors for instruction operands, use these for efficient access to a known instruction

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`
`22`	`22`	`#pragma once`
`23`	`23`
	`24`	`+#include "base/function_ref.h"`
	`25`	`+`
`24`	`26`	`#ifdef BINARYNINJACORE_LIBRARY`
`25`	`27`	`#include "binaryninjacore_global.h"`
`26`	`28`	`namespace BinaryNinjaCore`
`@@ -157,16 +159,13 @@ using namespace std;`
`157`	`159`	`populateRangeMap();`
`158`	`160`	`}`
`159`	`161`
`160`		`- GenericRangeMap(const vector<GenericRange<T>>& ranges, std::function<void(vector<T>&)> orderingStrategy)`
	`162`	`+ GenericRangeMap(const vector<GenericRange<T>>& ranges, bn::base::function_ref<void(vector<T>&)> orderingStrategy)`
`161`	`163`	`{`
`162`	`164`	`m_sourceRanges = ranges;`
`163`	`165`	`m_flattenedRanges = ranges;`
`164`	`166`	`flatten(m_flattenedRanges);`
`165`		`- if (orderingStrategy)`
`166`		`- {`
`167`		`- for (auto& i : m_flattenedRanges)`
`168`		`- orderingStrategy(i.GetMutableItems());`
`169`		`- }`
	`167`	`+ for (auto& i : m_flattenedRanges)`
	`168`	`+ orderingStrategy(i.GetMutableItems());`
`170`	`169`	`populateRangeMap();`
`171`	`170`	`}`
`172`	`171`
`@@ -206,7 +205,7 @@ using namespace std;`
`206`	`205`	`throw std::out_of_range("GenericRangeMap::GetMutableGenericRangeAt - Address not found in any range!");`
`207`	`206`	`}`
`208`	`207`
`209`		`- std::optional<std::pair<uint64_t, uint64_t>> GetNextValidRange(uint64_t addr, std::function<bool(const GenericRange<T>&)> predicate) const`
	`208`	`+ std::optional<std::pair<uint64_t, uint64_t>> GetNextValidRange(uint64_t addr, bn::base::function_ref<bool(const GenericRange<T>&)> predicate) const`
`210`	`209`	`{`
`211`	`210`	`auto itr = m_rangeMap.upper_bound(addr);`
`212`	`211`	`if (itr != m_rangeMap.begin())`
`@@ -222,7 +221,7 @@ using namespace std;`
`222`	`221`	`return std::nullopt;`
`223`	`222`	`}`
`224`	`223`
`225`		`- std::optional<std::pair<uint64_t, uint64_t>> GetPreviousValidRange(uint64_t addr, std::function<bool(const GenericRange<T>&)> predicate) const`
	`224`	`+ std::optional<std::pair<uint64_t, uint64_t>> GetPreviousValidRange(uint64_t addr, bn::base::function_ref<bool(const GenericRange<T>&)> predicate) const`
`226`	`225`	`{`
`227`	`226`	`auto itr = m_rangeMap.upper_bound(addr);`
`228`	`227`	`if (itr != m_rangeMap.begin())`
Original file line number	Diff line number	Diff line change
`@@ -1342,7 +1342,7 @@ void HighLevelILInstruction::CollectSubExprs(stack<size_t>& toProcess) const`
`1342`	`1342`	`}`
`1343`	`1343`
`1344`	`1344`
`1345`		`-void HighLevelILInstruction::VisitExprs(const std::function<bool(const HighLevelILInstruction& expr)>& func) const`
	`1345`	`+void HighLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const HighLevelILInstruction& expr)> func) const`
`1346`	`1346`	`{`
`1347`	`1347`	`stack<size_t> toProcess;`
`1348`	`1348`	`toProcess.push(exprIndex);`
`@@ -1357,8 +1357,8 @@ void HighLevelILInstruction::VisitExprs(const std::function<bool(const HighLevel`
`1357`	`1357`	`}`
`1358`	`1358`
`1359`	`1359`
`1360`		`-void HighLevelILInstruction::VisitExprs(const std::function<bool(const HighLevelILInstruction& expr)>& preFunc,`
`1361`		`- const std::function<void(const HighLevelILInstruction& expr)>& postFunc) const`
	`1360`	`+void HighLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const HighLevelILInstruction& expr)> preFunc,`
	`1361`	`+ bn::base::function_ref<void(const HighLevelILInstruction& expr)> postFunc) const`
`1362`	`1362`	`{`
`1363`	`1363`	`stack<std::pair<HighLevelILInstruction, stack<size_t>>> toProcess;`
`1364`	`1364`	`HighLevelILInstruction cur = *this;`
`@@ -1404,7 +1404,7 @@ ExprId HighLevelILInstruction::CopyTo(HighLevelILFunction* dest, const ILSourceL`
`1404`	`1404`
`1405`	`1405`
`1406`	`1406`	`ExprId HighLevelILInstruction::CopyTo(`
`1407`		`- HighLevelILFunction* dest, const std::function<ExprId(const HighLevelILInstruction& subExpr)>& subExprHandler, const ILSourceLocation& sourceLocation) const`
	`1407`	`+ HighLevelILFunction* dest, bn::base::function_ref<ExprId(const HighLevelILInstruction& subExpr)> subExprHandler, const ILSourceLocation& sourceLocation) const`
`1408`	`1408`	`{`
`1409`	`1409`	`vector<ExprId> output, params;`
`1410`	`1410`
Original file line number	Diff line number	Diff line change
`@@ -1885,7 +1885,7 @@ void LowLevelILInstructionBase::ClearAttribute(BNILInstructionAttribute attribut`
`1885`	`1885`	`}`
`1886`	`1886`
`1887`	`1887`
`1888`		`-void LowLevelILInstruction::VisitExprs(const std::function<bool(const LowLevelILInstruction& expr)>& func) const`
	`1888`	`+void LowLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const LowLevelILInstruction& expr)> func) const`
`1889`	`1889`	`{`
`1890`	`1890`	`if (!func(*this))`
`1891`	`1891`	`return;`
`@@ -2096,7 +2096,7 @@ ExprId LowLevelILInstruction::CopyTo(LowLevelILFunction* dest, const ILSourceLoc`
`2096`	`2096`
`2097`	`2097`
`2098`	`2098`	`ExprId LowLevelILInstruction::CopyTo(`
`2099`		`- LowLevelILFunction* dest, const std::function<ExprId(const LowLevelILInstruction& subExpr)>& subExprHandler, const ILSourceLocation& sourceLocation) const`
	`2099`	`+ LowLevelILFunction* dest, bn::base::function_ref<ExprId(const LowLevelILInstruction& subExpr)> subExprHandler, const ILSourceLocation& sourceLocation) const`
`2100`	`2100`	`{`
`2101`	`2101`	`vector<ExprId> params;`
`2102`	`2102`	`BNLowLevelILLabel* labelA;`
Original file line number	Diff line number	Diff line change
`@@ -1350,7 +1350,7 @@ void MediumLevelILInstructionBase::ClearAttribute(BNILInstructionAttribute attri`
`1350`	`1350`	`}`
`1351`	`1351`
`1352`	`1352`
`1353`		`-void MediumLevelILInstruction::VisitExprs(const std::function<bool(const MediumLevelILInstruction& expr)>& func) const`
	`1353`	`+void MediumLevelILInstruction::VisitExprs(bn::base::function_ref<bool(const MediumLevelILInstruction& expr)> func) const`
`1354`	`1354`	`{`
`1355`	`1355`	`if (!func(*this))`
`1356`	`1356`	`return;`
`@@ -1569,7 +1569,7 @@ ExprId MediumLevelILInstruction::CopyTo(MediumLevelILFunction* dest, const ILSou`
`1569`	`1569`
`1570`	`1570`
`1571`	`1571`	`ExprId MediumLevelILInstruction::CopyTo(MediumLevelILFunction* dest,`
`1572`		`- const std::function<ExprId(const MediumLevelILInstruction& subExpr)>& subExprHandler,`
	`1572`	`+ bn::base::function_ref<ExprId(const MediumLevelILInstruction& subExpr)> subExprHandler,`
`1573`	`1573`	`const ILSourceLocation& sourceLocation) const`
`1574`	`1574`	`{`
`1575`	`1575`	`vector<ExprId> params;`