Base tramp layout on PPC64 was horribly, tragically, awfully wrong. Fixed.
[dyninst.git] / symtabAPI / src / emitElfStatic.C
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 /*
32  * XXX
33  *
34  * This class is unnecessary. However, at the time of writing, emitElf was
35  * split into two different classes (one for 32-bit and 64-bit). Instead of
36  * duplicating code, this class was created to share code between the
37  * two emitElf classes.
38  *
39  * Once the emitElf classes are merged, this class can be merged with the new
40  * emitElf class.
41  */
42
43 #include <cstdlib>
44 #include <cstdio>
45 #include <iostream>
46
47 #include <algorithm>
48
49 #include "emitElfStatic.h"
50 #include "debug.h"
51
52 #if defined(os_freebsd)
53 #define R_X86_64_JUMP_SLOT R_X86_64_JMP_SLOT
54 #endif
55
56 using namespace Dyninst;
57 using namespace SymtabAPI;
58
59 // Section names
60 static const string CODE_NAME(".dyninstCode");
61 static const string STUB_NAME(".dyninstStub");
62 static const string DATA_NAME(".dyninstData");
63 static const string BSS_NAME(".dyninstBss");
64 // DISABLED #if defined(arch_power) && defined(arch_64bit)
65 // We do GOT replacement...
66 //static const string GOT_NAME(".got");
67 //#else
68 static const string GOT_NAME(".dyninstGot");
69 //#endif
70 static const string CTOR_NAME(".dyninstCtors");
71 static const string DTOR_NAME(".dyninstDtors");
72 static const string TLS_DATA_NAME(".dyninstTdata");
73 static const string DEFAULT_COM_NAME(".common");
74
75 /* Used by architecture specific functions, but not architecture specific */
76 const string Dyninst::SymtabAPI::SYMTAB_CTOR_LIST_REL("__SYMTABAPI_CTOR_LIST__");
77 const string Dyninst::SymtabAPI::SYMTAB_DTOR_LIST_REL("__SYMTABAPI_DTOR_LIST__");
78
79 emitElfStatic::emitElfStatic(unsigned addressWidth, bool isStripped) :
80     addressWidth_(addressWidth),
81     isStripped_(isStripped),
82     hasRewrittenTLS_(false)
83 {}
84
85 /**
86  * NOTE:
87  * Most of these functions take a reference to a StaticLinkError and a string
88  * for error reporting purposes. These should prove useful in identifying the
89  * cause of an error
90  */
91
92 /**
93  * Statically links relocatable files into the specified Symtab object, 
94  * as specified by state in the Symtab object
95  *
96  * target       relocatable files will be linked into this Symtab
97  *
98  * Returns a pointer to a block of data containing the results of the link
99  * The caller is responsible for delete'ing this block of data
100  */
101 char *emitElfStatic::linkStatic(Symtab *target, 
102         StaticLinkError &err, string &errMsg) 
103 {
104     /* 
105      * Basic algorithm is:
106      * - locate defined versions of symbols for undefined symbols in 
107      *   either the target or relocatable code, produces a list
108      *   of Symtab objects that contain the defined versions
109      *
110      * - Allocate space for all new code and data to be linked into 
111      *   the target, populates a LinkMap with all allocation 
112      *   information
113      *
114      * - Compute relocations and set their targets to these values
115      */
116
117     // Holds all information necessary to work with the block of data created by createLinkMap
118     LinkMap lmap;
119
120     rewrite_printf("START link map output\n");
121     
122     // Determine starting location of new Regions
123     Offset globalOffset = 0;
124     vector<Region *> newRegs;
125     if( target->getAllNewRegions(newRegs) ) {
126         // This is true, only if other regions have already been added
127         vector<Region *>::iterator newReg_it;
128         for(newReg_it = newRegs.begin(); newReg_it != newRegs.end(); ++newReg_it) {
129             Offset newRegEndAddr = (*newReg_it)->getMemSize() + (*newReg_it)->getDiskOffset();
130             if( newRegEndAddr > globalOffset ) {
131                 globalOffset = newRegEndAddr;
132             }
133         }
134     }
135
136     if( globalOffset == 0 ) {
137         err = Link_Location_Error;
138         errMsg = "failed to find location for new code and data.";
139         return NULL;
140     }
141
142     // Holds all necessary dependencies, as determined by resolveSymbols
143     vector<Symtab *> relocatableObjects;
144     if( !resolveSymbols(target, relocatableObjects, lmap, err, errMsg) ) {
145         return NULL;
146     }
147
148     // Lays out all relocatable files into a single contiguous block of data
149     if( !createLinkMap(target, relocatableObjects, globalOffset, lmap, err, errMsg) ) {
150         return NULL;
151     }
152
153     // Copies the data from the relocatable files into the new block of data
154     if( !addNewRegions(target, globalOffset, lmap) ) {
155         err = Storage_Allocation_Failure;
156         errMsg = "Failed to create new Regions in original binary";
157         return NULL;
158     }
159
160     if (!updateTOC(target, lmap, globalOffset)) {
161       return NULL;
162     }
163
164     // Print out the link map for debugging
165     rewrite_printf("Global Offset = 0x%lx\n", globalOffset);
166     if( sym_debug_rewrite ) {
167         lmap.printAll(cerr, globalOffset);
168         lmap.printBySymtab(cerr, relocatableObjects, globalOffset);
169     }
170
171     // Now that all symbols are at their final locations, compute and apply relocations
172     if( !applyRelocations(target, relocatableObjects, globalOffset, lmap, err, errMsg) ) {
173         if( lmap.allocatedData ) delete lmap.allocatedData;
174         return NULL;
175     }
176
177     // Restore the offset of the modified symbols
178     vector< pair<Symbol *, Offset> >::iterator symOff_it;
179     for(symOff_it = lmap.origSymbols.begin();
180         symOff_it != lmap.origSymbols.end();
181         ++symOff_it)
182     {
183         symOff_it->first->setOffset(symOff_it->second);
184     }
185
186     // Restore the symbols of the modified relocations
187    vector< pair<relocationEntry *, Symbol *> >::iterator relSym_it;
188    for(relSym_it = lmap.origRels.begin();
189        relSym_it != lmap.origRels.end();
190        ++relSym_it)
191    {
192        relSym_it->first->addDynSym(relSym_it->second);
193    }
194
195     rewrite_printf("\n*** Finished static linking\n\n");
196
197     rewrite_printf("END link map output\n");
198
199     err = No_Static_Link_Error;
200     errMsg = "";
201     return lmap.allocatedData;
202 }
203
204 /**
205  * Resolves undefined symbols in the specified Symtab object, usually due
206  * to the addition of new Symbols to the Symtab object. The target Symtab
207  * object must have a collection of Archives associated with it. These
208  * Archives will be searched for the defined versions of the undefined 
209  * symbols in the specified Symtab objects.
210  *
211  * target               the Symtab containing the undefined symbols
212  * relocatableObjects   populated by this function, this collection specifies
213  *                      all the Symtabs needed to ensure that the target has
214  *                      no undefined Symbols once the link is performed
215  */
216 bool emitElfStatic::resolveSymbols(Symtab *target, 
217         vector<Symtab *> &relocatableObjects,
218         LinkMap &lmap,
219         StaticLinkError &err, string &errMsg) 
220 {
221     // Collection of Symtabs that currently need their symbols resolved
222     set<Symtab *> workSet;
223
224     // Collection of Symtabs that have already had their symbols resolved
225     // this is necessary to avoid errors related to circular dependencies
226     set<Symtab *> linkedSet;
227
228     set<string> excludeSymNames;
229     getExcludedSymbolNames(excludeSymNames);
230
231     // Establish list of libraries to search for symbols
232     vector<Archive *> libraries;
233     target->getLinkingResources(libraries);
234
235     // Add all relocatable files explicitly referenced by new symbols, these
236     // essentially fuel the symbol resolution process
237     set<Symtab *> explicitRefs;
238     target->getExplicitSymtabRefs(explicitRefs);
239
240     set<Symtab *>::iterator expObj_it;
241     for(expObj_it = explicitRefs.begin(); expObj_it != explicitRefs.end();
242             ++expObj_it) 
243     {
244         relocatableObjects.push_back(*expObj_it);
245         workSet.insert(*expObj_it);
246         linkedSet.insert(*expObj_it);
247     }
248
249     set<Symtab *>::iterator curObjFilePtr = workSet.begin();
250     while( curObjFilePtr != workSet.end() ) {
251         // Take a relocatable file off the working set
252         Symtab *curObjFile = *curObjFilePtr;
253         workSet.erase(curObjFile);
254
255         rewrite_printf("\n*** Resolving symbols for: %s\n\n",
256                 curObjFile->memberName().c_str());
257
258         // Build the map of symbols to their relocations
259         map<Symbol *, vector<relocationEntry *> > symToRels;
260         vector<Region *> allRegions;
261         curObjFile->getAllRegions(allRegions);
262
263         vector<Region *>::iterator region_it;
264         for(region_it = allRegions.begin(); region_it != allRegions.end();
265                 ++region_it)
266         {
267             vector<relocationEntry> &region_rels = (*region_it)->getRelocations();
268             vector<relocationEntry>::iterator rel_it;
269             for( rel_it = region_rels.begin(); rel_it != region_rels.end(); ++rel_it) {
270                 symToRels[rel_it->getDynSym()].push_back(&(*rel_it));
271                 lmap.origRels.push_back(make_pair(&(*rel_it), rel_it->getDynSym()));
272             }
273         }
274
275         // Iterate over all undefined symbols, attempting to resolve them
276         vector<Symbol *> undefSyms;
277         curObjFile->getAllUndefinedSymbols(undefSyms);
278
279         vector<Symbol *>::iterator undefSym_it;
280         for(undefSym_it = undefSyms.begin(); undefSym_it != undefSyms.end();
281                 ++undefSym_it) 
282         {
283             Symbol *curUndefSym = *undefSym_it;
284
285             // Skip symbols that are don't cares
286             if( excludeSymNames.count(curUndefSym->getPrettyName()) ) continue;
287
288             if( !checkSpecialCaseSymbols(curObjFile, curUndefSym) ) {
289                 err = Symbol_Resolution_Failure;
290                 errMsg = "special case check failed for symbol: " +
291                     curUndefSym->getMangledName();
292                 return false;
293             }
294
295             Symbol *extSymbol = NULL;
296
297             // First, attempt to search the target for the symbol
298             if( !isStripped_ ) {
299                  vector<Symbol *> foundSyms;
300                  if( target->findSymbol(foundSyms, curUndefSym->getMangledName(),
301                     curUndefSym->getType()) )
302                  {
303                     if( foundSyms.size() > 1 ) {
304                         err = Symbol_Resolution_Failure;
305                         errMsg = "ambiguous symbol definition: " + 
306                             curUndefSym->getMangledName();
307                         return false;
308                     }
309
310                     extSymbol = foundSyms[0];
311
312                     rewrite_printf("Found external symbol %s in target with address = 0x%lx\n",
313                             extSymbol->getPrettyName().c_str(), extSymbol->getOffset());
314                  }
315             }
316
317             if( extSymbol == NULL ) {
318                 // search loaded libraries and add any new reloctable files
319                 vector<Archive *>::iterator lib_it;
320                 Symtab *containingSymtab = NULL;
321                 for(lib_it = libraries.begin(); lib_it != libraries.end(); ++lib_it) {
322                     Symtab *tmpSymtab;
323                     if( (*lib_it)->getMemberByGlobalSymbol(tmpSymtab, 
324                                 const_cast<string&>(curUndefSym->getMangledName())) ) 
325                     {
326                         /** 
327                          * The GNU approach is to use the symbol that is defined first
328                          * in the list of libraries (in the order specified to the linker)
329                          *
330                          * I am choosing to use that same behavior here.
331                          */
332                         containingSymtab = tmpSymtab;
333                         break;
334                     }else{
335                         /* Regarding duplicate symbols in Archives:
336                          *
337                          * gcc/ld appear to ignore the case where an Archive
338                          * contains the same symbol in different members and
339                          * chooses the symbol that occurs first in the
340                          * Archive's symbol table. This could produce
341                          * unexpected results so it is better to alert the user
342                          * of this error
343                          */
344                         if( Archive::getLastError() == Duplicate_Symbol ) {
345                             err = Symbol_Resolution_Failure;
346                             errMsg = Archive::printError(Duplicate_Symbol);
347                             return false;
348                         }
349                     }
350                 }
351
352                 if( containingSymtab != NULL ) {
353                     vector<Symbol *> foundSyms;
354                     if( containingSymtab->findSymbol(foundSyms, curUndefSym->getMangledName(),
355                         curUndefSym->getType()) )
356                     {
357                         if( foundSyms.size() > 1 ) {
358                             err = Symbol_Resolution_Failure;
359                             errMsg = "ambiguous symbol definition: " + 
360                                 curUndefSym->getMangledName();
361                             return false;
362                         }
363
364                         extSymbol = foundSyms[0];
365                         if( !linkedSet.count(containingSymtab) ) {
366                             // Consistency check 
367                             if( containingSymtab->getAddressWidth() != addressWidth_ ) {
368                                 err = Symbol_Resolution_Failure;
369                                 errMsg = "symbol (" + curUndefSym->getMangledName() +
370                                     ") found in relocatable file that is not compatible"
371                                     + " with the target binary";
372                                 return false;
373                             }
374
375                             relocatableObjects.push_back(containingSymtab);
376
377                             // Resolve all symbols for this new Symtab, if it hasn't already
378                             // been done
379
380                             workSet.insert(containingSymtab);
381                             linkedSet.insert(containingSymtab);
382                         }
383
384                         rewrite_printf("Found external symbol %s in object %s(%s)\n",
385                                 extSymbol->getPrettyName().c_str(),
386                                 containingSymtab->getParentArchive()->name().c_str(),
387                                 containingSymtab->memberName().c_str());
388                     }else{
389                         err = Symbol_Resolution_Failure;
390                         errMsg = "inconsistency found between archive's symbol table and member's symbol table";
391                         return false;   
392                     }
393                 }
394             }
395
396             if( extSymbol == NULL ) {
397                 // If it is a weak symbol, it isn't an error that the symbol wasn't resolved
398                 if( curUndefSym->getLinkage() == Symbol::SL_WEAK ) {
399                     continue;
400                 }
401
402                 err = Symbol_Resolution_Failure;
403                 errMsg = "failed to locate symbol '" + curUndefSym->getMangledName()
404                     + "' for object '" + curObjFile->memberName() + "'";
405 rewrite_printf(" failed to locate symbol %s for %s  \n" , curUndefSym->getMangledName().c_str(), curObjFile->memberName().c_str());
406                 continue;
407                 //return false;
408             }
409
410             // Store the found symbol with the related relocations
411             map<Symbol *, vector<relocationEntry *> >::iterator relMap_it;
412             relMap_it = symToRels.find(curUndefSym);
413             if( relMap_it != symToRels.end() ) {
414                 vector<relocationEntry *>::iterator rel_it;
415                 for(rel_it = relMap_it->second.begin(); rel_it != relMap_it->second.end();
416                         ++rel_it)
417                 {
418                     (*rel_it)->addDynSym(extSymbol);
419                 }
420             }   /* else
421                  *
422                  * Some libraries define a reference to a symbol and then never
423                  * use it in order to ensure that the object that defines the
424                  * symbol is linked. Therefore, it is not an error if a symbol doesn't
425                  * have a relocation.
426                  */
427         }
428
429         curObjFilePtr = workSet.begin();
430     }
431     
432     return true;
433 }
434
435 /**
436  * Given a collection of Symtab objects, combines the code, data, bss and
437  * other miscellaneous Regions into groups and places them in a new block
438  * of data.
439  * 
440  * Allocates COMMON symbols in the collection of Symtab objects
441  * as bss
442  *
443  * Creates a new TLS initialization image, combining the target image
444  * and the image that exists in the collection of Symtab objects
445  *
446  * Creates a GOT used for indirect memory accesses that is required by some
447  * relocations
448  *
449  * Creates a new global constructor and/or destructor table if necessary,
450  * combining tables from the target and collection of Symtab objects
451  *
452  * target               New code/data/etc. will be linked into this Symtab
453  * relocatableObjects   The new code/data/etc.
454  * globalOffset         The location of the new block of data in the target
455  * lmap                 The LinkMap to be populated by this function
456  */
457 bool emitElfStatic::createLinkMap(Symtab *target,
458         vector<Symtab *> &relocatableObjects, 
459         Offset & globalOffset, 
460         LinkMap &lmap,
461         StaticLinkError &err, string &errMsg) 
462 {
463     rewrite_printf("\n*** Allocating storage for relocatable objects\n\n");
464
465     // Used to create a new COMMON block
466     multimap<Offset, Symbol *> commonAlignments;
467     Offset commonRegionAlign = 0;
468
469     // Collect all Regions that should be allocated in the new data block
470     vector<Symtab *>::iterator obj_it;
471     for(obj_it = relocatableObjects.begin(); obj_it != relocatableObjects.end(); ++obj_it) {
472         vector<Region *> regs;
473         if( !(*obj_it)->getAllRegions(regs) ) {
474             err = Storage_Allocation_Failure;
475             errMsg = "failed to locate regions in relocatable object";
476             return false;
477         }
478
479         vector<Region *>::iterator reg_it;
480         for(reg_it = regs.begin(); reg_it != regs.end(); ++reg_it) {
481             string regionName = (*reg_it)->getRegionName();
482             if( (*reg_it)->isLoadable() && (*reg_it)->getMemSize() > 0) {
483                 if( (*reg_it)->isTLS() ) {
484                     switch((*reg_it)->getRegionType()) {
485                         case Region::RT_DATA:
486                         case Region::RT_BSS:
487                             lmap.tlsRegions.push_back(*reg_it);
488                             // Determine alignment of combined region
489                             if( (*reg_it)->getMemAlignment() > lmap.tlsRegionAlign ) {
490                                 lmap.tlsRegionAlign = (*reg_it)->getMemAlignment();
491                             }
492                             break;
493                         default:
494                             // ignore any other regions
495                             break;
496                     }
497                 }else if( isConstructorRegion(*reg_it) ) {
498                     lmap.newCtorRegions.push_back(*reg_it);
499                     if( (*reg_it)->getMemAlignment() > lmap.ctorRegionAlign ) {
500                         lmap.ctorRegionAlign = (*reg_it)->getMemAlignment();
501                     }
502                 }else if( isDestructorRegion(*reg_it) ) {
503                     lmap.newDtorRegions.push_back(*reg_it);
504                     if( (*reg_it)->getMemAlignment() > lmap.dtorRegionAlign ) {
505                         lmap.dtorRegionAlign = (*reg_it)->getMemAlignment();
506                     }
507                 } else if( isGOTRegion(*reg_it) ) {
508                   lmap.gotRegions.push_back(*reg_it);
509                   if( (*reg_it)->getMemAlignment() > lmap.gotRegionAlign ) {
510                     lmap.gotRegionAlign = (*reg_it)->getMemAlignment();
511                   }
512                 }else{
513                     switch((*reg_it)->getRegionType()) {
514                         case Region::RT_TEXT:
515                             lmap.codeRegions.push_back(*reg_it);
516                             // Determine alignment of combined region
517                             if( (*reg_it)->getMemAlignment() > lmap.codeRegionAlign ) {
518                                 lmap.codeRegionAlign = (*reg_it)->getMemAlignment();
519                             }
520                             break;
521                         case Region::RT_DATA:
522                             lmap.dataRegions.push_back(*reg_it);
523                             // Determine alignment of combined region
524                             if( (*reg_it)->getMemAlignment() > lmap.dataRegionAlign ) {
525                                 lmap.dataRegionAlign = (*reg_it)->getMemAlignment();
526                             }
527
528                             break;
529                         case Region::RT_BSS:
530                             lmap.bssRegions.push_back(*reg_it);
531                             // Determine alignment of combined region
532                             if( (*reg_it)->getMemAlignment() > lmap.bssRegionAlign ) {
533                                 lmap.bssRegionAlign = (*reg_it)->getMemAlignment();
534                             }
535                             break;
536                         case Region::RT_TEXTDATA:
537                             lmap.codeRegions.push_back(*reg_it);
538                             // Determine alignment of combined region
539                             if( (*reg_it)->getMemAlignment() > lmap.codeRegionAlign ) {
540                                 lmap.codeRegionAlign = (*reg_it)->getMemAlignment();
541                             }
542                             break;
543                         default:
544                             // skip other regions
545                             continue;
546                     }
547                 }
548
549                 // Find symbols that need to be put in the GOT
550
551 #if defined(arch_power) && defined(arch_64bit)
552                 // If statically linked binary, we need to put all the entries in region toc to GOT
553                 if(target->isStaticBinary() && (regionName.compare(".toc") == 0)) {
554                    // For every symbol in toc
555                    // Get data of the region and split it into symbols
556                    char *rawRegionData = reinterpret_cast<char *>((*reg_it)->getPtrToRawData());
557                    unsigned long numSymbols = (*reg_it)->getMemSize()/8;
558                    for (Offset entry = 0; entry < numSymbols; entry++ ) {       
559                       // If symbol has relocation, add that 
560                       bool relExist = false;
561                       vector<relocationEntry> &region_rels = (*reg_it)->getRelocations();
562                       vector<relocationEntry>::iterator rel_it;
563                       for( rel_it = region_rels.begin(); rel_it != region_rels.end(); ++rel_it) {
564                          if(entry*8 == rel_it->rel_addr()) {
565                             lmap.gotSymbolTable.push_back(make_pair(rel_it->getDynSym(), rel_it->addend()));  
566                             lmap.gotSymbols.insert(make_pair(rel_it->getDynSym(), rel_it->addend()));
567                             relExist = true;
568                             
569                             break;
570                          }
571                       }
572                       if(!relExist) {
573                          // else create a new symbol 
574                          // Offset and name is all we care - offset should be value of the symbol
575                          Offset soffset = *((unsigned long *) (rawRegionData + entry*8));
576                          Symbol *newsym = new Symbol("dyntoc_entry",
577                                                      Symbol::ST_UNKNOWN,
578                                                      Symbol::SL_UNKNOWN,
579                                                      Symbol::SV_UNKNOWN,
580                                                      soffset);
581                          
582                          lmap.gotSymbolTable.push_back(make_pair(newsym, 0));  
583                          lmap.gotSymbols.insert(make_pair(newsym, 0));
584                          
585                       }
586                    }
587                    
588                 }
589 #endif
590                 vector<relocationEntry> &region_rels = (*reg_it)->getRelocations();
591                 vector<relocationEntry>::iterator rel_it;
592                 for( rel_it = region_rels.begin(); rel_it != region_rels.end(); ++rel_it) {
593                   
594                   if(isGOTRelocation(rel_it->getRelType()) ) {
595                     lmap.gotSymbolTable.push_back(make_pair(rel_it->getDynSym(), rel_it->addend()));
596                     lmap.gotSymbols.insert(make_pair(rel_it->getDynSym(), 0));
597                     
598                   }
599                   
600                 }
601             } // isLoadable
602            
603         } //for regions
604
605         vector<Symbol *> definedSyms;
606         if( (*obj_it)->getAllDefinedSymbols(definedSyms) ) {
607             vector<Symbol *>::iterator sym_it;
608             for(sym_it = definedSyms.begin(); sym_it != definedSyms.end(); ++sym_it) {
609                 // Note: the assumption is made that a Symbol cannot 
610                 // be both TLS and COMMON
611                 if( (*sym_it)->isCommonStorage() ) {
612                     // For a symbol in common storage, the offset/value is the alignment
613                     commonAlignments.insert(make_pair((*sym_it)->getOffset(), *sym_it));
614
615                     // The alignment of a COMMON Region is the maximum alignment
616                     // needed by one of its symbols
617                     if( (*sym_it)->getOffset() > commonRegionAlign ) {
618                         commonRegionAlign = (*sym_it)->getOffset();
619                     }
620                 }else if( (*sym_it)->getType() == Symbol::ST_TLS ) {
621                     lmap.tlsSymbols.push_back(*sym_it);
622                 }
623             }
624         }
625     }
626
627     // Determine how all the Regions in the relocatable objects will be 
628     // placed in the rewritten target
629     Offset currentOffset = 0;
630
631     // Allocate code regions 
632
633     // Since this is the first new Region, the actual globalOffset should be 
634     // the passed globalOffset plus the padding for this Region
635     
636     Offset maxAlign = getGOTAlign(lmap);
637     if(maxAlign < lmap.codeRegionAlign) maxAlign = lmap.codeRegionAlign;
638
639     globalOffset += computePadding(globalOffset + currentOffset,
640             maxAlign);
641
642     // Allocate space for a GOT Region, if necessary
643     Offset gotLayoutOffset = 0;
644     lmap.gotSize = getGOTSize(target, lmap, gotLayoutOffset);
645     if( lmap.gotSize > 0 ) {
646       // We may copy the original GOT over; in this case, we have to be sure we skip it
647       // when we lay out new GOT entries. That's the gotLayoutOffset value. 
648         lmap.gotRegionAlign = getGOTAlign(lmap);
649         lmap.gotRegionOffset = currentOffset;
650         currentOffset += lmap.gotSize;
651         layoutRegions(lmap.gotRegions, lmap.regionAllocs,
652                       lmap.gotRegionOffset + gotLayoutOffset, globalOffset);
653         calculateTOCs(target, lmap.gotRegions, lmap.gotRegionOffset, gotLayoutOffset, globalOffset);
654     } 
655
656     // Calculate the space necessary for stub code; normally this will be 0,
657     // but we may need to add code later on. Make room for it now. 
658     // Note we use code region alignment here. 
659     lmap.stubRegionOffset = currentOffset;
660     lmap.stubRegionOffset += computePadding(globalOffset + lmap.stubRegionOffset,
661                                             lmap.codeRegionAlign);
662     rewrite_printf("Before allocStubRegions, currentOffset is 0x%lx\n", currentOffset);
663     currentOffset = allocStubRegions(lmap, globalOffset);
664     rewrite_printf("After allocStubRegions, currentOffset is 0x%lx\n", currentOffset);
665     if( currentOffset == ~0UL ) {
666         err = Storage_Allocation_Failure;
667         errMsg = "assumption failed while creating link map";
668         return false;
669     }
670     lmap.stubSize = currentOffset - lmap.stubRegionOffset;
671
672     lmap.codeRegionOffset = currentOffset;
673     lmap.codeRegionOffset += computePadding(globalOffset + lmap.codeRegionOffset,
674                                             lmap.codeRegionAlign);
675     currentOffset = layoutRegions(lmap.codeRegions, lmap.regionAllocs,
676                                   lmap.codeRegionOffset, globalOffset);
677     if( currentOffset == ~0UL ) {
678         err = Storage_Allocation_Failure;
679         errMsg = "assumption failed while creating link map";
680         return false;
681     }
682     lmap.codeSize = currentOffset - lmap.codeRegionOffset;
683
684     // Allocate data regions 
685     lmap.dataRegionOffset = currentOffset;
686     lmap.dataRegionOffset += computePadding(globalOffset + lmap.dataRegionOffset,
687             lmap.dataRegionAlign);
688     currentOffset = layoutRegions(lmap.dataRegions, lmap.regionAllocs, 
689             lmap.dataRegionOffset, globalOffset);
690     if( currentOffset == ~0UL ) {
691         err = Storage_Allocation_Failure;
692         errMsg = "assumption failed while creating link map";
693         return false;
694     }
695     lmap.dataSize = currentOffset - lmap.dataRegionOffset;
696
697     /* 
698      * Find current TLS Regions in target, also check for multiple TLS Regions
699      * of the same type => knowing how to construct the TLS image would be
700      * undefined for multiple TLS Regions of the same type
701      *
702      * Find current constructor Regions and destructor Regions.
703      */
704     Region *dataTLS = NULL, *bssTLS = NULL;
705     lmap.tlsSize = 0;
706     
707     vector<Region *> regions;
708     if( !target->getAllRegions(regions) ) {
709         err = Storage_Allocation_Failure;
710         errMsg = "failed to retrieve regions from target";
711         return false;
712     }
713     
714     vector<Region *>::iterator reg_it;
715     for(reg_it = regions.begin(); reg_it != regions.end(); ++reg_it) {
716         if( (*reg_it)->isTLS() ) {
717             if( (*reg_it)->getRegionType() == Region::RT_DATA ) {
718                 if( dataTLS != NULL ) {
719                     err = Storage_Allocation_Failure;
720                     errMsg = "found more than one TLS data region";
721                     return false;
722                 }
723                 dataTLS = *reg_it;
724                 lmap.tlsSize += dataTLS->getMemSize();
725                 if( dataTLS->getMemAlignment() > lmap.tlsRegionAlign ) {
726                     lmap.tlsRegionAlign = dataTLS->getMemAlignment();
727                 }
728             }else if( (*reg_it)->getRegionType() == Region::RT_BSS ) {
729                 if( bssTLS != NULL ) {
730                     err = Storage_Allocation_Failure;
731                     errMsg = "found more than one TLS bss region";
732                     return false;
733                 }
734                 bssTLS = *reg_it;
735                 lmap.tlsSize += bssTLS->getMemSize();
736                 if( bssTLS->getMemAlignment() > lmap.tlsRegionAlign ) {
737                     lmap.tlsRegionAlign = bssTLS->getMemAlignment();
738                 }
739             }
740         }else if( isConstructorRegion(*reg_it) ) {
741             lmap.originalCtorRegion = *reg_it;
742         }else if( isDestructorRegion(*reg_it) ){
743             lmap.originalDtorRegion = *reg_it;
744         }
745     }
746 #if defined(arch_x86) || defined(arch_x86_64) || defined(arch_power)
747     // Allocate the new TLS region, if necessary
748     if( lmap.tlsRegions.size() > 0 ) {
749         lmap.tlsRegionOffset = currentOffset;
750
751         lmap.tlsRegionOffset += computePadding(lmap.tlsRegionOffset + globalOffset,
752                 lmap.tlsRegionAlign);
753         currentOffset = layoutTLSImage(globalOffset, dataTLS, bssTLS, lmap);
754
755         if( currentOffset == lmap.tlsRegionOffset ) {
756             err = Storage_Allocation_Failure;
757             errMsg = "failed to create TLS initialization image";
758             return false;
759         }
760
761         /*
762          *  The size of this Region is counted twice: once when collecting the
763          *  original TLS Regions and once when laying out the image. This is
764          *  necessary to maintain consistency with the case where there are no
765          *  new TLS regions in the relocatable objects but existing TLS symbols
766          *  are used.
767          */
768         if( dataTLS != NULL ) {
769             lmap.tlsSize -= dataTLS->getMemSize();
770         }
771
772         lmap.tlsSize += currentOffset - lmap.tlsRegionOffset;
773
774         // Adjust offsets for all existing TLS symbols, as their offset
775         // in the TLS block could have changed
776         vector<Symbol *> definedSyms;
777         if( target->getAllDefinedSymbols(definedSyms) ) {
778             vector<Symbol *>::iterator sym_it;
779             for(sym_it = definedSyms.begin(); sym_it != definedSyms.end(); ++sym_it) {
780                 if( (*sym_it)->getType() == Symbol::ST_TLS ) {
781
782                     map<Region *, LinkMap::AllocPair>::iterator result;
783                     result = lmap.regionAllocs.find((*sym_it)->getRegion());
784
785                     if( result != lmap.regionAllocs.end() ) {
786                         Offset regionOffset = result->second.second;
787                         Offset symbolOffset = (*sym_it)->getOffset();
788                         lmap.origSymbols.push_back(make_pair(*sym_it, symbolOffset));
789
790                         symbolOffset += regionOffset - lmap.tlsRegionOffset;
791                         symbolOffset = adjustTLSOffset(symbolOffset, lmap.tlsSize);
792
793                         (*sym_it)->setOffset(symbolOffset);
794                     }
795                 }
796             }
797         }
798
799         cleanupTLSRegionOffsets(lmap.regionAllocs, dataTLS, bssTLS);
800         if( bssTLS != NULL ) lmap.tlsSize -= bssTLS->getMemSize();
801
802         hasRewrittenTLS_ = true;
803     }else{
804         // Adjust offsets for all existing TLS symbols, as the offsets required
805         // by relocation processing are TLS variant dependent
806         vector<Symbol *> definedSyms;
807         if( target->getAllDefinedSymbols(definedSyms) ) {
808             vector<Symbol *>::iterator sym_it;
809             for(sym_it = definedSyms.begin(); sym_it != definedSyms.end(); ++sym_it) {
810                 if( (*sym_it)->getType() == Symbol::ST_TLS ) {
811                     Offset symbolOffset = (*sym_it)->getOffset();
812                     lmap.origSymbols.push_back(make_pair(*sym_it, symbolOffset));
813
814                     symbolOffset = adjustTLSOffset(symbolOffset, lmap.tlsSize);
815                     (*sym_it)->setOffset(symbolOffset);
816                 }
817             }
818         }
819
820         // The size of the original TLS image is no longer needed
821         lmap.tlsSize = 0;
822     }
823
824 #endif
825     // Allocate space for a new constructor region, if necessary
826     if( lmap.newCtorRegions.size() > 0 ) {
827         lmap.ctorRegionOffset = currentOffset;
828         lmap.ctorRegionOffset += computePadding(globalOffset + lmap.ctorRegionOffset,
829                 lmap.ctorRegionAlign);
830         currentOffset = layoutNewCtorRegion(lmap);
831         if( currentOffset == ~0UL ) {
832             err = Storage_Allocation_Failure;
833             errMsg = "assumption failed while creating link map";
834             return false;
835         }
836         lmap.ctorSize = currentOffset - lmap.ctorRegionOffset;
837     }
838
839     // Allocate space for a new destructor region, if necessary
840     if( lmap.newDtorRegions.size() > 0 ) {
841         lmap.dtorRegionOffset = currentOffset;
842         lmap.dtorRegionOffset += computePadding(globalOffset + lmap.dtorRegionOffset,
843                 lmap.dtorRegionAlign);
844         currentOffset = layoutNewDtorRegion(lmap);
845         if( currentOffset == ~0UL ) {
846             err = Storage_Allocation_Failure;
847             errMsg = "assumption failed while creating link map";
848             return false;
849         }
850         lmap.dtorSize = currentOffset - lmap.dtorRegionOffset;
851     }
852
853     /* Combine all COMMON symbols into a single block */
854     if( commonAlignments.size() > 0 ) {
855         // The alignment of the COMMON Region could be the alignment 
856         // for the bss Region
857         if( commonRegionAlign > lmap.bssRegionAlign ) {
858             lmap.bssRegionAlign = commonRegionAlign;
859         }
860
861         // The following approach to laying out the COMMON symbols is greedy and
862         // suboptimal (in terms of space in the target), but it's quick...
863         Offset commonOffset = currentOffset;
864
865         // Make sure the COMMON Region's alignment is satisfied
866         commonOffset += computePadding(globalOffset + commonOffset, lmap.bssRegionAlign);
867         Offset commonStartOffset = commonOffset;
868
869         multimap<Offset, Symbol *>::iterator align_it;
870         for(align_it = commonAlignments.begin(); 
871             align_it != commonAlignments.end(); ++align_it)
872         {
873             commonOffset += computePadding(commonOffset, align_it->first);
874             lmap.origSymbols.push_back(make_pair(align_it->second, align_it->first));
875
876             // Update symbol with place in new linked data
877             align_it->second->setOffset(globalOffset + commonOffset);
878             commonOffset += align_it->second->getSize();
879         }
880
881         // Update the size of COMMON storage
882         if( commonAlignments.size() > 0 ) {
883             // A COMMON region is not really complete
884             lmap.commonStorage = Region::createRegion(0, Region::RP_RW,
885                     Region::RT_BSS, commonOffset - commonStartOffset, 0, 
886                     commonOffset - commonStartOffset,
887                     DEFAULT_COM_NAME, NULL, true, false, commonRegionAlign);
888             lmap.bssRegions.push_front(lmap.commonStorage);
889         }
890     }
891
892     // Allocate bss regions
893     lmap.bssRegionOffset = currentOffset;
894     lmap.bssRegionOffset += computePadding(globalOffset + lmap.bssRegionOffset,
895             lmap.bssRegionAlign);
896     currentOffset = layoutRegions(lmap.bssRegions, lmap.regionAllocs,
897             lmap.bssRegionOffset, globalOffset);
898     if( currentOffset == ~0UL ) {
899         err = Storage_Allocation_Failure;
900         errMsg = "assumption failed while creating link map";
901         return false;
902     }
903
904     lmap.bssSize = currentOffset - lmap.bssRegionOffset;
905
906     // Update all relevant symbols with their offsets in the new target
907     for(obj_it = relocatableObjects.begin(); obj_it != relocatableObjects.end(); ++obj_it) {
908         vector<Symbol *> definedSyms;
909         if( (*obj_it)->getAllDefinedSymbols(definedSyms) ) {
910             vector<Symbol *>::iterator sym_it;
911             for(sym_it = definedSyms.begin(); sym_it != definedSyms.end(); ++sym_it) {
912                 if(    !(*sym_it)->isCommonStorage() 
913                     && (*sym_it)->getType() != Symbol::ST_TLS) 
914                 {
915                     map<Region *, LinkMap::AllocPair>::iterator result;
916                     result = lmap.regionAllocs.find((*sym_it)->getRegion());
917                     if( result != lmap.regionAllocs.end() ) {
918                         Offset regionOffset = result->second.second;
919                         Offset symbolOffset = (*sym_it)->getOffset();
920                         lmap.origSymbols.push_back(make_pair(*sym_it, symbolOffset));
921
922                         symbolOffset += globalOffset + regionOffset;
923 // If region has relocations, set offset to got 
924                         vector<relocationEntry> region_rels = result->first->getRelocations();
925                         if(region_rels.size() > 0) {
926 //                      printf(" region %s has relocations %d \n", result->first->getRegionName().c_str(), region_rels.size()); 
927 /*
928                                 result = lmap.regionAllocs.find((*sym_it)->getRegion());
929                                 regionOffset = result->second.second;
930 */
931                         }
932                         
933                 
934                         (*sym_it)->setOffset(symbolOffset);
935                     }
936                 }
937             }
938         }
939     }
940
941     /* ASSUMPTION
942      * At this point, the layout of the new regions is fixed, and
943      * addresses of all symbols are known (excluding Constructor/Destructor Regions)
944      */
945
946     // Allocate storage space
947     lmap.allocatedData = new char[currentOffset];
948     lmap.allocatedSize = currentOffset;
949
950     // Copy the Regions from the relocatable objects into the new storage space
951     copyRegions(lmap);
952
953     return true;
954 }
955
956 /**
957  * Lays out the specified regions, storing the layout info in the 
958  * passed map.
959  *
960  * regions              A collection of Regions to layout
961  * regionAllocs         A map of Regions to their layout information
962  * currentOffset        The starting offset for the passed Regions in
963  *                      the new storage space
964  * globalOffset         The location of the new storage space in the
965  *                      target (used for padding calculation)
966  */
967 Offset emitElfStatic::layoutRegions(deque<Region *> &regions, 
968                                     map<Region *, LinkMap::AllocPair> &regionAllocs,
969                                     Offset currentOffset, Offset globalOffset) 
970 {
971     Offset retOffset = currentOffset;
972
973     deque<Region *>::iterator copyReg_it;
974     for(copyReg_it = regions.begin(); copyReg_it != regions.end(); ++copyReg_it) {
975         // Skip empty Regions
976         if( (*copyReg_it)->getMemSize() == 0 ) continue;
977
978         // Make sure the Region is aligned correctly in the new aggregate Region
979         Offset padding = computePadding(globalOffset + retOffset, (*copyReg_it)->getMemAlignment());
980         retOffset += padding;
981
982         // Set up mapping for a new Region in the specified storage space
983         pair<map<Region *, LinkMap::AllocPair>::iterator, bool> result;
984         result = regionAllocs.insert(make_pair(*copyReg_it, make_pair(padding, retOffset)));
985
986         // If the map already contains this Region, this is a logic error
987         if( !result.second ) {
988             retOffset = ~0UL;
989             break;
990         }
991                        
992         retOffset += (*copyReg_it)->getMemSize();
993     }
994
995     return retOffset;
996 }
997
998 /*
999  * Adds new combined Regions to the target at the specified globalOffset
1000  *
1001  * target       The Symtab object to which the new Regions will be added
1002  * globalOffset The offset of the first new Region in the target
1003  * lmap         Contains all the information about the LinkMap
1004  */
1005 bool emitElfStatic::addNewRegions(Symtab *target, Offset globalOffset, LinkMap &lmap) {
1006     char *newTargetData = lmap.allocatedData;
1007  
1008 #if defined(arch_x86) || defined(arch_x86_64)  || (defined(arch_power) && defined(arch_64bit))
1009     if( lmap.gotSize > 0 ) {
1010        buildGOT(target, lmap);
1011         target->addRegion(globalOffset + lmap.gotRegionOffset,
1012                 reinterpret_cast<void *>(&newTargetData[lmap.gotRegionOffset]),
1013                 static_cast<unsigned int>(lmap.gotSize),
1014                 GOT_NAME, Region::RT_DATA, true, lmap.gotRegionAlign);
1015     }   
1016 #endif
1017     if( lmap.codeSize > 0 ) {
1018         target->addRegion(globalOffset + lmap.codeRegionOffset,
1019                 reinterpret_cast<void *>(&newTargetData[lmap.codeRegionOffset]),
1020                 static_cast<unsigned int>(lmap.codeSize),
1021                 CODE_NAME, Region::RT_TEXTDATA, true, lmap.codeRegionAlign);
1022     }
1023     if (lmap.stubSize > 0) {
1024         target->addRegion(globalOffset + lmap.stubRegionOffset,
1025                           reinterpret_cast<void *>(&newTargetData[lmap.stubRegionOffset]),
1026                           static_cast<unsigned int>(lmap.stubSize),
1027                           STUB_NAME, Region::RT_TEXTDATA, true, lmap.codeRegionAlign);
1028     }      
1029
1030     if( lmap.dataSize > 0 ) {
1031         target->addRegion(globalOffset + lmap.dataRegionOffset, 
1032                 reinterpret_cast<void *>(&newTargetData[lmap.dataRegionOffset]),
1033                 static_cast<unsigned int>(lmap.dataSize),
1034                 DATA_NAME, Region::RT_DATA, true, lmap.dataRegionAlign);
1035     }
1036
1037 #if defined(arch_x86) || defined(arch_x86_64)  || defined(arch_power) 
1038     if( lmap.tlsSize > 0 ) {
1039         target->addRegion(globalOffset + lmap.tlsRegionOffset,
1040                 reinterpret_cast<void *>(&newTargetData[lmap.tlsRegionOffset]),
1041                 static_cast<unsigned int>(lmap.tlsSize),
1042                 TLS_DATA_NAME, Region::RT_DATA, true, lmap.tlsRegionAlign, true);
1043     }
1044 #endif
1045     if( lmap.newCtorRegions.size() > 0 ) {
1046         if( !createNewCtorRegion(lmap) ) {
1047             return false;
1048         }
1049
1050         target->addRegion(globalOffset + lmap.ctorRegionOffset,
1051                 reinterpret_cast<void *>(&newTargetData[lmap.ctorRegionOffset]),
1052                 static_cast<unsigned int>(lmap.ctorSize),
1053                 CTOR_NAME, Region::RT_DATA, true, 
1054                 lmap.ctorRegionAlign);
1055     }
1056
1057     if( lmap.newDtorRegions.size() > 0 ) {
1058         if( !createNewDtorRegion(lmap) ) {
1059             return false;
1060         }
1061
1062         target->addRegion(globalOffset + lmap.dtorRegionOffset,
1063                 reinterpret_cast<void *>(&newTargetData[lmap.dtorRegionOffset]),
1064                 static_cast<unsigned int>(lmap.dtorSize),
1065                 DTOR_NAME, Region::RT_DATA, true,
1066                 lmap.dtorRegionAlign);
1067     }
1068
1069     if( lmap.bssSize > 0 ) {
1070         target->addRegion(globalOffset + lmap.bssRegionOffset, 
1071                 reinterpret_cast<void *>(&newTargetData[lmap.bssRegionOffset]),
1072                 static_cast<unsigned int>(lmap.bssSize),
1073                 BSS_NAME, Region::RT_BSS, true, lmap.bssRegionAlign);
1074     }
1075
1076     return true;
1077 }
1078
1079 /**
1080  * Copys the new Regions, as indicated by the LinkMap, into the
1081  * allocated storage space
1082  *
1083  * lmap         Contains all the information necessary to perform the copy
1084  */
1085 void emitElfStatic::copyRegions(LinkMap &lmap) {
1086     char *targetData = lmap.allocatedData;
1087
1088     map<Region *, LinkMap::AllocPair>::iterator regOff_it;
1089     for(regOff_it = lmap.regionAllocs.begin(); regOff_it != lmap.regionAllocs.end(); ++regOff_it) {
1090         Region *depRegion = regOff_it->first;
1091         Offset regionOffset = regOff_it->second.second;
1092         Offset padding = regOff_it->second.first;
1093
1094         // Copy in the Region data
1095         char *rawRegionData = reinterpret_cast<char *>(depRegion->getPtrToRawData());
1096
1097         if( !depRegion->isBSS() ) {
1098             memcpy(&targetData[regionOffset], rawRegionData, depRegion->getMemSize());
1099         }
1100
1101         // Set the padded space to a meaningful value
1102         memset(&targetData[regionOffset - padding], getPaddingValue(depRegion->getRegionType()), padding);
1103     }
1104 }
1105
1106 /**
1107  * Computes the padding necessary to satisfy the specified alignment
1108  *
1109  * candidateOffset      A possible offset for an item
1110  * alignment            The alignment for an item
1111  */
1112 inline
1113 Offset emitElfStatic::computePadding(Offset candidateOffset, Offset alignment) {
1114     Offset padding = 0;
1115     if( alignment != 0 && (candidateOffset % alignment) != 0 ) {
1116         padding = alignment - (candidateOffset % alignment);
1117     }
1118     return padding;
1119 }
1120
1121 /**
1122  * Given a collection of newly allocated regions in the specified storage space, 
1123  * computes relocations and places the values at the location specified by the
1124  * relocation entry (stored with the Regions)
1125  *
1126  * target               The Symtab object being rewritten
1127  * relocatableObjects   A list of relocatable files being linked into target
1128  * globalOffset         The location of the new storage space in target
1129  * lmap                 Contains all the information necessary to apply relocations
1130  */
1131 bool emitElfStatic::applyRelocations(Symtab *target, vector<Symtab *> &relocatableObjects,
1132                                      Offset globalOffset, LinkMap &lmap,
1133                                      StaticLinkError &err, string &errMsg) 
1134 {
1135     // Iterate over all relocations in all relocatable files
1136     vector<Symtab *>::iterator depObj_it;
1137     for(depObj_it = relocatableObjects.begin(); depObj_it != relocatableObjects.end(); ++depObj_it) {
1138         vector<Region *> allRegions;
1139         (*depObj_it)->getAllRegions(allRegions);
1140
1141         // Relocations are stored with the Region to which they will be applied
1142         // As an ELF example, .rel.text relocations are stored with the Region .text
1143         vector<Region *>::iterator region_it;
1144         for(region_it = allRegions.begin(); region_it != allRegions.end(); ++region_it) {
1145             // Only compute relocations for the new Regions
1146                         if ((*region_it)->getRegionName().compare(".text") && (*region_it)->getRegionName().compare(".toc") ) {
1147                                 continue;
1148         }
1149         map<Region *, LinkMap::AllocPair>::iterator result;
1150         result = lmap.regionAllocs.find(*region_it);
1151         if( result != lmap.regionAllocs.end() ) { 
1152
1153                 Offset regionOffset = result->second.second;
1154                 vector<relocationEntry> region_rels = (*region_it)->getRelocations();
1155
1156                 vector<relocationEntry>::iterator rel_it;
1157                 for(rel_it = region_rels.begin(); rel_it != region_rels.end(); ++rel_it) {
1158                     // Compute destination of relocation
1159                     Offset dest = regionOffset + rel_it->rel_addr();
1160                     Offset relOffset = globalOffset + dest;
1161
1162                     rewrite_printf("Computing relocations to apply to region: %s (%s) @ 0x%lx reloffset 0x%lx dest 0x%lx  \n\n",
1163                                    (*region_it)->getRegionName().c_str(), 
1164                                    (*region_it)->symtab()->file().c_str(),
1165                                    regionOffset, 
1166                                    relOffset,
1167                                    dest);
1168                     rewrite_printf("\t RelOffset computed as region 0x%lx + rel_addr 0x%lx + globalOffset 0x%lx\n",
1169                                    regionOffset, rel_it->rel_addr(), globalOffset);
1170                     
1171                     char *targetData = lmap.allocatedData;
1172                     if( !archSpecificRelocation(target, *depObj_it, 
1173                                                 targetData, *rel_it, dest, 
1174                                                 relOffset, globalOffset, lmap, errMsg) ) 
1175                     {
1176                         err = Relocation_Computation_Failure;
1177                         errMsg = "Failed to compute relocation: " + errMsg;
1178                         return false;
1179                     }
1180 /*
1181                    if((*region_it)->getRegionName().compare(".toc") == 0){
1182                         Offset regOffset = lmap.gotRegionOffset; 
1183                         dest = regOffset + rel_it->rel_addr();
1184                         relOffset = globalOffset + dest;
1185
1186                     if((*rel_it).name().compare("__SYMTABAPI_CTOR_LIST__") == 0) 
1187                         {
1188                         printf("\n\tComputing relocations to apply to region: %s @ 0x%lx reloffset %d 0x%lx dest %d 0x%lx  \n\n",
1189                         (*region_it)->getRegionName().c_str(), regOffset, relOffset,relOffset, dest,dest);
1190                     if( !archSpecificRelocation(target, *depObj_it, targetData, *rel_it, dest, 
1191                                 relOffset, globalOffset, lmap, errMsg) ) 
1192                     {
1193                         err = Relocation_Computation_Failure;
1194                         errMsg = "Failed to compute relocation: " + errMsg;
1195                         return false;
1196                     }
1197                         }
1198                 
1199                    }  
1200 */
1201                 }
1202             }
1203         }
1204     }
1205
1206     rewrite_printf("\n*** Computing relocations added to target.\n\n");
1207
1208     // Compute relocations added to target 
1209     vector<Region *> allRegions;
1210     target->getAllRegions(allRegions);
1211
1212     vector<Region *>::iterator reg_it;
1213     for(reg_it = allRegions.begin(); reg_it != allRegions.end(); ++reg_it) {
1214           
1215         char *regionData = reinterpret_cast<char *>((*reg_it)->getPtrToRawData());
1216         
1217         vector<relocationEntry>::iterator rel_it;
1218         for(rel_it = (*reg_it)->getRelocations().begin();
1219             rel_it != (*reg_it)->getRelocations().end();
1220             ++rel_it)
1221           {
1222             // Don't process relocations for other sections; those get handled by the
1223             // stub code.
1224             if ((rel_it->rel_addr() < (*reg_it)->getMemOffset()) ||
1225                 (rel_it->rel_addr() >= ((*reg_it)->getMemOffset() + (*reg_it)->getMemSize()))) continue;
1226             if( !archSpecificRelocation(target, target, regionData, *rel_it,
1227                         rel_it->rel_addr() - (*reg_it)->getDiskOffset(),
1228                         rel_it->rel_addr(), globalOffset, lmap, errMsg) )
1229             {
1230                 err = Relocation_Computation_Failure;
1231                 errMsg = "Failed to compute relocation: " + errMsg;
1232                 return false;
1233             }
1234           }
1235     }
1236     return true;
1237 }
1238
1239 /**
1240  * A string representation of the StaticLinkError returned by
1241  * other functions
1242  */
1243 string emitElfStatic::printStaticLinkError(StaticLinkError err) {
1244     switch(err) {
1245         CASE_RETURN_STR(No_Static_Link_Error);
1246         CASE_RETURN_STR(Symbol_Resolution_Failure);
1247         CASE_RETURN_STR(Relocation_Computation_Failure);
1248         CASE_RETURN_STR(Storage_Allocation_Failure);
1249         default:
1250             return "unknown error";
1251     }
1252 }
1253
1254 /**
1255  * Indicates if a new TLS initialization image has been created
1256  */
1257 bool emitElfStatic::hasRewrittenTLS() const {
1258     return hasRewrittenTLS_;
1259 }
1260
1261 /** The following functions are all somewhat architecture-specific */
1262
1263 /* TLS Info
1264  *
1265  * TLS handling is pseudo-architecture dependent. The implementation of the TLS
1266  * functions depend on the implementation of TLS on a specific architecture.
1267  *
1268  * The following material is documented in more detail in the 
1269  * "ELF Handling For TLS" white paper. According to this paper, their are 
1270  * two variants w.r.t. creating a TLS initialization image.
1271  *
1272  * ======================
1273  *
1274  * The first is:
1275  *
1276  *            beginning of image
1277  *            |
1278  *            V                              high address
1279  * +----+-----+----------+---------+---------+
1280  * |    | TCB | image 1  | image 2 | image 3 |
1281  * +----+---- +----------+---------+---------+
1282  *
1283  * where TCB = thread control block, and each image is the
1284  * TLS initialization image for an object (in this context an executable or 
1285  * shared library).
1286  *
1287  * ========================
1288  *
1289  * The second is:
1290  * 
1291  * beginning of image
1292  * | 
1293  * V                                        high address
1294  * +---------+----------+---------+---------+
1295  * | image 3 | image 2  | image 1 |  TCB    |
1296  * +---------+----------+---------+---------+
1297  *
1298  * An image is:
1299  *
1300  * +--------+--------+
1301  * | DATA   |  BSS   |
1302  * +--------+--------+
1303  *
1304  * New TLS data and bss is added to the original initialization image as follows:
1305  *
1306  * +----------+------------------+-------------+------------+-----+
1307  * | NEW DATA | EXPANDED NEW BSS | TARGET DATA | TARGET BSS | TCB |
1308  * +----------+------------------+-------------+------------+-----+
1309  *
1310  * It is important to note that the TARGET DATA and TARGET BSS blocks are not moved.
1311  * This ensures that the modifications to the TLS image are safe.
1312  *
1313  * ==========================
1314  * 
1315  * These are the two variants one would see when working with ELF files. So, an
1316  * architecture either uses variant 1 or 2.
1317  *
1318  */
1319
1320 /* See architecture specific functions that call these for descriptions of function interface */
1321
1322 Offset emitElfStatic::tlsLayoutVariant1(Offset globalOffset, Region *dataTLS, Region *bssTLS, LinkMap &lmap)
1323 {
1324     // The original init. image needs to remain in the image 1 slot because
1325     // the TLS data references are relative to that position
1326     unsigned long tlsBssSize = 0;
1327     if( dataTLS != NULL ) lmap.tlsRegions.push_back(dataTLS);
1328     if( bssTLS != NULL ) tlsBssSize = bssTLS->getMemSize();
1329     deque<Region *> tlsRegionsVar;
1330
1331     deque<Region *>::iterator copyReg_it;
1332     for(copyReg_it = lmap.tlsRegions.begin(); copyReg_it != lmap.tlsRegions.end(); ++copyReg_it) {
1333          tlsRegionsVar.push_front(*copyReg_it);
1334     }
1335
1336     // Create the image, note new BSS regions are expanded
1337     Offset endOffset = layoutRegions(lmap.tlsRegions,
1338             lmap.regionAllocs, lmap.tlsRegionOffset, globalOffset);
1339     if( endOffset == ~0UL ) return lmap.tlsRegionOffset;
1340     Offset adjustedEnd = endOffset - lmap.tlsRegionOffset;
1341
1342     // This is necessary so the offsets of existing TLS symbols can be updated
1343     // in a uniform, architecture independent way
1344     if( bssTLS != NULL ) {
1345         if( dataTLS != NULL ) {
1346             lmap.regionAllocs.insert(make_pair(bssTLS, lmap.regionAllocs[dataTLS]));
1347         }else{
1348             lmap.regionAllocs.insert(make_pair(bssTLS, make_pair(0, endOffset)));
1349         }
1350     }
1351
1352     // Update the symbols with their offsets relative to the TCB address
1353     vector<Symbol *>::iterator sym_it;
1354     for(sym_it = lmap.tlsSymbols.begin(); sym_it != lmap.tlsSymbols.end(); ++sym_it) {
1355         map<Region *, LinkMap::AllocPair>::iterator result;
1356         result = lmap.regionAllocs.find((*sym_it)->getRegion());
1357
1358         // It is a programming error if the region for the symbol
1359         // was not passed to this function
1360         if( result == lmap.regionAllocs.end() ) {
1361             endOffset = lmap.tlsRegionOffset;
1362             break;
1363         }
1364
1365         Offset regionOffset = result->second.second;
1366         Offset symbolOffset = (*sym_it)->getOffset();
1367         lmap.origSymbols.push_back(make_pair((*sym_it), symbolOffset));
1368
1369         symbolOffset += (regionOffset - lmap.tlsRegionOffset) - (adjustedEnd + tlsBssSize);
1370         (*sym_it)->setOffset(symbolOffset);
1371     }
1372
1373     return endOffset;
1374 }
1375
1376 Offset emitElfStatic::tlsLayoutVariant2(Offset globalOffset, Region *dataTLS, Region *bssTLS,
1377         LinkMap &lmap)
1378 {
1379     // The original init. image needs to remain in the image 1 slot because
1380     // the TLS data references are relative to that position
1381     unsigned long tlsBssSize = 0;
1382     if( dataTLS != NULL ) lmap.tlsRegions.push_back(dataTLS);
1383     if( bssTLS != NULL ) tlsBssSize = bssTLS->getMemSize();
1384
1385     // Create the image, note new BSS regions are expanded
1386     Offset endOffset = layoutRegions(lmap.tlsRegions,
1387             lmap.regionAllocs, lmap.tlsRegionOffset, globalOffset);
1388     if( endOffset == ~0UL ) return lmap.tlsRegionOffset;
1389     Offset adjustedEnd = endOffset - lmap.tlsRegionOffset;
1390
1391     // This is necessary so the offsets of existing TLS symbols can be updated
1392     // in a uniform, architecture independent way
1393     if( bssTLS != NULL ) {
1394         if( dataTLS != NULL ) {
1395             lmap.regionAllocs.insert(make_pair(bssTLS, lmap.regionAllocs[dataTLS]));
1396         }else{
1397             lmap.regionAllocs.insert(make_pair(bssTLS, make_pair(0, endOffset)));
1398         }
1399     }
1400
1401     // Update the symbols with their offsets relative to the TCB address
1402     vector<Symbol *>::iterator sym_it;
1403     for(sym_it = lmap.tlsSymbols.begin(); sym_it != lmap.tlsSymbols.end(); ++sym_it) {
1404         map<Region *, LinkMap::AllocPair>::iterator result;
1405         result = lmap.regionAllocs.find((*sym_it)->getRegion());
1406
1407         // It is a programming error if the region for the symbol
1408         // was not passed to this function
1409         if( result == lmap.regionAllocs.end() ) {
1410             endOffset = lmap.tlsRegionOffset;
1411             break;
1412         }
1413
1414         Offset regionOffset = result->second.second;
1415         Offset symbolOffset = (*sym_it)->getOffset();
1416         lmap.origSymbols.push_back(make_pair((*sym_it), symbolOffset));
1417
1418         symbolOffset += (regionOffset - lmap.tlsRegionOffset) - (adjustedEnd + tlsBssSize);
1419         (*sym_it)->setOffset(symbolOffset);
1420     }
1421
1422     return endOffset;
1423 }
1424
1425 // Note: Variant 1 does not require any modifications, so a separate
1426 // function is not necessary
1427 Offset emitElfStatic::tlsAdjustVariant2(Offset curOffset, Offset tlsSize) {
1428     // For Variant 2, offsets relative to the TCB need to be negative
1429     Offset retOffset = curOffset;
1430     retOffset -= tlsSize;
1431     return retOffset;
1432 }
1433
1434 void emitElfStatic::tlsCleanupVariant1(map<Region *, LinkMap::AllocPair> &regionAllocs,
1435         Region *, Region *bssTLS) 
1436 {
1437     // Existing BSS TLS region is not copied to the new target data
1438     if( bssTLS != NULL ) regionAllocs.erase(bssTLS);
1439 }
1440
1441 void emitElfStatic::tlsCleanupVariant2(map<Region *, LinkMap::AllocPair> &regionAllocs,
1442         Region *, Region *bssTLS) 
1443 {
1444     // Existing BSS TLS region is not copied to the new target data
1445     if( bssTLS != NULL ) regionAllocs.erase(bssTLS);
1446 }
1447
1448 bool 
1449 emitElfUtils::sort_reg(const Region* a, const Region* b)
1450 {   
1451     if (a->getMemOffset() == b->getMemOffset())
1452         return a->getMemSize() < b->getMemSize();
1453     return a->getMemOffset() < b->getMemOffset();
1454 }
1455
1456 /*
1457  * Sort the sections array so that sections with a non-zero
1458  * memory offset come first (and are sorted in increasing
1459  * order of offset). Preserves the ordering of zero-offset
1460  * sections.
1461  *
1462  * If no section has a non-zero offset, the return value will
1463  * be an address in the virtual memory space big enough to
1464  * hold all the loadable sections. Otherwise it will be the
1465  * address of the first non-zero offset section.
1466  *
1467  * NB if we need to create a new segment to hold these sections,
1468  * it needs to be clear up to the next page boundary to avoid
1469  * potentially clobbering other loadable segments.
1470  */
1471 Address 
1472 emitElfUtils::orderLoadableSections(Symtab *obj, vector<Region*> & sections)
1473 {
1474     Address ret = 0;
1475     Address sz = 0;
1476     vector<Region*> nonzero;
1477     vector<Region*> copy(sections);
1478     unsigned insert = sections.size()-1;
1479
1480     for(int i=copy.size()-1;i>=0;--i) {
1481         if(!copy[i]->getMemOffset())
1482             sections[insert--] = copy[i];
1483         else
1484             nonzero.push_back(copy[i]);
1485         sz += copy[i]->getMemSize();
1486     }
1487
1488     assert(nonzero.size() == (insert+1));
1489
1490     std::sort(nonzero.begin(),nonzero.end(),sort_reg);
1491     for(unsigned i=0;i<nonzero.size();++i)
1492         sections[i] = nonzero[i];
1493
1494     if(nonzero.size() > 0)
1495         ret = nonzero[0]->getMemOffset();
1496     else {
1497         // find a `hole' of appropriate size
1498         sz = (sz + 4096 - 1) & ~(4096-1);
1499         ret = obj->getFreeOffset(sz);
1500         if(!ret) {
1501             fprintf(stderr,"Failed to finde hole of size %lx, bailing\n",sz);
1502         }
1503     }
1504     return ret;
1505 }
1506
1507 // There are also some known variables that point to the heap 
1508 bool emitElfUtils::updateHeapVariables(Symtab *obj, unsigned long newSecsEndAddress ) {
1509     unsigned pgSize = (unsigned)getpagesize();
1510     const std::string minbrk(".minbrk");
1511     const std::string curbrk(".curbrk");
1512     std::vector<Symbol *> heapSyms;
1513     obj->findSymbol(heapSyms, minbrk, Symbol::ST_NOTYPE);
1514     obj->findSymbol(heapSyms, curbrk, Symbol::ST_NOTYPE);
1515
1516     std::vector<Symbol *>::iterator heapSymsIter;
1517     for(heapSymsIter = heapSyms.begin();
1518       heapSymsIter != heapSyms.end();
1519       ++heapSymsIter)
1520     {
1521         Region *symRegion = (*heapSymsIter)->getRegion();
1522         Offset symOffset = (*heapSymsIter)->getOffset(); 
1523         if( symOffset < symRegion->getDiskOffset() ) continue;
1524
1525         Offset regOffset = symOffset - symRegion->getDiskOffset();
1526         unsigned char *regData = reinterpret_cast<unsigned char *>(symRegion->getPtrToRawData());
1527         Offset heapAddr;
1528         memcpy(&heapAddr, &regData[regOffset], sizeof(Offset));
1529
1530         heapAddr = (newSecsEndAddress & ~(pgSize-1)) + pgSize;
1531
1532         if( !symRegion->patchData(regOffset, &heapAddr, sizeof(Offset)) ) {
1533             rewrite_printf("Failed to update heap address\n");
1534             return false;
1535         }
1536     }
1537
1538     return true;
1539 }
1540
1541 inline
1542 static bool adjustValInRegion(Region *reg, Offset offInReg, Offset addressWidth, int adjust) {
1543     Offset newValue;
1544     unsigned char *oldValues;
1545
1546     oldValues = reinterpret_cast<unsigned char *>(reg->getPtrToRawData());
1547     memcpy(&newValue, &oldValues[offInReg], addressWidth);
1548     newValue += adjust;
1549     return reg->patchData(offInReg, &newValue, addressWidth);
1550 }
1551
1552 bool emitElfUtils::updateRelocation(Symtab *obj, relocationEntry &rel, int library_adjust) {
1553     // Currently, only verified on x86 and x86_64 -- this may work on other architectures
1554 #if defined(arch_x86) || defined(arch_x86_64)
1555     Region *targetRegion = obj->findEnclosingRegion(rel.rel_addr());
1556     if( NULL == targetRegion ) {
1557         rewrite_printf("Failed to find enclosing Region for relocation");
1558         return false;
1559     }
1560
1561     // Used to update a Region
1562     unsigned addressWidth = obj->getAddressWidth();
1563     if( addressWidth == 8 ) {
1564         switch(rel.getRelType()) {
1565             case R_X86_64_RELATIVE:
1566                 rel.setAddend(rel.addend() + library_adjust);
1567                 break;
1568             case R_X86_64_JUMP_SLOT:
1569                 if( !adjustValInRegion(targetRegion, 
1570                            rel.rel_addr() - targetRegion->getDiskOffset(),
1571                            addressWidth, library_adjust) )
1572                 {
1573                     rewrite_printf("Failed to update relocation\n");
1574                     return false;
1575                 }
1576                 break;
1577             default:
1578                 // Do nothing
1579                 break;
1580         }
1581     }else{
1582         switch(rel.getRelType()) {
1583             case R_386_RELATIVE:
1584                 // On x86, addends are stored in their target location
1585                 if( !adjustValInRegion(targetRegion, 
1586                            rel.rel_addr() - targetRegion->getDiskOffset(),
1587                            addressWidth, library_adjust) )
1588                 {
1589                     rewrite_printf("Failed to update relocation\n");
1590                     return false;
1591                 }
1592                 break;
1593             case R_386_JMP_SLOT:
1594                 if( !adjustValInRegion(targetRegion, 
1595                            rel.rel_addr() - targetRegion->getDiskOffset(),
1596                            addressWidth, library_adjust) )
1597                 {
1598                     rewrite_printf("Failed to update relocation\n");
1599                     return false;
1600                 }
1601                 break;
1602             default:
1603                 // Do nothing
1604                 break;
1605         }
1606     }
1607
1608     // XXX The GOT also holds a pointer to the DYNAMIC segment -- this is currently not
1609     // updated. However, this appears to be unneeded for regular shared libraries.
1610     
1611     // From the SYS V ABI x86 supplement
1612     // "The table's entry zero is reserved to hold the address of the dynamic structure,
1613     // referenced with the symbol _DYNAMIC. This allows a program, such as the
1614     // dynamic linker, to find its own dynamic structure without having yet processed
1615     // its relocation entries. This is especially important for the dynamic linker, because
1616     // it must initialize itself without relying on other programs to relocate its memory
1617     // image."
1618     
1619     // In order to implement this, would have determine the final address of a new .dynamic
1620     // section before outputting the patched GOT data -- this will require some refactoring.
1621 #else
1622     rewrite_printf("WARNING: updateRelocation is not implemented on this architecture\n");
1623 #endif
1624
1625     return true;
1626 }
1627
1628 bool emitElfStatic::calculateTOCs(Symtab *target, deque<Region *> &regions, Offset GOTstart, Offset newStart, Offset globalOffset) {
1629   rewrite_printf("Calculating TOCs for merged GOT sections, base is 0x%lx, new regions at 0x%lx\n", 
1630                  GOTstart + globalOffset,
1631                  GOTstart + newStart + globalOffset);
1632
1633   Offset GOTbase = GOTstart + globalOffset;
1634   Offset current = GOTbase + newStart;
1635   Offset currentTOC = target->getTOCoffset((Offset) 0);
1636   rewrite_printf("\tBase TOC is 0x%lx\n", currentTOC);
1637
1638   for (deque<Region *>::iterator iter = regions.begin(); iter != regions.end(); ++iter) {
1639     Region *reg = *iter;
1640     Symtab *symtab = reg->symtab();
1641     
1642     Offset end = current + reg->getDiskSize();
1643
1644     // We'd like the TOC to be GOTbase + 0x8000, so long as that can address the end of the current
1645     // region. 
1646     if ((currentTOC + 0x7ff0) < end) {
1647       // Crud...
1648       // OTOH, we can't reference anything outside the current GOT, so just rebase it
1649       currentTOC = current + 0x8000;
1650     }
1651     // Recheck
1652     if ((currentTOC + 0x7ff0) < end) {
1653       assert(0 && "Need to implement -bbigtoc equivalent to rewrite this binary!");
1654     }
1655     symtab->setTOCOffset(currentTOC);
1656     current = end;
1657   }
1658   return true;
1659 }