Skip to content

Commit de30d49

Browse files
zznopzznop
committed
Share context between BB recovery, lifing, and disassembly
Adds a GetInstructionTextWithContext callback to the architecture class that can be used to pass data from AnalyzeBasicBlocks. This same context is also supplied to LiftFunction and allows for supplying shared function and/or binary view level information across basic block analysis, function lifting, and disassembly text rendering
1 parent 3c8ce87 commit de30d49

5 files changed

Lines changed: 586 additions & 301 deletions

File tree

‎architecture.cpp‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -518,6 +518,7 @@ FunctionLifterContext::FunctionLifterContext(LowLevelILFunction* func, BNFunctio
518518
m_inlinedCalls.insert(context->inlinedCalls[i]);
519519
}
520520

521+
m_functionArchContext = context->functionArchContext;
521522
m_containsInlinedFunctions = context->containsInlinedFunctions;
522523
}
523524

@@ -582,6 +583,12 @@ std::set<uint64_t>& FunctionLifterContext::GetInlinedCalls()
582583
}
583584

584585

586+
void *FunctionLifterContext::GetFunctionArchContext()
587+
{
588+
return m_functionArchContext;
589+
}
590+
591+
585592
void FunctionLifterContext::SetContainsInlinedFunctions(bool value)
586593
{
587594
*m_containsInlinedFunctions = value;
@@ -730,6 +737,26 @@ bool Architecture::GetInstructionTextCallback(
730737
}
731738

732739

740+
bool Architecture::GetInstructionTextWithContextCallback(void* ctxt, const uint8_t* data, uint64_t addr, void* context,
741+
size_t* len, BNInstructionTextToken** result, size_t* count)
742+
{
743+
CallbackRef<Architecture> arch(ctxt);
744+
745+
vector<InstructionTextToken> tokens;
746+
bool ok = arch->GetInstructionTextWithContext(data, addr, context, *len, tokens);
747+
if (!ok)
748+
{
749+
*result = nullptr;
750+
*count = 0;
751+
return false;
752+
}
753+
754+
*count = tokens.size();
755+
*result = InstructionTextToken::CreateInstructionTextTokenList(tokens);
756+
return true;
757+
}
758+
759+
733760
void Architecture::FreeInstructionTextCallback(BNInstructionTextToken* tokens, size_t count)
734761
{
735762
for (size_t i = 0; i < count; i++)
@@ -772,6 +799,13 @@ bool Architecture::LiftFunctionCallback(void* ctxt, BNLowLevelILFunction* functi
772799
}
773800

774801

802+
void Architecture::FreeFunctionArchContextCallback(void* ctxt, void* context)
803+
{
804+
CallbackRef<Architecture> arch(ctxt);
805+
arch->FreeFunctionArchContext(context);
806+
}
807+
808+
775809
char* Architecture::GetRegisterNameCallback(void* ctxt, uint32_t reg)
776810
{
777811
CallbackRef<Architecture> arch(ctxt);
@@ -1260,10 +1294,12 @@ void Architecture::Register(Architecture* arch)
12601294
callbacks.getAssociatedArchitectureByAddress = GetAssociatedArchitectureByAddressCallback;
12611295
callbacks.getInstructionInfo = GetInstructionInfoCallback;
12621296
callbacks.getInstructionText = GetInstructionTextCallback;
1297+
callbacks.getInstructionTextWithContext = GetInstructionTextWithContextCallback;
12631298
callbacks.freeInstructionText = FreeInstructionTextCallback;
12641299
callbacks.getInstructionLowLevelIL = GetInstructionLowLevelILCallback;
12651300
callbacks.analyzeBasicBlocks = AnalyzeBasicBlocksCallback;
12661301
callbacks.liftFunction = LiftFunctionCallback;
1302+
callbacks.freeFunctionArchContext = FreeFunctionArchContextCallback;
12671303
callbacks.getRegisterName = GetRegisterNameCallback;
12681304
callbacks.getFlagName = GetFlagNameCallback;
12691305
callbacks.getFlagWriteTypeName = GetFlagWriteTypeNameCallback;
@@ -1404,6 +1440,16 @@ bool Architecture::LiftFunction(LowLevelILFunction* function, FunctionLifterCont
14041440
}
14051441

14061442

1443+
bool Architecture::GetInstructionTextWithContext(
1444+
const uint8_t* data, uint64_t addr, void* context, size_t& len, std::vector<InstructionTextToken>& result)
1445+
{
1446+
return GetInstructionText(data, addr, len, result);
1447+
}
1448+
1449+
1450+
void Architecture::FreeFunctionArchContext(void* context) {}
1451+
1452+
14071453
string Architecture::GetRegisterName(uint32_t reg)
14081454
{
14091455
return fmt::format("r{}", reg);
@@ -1959,6 +2005,19 @@ bool CoreArchitecture::GetInstructionText(
19592005
}
19602006

19612007

2008+
bool CoreArchitecture::GetInstructionTextWithContext(
2009+
const uint8_t* data, uint64_t addr, void* context, size_t& len, std::vector<InstructionTextToken>& result)
2010+
{
2011+
BNInstructionTextToken* tokens = nullptr;
2012+
size_t count = 0;
2013+
if (!BNGetInstructionTextWithContext(m_object, data, addr, context, &len, &tokens, &count))
2014+
return false;
2015+
2016+
result = InstructionTextToken::ConvertAndFreeInstructionTextTokenList(tokens, count);
2017+
return true;
2018+
}
2019+
2020+
19622021
bool CoreArchitecture::GetInstructionLowLevelIL(const uint8_t* data, uint64_t addr, size_t& len, LowLevelILFunction& il)
19632022
{
19642023
return BNGetInstructionLowLevelIL(m_object, data, addr, &len, il.GetObject());
@@ -1977,6 +2036,12 @@ bool CoreArchitecture::LiftFunction(LowLevelILFunction* function, FunctionLifter
19772036
}
19782037

19792038

2039+
void CoreArchitecture::FreeFunctionArchContext(void* context)
2040+
{
2041+
BNArchitectureFreeFunctionArchContext(m_object, context);
2042+
}
2043+
2044+
19802045
string CoreArchitecture::GetRegisterName(uint32_t reg)
19812046
{
19822047
char* name = BNGetArchitectureRegisterName(m_object, reg);
@@ -2487,6 +2552,13 @@ bool ArchitectureExtension::GetInstructionText(
24872552
}
24882553

24892554

2555+
bool ArchitectureExtension::GetInstructionTextWithContext(
2556+
const uint8_t* data, uint64_t addr, void* context, size_t& len, vector<InstructionTextToken>& result)
2557+
{
2558+
return m_base->GetInstructionTextWithContext(data, addr, context, len, result);
2559+
}
2560+
2561+
24902562
bool ArchitectureExtension::GetInstructionLowLevelIL(
24912563
const uint8_t* data, uint64_t addr, size_t& len, LowLevelILFunction& il)
24922564
{

‎binaryninjaapi.h‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9383,6 +9383,9 @@ namespace BinaryNinja {
93839383
std::set<ArchAndAddr>& GetHaltedDisassemblyAddresses();
93849384
std::map<ArchAndAddr, ArchAndAddr>& GetInlinedUnresolvedIndirectBranches();
93859385

9386+
void* GetFunctionArchContext() { return m_context->functionArchContext; }
9387+
void SetFunctionArchContext(void* context) { m_context->functionArchContext = context; }
9388+
93869389
void AddTempOutgoingReference(Function* targetFunc);
93879390

93889391
Ref<BasicBlock> CreateBasicBlock(Architecture* arch, uint64_t start);
@@ -9405,6 +9408,7 @@ namespace BinaryNinja {
94059408
std::map<ArchAndAddr, std::set<ArchAndAddr>> m_autoIndirectBranches;
94069409
std::set<uint64_t> m_inlinedCalls;
94079410
bool* m_containsInlinedFunctions;
9411+
void* m_functionArchContext;
94089412

94099413
public:
94109414
BNFunctionLifterContext* m_context;
@@ -9420,6 +9424,7 @@ namespace BinaryNinja {
94209424
std::map<ArchAndAddr, std::set<ArchAndAddr>>& GetAutoIndirectBranches();
94219425
std::set<uint64_t>& GetInlinedCalls();
94229426
void SetContainsInlinedFunctions(bool value);
9427+
void* GetFunctionArchContext();
94239428

94249429
void CheckForInlinedCall(BasicBlock* block, size_t instrCountBefore, size_t instrCountAfter, uint64_t prevAddr,
94259430
uint64_t addr, const uint8_t* opcode, size_t len,
@@ -9453,11 +9458,14 @@ namespace BinaryNinja {
94539458
void* ctxt, const uint8_t* data, uint64_t addr, size_t maxLen, BNInstructionInfo* result);
94549459
static bool GetInstructionTextCallback(void* ctxt, const uint8_t* data, uint64_t addr, size_t* len,
94559460
BNInstructionTextToken** result, size_t* count);
9461+
static bool GetInstructionTextWithContextCallback(void* ctxt, const uint8_t* data, uint64_t addr, void* context,
9462+
size_t* len, BNInstructionTextToken** result, size_t* count);
94569463
static void FreeInstructionTextCallback(BNInstructionTextToken* tokens, size_t count);
94579464
static bool GetInstructionLowLevelILCallback(
94589465
void* ctxt, const uint8_t* data, uint64_t addr, size_t* len, BNLowLevelILFunction* il);
94599466
static void AnalyzeBasicBlocksCallback(void *ctxt, BNFunction* function, BNBasicBlockAnalysisContext* context);
94609467
static bool LiftFunctionCallback(void* ctxt, BNLowLevelILFunction* function, BNFunctionLifterContext* context);
9468+
static void FreeFunctionArchContextCallback(void* ctxt, void* context);
94619469
static char* GetRegisterNameCallback(void* ctxt, uint32_t reg);
94629470
static char* GetFlagNameCallback(void* ctxt, uint32_t flag);
94639471
static char* GetFlagWriteTypeNameCallback(void* ctxt, uint32_t flags);
@@ -9635,6 +9643,20 @@ namespace BinaryNinja {
96359643
virtual bool GetInstructionText(
96369644
const uint8_t* data, uint64_t addr, size_t& len, std::vector<InstructionTextToken>& result) = 0;
96379645

9646+
/*! Retrieves a list of InstructionTextTokens while supplying contextual information
9647+
9648+
\note Architecture subclasses can implement this method to provide contextual information from AnalyzeBasicBlocks
9649+
9650+
\param[in] data pointer to the instruction data to retrieve text for
9651+
\param[in] addr address of the instruction data to retrieve text for
9652+
\param[in] context context to use when retrieving instruction text
9653+
\param[out] len will be written to with the length of the instruction data which was translated
9654+
\param[out] result
9655+
\return Whether instruction info was successfully retrieved.
9656+
*/
9657+
virtual bool GetInstructionTextWithContext(const uint8_t* data, uint64_t addr, void* context, size_t& len,
9658+
std::vector<InstructionTextToken>& result);
9659+
96389660
/*! Translates an instruction at addr and appends it onto the LowLevelILFunction& il.
96399661

96409662
\note Architecture subclasses should implement this method.
@@ -9661,6 +9683,12 @@ namespace BinaryNinja {
96619683
*/
96629684
virtual bool LiftFunction(LowLevelILFunction* function, FunctionLifterContext& context);
96639685

9686+
/*! Free the function architecture context
9687+
9688+
\param context Function architecture context
9689+
*/
9690+
virtual void FreeFunctionArchContext(void* context);
9691+
96649692
/*! Gets a register name from a register index.
96659693

96669694
\param reg Register index
@@ -10052,10 +10080,13 @@ namespace BinaryNinja {
1005210080
const uint8_t* data, uint64_t addr, size_t maxLen, InstructionInfo& result) override;
1005310081
virtual bool GetInstructionText(
1005410082
const uint8_t* data, uint64_t addr, size_t& len, std::vector<InstructionTextToken>& result) override;
10083+
virtual bool GetInstructionTextWithContext(const uint8_t* data, uint64_t addr, void* context, size_t& len,
10084+
std::vector<InstructionTextToken>& result) override;
1005510085
virtual bool GetInstructionLowLevelIL(
1005610086
const uint8_t* data, uint64_t addr, size_t& len, LowLevelILFunction& il) override;
1005710087
virtual void AnalyzeBasicBlocks(Function* function, BasicBlockAnalysisContext& context) override;
1005810088
virtual bool LiftFunction(LowLevelILFunction* function, FunctionLifterContext& context) override;
10089+
virtual void FreeFunctionArchContext(void* context) override;
1005910090
virtual std::string GetRegisterName(uint32_t reg) override;
1006010091
virtual std::string GetFlagName(uint32_t flag) override;
1006110092
virtual std::string GetFlagWriteTypeName(uint32_t flags) override;
@@ -10139,6 +10170,8 @@ namespace BinaryNinja {
1013910170
const uint8_t* data, uint64_t addr, size_t maxLen, InstructionInfo& result) override;
1014010171
virtual bool GetInstructionText(
1014110172
const uint8_t* data, uint64_t addr, size_t& len, std::vector<InstructionTextToken>& result) override;
10173+
virtual bool GetInstructionTextWithContext(const uint8_t* data, uint64_t addr, void* context, size_t& len,
10174+
std::vector<InstructionTextToken>& result) override;
1014210175
virtual bool GetInstructionLowLevelIL(
1014310176
const uint8_t* data, uint64_t addr, size_t& len, LowLevelILFunction& il) override;
1014410177
virtual std::string GetRegisterName(uint32_t reg) override;

‎binaryninjacore.h‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2049,6 +2049,8 @@ extern "C"
20492049

20502050
size_t inlinedUnresolvedIndirectBranchCount;
20512051
BNArchitectureAndAddress* inlinedUnresolvedIndirectBranches;
2052+
2053+
void* functionArchContext;
20522054
} BNBasicBlockAnalysisContext;
20532055

20542056
typedef struct BNFunctionLifterContext {
@@ -2075,6 +2077,8 @@ extern "C"
20752077
size_t inlinedCallsCount;
20762078
uint64_t* inlinedCalls;
20772079

2080+
void* functionArchContext;
2081+
20782082
// OUT
20792083
bool* containsInlinedFunctions;
20802084
} BNFunctionLifterContext;
@@ -2094,11 +2098,14 @@ extern "C"
20942098
void* ctxt, const uint8_t* data, uint64_t addr, size_t maxLen, BNInstructionInfo* result);
20952099
bool (*getInstructionText)(void* ctxt, const uint8_t* data, uint64_t addr, size_t* len,
20962100
BNInstructionTextToken** result, size_t* count);
2101+
bool (*getInstructionTextWithContext)(void* ctxt, const uint8_t* data, uint64_t addr, void* context,
2102+
size_t* len, BNInstructionTextToken** result, size_t* count);
20972103
void (*freeInstructionText)(BNInstructionTextToken* tokens, size_t count);
20982104
bool (*getInstructionLowLevelIL)(
20992105
void* ctxt, const uint8_t* data, uint64_t addr, size_t* len, BNLowLevelILFunction* il);
21002106
void (*analyzeBasicBlocks)(void* ctxt, BNFunction* function, BNBasicBlockAnalysisContext* context);
21012107
bool (*liftFunction)(void *ctext, BNLowLevelILFunction* function, BNFunctionLifterContext* context);
2108+
void (*freeFunctionArchContext)(void *ctxt, void* context);
21022109
char* (*getRegisterName)(void* ctxt, uint32_t reg);
21032110
char* (*getFlagName)(void* ctxt, uint32_t flag);
21042111
char* (*getFlagWriteTypeName)(void* ctxt, uint32_t flags);
@@ -4931,6 +4938,8 @@ extern "C"
49314938
BNArchitecture* arch, const uint8_t* data, uint64_t addr, size_t maxLen, BNInstructionInfo* result);
49324939
BINARYNINJACOREAPI bool BNGetInstructionText(BNArchitecture* arch, const uint8_t* data, uint64_t addr, size_t* len,
49334940
BNInstructionTextToken** result, size_t* count);
4941+
BINARYNINJACOREAPI bool BNGetInstructionTextWithContext(BNArchitecture* arch, const uint8_t* data, uint64_t addr, void* context,
4942+
size_t* len, BNInstructionTextToken** result, size_t* count);
49344943
BINARYNINJACOREAPI bool BNGetInstructionLowLevelIL(
49354944
BNArchitecture* arch, const uint8_t* data, uint64_t addr, size_t* len, BNLowLevelILFunction* il);
49364945
BINARYNINJACOREAPI void BNFreeInstructionText(BNInstructionTextToken* tokens, size_t count);
@@ -4942,6 +4951,7 @@ extern "C"
49424951
BINARYNINJACOREAPI bool BNArchitectureDefaultLiftFunction(BNLowLevelILFunction* function, BNFunctionLifterContext* context);
49434952
BINARYNINJACOREAPI bool BNArchitectureLiftFunction(BNArchitecture* arch, BNLowLevelILFunction* function,
49444953
BNFunctionLifterContext* context);
4954+
BINARYNINJACOREAPI void BNArchitectureFreeFunctionArchContext(BNArchitecture* arch, void* context);
49454955
BINARYNINJACOREAPI void BNFreeInstructionTextLines(BNInstructionTextLine* lines, size_t count);
49464956
BINARYNINJACOREAPI char* BNGetArchitectureRegisterName(BNArchitecture* arch, uint32_t reg);
49474957
BINARYNINJACOREAPI char* BNGetArchitectureFlagName(BNArchitecture* arch, uint32_t flag);

0 commit comments

Comments
 (0)