Add 'Region' lookup to find regions of the binary mapped into the address space
[dyninst.git] / symtabAPI / src / Object-elf.h
1 /*
2  * Copyright (c) 1996-2007 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  * $Id: Object-elf.h,v 1.10 2007/12/04 18:05:53 legendre Exp $
34  * Object-elf.h: Object class for ELF file format
35 ************************************************************************/
36
37
38 #if !defined(_Object_elf_h_)
39 #define _Object_elf_h_
40
41
42 #include "symtabAPI/h/Symbol.h"
43 #include "common/h/Types.h"
44 #include <elf.h>
45 #include <libelf.h>
46
47 #include "Elf_X.h"
48
49 #include <libelf.h>
50 #include <fcntl.h>
51 #include <stdlib.h>
52 #include <unistd.h>
53
54 #include <sys/types.h>
55 #include <sys/mman.h>
56 #include <sys/stat.h>
57
58 namespace Dyninst{
59 namespace SymtabAPI{
60 /*
61  * The standard symbol table in an elf file is the .symtab section. This section does
62  * not have information to find the module to which a global symbol belongs, so we must
63  * also read the .stab section to get this info.
64  */
65
66 // Declarations for the .stab section.
67 // These are not declared in any system header files, so we must provide our own
68 // declarations. The declarations below were taken from:
69 //       SPARCWorks 3.0.x Debugger Interface, July 1994
70 // 
71 struct stab32 {
72     unsigned int name;  // stabstr table index for this symbol
73     unsigned char type; // type of this symbol
74     unsigned char other;
75     unsigned short desc;
76     unsigned int val;   // value of this symbol -- usually zero. The real value must
77                         // be obtained from the symtab section
78 };
79 struct stab64 {
80     // XXX ELF stabs are currently not implementing actual 64-bit support
81     //     on AMD-64, for which this separation was introduced. Until we
82     //     start seeing stab records with fields of the appropriate length,
83     //     we should assume the smaller records.
84     //unsigned long name; // stabstr table index for this symbol
85     unsigned int name; // stabstr table index for this symbol
86     unsigned char type; // type of this symbol
87     unsigned char other;
88     unsigned short desc;
89     //unsigned long val;
90     unsigned int val;  // value of this symbol -- usually zero. The real value must
91                         // be obtained from the symtab section
92 };
93
94 // 
95 // Extended to a class for 32/64-bit stab entries at runtime. - Ray
96 // 
97 class stab_entry {
98   public:
99     stab_entry(void *_stabptr = 0, const char *_stabstr = 0, long _nsyms = 0)
100         : stabptr(_stabptr), stabstr(_stabstr), nsyms(_nsyms) { }
101     virtual ~stab_entry() {};
102
103     virtual const char *name(int i) = 0;
104     virtual unsigned long nameIdx(int i) = 0;
105     virtual unsigned char type(int i) = 0;
106     virtual unsigned char other(int i) = 0;
107     virtual unsigned short desc(int i) = 0;
108     virtual unsigned long val(int i) = 0;
109
110     unsigned long count() { return nsyms; }
111     void setStringBase(const char *ptr) { stabstr = const_cast<char *>(ptr); }
112     const char *getStringBase() { return stabstr; }
113
114   protected:
115     void *stabptr;
116     const char *stabstr;
117     long nsyms;
118 };
119
120 class stab_entry_32 : public stab_entry {
121   public:
122     stab_entry_32(void *_stabptr = 0, const char *_stabstr = 0, long _nsyms = 0)
123         : stab_entry(_stabptr, _stabstr, _nsyms) { }
124     virtual ~stab_entry_32() {};
125
126     const char *name(int i = 0) { return stabstr + ((stab32 *)stabptr)[i].name; }
127     unsigned long nameIdx(int i = 0) { return ((stab32 *)stabptr)[i].name; }
128     unsigned char type(int i = 0) { return ((stab32 *)stabptr)[i].type; }
129     unsigned char other(int i = 0) { return ((stab32 *)stabptr)[i].other; }
130     unsigned short desc(int i = 0) { return ((stab32 *)stabptr)[i].desc; }
131     unsigned long val(int i = 0) { return ((stab32 *)stabptr)[i].val; }
132 };
133
134 class stab_entry_64 : public stab_entry {
135   public:
136     stab_entry_64(void *_stabptr = 0, const char *_stabstr = 0, long _nsyms = 0)
137         : stab_entry(_stabptr, _stabstr, _nsyms) { }
138     virtual ~stab_entry_64() {};
139
140     const char *name(int i = 0) { return stabstr + ((stab64 *)stabptr)[i].name; }
141     unsigned long nameIdx(int i = 0) { return ((stab64 *)stabptr)[i].name; }
142     unsigned char type(int i = 0) { return ((stab64 *)stabptr)[i].type; }
143     unsigned char other(int i = 0) { return ((stab64 *)stabptr)[i].other; }
144     unsigned short desc(int i = 0) { return ((stab64 *)stabptr)[i].desc; }
145     unsigned long val(int i = 0) { return ((stab64 *)stabptr)[i].val; }
146 };
147
148 // Types 
149 #define N_UNDF  0x00 /* start of object file */
150 #define N_GSYM  0x20 /* global symbol */
151 #define N_FUN   0x24 /* function or procedure */
152 #define N_STSYM 0x26 /* initialized static symbol */
153 #define N_LCSYM 0x28 /* unitialized static symbol */
154 #define N_ROSYM 0x2c /* read-only static symbol */
155 #define N_OPT   0x3c /* compiler options */
156 #define N_ENDM  0x62 /* end module */
157 #define N_SO    0x64 /* source directory and file */
158 #define N_ENTRY 0xa4 /* fortran alternate subroutine entry point */
159 #define N_BCOMM 0xe2 /* start fortran named common block */
160 #define N_ECOMM 0xe4 /* start fortran named common block */
161
162 // Language code -- the desc field in a N_SO entry is a language code
163 #define N_SO_AS      1 /* assembler source */
164 #define N_SO_C       2 /* K & R C source */
165 #define N_SO_ANSI_C  3 /* ANSI C source */
166 #define N_SO_CC      4 /* C++ source */
167 #define N_SO_FORTRAN 5 /* fortran source */
168 #define N_SO_PASCAL  6 /* Pascal source */
169 #define N_SO_F90     7 /* Fortran90 source */
170
171 //line information data
172 #define N_SLINE  0x44 /* line number in text segment */
173 #define N_SOL    0x84 /* name of the include file*/
174
175 // Symbol descriptors
176 // The format of a name is "<name>:<symbol descriptor><rest of name>
177 // The following are the descriptors of interest
178 #define SD_GLOBAL_FUN 'F' /* global function or procedure */
179 #define SD_PROTOTYPE  'P'  /* function prototypes */
180 #define SD_GLOBAL_VAR 'G' /* global variable */
181
182 // end of stab declarations
183
184 class pdElfShdr;
185
186 class Symtab;
187 class Section;
188
189 class Object : public AObject {
190  public:
191   Object(){}
192   //void findMain( std::vector< Symbol *> &allsymbols );
193   //Offset findDynamic( std::vector< Symbol *> &allsymbols );
194   // "Filedescriptor" ctor
195   Object(std::string &filename, void (*)(const char *) = log_msg);
196   Object(char *mem_image, size_t image_size, void (*)(const char *) = log_msg);
197   Object(const Object &);
198   virtual ~Object();
199   const Object& operator=(const Object &);
200
201   bool emitDriver(Symtab *obj, std::string fName, std::vector<Symbol *>&functions, std::vector<Symbol *>&variables, std::vector<Symbol *>&mods, std::vector<Symbol *>&notypes, unsigned flag);
202   
203   const char *elf_vaddr_to_ptr(Offset vaddr) const;
204   bool hasStabInfo() const { return ! ( !stab_off_ || !stab_size_ || !stabstr_off_ ); }
205   bool hasDwarfInfo() const { return dwarvenDebugInfo; }
206   stab_entry * get_stab_info() const;
207   const char * getFileName() const { return fileName; }
208   void getModuleLanguageInfo(hash_map<std::string, supportedLanguages> *mod_langs);
209   void parseFileLineInfo();
210   void parseTypeInfo(Symtab *obj);
211   bool getMappedRegions(std::vector<Region> &regs) const;
212
213   bool needs_function_binding() const { return (plt_addr_ > 0); } 
214   bool get_func_binding_table(std::vector<relocationEntry> &fbt) const;
215   bool get_func_binding_table_ptr(const std::vector<relocationEntry> *&fbt) const;
216
217   //getLoadAddress may return 0 on shared objects
218   Offset getLoadAddress() const { return loadAddress_; }
219
220   Offset getEntryAddress() const { return entryAddress_; }
221   // To be changed later - Giri
222   Offset getBaseAddress() const { return 0; }
223   static bool truncateLineFilenames;
224  
225   virtual char *mem_image() const { 
226         if(fileName == NULL)
227                 return mem_image_;
228         return file_ptr_; 
229   }
230
231   DLLEXPORT ObjectType objType() const;
232   const char *interpreter_name() const;
233
234
235 //TODO Later - change this #ifdef later.. make getTOCoffset available for all platforms  
236
237 #if defined(arch_ia64)
238   Offset getTOCoffset() const { return gp; }
239 #elif defined(os_linux) && defined(arch_power) && defined(arch_64bit)
240   // 64-bit PowerPC ELF ABI Supplement, Version 1.9, 2004-10-23:
241   //   The TOC section contains a conventional ELF GOT, and may optionally
242   //   contain a small data area.
243   //   The TOC base is typically the first address in the TOC plus 0x8000.
244   // I don't understand why I can find a ".got" within binaries, but I can't
245   // find a ".toc".  ssuen  August 7, 2007
246   Offset getTOCoffset() const { return got_addr_ + 0x8000; }
247 #else
248   Offset getTOCoffset() const { return 0; }
249 #endif
250
251   const std::ostream &dump_state_info(std::ostream &s);
252   bool isEEL() { return EEL; }
253
254         //to determine if a mutation falls in the text section of
255         // a shared library
256         bool isinText(Offset addr, Offset baseaddr) const { 
257                 //printf(" baseaddr %x TESTING %x %x \n", baseaddr, text_addr_ + baseaddr  , text_addr_ + baseaddr + text_size_ );
258                 if(addr > text_addr_ + baseaddr     &&
259                    addr < text_addr_ + baseaddr + text_size_ ) {
260                         return true;
261                 }
262                 return false;
263         } 
264         // to determine where in the .plt this function is listed 
265         // returns an offset from the base address of the object
266         // so the entry can easily be located in memory
267         Offset getPltSlot(std::string funcName) const ;
268         bool hasSymAtAddr( Offset adr )
269         {
270             return (symbolNamesByAddr.find( adr )!=symbolNamesByAddr.end());
271         }
272         Offset textAddress(){ return text_addr_;}
273         bool isText( Offset addr ) const
274         {
275             if( addr >= text_addr_ && addr <= text_addr_ + text_size_ )
276                 return true;
277             return false;
278         }
279
280         bool is_offset_in_plt(Offset offset) const;
281         hash_map<std::string, LineInformation > &getLineInfo()
282         {
283             //Parse Line Info
284             parseFileLineInfo();
285                    
286             return lineInfo_;
287         }
288
289  private:
290   static void log_elferror (void (*)(const char *), const char *);
291     
292   int       file_fd_;            // mapped ELF file
293   unsigned  file_size_;          // mapped ELF file
294   char     *file_ptr_;           // mapped ELF file
295   Elf_X    elfHdr;
296   
297   const char * fileName;
298   char *mem_image_;
299   //Symbol    mainSym_;
300   Offset   fini_addr_;
301   Offset   text_addr_;   //.text section 
302   Offset   text_size_;   //.text section size
303   Offset   dynamic_addr_;        //.dynamic section
304   Offset   dynsym_addr_;        // .dynsym section
305   Offset   dynstr_addr_;        // .dynstr section
306   Offset   got_addr_;           // global offset table
307   unsigned  got_size_;           // global offset table
308   Offset   plt_addr_;           // procedure linkage table
309   unsigned  plt_size_;           // procedure linkage table
310   unsigned  plt_entry_size_;     // procedure linkage table
311   Offset   rel_plt_addr_;       // .rel[a].plt section
312   unsigned  rel_plt_size_;       // .rel[a].plt section
313   unsigned  rel_plt_entry_size_; // .rel[a].plt section
314
315   Offset   stab_off_;           // .stab section
316   unsigned  stab_size_;          // .stab section
317   Offset   stabstr_off_;        // .stabstr section
318
319   Offset   stab_indx_off_;       // .stab.index section
320   unsigned  stab_indx_size_;     // .stab.index section
321   Offset   stabstr_indx_off_;    // .stabstr.index section
322
323   bool      dwarvenDebugInfo;    // is DWARF debug info present?
324   Offset   loadAddress_;      // The object may specify a load address
325                                //   Set to 0 if it may load anywhere
326   Offset entryAddress_;
327   char *interpreter_name_;
328   bool  isStripped;
329           
330 #if defined(arch_ia64)
331   Offset   gp;                   // The gp for this object.
332 #endif
333   bool      EEL;                 // true if EEL rewritten
334   bool      did_open;           // true if the file has been mmapped
335   ObjectType obj_type_;
336
337   // for sparc-solaris this is a table of PLT entry addr, function_name
338   // for x86-solaris this is a table of GOT entry addr, function_name
339   // on sparc-solaris the runtime linker modifies the PLT entry when it
340   // binds a function, on X86 the PLT entry is not modified, but it uses
341   // an indirect jump to a GOT entry that is modified when the function 
342   // is bound....is this correct???? or should it be <PLTentry_addr, name> 
343   // for both?
344   std::vector<relocationEntry> relocation_table_;
345
346   // all section headers, sorted by address
347   // we use these to do a better job of finding the end of symbols
348   std::vector<Elf_X_Shdr*> allSectionHdrs;
349
350   // It doesn't look like image's equivalent hashtable is built by
351   // the time we need it, and it's hard to get to anyway.
352   hash_map< Offset, std::string > symbolNamesByAddr;
353
354   // LineNumber information
355   hash_map< std::string, LineInformation>lineInfo_;
356
357   // populates: file_fd_, file_size_, file_ptr_
358   bool mmap_file(const char *file, 
359                  bool &did_open, bool &did_mmap);
360
361   bool loaded_elf( Offset &, Offset &,
362                     Elf_X_Shdr* &, Elf_X_Shdr* &, 
363                     Elf_X_Shdr* &, Elf_X_Shdr* &, 
364                     Elf_X_Shdr* &, Elf_X_Shdr* &,
365                     Elf_X_Shdr*& rel_plt_scnp, Elf_X_Shdr*& plt_scnp, 
366                     Elf_X_Shdr*& got_scnp,  Elf_X_Shdr*& dynsym_scnp,
367                     Elf_X_Shdr*& dynstr_scnp, Elf_X_Shdr*& eh_frame,
368                     Elf_X_Shdr*& gcc_except, Elf_X_Shdr *& interp_scnp,
369           bool a_out=false);
370   
371   void parseStabFileLineInfo();
372   void parseDwarfFileLineInfo();
373
374   void parseDwarfTypes(Symtab *obj);
375   void parseStabTypes(Symtab *obj);
376
377   void load_object();
378   void load_shared_object();
379
380   // initialize relocation_table_ from .rel[a].plt section entries 
381   bool get_relocation_entries(Elf_X_Shdr *&rel_plt_scnp,
382                               Elf_X_Shdr *&dynsym_scnp, 
383                               Elf_X_Shdr *&dynstr_scnp);
384
385   void parse_symbols(std::vector<Symbol *> &allsymbols, 
386                      Elf_X_Data &symdata, Elf_X_Data &strdata,
387                      bool shared_library,
388                      std::string module);
389   
390   void fix_zero_function_sizes(std::vector<Symbol *> &allsymbols, bool EEL);
391   void override_weak_symbols(std::vector<Symbol *> &allsymbols);
392   void insert_symbols_shared(std::vector<Symbol *> &allsymbols);
393   void find_code_and_data(Elf_X &elf,
394        Offset txtaddr, Offset dataddr);
395   void insert_symbols_static(std::vector<Symbol *> &allsymbols);
396   bool fix_global_symbol_modules_static_stab(Elf_X_Shdr *stabscnp,
397                                              Elf_X_Shdr *stabstrscnp);
398   bool fix_global_symbol_modules_static_dwarf(Elf_X &elf);
399
400   void get_valid_memory_areas(Elf_X &elf);
401
402 #if defined(os_irix)
403
404  public:
405   Offset     get_gp_value()  const { return gp_value; }
406   Offset     get_rbrk_addr() const { return rbrk_addr; }
407   Offset     get_base_addr() const { return base_addr; }
408   const char *got_entry_name(Offset entry_off) const;
409   int         got_gp_disp(const char *entry_name) const;
410
411   Offset     MIPS_stubs_addr_;   // .MIPS.stubs section
412   Offset     MIPS_stubs_off_;    // .MIPS.stubs section
413   unsigned    MIPS_stubs_size_;   // .MIPS.stubs section
414   
415  private:
416   Offset     gp_value;
417   Offset     rbrk_addr;
418   Offset     base_addr;
419   
420   int         got_zero_index_;
421   int         dynsym_zero_index_;
422
423 #endif /* mips_sgi_irix6_4 */
424 };
425
426 //const char *pdelf_get_shnames(Elf *elfp, bool is64);
427
428 }//namespace SymtabAPI
429 }//namespace Dyninst
430
431 #endif /* !defined(_Object_elf_h_) */