1 //===-- Archive.cpp - Generic LLVM archive functions ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains the implementation of the Archive and ArchiveMember
11 // classes that is common to both reading and writing archives..
13 //===----------------------------------------------------------------------===//
15 #include "ArchiveInternals.h"
16 #include "llvm/Bitcode/ReaderWriter.h"
17 #include "llvm/ModuleProvider.h"
18 #include "llvm/Module.h"
19 #include "llvm/Support/MemoryBuffer.h"
20 #include "llvm/System/Process.h"
25 // getMemberSize - compute the actual physical size of the file member as seen
26 // on disk. This isn't the size of member's payload. Use getSize() for that.
28 ArchiveMember::getMemberSize() const {
29 // Basically its the file size plus the header size
30 unsigned result
= info
.fileSize
+ sizeof(ArchiveMemberHeader
);
32 // If it has a long filename, include the name length
33 if (hasLongFilename())
34 result
+= path
.toString().length() + 1;
36 // If its now odd lengthed, include the padding byte
43 // This default constructor is only use by the ilist when it creates its
44 // sentry node. We give it specific static values to make it stand out a bit.
45 ArchiveMember::ArchiveMember()
46 : parent(0), path("--invalid--"), flags(0), data(0)
48 info
.user
= sys::Process::GetCurrentUserId();
49 info
.group
= sys::Process::GetCurrentGroupId();
52 info
.modTime
= sys::TimeValue::now();
55 // This is the constructor that the Archive class uses when it is building or
56 // reading an archive. It just defaults a few things and ensures the parent is
57 // set for the iplist. The Archive class fills in the ArchiveMember's data.
58 // This is required because correctly setting the data may depend on other
59 // things in the Archive.
60 ArchiveMember::ArchiveMember(Archive
* PAR
)
61 : parent(PAR
), path(), flags(0), data(0)
65 // This method allows an ArchiveMember to be replaced with the data for a
66 // different file, presumably as an update to the member. It also makes sure
67 // the flags are reset correctly.
68 bool ArchiveMember::replaceWith(const sys::Path
& newFile
, std::string
* ErrMsg
) {
69 if (!newFile
.exists()) {
71 *ErrMsg
= "Can not replace an archive member with a non-existent file";
78 // SVR4 symbol tables have an empty name
79 if (path
.toString() == ARFILE_SVR4_SYMTAB_NAME
)
80 flags
|= SVR4SymbolTableFlag
;
82 flags
&= ~SVR4SymbolTableFlag
;
84 // BSD4.4 symbol tables have a special name
85 if (path
.toString() == ARFILE_BSD4_SYMTAB_NAME
)
86 flags
|= BSD4SymbolTableFlag
;
88 flags
&= ~BSD4SymbolTableFlag
;
90 // LLVM symbol tables have a very specific name
91 if (path
.toString() == ARFILE_LLVM_SYMTAB_NAME
)
92 flags
|= LLVMSymbolTableFlag
;
94 flags
&= ~LLVMSymbolTableFlag
;
97 if (path
.toString() == ARFILE_STRTAB_NAME
)
98 flags
|= StringTableFlag
;
100 flags
&= ~StringTableFlag
;
102 // If it has a slash then it has a path
103 bool hasSlash
= path
.toString().find('/') != std::string::npos
;
105 flags
|= HasPathFlag
;
107 flags
&= ~HasPathFlag
;
109 // If it has a slash or its over 15 chars then its a long filename format
110 if (hasSlash
|| path
.toString().length() > 15)
111 flags
|= HasLongFilenameFlag
;
113 flags
&= ~HasLongFilenameFlag
;
115 // Get the signature and status info
116 const char* signature
= (const char*) data
;
119 path
.getMagicNumber(magic
,4);
120 signature
= magic
.c_str();
122 const sys::FileStatus
*FSinfo
= path
.getFileStatus(false, ErrMsg
);
129 // Determine what kind of file it is
130 switch (sys::IdentifyFileType(signature
,4)) {
132 flags
&= ~BitcodeFlag
;
138 // Archive constructor - this is the only constructor that gets used for the
139 // Archive class. Everything else (default,copy) is deprecated. This just
140 // initializes and maps the file into memory, if requested.
141 Archive::Archive(const sys::Path
& filename
)
142 : archPath(filename
), members(), mapfile(0), base(0), symTab(), strtab(),
143 symTabSize(0), firstFileOffset(0), modules(), foreignST(0) {
147 Archive::mapToMemory(std::string
* ErrMsg
) {
148 mapfile
= MemoryBuffer::getFile(archPath
.c_str(), ErrMsg
);
151 base
= mapfile
->getBufferStart();
155 void Archive::cleanUpMemory() {
156 // Shutdown the file mapping
161 // Forget the entire symbol table
167 // Free the foreign symbol table member
173 // Delete any ModuleProviders and ArchiveMember's we've allocated as a result
174 // of symbol table searches.
175 for (ModuleMap::iterator I
=modules
.begin(), E
=modules
.end(); I
!= E
; ++I
) {
176 delete I
->second
.first
;
177 delete I
->second
.second
;
181 // Archive destructor - just clean up memory
182 Archive::~Archive() {
188 static void getSymbols(Module
*M
, std::vector
<std::string
>& symbols
) {
189 // Loop over global variables
190 for (Module::global_iterator GI
= M
->global_begin(), GE
=M
->global_end(); GI
!= GE
; ++GI
)
191 if (!GI
->isDeclaration() && !GI
->hasLocalLinkage())
192 if (!GI
->getName().empty())
193 symbols
.push_back(GI
->getName());
195 // Loop over functions
196 for (Module::iterator FI
= M
->begin(), FE
= M
->end(); FI
!= FE
; ++FI
)
197 if (!FI
->isDeclaration() && !FI
->hasLocalLinkage())
198 if (!FI
->getName().empty())
199 symbols
.push_back(FI
->getName());
202 for (Module::alias_iterator AI
= M
->alias_begin(), AE
= M
->alias_end();
205 symbols
.push_back(AI
->getName());
209 // Get just the externally visible defined symbols from the bitcode
210 bool llvm::GetBitcodeSymbols(const sys::Path
& fName
,
211 std::vector
<std::string
>& symbols
,
212 std::string
* ErrMsg
) {
213 std::auto_ptr
<MemoryBuffer
> Buffer(
214 MemoryBuffer::getFileOrSTDIN(fName
.c_str()));
216 if (ErrMsg
) *ErrMsg
= "Could not open file '" + fName
.toString() + "'";
220 ModuleProvider
*MP
= getBitcodeModuleProvider(Buffer
.get(), ErrMsg
);
224 // Get the module from the provider
225 Module
* M
= MP
->materializeModule();
232 getSymbols(M
, symbols
);
234 // Done with the module.
240 llvm::GetBitcodeSymbols(const unsigned char *BufPtr
, unsigned Length
,
241 const std::string
& ModuleID
,
242 std::vector
<std::string
>& symbols
,
243 std::string
* ErrMsg
) {
244 // Get the module provider
245 MemoryBuffer
*Buffer
=MemoryBuffer::getNewMemBuffer(Length
, ModuleID
.c_str());
246 memcpy((char*)Buffer
->getBufferStart(), BufPtr
, Length
);
248 ModuleProvider
*MP
= getBitcodeModuleProvider(Buffer
, ErrMsg
);
252 // Get the module from the provider
253 Module
* M
= MP
->materializeModule();
260 getSymbols(M
, symbols
);
262 // Done with the module. Note that ModuleProvider will delete the
263 // Module when it is deleted. Also note that its the caller's responsibility
264 // to delete the ModuleProvider.