When working on Ghidra modules I often need to unit-test my algorithms before throwing them at real binaries. And so I need a workable Program instance, as well all kinds of AddressSpaces. Luckily Ghidra provides a helper class ToyProgramBuilder.
Below is the base class I use for my unit tests
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41 | import java.io.File;
import java.io.IOException;
import ghidra.GhidraTestApplicationLayout;
import ghidra.framework.Application;
import ghidra.framework.ApplicationConfiguration;
import ghidra.program.model.address.AddressFactory;
import ghidra.program.model.address.AddressSpace;
import ghidra.program.model.listing.Program;
import ghidra.test.ToyProgramBuilder;
public class TestBase {
Program program;
AddressSpace ramSpace;
AddressSpace regSpace;
AddressSpace uniqueSpace;
AddressSpace constSpace;
static {
ApplicationConfiguration appConfig = new ApplicationConfiguration();
GhidraTestApplicationLayout layout;
try {
layout = new GhidraTestApplicationLayout(new File("/tmp/test"));
Application.initializeApplication(layout, appConfig);
} catch (IOException e) {
e.printStackTrace();
}
}
TestBase() throws Exception {
ToyProgramBuilder builder = new ToyProgramBuilder("TestProgram", false);
program = builder.getProgram();
AddressFactory addressFactory = program.getAddressFactory();
ramSpace = addressFactory.getDefaultAddressSpace();
regSpace = addressFactory.getRegisterSpace();
uniqueSpace = addressFactory.getUniqueSpace();
constSpace = addressFactory.getConstantSpace();
}
}
|
I also have a bunch of helper methods to quickly instantiate Varnodes, e.g.:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 | Varnode reg(long offset, int size) {
return new Varnode(regSpace.getAddress(offset), size);
}
Varnode r8(long offset) {
return reg(offset, 8);
}
// ...
Varnode ram(long offset, int size) {
return new Varnode(ramSpace.getAddress(offset), size);
}
Varnode m8(long offset) {
return ram(offset, 8);
}
|
And the same goes for PcodeOps, e.g. here's one that creates a binary operation:
| private PcodeOp buildOp(
Address address, int opIdx, int opcode, Varnode in1, Varnode in2, Varnode out) {
ArrayList<Varnode> ins = new ArrayList<>(Arrays.asList(in1, in2));
return new PcodeOp(
address,
opIdx,
opcode,
ins.toArray(new Varnode[ins.size()]),
out);
}
|
Address is of course obtained by something like ramSpace.getAddress(0x400000L).