Merge branch 'master' into NewInstpoint
[dyninst.git] / dyninstAPI / src / parse-x86.C
1 /*
2  * Copyright (c) 1996-2011 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 /*
33  * inst-x86.C - x86 dependent functions and code generator
34  */
35
36 #include "common/h/Vector.h"
37 #include "common/h/Dictionary.h"
38 #include "common/h/Vector.h"
39 #include "parse-cfg.h"
40 #include "instPoint.h"
41 #include "mapped_object.h"
42 #include "symtab.h"
43 #include "dyninstAPI/h/BPatch_Set.h"
44 #include "debug.h"
45 #include <deque>
46 #include <set>
47 #include <algorithm>
48 //#include "arch.h"
49
50 #include "instructionAPI/h/Instruction.h"
51 #include "instructionAPI/h/InstructionDecoder.h"
52
53 using namespace Dyninst::ParseAPI;
54
55 bool parse_func::writesFPRs(unsigned level) {
56     
57     using namespace Dyninst::InstructionAPI;
58     // Oh, we should be parsed by now...
59     if (!parsed()) image_->analyzeIfNeeded();
60
61     if (containsFPRWrites_ == unknown) {
62         // Iterate down and find out...
63         // We know if we have callees because we can
64         // check the instPoints; no reason to iterate over.
65         // We also cache callee values here for speed.
66
67         if (level >= 3) {
68             return true; // Arbitrarily decided level 3 iteration.
69         }        
70         Function::edgelist & calls = callEdges();
71         Function::edgelist::iterator cit = calls.begin();
72         for( ; cit != calls.end(); ++cit) {
73             image_edge * ce = static_cast<image_edge*>(*cit);
74             parse_func * ct = static_cast<parse_func*>(
75                 obj()->findFuncByEntry(region(),ce->trg()->start()));
76             if(ct && ct != this) {
77                 if (ct->writesFPRs(level+1)) {
78                     // One of our kids does... if we're top-level, cache it; in 
79                     // any case, return
80                     if (level == 0)
81                         containsFPRWrites_ = used;
82                     return true;
83                 }
84             }
85             else if(!ct){
86                 // Indirect call... oh, yeah. 
87                 if (level == 0)
88                     containsFPRWrites_ = used;
89                 return true;
90             }
91         }
92
93         // No kids contain writes. See if our code does.
94         static RegisterAST::Ptr st0(new RegisterAST(x86::st0));
95         static RegisterAST::Ptr st1(new RegisterAST(x86::st1));
96         static RegisterAST::Ptr st2(new RegisterAST(x86::st2));
97         static RegisterAST::Ptr st3(new RegisterAST(x86::st3));
98         static RegisterAST::Ptr st4(new RegisterAST(x86::st4));
99         static RegisterAST::Ptr st5(new RegisterAST(x86::st5));
100         static RegisterAST::Ptr st6(new RegisterAST(x86::st6));
101         static RegisterAST::Ptr st7(new RegisterAST(x86::st7));
102         static RegisterAST::Ptr xmm0(new RegisterAST(x86::xmm0));
103         static RegisterAST::Ptr xmm1(new RegisterAST(x86::xmm1));
104         static RegisterAST::Ptr xmm2(new RegisterAST(x86::xmm2));
105         static RegisterAST::Ptr xmm3(new RegisterAST(x86::xmm3));
106         static RegisterAST::Ptr xmm4(new RegisterAST(x86::xmm4));
107         static RegisterAST::Ptr xmm5(new RegisterAST(x86::xmm5));
108         static RegisterAST::Ptr xmm6(new RegisterAST(x86::xmm6));
109         static RegisterAST::Ptr xmm7(new RegisterAST(x86::xmm7));
110
111         vector<FuncExtent *>::const_iterator eit = extents().begin();
112         for( ; eit != extents().end(); ++eit) {
113             FuncExtent * fe = *eit;
114         
115             const unsigned char* buf = (const unsigned char*)
116                 isrc()->getPtrToInstruction(fe->start());
117             if(!buf) {
118                 parsing_printf("%s[%d]: failed to get insn ptr at %lx\n",
119                     FILE__, __LINE__,fe->start());
120                 // if the function cannot be parsed, it is only safe to 
121                 // assume that the FPRs are written -- mcnulty
122                 return true; 
123             }
124             InstructionDecoder d(buf,fe->end()-fe->start(),isrc()->getArch());
125             Instruction::Ptr i;
126
127             while(i = d.decode()) {
128                 if(i->isWritten(st0) ||
129                     i->isWritten(st1) ||
130                     i->isWritten(st2) ||
131                     i->isWritten(st3) ||
132                     i->isWritten(st4) ||
133                     i->isWritten(st5) ||
134                     i->isWritten(st6) ||
135                     i->isWritten(st7) ||
136                    i->isWritten(xmm0) ||
137                    i->isWritten(xmm1) ||
138                    i->isWritten(xmm2) ||
139                    i->isWritten(xmm3) ||
140                    i->isWritten(xmm4) ||
141                    i->isWritten(xmm5) ||
142                    i->isWritten(xmm6) ||
143                    i->isWritten(xmm7)
144                   )
145                 {
146                     containsFPRWrites_ = used;
147                     return true;
148                 }
149             }
150         }
151         // No kids do, and we don't. Impressive.
152         containsFPRWrites_ = unused;
153         return false;
154     }
155     else if (containsFPRWrites_ == used) {
156         return true;
157     }
158     else if (containsFPRWrites_ == unused) {
159         return false;
160     }
161
162     fprintf(stderr, "ERROR: function %s, containsFPRWrites_ is %d (illegal value!)\n", 
163             symTabName().c_str(), containsFPRWrites_);
164     
165     assert(0);
166     return false;
167 }
168
169 #if defined(os_linux) || defined(os_freebsd)
170
171 #include "binaryEdit.h"
172 #include "addressSpace.h"
173 #include "function.h"
174 #include "miniTramp.h"
175 #include "baseTramp.h"
176 #include "symtab.h"
177
178 using namespace Dyninst::SymtabAPI;
179
180 /*
181  * Static binary rewriting support
182  *
183  * Some of the following functions replace the standard ctor and dtor handlers
184  * in a binary. Currently, these operations only work with binaries linked with
185  * the GNU toolchain. However, it should be straightforward to extend these
186  * operations to other toolchains.
187  */
188 static const std::string LIBC_CTOR_HANDLER("__do_global_ctors_aux");
189 static const std::string LIBC_DTOR_HANDLER("__do_global_dtors_aux");
190 static const std::string DYNINST_CTOR_HANDLER("DYNINSTglobal_ctors_handler");
191 static const std::string DYNINST_CTOR_LIST("DYNINSTctors_addr");
192 static const std::string DYNINST_DTOR_HANDLER("DYNINSTglobal_dtors_handler");
193 static const std::string DYNINST_DTOR_LIST("DYNINSTdtors_addr");
194 static const std::string SYMTAB_CTOR_LIST_REL("__SYMTABAPI_CTOR_LIST__");
195 static const std::string SYMTAB_DTOR_LIST_REL("__SYMTABAPI_DTOR_LIST__");
196
197 static bool replaceHandler(func_instance *origHandler, func_instance *newHandler, 
198         int_symbol *newList, const std::string &listRelName)
199 {
200     // Add instrumentation to replace the function
201    // TODO: this should be a function replacement!
202    // And why the hell is it in parse-x86.C?
203    instPoint *entry = instPoint::funcEntry(origHandler);
204    AstNodePtr funcJump = AstNode::funcReplacementNode(const_cast<func_instance *>(newHandler));
205    miniTramp *mini = entry->push_front(funcJump, true);
206    origHandler->proc()->relocate();
207     
208     
209     /* create the special relocation for the new list -- search the RT library for
210      * the symbol
211      */
212     Symbol *newListSym = const_cast<Symbol *>(newList->sym());
213     
214     std::vector<Region *> allRegions;
215     if( !newListSym->getSymtab()->getAllRegions(allRegions) ) {
216         return false;
217     }
218
219     bool success = false;
220     std::vector<Region *>::iterator reg_it;
221     for(reg_it = allRegions.begin(); reg_it != allRegions.end(); ++reg_it) {
222         std::vector<relocationEntry> &region_rels = (*reg_it)->getRelocations();
223         vector<relocationEntry>::iterator rel_it;
224         for( rel_it = region_rels.begin(); rel_it != region_rels.end(); ++rel_it) {
225             if( rel_it->getDynSym() == newListSym ) {
226                 relocationEntry *rel = &(*rel_it);
227                 rel->setName(listRelName);
228                 success = true;
229             }
230         }
231     }
232
233     return success;
234 }
235
236 bool BinaryEdit::doStaticBinarySpecialCases() {
237     Symtab *origBinary = mobj->parse_img()->getObject();
238
239     /* Special Case 1: Handling global constructor and destructor Regions
240      *
241      * Replace global ctors function with special ctors function,
242      * and create a special relocation for the ctors list used by the special
243      * ctors function
244      *
245      * Replace global dtors function with special dtors function,
246      * and create a special relocation for the dtors list used by the special
247      * dtors function
248      */
249
250     // First, find all the necessary symbol info.
251     func_instance *globalCtorHandler = mobj->findGlobalConstructorFunc(LIBC_CTOR_HANDLER);
252     if( !globalCtorHandler ) {
253         logLine("failed to find libc constructor handler\n");
254         return false;
255     }
256
257     func_instance *dyninstCtorHandler = findOnlyOneFunction(DYNINST_CTOR_HANDLER);
258     if( !dyninstCtorHandler ) {
259         logLine("failed to find Dyninst constructor handler\n");
260         return false;
261     }
262
263     func_instance *globalDtorHandler = mobj->findGlobalDestructorFunc(LIBC_DTOR_HANDLER);
264     if( !globalDtorHandler ) {
265         logLine("failed to find libc destructor handler\n");
266         return false;
267     }
268
269     func_instance *dyninstDtorHandler = findOnlyOneFunction(DYNINST_DTOR_HANDLER);
270     if( !dyninstDtorHandler ) {
271         logLine("failed to find Dyninst destructor handler\n");
272         return false;
273     }
274
275     int_symbol ctorsListInt;
276     int_symbol dtorsListInt;
277     bool ctorFound = false, dtorFound = false; 
278     std::vector<BinaryEdit *>::iterator rtlib_it;
279     for(rtlib_it = rtlib.begin(); rtlib_it != rtlib.end(); ++rtlib_it) {
280         if( (*rtlib_it)->getSymbolInfo(DYNINST_CTOR_LIST, ctorsListInt) ) {
281             ctorFound = true;
282             if( dtorFound ) break;
283         }
284
285         if( (*rtlib_it)->getSymbolInfo(DYNINST_DTOR_LIST, dtorsListInt) ) {
286             dtorFound = true;
287             if( ctorFound ) break;
288         }
289     }
290
291     if( !ctorFound ) {
292          logLine("failed to find ctors list symbol\n");
293          return false;
294     }
295
296     if( !dtorFound ) {
297         logLine("failed to find dtors list symbol\n");
298         return false;
299     }
300
301     /*
302      * Replace the libc ctor and dtor handlers with our special handlers
303      */
304     if( !replaceHandler(globalCtorHandler, dyninstCtorHandler,
305                 &ctorsListInt, SYMTAB_CTOR_LIST_REL) ) {
306         logLine("Failed to replace libc ctor handler with special handler");
307         return false;
308     }else{
309         inst_printf("%s[%d]: replaced ctor function %s with %s\n",
310                 FILE__, __LINE__, LIBC_CTOR_HANDLER.c_str(),
311                 DYNINST_CTOR_HANDLER.c_str());
312     }
313
314     if( !replaceHandler(globalDtorHandler, dyninstDtorHandler,
315                 &dtorsListInt, SYMTAB_DTOR_LIST_REL) ) {
316         logLine("Failed to replace libc dtor handler with special handler");
317         return false;
318     }else{
319         inst_printf("%s[%d]: replaced dtor function %s with %s\n",
320                 FILE__, __LINE__, LIBC_DTOR_HANDLER.c_str(),
321                 DYNINST_DTOR_HANDLER.c_str());
322     }
323
324     /*
325      * Special Case 2: Issue a warning if attempting to link pthreads into a binary
326      * that originally did not support it or into a binary that is stripped. This
327      * scenario is not supported with the initial release of the binary rewriter for
328      * static binaries.
329      *
330      * The other side of the coin, if working with a binary that does have pthreads
331      * support, pthreads needs to be loaded.
332      */
333     bool isMTCapable = isMultiThreadCapable();
334     bool foundPthreads = false;
335
336     vector<Archive *> libs;
337     vector<Archive *>::iterator libIter;
338     if( origBinary->getLinkingResources(libs) ) {
339         for(libIter = libs.begin(); libIter != libs.end(); ++libIter) {
340             if( (*libIter)->name().find("libpthread") != std::string::npos ||
341                 (*libIter)->name().find("libthr") != std::string::npos ) 
342             {
343                 foundPthreads = true;
344                 break;
345             }
346         }
347     }
348
349     if( foundPthreads && (!isMTCapable || origBinary->isStripped()) ) {
350         fprintf(stderr,
351             "\nWARNING: the pthreads library has been loaded and\n"
352             "the original binary is not multithread-capable or\n"
353             "it is stripped. Currently, the combination of these two\n"
354             "scenarios is unsupported and unexpected behavior may occur.\n");
355     }else if( !foundPthreads && isMTCapable ) {
356         fprintf(stderr,
357             "\nWARNING: the pthreads library has not been loaded and\n"
358             "the original binary is multithread-capable. Unexpected\n"
359             "behavior may occur because some pthreads routines are\n"
360             "unavailable in the original binary\n");
361     }
362
363     /* 
364      * Special Case 3:
365      * The RT library has some dependencies -- Symtab always needs to know
366      * about these dependencies. So if the dependencies haven't already been
367      * loaded, load them.
368      */
369     bool loadLibc = true;
370
371     for(libIter = libs.begin(); libIter != libs.end(); ++libIter) {
372         if( (*libIter)->name().find("libc.a") != std::string::npos ) {
373             loadLibc = false;
374         }
375     }
376
377     if( loadLibc ) {
378         std::map<std::string, BinaryEdit *> res = openResolvedLibraryName("libc.a");
379         std::map<std::string, BinaryEdit *>::iterator bedit_it;
380         for(bedit_it = res.begin(); bedit_it != res.end(); ++bedit_it) {
381             if( bedit_it->second == NULL ) {
382                 logLine("Failed to load DyninstAPI_RT library dependency (libc.a)");
383                 return false;
384             }
385         }
386     }
387
388     return true;
389 }
390
391 func_instance *mapped_object::findGlobalConstructorFunc(const std::string &ctorHandler) {
392     using namespace Dyninst::InstructionAPI;
393
394     const pdvector<func_instance *> *funcs = findFuncVectorByMangled(ctorHandler);
395     if( funcs != NULL ) {
396         return funcs->at(0);
397     }
398
399     /* If the symbol isn't found, try looking for it in a call instruction in
400      * the .init section
401      *
402      * On Linux, the instruction sequence is:
403      * ...
404      * some instructions
405      * ...
406      * call call_gmon_start
407      * call frame_dummy
408      * call ctor_handler
409      *
410      * On FreeBSD, the instruction sequence is:
411      * ...
412      * some instructions
413      * ...
414      * call frame_dummy
415      * call ctor_handler
416      */
417     Symtab *linkedFile = parse_img()->getObject();
418     Region *initRegion = NULL;
419     if( !linkedFile->findRegion(initRegion, ".init") ) {
420         vector<Dyninst::SymtabAPI::Function *> symFuncs;
421         if( linkedFile->findFunctionsByName(symFuncs, "_init") ) {
422             initRegion = symFuncs[0]->getRegion();
423         }else{
424             logLine("failed to locate .init Region or _init function\n");
425             return NULL;
426         }
427     }
428
429     if( initRegion == NULL ) {
430         logLine("failed to locate .init Region or _init function\n");
431         return NULL;
432     }
433
434     // Search for last of a fixed number of calls
435 #if defined(os_freebsd)
436     const unsigned CTOR_NUM_CALLS = 2;
437 #else
438     const unsigned CTOR_NUM_CALLS = 3;
439 #endif
440
441     Address ctorAddress = 0;
442     unsigned bytesSeen = 0;
443     unsigned numCalls = 0;
444     const unsigned char *p = reinterpret_cast<const unsigned char *>(initRegion->getPtrToRawData());
445
446     InstructionDecoder decoder(p, initRegion->getRegionSize(),
447         parse_img()->codeObject()->cs()->getArch()); 
448
449     Instruction::Ptr curInsn = decoder.decode();
450     while(numCalls < CTOR_NUM_CALLS && curInsn && curInsn->isValid() &&
451           bytesSeen < initRegion->getRegionSize()) 
452     {
453         InsnCategory category = curInsn->getCategory();
454         if( category == c_CallInsn ) {
455             numCalls++;
456         }
457         if( numCalls < CTOR_NUM_CALLS ) {
458             bytesSeen += curInsn->size();
459             curInsn = decoder.decode();
460         }
461     }
462
463     if( numCalls != CTOR_NUM_CALLS ) {
464         logLine("heuristic for finding global constructor function failed\n");
465         return NULL;
466     }
467
468     Address callAddress = initRegion->getRegionAddr() + bytesSeen;
469
470     RegisterAST thePC = RegisterAST(
471         Dyninst::MachRegister::getPC(parse_img()->codeObject()->cs()->getArch()));
472
473     Expression::Ptr callTarget = curInsn->getControlFlowTarget();
474     if( !callTarget.get() ) {
475         logLine("failed to find global constructor function\n");
476         return NULL;
477     }
478     callTarget->bind(&thePC, Result(s64, callAddress));
479
480     Result actualTarget = callTarget->eval();
481     if( actualTarget.defined ) {
482         ctorAddress = actualTarget.convert<Address>();
483     }else{
484         logLine("failed to find global constructor function\n");
485         return NULL;
486     }
487
488     if( !ctorAddress || !parse_img()->codeObject()->cs()->isValidAddress(ctorAddress) ) {
489         logLine("invalid address for global constructor function\n");
490         return NULL;
491     }
492
493     func_instance *ret;
494     if( (ret = findFuncByEntry(ctorAddress)) == NULL ) {
495         logLine("unable to create representation for global constructor function\n");
496         return NULL;
497     }
498
499     inst_printf("%s[%d]: set global constructor address to 0x%lx\n", FILE__, __LINE__,
500             ctorAddress);
501
502     return ret;
503 }
504
505 func_instance *mapped_object::findGlobalDestructorFunc(const std::string &dtorHandler) {
506     using namespace Dyninst::InstructionAPI;
507
508     const pdvector<func_instance *> *funcs = findFuncVectorByMangled(dtorHandler);
509     if( funcs != NULL ) {
510         return funcs->at(0);
511     }
512
513     /*
514      * If the symbol isn't found, try looking for it in a call in the
515      * .fini section. It is the last call in .fini.
516      *
517      * The pattern is:
518      *
519      * _fini:
520      *
521      * ... some code ...
522      *
523      * call dtor_handler
524      *
525      * ... prologue ...
526      */
527     Symtab *linkedFile = parse_img()->getObject();
528     Region *finiRegion = NULL;
529     if( !linkedFile->findRegion(finiRegion, ".fini") ) {
530         vector<Dyninst::SymtabAPI::Function *> symFuncs;
531         if( linkedFile->findFunctionsByName(symFuncs, "_fini") ) {
532             finiRegion = symFuncs[0]->getRegion();
533         }else{
534             logLine("failed to locate .fini Region or _fini function\n");
535             return NULL;
536         }
537     }
538
539     if( finiRegion == NULL ) {
540         logLine("failed to locate .fini Region or _fini function\n");
541         return NULL;
542     }
543
544     // Search for last call in the function
545     Address dtorAddress = 0;
546     unsigned bytesSeen = 0;
547     const unsigned char *p = reinterpret_cast<const unsigned char *>(finiRegion->getPtrToRawData());
548
549     InstructionDecoder decoder(p, finiRegion->getRegionSize(),
550         parse_img()->codeObject()->cs()->getArch());
551
552     Instruction::Ptr lastCall;
553     Instruction::Ptr curInsn = decoder.decode();
554
555     while(curInsn && curInsn->isValid() &&
556           bytesSeen < finiRegion->getRegionSize()) 
557     {
558         InsnCategory category = curInsn->getCategory();
559         if( category == c_CallInsn ) {
560             lastCall = curInsn;
561             break;
562         }
563
564         bytesSeen += curInsn->size();
565         curInsn = decoder.decode();
566     }
567
568     if( !lastCall.get() || !lastCall->isValid() ) {
569         logLine("heuristic for finding global destructor function failed\n");
570         return NULL;
571     }
572
573     Address callAddress = finiRegion->getRegionAddr() + bytesSeen;
574
575     RegisterAST thePC = RegisterAST(
576         Dyninst::MachRegister::getPC(parse_img()->codeObject()->cs()->getArch()));
577
578     Expression::Ptr callTarget = lastCall->getControlFlowTarget();
579     if( !callTarget.get() ) {
580         logLine("failed to find global destructor function\n");
581         return NULL;
582     }
583     callTarget->bind(&thePC, Result(s64, callAddress));
584
585     Result actualTarget = callTarget->eval();
586     if( actualTarget.defined ) {
587         dtorAddress = actualTarget.convert<Address>();
588     }else{
589         logLine("failed to find global destructor function\n");
590         return NULL;
591     }
592
593     if( !dtorAddress || !parse_img()->codeObject()->cs()->isValidAddress(dtorAddress) ) {
594         logLine("invalid address for global destructor function\n");
595         return NULL;
596     }
597
598     // A targ stub should have been created at the address
599     func_instance *ret = NULL;
600     if( (ret = findFuncByEntry(dtorAddress)) == NULL ) {
601         logLine("unable to find global destructor function\n");
602         return NULL;
603     }
604     inst_printf("%s[%d]: set global destructor address to 0x%lx\n", FILE__, __LINE__,
605             dtorAddress);
606
607     return ret;
608 }
609
610 #endif