//===- Support/FileUtilities.cpp - File System Utilities ------------------===//
-//
+//
// The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+//
//===----------------------------------------------------------------------===//
//
// This file implements a family of utility functions which are useful for doing
//
//===----------------------------------------------------------------------===//
-#include "Support/FileUtilities.h"
-#include "Config/unistd.h"
-#include "Config/fcntl.h"
-#include "Config/sys/stat.h"
-#include "Config/sys/types.h"
-#include "Config/sys/mman.h"
-#include <fstream>
-#include <iostream>
-#include <cstdio>
+#include "llvm/Support/FileUtilities.h"
+#include "llvm/System/Path.h"
+#include "llvm/System/MappedFile.h"
+#include "llvm/ADT/StringExtras.h"
+#include <cstring>
+#include <cctype>
using namespace llvm;
-/// CheckMagic - Returns true IFF the file named FN begins with Magic. FN must
-/// name a readable file.
-///
-bool llvm::CheckMagic(const std::string &FN, const std::string &Magic) {
- char buf[1 + Magic.size ()];
- std::ifstream f (FN.c_str ());
- f.read (buf, Magic.size ());
- buf[Magic.size ()] = '\0';
- return Magic == buf;
-}
-
-/// IsArchive - Returns true IFF the file named FN appears to be a "ar" library
-/// archive. The file named FN must exist.
-///
-bool llvm::IsArchive(const std::string &FN) {
- // Inspect the beginning of the file to see if it contains the "ar"
- // library archive format magic string.
- return CheckMagic (FN, "!<arch>\012");
-}
-
-/// IsBytecode - Returns true IFF the file named FN appears to be an LLVM
-/// bytecode file. The file named FN must exist.
-///
-bool llvm::IsBytecode(const std::string &FN) {
- // Inspect the beginning of the file to see if it contains the LLVM
- // bytecode format magic string.
- return CheckMagic (FN, "llvm");
+static bool isNumberChar(char C) {
+ switch (C) {
+ case '0': case '1': case '2': case '3': case '4':
+ case '5': case '6': case '7': case '8': case '9':
+ case '.': case '+': case '-':
+ case 'D': // Strange exponential notation.
+ case 'd': // Strange exponential notation.
+ case 'e':
+ case 'E': return true;
+ default: return false;
+ }
}
-/// IsSharedObject - Returns trus IFF the file named FN appears to be a shared
-/// object with an ELF header. The file named FN must exist.
-///
-bool llvm::IsSharedObject(const std::string &FN) {
- // Inspect the beginning of the file to see if it contains the ELF shared
- // object magic string.
- static const char elfMagic[] = { 0x7f, 'E', 'L', 'F', '\0' };
- return CheckMagic(FN, elfMagic);
-}
+static char *BackupNumber(char *Pos, char *FirstChar) {
+ // If we didn't stop in the middle of a number, don't backup.
+ if (!isNumberChar(*Pos)) return Pos;
-/// FileOpenable - Returns true IFF Filename names an existing regular
-/// file which we can successfully open.
-///
-bool llvm::FileOpenable(const std::string &Filename) {
- struct stat s;
- if (stat (Filename.c_str (), &s) == -1)
- return false; // Cannot stat file
- if (!S_ISREG (s.st_mode))
- return false; // File is not a regular file
- std::ifstream FileStream (Filename.c_str ());
- if (!FileStream)
- return false; // File is not openable
- return true;
+ // Otherwise, return to the start of the number.
+ while (Pos > FirstChar && isNumberChar(Pos[-1]))
+ --Pos;
+ return Pos;
}
-/// DiffFiles - Compare the two files specified, returning true if they are
-/// different or if there is a file error. If you specify a string to fill in
-/// for the error option, it will set the string to an error message if an error
-/// occurs, allowing the caller to distinguish between a failed diff and a file
-/// system error.
-///
-bool llvm::DiffFiles(const std::string &FileA, const std::string &FileB,
- std::string *Error) {
- std::ifstream FileAStream(FileA.c_str());
- if (!FileAStream) {
- if (Error) *Error = "Couldn't open file '" + FileA + "'";
- return true;
+/// CompareNumbers - compare two numbers, returning true if they are different.
+static bool CompareNumbers(char *&F1P, char *&F2P, char *F1End, char *F2End,
+ double AbsTolerance, double RelTolerance,
+ std::string *ErrorMsg) {
+ char *F1NumEnd, *F2NumEnd;
+ double V1 = 0.0, V2 = 0.0;
+
+ // If one of the positions is at a space and the other isn't, chomp up 'til
+ // the end of the space.
+ while (isspace(*F1P) && F1P != F1End)
+ ++F1P;
+ while (isspace(*F2P) && F2P != F2End)
+ ++F2P;
+
+ // If we stop on numbers, compare their difference. Note that some ugliness
+ // is built into this to permit support for numbers that use "D" or "d" as
+ // their exponential marker, e.g. "1.234D45". This occurs in 200.sixtrack in
+ // spec2k.
+ if (isNumberChar(*F1P) && isNumberChar(*F2P)) {
+ bool isDNotation;
+ do {
+ isDNotation = false;
+ V1 = strtod(F1P, &F1NumEnd);
+ V2 = strtod(F2P, &F2NumEnd);
+
+ if (*F1NumEnd == 'D' || *F1NumEnd == 'd') {
+ *F1NumEnd = 'e'; // Strange exponential notation!
+ isDNotation = true;
+ }
+ if (*F2NumEnd == 'D' || *F2NumEnd == 'd') {
+ *F2NumEnd = 'e'; // Strange exponential notation!
+ isDNotation = true;
+ }
+ } while (isDNotation);
+ } else {
+ // Otherwise, the diff failed.
+ F1NumEnd = F1P;
+ F2NumEnd = F2P;
}
- std::ifstream FileBStream(FileB.c_str());
- if (!FileBStream) {
- if (Error) *Error = "Couldn't open file '" + FileB + "'";
+ if (F1NumEnd == F1P || F2NumEnd == F2P) {
+ if (ErrorMsg) {
+ *ErrorMsg = "FP Comparison failed, not a numeric difference between '";
+ *ErrorMsg += F1P[0];
+ *ErrorMsg += "' and '";
+ *ErrorMsg += F2P[0];
+ *ErrorMsg += "'";
+ }
return true;
}
- // Compare the two files...
- int C1, C2;
- do {
- C1 = FileAStream.get();
- C2 = FileBStream.get();
- if (C1 != C2) return true;
- } while (C1 != EOF);
-
- return false;
-}
-
-
-/// CopyFile - Copy the specified source file to the specified destination,
-/// overwriting destination if it exists. This returns true on failure.
-///
-bool llvm::CopyFile(const std::string &Dest, const std::string &Src) {
- FDHandle InFD(open(Src.c_str(), O_RDONLY));
- if (InFD == -1) return true;
-
- FileRemover FR(Dest);
-
- FDHandle OutFD(open(Dest.c_str(), O_WRONLY|O_CREAT, 0666));
- if (OutFD == -1) return true;
-
- char Buffer[16*1024];
- while (ssize_t Amt = read(InFD, Buffer, 16*1024)) {
- if (Amt == -1) {
- if (errno != EINTR) return true; // Error reading the file.
- } else {
- char *BufPtr = Buffer;
- while (Amt) {
- ssize_t AmtWritten = write(OutFD, BufPtr, Amt);
- if (AmtWritten == -1) {
- if (errno != EINTR) return true; // Error writing the file.
- } else {
- Amt -= AmtWritten;
- BufPtr += AmtWritten;
- }
+ // Check to see if these are inside the absolute tolerance
+ if (AbsTolerance < std::abs(V1-V2)) {
+ // Nope, check the relative tolerance...
+ double Diff;
+ if (V2)
+ Diff = std::abs(V1/V2 - 1.0);
+ else if (V1)
+ Diff = std::abs(V2/V1 - 1.0);
+ else
+ Diff = 0; // Both zero.
+ if (Diff > RelTolerance) {
+ if (ErrorMsg) {
+ *ErrorMsg = "Compared: " + ftostr(V1) + " and " + ftostr(V2) + "\n";
+ *ErrorMsg += "abs. diff = " + ftostr(std::abs(V1-V2)) +
+ " rel.diff = " + ftostr(Diff) + "\n";
+ *ErrorMsg += "Out of tolerance: rel/abs: " + ftostr(RelTolerance) +
+ "/" + ftostr(AbsTolerance);
}
+ return true;
}
}
- FR.releaseFile(); // Success!
+ // Otherwise, advance our read pointers to the end of the numbers.
+ F1P = F1NumEnd; F2P = F2NumEnd;
return false;
}
-
-/// MoveFileOverIfUpdated - If the file specified by New is different than Old,
-/// or if Old does not exist, move the New file over the Old file. Otherwise,
-/// remove the New file.
-///
-void llvm::MoveFileOverIfUpdated(const std::string &New,
- const std::string &Old) {
- if (DiffFiles(New, Old)) {
- if (std::rename(New.c_str(), Old.c_str()))
- std::cerr << "Error renaming '" << New << "' to '" << Old << "'!\n";
- } else {
- std::remove(New.c_str());
- }
-}
-
-/// removeFile - Delete the specified file
-///
-void llvm::removeFile(const std::string &Filename) {
- std::remove(Filename.c_str());
-}
-
-/// getUniqueFilename - Return a filename with the specified prefix. If the
-/// file does not exist yet, return it, otherwise add a suffix to make it
-/// unique.
-///
-std::string llvm::getUniqueFilename(const std::string &FilenameBase) {
- if (!std::ifstream(FilenameBase.c_str()))
- return FilenameBase; // Couldn't open the file? Use it!
-
- // Create a pattern for mkstemp...
- char *FNBuffer = new char[FilenameBase.size()+8];
- strcpy(FNBuffer, FilenameBase.c_str());
- strcpy(FNBuffer+FilenameBase.size(), "-XXXXXX");
-
- // Agree on a temporary file name to use....
- int TempFD;
- if ((TempFD = mkstemp(FNBuffer)) == -1) {
- std::cerr << "bugpoint: ERROR: Cannot create temporary file in the current "
- << " directory!\n";
- exit(1);
+// PadFileIfNeeded - If the files are not identical, we will have to be doing
+// numeric comparisons in here. There are bad cases involved where we (i.e.,
+// strtod) might run off the beginning or end of the file if it starts or ends
+// with a number. Because of this, if needed, we pad the file so that it starts
+// and ends with a null character.
+static void PadFileIfNeeded(char *&FileStart, char *&FileEnd, char *&FP) {
+ if (FileStart-FileEnd < 2 ||
+ isNumberChar(FileStart[0]) || isNumberChar(FileEnd[-1])) {
+ unsigned FileLen = FileEnd-FileStart;
+ char *NewFile = new char[FileLen+2];
+ NewFile[0] = 0; // Add null padding
+ NewFile[FileLen+1] = 0; // Add null padding
+ memcpy(NewFile+1, FileStart, FileLen);
+ FP = NewFile+(FP-FileStart)+1;
+ FileStart = NewFile+1;
+ FileEnd = FileStart+FileLen;
}
-
- // We don't need to hold the temp file descriptor... we will trust that no one
- // will overwrite/delete the file while we are working on it...
- close(TempFD);
- std::string Result(FNBuffer);
- delete[] FNBuffer;
- return Result;
}
-static bool AddPermissionsBits (const std::string &Filename, mode_t bits) {
- // Get the umask value from the operating system. We want to use it
- // when changing the file's permissions. Since calling umask() sets
- // the umask and returns its old value, we must call it a second
- // time to reset it to the user's preference.
- mode_t mask = umask (0777); // The arg. to umask is arbitrary...
- umask (mask);
-
- // Get the file's current mode.
- struct stat st;
- if ((stat (Filename.c_str(), &st)) == -1)
- return false;
-
- // Change the file to have whichever permissions bits from 'bits'
- // that the umask would not disable.
- if ((chmod(Filename.c_str(), (st.st_mode | (bits & ~mask)))) == -1)
- return false;
-
- return true;
-}
-
-/// MakeFileExecutable - Make the file named Filename executable by
-/// setting whichever execute permissions bits the process's current
-/// umask would allow. Filename must name an existing file or
-/// directory. Returns true on success, false on error.
-///
-bool llvm::MakeFileExecutable(const std::string &Filename) {
- return AddPermissionsBits(Filename, 0111);
-}
-
-/// MakeFileReadable - Make the file named Filename readable by
-/// setting whichever read permissions bits the process's current
-/// umask would allow. Filename must name an existing file or
-/// directory. Returns true on success, false on error.
+/// DiffFilesWithTolerance - Compare the two files specified, returning 0 if the
+/// files match, 1 if they are different, and 2 if there is a file error. This
+/// function differs from DiffFiles in that you can specify an absolete and
+/// relative FP error that is allowed to exist. If you specify a string to fill
+/// in for the error option, it will set the string to an error message if an
+/// error occurs, allowing the caller to distinguish between a failed diff and a
+/// file system error.
///
-bool llvm::MakeFileReadable(const std::string &Filename) {
- return AddPermissionsBits(Filename, 0444);
-}
-
-/// getFileSize - Return the size of the specified file in bytes, or -1 if the
-/// file cannot be read or does not exist.
-long long llvm::getFileSize(const std::string &Filename) {
- struct stat StatBuf;
- if (stat(Filename.c_str(), &StatBuf) == -1)
- return -1;
- return StatBuf.st_size;
-}
-
-/// getFileTimestamp - Get the last modified time for the specified file in an
-/// unspecified format. This is useful to allow checking to see if a file was
-/// updated since that last time the timestampt was aquired. If the file does
-/// not exist or there is an error getting the time-stamp, zero is returned.
-unsigned long long llvm::getFileTimestamp(const std::string &Filename) {
- struct stat StatBuf;
- if (stat(Filename.c_str(), &StatBuf) == -1)
+int llvm::DiffFilesWithTolerance(const sys::Path &FileA,
+ const sys::Path &FileB,
+ double AbsTol, double RelTol,
+ std::string *Error) {
+ sys::FileStatus FileAStat, FileBStat;
+ if (FileA.getFileStatus(FileAStat, Error))
+ return 2;
+ if (FileB.getFileStatus(FileBStat, Error))
+ return 2;
+
+ // Check for zero length files because some systems croak when you try to
+ // mmap an empty file.
+ size_t A_size = FileAStat.getSize();
+ size_t B_size = FileBStat.getSize();
+
+ // If they are both zero sized then they're the same
+ if (A_size == 0 && B_size == 0)
return 0;
- return StatBuf.st_mtime;
-}
-/// ReadFileIntoAddressSpace - Attempt to map the specific file into the
-/// address space of the current process for reading. If this succeeds,
-/// return the address of the buffer and the length of the file mapped. On
-/// failure, return null.
-void *llvm::ReadFileIntoAddressSpace(const std::string &Filename,
- unsigned &Length) {
-#ifdef HAVE_MMAP_FILE
- Length = getFileSize(Filename);
- if ((int)Length == -1) return 0;
+ // If only one of them is zero sized then they can't be the same
+ if ((A_size == 0 || B_size == 0)) {
+ if (Error)
+ *Error = "Files differ: one is zero-sized, the other isn't";
+ return 1;
+ }
- FDHandle FD(open(Filename.c_str(), O_RDONLY));
- if (FD == -1) return 0;
+ // Now its safe to mmap the files into memory becasue both files
+ // have a non-zero size.
+ sys::MappedFile F1;
+ if (F1.open(FileA, sys::MappedFile::READ_ACCESS, Error))
+ return 2;
+ sys::MappedFile F2;
+ if (F2.open(FileB, sys::MappedFile::READ_ACCESS, Error))
+ return 2;
+ if (!F1.map(Error))
+ return 2;
+ if (!F2.map(Error))
+ return 2;
+
+ // Okay, now that we opened the files, scan them for the first difference.
+ char *File1Start = F1.charBase();
+ char *File2Start = F2.charBase();
+ char *File1End = File1Start+A_size;
+ char *File2End = File2Start+B_size;
+ char *F1P = File1Start;
+ char *F2P = File2Start;
+
+ if (A_size == B_size) {
+ // Are the buffers identical?
+ if (std::memcmp(File1Start, File2Start, A_size) == 0)
+ return 0;
+
+ if (AbsTol == 0 && RelTol == 0) {
+ if (Error)
+ *Error = "Files differ without tolerance allowance";
+ return 1; // Files different!
+ }
+ }
- // If the file has a length of zero, mmap might return a null pointer. In
- // this case, allocate a single byte of memory and return it instead.
- if (Length == 0)
- return malloc(1);
+ char *OrigFile1Start = File1Start;
+ char *OrigFile2Start = File2Start;
- // mmap in the file all at once...
- void *Buffer = (void*)mmap(0, Length, PROT_READ, MAP_PRIVATE, FD, 0);
+ // If the files need padding, do so now.
+ PadFileIfNeeded(File1Start, File1End, F1P);
+ PadFileIfNeeded(File2Start, File2End, F2P);
- if (Buffer == (void*)MAP_FAILED)
- return 0;
+ bool CompareFailed = false;
+ while (1) {
+ // Scan for the end of file or next difference.
+ while (F1P < File1End && F2P < File2End && *F1P == *F2P)
+ ++F1P, ++F2P;
- return Buffer;
-#else
- // FIXME: implement with read/write
- return 0;
-#endif
-}
+ if (F1P >= File1End || F2P >= File2End) break;
-/// UnmapFileFromAddressSpace - Remove the specified file from the current
-/// address space.
-void llvm::UnmapFileFromAddressSpace(void *Buffer, unsigned Length) {
-#ifdef HAVE_MMAP_FILE
- if (Length)
- munmap((char*)Buffer, Length);
- else
- free(Buffer); // Zero byte files are malloc(1)'s.
-#else
- free(Buffer);
-#endif
-}
+ // Okay, we must have found a difference. Backup to the start of the
+ // current number each stream is at so that we can compare from the
+ // beginning.
+ F1P = BackupNumber(F1P, File1Start);
+ F2P = BackupNumber(F2P, File2Start);
-//===----------------------------------------------------------------------===//
-// FDHandle class implementation
-//
+ // Now that we are at the start of the numbers, compare them, exiting if
+ // they don't match.
+ if (CompareNumbers(F1P, F2P, File1End, File2End, AbsTol, RelTol, Error)) {
+ CompareFailed = true;
+ break;
+ }
+ }
-FDHandle::~FDHandle() throw() {
- if (FD != -1) close(FD);
-}
+ // Okay, we reached the end of file. If both files are at the end, we
+ // succeeded.
+ bool F1AtEnd = F1P >= File1End;
+ bool F2AtEnd = F2P >= File2End;
+ if (!CompareFailed && (!F1AtEnd || !F2AtEnd)) {
+ // Else, we might have run off the end due to a number: backup and retry.
+ if (F1AtEnd && isNumberChar(F1P[-1])) --F1P;
+ if (F2AtEnd && isNumberChar(F2P[-1])) --F2P;
+ F1P = BackupNumber(F1P, File1Start);
+ F2P = BackupNumber(F2P, File2Start);
+
+ // Now that we are at the start of the numbers, compare them, exiting if
+ // they don't match.
+ if (CompareNumbers(F1P, F2P, File1End, File2End, AbsTol, RelTol, Error))
+ CompareFailed = true;
+
+ // If we found the end, we succeeded.
+ if (F1P < File1End || F2P < File2End)
+ CompareFailed = true;
+ }
-FDHandle &FDHandle::operator=(int fd) throw() {
- if (FD != -1) close(FD);
- FD = fd;
- return *this;
+ if (OrigFile1Start != File1Start)
+ delete[] (File1Start-1); // Back up past null byte
+ if (OrigFile2Start != File2Start)
+ delete[] (File2Start-1); // Back up past null byte
+ return CompareFailed;
}
-
projects / oota-llvm.git / blobdiff