1 //===- Support/FileUtilities.cpp - File System Utilities ------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a family of utility functions which are useful for doing
11 // various things with files.
13 //===----------------------------------------------------------------------===//
15 #include "Support/FileUtilities.h"
16 #include "Config/unistd.h"
17 #include "Config/fcntl.h"
18 #include "Config/sys/stat.h"
19 #include "Config/sys/types.h"
20 #include "Config/sys/mman.h"
26 /// CheckMagic - Returns true IFF the file named FN begins with Magic. FN must
27 /// name a readable file.
29 bool llvm::CheckMagic(const std::string &FN, const std::string &Magic) {
30 char buf[1 + Magic.size ()];
31 std::ifstream f (FN.c_str ());
32 f.read (buf, Magic.size ());
33 buf[Magic.size ()] = '\0';
37 /// IsArchive - Returns true IFF the file named FN appears to be a "ar" library
38 /// archive. The file named FN must exist.
40 bool llvm::IsArchive(const std::string &FN) {
41 // Inspect the beginning of the file to see if it contains the "ar"
42 // library archive format magic string.
43 return CheckMagic (FN, "!<arch>\012");
46 /// IsBytecode - Returns true IFF the file named FN appears to be an LLVM
47 /// bytecode file. The file named FN must exist.
49 bool llvm::IsBytecode(const std::string &FN) {
50 // Inspect the beginning of the file to see if it contains the LLVM
51 // bytecode format magic string.
52 return CheckMagic (FN, "llvm");
55 /// IsSharedObject - Returns trus IFF the file named FN appears to be a shared
56 /// object with an ELF header. The file named FN must exist.
58 bool llvm::IsSharedObject(const std::string &FN) {
59 // Inspect the beginning of the file to see if it contains the ELF shared
60 // object magic string.
61 static const char elfMagic[] = { 0x7f, 'E', 'L', 'F', '\0' };
62 return CheckMagic(FN, elfMagic);
65 /// FileOpenable - Returns true IFF Filename names an existing regular
66 /// file which we can successfully open.
68 bool llvm::FileOpenable(const std::string &Filename) {
70 if (stat (Filename.c_str (), &s) == -1)
71 return false; // Cannot stat file
72 if (!S_ISREG (s.st_mode))
73 return false; // File is not a regular file
74 std::ifstream FileStream (Filename.c_str ());
76 return false; // File is not openable
80 /// DiffFiles - Compare the two files specified, returning true if they are
81 /// different or if there is a file error. If you specify a string to fill in
82 /// for the error option, it will set the string to an error message if an error
83 /// occurs, allowing the caller to distinguish between a failed diff and a file
86 bool llvm::DiffFiles(const std::string &FileA, const std::string &FileB,
88 std::ifstream FileAStream(FileA.c_str());
90 if (Error) *Error = "Couldn't open file '" + FileA + "'";
94 std::ifstream FileBStream(FileB.c_str());
96 if (Error) *Error = "Couldn't open file '" + FileB + "'";
100 // Compare the two files...
103 C1 = FileAStream.get();
104 C2 = FileBStream.get();
105 if (C1 != C2) return true;
112 /// CopyFile - Copy the specified source file to the specified destination,
113 /// overwriting destination if it exists. This returns true on failure.
115 bool llvm::CopyFile(const std::string &Dest, const std::string &Src) {
116 FDHandle InFD(open(Src.c_str(), O_RDONLY));
117 if (InFD == -1) return true;
119 FileRemover FR(Dest);
121 FDHandle OutFD(open(Dest.c_str(), O_WRONLY|O_CREAT, 0666));
122 if (OutFD == -1) return true;
124 char Buffer[16*1024];
125 while (ssize_t Amt = read(InFD, Buffer, 16*1024)) {
127 if (errno != EINTR) return true; // Error reading the file.
129 char *BufPtr = Buffer;
131 ssize_t AmtWritten = write(OutFD, BufPtr, Amt);
132 if (AmtWritten == -1) {
133 if (errno != EINTR) return true; // Error writing the file.
136 BufPtr += AmtWritten;
142 FR.releaseFile(); // Success!
147 /// MoveFileOverIfUpdated - If the file specified by New is different than Old,
148 /// or if Old does not exist, move the New file over the Old file. Otherwise,
149 /// remove the New file.
151 void llvm::MoveFileOverIfUpdated(const std::string &New,
152 const std::string &Old) {
153 if (DiffFiles(New, Old)) {
154 if (std::rename(New.c_str(), Old.c_str()))
155 std::cerr << "Error renaming '" << New << "' to '" << Old << "'!\n";
157 std::remove(New.c_str());
161 /// removeFile - Delete the specified file
163 void llvm::removeFile(const std::string &Filename) {
164 std::remove(Filename.c_str());
167 /// getUniqueFilename - Return a filename with the specified prefix. If the
168 /// file does not exist yet, return it, otherwise add a suffix to make it
171 std::string llvm::getUniqueFilename(const std::string &FilenameBase) {
172 if (!std::ifstream(FilenameBase.c_str()))
173 return FilenameBase; // Couldn't open the file? Use it!
175 // Create a pattern for mkstemp...
176 char *FNBuffer = new char[FilenameBase.size()+8];
177 strcpy(FNBuffer, FilenameBase.c_str());
178 strcpy(FNBuffer+FilenameBase.size(), "-XXXXXX");
180 // Agree on a temporary file name to use....
182 if ((TempFD = mkstemp(FNBuffer)) == -1) {
183 std::cerr << "bugpoint: ERROR: Cannot create temporary file in the current "
188 // We don't need to hold the temp file descriptor... we will trust that no one
189 // will overwrite/delete the file while we are working on it...
191 std::string Result(FNBuffer);
196 static bool AddPermissionsBits (const std::string &Filename, mode_t bits) {
197 // Get the umask value from the operating system. We want to use it
198 // when changing the file's permissions. Since calling umask() sets
199 // the umask and returns its old value, we must call it a second
200 // time to reset it to the user's preference.
201 mode_t mask = umask (0777); // The arg. to umask is arbitrary...
204 // Get the file's current mode.
206 if ((stat (Filename.c_str(), &st)) == -1)
209 // Change the file to have whichever permissions bits from 'bits'
210 // that the umask would not disable.
211 if ((chmod(Filename.c_str(), (st.st_mode | (bits & ~mask)))) == -1)
217 /// MakeFileExecutable - Make the file named Filename executable by
218 /// setting whichever execute permissions bits the process's current
219 /// umask would allow. Filename must name an existing file or
220 /// directory. Returns true on success, false on error.
222 bool llvm::MakeFileExecutable(const std::string &Filename) {
223 return AddPermissionsBits(Filename, 0111);
226 /// MakeFileReadable - Make the file named Filename readable by
227 /// setting whichever read permissions bits the process's current
228 /// umask would allow. Filename must name an existing file or
229 /// directory. Returns true on success, false on error.
231 bool llvm::MakeFileReadable(const std::string &Filename) {
232 return AddPermissionsBits(Filename, 0444);
235 /// getFileSize - Return the size of the specified file in bytes, or -1 if the
236 /// file cannot be read or does not exist.
237 long long llvm::getFileSize(const std::string &Filename) {
239 if (stat(Filename.c_str(), &StatBuf) == -1)
241 return StatBuf.st_size;
244 /// getFileTimestamp - Get the last modified time for the specified file in an
245 /// unspecified format. This is useful to allow checking to see if a file was
246 /// updated since that last time the timestampt was aquired. If the file does
247 /// not exist or there is an error getting the time-stamp, zero is returned.
248 unsigned long long llvm::getFileTimestamp(const std::string &Filename) {
250 if (stat(Filename.c_str(), &StatBuf) == -1)
252 return StatBuf.st_mtime;
255 /// ReadFileIntoAddressSpace - Attempt to map the specific file into the
256 /// address space of the current process for reading. If this succeeds,
257 /// return the address of the buffer and the length of the file mapped. On
258 /// failure, return null.
259 void *llvm::ReadFileIntoAddressSpace(const std::string &Filename,
261 #ifdef HAVE_MMAP_FILE
262 Length = getFileSize(Filename);
263 if ((int)Length == -1) return 0;
265 FDHandle FD(open(Filename.c_str(), O_RDONLY));
266 if (FD == -1) return 0;
268 // If the file has a length of zero, mmap might return a null pointer. In
269 // this case, allocate a single byte of memory and return it instead.
273 // mmap in the file all at once...
274 void *Buffer = (void*)mmap(0, Length, PROT_READ, MAP_PRIVATE, FD, 0);
276 if (Buffer == (void*)MAP_FAILED)
281 // FIXME: implement with read/write
286 /// UnmapFileFromAddressSpace - Remove the specified file from the current
288 void llvm::UnmapFileFromAddressSpace(void *Buffer, unsigned Length) {
289 #ifdef HAVE_MMAP_FILE
291 munmap((char*)Buffer, Length);
293 free(Buffer); // Zero byte files are malloc(1)'s.
299 //===----------------------------------------------------------------------===//
300 // FDHandle class implementation
303 FDHandle::~FDHandle() throw() {
304 if (FD != -1) close(FD);
307 FDHandle &FDHandle::operator=(int fd) throw() {
308 if (FD != -1) close(FD);