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