1 //===-- Archive.cpp - Generic LLVM archive functions ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Reid Spencer and is distributed under the
6 // University of Illinois Open Source 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"
23 // getMemberSize - compute the actual physical size of the file member as seen
24 // on disk. This isn't the size of member's payload. Use getSize() for that.
26 ArchiveMember::getMemberSize() const {
27 // Basically its the file size plus the header size
28 unsigned result = info.fileSize + sizeof(ArchiveMemberHeader);
30 // If it has a long filename, include the name length
31 if (hasLongFilename())
32 result += path.toString().length() + 1;
34 // If its now odd lengthed, include the padding byte
41 // This default constructor is only use by the ilist when it creates its
42 // sentry node. We give it specific static values to make it stand out a bit.
43 ArchiveMember::ArchiveMember()
44 : next(0), prev(0), parent(0), path("--invalid--"), flags(0), data(0)
46 info.user = sys::Process::GetCurrentUserId();
47 info.group = sys::Process::GetCurrentGroupId();
50 info.modTime = sys::TimeValue::now();
53 // This is the constructor that the Archive class uses when it is building or
54 // reading an archive. It just defaults a few things and ensures the parent is
55 // set for the iplist. The Archive class fills in the ArchiveMember's data.
56 // This is required because correctly setting the data may depend on other
57 // things in the Archive.
58 ArchiveMember::ArchiveMember(Archive* PAR)
59 : next(0), prev(0), parent(PAR), path(), flags(0), data(0)
63 // This method allows an ArchiveMember to be replaced with the data for a
64 // different file, presumably as an update to the member. It also makes sure
65 // the flags are reset correctly.
66 bool ArchiveMember::replaceWith(const sys::Path& newFile, std::string* ErrMsg) {
67 if (!newFile.exists()) {
69 *ErrMsg = "Can not replace an archive member with a non-existent file";
76 // SVR4 symbol tables have an empty name
77 if (path.toString() == ARFILE_SVR4_SYMTAB_NAME)
78 flags |= SVR4SymbolTableFlag;
80 flags &= ~SVR4SymbolTableFlag;
82 // BSD4.4 symbol tables have a special name
83 if (path.toString() == ARFILE_BSD4_SYMTAB_NAME)
84 flags |= BSD4SymbolTableFlag;
86 flags &= ~BSD4SymbolTableFlag;
88 // LLVM symbol tables have a very specific name
89 if (path.toString() == ARFILE_LLVM_SYMTAB_NAME)
90 flags |= LLVMSymbolTableFlag;
92 flags &= ~LLVMSymbolTableFlag;
95 if (path.toString() == ARFILE_STRTAB_NAME)
96 flags |= StringTableFlag;
98 flags &= ~StringTableFlag;
100 // If it has a slash then it has a path
101 bool hasSlash = path.toString().find('/') != std::string::npos;
103 flags |= HasPathFlag;
105 flags &= ~HasPathFlag;
107 // If it has a slash or its over 15 chars then its a long filename format
108 if (hasSlash || path.toString().length() > 15)
109 flags |= HasLongFilenameFlag;
111 flags &= ~HasLongFilenameFlag;
113 // Get the signature and status info
114 const char* signature = (const char*) data;
117 path.getMagicNumber(magic,4);
118 signature = magic.c_str();
120 const sys::FileStatus *FSinfo = path.getFileStatus(false, ErrMsg);
127 // Determine what kind of file it is
128 switch (sys::IdentifyFileType(signature,4)) {
129 case sys::Bytecode_FileType:
130 flags |= BytecodeFlag;
132 case sys::CompressedBytecode_FileType:
133 flags |= CompressedBytecodeFlag;
134 flags &= ~CompressedFlag;
137 flags &= ~(BytecodeFlag|CompressedBytecodeFlag);
143 // Archive constructor - this is the only constructor that gets used for the
144 // Archive class. Everything else (default,copy) is deprecated. This just
145 // initializes and maps the file into memory, if requested.
146 Archive::Archive(const sys::Path& filename)
147 : archPath(filename), members(), mapfile(0), base(0), symTab(), strtab(),
148 symTabSize(0), firstFileOffset(0), modules(), foreignST(0) {
152 Archive::mapToMemory(std::string* ErrMsg)
154 mapfile = new sys::MappedFile();
155 if (mapfile->open(archPath, sys::MappedFile::READ_ACCESS, ErrMsg))
157 if (!(base = (char*) mapfile->map(ErrMsg)))
162 void Archive::cleanUpMemory() {
163 // Shutdown the file mapping
172 // Forget the entire symbol table
178 // Free the foreign symbol table member
184 // Delete any ModuleProviders and ArchiveMember's we've allocated as a result
185 // of symbol table searches.
186 for (ModuleMap::iterator I=modules.begin(), E=modules.end(); I != E; ++I ) {
187 delete I->second.first;
188 delete I->second.second;
192 // Archive destructor - just clean up memory
193 Archive::~Archive() {
199 static void getSymbols(Module*M, std::vector<std::string>& symbols) {
200 // Loop over global variables
201 for (Module::global_iterator GI = M->global_begin(), GE=M->global_end(); GI != GE; ++GI)
202 if (!GI->isDeclaration() && !GI->hasInternalLinkage())
203 if (!GI->getName().empty())
204 symbols.push_back(GI->getName());
206 // Loop over functions.
207 for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI)
208 if (!FI->isDeclaration() && !FI->hasInternalLinkage())
209 if (!FI->getName().empty())
210 symbols.push_back(FI->getName());
213 // Get just the externally visible defined symbols from the bitcode
214 bool llvm::GetBitcodeSymbols(const sys::Path& fName,
215 std::vector<std::string>& symbols,
216 std::string* ErrMsg) {
217 std::auto_ptr<MemoryBuffer> Buffer(
218 MemoryBuffer::getFileOrSTDIN(&fName.toString()[0],
219 fName.toString().size()));
221 if (ErrMsg) *ErrMsg = "Could not open file '" + fName.toString() + "'";
225 ModuleProvider *MP = getBitcodeModuleProvider(Buffer.get(), ErrMsg);
229 // Get the module from the provider
230 Module* M = MP->materializeModule();
237 getSymbols(M, symbols);
239 // Done with the module.
245 llvm::GetBitcodeSymbols(const unsigned char *BufPtr, unsigned Length,
246 const std::string& ModuleID,
247 std::vector<std::string>& symbols,
248 std::string* ErrMsg) {
249 // Get the module provider
250 MemoryBuffer *Buffer =MemoryBuffer::getNewMemBuffer(Length, ModuleID.c_str());
251 memcpy((char*)Buffer->getBufferStart(), BufPtr, Length);
253 ModuleProvider *MP = getBitcodeModuleProvider(Buffer, ErrMsg);
257 // Get the module from the provider
258 Module* M = MP->materializeModule();
265 getSymbols(M, symbols);
267 // Done with the module. Note that ModuleProvider will delete the
268 // Module when it is deleted. Also note that its the caller's responsibility
269 // to delete the ModuleProvider.