//===-- ArchiveWriter.cpp - Write LLVM archive files ----------------------===//
-//
+//
// The LLVM Compiler Infrastructure
//
-// This file was developed by Reid Spencer and is distributed under the
+// This file was developed by Reid Spencer and is distributed under the
// University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+//
//===----------------------------------------------------------------------===//
//
// Builds up an LLVM archive file (.a) containing LLVM bytecode.
#include "ArchiveInternals.h"
#include "llvm/Bytecode/Reader.h"
-#include "llvm/Support/FileUtilities.h"
#include "llvm/Support/Compressor.h"
#include "llvm/System/Signals.h"
+#include "llvm/System/Process.h"
#include <fstream>
#include <iostream>
#include <iomanip>
using namespace llvm;
-namespace {
-
// Write an integer using variable bit rate encoding. This saves a few bytes
// per entry in the symbol table.
inline void writeInteger(unsigned num, std::ofstream& ARFile) {
ARFile << (unsigned char)num;
return;
}
-
+
// Nope, we are bigger than a character, output the next 7 bits and set the
// high bit to say that there is more coming...
ARFile << (unsigned char)(0x80 | ((unsigned char)num & 0x7F));
// Compute how many bytes are taken by a given VBR encoded value. This is needed
// to pre-compute the size of the symbol table.
inline unsigned numVbrBytes(unsigned num) {
- if (num < 128) // 2^7
- return 1;
- if (num < 16384) // 2^14
- return 2;
- if (num < 2097152) // 2^21
+
+ // Note that the following nested ifs are somewhat equivalent to a binary
+ // search. We split it in half by comparing against 2^14 first. This allows
+ // most reasonable values to be done in 2 comparisons instead of 1 for
+ // small ones and four for large ones. We expect this to access file offsets
+ // in the 2^10 to 2^24 range and symbol lengths in the 2^0 to 2^8 range,
+ // so this approach is reasonable.
+ if (num < 1<<14)
+ if (num < 1<<7)
+ return 1;
+ else
+ return 2;
+ if (num < 1<<21)
return 3;
- if (num < 268435456) // 2^28
- return 4;
- return 5; // anything >= 2^28 takes 5 bytes
-}
+ if (num < 1<<28)
+ return 4;
+ return 5; // anything >= 2^28 takes 5 bytes
}
// Create an empty archive.
-Archive*
+Archive*
Archive::CreateEmpty(const sys::Path& FilePath ) {
Archive* result = new Archive(FilePath,false);
return result;
}
+// Fill the ArchiveMemberHeader with the information from a member. If
+// TruncateNames is true, names are flattened to 15 chars or less. The sz field
+// is provided here instead of coming from the mbr because the member might be
+// stored compressed and the compressed size is not the ArchiveMember's size.
+// Furthermore compressed files have negative size fields to identify them as
+// compressed.
bool
Archive::fillHeader(const ArchiveMember &mbr, ArchiveMemberHeader& hdr,
int sz, bool TruncateNames) const {
sprintf(buffer, "%-6u", mbr.getGroup());
memcpy(hdr.gid,buffer,6);
- // Set the size field
- if (sz < 0 ) {
- buffer[0] = '-';
- sprintf(&buffer[1],"%-9u",(unsigned)-sz);
- } else {
- sprintf(buffer, "%-10u", (unsigned)sz);
- }
- memcpy(hdr.size,buffer,10);
-
// Set the last modification date
uint64_t secondsSinceEpoch = mbr.getModTime().toEpochTime();
sprintf(buffer,"%-12u", unsigned(secondsSinceEpoch));
memcpy(hdr.date,buffer,12);
+ // Get rid of trailing blanks in the name
+ std::string mbrPath = mbr.getPath().toString();
+ size_t mbrLen = mbrPath.length();
+ while (mbrLen > 0 && mbrPath[mbrLen-1] == ' ') {
+ mbrPath.erase(mbrLen-1,1);
+ mbrLen--;
+ }
+
// Set the name field in one of its various flavors.
bool writeLongName = false;
- const std::string& mbrPath = mbr.getPath().get();
if (mbr.isStringTable()) {
memcpy(hdr.name,ARFILE_STRTAB_NAME,16);
- } else if (mbr.isForeignSymbolTable()) {
- memcpy(hdr.name,ARFILE_SYMTAB_NAME,16);
+ } else if (mbr.isSVR4SymbolTable()) {
+ memcpy(hdr.name,ARFILE_SVR4_SYMTAB_NAME,16);
+ } else if (mbr.isBSD4SymbolTable()) {
+ memcpy(hdr.name,ARFILE_BSD4_SYMTAB_NAME,16);
} else if (mbr.isLLVMSymbolTable()) {
memcpy(hdr.name,ARFILE_LLVM_SYMTAB_NAME,16);
} else if (TruncateNames) {
nm += slashpos + 1;
len -= slashpos +1;
}
- if (len >15)
+ if (len > 15)
len = 15;
- mbrPath.copy(hdr.name,len);
+ memcpy(hdr.name,nm,len);
hdr.name[len] = '/';
} else if (mbrPath.length() < 16 && mbrPath.find('/') == std::string::npos) {
- mbrPath.copy(hdr.name,mbrPath.length());
+ memcpy(hdr.name,mbrPath.c_str(),mbrPath.length());
hdr.name[mbrPath.length()] = '/';
} else {
std::string nm = "#1/";
nm += utostr(mbrPath.length());
- nm.copy(hdr.name,nm.length());
+ memcpy(hdr.name,nm.data(),nm.length());
+ if (sz < 0)
+ sz -= mbrPath.length();
+ else
+ sz += mbrPath.length();
writeLongName = true;
}
+
+ // Set the size field
+ if (sz < 0) {
+ buffer[0] = '-';
+ sprintf(&buffer[1],"%-9u",(unsigned)-sz);
+ } else {
+ sprintf(buffer, "%-10u", (unsigned)sz);
+ }
+ memcpy(hdr.size,buffer,10);
+
return writeLongName;
}
+// Insert a file into the archive before some other member. This also takes care
+// of extracting the necessary flags and information from the file.
void
Archive::addFileBefore(const sys::Path& filePath, iterator where) {
assert(filePath.exists() && "Can't add a non-existent file");
mbr->path.getStatusInfo(mbr->info);
unsigned flags = 0;
- bool hasSlash = filePath.get().find('/') != std::string::npos;
+ bool hasSlash = filePath.toString().find('/') != std::string::npos;
if (hasSlash)
flags |= ArchiveMember::HasPathFlag;
- if (hasSlash || filePath.get().length() > 15)
+ if (hasSlash || filePath.toString().length() > 15)
flags |= ArchiveMember::HasLongFilenameFlag;
std::string magic;
mbr->path.getMagicNumber(magic,4);
members.insert(where,mbr);
}
-void
-Archive::moveMemberBefore(iterator target, iterator where) {
- assert(target != end() && "Target iterator for moveMemberBefore is invalid");
- ArchiveMember* mbr = members.remove(target);
- members.insert(where, mbr);
-}
-
-void
-Archive::remove(iterator target) {
- assert(target != end() && "Target iterator for remove is invalid");
- ArchiveMember* mbr = members.remove(target);
- delete mbr;
-}
+// Write one member out to the file.
void
Archive::writeMember(
const ArchiveMember& member,
std::ofstream& ARFile,
bool CreateSymbolTable,
bool TruncateNames,
- bool ShouldCompress
+ bool ShouldCompress
) {
unsigned filepos = ARFile.tellp();
mFile = new sys::MappedFile(member.getPath());
data = (const char*) mFile->map();
fSize = mFile->size();
- }
+ }
- // Now that we have the data in memory, update the
+ // Now that we have the data in memory, update the
// symbol table if its a bytecode file.
- if (CreateSymbolTable &&
+ if (CreateSymbolTable &&
(member.isBytecode() || member.isCompressedBytecode())) {
std::vector<std::string> symbols;
- GetBytecodeSymbols((const unsigned char*)data,fSize,member.getPath().get(),
- symbols);
- for (std::vector<std::string>::iterator SI = symbols.begin(),
- SE = symbols.end(); SI != SE; ++SI) {
-
- std::pair<SymTabType::iterator,bool> Res =
- symTab.insert(std::make_pair(*SI,filepos));
-
- if (Res.second) {
- symTabSize += SI->length() +
- numVbrBytes(SI->length()) +
- numVbrBytes(filepos);
+ std::string FullMemberName = archPath.toString() + "(" +
+ member.getPath().toString()
+ + ")";
+ ModuleProvider* MP = GetBytecodeSymbols(
+ (const unsigned char*)data,fSize,FullMemberName, symbols);
+
+ // If the bytecode parsed successfully
+ if ( MP ) {
+ for (std::vector<std::string>::iterator SI = symbols.begin(),
+ SE = symbols.end(); SI != SE; ++SI) {
+
+ std::pair<SymTabType::iterator,bool> Res =
+ symTab.insert(std::make_pair(*SI,filepos));
+
+ if (Res.second) {
+ symTabSize += SI->length() +
+ numVbrBytes(SI->length()) +
+ numVbrBytes(filepos);
+ }
}
+ // We don't need this module any more.
+ delete MP;
+ } else {
+ throw std::string("Can't parse bytecode member: ") +
+ member.getPath().toString();
}
}
// Determine if we actually should compress this member
- bool willCompress =
- (ShouldCompress &&
- !member.isForeignSymbolTable() &&
+ bool willCompress =
+ (ShouldCompress &&
+ !member.isCompressed() &&
+ !member.isCompressedBytecode() &&
!member.isLLVMSymbolTable() &&
- !member.isCompressed() &&
- !member.isCompressedBytecode());
+ !member.isSVR4SymbolTable() &&
+ !member.isBSD4SymbolTable());
// Perform the compression. Note that if the file is uncompressed bytecode
// then we turn the file into compressed bytecode rather than treating it as
data +=4;
fSize -= 4;
}
- fSize = Compressor::compressToNewBuffer(
- data,fSize,output,Compressor::COMP_TYPE_ZLIB);
+ fSize = Compressor::compressToNewBuffer(data,fSize,output);
data = output;
if (member.isBytecode())
- hdrSize = -fSize-4;
+ hdrSize = -fSize-4;
else
hdrSize = -fSize;
} else {
// Write the long filename if its long
if (writeLongName) {
- ARFile << member.getPath().c_str();
- ARFile << '\n';
+ ARFile.write(member.getPath().toString().data(),
+ member.getPath().toString().length());
}
// Make sure we write the compressed bytecode magic number if we should.
ARFile.write(data,fSize);
// Make sure the member is an even length
- if (ARFile.tellp() % 2 != 0)
+ if ((ARFile.tellp() & 1) == 1)
ARFile << ARFILE_PAD;
// Free the compressed data, if necessary
// Close the mapped file if it was opened
if (mFile != 0) {
- mFile->unmap();
+ mFile->close();
delete mFile;
}
}
+// Write out the LLVM symbol table as an archive member to the file.
void
-Archive::writeSymbolTable(std::ofstream& ARFile,bool PrintSymTab ) {
+Archive::writeSymbolTable(std::ofstream& ARFile) {
// Construct the symbol table's header
ArchiveMemberHeader Hdr;
memcpy(Hdr.name,ARFILE_LLVM_SYMTAB_NAME,16);
uint64_t secondsSinceEpoch = sys::TimeValue::now().toEpochTime();
char buffer[32];
+ sprintf(buffer, "%-8o", 0644);
+ memcpy(Hdr.mode,buffer,8);
+ sprintf(buffer, "%-6u", sys::Process::GetCurrentUserId());
+ memcpy(Hdr.uid,buffer,6);
+ sprintf(buffer, "%-6u", sys::Process::GetCurrentGroupId());
+ memcpy(Hdr.gid,buffer,6);
sprintf(buffer,"%-12u", unsigned(secondsSinceEpoch));
memcpy(Hdr.date,buffer,12);
sprintf(buffer,"%-10u",symTabSize);
// Save the starting position of the symbol tables data content.
unsigned startpos = ARFile.tellp();
- // Print the symbol table header if we're supposed to
- if (PrintSymTab)
- std::cout << "Symbol Table:\n";
-
// Write out the symbols sequentially
for ( Archive::SymTabType::iterator I = symTab.begin(), E = symTab.end();
I != E; ++I)
writeInteger(I->first.length(), ARFile);
// Write out the symbol
ARFile.write(I->first.data(), I->first.length());
-
- // Print this entry to std::cout if we should
- if (PrintSymTab) {
- unsigned filepos = I->second + symTabSize + sizeof(ArchiveMemberHeader) +
- (symTabSize % 2 != 0) + 8;
- std::cout << " " << std::setw(9) << filepos << "\t" << I->first << "\n";
- }
}
// Now that we're done with the symbol table, get the ending file position
ARFile << ARFILE_PAD;
}
+// Write the entire archive to the file specified when the archive was created.
+// This writes to a temporary file first. Options are for creating a symbol
+// table, flattening the file names (no directories, 15 chars max) and
+// compressing each archive member.
void
-Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames,
- bool Compress, bool PrintSymTab) {
-
+Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames, bool Compress){
+
// Make sure they haven't opened up the file, not loaded it,
// but are now trying to write it which would wipe out the file.
- assert(!(members.empty() && mapfile->size() > 8));
+ assert(!(members.empty() && mapfile->size() > 8) &&
+ "Can't write an archive not opened for writing");
// Create a temporary file to store the archive in
sys::Path TmpArchive = archPath;
- TmpArchive.createTemporaryFile();
+ TmpArchive.createTemporaryFileOnDisk();
// Make sure the temporary gets removed if we crash
sys::RemoveFileOnSignal(TmpArchive);
// Ensure we can remove the temporary even in the face of an exception
try {
// Create archive file for output.
- std::ofstream ArchiveFile(TmpArchive.c_str());
-
+ std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
+ std::ios::binary;
+ std::ofstream ArchiveFile(TmpArchive.c_str(), io_mode);
+
// Check for errors opening or creating archive file.
if ( !ArchiveFile.is_open() || ArchiveFile.bad() ) {
- throw std::string("Error opening archive file: ") + archPath.get();
+ throw std::string("Error opening archive file: ") + archPath.toString();
}
// If we're creating a symbol table, reset it now
// ensure compatibility with other archivers we need to put the symbol
// table first in the file. Unfortunately, this means mapping the file
// we just wrote back in and copying it to the destination file.
+
+ // Map in the archive we just wrote.
sys::MappedFile arch(TmpArchive);
const char* base = (const char*) arch.map();
- // Open the final file to write and check it.
- std::ofstream FinalFile(archPath.c_str());
- if ( !FinalFile.is_open() || FinalFile.bad() ) {
- throw std::string("Error opening archive file: ") + archPath.get();
+ // Open another temporary file in order to avoid invalidating the mmapped data
+ sys::Path FinalFilePath = archPath;
+ FinalFilePath.createTemporaryFileOnDisk();
+ sys::RemoveFileOnSignal(FinalFilePath);
+ try {
+
+
+ std::ofstream FinalFile(FinalFilePath.c_str(), io_mode);
+ if ( !FinalFile.is_open() || FinalFile.bad() ) {
+ throw std::string("Error opening archive file: ") + FinalFilePath.toString();
+ }
+
+ // Write the file magic number
+ FinalFile << ARFILE_MAGIC;
+
+ // If there is a foreign symbol table, put it into the file now. Most
+ // ar(1) implementations require the symbol table to be first but llvm-ar
+ // can deal with it being after a foreign symbol table. This ensures
+ // compatibility with other ar(1) implementations as well as allowing the
+ // archive to store both native .o and LLVM .bc files, both indexed.
+ if (foreignST) {
+ writeMember(*foreignST, FinalFile, false, false, false);
+ }
+
+ // Put out the LLVM symbol table now.
+ writeSymbolTable(FinalFile);
+
+ // Copy the temporary file contents being sure to skip the file's magic
+ // number.
+ FinalFile.write(base + sizeof(ARFILE_MAGIC)-1,
+ arch.size()-sizeof(ARFILE_MAGIC)+1);
+
+ // Close up shop
+ FinalFile.close();
+ arch.close();
+
+ // Move the final file over top of TmpArchive
+ FinalFilePath.renamePathOnDisk(TmpArchive);
+ } catch (...) {
+ // Make sure we clean up.
+ if (FinalFilePath.exists())
+ FinalFilePath.eraseFromDisk();
+ throw;
}
-
- // Write the file magic number
- FinalFile << ARFILE_MAGIC;
-
- // Put out the symbol table
- writeSymbolTable(FinalFile,PrintSymTab);
-
- // Copy the temporary file contents being sure to skip the file's magic
- // number.
- FinalFile.write(base + sizeof(ARFILE_MAGIC)-1,
- arch.size()-sizeof(ARFILE_MAGIC)+1);
-
- // Close up shop
- FinalFile.close();
- arch.unmap();
- TmpArchive.destroyFile();
-
- } else {
- // We don't have to insert the symbol table, so just renaming the temp
- // file to the correct name will suffice.
- TmpArchive.renameFile(archPath);
}
+
+ // Before we replace the actual archive, we need to forget all the
+ // members, since they point to data in that old archive. We need to do
+ // we cannot replace an open file on Windows.
+ cleanUpMemory();
+
+ TmpArchive.renamePathOnDisk(archPath);
} catch (...) {
// Make sure we clean up.
if (TmpArchive.exists())
- TmpArchive.destroyFile();
+ TmpArchive.eraseFromDisk();
throw;
}
}
projects / oota-llvm.git / blobdiff