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/MappedFile.h"
21 #include "llvm/System/Process.h"
26 // getMemberSize - compute the actual physical size of the file member as seen
27 // on disk. This isn't the size of member's payload. Use getSize() for that.
29 ArchiveMember::getMemberSize() const {
30 // Basically its the file size plus the header size
31 unsigned result = info.fileSize + sizeof(ArchiveMemberHeader);
33 // If it has a long filename, include the name length
34 if (hasLongFilename())
35 result += path.toString().length() + 1;
37 // If its now odd lengthed, include the padding byte
44 // This default constructor is only use by the ilist when it creates its
45 // sentry node. We give it specific static values to make it stand out a bit.
46 ArchiveMember::ArchiveMember()
47 : next(0), prev(0), parent(0), path("--invalid--"), flags(0), data(0)
49 info.user = sys::Process::GetCurrentUserId();
50 info.group = sys::Process::GetCurrentGroupId();
53 info.modTime = sys::TimeValue::now();
56 // This is the constructor that the Archive class uses when it is building or
57 // reading an archive. It just defaults a few things and ensures the parent is
58 // set for the iplist. The Archive class fills in the ArchiveMember's data.
59 // This is required because correctly setting the data may depend on other
60 // things in the Archive.
61 ArchiveMember::ArchiveMember(Archive* PAR)
62 : next(0), prev(0), parent(PAR), path(), flags(0), data(0)
66 // This method allows an ArchiveMember to be replaced with the data for a
67 // different file, presumably as an update to the member. It also makes sure
68 // the flags are reset correctly.
69 bool ArchiveMember::replaceWith(const sys::Path& newFile, std::string* ErrMsg) {
70 if (!newFile.exists()) {
72 *ErrMsg = "Can not replace an archive member with a non-existent file";
79 // SVR4 symbol tables have an empty name
80 if (path.toString() == ARFILE_SVR4_SYMTAB_NAME)
81 flags |= SVR4SymbolTableFlag;
83 flags &= ~SVR4SymbolTableFlag;
85 // BSD4.4 symbol tables have a special name
86 if (path.toString() == ARFILE_BSD4_SYMTAB_NAME)
87 flags |= BSD4SymbolTableFlag;
89 flags &= ~BSD4SymbolTableFlag;
91 // LLVM symbol tables have a very specific name
92 if (path.toString() == ARFILE_LLVM_SYMTAB_NAME)
93 flags |= LLVMSymbolTableFlag;
95 flags &= ~LLVMSymbolTableFlag;
98 if (path.toString() == ARFILE_STRTAB_NAME)
99 flags |= StringTableFlag;
101 flags &= ~StringTableFlag;
103 // If it has a slash then it has a path
104 bool hasSlash = path.toString().find('/') != std::string::npos;
106 flags |= HasPathFlag;
108 flags &= ~HasPathFlag;
110 // If it has a slash or its over 15 chars then its a long filename format
111 if (hasSlash || path.toString().length() > 15)
112 flags |= HasLongFilenameFlag;
114 flags &= ~HasLongFilenameFlag;
116 // Get the signature and status info
117 const char* signature = (const char*) data;
120 path.getMagicNumber(magic,4);
121 signature = magic.c_str();
123 const sys::FileStatus *FSinfo = path.getFileStatus(false, ErrMsg);
130 // Determine what kind of file it is
131 switch (sys::IdentifyFileType(signature,4)) {
133 flags &= ~BitcodeFlag;
139 // Archive constructor - this is the only constructor that gets used for the
140 // Archive class. Everything else (default,copy) is deprecated. This just
141 // initializes and maps the file into memory, if requested.
142 Archive::Archive(const sys::Path& filename)
143 : archPath(filename), members(), mapfile(0), base(0), symTab(), strtab(),
144 symTabSize(0), firstFileOffset(0), modules(), foreignST(0) {
148 Archive::mapToMemory(std::string* ErrMsg)
150 mapfile = new sys::MappedFile();
151 if (mapfile->open(archPath, ErrMsg))
153 if (!(base = (char*) mapfile->map(ErrMsg)))
158 void Archive::cleanUpMemory() {
159 // Shutdown the file mapping
168 // Forget the entire symbol table
174 // Free the foreign symbol table member
180 // Delete any ModuleProviders and ArchiveMember's we've allocated as a result
181 // of symbol table searches.
182 for (ModuleMap::iterator I=modules.begin(), E=modules.end(); I != E; ++I ) {
183 delete I->second.first;
184 delete I->second.second;
188 // Archive destructor - just clean up memory
189 Archive::~Archive() {
195 static void getSymbols(Module*M, std::vector<std::string>& symbols) {
196 // Loop over global variables
197 for (Module::global_iterator GI = M->global_begin(), GE=M->global_end(); GI != GE; ++GI)
198 if (!GI->isDeclaration() && !GI->hasInternalLinkage())
199 if (!GI->getName().empty())
200 symbols.push_back(GI->getName());
202 // Loop over functions
203 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI)
204 if (!FI->isDeclaration() && !FI->hasInternalLinkage())
205 if (!FI->getName().empty())
206 symbols.push_back(FI->getName());
209 for (Module::alias_iterator AI = M->alias_begin(), AE = M->alias_end();
212 symbols.push_back(AI->getName());
216 // Get just the externally visible defined symbols from the bitcode
217 bool llvm::GetBitcodeSymbols(const sys::Path& fName,
218 std::vector<std::string>& symbols,
219 std::string* ErrMsg) {
220 std::auto_ptr<MemoryBuffer> Buffer(
221 MemoryBuffer::getFileOrSTDIN(&fName.toString()[0],
222 fName.toString().size()));
224 if (ErrMsg) *ErrMsg = "Could not open file '" + fName.toString() + "'";
228 ModuleProvider *MP = getBitcodeModuleProvider(Buffer.get(), ErrMsg);
232 // Get the module from the provider
233 Module* M = MP->materializeModule();
240 getSymbols(M, symbols);
242 // Done with the module.
248 llvm::GetBitcodeSymbols(const unsigned char *BufPtr, unsigned Length,
249 const std::string& ModuleID,
250 std::vector<std::string>& symbols,
251 std::string* ErrMsg) {
252 // Get the module provider
253 MemoryBuffer *Buffer =MemoryBuffer::getNewMemBuffer(Length, ModuleID.c_str());
254 memcpy((char*)Buffer->getBufferStart(), BufPtr, Length);
256 ModuleProvider *MP = getBitcodeModuleProvider(Buffer, ErrMsg);
260 // Get the module from the provider
261 Module* M = MP->materializeModule();
268 getSymbols(M, symbols);
270 // Done with the module. Note that ModuleProvider will delete the
271 // Module when it is deleted. Also note that its the caller's responsibility
272 // to delete the ModuleProvider.