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/ModuleProvider.h"
17 #include "llvm/Module.h"
18 #include "llvm/Bytecode/Reader.h"
19 #include "llvm/System/Process.h"
22 // getMemberSize - compute the actual physical size of the file member as seen
23 // on disk. This isn't the size of member's payload. Use getSize() for that.
25 ArchiveMember::getMemberSize() const {
26 // Basically its the file size plus the header size
27 unsigned result = info.fileSize + sizeof(ArchiveMemberHeader);
29 // If it has a long filename, include the name length
30 if (hasLongFilename())
31 result += path.toString().length() + 1;
33 // If its now odd lengthed, include the padding byte
40 // This default constructor is only use by the ilist when it creates its
41 // sentry node. We give it specific static values to make it stand out a bit.
42 ArchiveMember::ArchiveMember()
43 : next(0), prev(0), parent(0), path("--invalid--"), flags(0), data(0)
45 info.user = sys::Process::GetCurrentUserId();
46 info.group = sys::Process::GetCurrentGroupId();
49 info.modTime = sys::TimeValue::now();
52 // This is the constructor that the Archive class uses when it is building or
53 // reading an archive. It just defaults a few things and ensures the parent is
54 // set for the iplist. The Archive class fills in the ArchiveMember's data.
55 // This is required because correctly setting the data may depend on other
56 // things in the Archive.
57 ArchiveMember::ArchiveMember(Archive* PAR)
58 : next(0), prev(0), parent(PAR), path(), flags(0), data(0)
62 // This method allows an ArchiveMember to be replaced with the data for a
63 // different file, presumably as an update to the member. It also makes sure
64 // the flags are reset correctly.
65 bool ArchiveMember::replaceWith(const sys::Path& newFile, std::string* ErrMsg) {
66 if (!newFile.exists()) {
68 *ErrMsg = "Can not replace an archive member with a non-existent file";
75 // SVR4 symbol tables have an empty name
76 if (path.toString() == ARFILE_SVR4_SYMTAB_NAME)
77 flags |= SVR4SymbolTableFlag;
79 flags &= ~SVR4SymbolTableFlag;
81 // BSD4.4 symbol tables have a special name
82 if (path.toString() == ARFILE_BSD4_SYMTAB_NAME)
83 flags |= BSD4SymbolTableFlag;
85 flags &= ~BSD4SymbolTableFlag;
87 // LLVM symbol tables have a very specific name
88 if (path.toString() == ARFILE_LLVM_SYMTAB_NAME)
89 flags |= LLVMSymbolTableFlag;
91 flags &= ~LLVMSymbolTableFlag;
94 if (path.toString() == ARFILE_STRTAB_NAME)
95 flags |= StringTableFlag;
97 flags &= ~StringTableFlag;
99 // If it has a slash then it has a path
100 bool hasSlash = path.toString().find('/') != std::string::npos;
102 flags |= HasPathFlag;
104 flags &= ~HasPathFlag;
106 // If it has a slash or its over 15 chars then its a long filename format
107 if (hasSlash || path.toString().length() > 15)
108 flags |= HasLongFilenameFlag;
110 flags &= ~HasLongFilenameFlag;
112 // Get the signature and status info
113 const char* signature = (const char*) data;
116 path.getMagicNumber(magic,4);
117 signature = magic.c_str();
119 const sys::FileStatus *FSinfo = path.getFileStatus(false, ErrMsg);
126 // Determine what kind of file it is
127 switch (sys::IdentifyFileType(signature,4)) {
128 case sys::BytecodeFileType:
129 flags |= BytecodeFlag;
131 case sys::CompressedBytecodeFileType:
132 flags |= CompressedBytecodeFlag;
133 flags &= ~CompressedFlag;
136 flags &= ~(BytecodeFlag|CompressedBytecodeFlag);
142 // Archive constructor - this is the only constructor that gets used for the
143 // Archive class. Everything else (default,copy) is deprecated. This just
144 // initializes and maps the file into memory, if requested.
145 Archive::Archive(const sys::Path& filename, BCDecompressor_t *BCDC)
146 : archPath(filename), members(), mapfile(0), base(0), symTab(), strtab(),
147 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 bytecode
214 bool llvm::GetBytecodeSymbols(const sys::Path& fName,
215 std::vector<std::string>& symbols,
216 BCDecompressor_t *BCDC,
217 std::string* ErrMsg) {
218 ModuleProvider *MP = getBytecodeModuleProvider(fName.toString(), BCDC,ErrMsg);
222 // Get the module from the provider
223 Module* M = MP->materializeModule();
230 getSymbols(M, symbols);
232 // Done with the module.
238 llvm::GetBytecodeSymbols(const unsigned char*Buffer, unsigned Length,
239 const std::string& ModuleID,
240 std::vector<std::string>& symbols,
241 BCDecompressor_t *BCDC,
242 std::string* ErrMsg) {
243 // Get the module provider
245 getBytecodeBufferModuleProvider(Buffer, Length, ModuleID, BCDC, ErrMsg, 0);
249 // Get the module from the provider
250 Module* M = MP->materializeModule();
257 getSymbols(M, symbols);
259 // Done with the module. Note that ModuleProvider will delete the
260 // Module when it is deleted. Also note that its the caller's responsibility
261 // to delete the ModuleProvider.