Merge branch 'master' of git.dyninst.org:/pub/dyninst into working
[dyninst.git] / dataflowAPI / src / RoseInsnFactory.C
1 #include "RoseInsnFactory.h"
2 //#include "../rose/x86InstructionSemantics.h"
3 //#include "../rose/powerpcInstructionSemantics.h"
4
5 #include "Instruction.h"
6 #include "Operand.h"
7 #include "Expression.h"
8 #include "Dereference.h"
9 #include "Immediate.h"
10 #include <vector>
11
12 #include "../rose/SgAsmInstruction.h"
13 #include "../rose/SgAsmPowerpcInstruction.h"
14 #include "../rose/SgAsmx86Instruction.h"
15 #include "../rose/SgAsmExpression.h"
16
17 #include "ExpressionConversionVisitor.h"
18
19 using namespace Dyninst;
20 using namespace InstructionAPI;
21 using namespace DataflowAPI;
22
23 SgAsmInstruction *RoseInsnFactory::convert(const InstructionAPI::Instruction::Ptr &insn, uint64_t addr) {
24   SgAsmInstruction *rinsn = createInsn();
25   
26   rinsn->set_address(addr);
27   rinsn->set_mnemonic(insn->format());
28   setOpcode(rinsn, insn->getOperation().getID(), insn->getOperation().getPrefixID(), insn->getOperation().format());
29
30   // semantics don't support 64-bit code
31   setSizes(rinsn);
32
33   //rinsn->set_operandSize(x86_insnsize_32);
34   //rinsn->set_addressSize(x86_insnsize_32);
35   
36   std::vector<unsigned char> rawBytes;
37   for (unsigned i = 0; i < insn->size(); ++i) rawBytes.push_back(insn->rawByte(i));
38   rinsn->set_raw_bytes(rawBytes);
39   
40   // operand list
41   SgAsmOperandList *roperands = new SgAsmOperandList;
42   
43   //cerr << "Converting " << insn->format() << " @" << hex << addr << dec << endl;
44   
45   //cerr << "checking instruction: " << insn->format() << " for special handling" << endl;
46   if (handleSpecialCases(insn->getOperation().getID(), rinsn, roperands)) {
47     rinsn->set_operandList(roperands);
48     return rinsn;
49   }
50
51   //cerr << "no special handling by opcode, checking if we should mangle operands..." << endl;
52   std::vector<InstructionAPI::Operand> operands;
53   insn->getOperands(operands);
54   //cerr << "\t " << operands.size() << " operands" << endl;
55   massageOperands(insn, operands);
56   int i = 0;
57   //cerr << "converting insn " << insn->format() << endl;
58   for (std::vector<InstructionAPI::Operand>::iterator opi = operands.begin();
59        opi != operands.end();
60        ++opi, ++i) {
61     InstructionAPI::Operand &currOperand = *opi;
62     //cerr << "Converting operand " << currOperand.format() << endl;
63     roperands->append_operand(convertOperand(currOperand.getValue(), addr));
64   }  
65   rinsn->set_operandList(roperands);
66   return rinsn;
67 }
68
69 SgAsmExpression *RoseInsnFactory::convertOperand(const Expression::Ptr expression, uint64_t addr) {
70   if(!expression) return NULL;
71   ExpressionConversionVisitor visitor(arch(), addr);
72   expression->apply(&visitor);
73   return visitor.getRoseExpression();
74 }
75
76 ///////////// X86 //////////////////
77
78 SgAsmInstruction *RoseInsnX86Factory::createInsn() {
79   return new SgAsmx86Instruction;
80 }
81
82 // Note: convertKind is defined in convertOpcodes.C
83
84 void RoseInsnX86Factory::setOpcode(SgAsmInstruction *insn, entryID opcode, prefixEntryID prefix, std::string) {
85   SgAsmx86Instruction *tmp = static_cast<SgAsmx86Instruction *>(insn);
86   
87   tmp->set_kind(convertKind(opcode, prefix));
88 }
89
90 void RoseInsnX86Factory::setSizes(SgAsmInstruction *insn) {
91   // FIXME when we go 64-bit...
92   SgAsmx86Instruction *tmp = static_cast<SgAsmx86Instruction *>(insn);
93   tmp->set_operandSize(x86_insnsize_32);
94   tmp->set_addressSize(x86_insnsize_32);
95 }
96
97 bool RoseInsnX86Factory::handleSpecialCases(entryID, SgAsmInstruction *, SgAsmOperandList *) {
98   // Does nothing?
99
100   return false;
101 }
102
103 void RoseInsnX86Factory::massageOperands(const InstructionAPI::Instruction::Ptr &insn, 
104                                          std::vector<InstructionAPI::Operand> &operands) {
105   switch (insn->getOperation().getID()) {
106   case e_lea: {
107     // ROSE expects there to be a "memory reference" statement wrapping the
108     // address calculation. It then unwraps it. 
109     Dereference::Ptr tmp = Dereference::Ptr(new Dereference(operands[1].getValue(), u32));
110     operands[1] = Operand(tmp, operands[1].isRead(), operands[1].isWritten());
111     operands.resize(2);
112     break;  
113   }
114   case e_push:
115   case e_pop:
116     operands.resize(1);
117     break;
118   case e_cmpxch:
119     operands.resize(2);
120     break;
121   case e_movsb:
122   case e_movsd:
123   case e_movsw:
124     // No operands
125     operands.clear();
126     break;
127   case e_cmpsb:
128   case e_cmpsw:
129   case e_cmpsd:
130     // No operands
131     operands.clear();
132     break;
133   case e_scasb:
134   case e_scasd:
135   case e_scasw:
136     // Same here
137     operands.clear();
138     break;
139   case e_stosb:
140   case e_stosd:
141   case e_stosw:
142     // Also, no operands
143     operands.clear();
144     break;
145   case e_jcxz_jec:
146     operands.resize(1);
147     break;
148   case e_cbw:
149   case e_cwde:
150   case e_cdq:
151     // Nada
152     operands.clear();
153     break;
154   default:
155     break;
156   }
157 }
158
159
160 //////////// PPC ///////////////////
161 // Note: convertKind is defined in convertOpcodes.C
162
163 SgAsmInstruction *RoseInsnPPCFactory::createInsn() {
164   return new SgAsmPowerpcInstruction;
165 }
166
167 void RoseInsnPPCFactory::setOpcode(SgAsmInstruction *insn, entryID opcode, prefixEntryID /*prefix*/, std::string mnem) {
168   SgAsmPowerpcInstruction *tmp = static_cast<SgAsmPowerpcInstruction *>(insn);
169   kind = convertKind(opcode, mnem);
170   tmp->set_kind(kind);
171 }
172
173
174 void RoseInsnPPCFactory::setSizes(SgAsmInstruction *) {
175 }
176
177
178 bool RoseInsnPPCFactory::handleSpecialCases(entryID iapi_opcode, 
179                                             SgAsmInstruction *insn, 
180                                             SgAsmOperandList *rose_operands) {
181   SgAsmPowerpcInstruction *rose_insn = static_cast<SgAsmPowerpcInstruction *>(insn);
182
183   switch(iapi_opcode) {
184   case power_op_b:
185   case power_op_bc:
186   case power_op_bcctr:
187   case power_op_bclr: {
188     unsigned int raw = 0;
189     int branch_target = 0;
190     unsigned int bo = 0, bi = 0;
191     std::vector<unsigned char> bytes = rose_insn->get_raw_bytes();
192     for(unsigned i = 0; i < bytes.size(); i++) {
193       raw = raw << 8;
194       raw |= bytes[i];
195     }
196     bool isAbsolute = (bool)(raw & 0x00000002);
197     bool isLink = (bool)(raw & 0x00000001);
198     rose_insn->set_kind(makeRoseBranchOpcode(iapi_opcode, isAbsolute, isLink));
199     if(power_op_b == iapi_opcode) {
200       branch_target = ((raw >> 2) & 0x00FFFFFF) << 2;
201       branch_target = (branch_target << 8) >> 8;
202     } else {
203       if(power_op_bc == iapi_opcode) {
204         branch_target = ((raw >> 2) & 0x00003FFF) << 2;
205         branch_target = (branch_target << 18) >> 18;
206         //cerr << "14-bit branch target: " << branch_target << endl;
207       }
208       bo = ((raw >> 21) & 0x0000001F);
209       bi = ((raw >> 16) & 0x0000001F);
210       rose_operands->append_operand(new SgAsmByteValueExpression(bo));
211       rose_operands->append_operand(new SgAsmPowerpcRegisterReferenceExpression(powerpc_regclass_cr, bi,
212                                                                                 powerpc_condreggranularity_bit));
213     }
214     if(branch_target) {
215       rose_operands->append_operand(new SgAsmDoubleWordValueExpression(branch_target));
216     } else if(power_op_bcctr == iapi_opcode) {
217       rose_operands->append_operand(new SgAsmPowerpcRegisterReferenceExpression(powerpc_regclass_spr, powerpc_spr_ctr));
218     } else {
219       assert(power_op_bclr == iapi_opcode);
220       rose_operands->append_operand(new SgAsmPowerpcRegisterReferenceExpression(powerpc_regclass_spr, powerpc_spr_lr));
221     }
222     return true;
223   }
224     break;
225   case power_op_sc:
226   case power_op_svcs: {
227     //cerr << "special-casing syscall insn" << endl;
228     unsigned int raw = 0;
229     std::vector<unsigned char> bytes = rose_insn->get_raw_bytes();
230     for(unsigned i = 0; i < bytes.size(); i++) {
231       raw = raw << 8;
232       raw |= bytes[i];
233     }
234     unsigned int lev = (raw >> 5) & 0x7F;
235     rose_operands->append_operand(new SgAsmByteValueExpression(lev));
236     //cerr << "LEV = " << lev << endl;
237     return true;
238   }
239   default:
240     return false;
241   }
242   
243 }  
244
245 void RoseInsnPPCFactory::massageOperands(const InstructionAPI::Instruction::Ptr &insn, 
246                                          std::vector<InstructionAPI::Operand> &operands) {
247   if(insn->writesMemory())
248     std::swap(operands[0], operands[1]);
249   entryID opcode = insn->getOperation().getID();
250   // Anything that's writing RA, ROSE expects in RA, RS, RB/immediates form.
251   // Any store, however, ROSE expects in RS, RA, RB/displacement form.  Very confusing,
252   // but we handle it cleanly here.
253   if(!operands[0].isWritten() && operands.size() >= 2 &&
254      operands[1].isWritten() && !operands[1].writesMemory()) {
255     std::cerr << "swapping RS and RA in " << insn->format() << std::endl;
256     std::swap(operands[0], operands[1]);
257   }
258   if(opcode == power_op_cmp ||
259      opcode == power_op_cmpl ||
260      opcode == power_op_cmpi ||
261      opcode == power_op_cmpli) {
262     operands.push_back(Operand(Immediate::makeImmediate(Result(u8, 1)), false, false));
263     std::swap(operands[2], operands[3]);
264     std::swap(operands[1], operands[2]);
265   }
266   if(insn->getOperation().format().find(".") != std::string::npos &&
267      insn->getOperation().getID() != power_op_stwcx_rc) {
268     operands.pop_back();
269   }
270
271   // Convert to ROSE so we can use numeric greater than/less than
272
273   if(kind >= powerpc_lbz && kind <= powerpc_lwzx) {
274     operands.resize(2);
275   }
276   if(kind >= powerpc_stb && kind <= powerpc_stwx) {
277     operands.resize(2);
278   }
279
280   return;
281 }
282