Update copyright to LGPL on all files
[dyninst.git] / testsuite / src / instruction / test_instruction_read_write.C
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 #include "instruction_comp.h"
33 #include "test_lib.h"
34
35 #include "Instruction.h"
36 #include "InstructionDecoder.h"
37
38 //#include <dyn_detail/boost/assign/list_of.hpp>
39 //#include <dyn_detail/boost/iterator/indirect_iterator.hpp>
40 #include <boost/assign/list_of.hpp>
41 #include <boost/iterator/indirect_iterator.hpp>
42 #include <deque>
43 using namespace Dyninst;
44 using namespace InstructionAPI;
45 using namespace boost;
46 using namespace boost::assign;
47
48 using namespace std;
49
50 class test_instruction_read_write_Mutator : public InstructionMutator {
51 public:
52    test_instruction_read_write_Mutator() { };
53    virtual test_results_t executeTest();
54 };
55
56 extern "C" DLLEXPORT TestMutator* test_instruction_read_write_factory()
57 {
58    return new test_instruction_read_write_Mutator();
59 }
60
61 template <typename T>
62 struct shared_ptr_lt
63 {
64   bool operator()(const T& lhs, const T& rhs)
65   {
66     // Non-nulls precede nulls
67     if(rhs.get() == NULL)
68     {
69       return lhs.get() != NULL;
70     }
71     if(lhs.get() == NULL)
72       return false;
73     // Otherwise, dereference and compare
74     return *lhs < *rhs;
75   }
76   
77 };
78
79
80 typedef std::set<RegisterAST::Ptr, shared_ptr_lt<RegisterAST::Ptr> > registerSet;
81
82 test_results_t failure_accumulator(test_results_t lhs, test_results_t rhs)
83 {
84   if(lhs == FAILED || rhs == FAILED)
85   {
86     return FAILED;
87   }
88   return PASSED;
89 }
90
91 test_results_t verify_read_write_sets(const Instruction::Ptr& i, const registerSet& expectedRead,
92                                       const registerSet& expectedWritten)
93 {
94   set<RegisterAST::Ptr> actualRead_uo;
95   set<RegisterAST::Ptr> actualWritten_uo;
96   i->getWriteSet(actualWritten_uo);
97   i->getReadSet(actualRead_uo);
98   registerSet actualRead, actualWritten;
99   copy(actualRead_uo.begin(), actualRead_uo.end(), inserter(actualRead, actualRead.begin()));
100   copy(actualWritten_uo.begin(), actualWritten_uo.end(), inserter(actualWritten, actualWritten.begin()));
101   
102   if(actualRead.size() != expectedRead.size() ||
103      actualWritten.size() != expectedWritten.size())
104   {
105     logerror("FAILED: instruction %s, expected %d regs read, %d regs written, actual %d read, %d written\n",
106              i->format().c_str(), expectedRead.size(), expectedWritten.size(), actualRead.size(), actualWritten.size());
107     logerror("Expected read:\n");
108     for (registerSet::const_iterator iter = expectedRead.begin(); iter != expectedRead.end(); iter++) {
109         logerror("\t%s\n", (*iter)->format().c_str());
110     }
111     logerror("Expected written:\n");
112     for (registerSet::const_iterator iter = expectedWritten.begin(); iter != expectedWritten.end(); iter++) {
113         logerror("\t%s\n", (*iter)->format().c_str());
114     }
115     logerror("Actual read:\n");
116     for (registerSet::iterator iter = actualRead.begin(); iter != actualRead.end(); iter++) {
117         logerror("\t%s\n", (*iter)->format().c_str());
118     }
119     logerror("Actual written:\n");
120     for (registerSet::iterator iter = actualWritten.begin(); iter != actualWritten.end(); iter++) {
121         logerror("\t%s\n", (*iter)->format().c_str());
122     }
123
124     return FAILED;
125   }
126   registerSet::const_iterator safety;
127   for(safety = expectedRead.begin();
128       safety != expectedRead.end();
129       ++safety)
130   {
131     if(!(*safety))
132     {
133       logerror("ERROR: null shared pointer in expectedRead for instruction %s\n", i->format().c_str());
134       return FAILED;
135     }
136     
137   }
138   for(safety = actualRead.begin();
139       safety != actualRead.end();
140       ++safety)
141   {
142     if(!(*safety))
143     {
144       logerror("ERROR: null shared pointer in actualRead for instruction %s\n", i->format().c_str());
145       return FAILED;
146     }
147     
148   }
149   
150   if(equal(make_indirect_iterator(actualRead.begin()), 
151            make_indirect_iterator(actualRead.end()), 
152            make_indirect_iterator(expectedRead.begin())))
153   {
154     for(registerSet::const_iterator it = expectedRead.begin();
155         it != expectedRead.end();
156         ++it)
157     {
158       if(!i->isRead(*it))
159       {
160         logerror("%s was in read set, but isRead(%s) was false\n", (*it)->format().c_str(), (*it)->format().c_str());
161         return FAILED;
162       }
163     }
164   }
165   else
166   {
167     logerror("Read set for instruction %s not as expected\n", i->format().c_str());
168     return FAILED;
169   }
170   
171   for(safety = expectedWritten.begin();
172       safety != expectedWritten.end();
173       ++safety)
174   {
175     if(!(*safety))
176     {
177       logerror("ERROR: null shared pointer in expectedWritten for instruction %s\n", i->format().c_str());
178       return FAILED;
179     }
180     
181   }
182   for(safety = actualWritten.begin();
183       safety != actualWritten.end();
184       ++safety)
185   {
186     if(!(*safety))
187     {
188       logerror("ERROR: null shared pointer in actualWritten for instruction %s\n", i->format().c_str());
189       return FAILED;
190     }
191     
192   }
193   if(equal(make_indirect_iterator(actualWritten.begin()), 
194            make_indirect_iterator(actualWritten.end()), 
195            make_indirect_iterator(expectedWritten.begin())))
196   {
197     for(registerSet::const_iterator it = expectedWritten.begin();
198         it != expectedWritten.end();
199         ++it)
200     {
201       if(!i->isWritten(*it))
202       {
203         logerror("%s was in write set, but isWritten(%s) was false\n", (*it)->format().c_str(), (*it)->format().c_str());
204         return FAILED;
205       }
206     }
207   }
208   else
209   {
210     logerror("Write set for instruction %s not as expected\n", i->format().c_str());
211     return FAILED;
212   }
213   logerror("PASSED: Instruction %s had read, write sets as expected\n", i->format().c_str());
214   return PASSED;
215 }
216
217
218 test_results_t test_instruction_read_write_Mutator::executeTest()
219 {
220   const unsigned char buffer[] = 
221   {
222     0x05, 0xef, 0xbe, 0xad, 0xde, // ADD eAX, 0xDEADBEEF
223     0x50, // PUSH rAX
224     0x74, 0x10, // JZ +0x10(8)
225     0xE8, 0x20, 0x00, 0x00, 0x00, // CALL +0x20(32)
226     0xF8, // CLC
227     0x04, 0x30, // ADD AL, 0x30(8)
228     0xc7, 0x45, 0xfc, 0x01, 0x00, 0x00, 0x00, // MOVL 0x01, -0x4(EBP)
229     0x88, 0x55, 0xcc, // MOVB DL, -0x34(EBP)
230     0xF2, 0x0F, 0x12, 0xC0, // MOVDDUP XMM0, XMM1
231     0x66, 0x0F, 0x7C, 0xC9  // HADDPD XMM1, XMM1
232   };
233   unsigned int size = 34;
234   unsigned int expectedInsns = 11;
235   InstructionDecoder d(buffer, size);
236 #if defined(arch_x86_64_test)
237   d.setMode(true);
238 #endif
239   std::deque<Instruction::Ptr> decodedInsns;
240   Instruction::Ptr i;
241   do
242   {
243     i = d.decode();
244     decodedInsns.push_back(i);
245   }
246   while(i && i->isValid());
247   if(decodedInsns.size() != expectedInsns)
248   {
249     logerror("FAILED: Expected %d instructions, decoded %d\n", expectedInsns, decodedInsns.size());
250     for(std::deque<Instruction::Ptr>::iterator curInsn = decodedInsns.begin();
251         curInsn != decodedInsns.end();
252         ++curInsn)
253     {
254       logerror("\t%s\n", (*curInsn)->format().c_str());
255     }
256     
257     return FAILED;
258   }
259   if(decodedInsns.back() && decodedInsns.back()->isValid())
260   {
261     logerror("FAILED: Expected instructions to end with an invalid instruction, but they didn't");
262     return FAILED;
263   }
264   RegisterAST::Ptr eax(new RegisterAST(r_eAX));
265   RegisterAST::Ptr adjust(new RegisterAST(r_AF));
266   RegisterAST::Ptr zero(new RegisterAST(r_ZF));
267   RegisterAST::Ptr overflow(new RegisterAST(r_OF));
268   RegisterAST::Ptr parity(new RegisterAST(r_PF));
269   RegisterAST::Ptr sign(new RegisterAST(r_SF));
270   RegisterAST::Ptr carry(new RegisterAST(r_CF));
271   registerSet expectedRead, expectedWritten;
272   expectedRead.insert(expectedRead.begin(), eax);
273   expectedWritten = list_of(eax)(adjust)(zero)(overflow)(parity)(sign)(carry);
274   
275   test_results_t retVal = PASSED;
276   
277   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), expectedRead, expectedWritten));
278   decodedInsns.pop_front();
279   
280   RegisterAST::Ptr rax(new RegisterAST(r_rAX));
281   RegisterAST::Ptr esp(new RegisterAST(r_eSP));
282   expectedRead.clear();
283   expectedWritten.clear();
284   expectedRead = list_of(esp)(rax);
285   expectedWritten = list_of(esp);
286   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), expectedRead, expectedWritten));
287   decodedInsns.pop_front();
288   
289   expectedRead.clear();
290   expectedWritten.clear();
291   RegisterAST::Ptr ip(new RegisterAST(r_EIP));
292   // Jccs are all documented as "may read zero, sign, carry, parity, overflow", so a JZ comes back as reading all
293   // of these flags
294   expectedRead = list_of(zero)(sign)(carry)(parity)(overflow)(ip);
295   expectedWritten = list_of(ip);
296   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), 
297                                                               expectedRead, expectedWritten));
298   decodedInsns.pop_front();
299   
300   expectedRead.clear();
301   expectedWritten.clear();
302   expectedRead = list_of(esp)(ip);
303   expectedWritten = list_of(esp)(ip);
304   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), 
305                                                               expectedRead, expectedWritten));
306   Instruction::Ptr callInsn = decodedInsns.front();
307   decodedInsns.pop_front();
308
309   expectedRead.clear();
310   expectedWritten.clear();
311   expectedWritten = list_of(carry);
312   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), 
313                                                               expectedRead, expectedWritten));
314   decodedInsns.pop_front();
315
316   expectedRead.clear();
317   expectedWritten.clear();
318   RegisterAST::Ptr al(new RegisterAST(r_AL));
319   expectedRead = list_of(al);
320   expectedWritten = list_of(al)(zero)(carry)(sign)(overflow)(parity)(adjust);
321   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), 
322                                                               expectedRead, expectedWritten));
323   decodedInsns.pop_front();
324
325 #if defined(arch_x86_64_test)
326   RegisterAST::Ptr bp(new RegisterAST(r_RBP));
327 #else
328   RegisterAST::Ptr bp(new RegisterAST(r_EBP));
329 #endif
330   expectedRead.clear();
331   expectedWritten.clear();
332   expectedRead = list_of(bp);
333   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), 
334                                                               expectedRead, expectedWritten));
335   decodedInsns.pop_front();
336   
337   
338   RegisterAST::Ptr dl(new RegisterAST(r_DL));
339   expectedRead.clear();
340   expectedWritten.clear();
341   expectedRead = list_of(bp)(dl);
342   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), 
343                                                               expectedRead, expectedWritten));
344   decodedInsns.pop_front();
345   
346
347   RegisterAST::Ptr xmm0(new RegisterAST(r_XMM0));
348   RegisterAST::Ptr xmm1(new RegisterAST(r_XMM1));
349   expectedRead.clear();
350   expectedWritten.clear();
351   expectedRead = list_of(xmm0);
352   expectedWritten = list_of(xmm0);
353   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), 
354                                                               expectedRead, expectedWritten));
355   if(decodedInsns.front()->size() != 4) {
356     logerror("FAILURE: movddup expected size 4, decoded to %s, had size %d\n", decodedInsns.front()->format().c_str(), decodedInsns.front()->size());
357     retVal = FAILED;
358   }
359   decodedInsns.pop_front();
360
361   expectedRead.clear();
362   expectedWritten.clear();
363   expectedRead = list_of(xmm1);
364   expectedWritten = list_of(xmm1);
365   retVal = failure_accumulator(retVal, verify_read_write_sets(decodedInsns.front(), expectedRead, expectedWritten));
366   if(decodedInsns.front()->size() != 4) {
367     logerror("FAILURE: haddpd expected size 4, decoded to %s, had size %d\n", decodedInsns.front()->format().c_str(), decodedInsns.front()->size());
368     retVal = FAILED;
369   }  
370   decodedInsns.pop_front();
371
372 #if defined(arch_x86_64_test)
373   const unsigned char amd64_specific[] = 
374   {
375     0x44, 0x89, 0x45, 0xc4
376   };
377   unsigned int amd64_size = 4;
378   unsigned int amd64_num_valid_insns = 1;
379   deque<Instruction::Ptr> amd64Insns;
380   
381   InstructionDecoder amd64_decoder(amd64_specific, amd64_size);
382   amd64_decoder.setMode(true);
383   
384   Instruction::Ptr tmp;
385   do
386   {
387     tmp = amd64_decoder.decode();
388     amd64Insns.push_back(tmp);
389   } while(tmp && tmp->isValid());
390   amd64Insns.pop_back();
391   if(amd64Insns.size() != amd64_num_valid_insns) 
392   {
393     logerror("FAILED: expected %d instructions in AMD64-specific part, got %d\n", amd64_num_valid_insns,
394              amd64Insns.size());
395     return FAILED;
396   }
397   RegisterAST::Ptr r8(new RegisterAST(r_R8));
398   
399   expectedRead = list_of(bp)(r8);
400   expectedWritten.clear();
401   
402   retVal = failure_accumulator(retVal, verify_read_write_sets(amd64Insns.front(), expectedRead, expectedWritten));
403   amd64Insns.pop_front();
404   
405 #endif
406
407   Expression::Ptr cft = callInsn->getControlFlowTarget();
408   if(!cft) {
409     logerror("FAILED: call had no control flow target\n");
410     return FAILED;
411   }
412   RegisterAST* the_ip = new RegisterAST(r_EIP);
413   
414   if(!cft->bind(the_ip, Result(u32, 0))) {
415     logerror("FAILED: bind found no IP in call Jz CFT\n");
416     return FAILED;
417   }
418   Result theTarget = cft->eval();
419   if(!theTarget.defined) {
420     logerror("FAILED: bind of IP on a Jz operand did not resolve all dependencies\n");
421     return FAILED;
422   }
423   if(theTarget.type != u32) {
424     logerror("FAILED: CFT was not address type\n");
425     logerror("   %s\n", theTarget.format().c_str());
426     return FAILED;
427   }
428   // Call target should be to IP + displacement + size
429   if(theTarget.val.u32val != 0x25) {
430     logerror("FAILED: expected call to %x, got call to %x\n", 0x20, theTarget.val.u32val);
431     logerror("   %s\n", theTarget.format().c_str());
432     return FAILED;
433   }
434   logerror("PASSED call CFT subtest\n");
435   delete the_ip;
436
437   return retVal;
438 }
439