FileUtilities.cpp revision 2ee51cbeb8f83f0b04d9611535151c801bbe3d4b
17a6ff2b98e0c7d4c54a4c04edb4357371f34d17fChris Lattner//===- Support/FileUtilities.cpp - File System Utilities ------------------===// 2b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// 3b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// The LLVM Compiler Infrastructure 4b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// 5b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// This file was developed by the LLVM research group and is distributed under 6b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// the University of Illinois Open Source License. See LICENSE.TXT for details. 7b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell// 8b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell//===----------------------------------------------------------------------===// 97a6ff2b98e0c7d4c54a4c04edb4357371f34d17fChris Lattner// 107a6ff2b98e0c7d4c54a4c04edb4357371f34d17fChris Lattner// This file implements a family of utility functions which are useful for doing 117a6ff2b98e0c7d4c54a4c04edb4357371f34d17fChris Lattner// various things with files. 127a6ff2b98e0c7d4c54a4c04edb4357371f34d17fChris Lattner// 137a6ff2b98e0c7d4c54a4c04edb4357371f34d17fChris Lattner//===----------------------------------------------------------------------===// 147a6ff2b98e0c7d4c54a4c04edb4357371f34d17fChris Lattner 15551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/FileUtilities.h" 169d88d1aaab145e18c8e0fe93544f8a1ff0474866Reid Spencer#include "llvm/System/Path.h" 1744542539233acdaf1a72179cd38506478b432de9Chris Lattner#include "llvm/System/MappedFile.h" 1844542539233acdaf1a72179cd38506478b432de9Chris Lattner#include "llvm/ADT/StringExtras.h" 1944542539233acdaf1a72179cd38506478b432de9Chris Lattner#include <cmath> 202ee51cbeb8f83f0b04d9611535151c801bbe3d4bChris Lattner#include <cstring> 212cdd21c2e4d855500dfb53f77aa74da53ccf9de6Chris Lattnerusing namespace llvm; 22d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 2344542539233acdaf1a72179cd38506478b432de9Chris Lattnerstatic bool isNumberChar(char C) { 2444542539233acdaf1a72179cd38506478b432de9Chris Lattner switch (C) { 2544542539233acdaf1a72179cd38506478b432de9Chris Lattner case '0': case '1': case '2': case '3': case '4': 2644542539233acdaf1a72179cd38506478b432de9Chris Lattner case '5': case '6': case '7': case '8': case '9': 2744542539233acdaf1a72179cd38506478b432de9Chris Lattner case '.': case '+': case '-': 2844542539233acdaf1a72179cd38506478b432de9Chris Lattner case 'e': 2944542539233acdaf1a72179cd38506478b432de9Chris Lattner case 'E': return true; 3044542539233acdaf1a72179cd38506478b432de9Chris Lattner default: return false; 3144542539233acdaf1a72179cd38506478b432de9Chris Lattner } 3244542539233acdaf1a72179cd38506478b432de9Chris Lattner} 3344542539233acdaf1a72179cd38506478b432de9Chris Lattner 3444542539233acdaf1a72179cd38506478b432de9Chris Lattnerstatic char *BackupNumber(char *Pos, char *FirstChar) { 3544542539233acdaf1a72179cd38506478b432de9Chris Lattner // If we didn't stop in the middle of a number, don't backup. 3644542539233acdaf1a72179cd38506478b432de9Chris Lattner if (!isNumberChar(*Pos)) return Pos; 3744542539233acdaf1a72179cd38506478b432de9Chris Lattner 3844542539233acdaf1a72179cd38506478b432de9Chris Lattner // Otherwise, return to the start of the number. 3944542539233acdaf1a72179cd38506478b432de9Chris Lattner while (Pos > FirstChar && isNumberChar(Pos[-1])) 4044542539233acdaf1a72179cd38506478b432de9Chris Lattner --Pos; 4144542539233acdaf1a72179cd38506478b432de9Chris Lattner return Pos; 4244542539233acdaf1a72179cd38506478b432de9Chris Lattner} 4344542539233acdaf1a72179cd38506478b432de9Chris Lattner 4444542539233acdaf1a72179cd38506478b432de9Chris Lattner/// CompareNumbers - compare two numbers, returning true if they are different. 4544542539233acdaf1a72179cd38506478b432de9Chris Lattnerstatic bool CompareNumbers(char *&F1P, char *&F2P, char *F1End, char *F2End, 4644542539233acdaf1a72179cd38506478b432de9Chris Lattner double AbsTolerance, double RelTolerance, 4744542539233acdaf1a72179cd38506478b432de9Chris Lattner std::string *ErrorMsg) { 4844542539233acdaf1a72179cd38506478b432de9Chris Lattner char *F1NumEnd, *F2NumEnd; 4944542539233acdaf1a72179cd38506478b432de9Chris Lattner double V1 = 0.0, V2 = 0.0; 5044542539233acdaf1a72179cd38506478b432de9Chris Lattner // If we stop on numbers, compare their difference. 5144542539233acdaf1a72179cd38506478b432de9Chris Lattner if (isNumberChar(*F1P) && isNumberChar(*F2P)) { 5244542539233acdaf1a72179cd38506478b432de9Chris Lattner V1 = strtod(F1P, &F1NumEnd); 5344542539233acdaf1a72179cd38506478b432de9Chris Lattner V2 = strtod(F2P, &F2NumEnd); 5444542539233acdaf1a72179cd38506478b432de9Chris Lattner } else { 5544542539233acdaf1a72179cd38506478b432de9Chris Lattner // Otherwise, the diff failed. 5644542539233acdaf1a72179cd38506478b432de9Chris Lattner F1NumEnd = F1P; 5744542539233acdaf1a72179cd38506478b432de9Chris Lattner F2NumEnd = F2P; 5844542539233acdaf1a72179cd38506478b432de9Chris Lattner } 5944542539233acdaf1a72179cd38506478b432de9Chris Lattner 6044542539233acdaf1a72179cd38506478b432de9Chris Lattner if (F1NumEnd == F1P || F2NumEnd == F2P) { 6144542539233acdaf1a72179cd38506478b432de9Chris Lattner if (ErrorMsg) *ErrorMsg = "Comparison failed, not a numeric difference."; 6244542539233acdaf1a72179cd38506478b432de9Chris Lattner return true; 6344542539233acdaf1a72179cd38506478b432de9Chris Lattner } 6444542539233acdaf1a72179cd38506478b432de9Chris Lattner 6544542539233acdaf1a72179cd38506478b432de9Chris Lattner // Check to see if these are inside the absolute tolerance 6644542539233acdaf1a72179cd38506478b432de9Chris Lattner if (AbsTolerance < std::abs(V1-V2)) { 6744542539233acdaf1a72179cd38506478b432de9Chris Lattner // Nope, check the relative tolerance... 6844542539233acdaf1a72179cd38506478b432de9Chris Lattner double Diff; 6944542539233acdaf1a72179cd38506478b432de9Chris Lattner if (V2) 7044542539233acdaf1a72179cd38506478b432de9Chris Lattner Diff = std::abs(V1/V2 - 1.0); 7144542539233acdaf1a72179cd38506478b432de9Chris Lattner else if (V1) 7244542539233acdaf1a72179cd38506478b432de9Chris Lattner Diff = std::abs(V2/V1 - 1.0); 7344542539233acdaf1a72179cd38506478b432de9Chris Lattner else 7444542539233acdaf1a72179cd38506478b432de9Chris Lattner Diff = 0; // Both zero. 7544542539233acdaf1a72179cd38506478b432de9Chris Lattner if (Diff > RelTolerance) { 7644542539233acdaf1a72179cd38506478b432de9Chris Lattner if (ErrorMsg) { 7744542539233acdaf1a72179cd38506478b432de9Chris Lattner *ErrorMsg = "Compared: " + ftostr(V1) + " and " + ftostr(V2) + 7844542539233acdaf1a72179cd38506478b432de9Chris Lattner ": diff = " + ftostr(Diff) + "\n"; 7944542539233acdaf1a72179cd38506478b432de9Chris Lattner *ErrorMsg += "Out of tolerance: rel/abs: " + ftostr(RelTolerance) + 8044542539233acdaf1a72179cd38506478b432de9Chris Lattner "/" + ftostr(AbsTolerance); 8144542539233acdaf1a72179cd38506478b432de9Chris Lattner } 8244542539233acdaf1a72179cd38506478b432de9Chris Lattner return true; 8344542539233acdaf1a72179cd38506478b432de9Chris Lattner } 8444542539233acdaf1a72179cd38506478b432de9Chris Lattner } 8544542539233acdaf1a72179cd38506478b432de9Chris Lattner 8644542539233acdaf1a72179cd38506478b432de9Chris Lattner // Otherwise, advance our read pointers to the end of the numbers. 8744542539233acdaf1a72179cd38506478b432de9Chris Lattner F1P = F1NumEnd; F2P = F2NumEnd; 8844542539233acdaf1a72179cd38506478b432de9Chris Lattner return false; 8944542539233acdaf1a72179cd38506478b432de9Chris Lattner} 9044542539233acdaf1a72179cd38506478b432de9Chris Lattner 9144542539233acdaf1a72179cd38506478b432de9Chris Lattner// PadFileIfNeeded - If the files are not identical, we will have to be doing 9244542539233acdaf1a72179cd38506478b432de9Chris Lattner// numeric comparisons in here. There are bad cases involved where we (i.e., 9344542539233acdaf1a72179cd38506478b432de9Chris Lattner// strtod) might run off the beginning or end of the file if it starts or ends 9444542539233acdaf1a72179cd38506478b432de9Chris Lattner// with a number. Because of this, if needed, we pad the file so that it starts 9544542539233acdaf1a72179cd38506478b432de9Chris Lattner// and ends with a null character. 9644542539233acdaf1a72179cd38506478b432de9Chris Lattnerstatic void PadFileIfNeeded(char *&FileStart, char *&FileEnd, char *&FP) { 97da7e70e058108fb444741a721ccfb38d40154e5bChris Lattner if (FileStart-FileEnd < 2 || 98da7e70e058108fb444741a721ccfb38d40154e5bChris Lattner isNumberChar(FileStart[0]) || isNumberChar(FileEnd[-1])) { 9944542539233acdaf1a72179cd38506478b432de9Chris Lattner unsigned FileLen = FileEnd-FileStart; 10044542539233acdaf1a72179cd38506478b432de9Chris Lattner char *NewFile = new char[FileLen+2]; 10144542539233acdaf1a72179cd38506478b432de9Chris Lattner NewFile[0] = 0; // Add null padding 10244542539233acdaf1a72179cd38506478b432de9Chris Lattner NewFile[FileLen+1] = 0; // Add null padding 10344542539233acdaf1a72179cd38506478b432de9Chris Lattner memcpy(NewFile+1, FileStart, FileLen); 10444542539233acdaf1a72179cd38506478b432de9Chris Lattner FP = NewFile+(FP-FileStart)+1; 10544542539233acdaf1a72179cd38506478b432de9Chris Lattner FileStart = NewFile+1; 10644542539233acdaf1a72179cd38506478b432de9Chris Lattner FileEnd = FileStart+FileLen; 10744542539233acdaf1a72179cd38506478b432de9Chris Lattner } 10844542539233acdaf1a72179cd38506478b432de9Chris Lattner} 10944542539233acdaf1a72179cd38506478b432de9Chris Lattner 11044542539233acdaf1a72179cd38506478b432de9Chris Lattner/// DiffFilesWithTolerance - Compare the two files specified, returning 0 if the 11144542539233acdaf1a72179cd38506478b432de9Chris Lattner/// files match, 1 if they are different, and 2 if there is a file error. This 11244542539233acdaf1a72179cd38506478b432de9Chris Lattner/// function differs from DiffFiles in that you can specify an absolete and 11344542539233acdaf1a72179cd38506478b432de9Chris Lattner/// relative FP error that is allowed to exist. If you specify a string to fill 11444542539233acdaf1a72179cd38506478b432de9Chris Lattner/// in for the error option, it will set the string to an error message if an 11544542539233acdaf1a72179cd38506478b432de9Chris Lattner/// error occurs, allowing the caller to distinguish between a failed diff and a 11644542539233acdaf1a72179cd38506478b432de9Chris Lattner/// file system error. 11744542539233acdaf1a72179cd38506478b432de9Chris Lattner/// 118cc1b90b0e768478c2f7d62f7e1cbc95d8e6cb237Chris Lattnerint llvm::DiffFilesWithTolerance(const sys::Path &FileA, 119cc1b90b0e768478c2f7d62f7e1cbc95d8e6cb237Chris Lattner const sys::Path &FileB, 12044542539233acdaf1a72179cd38506478b432de9Chris Lattner double AbsTol, double RelTol, 12144542539233acdaf1a72179cd38506478b432de9Chris Lattner std::string *Error) { 12244542539233acdaf1a72179cd38506478b432de9Chris Lattner try { 1231e1a99fffac551af96df11a9149f40e17f68af42Misha Brukman // Check for zero length files because some systems croak when you try to 12445d55641fa3af536e48be446647ff51b15109992Reid Spencer // mmap an empty file. 12545d55641fa3af536e48be446647ff51b15109992Reid Spencer size_t A_size = FileA.getSize(); 12645d55641fa3af536e48be446647ff51b15109992Reid Spencer size_t B_size = FileB.getSize(); 12745d55641fa3af536e48be446647ff51b15109992Reid Spencer 12845d55641fa3af536e48be446647ff51b15109992Reid Spencer // If they are both zero sized then they're the same 12945d55641fa3af536e48be446647ff51b15109992Reid Spencer if (A_size == 0 && B_size == 0) 13045d55641fa3af536e48be446647ff51b15109992Reid Spencer return 0; 13145d55641fa3af536e48be446647ff51b15109992Reid Spencer // If only one of them is zero sized then they can't be the same 13245d55641fa3af536e48be446647ff51b15109992Reid Spencer if ((A_size == 0 || B_size == 0)) 13345d55641fa3af536e48be446647ff51b15109992Reid Spencer return 1; 13445d55641fa3af536e48be446647ff51b15109992Reid Spencer 13545d55641fa3af536e48be446647ff51b15109992Reid Spencer // Now its safe to mmap the files into memory becasue both files 13645d55641fa3af536e48be446647ff51b15109992Reid Spencer // have a non-zero size. 137cc1b90b0e768478c2f7d62f7e1cbc95d8e6cb237Chris Lattner sys::MappedFile F1(FileA); 138cc1b90b0e768478c2f7d62f7e1cbc95d8e6cb237Chris Lattner sys::MappedFile F2(FileB); 13944542539233acdaf1a72179cd38506478b432de9Chris Lattner F1.map(); 14044542539233acdaf1a72179cd38506478b432de9Chris Lattner F2.map(); 14144542539233acdaf1a72179cd38506478b432de9Chris Lattner 14244542539233acdaf1a72179cd38506478b432de9Chris Lattner // Okay, now that we opened the files, scan them for the first difference. 14344542539233acdaf1a72179cd38506478b432de9Chris Lattner char *File1Start = F1.charBase(); 14444542539233acdaf1a72179cd38506478b432de9Chris Lattner char *File2Start = F2.charBase(); 1452ee51cbeb8f83f0b04d9611535151c801bbe3d4bChris Lattner char *File1End = File1Start+A_size; 1462ee51cbeb8f83f0b04d9611535151c801bbe3d4bChris Lattner char *File2End = File2Start+B_size; 14744542539233acdaf1a72179cd38506478b432de9Chris Lattner char *F1P = File1Start; 14844542539233acdaf1a72179cd38506478b432de9Chris Lattner char *F2P = File2Start; 14944542539233acdaf1a72179cd38506478b432de9Chris Lattner 15045d55641fa3af536e48be446647ff51b15109992Reid Spencer if (A_size == B_size) { 1512ee51cbeb8f83f0b04d9611535151c801bbe3d4bChris Lattner // Are the buffers identical? 1522ee51cbeb8f83f0b04d9611535151c801bbe3d4bChris Lattner if (std::memcmp(File1Start, File2Start, A_size) == 0) 1532ee51cbeb8f83f0b04d9611535151c801bbe3d4bChris Lattner return 0; 15444542539233acdaf1a72179cd38506478b432de9Chris Lattner 15545d55641fa3af536e48be446647ff51b15109992Reid Spencer if (AbsTol == 0 && RelTol == 0) 15645d55641fa3af536e48be446647ff51b15109992Reid Spencer return 1; // Files different! 15745d55641fa3af536e48be446647ff51b15109992Reid Spencer } 158cc1b90b0e768478c2f7d62f7e1cbc95d8e6cb237Chris Lattner 15944542539233acdaf1a72179cd38506478b432de9Chris Lattner char *OrigFile1Start = File1Start; 16044542539233acdaf1a72179cd38506478b432de9Chris Lattner char *OrigFile2Start = File2Start; 16144542539233acdaf1a72179cd38506478b432de9Chris Lattner 16244542539233acdaf1a72179cd38506478b432de9Chris Lattner // If the files need padding, do so now. 16344542539233acdaf1a72179cd38506478b432de9Chris Lattner PadFileIfNeeded(File1Start, File1End, F1P); 16444542539233acdaf1a72179cd38506478b432de9Chris Lattner PadFileIfNeeded(File2Start, File2End, F2P); 16544542539233acdaf1a72179cd38506478b432de9Chris Lattner 16644542539233acdaf1a72179cd38506478b432de9Chris Lattner bool CompareFailed = false; 16744542539233acdaf1a72179cd38506478b432de9Chris Lattner while (1) { 16844542539233acdaf1a72179cd38506478b432de9Chris Lattner // Scan for the end of file or next difference. 16944542539233acdaf1a72179cd38506478b432de9Chris Lattner while (F1P < File1End && F2P < File2End && *F1P == *F2P) 17044542539233acdaf1a72179cd38506478b432de9Chris Lattner ++F1P, ++F2P; 17144542539233acdaf1a72179cd38506478b432de9Chris Lattner 17244542539233acdaf1a72179cd38506478b432de9Chris Lattner if (F1P >= File1End || F2P >= File2End) break; 17344542539233acdaf1a72179cd38506478b432de9Chris Lattner 17444542539233acdaf1a72179cd38506478b432de9Chris Lattner // Okay, we must have found a difference. Backup to the start of the 17544542539233acdaf1a72179cd38506478b432de9Chris Lattner // current number each stream is at so that we can compare from the 17644542539233acdaf1a72179cd38506478b432de9Chris Lattner // beginning. 17744542539233acdaf1a72179cd38506478b432de9Chris Lattner F1P = BackupNumber(F1P, File1Start); 17844542539233acdaf1a72179cd38506478b432de9Chris Lattner F2P = BackupNumber(F2P, File2Start); 17944542539233acdaf1a72179cd38506478b432de9Chris Lattner 18044542539233acdaf1a72179cd38506478b432de9Chris Lattner // Now that we are at the start of the numbers, compare them, exiting if 18144542539233acdaf1a72179cd38506478b432de9Chris Lattner // they don't match. 18244542539233acdaf1a72179cd38506478b432de9Chris Lattner if (CompareNumbers(F1P, F2P, File1End, File2End, AbsTol, RelTol, Error)) { 18344542539233acdaf1a72179cd38506478b432de9Chris Lattner CompareFailed = true; 18444542539233acdaf1a72179cd38506478b432de9Chris Lattner break; 18544542539233acdaf1a72179cd38506478b432de9Chris Lattner } 18644542539233acdaf1a72179cd38506478b432de9Chris Lattner } 18744542539233acdaf1a72179cd38506478b432de9Chris Lattner 18844542539233acdaf1a72179cd38506478b432de9Chris Lattner // Okay, we reached the end of file. If both files are at the end, we 18944542539233acdaf1a72179cd38506478b432de9Chris Lattner // succeeded. 19044542539233acdaf1a72179cd38506478b432de9Chris Lattner bool F1AtEnd = F1P >= File1End; 19144542539233acdaf1a72179cd38506478b432de9Chris Lattner bool F2AtEnd = F2P >= File2End; 19244542539233acdaf1a72179cd38506478b432de9Chris Lattner if (!CompareFailed && (!F1AtEnd || !F2AtEnd)) { 19344542539233acdaf1a72179cd38506478b432de9Chris Lattner // Else, we might have run off the end due to a number: backup and retry. 19444542539233acdaf1a72179cd38506478b432de9Chris Lattner if (F1AtEnd && isNumberChar(F1P[-1])) --F1P; 19544542539233acdaf1a72179cd38506478b432de9Chris Lattner if (F2AtEnd && isNumberChar(F2P[-1])) --F2P; 19644542539233acdaf1a72179cd38506478b432de9Chris Lattner F1P = BackupNumber(F1P, File1Start); 19744542539233acdaf1a72179cd38506478b432de9Chris Lattner F2P = BackupNumber(F2P, File2Start); 19844542539233acdaf1a72179cd38506478b432de9Chris Lattner 19944542539233acdaf1a72179cd38506478b432de9Chris Lattner // Now that we are at the start of the numbers, compare them, exiting if 20044542539233acdaf1a72179cd38506478b432de9Chris Lattner // they don't match. 20144542539233acdaf1a72179cd38506478b432de9Chris Lattner if (CompareNumbers(F1P, F2P, File1End, File2End, AbsTol, RelTol, Error)) 20244542539233acdaf1a72179cd38506478b432de9Chris Lattner CompareFailed = true; 20344542539233acdaf1a72179cd38506478b432de9Chris Lattner 20444542539233acdaf1a72179cd38506478b432de9Chris Lattner // If we found the end, we succeeded. 20544542539233acdaf1a72179cd38506478b432de9Chris Lattner if (F1P < File1End || F2P < File2End) 20644542539233acdaf1a72179cd38506478b432de9Chris Lattner CompareFailed = true; 20744542539233acdaf1a72179cd38506478b432de9Chris Lattner } 20844542539233acdaf1a72179cd38506478b432de9Chris Lattner 20944542539233acdaf1a72179cd38506478b432de9Chris Lattner if (OrigFile1Start != File1Start) 210cc1b90b0e768478c2f7d62f7e1cbc95d8e6cb237Chris Lattner delete[] (File1Start-1); // Back up past null byte 21144542539233acdaf1a72179cd38506478b432de9Chris Lattner if (OrigFile2Start != File2Start) 212cc1b90b0e768478c2f7d62f7e1cbc95d8e6cb237Chris Lattner delete[] (File2Start-1); // Back up past null byte 21344542539233acdaf1a72179cd38506478b432de9Chris Lattner return CompareFailed; 21444542539233acdaf1a72179cd38506478b432de9Chris Lattner } catch (const std::string &Msg) { 21544542539233acdaf1a72179cd38506478b432de9Chris Lattner if (Error) *Error = Msg; 21644542539233acdaf1a72179cd38506478b432de9Chris Lattner return 2; 21744542539233acdaf1a72179cd38506478b432de9Chris Lattner } 21844542539233acdaf1a72179cd38506478b432de9Chris Lattner} 219