lib/Support/FileUtilities.cpp

   1 //===- Support/FileUtilities.cpp - File System Utilities ------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements a family of utility functions which are useful for doing
  11 // various things with files.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Support/FileUtilities.h"
  16 #include "llvm/ADT/OwningPtr.h"
  17 #include "llvm/ADT/SmallString.h"
  18 #include "llvm/Support/MemoryBuffer.h"
  19 #include "llvm/Support/Path.h"
  20 #include "llvm/Support/PathV1.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 #include "llvm/Support/system_error.h"
  23 #include <cctype>
  24 #include <cstdlib>
  25 #include <cstring>
  26 using namespace llvm;
  27
  28 static bool isSignedChar(char C) {
  29   return (C == '+' || C == '-');
  30 }
  31
  32 static bool isExponentChar(char C) {
  33   switch (C) {
  34   case 'D':  // Strange exponential notation.
  35   case 'd':  // Strange exponential notation.
  36   case 'e':
  37   case 'E': return true;
  38   default: return false;
  39   }
  40 }
  41
  42 static bool isNumberChar(char C) {
  43   switch (C) {
  44   case '0': case '1': case '2': case '3': case '4':
  45   case '5': case '6': case '7': case '8': case '9':
  46   case '.': return true;
  47   default: return isSignedChar(C) || isExponentChar(C);
  48   }
  49 }
  50
  51 static const char *BackupNumber(const char *Pos, const char *FirstChar) {
  52   // If we didn't stop in the middle of a number, don't backup.
  53   if (!isNumberChar(*Pos)) return Pos;
  54
  55   // Otherwise, return to the start of the number.
  56   bool HasPeriod = false;
  57   while (Pos > FirstChar && isNumberChar(Pos[-1])) {
  58     // Backup over at most one period.
  59     if (Pos[-1] == '.') {
  60       if (HasPeriod)
  61         break;
  62       HasPeriod = true;
  63     }
  64
  65     --Pos;
  66     if (Pos > FirstChar && isSignedChar(Pos[0]) && !isExponentChar(Pos[-1]))
  67       break;
  68   }
  69   return Pos;
  70 }
  71
  72 /// EndOfNumber - Return the first character that is not part of the specified
  73 /// number.  This assumes that the buffer is null terminated, so it won't fall
  74 /// off the end.
  75 static const char *EndOfNumber(const char *Pos) {
  76   while (isNumberChar(*Pos))
  77     ++Pos;
  78   return Pos;
  79 }
  80
  81 /// CompareNumbers - compare two numbers, returning true if they are different.
  82 static bool CompareNumbers(const char *&F1P, const char *&F2P,
  83                            const char *F1End, const char *F2End,
  84                            double AbsTolerance, double RelTolerance,
  85                            std::string *ErrorMsg) {
  86   const char *F1NumEnd, *F2NumEnd;
  87   double V1 = 0.0, V2 = 0.0;
  88
  89   // If one of the positions is at a space and the other isn't, chomp up 'til
  90   // the end of the space.
  91   while (isspace(static_cast<unsigned char>(*F1P)) && F1P != F1End)
  92     ++F1P;
  93   while (isspace(static_cast<unsigned char>(*F2P)) && F2P != F2End)
  94     ++F2P;
  95
  96   // If we stop on numbers, compare their difference.
  97   if (!isNumberChar(*F1P) || !isNumberChar(*F2P)) {
  98     // The diff failed.
  99     F1NumEnd = F1P;
 100     F2NumEnd = F2P;
 101   } else {
 102     // Note that some ugliness is built into this to permit support for numbers
 103     // that use "D" or "d" as their exponential marker, e.g. "1.234D45".  This
 104     // occurs in 200.sixtrack in spec2k.
 105     V1 = strtod(F1P, const_cast<char**>(&F1NumEnd));
 106     V2 = strtod(F2P, const_cast<char**>(&F2NumEnd));
 107
 108     if (*F1NumEnd == 'D' || *F1NumEnd == 'd') {
 109       // Copy string into tmp buffer to replace the 'D' with an 'e'.
 110       SmallString<200> StrTmp(F1P, EndOfNumber(F1NumEnd)+1);
 111       // Strange exponential notation!
 112       StrTmp[static_cast<unsigned>(F1NumEnd-F1P)] = 'e';
 113
 114       V1 = strtod(&StrTmp[0], const_cast<char**>(&F1NumEnd));
 115       F1NumEnd = F1P + (F1NumEnd-&StrTmp[0]);
 116     }
 117
 118     if (*F2NumEnd == 'D' || *F2NumEnd == 'd') {
 119       // Copy string into tmp buffer to replace the 'D' with an 'e'.
 120       SmallString<200> StrTmp(F2P, EndOfNumber(F2NumEnd)+1);
 121       // Strange exponential notation!
 122       StrTmp[static_cast<unsigned>(F2NumEnd-F2P)] = 'e';
 123
 124       V2 = strtod(&StrTmp[0], const_cast<char**>(&F2NumEnd));
 125       F2NumEnd = F2P + (F2NumEnd-&StrTmp[0]);
 126     }
 127   }
 128
 129   if (F1NumEnd == F1P || F2NumEnd == F2P) {
 130     if (ErrorMsg) {
 131       *ErrorMsg = "FP Comparison failed, not a numeric difference between '";
 132       *ErrorMsg += F1P[0];
 133       *ErrorMsg += "' and '";
 134       *ErrorMsg += F2P[0];
 135       *ErrorMsg += "'";
 136     }
 137     return true;
 138   }
 139
 140   // Check to see if these are inside the absolute tolerance
 141   if (AbsTolerance < std::abs(V1-V2)) {
 142     // Nope, check the relative tolerance...
 143     double Diff;
 144     if (V2)
 145       Diff = std::abs(V1/V2 - 1.0);
 146     else if (V1)
 147       Diff = std::abs(V2/V1 - 1.0);
 148     else
 149       Diff = 0;  // Both zero.
 150     if (Diff > RelTolerance) {
 151       if (ErrorMsg) {
 152         raw_string_ostream(*ErrorMsg)
 153           << "Compared: " << V1 << " and " << V2 << '\n'
 154           << "abs. diff = " << std::abs(V1-V2) << " rel.diff = " << Diff << '\n'
 155           << "Out of tolerance: rel/abs: " << RelTolerance << '/'
 156           << AbsTolerance;
 157       }
 158       return true;
 159     }
 160   }
 161
 162   // Otherwise, advance our read pointers to the end of the numbers.
 163   F1P = F1NumEnd;  F2P = F2NumEnd;
 164   return false;
 165 }
 166
 167 /// DiffFilesWithTolerance - Compare the two files specified, returning 0 if the
 168 /// files match, 1 if they are different, and 2 if there is a file error.  This
 169 /// function differs from DiffFiles in that you can specify an absolete and
 170 /// relative FP error that is allowed to exist.  If you specify a string to fill
 171 /// in for the error option, it will set the string to an error message if an
 172 /// error occurs, allowing the caller to distinguish between a failed diff and a
 173 /// file system error.
 174 ///
 175 int llvm::DiffFilesWithTolerance(StringRef NameA,
 176                                  StringRef NameB,
 177                                  double AbsTol, double RelTol,
 178                                  std::string *Error) {
 179   sys::PathWithStatus FileA(NameA);
 180   sys::PathWithStatus FileB(NameB);
 181
 182   const sys::FileStatus *FileAStat = FileA.getFileStatus(false, Error);
 183   if (!FileAStat)
 184     return 2;
 185   const sys::FileStatus *FileBStat = FileB.getFileStatus(false, Error);
 186   if (!FileBStat)
 187     return 2;
 188
 189   // Check for zero length files because some systems croak when you try to
 190   // mmap an empty file.
 191   size_t A_size = FileAStat->getSize();
 192   size_t B_size = FileBStat->getSize();
 193
 194   // If they are both zero sized then they're the same
 195   if (A_size == 0 && B_size == 0)
 196     return 0;
 197
 198   // If only one of them is zero sized then they can't be the same
 199   if ((A_size == 0 || B_size == 0)) {
 200     if (Error)
 201       *Error = "Files differ: one is zero-sized, the other isn't";
 202     return 1;
 203   }
 204
 205   // Now its safe to mmap the files into memory because both files
 206   // have a non-zero size.
 207   OwningPtr<MemoryBuffer> F1;
 208   if (error_code ec = MemoryBuffer::getFile(FileA.c_str(), F1)) {
 209     if (Error)
 210       *Error = ec.message();
 211     return 2;
 212   }
 213   OwningPtr<MemoryBuffer> F2;
 214   if (error_code ec = MemoryBuffer::getFile(FileB.c_str(), F2)) {
 215     if (Error)
 216       *Error = ec.message();
 217     return 2;
 218   }
 219
 220   // Okay, now that we opened the files, scan them for the first difference.
 221   const char *File1Start = F1->getBufferStart();
 222   const char *File2Start = F2->getBufferStart();
 223   const char *File1End = F1->getBufferEnd();
 224   const char *File2End = F2->getBufferEnd();
 225   const char *F1P = File1Start;
 226   const char *F2P = File2Start;
 227
 228   // Are the buffers identical?  Common case: Handle this efficiently.
 229   if (A_size == B_size &&
 230       std::memcmp(File1Start, File2Start, A_size) == 0)
 231     return 0;
 232
 233   // Otherwise, we are done a tolerances are set.
 234   if (AbsTol == 0 && RelTol == 0) {
 235     if (Error)
 236       *Error = "Files differ without tolerance allowance";
 237     return 1;   // Files different!
 238   }
 239
 240   bool CompareFailed = false;
 241   while (1) {
 242     // Scan for the end of file or next difference.
 243     while (F1P < File1End && F2P < File2End && *F1P == *F2P)
 244       ++F1P, ++F2P;
 245
 246     if (F1P >= File1End || F2P >= File2End) break;
 247
 248     // Okay, we must have found a difference.  Backup to the start of the
 249     // current number each stream is at so that we can compare from the
 250     // beginning.
 251     F1P = BackupNumber(F1P, File1Start);
 252     F2P = BackupNumber(F2P, File2Start);
 253
 254     // Now that we are at the start of the numbers, compare them, exiting if
 255     // they don't match.
 256     if (CompareNumbers(F1P, F2P, File1End, File2End, AbsTol, RelTol, Error)) {
 257       CompareFailed = true;
 258       break;
 259     }
 260   }
 261
 262   // Okay, we reached the end of file.  If both files are at the end, we
 263   // succeeded.
 264   bool F1AtEnd = F1P >= File1End;
 265   bool F2AtEnd = F2P >= File2End;
 266   if (!CompareFailed && (!F1AtEnd || !F2AtEnd)) {
 267     // Else, we might have run off the end due to a number: backup and retry.
 268     if (F1AtEnd && isNumberChar(F1P[-1])) --F1P;
 269     if (F2AtEnd && isNumberChar(F2P[-1])) --F2P;
 270     F1P = BackupNumber(F1P, File1Start);
 271     F2P = BackupNumber(F2P, File2Start);
 272
 273     // Now that we are at the start of the numbers, compare them, exiting if
 274     // they don't match.
 275     if (CompareNumbers(F1P, F2P, File1End, File2End, AbsTol, RelTol, Error))
 276       CompareFailed = true;
 277
 278     // If we found the end, we succeeded.
 279     if (F1P < File1End || F2P < File2End)
 280       CompareFailed = true;
 281   }
 282
 283   return CompareFailed;
 284 }