1 /* -*- mode: C++; c-basic-offset: 4; tab-width: 4 -*-
3 * Copyright (c) 2005-2011 Apple Inc. All rights reserved.
5 * @APPLE_LICENSE_HEADER_START@
7 * This file contains Original Code and/or Modifications of Original Code
8 * as defined in and that are subject to the Apple Public Source License
9 * Version 2.0 (the 'License'). You may not use this file except in
10 * compliance with the License. Please obtain a copy of the License at
11 * http://www.opensource.apple.com/apsl/ and read it before using this
14 * The Original Code and all software distributed under the License are
15 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
16 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
17 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
19 * Please see the License for the specific language governing rights and
20 * limitations under the License.
22 * @APPLE_LICENSE_HEADER_END@
28 #include <sys/param.h>
29 #include <mach-o/ranlib.h>
36 #include <ext/hash_map>
38 #include "MachOFileAbstraction.hpp"
39 #include "Architectures.hpp"
41 #include "macho_relocatable_file.h"
43 #include "archive_file.h"
48 typedef const struct ranlib
* ConstRanLibPtr
;
51 template <typename A
> class File
;
58 typedef typename
A::P P
;
60 static bool validFile(const uint8_t* fileContent
, uint64_t fileLength
,
61 const mach_o::relocatable::ParserOptions
& opts
) {
62 return File
<A
>::validFile(fileContent
, fileLength
, opts
); }
63 static File
<A
>* parse(const uint8_t* fileContent
, uint64_t fileLength
,
64 const char* path
, time_t mTime
,
65 uint32_t ordinal
, const ParserOptions
& opts
) {
66 return new File
<A
>(fileContent
, fileLength
, path
, mTime
,
73 class File
: public ld::archive::File
76 static bool validFile(const uint8_t* fileContent
, uint64_t fileLength
,
77 const mach_o::relocatable::ParserOptions
& opts
);
78 File(const uint8_t* fileContent
, uint64_t fileLength
,
79 const char* pth
, time_t modTime
,
80 uint32_t ord
, const ParserOptions
& opts
);
83 // overrides of ld::File
84 virtual bool forEachAtom(ld::File::AtomHandler
&) const;
85 virtual bool justInTimeforEachAtom(const char* name
, ld::File::AtomHandler
&) const;
86 virtual uint32_t subFileCount() const { return _archiveFilelength
/sizeof(ar_hdr
); }
88 // overrides of ld::archive::File
89 virtual bool justInTimeDataOnlyforEachAtom(const char* name
, ld::File::AtomHandler
& handler
) const;
92 static bool validMachOFile(const uint8_t* fileContent
, uint64_t fileLength
,
93 const mach_o::relocatable::ParserOptions
& opts
);
94 static bool validLTOFile(const uint8_t* fileContent
, uint64_t fileLength
,
95 const mach_o::relocatable::ParserOptions
& opts
);
96 static cpu_type_t
architecture();
101 const char* name() const;
102 time_t modificationTime() const;
103 const uint8_t* content() const;
104 uint32_t contentSize() const;
105 const Entry
* next() const;
107 bool hasLongName() const;
108 unsigned int getLongNameSpace() const;
115 bool operator()(const char* left
, const char* right
) const { return (strcmp(left
, right
) == 0); }
117 typedef __gnu_cxx::hash_map
<const char*, const struct ranlib
*, __gnu_cxx::hash
<const char*>, CStringEquals
> NameToEntryMap
;
119 typedef typename
A::P P
;
120 typedef typename
A::P::E E
;
122 struct MemberState
{ ld::relocatable::File
* file
; bool logged
; bool loaded
; };
124 typedef std::map
<const class Entry
*, MemberState
> MemberToStateMap
;
126 const struct ranlib
* ranlibHashSearch(const char* name
) const;
127 MemberState
& makeObjectFileForMember(const Entry
* member
) const;
128 bool memberHasObjCCategories(const Entry
* member
) const;
129 void dumpTableOfContents();
130 void buildHashTable();
132 const uint8_t* _archiveFileContent
;
133 uint64_t _archiveFilelength
;
134 const struct ranlib
* _tableOfContents
;
135 uint32_t _tableOfContentCount
;
136 const char* _tableOfContentStrings
;
137 mutable MemberToStateMap _instantiatedEntries
;
138 NameToEntryMap _hashTable
;
139 const bool _forceLoadAll
;
140 const bool _forceLoadObjC
;
141 const bool _forceLoadThis
;
142 const bool _objc2ABI
;
143 const bool _verboseLoad
;
144 const bool _logAllFiles
;
145 const mach_o::relocatable::ParserOptions _objOpts
;
149 template <typename A
>
150 bool File
<A
>::Entry::hasLongName() const
152 return ( strncmp(this->ar_name
, AR_EFMT1
, strlen(AR_EFMT1
)) == 0 );
155 template <typename A
>
156 unsigned int File
<A
>::Entry::getLongNameSpace() const
159 long result
= strtol(&this->ar_name
[strlen(AR_EFMT1
)], &endptr
, 10);
163 template <typename A
>
164 const char* File
<A
>::Entry::name() const
166 if ( this->hasLongName() ) {
167 int len
= this->getLongNameSpace();
168 static char longName
[256];
169 strncpy(longName
, ((char*)this)+sizeof(ar_hdr
), len
);
170 longName
[len
] = '\0';
174 static char shortName
[20];
175 strncpy(shortName
, this->ar_name
, 16);
176 shortName
[16] = '\0';
177 char* space
= strchr(shortName
, ' ');
184 template <typename A
>
185 time_t File
<A
>::Entry::modificationTime() const
188 strncpy(temp
, this->ar_date
, 12);
191 return (time_t)strtol(temp
, &endptr
, 10);
195 template <typename A
>
196 const uint8_t* File
<A
>::Entry::content() const
198 if ( this->hasLongName() )
199 return ((uint8_t*)this) + sizeof(ar_hdr
) + this->getLongNameSpace();
201 return ((uint8_t*)this) + sizeof(ar_hdr
);
205 template <typename A
>
206 uint32_t File
<A
>::Entry::contentSize() const
209 strncpy(temp
, this->ar_size
, 10);
212 long size
= strtol(temp
, &endptr
, 10);
213 // long name is included in ar_size
214 if ( this->hasLongName() )
215 size
-= this->getLongNameSpace();
220 template <typename A
>
221 const class File
<A
>::Entry
* File
<A
>::Entry::next() const
223 const uint8_t* p
= this->content() + contentSize();
224 p
= (const uint8_t*)(((uintptr_t)p
+3) & (-4)); // 4-byte align
225 return (class File
<A
>::Entry
*)p
;
229 template <> cpu_type_t File
<x86
>::architecture() { return CPU_TYPE_I386
; }
230 template <> cpu_type_t File
<x86_64
>::architecture() { return CPU_TYPE_X86_64
; }
231 template <> cpu_type_t File
<arm
>::architecture() { return CPU_TYPE_ARM
; }
234 template <typename A
>
235 bool File
<A
>::validMachOFile(const uint8_t* fileContent
, uint64_t fileLength
, const mach_o::relocatable::ParserOptions
& opts
)
237 return mach_o::relocatable::isObjectFile(fileContent
, fileLength
, opts
);
240 template <typename A
>
241 bool File
<A
>::validLTOFile(const uint8_t* fileContent
, uint64_t fileLength
, const mach_o::relocatable::ParserOptions
& opts
)
243 return lto::isObjectFile(fileContent
, fileLength
, opts
.architecture
, opts
.subType
);
248 template <typename A
>
249 bool File
<A
>::validFile(const uint8_t* fileContent
, uint64_t fileLength
, const mach_o::relocatable::ParserOptions
& opts
)
251 // must have valid archive header
252 if ( strncmp((const char*)fileContent
, "!<arch>\n", 8) != 0 )
255 // peak at first .o file and verify it is correct architecture
256 const Entry
* const start
= (Entry
*)&fileContent
[8];
257 const Entry
* const end
= (Entry
*)&fileContent
[fileLength
];
258 for (const Entry
* p
=start
; p
< end
; p
= p
->next()) {
259 const char* memberName
= p
->name();
260 // skip option table-of-content member
261 if ( (p
==start
) && ((strcmp(memberName
, SYMDEF_SORTED
) == 0) || (strcmp(memberName
, SYMDEF
) == 0)) )
263 // archive is valid if first .o file is valid
264 return (validMachOFile(p
->content(), p
->contentSize(), opts
) || validLTOFile(p
->content(), p
->contentSize(), opts
));
271 template <typename A
>
272 File
<A
>::File(const uint8_t fileContent
[], uint64_t fileLength
, const char* pth
, time_t modTime
,
273 uint32_t ord
, const ParserOptions
& opts
)
274 : ld::archive::File(strdup(pth
), modTime
, ord
),
275 _archiveFileContent(fileContent
), _archiveFilelength(fileLength
),
276 _tableOfContents(NULL
), _tableOfContentCount(0), _tableOfContentStrings(NULL
),
277 _forceLoadAll(opts
.forceLoadAll
), _forceLoadObjC(opts
.forceLoadObjC
),
278 _forceLoadThis(opts
.forceLoadThisArchive
), _objc2ABI(opts
.objcABI2
), _verboseLoad(opts
.verboseLoad
),
279 _logAllFiles(opts
.logAllFiles
), _objOpts(opts
.objOpts
)
281 if ( strncmp((const char*)fileContent
, "!<arch>\n", 8) != 0 )
282 throw "not an archive";
284 if ( !_forceLoadAll
) {
285 const Entry
* const firstMember
= (Entry
*)&_archiveFileContent
[8];
286 if ( (strcmp(firstMember
->name(), SYMDEF_SORTED
) == 0) || (strcmp(firstMember
->name(), SYMDEF
) == 0) ) {
287 const uint8_t* contents
= firstMember
->content();
288 uint32_t ranlibArrayLen
= E::get32(*((uint32_t*)contents
));
289 _tableOfContents
= (const struct ranlib
*)&contents
[4];
290 _tableOfContentCount
= ranlibArrayLen
/ sizeof(struct ranlib
);
291 _tableOfContentStrings
= (const char*)&contents
[ranlibArrayLen
+8];
292 if ( ((uint8_t*)(&_tableOfContents
[_tableOfContentCount
]) > &fileContent
[fileLength
])
293 || ((uint8_t*)_tableOfContentStrings
> &fileContent
[fileLength
]) )
294 throw "malformed archive, perhaps wrong architecture";
295 this->buildHashTable();
298 throw "archive has no table of contents";
303 bool File
<x86
>::memberHasObjCCategories(const Entry
* member
) const
306 // i386 for iOS simulator uses ObjC2 which has no global symbol for categories
307 return mach_o::relocatable::hasObjC2Categories(member
->content());
310 // i386 uses ObjC1 ABI which has .objc_category* global symbols
317 template <typename A
>
318 bool File
<A
>::memberHasObjCCategories(const Entry
* member
) const
320 // x86_64 and ARM use ObjC2 which has no global symbol for categories
321 return mach_o::relocatable::hasObjC2Categories(member
->content());
325 template <typename A
>
326 typename File
<A
>::MemberState
& File
<A
>::makeObjectFileForMember(const Entry
* member
) const
328 // in case member was instantiated earlier but not needed yet
329 typename
MemberToStateMap::iterator pos
= _instantiatedEntries
.find(member
);
330 if ( pos
!= _instantiatedEntries
.end() )
333 const char* memberName
= member
->name();
334 char memberPath
[strlen(this->path()) + strlen(memberName
)+4];
335 strcpy(memberPath
, this->path());
336 strcat(memberPath
, "(");
337 strcat(memberPath
, memberName
);
338 strcat(memberPath
, ")");
339 //fprintf(stderr, "using %s from %s\n", memberName, this->path());
342 if ( member
> (Entry
*)(_archiveFileContent
+_archiveFilelength
) )
343 throwf("corrupt archive, member starts past end of file");
344 if ( (member
->content() + member
->contentSize()) > (_archiveFileContent
+_archiveFilelength
) )
345 throwf("corrupt archive, member contents extends past end of file");
346 const char* mPath
= strdup(memberPath
);
347 // offset the ordinals in this mach-o .o file, so that atoms layout in same order as in archive
348 uint32_t memberIndex
= ((uint8_t*)member
- _archiveFileContent
)/sizeof(ar_hdr
);
349 // see if member is mach-o file
350 ld::relocatable::File
* result
= mach_o::relocatable::parse(member
->content(), member
->contentSize(),
351 mPath
, member
->modificationTime(),
352 this->ordinal() + memberIndex
, _objOpts
);
353 if ( result
!= NULL
) {
354 MemberState state
= {result
, false, false};
355 _instantiatedEntries
[member
] = state
;
356 return _instantiatedEntries
[member
];
358 // see if member is llvm bitcode file
359 result
= lto::parse(member
->content(), member
->contentSize(),
360 mPath
, member
->modificationTime(), this->ordinal() + memberIndex
,
361 _objOpts
.architecture
, _objOpts
.subType
, _logAllFiles
);
362 if ( result
!= NULL
) {
363 MemberState state
= {result
, false, false};
364 _instantiatedEntries
[member
] = state
;
365 return _instantiatedEntries
[member
];
368 throwf("archive member '%s' with length %d is not mach-o or llvm bitcode", memberName
, member
->contentSize());
370 catch (const char* msg
) {
371 throwf("in %s, %s", memberPath
, msg
);
376 template <typename A
>
377 bool File
<A
>::forEachAtom(ld::File::AtomHandler
& handler
) const
379 bool didSome
= false;
380 if ( _forceLoadAll
|| _forceLoadThis
) {
381 // call handler on all .o files in this archive
382 const Entry
* const start
= (Entry
*)&_archiveFileContent
[8];
383 const Entry
* const end
= (Entry
*)&_archiveFileContent
[_archiveFilelength
];
384 for (const Entry
* p
=start
; p
< end
; p
= p
->next()) {
385 const char* memberName
= p
->name();
386 if ( (p
==start
) && ((strcmp(memberName
, SYMDEF_SORTED
) == 0) || (strcmp(memberName
, SYMDEF
) == 0)) )
388 MemberState
& state
= this->makeObjectFileForMember(p
);
389 if ( _verboseLoad
) {
390 if ( _forceLoadThis
)
391 printf("-force_load forced load of %s(%s)\n", this->path(), memberName
);
393 printf("-all_load forced load of %s(%s)\n", this->path(), memberName
);
396 didSome
|= state
.file
->forEachAtom(handler
);
400 else if ( _forceLoadObjC
) {
401 // call handler on all .o files in this archive containing objc classes
402 for(typename
NameToEntryMap::const_iterator it
= _hashTable
.begin(); it
!= _hashTable
.end(); ++it
) {
403 if ( (strncmp(it
->first
, ".objc_c", 7) == 0) || (strncmp(it
->first
, "_OBJC_CLASS_$_", 14) == 0) ) {
404 const Entry
* member
= (Entry
*)&_archiveFileContent
[E::get32(it
->second
->ran_off
)];
405 MemberState
& state
= this->makeObjectFileForMember(member
);
406 if ( _verboseLoad
&& !state
.logged
) {
407 printf("-ObjC forced load of %s(%s)\n", this->path(), member
->name());
410 if ( ! state
.loaded
) {
411 didSome
|= state
.file
->forEachAtom(handler
);
416 // ObjC2 has no symbols in .o files with categories but not classes, look deeper for those
417 const Entry
* const start
= (Entry
*)&_archiveFileContent
[8];
418 const Entry
* const end
= (Entry
*)&_archiveFileContent
[_archiveFilelength
];
419 for (const Entry
* member
=start
; member
< end
; member
= member
->next()) {
420 // only look at files not already instantiated
421 if ( _instantiatedEntries
.count(member
) == 0 ) {
422 //fprintf(stderr, "checking member %s\n", member->name());
423 if ( this->memberHasObjCCategories(member
) ) {
424 MemberState
& state
= this->makeObjectFileForMember(member
);
425 if ( _verboseLoad
&& !state
.logged
) {
426 printf("-ObjC forced load of %s(%s)\n", this->path(), member
->name());
429 if ( ! state
.loaded
) {
430 didSome
|= state
.file
->forEachAtom(handler
);
440 template <typename A
>
441 bool File
<A
>::justInTimeforEachAtom(const char* name
, ld::File::AtomHandler
& handler
) const
443 // in force load case, all members already loaded
444 if ( _forceLoadAll
|| _forceLoadThis
)
447 // do a hash search of table of contents looking for requested symbol
448 const struct ranlib
* result
= ranlibHashSearch(name
);
449 if ( result
!= NULL
) {
450 const Entry
* member
= (Entry
*)&_archiveFileContent
[E::get32(result
->ran_off
)];
451 MemberState
& state
= this->makeObjectFileForMember(member
);
452 // only call handler for each member once
453 if ( ! state
.loaded
&& !state
.logged
) {
454 if ( _verboseLoad
) {
455 printf("%s forced load of %s(%s)\n", name
, this->path(), member
->name());
459 return state
.file
->forEachAtom(handler
);
462 //fprintf(stderr, "%s NOT found in archive %s\n", name, this->path());
466 class CheckIsDataSymbolHandler
: public ld::File::AtomHandler
469 CheckIsDataSymbolHandler(const char* n
) : _name(n
), _isData(false) {}
470 virtual void doAtom(const class ld::Atom
& atom
) {
471 if ( strcmp(atom
.name(), _name
) == 0 ) {
472 if ( atom
.section().type() != ld::Section::typeCode
)
476 virtual void doFile(const class ld::File
&) {}
477 bool symbolIsDataDefinition() { return _isData
; }
485 template <typename A
>
486 bool File
<A
>::justInTimeDataOnlyforEachAtom(const char* name
, ld::File::AtomHandler
& handler
) const
488 // in force load case, all members already loaded
489 if ( _forceLoadAll
|| _forceLoadThis
)
492 // do a hash search of table of contents looking for requested symbol
493 const struct ranlib
* result
= ranlibHashSearch(name
);
494 if ( result
!= NULL
) {
495 const Entry
* member
= (Entry
*)&_archiveFileContent
[E::get32(result
->ran_off
)];
496 MemberState
& state
= this->makeObjectFileForMember(member
);
497 // only call handler for each member once
498 if ( ! state
.loaded
) {
499 CheckIsDataSymbolHandler
checker(name
);
500 state
.file
->forEachAtom(checker
);
501 if ( checker
.symbolIsDataDefinition() ) {
502 if ( _verboseLoad
&& !state
.logged
) {
503 printf("%s forced load of %s(%s)\n", name
, this->path(), member
->name());
507 return state
.file
->forEachAtom(handler
);
511 //fprintf(stderr, "%s NOT found in archive %s\n", name, this->path());
516 typedef const struct ranlib
* ConstRanLibPtr
;
518 template <typename A
>
519 ConstRanLibPtr File
<A
>::ranlibHashSearch(const char* name
) const
521 typename
NameToEntryMap::const_iterator pos
= _hashTable
.find(name
);
522 if ( pos
!= _hashTable
.end() )
528 template <typename A
>
529 void File
<A
>::buildHashTable()
531 // walk through list backwards, adding/overwriting entries
532 // this assures that with duplicates those earliest in the list will be found
533 for (int i
= _tableOfContentCount
-1; i
>= 0; --i
) {
534 const struct ranlib
* entry
= &_tableOfContents
[i
];
535 const char* entryName
= &_tableOfContentStrings
[E::get32(entry
->ran_un
.ran_strx
)];
536 if ( E::get32(entry
->ran_off
) > _archiveFilelength
) {
537 throwf("malformed archive TOC entry for %s, offset %d is beyond end of file %lld\n",
538 entryName
, entry
->ran_off
, _archiveFilelength
);
541 //const Entry* member = (Entry*)&_archiveFileContent[E::get32(entry->ran_off)];
542 //fprintf(stderr, "adding hash %d, %s -> %p\n", i, entryName, entry);
543 _hashTable
[entryName
] = entry
;
547 template <typename A
>
548 void File
<A
>::dumpTableOfContents()
550 for (unsigned int i
=0; i
< _tableOfContentCount
; ++i
) {
551 const struct ranlib
* e
= &_tableOfContents
[i
];
552 printf("%s in %s\n", &_tableOfContentStrings
[E::get32(e
->ran_un
.ran_strx
)], ((Entry
*)&_archiveFileContent
[E::get32(e
->ran_off
)])->name());
558 // main function used by linker to instantiate archive files
560 ld::archive::File
* parse(const uint8_t* fileContent
, uint64_t fileLength
,
561 const char* path
, time_t modTime
, uint32_t ordinal
, const ParserOptions
& opts
)
563 switch ( opts
.objOpts
.architecture
) {
564 case CPU_TYPE_X86_64
:
565 if ( archive::Parser
<x86_64
>::validFile(fileContent
, fileLength
, opts
.objOpts
) )
566 return archive::Parser
<x86_64
>::parse(fileContent
, fileLength
, path
, modTime
, ordinal
, opts
);
569 if ( archive::Parser
<x86
>::validFile(fileContent
, fileLength
, opts
.objOpts
) )
570 return archive::Parser
<x86
>::parse(fileContent
, fileLength
, path
, modTime
, ordinal
, opts
);
573 if ( archive::Parser
<arm
>::validFile(fileContent
, fileLength
, opts
.objOpts
) )
574 return archive::Parser
<arm
>::parse(fileContent
, fileLength
, path
, modTime
, ordinal
, opts
);
582 }; // namespace archive