Remove Path::canWrite.
[oota-llvm.git] / lib / Support / Windows / Path.inc
1 //===- llvm/Support/Win32/Path.cpp - Win32 Path Implementation ---*- C++ -*-===//
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 provides the Win32 specific implementation of the Path class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 //===----------------------------------------------------------------------===//
15 //=== WARNING: Implementation here must contain only generic Win32 code that
16 //===          is guaranteed to work on *all* Win32 variants.
17 //===----------------------------------------------------------------------===//
18
19 #include "Windows.h"
20 #include <cstdio>
21 #include <malloc.h>
22
23 // We need to undo a macro defined in Windows.h, otherwise we won't compile:
24 #undef GetCurrentDirectory
25
26 // Windows happily accepts either forward or backward slashes, though any path
27 // returned by a Win32 API will have backward slashes.  As LLVM code basically
28 // assumes forward slashes are used, backward slashs are converted where they
29 // can be introduced into a path.
30 //
31 // Another invariant is that a path ends with a slash if and only if the path
32 // is a root directory.  Any other use of a trailing slash is stripped.  Unlike
33 // in Unix, Windows has a rather complicated notion of a root path and this
34 // invariant helps simply the code.
35
36 static void FlipBackSlashes(std::string& s) {
37   for (size_t i = 0; i < s.size(); i++)
38     if (s[i] == '\\')
39       s[i] = '/';
40 }
41
42 namespace llvm {
43 namespace sys {
44
45 const char PathSeparator = ';';
46
47 StringRef Path::GetEXESuffix() {
48   return "exe";
49 }
50
51 Path::Path(llvm::StringRef p)
52   : path(p) {
53   FlipBackSlashes(path);
54 }
55
56 Path::Path(const char *StrStart, unsigned StrLen)
57   : path(StrStart, StrLen) {
58   FlipBackSlashes(path);
59 }
60
61 Path&
62 Path::operator=(StringRef that) {
63   path.assign(that.data(), that.size());
64   FlipBackSlashes(path);
65   return *this;
66 }
67
68 bool
69 Path::isValid() const {
70   if (path.empty())
71     return false;
72
73   size_t len = path.size();
74   // If there is a null character, it and all its successors are ignored.
75   size_t pos = path.find_first_of('\0');
76   if (pos != std::string::npos)
77     len = pos;
78
79   // If there is a colon, it must be the second character, preceded by a letter
80   // and followed by something.
81   pos = path.rfind(':',len);
82   size_t rootslash = 0;
83   if (pos != std::string::npos) {
84     if (pos != 1 || !isalpha(static_cast<unsigned char>(path[0])) || len < 3)
85       return false;
86       rootslash = 2;
87   }
88
89   // Look for a UNC path, and if found adjust our notion of the root slash.
90   if (len > 3 && path[0] == '/' && path[1] == '/') {
91     rootslash = path.find('/', 2);
92     if (rootslash == std::string::npos)
93       rootslash = 0;
94   }
95
96   // Check for illegal characters.
97   if (path.find_first_of("\\<>\"|\001\002\003\004\005\006\007\010\011\012"
98                          "\013\014\015\016\017\020\021\022\023\024\025\026"
99                          "\027\030\031\032\033\034\035\036\037")
100       != std::string::npos)
101     return false;
102
103   // Remove trailing slash, unless it's a root slash.
104   if (len > rootslash+1 && path[len-1] == '/')
105     path.erase(--len);
106
107   // Check each component for legality.
108   for (pos = 0; pos < len; ++pos) {
109     // A component may not end in a space.
110     if (path[pos] == ' ') {
111       if (pos+1 == len || path[pos+1] == '/' || path[pos+1] == '\0')
112         return false;
113     }
114
115     // A component may not end in a period.
116     if (path[pos] == '.') {
117       if (pos+1 == len || path[pos+1] == '/') {
118         // Unless it is the pseudo-directory "."...
119         if (pos == 0 || path[pos-1] == '/' || path[pos-1] == ':')
120           return true;
121         // or "..".
122         if (pos > 0 && path[pos-1] == '.') {
123           if (pos == 1 || path[pos-2] == '/' || path[pos-2] == ':')
124             return true;
125         }
126         return false;
127       }
128     }
129   }
130
131   return true;
132 }
133
134 void Path::makeAbsolute() {
135   TCHAR  FullPath[MAX_PATH + 1] = {0};
136   LPTSTR FilePart = NULL;
137
138   DWORD RetLength = ::GetFullPathNameA(path.c_str(),
139                         sizeof(FullPath)/sizeof(FullPath[0]),
140                         FullPath, &FilePart);
141
142   if (0 == RetLength) {
143     // FIXME: Report the error GetLastError()
144     assert(0 && "Unable to make absolute path!");
145   } else if (RetLength > MAX_PATH) {
146     // FIXME: Report too small buffer (needed RetLength bytes).
147     assert(0 && "Unable to make absolute path!");
148   } else {
149     path = FullPath;
150   }
151 }
152
153 static Path *TempDirectory;
154
155 Path
156 Path::GetTemporaryDirectory(std::string* ErrMsg) {
157   if (TempDirectory) {
158 #if defined(_MSC_VER)
159     // Visual Studio gets confused and emits a diagnostic about calling exists,
160     // even though this is the implementation for PathV1.  Temporarily 
161     // disable the deprecated warning message
162     #pragma warning(push)
163     #pragma warning(disable:4996)
164 #endif
165     assert(TempDirectory->exists() && "Who has removed TempDirectory?");
166 #if defined(_MSC_VER)
167     #pragma warning(pop)
168 #endif
169     return *TempDirectory;
170   }
171
172   char pathname[MAX_PATH];
173   if (!GetTempPath(MAX_PATH, pathname)) {
174     if (ErrMsg)
175       *ErrMsg = "Can't determine temporary directory";
176     return Path();
177   }
178
179   Path result;
180   result.set(pathname);
181
182   // Append a subdirectory based on our process id so multiple LLVMs don't
183   // step on each other's toes.
184 #ifdef __MINGW32__
185   // Mingw's Win32 header files are broken.
186   sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
187 #else
188   sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
189 #endif
190   result.appendComponent(pathname);
191
192   // If there's a directory left over from a previous LLVM execution that
193   // happened to have the same process id, get rid of it.
194   result.eraseFromDisk(true);
195
196   // And finally (re-)create the empty directory.
197   result.createDirectoryOnDisk(false);
198   TempDirectory = new Path(result);
199   return *TempDirectory;
200 }
201
202 Path
203 Path::GetCurrentDirectory() {
204   char pathname[MAX_PATH];
205   ::GetCurrentDirectoryA(MAX_PATH,pathname);
206   return Path(pathname);
207 }
208
209 /// GetMainExecutable - Return the path to the main executable, given the
210 /// value of argv[0] from program startup.
211 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
212   char pathname[MAX_PATH];
213   DWORD ret = ::GetModuleFileNameA(NULL, pathname, MAX_PATH);
214   return ret != MAX_PATH ? Path(pathname) : Path();
215 }
216
217
218 // FIXME: the above set of functions don't map to Windows very well.
219
220 bool
221 Path::exists() const {
222   DWORD attr = GetFileAttributes(path.c_str());
223   return attr != INVALID_FILE_ATTRIBUTES;
224 }
225
226 bool
227 Path::isDirectory() const {
228   DWORD attr = GetFileAttributes(path.c_str());
229   return (attr != INVALID_FILE_ATTRIBUTES) &&
230          (attr & FILE_ATTRIBUTE_DIRECTORY);
231 }
232
233 bool
234 Path::isSymLink() const {
235   DWORD attributes = GetFileAttributes(path.c_str());
236
237   if (attributes == INVALID_FILE_ATTRIBUTES)
238     // There's no sane way to report this :(.
239     assert(0 && "GetFileAttributes returned INVALID_FILE_ATTRIBUTES");
240
241   // This isn't exactly what defines a NTFS symlink, but it is only true for
242   // paths that act like a symlink.
243   return attributes & FILE_ATTRIBUTE_REPARSE_POINT;
244 }
245
246 bool
247 Path::canExecute() const {
248   // FIXME: take security attributes into account.
249   DWORD attr = GetFileAttributes(path.c_str());
250   return attr != INVALID_FILE_ATTRIBUTES;
251 }
252
253 bool
254 Path::isRegularFile() const {
255   bool res;
256   if (fs::is_regular_file(path, res))
257     return false;
258   return res;
259 }
260
261 const FileStatus *
262 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
263   if (!fsIsValid || update) {
264     WIN32_FILE_ATTRIBUTE_DATA fi;
265     if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
266       MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
267                       ": Can't get status: ");
268       return 0;
269     }
270
271     status.fileSize = fi.nFileSizeHigh;
272     status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
273     status.fileSize += fi.nFileSizeLow;
274
275     status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
276     status.user = 9999;    // Not applicable to Windows, so...
277     status.group = 9999;   // Not applicable to Windows, so...
278
279     ULARGE_INTEGER ui;
280     ui.LowPart = fi.ftLastWriteTime.dwLowDateTime;
281     ui.HighPart = fi.ftLastWriteTime.dwHighDateTime;
282     status.modTime.fromWin32Time(ui.QuadPart);
283
284     status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
285     fsIsValid = true;
286   }
287   return &status;
288 }
289
290 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
291   // All files are readable on Windows (ignoring security attributes).
292   return false;
293 }
294
295 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
296   DWORD attr = GetFileAttributes(path.c_str());
297
298   // If it doesn't exist, we're done.
299   if (attr == INVALID_FILE_ATTRIBUTES)
300     return false;
301
302   if (attr & FILE_ATTRIBUTE_READONLY) {
303     if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
304       MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
305       return true;
306     }
307   }
308   return false;
309 }
310
311 bool
312 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
313   WIN32_FILE_ATTRIBUTE_DATA fi;
314   if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
315     MakeErrMsg(ErrMsg, path + ": can't get status of file");
316     return true;
317   }
318
319   if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
320     if (ErrMsg)
321       *ErrMsg = path + ": not a directory";
322     return true;
323   }
324
325   result.clear();
326   WIN32_FIND_DATA fd;
327   std::string searchpath = path;
328   if (path.size() == 0 || searchpath[path.size()-1] == '/')
329     searchpath += "*";
330   else
331     searchpath += "/*";
332
333   HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
334   if (h == INVALID_HANDLE_VALUE) {
335     if (GetLastError() == ERROR_FILE_NOT_FOUND)
336       return true; // not really an error, now is it?
337     MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
338     return true;
339   }
340
341   do {
342     if (fd.cFileName[0] == '.')
343       continue;
344     Path aPath(path);
345     aPath.appendComponent(&fd.cFileName[0]);
346     result.insert(aPath);
347   } while (FindNextFile(h, &fd));
348
349   DWORD err = GetLastError();
350   FindClose(h);
351   if (err != ERROR_NO_MORE_FILES) {
352     SetLastError(err);
353     MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
354     return true;
355   }
356   return false;
357 }
358
359 bool
360 Path::set(StringRef a_path) {
361   if (a_path.empty())
362     return false;
363   std::string save(path);
364   path = a_path;
365   FlipBackSlashes(path);
366   if (!isValid()) {
367     path = save;
368     return false;
369   }
370   return true;
371 }
372
373 bool
374 Path::appendComponent(StringRef name) {
375   if (name.empty())
376     return false;
377   std::string save(path);
378   if (!path.empty()) {
379     size_t last = path.size() - 1;
380     if (path[last] != '/')
381       path += '/';
382   }
383   path += name;
384   if (!isValid()) {
385     path = save;
386     return false;
387   }
388   return true;
389 }
390
391 bool
392 Path::eraseComponent() {
393   size_t slashpos = path.rfind('/',path.size());
394   if (slashpos == path.size() - 1 || slashpos == std::string::npos)
395     return false;
396   std::string save(path);
397   path.erase(slashpos);
398   if (!isValid()) {
399     path = save;
400     return false;
401   }
402   return true;
403 }
404
405 bool
406 Path::eraseSuffix() {
407   size_t dotpos = path.rfind('.',path.size());
408   size_t slashpos = path.rfind('/',path.size());
409   if (dotpos != std::string::npos) {
410     if (slashpos == std::string::npos || dotpos > slashpos+1) {
411       std::string save(path);
412       path.erase(dotpos, path.size()-dotpos);
413       if (!isValid()) {
414         path = save;
415         return false;
416       }
417       return true;
418     }
419   }
420   return false;
421 }
422
423 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
424   if (ErrMsg)
425     *ErrMsg = std::string(pathname) + ": " + std::string(msg);
426   return true;
427 }
428
429 bool
430 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
431   // Get a writeable copy of the path name
432   size_t len = path.length();
433   char *pathname = reinterpret_cast<char *>(_alloca(len+2));
434   path.copy(pathname, len);
435   pathname[len] = 0;
436
437   // Make sure it ends with a slash.
438   if (len == 0 || pathname[len - 1] != '/') {
439     pathname[len] = '/';
440     pathname[++len] = 0;
441   }
442
443   // Determine starting point for initial / search.
444   char *next = pathname;
445   if (pathname[0] == '/' && pathname[1] == '/') {
446     // Skip host name.
447     next = strchr(pathname+2, '/');
448     if (next == NULL)
449       return PathMsg(ErrMsg, pathname, "badly formed remote directory");
450
451     // Skip share name.
452     next = strchr(next+1, '/');
453     if (next == NULL)
454       return PathMsg(ErrMsg, pathname,"badly formed remote directory");
455
456     next++;
457     if (*next == 0)
458       return PathMsg(ErrMsg, pathname, "badly formed remote directory");
459
460   } else {
461     if (pathname[1] == ':')
462       next += 2;    // skip drive letter
463     if (*next == '/')
464       next++;       // skip root directory
465   }
466
467   // If we're supposed to create intermediate directories
468   if (create_parents) {
469     // Loop through the directory components until we're done
470     while (*next) {
471       next = strchr(next, '/');
472       *next = 0;
473       if (!CreateDirectory(pathname, NULL) &&
474           GetLastError() != ERROR_ALREADY_EXISTS)
475           return MakeErrMsg(ErrMsg,
476             std::string(pathname) + ": Can't create directory: ");
477       *next++ = '/';
478     }
479   } else {
480     // Drop trailing slash.
481     pathname[len-1] = 0;
482     if (!CreateDirectory(pathname, NULL) &&
483         GetLastError() != ERROR_ALREADY_EXISTS) {
484       return MakeErrMsg(ErrMsg, std::string(pathname) +
485                         ": Can't create directory: ");
486     }
487   }
488   return false;
489 }
490
491 bool
492 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
493   WIN32_FILE_ATTRIBUTE_DATA fi;
494   if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
495     return true;
496
497   if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
498     // If it doesn't exist, we're done.
499     bool Exists;
500     if (fs::exists(path, Exists) || !Exists)
501       return false;
502
503     char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
504     int lastchar = path.length() - 1 ;
505     path.copy(pathname, lastchar+1);
506
507     // Make path end with '/*'.
508     if (pathname[lastchar] != '/')
509       pathname[++lastchar] = '/';
510     pathname[lastchar+1] = '*';
511     pathname[lastchar+2] = 0;
512
513     if (remove_contents) {
514       WIN32_FIND_DATA fd;
515       HANDLE h = FindFirstFile(pathname, &fd);
516
517       // It's a bad idea to alter the contents of a directory while enumerating
518       // its contents. So build a list of its contents first, then destroy them.
519
520       if (h != INVALID_HANDLE_VALUE) {
521         std::vector<Path> list;
522
523         do {
524           if (strcmp(fd.cFileName, ".") == 0)
525             continue;
526           if (strcmp(fd.cFileName, "..") == 0)
527             continue;
528
529           Path aPath(path);
530           aPath.appendComponent(&fd.cFileName[0]);
531           list.push_back(aPath);
532         } while (FindNextFile(h, &fd));
533
534         DWORD err = GetLastError();
535         FindClose(h);
536         if (err != ERROR_NO_MORE_FILES) {
537           SetLastError(err);
538           return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
539         }
540
541         for (std::vector<Path>::iterator I = list.begin(); I != list.end();
542              ++I) {
543           Path &aPath = *I;
544           aPath.eraseFromDisk(true);
545         }
546       } else {
547         if (GetLastError() != ERROR_FILE_NOT_FOUND)
548           return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
549       }
550     }
551
552     pathname[lastchar] = 0;
553     if (!RemoveDirectory(pathname))
554       return MakeErrMsg(ErrStr,
555         std::string(pathname) + ": Can't destroy directory: ");
556     return false;
557   } else {
558     // Read-only files cannot be deleted on Windows.  Must remove the read-only
559     // attribute first.
560     if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
561       if (!SetFileAttributes(path.c_str(),
562                              fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
563         return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
564     }
565
566     if (!DeleteFile(path.c_str()))
567       return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
568     return false;
569   }
570 }
571
572 bool
573 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
574   if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
575     return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
576         + "': ");
577   return false;
578 }
579
580 bool
581 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
582   // FIXME: should work on directories also.
583   if (!si.isFile) {
584     return true;
585   }
586
587   HANDLE h = CreateFile(path.c_str(),
588                         FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
589                         FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
590                         NULL,
591                         OPEN_EXISTING,
592                         FILE_ATTRIBUTE_NORMAL,
593                         NULL);
594   if (h == INVALID_HANDLE_VALUE)
595     return true;
596
597   BY_HANDLE_FILE_INFORMATION bhfi;
598   if (!GetFileInformationByHandle(h, &bhfi)) {
599     DWORD err = GetLastError();
600     CloseHandle(h);
601     SetLastError(err);
602     return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
603   }
604
605   ULARGE_INTEGER ui;
606   ui.QuadPart = si.modTime.toWin32Time();
607   FILETIME ft;
608   ft.dwLowDateTime = ui.LowPart;
609   ft.dwHighDateTime = ui.HighPart;
610   BOOL ret = SetFileTime(h, NULL, &ft, &ft);
611   DWORD err = GetLastError();
612   CloseHandle(h);
613   if (!ret) {
614     SetLastError(err);
615     return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
616   }
617
618   // Best we can do with Unix permission bits is to interpret the owner
619   // writable bit.
620   if (si.mode & 0200) {
621     if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
622       if (!SetFileAttributes(path.c_str(),
623               bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
624         return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
625     }
626   } else {
627     if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
628       if (!SetFileAttributes(path.c_str(),
629               bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
630         return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
631     }
632   }
633
634   return false;
635 }
636
637 bool
638 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
639   bool Exists;
640   if (reuse_current && (fs::exists(path, Exists) || !Exists))
641     return false; // File doesn't exist already, just use it!
642
643   // Reserve space for -XXXXXX at the end.
644   char *FNBuffer = (char*) alloca(path.size()+8);
645   unsigned offset = path.size();
646   path.copy(FNBuffer, offset);
647
648   // Find a numeric suffix that isn't used by an existing file.  Assume there
649   // won't be more than 1 million files with the same prefix.  Probably a safe
650   // bet.
651   static int FCounter = -1;
652   if (FCounter < 0) {
653     // Give arbitrary initial seed.
654     // FIXME: We should use sys::fs::unique_file() in future.
655     LARGE_INTEGER cnt64;
656     DWORD x = GetCurrentProcessId();
657     x = (x << 16) | (x >> 16);
658     if (QueryPerformanceCounter(&cnt64))    // RDTSC
659       x ^= cnt64.HighPart ^ cnt64.LowPart;
660     FCounter = x % 1000000;
661   }
662   do {
663     sprintf(FNBuffer+offset, "-%06u", FCounter);
664     if (++FCounter > 999999)
665       FCounter = 0;
666     path = FNBuffer;
667   } while (!fs::exists(path, Exists) && Exists);
668   return false;
669 }
670
671 bool
672 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
673   // Make this into a unique file name
674   makeUnique(reuse_current, ErrMsg);
675
676   // Now go and create it
677   HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
678                         FILE_ATTRIBUTE_NORMAL, NULL);
679   if (h == INVALID_HANDLE_VALUE)
680     return MakeErrMsg(ErrMsg, path + ": can't create file");
681
682   CloseHandle(h);
683   return false;
684 }
685 }
686 }