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