11 #define RT(op) ((op >> 16) & 0x1F)
12 #define RS(op) ((op >> 21) & 0x1F)
13 #define RD(op) ((op >> 11) & 0x1F)
14 #define SA(op) ((op >> 6) & 0x1F)
15 #define IMM(op) ((signed short) (op & 0xFFFF))
16 #define IMMU(op) ((unsigned short) (op & 0xFFFF))
18 /* Subroutine decompilation status */
19 #define SUBROUTINE_EXTRACTED 1
20 #define SUBROUTINE_CFG_EXTRACTED 2
21 #define SUBROUTINE_OPERATIONS_EXTRACTED 4
22 #define SUBROUTINE_LIVE_REGISTERS 8
23 #define SUBROUTINE_CFG_TRAVERSE 16
24 #define SUBROUTINE_CFG_TRAVERSE_REV 32
25 #define SUBROUTINE_FIXUP_CALL_ARGS 64
26 #define SUBROUTINE_SSA 128
27 #define SUBROUTINE_CONSTANTS_EXTRACTED 256
28 #define SUBROUTINE_VARIABLES_EXTRACTED 512
29 #define SUBROUTINE_STRUCTURES_EXTRACTED 1024
31 /* Operation status */
32 #define OPERATION_DEFERRED 1
36 #define REGISTER_GPR_ZERO 0
37 #define REGISTER_GPR_AT 1
38 #define REGISTER_GPR_V0 2
39 #define REGISTER_GPR_V1 3
40 #define REGISTER_GPR_A0 4
41 #define REGISTER_GPR_A1 5
42 #define REGISTER_GPR_A2 6
43 #define REGISTER_GPR_A3 7
44 #define REGISTER_GPR_T0 8
45 #define REGISTER_GPR_T1 9
46 #define REGISTER_GPR_T2 10
47 #define REGISTER_GPR_T3 11
48 #define REGISTER_GPR_T4 12
49 #define REGISTER_GPR_T5 13
50 #define REGISTER_GPR_T6 14
51 #define REGISTER_GPR_T7 15
52 #define REGISTER_GPR_S0 16
53 #define REGISTER_GPR_S1 17
54 #define REGISTER_GPR_S2 18
55 #define REGISTER_GPR_S3 19
56 #define REGISTER_GPR_S4 20
57 #define REGISTER_GPR_S5 21
58 #define REGISTER_GPR_S6 22
59 #define REGISTER_GPR_S7 23
60 #define REGISTER_GPR_T8 24
61 #define REGISTER_GPR_T9 25
62 #define REGISTER_GPR_K0 26
63 #define REGISTER_GPR_K1 27
64 #define REGISTER_GPR_GP 28
65 #define REGISTER_GPR_SP 29
66 #define REGISTER_GPR_FP 30
67 #define REGISTER_GPR_RA 31
68 #define REGISTER_LO 32
69 #define REGISTER_HI 33
70 #define NUM_REGISTERS 34
71 #define NUM_REGMASK ((NUM_REGISTERS + 31) >> 4)
74 #define MAX_SUB_ARGS 8
77 #define IS_BIT_SET(flags, bit) ((1 << ((bit) & 31)) & ((flags)[(bit) >> 5]))
78 #define BIT_SET(flags, bit) ((flags)[(bit) >> 5]) |= 1 << ((bit) & 31)
80 extern const uint32 regmask_call_gen
[NUM_REGMASK
];
81 extern const uint32 regmask_call_kill
[NUM_REGMASK
];
82 extern const uint32 regmask_subend_gen
[NUM_REGMASK
];
83 extern const uint32 regmask_localvars
[NUM_REGMASK
];
86 /* Possible reachable status */
87 enum locationreachable
{
88 LOCATION_UNREACHABLE
= 0, /* Location is not reachable by any means */
89 LOCATION_REACHABLE
, /* Location is reachable by some path */
90 LOCATION_DELAY_SLOT
/* Location is a delay slot of a reachable branch/jump */
93 /* If an error was detected one a location */
95 ERROR_NONE
= 0, /* No error */
96 ERROR_INVALID_OPCODE
, /* Opcode is not recognized */
97 ERROR_DELAY_SLOT
, /* Branch/jump inside a delay slot */
98 ERROR_TARGET_OUTSIDE_FILE
, /* Branch/jump target outside the code */
99 ERROR_ILLEGAL_BRANCH
/* Branch with a condition that can never occur, such as `bne $0, $0, target' */
102 /* Represents a location in the code */
104 uint32 opc
; /* The opcode (little-endian) */
105 uint32 address
; /* The virtual address of the location */
107 const struct allegrex_instruction
*insn
; /* The decoded instruction or null (illegal opcode) */
108 struct location
*target
; /* A possible target of a branch/jump */
110 list references
; /* Number of references to this target inside the same subroutine */
111 int branchalways
; /* True if this location is a branch that always occurs */
112 enum locationreachable reachable
; /* Reachable status */
113 enum locationerror error
; /* Error status */
115 struct subroutine
*sub
; /* Owner subroutine */
116 struct basicblock
*block
; /* Basic block mark (used when extracting basic blocks) */
117 struct codeswitch
*cswitch
; /* Code switch mark */
120 /* Represents a switch in the code */
122 struct prx_reloc
*jumpreloc
;
123 struct prx_reloc
*switchreloc
;
124 struct location
*location
; /* The location that loads the base address of the switch */
125 struct location
*jumplocation
; /* The location of the jump instruction */
126 list references
; /* A list of possible target locations (without repeating) */
127 int count
; /* How many possible targets this switch have */
128 int checked
; /* Is this switch valid? */
133 struct code
*code
; /* The owner code of this subroutine */
134 struct prx_function
*export
; /* Is this a function export? */
135 struct prx_function
*import
; /* Is this a function import? */
137 struct location
*begin
; /* Where the subroutine begins */
138 struct location
*end
; /* Where the subroutine ends */
140 struct basicblock
*startblock
; /* Points to the START basic block of this subroutine */
141 struct basicblock
*firstblock
; /* Points to the first SIMPLE basic block of this subroutine */
142 struct basicblock
*endblock
; /* Points to the END basic block of this subroutine */
143 list blocks
; /* A list of the basic blocks of this subroutine */
144 list dfsblocks
, revdfsblocks
; /* Blocks ordered in DFS and Reverse-DFS order */
146 list whereused
; /* A list of basic blocks calling this subroutine */
147 list callblocks
; /* Inner blocks of type CALL */
151 int numregargs
, numregout
;
153 int haserror
, status
; /* Subroutine decompilation status */
157 /* Represents a pair of integers */
163 /* Abstract node in DFS and DOM trees (or reverse DFS and DOM trees) */
164 struct basicblocknode
{
165 int dfsnum
; /* The Depth-First search number */
166 struct intpair domdfsnum
; /* To determine ancestry information in the dominator tree */
167 struct basicblocknode
*dominator
; /* The dominator node */
168 struct basicblocknode
*parent
; /* The parent node (in the depth-first search) */
169 element blockel
; /* An element inside the list (dfsblocks or revdfsblocks) */
170 list children
; /* Children in the DFS tree */
171 list domchildren
; /* Children in the dominator tree */
172 list frontier
; /* The dominator frontier */
175 /* The type of the basic block */
176 enum basicblocktype
{
177 BLOCK_START
= 0, /* The first basic block in a subroutine */
178 BLOCK_SIMPLE
, /* A simple block */
179 BLOCK_CALL
, /* A block that represents a call */
180 BLOCK_END
/* The last basic block */
183 /* The basic block */
185 enum basicblocktype type
; /* The type of the basic block */
186 element blockel
; /* An element inside the list sub->blocks */
189 struct location
*begin
; /* The start of the simple block */
190 struct location
*end
; /* The end of the simple block */
191 struct location
*jumploc
; /* The jump/branch location inside the block */
194 struct subroutine
*calltarget
; /* The target of the call */
198 uint32 reg_gen
[NUM_REGMASK
], reg_kill
[NUM_REGMASK
];
199 uint32 reg_live_in
[NUM_REGMASK
], reg_live_out
[NUM_REGMASK
];
201 struct subroutine
*sub
; /* The owner subroutine */
203 struct basicblocknode node
; /* Node info for DFS and DOM trees */
204 struct basicblocknode revnode
; /* Node info for the reverse DFS and DOM trees */
206 list inrefs
, outrefs
; /* A list of in- and out-edges of this block */
208 struct loopstructure
*loopst
;
209 struct ifstructure
*ifst
;
211 int haslabel
, identsize
;
227 struct basicblock
*from
, *to
;
228 element fromel
, toel
;
242 struct ssavar
*variable
;
258 enum ssavartype type
;
263 struct operation
*def
;
279 enum operationtype type
;
280 struct basicblock
*block
;
284 enum allegrex_insn insn
;
285 struct location
*loc
;
288 struct location
*begin
, *end
;
308 struct loopstructure
{
310 struct basicblock
*start
;
311 struct basicblock
*end
;
317 struct basicblock
*end
;
323 /* Represents the entire PRX code */
325 struct prx
*file
; /* The PRX file */
327 uint32 baddr
, numopc
; /* The code segment base address and number of opcodes */
328 struct location
*base
; /* The code segment start */
329 struct location
*end
; /* The code segment end */
331 list subroutines
; /* The list of subroutines */
334 fixedpool switchpool
;
336 fixedpool blockspool
;
338 fixedpool ssavarspool
;
346 struct code
* code_analyse (struct prx
*p
);
347 void code_free (struct code
*c
);
349 int decode_instructions (struct code
*c
);
350 uint32
location_gpr_used (struct location
*loc
);
351 uint32
location_gpr_defined (struct location
*loc
);
352 int location_branch_may_swap (struct location
*branch
);
354 void extract_switches (struct code
*c
);
355 void extract_subroutines (struct code
*c
);
357 void extract_cfg (struct subroutine
*sub
);
358 void cfg_traverse (struct subroutine
*sub
, int reverse
);
359 int dom_isancestor (struct basicblocknode
*ancestor
, struct basicblocknode
*node
);
360 struct basicblocknode
*dom_common (struct basicblocknode
*n1
, struct basicblocknode
*n2
);
363 struct operation
*operation_alloc (struct basicblock
*block
);
364 struct value
*value_append (struct subroutine
*sub
, list l
, enum valuetype type
, uint32 value
);
365 void extract_operations (struct subroutine
*sub
);
366 void fixup_call_arguments (struct subroutine
*sub
);
367 void remove_call_arguments (struct subroutine
*sub
);
369 void live_registers (struct code
*c
);
370 void live_registers_imports (struct code
*c
);
372 void build_ssa (struct subroutine
*sub
);
373 void unbuild_ssa (struct subroutine
*sub
);
375 void abi_check (struct subroutine
*sub
);
377 void propagate_constants (struct subroutine
*sub
);
378 void extract_variables (struct subroutine
*sub
);
381 void reset_marks (struct subroutine
*sub
);
382 void extract_structures (struct subroutine
*sub
);
384 #endif /* __CODE_H */