Play-/Source/MIPSAnalysis.cpp
Jean-Philip Desjardins bb75476f3f Fix warning.
2016-07-10 22:46:30 -04:00

464 lines
12 KiB
C++

#include <stdio.h>
#include "MIPSAnalysis.h"
#include "MIPS.h"
CMIPSAnalysis::CMIPSAnalysis(CMIPS* ctx)
: m_ctx(ctx)
{
}
CMIPSAnalysis::~CMIPSAnalysis()
{
}
void CMIPSAnalysis::Clear()
{
m_subroutines.clear();
}
void CMIPSAnalysis::Analyse(uint32 start, uint32 end, uint32 entryPoint)
{
AnalyseSubroutines(start, end, entryPoint);
AnalyseStringReferences(start, end);
}
void CMIPSAnalysis::InsertSubroutine(uint32 start, uint32 end, uint32 stackAllocStart, uint32 stackAllocEnd, uint32 stackSize, uint32 returnAddrPos)
{
assert(FindSubroutine(start) == nullptr);
assert(FindSubroutine(end) == nullptr);
SUBROUTINE subroutine;
subroutine.start = start;
subroutine.end = end;
subroutine.stackAllocStart = stackAllocStart;
subroutine.stackAllocEnd = stackAllocEnd;
subroutine.stackSize = stackSize;
subroutine.returnAddrPos = returnAddrPos;
m_subroutines.insert(std::make_pair(start, subroutine));
}
const CMIPSAnalysis::SUBROUTINE* CMIPSAnalysis::FindSubroutine(uint32 address) const
{
auto subroutineIterator = m_subroutines.lower_bound(address);
if(subroutineIterator == std::end(m_subroutines)) return nullptr;
auto& subroutine = subroutineIterator->second;
if(address >= subroutine.start && address <= subroutine.end)
{
return &subroutine;
}
else
{
return nullptr;
}
}
void CMIPSAnalysis::ChangeSubroutineStart(uint32 currStart, uint32 newStart)
{
auto subroutineIterator = m_subroutines.find(currStart);
assert(subroutineIterator != std::end(m_subroutines));
SUBROUTINE subroutine(subroutineIterator->second);
subroutine.start = newStart;
m_subroutines.erase(subroutineIterator);
m_subroutines.insert(SubroutineList::value_type(newStart, subroutine));
}
void CMIPSAnalysis::ChangeSubroutineEnd(uint32 start, uint32 newEnd)
{
assert(start < newEnd);
auto subroutineIterator = m_subroutines.find(start);
assert(subroutineIterator != std::end(m_subroutines));
auto& subroutine(subroutineIterator->second);
subroutine.end = newEnd;
}
void CMIPSAnalysis::AnalyseSubroutines(uint32 start, uint32 end, uint32 entryPoint)
{
start &= ~0x3;
end &= ~0x3;
auto subroutinesBefore = m_subroutines.size();
FindSubroutinesByStackAllocation(start, end);
FindSubroutinesByJumpTargets(start, end, entryPoint);
ExpandSubroutines(start, end);
uint32 subroutinesAdded = static_cast<uint32>(m_subroutines.size() - subroutinesBefore);
printf("CMIPSAnalysis: Found %d subroutines in the range [0x%0.8X, 0x%0.8X].\r\n", subroutinesAdded, start, end);
}
static bool IsStackFreeingInstruction(uint32 opcode)
{
return (opcode & 0xFFFF0000) == 0x27BD0000;
}
void CMIPSAnalysis::FindSubroutinesByStackAllocation(uint32 start, uint32 end)
{
uint32 candidate = start;
while(candidate != end)
{
uint32 returnAddr = 0;
uint32 opcode = m_ctx->m_pMemoryMap->GetInstruction(candidate);
if((opcode & 0xFFFF0000) == 0x27BD0000)
{
//Found the head of a routine (stack allocation)
uint32 stackAmount = 0 - (int16)(opcode & 0xFFFF);
//Look for a JR RA
uint32 tempAddr = candidate;
while(tempAddr != end)
{
opcode = m_ctx->m_pMemoryMap->GetInstruction(tempAddr);
//Check SW/SD RA, 0x0000(SP)
if(
((opcode & 0xFFFF0000) == 0xAFBF0000) || //SW
((opcode & 0xFFFF0000) == 0xFFBF0000)) //SD
{
returnAddr = (opcode & 0xFFFF);
}
//Check for JR RA or J
if((opcode == 0x03E00008) || ((opcode & 0xFC000000) == 0x08000000))
{
//Check if there's a stack unwinding instruction above or below
//Check above
//ADDIU SP, SP, 0x????
//JR RA
opcode = m_ctx->m_pMemoryMap->GetInstruction(tempAddr - 4);
if(IsStackFreeingInstruction(opcode))
{
if(stackAmount == (int16)(opcode & 0xFFFF))
{
//That's good...
InsertSubroutine(candidate, tempAddr + 4, candidate, tempAddr - 4, stackAmount, returnAddr);
candidate = tempAddr + 4;
break;
}
}
//Check below
//JR RA
//ADDIU SP, SP, 0x????
opcode = m_ctx->m_pMemoryMap->GetInstruction(tempAddr + 4);
if(IsStackFreeingInstruction(opcode))
{
if(stackAmount == (int16)(opcode & 0xFFFF))
{
//That's good
InsertSubroutine(candidate, tempAddr + 4, candidate, tempAddr + 4, stackAmount, returnAddr);
candidate = tempAddr + 4;
}
break;
}
//No stack unwinding was found... just forget about this one
//break;
}
tempAddr += 4;
}
}
candidate += 4;
}
}
void CMIPSAnalysis::FindSubroutinesByJumpTargets(uint32 start, uint32 end, uint32 entryPoint)
{
//Second pass : Search for all JAL targets then scan for functions
std::set<uint32> subroutineAddresses;
for(uint32 address = start; address <= end; address += 4)
{
uint32 opcode = m_ctx->m_pMemoryMap->GetInstruction(address);
if(
(opcode & 0xFC000000) == 0x0C000000 ||
(opcode & 0xFC000000) == 0x08000000)
{
uint32 jumpTarget = (opcode & 0x03FFFFFF) * 4;
if(jumpTarget < start) continue;
if(jumpTarget >= end) continue;
subroutineAddresses.insert(jumpTarget);
}
}
if(entryPoint != -1)
{
subroutineAddresses.insert(entryPoint);
}
for(const auto& subroutineAddress : subroutineAddresses)
{
if(subroutineAddress == 0) continue;
//Don't bother if we already found it
if(FindSubroutine(subroutineAddress)) continue;
//Otherwise, try to find a function that already exists
for(uint32 address = subroutineAddress; address <= end; address += 4)
{
uint32 opcode = m_ctx->m_pMemoryMap->GetInstruction(address);
//Check for JR RA or J
if((opcode == 0x03E00008) || ((opcode & 0xFC000000) == 0x08000000))
{
InsertSubroutine(subroutineAddress, address + 4, 0, 0, 0, 0);
break;
}
auto subroutine = FindSubroutine(address);
if(subroutine)
{
//Function already exists, merge.
ChangeSubroutineStart(subroutine->start, subroutineAddress);
break;
}
}
}
}
void CMIPSAnalysis::ExpandSubroutines(uint32 executableStart, uint32 executableEnd)
{
static const uint32 searchLimit = 0x1000;
const auto& findFreeSubroutineEnd =
[this](uint32 begin, uint32 end) -> uint32
{
for(uint32 address = begin; address <= begin + searchLimit; address += 4)
{
if(FindSubroutine(address) != nullptr) return MIPS_INVALID_PC;
uint32 opcode = m_ctx->m_pMemoryMap->GetInstruction(address);
//Check for JR RA or J
if((opcode == 0x03E00008) || ((opcode & 0xFC000000) == 0x08000000))
{
//+4 for delay slot
return address + 4;
}
//Check for BEQ R0, R0, $label
if((opcode & 0xFFFF0000) == 0x10000000)
{
//+4 for delay slot
return address + 4;
}
}
return MIPS_INVALID_PC;
};
for(auto& subroutinePair : m_subroutines)
{
auto& subroutine = subroutinePair.second;
//Don't bother if subroutine is not in our range
if(subroutine.start < executableStart) continue;
if(subroutine.end > executableEnd) continue;
//Search for branch targets that fall in space not allocated for a subroutine
for(uint32 address = subroutine.start; address <= subroutine.end; address += 4)
{
uint32 opcode = m_ctx->m_pMemoryMap->GetInstruction(address);
auto branchType = m_ctx->m_pArch->IsInstructionBranch(m_ctx, address, opcode);
if(branchType != MIPS_BRANCH_NORMAL) continue;
uint32 branchTarget = m_ctx->m_pArch->GetInstructionEffectiveAddress(m_ctx, address, opcode);
//Check if pointing inside our subroutine. If so, don't bother
if(branchTarget >= subroutine.start && branchTarget <= subroutine.end) continue;
//Branch could be out of subroutine range, but that would be weird and we don't want to handle that
if(branchTarget < subroutine.start) continue;
//Check if branch is outside our search limit
if(branchTarget > (subroutine.end + searchLimit)) continue;
//Doesn't make sense if target is outside range
if(branchTarget >= executableEnd) continue;
//If there's already a subroutine there, don't bother
if(FindSubroutine(branchTarget) != nullptr) continue;
uint32 routineEnd = findFreeSubroutineEnd(branchTarget, executableEnd);
if(routineEnd == MIPS_INVALID_PC)
{
continue;
}
//Check invariant
assert(FindSubroutine(routineEnd) == nullptr);
//Check if we need to update stackAllocEnd
uint32 endOpcode = m_ctx->m_pMemoryMap->GetInstruction(routineEnd);
if(IsStackFreeingInstruction(endOpcode))
{
uint16 stackAmount = static_cast<int16>(endOpcode & 0xFFFF);
if(stackAmount == subroutine.stackSize)
{
subroutine.stackAllocEnd = std::max<uint32>(subroutine.stackAllocEnd, routineEnd);
}
}
subroutine.end = std::max<uint32>(subroutine.end, routineEnd);
}
}
}
static bool TryGetStringAtAddress(CMIPS* context, uint32 address, std::string& result)
{
uint8 byteBefore = context->m_pMemoryMap->GetByte(address - 1);
if(byteBefore != 0) return false;
while(1)
{
uint8 byte = context->m_pMemoryMap->GetByte(address);
if(byte == 0) break;
if(byte > 0x7F) return false;
if((byte < 0x20) &&
(byte != '\t') &&
(byte != '\n') &&
(byte != '\r'))
{
return false;
}
result += byte;
address++;
}
return (result.length() != 0);
}
void CMIPSAnalysis::AnalyseStringReferences(uint32 start, uint32 end)
{
for(auto subroutinePair : m_subroutines)
{
const auto& subroutine = subroutinePair.second;
uint32 registerValue[0x20] = { 0 };
bool registerWritten[0x20] = { false };
for(uint32 address = subroutine.start; address <= subroutine.end; address += 4)
{
uint32 op = m_ctx->m_pMemoryMap->GetInstruction(address);
//LUI
if((op & 0xFC000000) == 0x3C000000)
{
uint32 rt = (op >> 16) & 0x1F;
uint32 imm = static_cast<int16>(op);
registerWritten[rt] = true;
registerValue[rt] = imm << 16;
}
//ADDIU
else if((op & 0xFC000000) == 0x24000000)
{
uint32 rs = (op >> 21) & 0x1F;
uint32 rt = (op >> 16) & 0x1F;
uint32 imm = static_cast<int16>(op);
if((rs == rt) && registerWritten[rs])
{
//Check string
uint32 targetAddress = registerValue[rs] + imm;
registerWritten[rs] = false;
if(targetAddress >= start && targetAddress <= end)
{
std::string stringConstant;
if(TryGetStringAtAddress(m_ctx, targetAddress, stringConstant))
{
if(m_ctx->m_Comments.Find(address) == nullptr)
{
m_ctx->m_Comments.InsertTag(address, stringConstant.c_str());
}
}
}
}
}
}
}
}
static bool IsValidProgramAddress(uint32 address)
{
return (address != 0) && ((address & 0x03) == 0);
}
CMIPSAnalysis::CallStackItemArray CMIPSAnalysis::GetCallStack(CMIPS* context, uint32 pc, uint32 sp, uint32 ra)
{
uint32 physicalSp = context->m_pAddrTranslator(context, sp);
CallStackItemArray result;
{
auto routine = context->m_analysis->FindSubroutine(pc);
if(!routine)
{
if(IsValidProgramAddress(pc)) result.push_back(pc);
if(pc != ra)
{
if(IsValidProgramAddress(ra)) result.push_back(ra);
}
return result;
}
//We need to get to a state where we're ready to dig into the previous function's
//stack
//Check if we need to check into the stack to get the RA
if(context->m_analysis->FindSubroutine(ra) == routine)
{
ra = context->m_pMemoryMap->GetWord(physicalSp + routine->returnAddrPos);
physicalSp += routine->stackSize;
}
else
{
//We haven't called a sub routine yet... The RA is good, but we
//don't know wether stack memory has been allocated or not
//ADDIU SP, SP, 0x????
//If the PC is after this instruction, then, we've allocated stack
if(pc > routine->stackAllocStart)
{
if(pc <= routine->stackAllocEnd)
{
physicalSp += routine->stackSize;
}
}
}
}
while(1)
{
//Add the current function
result.push_back(pc);
//Go to previous routine
pc = ra;
//Check if we can go on...
auto routine = context->m_analysis->FindSubroutine(pc);
if(!routine)
{
if(IsValidProgramAddress(ra)) result.push_back(ra);
break;
}
//Get the next RA
ra = context->m_pMemoryMap->GetWord(physicalSp + routine->returnAddrPos);
physicalSp += routine->stackSize;
if((pc == ra) && (routine->stackSize == 0))
{
if(IsValidProgramAddress(ra)) result.push_back(ra);
break;
}
}
return result;
}