LLVM  7.0.0svn
FileSystem.h
Go to the documentation of this file.
1 //===- llvm/Support/FileSystem.h - File System OS Concept -------*- 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 declares the llvm::sys::fs namespace. It is designed after
11 // TR2/boost filesystem (v3), but modified to remove exception handling and the
12 // path class.
13 //
14 // All functions return an error_code and their actual work via the last out
15 // argument. The out argument is defined if and only if errc::success is
16 // returned. A function may return any error code in the generic or system
17 // category. However, they shall be equivalent to any error conditions listed
18 // in each functions respective documentation if the condition applies. [ note:
19 // this does not guarantee that error_code will be in the set of explicitly
20 // listed codes, but it does guarantee that if any of the explicitly listed
21 // errors occur, the correct error_code will be used ]. All functions may
22 // return errc::not_enough_memory if there is not enough memory to complete the
23 // operation.
24 //
25 //===----------------------------------------------------------------------===//
26 
27 #ifndef LLVM_SUPPORT_FILESYSTEM_H
28 #define LLVM_SUPPORT_FILESYSTEM_H
29 
30 #include "llvm/ADT/SmallString.h"
31 #include "llvm/ADT/StringRef.h"
32 #include "llvm/ADT/Twine.h"
33 #include "llvm/Config/llvm-config.h"
34 #include "llvm/Support/Chrono.h"
35 #include "llvm/Support/Error.h"
37 #include "llvm/Support/ErrorOr.h"
38 #include "llvm/Support/MD5.h"
39 #include <cassert>
40 #include <cstdint>
41 #include <ctime>
42 #include <memory>
43 #include <stack>
44 #include <string>
45 #include <system_error>
46 #include <tuple>
47 #include <vector>
48 
49 #ifdef HAVE_SYS_STAT_H
50 #include <sys/stat.h>
51 #endif
52 
53 namespace llvm {
54 namespace sys {
55 namespace fs {
56 
57 #if defined(_WIN32)
58 // A Win32 HANDLE is a typedef of void*
59 using file_t = void *;
60 #else
61 using file_t = int;
62 #endif
63 
64 extern const file_t kInvalidFile;
65 
66 /// An enumeration for the file system's view of the type.
67 enum class file_type {
73  block_file,
75  fifo_file,
78 };
79 
80 /// space_info - Self explanatory.
81 struct space_info {
82  uint64_t capacity;
83  uint64_t free;
84  uint64_t available;
85 };
86 
87 enum perms {
88  no_perms = 0,
89  owner_read = 0400,
90  owner_write = 0200,
91  owner_exe = 0100,
93  group_read = 040,
94  group_write = 020,
95  group_exe = 010,
99  others_exe = 01,
105  set_uid_on_exe = 04000,
106  set_gid_on_exe = 02000,
107  sticky_bit = 01000,
110 };
111 
112 // Helper functions so that you can use & and | to manipulate perms bits:
113 inline perms operator|(perms l, perms r) {
114  return static_cast<perms>(static_cast<unsigned short>(l) |
115  static_cast<unsigned short>(r));
116 }
117 inline perms operator&(perms l, perms r) {
118  return static_cast<perms>(static_cast<unsigned short>(l) &
119  static_cast<unsigned short>(r));
120 }
121 inline perms &operator|=(perms &l, perms r) {
122  l = l | r;
123  return l;
124 }
125 inline perms &operator&=(perms &l, perms r) {
126  l = l & r;
127  return l;
128 }
129 inline perms operator~(perms x) {
130  // Avoid UB by explicitly truncating the (unsigned) ~ result.
131  return static_cast<perms>(
132  static_cast<unsigned short>(~static_cast<unsigned short>(x)));
133 }
134 
135 class UniqueID {
136  uint64_t Device;
137  uint64_t File;
138 
139 public:
140  UniqueID() = default;
141  UniqueID(uint64_t Device, uint64_t File) : Device(Device), File(File) {}
142 
143  bool operator==(const UniqueID &Other) const {
144  return Device == Other.Device && File == Other.File;
145  }
146  bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
147  bool operator<(const UniqueID &Other) const {
148  return std::tie(Device, File) < std::tie(Other.Device, Other.File);
149  }
150 
151  uint64_t getDevice() const { return Device; }
152  uint64_t getFile() const { return File; }
153 };
154 
155 /// Represents the result of a call to directory_iterator::status(). This is a
156 /// subset of the information returned by a regular sys::fs::status() call, and
157 /// represents the information provided by Windows FileFirstFile/FindNextFile.
159 protected:
160  #if defined(LLVM_ON_UNIX)
161  time_t fs_st_atime = 0;
162  time_t fs_st_mtime = 0;
163  uid_t fs_st_uid = 0;
164  gid_t fs_st_gid = 0;
165  off_t fs_st_size = 0;
166  #elif defined (_WIN32)
167  uint32_t LastAccessedTimeHigh = 0;
168  uint32_t LastAccessedTimeLow = 0;
169  uint32_t LastWriteTimeHigh = 0;
170  uint32_t LastWriteTimeLow = 0;
171  uint32_t FileSizeHigh = 0;
172  uint32_t FileSizeLow = 0;
173  #endif
176 
177 public:
178  basic_file_status() = default;
179 
180  explicit basic_file_status(file_type Type) : Type(Type) {}
181 
182  #if defined(LLVM_ON_UNIX)
183  basic_file_status(file_type Type, perms Perms, time_t ATime, time_t MTime,
184  uid_t UID, gid_t GID, off_t Size)
185  : fs_st_atime(ATime), fs_st_mtime(MTime), fs_st_uid(UID), fs_st_gid(GID),
186  fs_st_size(Size), Type(Type), Perms(Perms) {}
187 #elif defined(_WIN32)
188  basic_file_status(file_type Type, perms Perms, uint32_t LastAccessTimeHigh,
189  uint32_t LastAccessTimeLow, uint32_t LastWriteTimeHigh,
190  uint32_t LastWriteTimeLow, uint32_t FileSizeHigh,
191  uint32_t FileSizeLow)
192  : LastAccessedTimeHigh(LastAccessTimeHigh),
193  LastAccessedTimeLow(LastAccessTimeLow),
194  LastWriteTimeHigh(LastWriteTimeHigh),
195  LastWriteTimeLow(LastWriteTimeLow), FileSizeHigh(FileSizeHigh),
196  FileSizeLow(FileSizeLow), Type(Type), Perms(Perms) {}
197  #endif
198 
199  // getters
200  file_type type() const { return Type; }
201  perms permissions() const { return Perms; }
202  TimePoint<> getLastAccessedTime() const;
203  TimePoint<> getLastModificationTime() const;
204 
205  #if defined(LLVM_ON_UNIX)
206  uint32_t getUser() const { return fs_st_uid; }
207  uint32_t getGroup() const { return fs_st_gid; }
208  uint64_t getSize() const { return fs_st_size; }
209  #elif defined (_WIN32)
210  uint32_t getUser() const {
211  return 9999; // Not applicable to Windows, so...
212  }
213 
214  uint32_t getGroup() const {
215  return 9999; // Not applicable to Windows, so...
216  }
217 
218  uint64_t getSize() const {
219  return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
220  }
221  #endif
222 
223  // setters
224  void type(file_type v) { Type = v; }
225  void permissions(perms p) { Perms = p; }
226 };
227 
228 /// Represents the result of a call to sys::fs::status().
230  friend bool equivalent(file_status A, file_status B);
231 
232  #if defined(LLVM_ON_UNIX)
233  dev_t fs_st_dev = 0;
234  nlink_t fs_st_nlinks = 0;
235  ino_t fs_st_ino = 0;
236  #elif defined (_WIN32)
237  uint32_t NumLinks = 0;
238  uint32_t VolumeSerialNumber = 0;
239  uint32_t FileIndexHigh = 0;
240  uint32_t FileIndexLow = 0;
241  #endif
242 
243 public:
244  file_status() = default;
245 
247 
248  #if defined(LLVM_ON_UNIX)
249  file_status(file_type Type, perms Perms, dev_t Dev, nlink_t Links, ino_t Ino,
250  time_t ATime, time_t MTime, uid_t UID, gid_t GID, off_t Size)
251  : basic_file_status(Type, Perms, ATime, MTime, UID, GID, Size),
252  fs_st_dev(Dev), fs_st_nlinks(Links), fs_st_ino(Ino) {}
253  #elif defined(_WIN32)
254  file_status(file_type Type, perms Perms, uint32_t LinkCount,
255  uint32_t LastAccessTimeHigh, uint32_t LastAccessTimeLow,
256  uint32_t LastWriteTimeHigh, uint32_t LastWriteTimeLow,
257  uint32_t VolumeSerialNumber, uint32_t FileSizeHigh,
258  uint32_t FileSizeLow, uint32_t FileIndexHigh,
259  uint32_t FileIndexLow)
260  : basic_file_status(Type, Perms, LastAccessTimeHigh, LastAccessTimeLow,
261  LastWriteTimeHigh, LastWriteTimeLow, FileSizeHigh,
262  FileSizeLow),
263  NumLinks(LinkCount), VolumeSerialNumber(VolumeSerialNumber),
264  FileIndexHigh(FileIndexHigh), FileIndexLow(FileIndexLow) {}
265  #endif
266 
267  UniqueID getUniqueID() const;
268  uint32_t getLinkCount() const;
269 };
270 
271 /// @}
272 /// @name Physical Operators
273 /// @{
274 
275 /// Make \a path an absolute path.
276 ///
277 /// Makes \a path absolute using the \a current_directory if it is not already.
278 /// An empty \a path will result in the \a current_directory.
279 ///
280 /// /absolute/path => /absolute/path
281 /// relative/../path => <current-directory>/relative/../path
282 ///
283 /// @param path A path that is modified to be an absolute path.
284 /// @returns errc::success if \a path has been made absolute, otherwise a
285 /// platform-specific error_code.
286 std::error_code make_absolute(const Twine &current_directory,
287  SmallVectorImpl<char> &path);
288 
289 /// Make \a path an absolute path.
290 ///
291 /// Makes \a path absolute using the current directory if it is not already. An
292 /// empty \a path will result in the current directory.
293 ///
294 /// /absolute/path => /absolute/path
295 /// relative/../path => <current-directory>/relative/../path
296 ///
297 /// @param path A path that is modified to be an absolute path.
298 /// @returns errc::success if \a path has been made absolute, otherwise a
299 /// platform-specific error_code.
300 std::error_code make_absolute(SmallVectorImpl<char> &path);
301 
302 /// Create all the non-existent directories in path.
303 ///
304 /// @param path Directories to create.
305 /// @returns errc::success if is_directory(path), otherwise a platform
306 /// specific error_code. If IgnoreExisting is false, also returns
307 /// error if the directory already existed.
308 std::error_code create_directories(const Twine &path,
309  bool IgnoreExisting = true,
310  perms Perms = owner_all | group_all);
311 
312 /// Create the directory in path.
313 ///
314 /// @param path Directory to create.
315 /// @returns errc::success if is_directory(path), otherwise a platform
316 /// specific error_code. If IgnoreExisting is false, also returns
317 /// error if the directory already existed.
318 std::error_code create_directory(const Twine &path, bool IgnoreExisting = true,
319  perms Perms = owner_all | group_all);
320 
321 /// Create a link from \a from to \a to.
322 ///
323 /// The link may be a soft or a hard link, depending on the platform. The caller
324 /// may not assume which one. Currently on windows it creates a hard link since
325 /// soft links require extra privileges. On unix, it creates a soft link since
326 /// hard links don't work on SMB file systems.
327 ///
328 /// @param to The path to hard link to.
329 /// @param from The path to hard link from. This is created.
330 /// @returns errc::success if the link was created, otherwise a platform
331 /// specific error_code.
332 std::error_code create_link(const Twine &to, const Twine &from);
333 
334 /// Create a hard link from \a from to \a to, or return an error.
335 ///
336 /// @param to The path to hard link to.
337 /// @param from The path to hard link from. This is created.
338 /// @returns errc::success if the link was created, otherwise a platform
339 /// specific error_code.
340 std::error_code create_hard_link(const Twine &to, const Twine &from);
341 
342 /// Collapse all . and .. patterns, resolve all symlinks, and optionally
343 /// expand ~ expressions to the user's home directory.
344 ///
345 /// @param path The path to resolve.
346 /// @param output The location to store the resolved path.
347 /// @param expand_tilde If true, resolves ~ expressions to the user's home
348 /// directory.
349 std::error_code real_path(const Twine &path, SmallVectorImpl<char> &output,
350  bool expand_tilde = false);
351 
352 /// Get the current path.
353 ///
354 /// @param result Holds the current path on return.
355 /// @returns errc::success if the current path has been stored in result,
356 /// otherwise a platform-specific error_code.
357 std::error_code current_path(SmallVectorImpl<char> &result);
358 
359 /// Set the current path.
360 ///
361 /// @param path The path to set.
362 /// @returns errc::success if the current path was successfully set,
363 /// otherwise a platform-specific error_code.
364 std::error_code set_current_path(const Twine &path);
365 
366 /// Remove path. Equivalent to POSIX remove().
367 ///
368 /// @param path Input path.
369 /// @returns errc::success if path has been removed or didn't exist, otherwise a
370 /// platform-specific error code. If IgnoreNonExisting is false, also
371 /// returns error if the file didn't exist.
372 std::error_code remove(const Twine &path, bool IgnoreNonExisting = true);
373 
374 /// Recursively delete a directory.
375 ///
376 /// @param path Input path.
377 /// @returns errc::success if path has been removed or didn't exist, otherwise a
378 /// platform-specific error code.
379 std::error_code remove_directories(const Twine &path, bool IgnoreErrors = true);
380 
381 /// Rename \a from to \a to.
382 ///
383 /// Files are renamed as if by POSIX rename(), except that on Windows there may
384 /// be a short interval of time during which the destination file does not
385 /// exist.
386 ///
387 /// @param from The path to rename from.
388 /// @param to The path to rename to. This is created.
389 std::error_code rename(const Twine &from, const Twine &to);
390 
391 /// Copy the contents of \a From to \a To.
392 ///
393 /// @param From The path to copy from.
394 /// @param To The path to copy to. This is created.
395 std::error_code copy_file(const Twine &From, const Twine &To);
396 
397 /// Resize path to size. File is resized as if by POSIX truncate().
398 ///
399 /// @param FD Input file descriptor.
400 /// @param Size Size to resize to.
401 /// @returns errc::success if \a path has been resized to \a size, otherwise a
402 /// platform-specific error_code.
403 std::error_code resize_file(int FD, uint64_t Size);
404 
405 /// Compute an MD5 hash of a file's contents.
406 ///
407 /// @param FD Input file descriptor.
408 /// @returns An MD5Result with the hash computed, if successful, otherwise a
409 /// std::error_code.
411 
412 /// Version of compute_md5 that doesn't require an open file descriptor.
414 
415 /// @}
416 /// @name Physical Observers
417 /// @{
418 
419 /// Does file exist?
420 ///
421 /// @param status A basic_file_status previously returned from stat.
422 /// @returns True if the file represented by status exists, false if it does
423 /// not.
424 bool exists(const basic_file_status &status);
425 
426 enum class AccessMode { Exist, Write, Execute };
427 
428 /// Can the file be accessed?
429 ///
430 /// @param Path Input path.
431 /// @returns errc::success if the path can be accessed, otherwise a
432 /// platform-specific error_code.
433 std::error_code access(const Twine &Path, AccessMode Mode);
434 
435 /// Does file exist?
436 ///
437 /// @param Path Input path.
438 /// @returns True if it exists, false otherwise.
439 inline bool exists(const Twine &Path) {
440  return !access(Path, AccessMode::Exist);
441 }
442 
443 /// Can we execute this file?
444 ///
445 /// @param Path Input path.
446 /// @returns True if we can execute it, false otherwise.
447 bool can_execute(const Twine &Path);
448 
449 /// Can we write this file?
450 ///
451 /// @param Path Input path.
452 /// @returns True if we can write to it, false otherwise.
453 inline bool can_write(const Twine &Path) {
454  return !access(Path, AccessMode::Write);
455 }
456 
457 /// Do file_status's represent the same thing?
458 ///
459 /// @param A Input file_status.
460 /// @param B Input file_status.
461 ///
462 /// assert(status_known(A) || status_known(B));
463 ///
464 /// @returns True if A and B both represent the same file system entity, false
465 /// otherwise.
467 
468 /// Do paths represent the same thing?
469 ///
470 /// assert(status_known(A) || status_known(B));
471 ///
472 /// @param A Input path A.
473 /// @param B Input path B.
474 /// @param result Set to true if stat(A) and stat(B) have the same device and
475 /// inode (or equivalent).
476 /// @returns errc::success if result has been successfully set, otherwise a
477 /// platform-specific error_code.
478 std::error_code equivalent(const Twine &A, const Twine &B, bool &result);
479 
480 /// Simpler version of equivalent for clients that don't need to
481 /// differentiate between an error and false.
482 inline bool equivalent(const Twine &A, const Twine &B) {
483  bool result;
484  return !equivalent(A, B, result) && result;
485 }
486 
487 /// Is the file mounted on a local filesystem?
488 ///
489 /// @param path Input path.
490 /// @param result Set to true if \a path is on fixed media such as a hard disk,
491 /// false if it is not.
492 /// @returns errc::success if result has been successfully set, otherwise a
493 /// platform specific error_code.
494 std::error_code is_local(const Twine &path, bool &result);
495 
496 /// Version of is_local accepting an open file descriptor.
497 std::error_code is_local(int FD, bool &result);
498 
499 /// Simpler version of is_local for clients that don't need to
500 /// differentiate between an error and false.
501 inline bool is_local(const Twine &Path) {
502  bool Result;
503  return !is_local(Path, Result) && Result;
504 }
505 
506 /// Simpler version of is_local accepting an open file descriptor for
507 /// clients that don't need to differentiate between an error and false.
508 inline bool is_local(int FD) {
509  bool Result;
510  return !is_local(FD, Result) && Result;
511 }
512 
513 /// Does status represent a directory?
514 ///
515 /// @param Path The path to get the type of.
516 /// @param Follow For symbolic links, indicates whether to return the file type
517 /// of the link itself, or of the target.
518 /// @returns A value from the file_type enumeration indicating the type of file.
519 file_type get_file_type(const Twine &Path, bool Follow = true);
520 
521 /// Does status represent a directory?
522 ///
523 /// @param status A basic_file_status previously returned from status.
524 /// @returns status.type() == file_type::directory_file.
525 bool is_directory(const basic_file_status &status);
526 
527 /// Is path a directory?
528 ///
529 /// @param path Input path.
530 /// @param result Set to true if \a path is a directory (after following
531 /// symlinks, false if it is not. Undefined otherwise.
532 /// @returns errc::success if result has been successfully set, otherwise a
533 /// platform-specific error_code.
534 std::error_code is_directory(const Twine &path, bool &result);
535 
536 /// Simpler version of is_directory for clients that don't need to
537 /// differentiate between an error and false.
538 inline bool is_directory(const Twine &Path) {
539  bool Result;
540  return !is_directory(Path, Result) && Result;
541 }
542 
543 /// Does status represent a regular file?
544 ///
545 /// @param status A basic_file_status previously returned from status.
546 /// @returns status_known(status) && status.type() == file_type::regular_file.
547 bool is_regular_file(const basic_file_status &status);
548 
549 /// Is path a regular file?
550 ///
551 /// @param path Input path.
552 /// @param result Set to true if \a path is a regular file (after following
553 /// symlinks), false if it is not. Undefined otherwise.
554 /// @returns errc::success if result has been successfully set, otherwise a
555 /// platform-specific error_code.
556 std::error_code is_regular_file(const Twine &path, bool &result);
557 
558 /// Simpler version of is_regular_file for clients that don't need to
559 /// differentiate between an error and false.
560 inline bool is_regular_file(const Twine &Path) {
561  bool Result;
562  if (is_regular_file(Path, Result))
563  return false;
564  return Result;
565 }
566 
567 /// Does status represent a symlink file?
568 ///
569 /// @param status A basic_file_status previously returned from status.
570 /// @returns status_known(status) && status.type() == file_type::symlink_file.
571 bool is_symlink_file(const basic_file_status &status);
572 
573 /// Is path a symlink file?
574 ///
575 /// @param path Input path.
576 /// @param result Set to true if \a path is a symlink file, false if it is not.
577 /// Undefined otherwise.
578 /// @returns errc::success if result has been successfully set, otherwise a
579 /// platform-specific error_code.
580 std::error_code is_symlink_file(const Twine &path, bool &result);
581 
582 /// Simpler version of is_symlink_file for clients that don't need to
583 /// differentiate between an error and false.
584 inline bool is_symlink_file(const Twine &Path) {
585  bool Result;
586  if (is_symlink_file(Path, Result))
587  return false;
588  return Result;
589 }
590 
591 /// Does this status represent something that exists but is not a
592 /// directory or regular file?
593 ///
594 /// @param status A basic_file_status previously returned from status.
595 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s)
596 bool is_other(const basic_file_status &status);
597 
598 /// Is path something that exists but is not a directory,
599 /// regular file, or symlink?
600 ///
601 /// @param path Input path.
602 /// @param result Set to true if \a path exists, but is not a directory, regular
603 /// file, or a symlink, false if it does not. Undefined otherwise.
604 /// @returns errc::success if result has been successfully set, otherwise a
605 /// platform-specific error_code.
606 std::error_code is_other(const Twine &path, bool &result);
607 
608 /// Get file status as if by POSIX stat().
609 ///
610 /// @param path Input path.
611 /// @param result Set to the file status.
612 /// @param follow When true, follows symlinks. Otherwise, the symlink itself is
613 /// statted.
614 /// @returns errc::success if result has been successfully set, otherwise a
615 /// platform-specific error_code.
616 std::error_code status(const Twine &path, file_status &result,
617  bool follow = true);
618 
619 /// A version for when a file descriptor is already available.
620 std::error_code status(int FD, file_status &Result);
621 
622 /// Set file permissions.
623 ///
624 /// @param Path File to set permissions on.
625 /// @param Permissions New file permissions.
626 /// @returns errc::success if the permissions were successfully set, otherwise
627 /// a platform-specific error_code.
628 /// @note On Windows, all permissions except *_write are ignored. Using any of
629 /// owner_write, group_write, or all_write will make the file writable.
630 /// Otherwise, the file will be marked as read-only.
631 std::error_code setPermissions(const Twine &Path, perms Permissions);
632 
633 /// Get file permissions.
634 ///
635 /// @param Path File to get permissions from.
636 /// @returns the permissions if they were successfully retrieved, otherwise a
637 /// platform-specific error_code.
638 /// @note On Windows, if the file does not have the FILE_ATTRIBUTE_READONLY
639 /// attribute, all_all will be returned. Otherwise, all_read | all_exe
640 /// will be returned.
641 ErrorOr<perms> getPermissions(const Twine &Path);
642 
643 /// Get file size.
644 ///
645 /// @param Path Input path.
646 /// @param Result Set to the size of the file in \a Path.
647 /// @returns errc::success if result has been successfully set, otherwise a
648 /// platform-specific error_code.
649 inline std::error_code file_size(const Twine &Path, uint64_t &Result) {
650  file_status Status;
651  std::error_code EC = status(Path, Status);
652  if (EC)
653  return EC;
654  Result = Status.getSize();
655  return std::error_code();
656 }
657 
658 /// Set the file modification and access time.
659 ///
660 /// @returns errc::success if the file times were successfully set, otherwise a
661 /// platform-specific error_code or errc::function_not_supported on
662 /// platforms where the functionality isn't available.
663 std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time);
664 
665 /// Is status available?
666 ///
667 /// @param s Input file status.
668 /// @returns True if status() != status_error.
669 bool status_known(const basic_file_status &s);
670 
671 /// Is status available?
672 ///
673 /// @param path Input path.
674 /// @param result Set to true if status() != status_error.
675 /// @returns errc::success if result has been successfully set, otherwise a
676 /// platform-specific error_code.
677 std::error_code status_known(const Twine &path, bool &result);
678 
679 enum CreationDisposition : unsigned {
680  /// CD_CreateAlways - When opening a file:
681  /// * If it already exists, truncate it.
682  /// * If it does not already exist, create a new file.
684 
685  /// CD_CreateNew - When opening a file:
686  /// * If it already exists, fail.
687  /// * If it does not already exist, create a new file.
689 
690  /// CD_OpenAlways - When opening a file:
691  /// * If it already exists, open the file with the offset set to 0.
692  /// * If it does not already exist, fail.
694 
695  /// CD_OpenAlways - When opening a file:
696  /// * If it already exists, open the file with the offset set to 0.
697  /// * If it does not already exist, create a new file.
699 };
700 
701 enum FileAccess : unsigned {
702  FA_Read = 1,
703  FA_Write = 2,
704 };
705 
706 enum OpenFlags : unsigned {
707  OF_None = 0,
708  F_None = 0, // For compatibility
709 
710  /// The file should be opened in text mode on platforms that make this
711  /// distinction.
712  OF_Text = 1,
713  F_Text = 1, // For compatibility
714 
715  /// The file should be opened in append mode.
717  F_Append = 2, // For compatibility
718 
719  /// Delete the file on close. Only makes a difference on windows.
721 
722  /// When a child process is launched, this file should remain open in the
723  /// child process.
725 };
726 
727 /// Create a uniquely named file.
728 ///
729 /// Generates a unique path suitable for a temporary file and then opens it as a
730 /// file. The name is based on \a model with '%' replaced by a random char in
731 /// [0-9a-f]. If \a model is not an absolute path, the temporary file will be
732 /// created in the current directory.
733 ///
734 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
735 ///
736 /// This is an atomic operation. Either the file is created and opened, or the
737 /// file system is left untouched.
738 ///
739 /// The intended use is for files that are to be kept, possibly after
740 /// renaming them. For example, when running 'clang -c foo.o', the file can
741 /// be first created as foo-abc123.o and then renamed.
742 ///
743 /// @param Model Name to base unique path off of.
744 /// @param ResultFD Set to the opened file's file descriptor.
745 /// @param ResultPath Set to the opened file's absolute path.
746 /// @returns errc::success if Result{FD,Path} have been successfully set,
747 /// otherwise a platform-specific error_code.
748 std::error_code createUniqueFile(const Twine &Model, int &ResultFD,
749  SmallVectorImpl<char> &ResultPath,
750  unsigned Mode = all_read | all_write);
751 
752 /// Simpler version for clients that don't want an open file. An empty
753 /// file will still be created.
754 std::error_code createUniqueFile(const Twine &Model,
755  SmallVectorImpl<char> &ResultPath,
756  unsigned Mode = all_read | all_write);
757 
758 /// Represents a temporary file.
759 ///
760 /// The temporary file must be eventually discarded or given a final name and
761 /// kept.
762 ///
763 /// The destructor doesn't implicitly discard because there is no way to
764 /// properly handle errors in a destructor.
765 class TempFile {
766  bool Done = false;
767  TempFile(StringRef Name, int FD);
768 
769 public:
770  /// This creates a temporary file with createUniqueFile and schedules it for
771  /// deletion with sys::RemoveFileOnSignal.
772  static Expected<TempFile> create(const Twine &Model,
773  unsigned Mode = all_read | all_write);
775  TempFile &operator=(TempFile &&Other);
776 
777  // Name of the temporary file.
778  std::string TmpName;
779 
780  // The open file descriptor.
781  int FD = -1;
782 
783  // Keep this with the given name.
784  Error keep(const Twine &Name);
785 
786  // Keep this with the temporary name.
787  Error keep();
788 
789  // Delete the file.
790  Error discard();
791 
792  // This checks that keep or delete was called.
793  ~TempFile();
794 };
795 
796 /// Create a file in the system temporary directory.
797 ///
798 /// The filename is of the form prefix-random_chars.suffix. Since the directory
799 /// is not know to the caller, Prefix and Suffix cannot have path separators.
800 /// The files are created with mode 0600.
801 ///
802 /// This should be used for things like a temporary .s that is removed after
803 /// running the assembler.
804 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
805  int &ResultFD,
806  SmallVectorImpl<char> &ResultPath);
807 
808 /// Simpler version for clients that don't want an open file. An empty
809 /// file will still be created.
810 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
811  SmallVectorImpl<char> &ResultPath);
812 
813 std::error_code createUniqueDirectory(const Twine &Prefix,
814  SmallVectorImpl<char> &ResultPath);
815 
816 /// Get a unique name, not currently exisiting in the filesystem. Subject
817 /// to race conditions, prefer to use createUniqueFile instead.
818 ///
819 /// Similar to createUniqueFile, but instead of creating a file only
820 /// checks if it exists. This function is subject to race conditions, if you
821 /// want to use the returned name to actually create a file, use
822 /// createUniqueFile instead.
823 std::error_code getPotentiallyUniqueFileName(const Twine &Model,
824  SmallVectorImpl<char> &ResultPath);
825 
826 /// Get a unique temporary file name, not currently exisiting in the
827 /// filesystem. Subject to race conditions, prefer to use createTemporaryFile
828 /// instead.
829 ///
830 /// Similar to createTemporaryFile, but instead of creating a file only
831 /// checks if it exists. This function is subject to race conditions, if you
832 /// want to use the returned name to actually create a file, use
833 /// createTemporaryFile instead.
834 std::error_code
836  SmallVectorImpl<char> &ResultPath);
837 
839  return OpenFlags(unsigned(A) | unsigned(B));
840 }
841 
843  A = A | B;
844  return A;
845 }
846 
848  return FileAccess(unsigned(A) | unsigned(B));
849 }
850 
852  A = A | B;
853  return A;
854 }
855 
856 /// @brief Opens a file with the specified creation disposition, access mode,
857 /// and flags and returns a file descriptor.
858 ///
859 /// The caller is responsible for closing the file descriptor once they are
860 /// finished with it.
861 ///
862 /// @param Name The path of the file to open, relative or absolute.
863 /// @param ResultFD If the file could be opened successfully, its descriptor
864 /// is stored in this location. Otherwise, this is set to -1.
865 /// @param Disp Value specifying the existing-file behavior.
866 /// @param Access Value specifying whether to open the file in read, write, or
867 /// read-write mode.
868 /// @param Flags Additional flags.
869 /// @param Mode The access permissions of the file, represented in octal.
870 /// @returns errc::success if \a Name has been opened, otherwise a
871 /// platform-specific error_code.
872 std::error_code openFile(const Twine &Name, int &ResultFD,
873  CreationDisposition Disp, FileAccess Access,
874  OpenFlags Flags, unsigned Mode = 0666);
875 
876 /// @brief Opens a file with the specified creation disposition, access mode,
877 /// and flags and returns a platform-specific file object.
878 ///
879 /// The caller is responsible for closing the file object once they are
880 /// finished with it.
881 ///
882 /// @param Name The path of the file to open, relative or absolute.
883 /// @param Disp Value specifying the existing-file behavior.
884 /// @param Access Value specifying whether to open the file in read, write, or
885 /// read-write mode.
886 /// @param Flags Additional flags.
887 /// @param Mode The access permissions of the file, represented in octal.
888 /// @returns errc::success if \a Name has been opened, otherwise a
889 /// platform-specific error_code.
891  FileAccess Access, OpenFlags Flags,
892  unsigned Mode = 0666);
893 
894 /// @brief Opens the file with the given name in a write-only or read-write
895 /// mode, returning its open file descriptor. If the file does not exist, it
896 /// is created.
897 ///
898 /// The caller is responsible for closing the file descriptor once they are
899 /// finished with it.
900 ///
901 /// @param Name The path of the file to open, relative or absolute.
902 /// @param ResultFD If the file could be opened successfully, its descriptor
903 /// is stored in this location. Otherwise, this is set to -1.
904 /// @param Flags Additional flags used to determine whether the file should be
905 /// opened in, for example, read-write or in write-only mode.
906 /// @param Mode The access permissions of the file, represented in octal.
907 /// @returns errc::success if \a Name has been opened, otherwise a
908 /// platform-specific error_code.
909 inline std::error_code
910 openFileForWrite(const Twine &Name, int &ResultFD,
912  OpenFlags Flags = OF_None, unsigned Mode = 0666) {
913  return openFile(Name, ResultFD, Disp, FA_Write, Flags, Mode);
914 }
915 
916 /// @brief Opens the file with the given name in a write-only or read-write
917 /// mode, returning its open file descriptor. If the file does not exist, it
918 /// is created.
919 ///
920 /// The caller is responsible for closing the freeing the file once they are
921 /// finished with it.
922 ///
923 /// @param Name The path of the file to open, relative or absolute.
924 /// @param Flags Additional flags used to determine whether the file should be
925 /// opened in, for example, read-write or in write-only mode.
926 /// @param Mode The access permissions of the file, represented in octal.
927 /// @returns a platform-specific file descriptor if \a Name has been opened,
928 /// otherwise an error object.
930  CreationDisposition Disp,
931  OpenFlags Flags,
932  unsigned Mode = 0666) {
933  return openNativeFile(Name, Disp, FA_Write, Flags, Mode);
934 }
935 
936 /// @brief Opens the file with the given name in a write-only or read-write
937 /// mode, returning its open file descriptor. If the file does not exist, it
938 /// is created.
939 ///
940 /// The caller is responsible for closing the file descriptor once they are
941 /// finished with it.
942 ///
943 /// @param Name The path of the file to open, relative or absolute.
944 /// @param ResultFD If the file could be opened successfully, its descriptor
945 /// is stored in this location. Otherwise, this is set to -1.
946 /// @param Flags Additional flags used to determine whether the file should be
947 /// opened in, for example, read-write or in write-only mode.
948 /// @param Mode The access permissions of the file, represented in octal.
949 /// @returns errc::success if \a Name has been opened, otherwise a
950 /// platform-specific error_code.
951 inline std::error_code openFileForReadWrite(const Twine &Name, int &ResultFD,
952  CreationDisposition Disp,
953  OpenFlags Flags,
954  unsigned Mode = 0666) {
955  return openFile(Name, ResultFD, Disp, FA_Write | FA_Read, Flags, Mode);
956 }
957 
958 /// @brief Opens the file with the given name in a write-only or read-write
959 /// mode, returning its open file descriptor. If the file does not exist, it
960 /// is created.
961 ///
962 /// The caller is responsible for closing the freeing the file once they are
963 /// finished with it.
964 ///
965 /// @param Name The path of the file to open, relative or absolute.
966 /// @param Flags Additional flags used to determine whether the file should be
967 /// opened in, for example, read-write or in write-only mode.
968 /// @param Mode The access permissions of the file, represented in octal.
969 /// @returns a platform-specific file descriptor if \a Name has been opened,
970 /// otherwise an error object.
972  CreationDisposition Disp,
973  OpenFlags Flags,
974  unsigned Mode = 0666) {
975  return openNativeFile(Name, Disp, FA_Write | FA_Read, Flags, Mode);
976 }
977 
978 /// @brief Opens the file with the given name in a read-only mode, returning
979 /// its open file descriptor.
980 ///
981 /// The caller is responsible for closing the file descriptor once they are
982 /// finished with it.
983 ///
984 /// @param Name The path of the file to open, relative or absolute.
985 /// @param ResultFD If the file could be opened successfully, its descriptor
986 /// is stored in this location. Otherwise, this is set to -1.
987 /// @param RealPath If nonnull, extra work is done to determine the real path
988 /// of the opened file, and that path is stored in this
989 /// location.
990 /// @returns errc::success if \a Name has been opened, otherwise a
991 /// platform-specific error_code.
992 std::error_code openFileForRead(const Twine &Name, int &ResultFD,
993  OpenFlags Flags = OF_None,
994  SmallVectorImpl<char> *RealPath = nullptr);
995 
996 /// @brief Opens the file with the given name in a read-only mode, returning
997 /// its open file descriptor.
998 ///
999 /// The caller is responsible for closing the freeing the file once they are
1000 /// finished with it.
1001 ///
1002 /// @param Name The path of the file to open, relative or absolute.
1003 /// @param RealPath If nonnull, extra work is done to determine the real path
1004 /// of the opened file, and that path is stored in this
1005 /// location.
1006 /// @returns a platform-specific file descriptor if \a Name has been opened,
1007 /// otherwise an error object.
1009 openNativeFileForRead(const Twine &Name, OpenFlags Flags = OF_None,
1010  SmallVectorImpl<char> *RealPath = nullptr);
1011 
1012 /// @brief Close the file object. This should be used instead of ::close for
1013 /// portability.
1014 ///
1015 /// @param F On input, this is the file to close. On output, the file is
1016 /// set to kInvalidFile.
1017 void closeFile(file_t &F);
1018 
1019 std::error_code getUniqueID(const Twine Path, UniqueID &Result);
1020 
1021 /// Get disk space usage information.
1022 ///
1023 /// Note: Users must be careful about "Time Of Check, Time Of Use" kind of bug.
1024 /// Note: Windows reports results according to the quota allocated to the user.
1025 ///
1026 /// @param Path Input path.
1027 /// @returns a space_info structure filled with the capacity, free, and
1028 /// available space on the device \a Path is on. A platform specific error_code
1029 /// is returned on error.
1030 ErrorOr<space_info> disk_space(const Twine &Path);
1031 
1032 /// This class represents a memory mapped file. It is based on
1033 /// boost::iostreams::mapped_file.
1035 public:
1036  enum mapmode {
1037  readonly, ///< May only access map via const_data as read only.
1038  readwrite, ///< May access map via data and modify it. Written to path.
1039  priv ///< May modify via data, but changes are lost on destruction.
1040  };
1041 
1042 private:
1043  /// Platform-specific mapping state.
1044  size_t Size;
1045  void *Mapping;
1046 #ifdef _WIN32
1047  void *FileHandle;
1048 #endif
1049  mapmode Mode;
1050 
1051  std::error_code init(int FD, uint64_t Offset, mapmode Mode);
1052 
1053 public:
1054  mapped_file_region() = delete;
1056  mapped_file_region &operator =(mapped_file_region&) = delete;
1057 
1058  /// \param fd An open file descriptor to map. mapped_file_region takes
1059  /// ownership if closefd is true. It must have been opended in the correct
1060  /// mode.
1061  mapped_file_region(int fd, mapmode mode, size_t length, uint64_t offset,
1062  std::error_code &ec);
1063 
1064  ~mapped_file_region();
1065 
1066  size_t size() const;
1067  char *data() const;
1068 
1069  /// Get a const view of the data. Modifying this memory has undefined
1070  /// behavior.
1071  const char *const_data() const;
1072 
1073  /// \returns The minimum alignment offset must be.
1074  static int alignment();
1075 };
1076 
1077 /// Return the path to the main executable, given the value of argv[0] from
1078 /// program startup and the address of main itself. In extremis, this function
1079 /// may fail and return an empty path.
1080 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
1081 
1082 /// @}
1083 /// @name Iterators
1084 /// @{
1085 
1086 /// directory_entry - A single entry in a directory. Caches the status either
1087 /// from the result of the iteration syscall, or the first time status is
1088 /// called.
1090  std::string Path;
1091  bool FollowSymlinks;
1092  basic_file_status Status;
1093 
1094 public:
1095  explicit directory_entry(const Twine &path, bool follow_symlinks = true,
1097  : Path(path.str()), FollowSymlinks(follow_symlinks), Status(st) {}
1098 
1099  directory_entry() = default;
1100 
1101  void assign(const Twine &path, basic_file_status st = basic_file_status()) {
1102  Path = path.str();
1103  Status = st;
1104  }
1105 
1106  void replace_filename(const Twine &filename,
1108 
1109  const std::string &path() const { return Path; }
1111 
1112  bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
1113  bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
1114  bool operator< (const directory_entry& rhs) const;
1115  bool operator<=(const directory_entry& rhs) const;
1116  bool operator> (const directory_entry& rhs) const;
1117  bool operator>=(const directory_entry& rhs) const;
1118 };
1119 
1120 namespace detail {
1121 
1122  struct DirIterState;
1123 
1124  std::error_code directory_iterator_construct(DirIterState &, StringRef, bool);
1125  std::error_code directory_iterator_increment(DirIterState &);
1126  std::error_code directory_iterator_destruct(DirIterState &);
1127 
1128  /// Keeps state for the directory_iterator.
1129  struct DirIterState {
1132  }
1133 
1134  intptr_t IterationHandle = 0;
1136  };
1137 
1138 } // end namespace detail
1139 
1140 /// directory_iterator - Iterates through the entries in path. There is no
1141 /// operator++ because we need an error_code. If it's really needed we can make
1142 /// it call report_fatal_error on error.
1144  std::shared_ptr<detail::DirIterState> State;
1145  bool FollowSymlinks = true;
1146 
1147 public:
1148  explicit directory_iterator(const Twine &path, std::error_code &ec,
1149  bool follow_symlinks = true)
1150  : FollowSymlinks(follow_symlinks) {
1151  State = std::make_shared<detail::DirIterState>();
1152  SmallString<128> path_storage;
1154  *State, path.toStringRef(path_storage), FollowSymlinks);
1155  update_error_code_for_current_entry(ec);
1156  }
1157 
1158  explicit directory_iterator(const directory_entry &de, std::error_code &ec,
1159  bool follow_symlinks = true)
1160  : FollowSymlinks(follow_symlinks) {
1161  State = std::make_shared<detail::DirIterState>();
1163  *State, de.path(), FollowSymlinks);
1164  update_error_code_for_current_entry(ec);
1165  }
1166 
1167  /// Construct end iterator.
1168  directory_iterator() = default;
1169 
1170  // No operator++ because we need error_code.
1171  directory_iterator &increment(std::error_code &ec) {
1172  ec = directory_iterator_increment(*State);
1173  update_error_code_for_current_entry(ec);
1174  return *this;
1175  }
1176 
1177  const directory_entry &operator*() const { return State->CurrentEntry; }
1178  const directory_entry *operator->() const { return &State->CurrentEntry; }
1179 
1180  bool operator==(const directory_iterator &RHS) const {
1181  if (State == RHS.State)
1182  return true;
1183  if (!RHS.State)
1184  return State->CurrentEntry == directory_entry();
1185  if (!State)
1186  return RHS.State->CurrentEntry == directory_entry();
1187  return State->CurrentEntry == RHS.State->CurrentEntry;
1188  }
1189 
1190  bool operator!=(const directory_iterator &RHS) const {
1191  return !(*this == RHS);
1192  }
1193  // Other members as required by
1194  // C++ Std, 24.1.1 Input iterators [input.iterators]
1195 
1196 private:
1197  // Checks if current entry is valid and populates error code. For example,
1198  // current entry may not exist due to broken symbol links.
1199  void update_error_code_for_current_entry(std::error_code &ec) {
1200  // Bail out if error has already occured earlier to avoid overwriting it.
1201  if (ec)
1202  return;
1203 
1204  // Empty directory entry is used to mark the end of an interation, it's not
1205  // an error.
1206  if (State->CurrentEntry == directory_entry())
1207  return;
1208 
1209  ErrorOr<basic_file_status> status = State->CurrentEntry.status();
1210  if (!status)
1211  ec = status.getError();
1212  }
1213 };
1214 
1215 namespace detail {
1216 
1217  /// Keeps state for the recursive_directory_iterator.
1219  std::stack<directory_iterator, std::vector<directory_iterator>> Stack;
1220  uint16_t Level = 0;
1221  bool HasNoPushRequest = false;
1222  };
1223 
1224 } // end namespace detail
1225 
1226 /// recursive_directory_iterator - Same as directory_iterator except for it
1227 /// recurses down into child directories.
1229  std::shared_ptr<detail::RecDirIterState> State;
1230  bool Follow;
1231 
1232 public:
1233  recursive_directory_iterator() = default;
1234  explicit recursive_directory_iterator(const Twine &path, std::error_code &ec,
1235  bool follow_symlinks = true)
1236  : State(std::make_shared<detail::RecDirIterState>()),
1237  Follow(follow_symlinks) {
1238  State->Stack.push(directory_iterator(path, ec, Follow));
1239  if (State->Stack.top() == directory_iterator())
1240  State.reset();
1241  }
1242 
1243  // No operator++ because we need error_code.
1244  recursive_directory_iterator &increment(std::error_code &ec) {
1245  const directory_iterator end_itr = {};
1246 
1247  if (State->HasNoPushRequest)
1248  State->HasNoPushRequest = false;
1249  else {
1250  ErrorOr<basic_file_status> status = State->Stack.top()->status();
1251  if (status && is_directory(*status)) {
1252  State->Stack.push(directory_iterator(*State->Stack.top(), ec, Follow));
1253  if (State->Stack.top() != end_itr) {
1254  ++State->Level;
1255  return *this;
1256  }
1257  State->Stack.pop();
1258  }
1259  }
1260 
1261  while (!State->Stack.empty()
1262  && State->Stack.top().increment(ec) == end_itr) {
1263  State->Stack.pop();
1264  --State->Level;
1265  }
1266 
1267  // Check if we are done. If so, create an end iterator.
1268  if (State->Stack.empty())
1269  State.reset();
1270 
1271  return *this;
1272  }
1273 
1274  const directory_entry &operator*() const { return *State->Stack.top(); }
1275  const directory_entry *operator->() const { return &*State->Stack.top(); }
1276 
1277  // observers
1278  /// Gets the current level. Starting path is at level 0.
1279  int level() const { return State->Level; }
1280 
1281  /// Returns true if no_push has been called for this directory_entry.
1282  bool no_push_request() const { return State->HasNoPushRequest; }
1283 
1284  // modifiers
1285  /// Goes up one level if Level > 0.
1286  void pop() {
1287  assert(State && "Cannot pop an end iterator!");
1288  assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
1289 
1290  const directory_iterator end_itr = {};
1291  std::error_code ec;
1292  do {
1293  if (ec)
1294  report_fatal_error("Error incrementing directory iterator.");
1295  State->Stack.pop();
1296  --State->Level;
1297  } while (!State->Stack.empty()
1298  && State->Stack.top().increment(ec) == end_itr);
1299 
1300  // Check if we are done. If so, create an end iterator.
1301  if (State->Stack.empty())
1302  State.reset();
1303  }
1304 
1305  /// Does not go down into the current directory_entry.
1306  void no_push() { State->HasNoPushRequest = true; }
1307 
1308  bool operator==(const recursive_directory_iterator &RHS) const {
1309  return State == RHS.State;
1310  }
1311 
1312  bool operator!=(const recursive_directory_iterator &RHS) const {
1313  return !(*this == RHS);
1314  }
1315  // Other members as required by
1316  // C++ Std, 24.1.1 Input iterators [input.iterators]
1317 };
1318 
1319 /// @}
1320 
1321 } // end namespace fs
1322 } // end namespace sys
1323 } // end namespace llvm
1324 
1325 #endif // LLVM_SUPPORT_FILESYSTEM_H
const file_t kInvalidFile
const directory_entry & operator*() const
Definition: FileSystem.h:1177
std::error_code create_directories(const Twine &path, bool IgnoreExisting=true, perms Perms=owner_all|group_all)
Create all the non-existent directories in path.
Definition: Path.cpp:906
bool can_execute(const Twine &Path)
Can we execute this file?
std::error_code openFileForReadWrite(const Twine &Name, int &ResultFD, CreationDisposition Disp, OpenFlags Flags, unsigned Mode=0666)
Opens the file with the given name in a write-only or read-write mode, returning its open file descri...
Definition: FileSystem.h:951
Represents either an error or a value T.
Definition: ErrorOr.h:69
space_info - Self explanatory.
Definition: FileSystem.h:81
Expected< file_t > openNativeFileForWrite(const Twine &Name, CreationDisposition Disp, OpenFlags Flags, unsigned Mode=0666)
Opens the file with the given name in a write-only or read-write mode, returning its open file descri...
Definition: FileSystem.h:929
SI Whole Quad Mode
bool status_known(const basic_file_status &s)
Is status available?
Definition: Path.cpp:999
LLVM_ATTRIBUTE_NORETURN void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
Definition: Error.cpp:115
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
bool operator<(const UniqueID &Other) const
Definition: FileSystem.h:147
std::error_code openFileForRead(const Twine &Name, int &ResultFD, OpenFlags Flags=OF_None, SmallVectorImpl< char > *RealPath=nullptr)
Opens the file with the given name in a read-only mode, returning its open file descriptor.
void closeFile(file_t &F)
Close the file object.
directory_entry(const Twine &path, bool follow_symlinks=true, basic_file_status st=basic_file_status())
Definition: FileSystem.h:1095
std::error_code createUniqueFile(const Twine &Model, int &ResultFD, SmallVectorImpl< char > &ResultPath, unsigned Mode=all_read|all_write)
Create a uniquely named file.
Definition: Path.cpp:757
bool operator>(int64_t V1, const APSInt &V2)
Definition: APSInt.h:327
recursive_directory_iterator(const Twine &path, std::error_code &ec, bool follow_symlinks=true)
Definition: FileSystem.h:1234
StringRef toStringRef(SmallVectorImpl< char > &Out) const
This returns the twine as a single StringRef if it can be represented as such.
Definition: Twine.h:453
void pop()
Goes up one level if Level > 0.
Definition: FileSystem.h:1286
This class represents a memory mapped file.
Definition: FileSystem.h:1034
std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time)
Set the file modification and access time.
std::error_code current_path(SmallVectorImpl< char > &result)
Get the current path.
bool is_directory(const basic_file_status &status)
Does status represent a directory?
Definition: Path.cpp:1010
Expected< file_t > openNativeFile(const Twine &Name, CreationDisposition Disp, FileAccess Access, OpenFlags Flags, unsigned Mode=0666)
Opens a file with the specified creation disposition, access mode, and flags and returns a platform-s...
F(f)
bool is_regular_file(const basic_file_status &status)
Does status represent a regular file?
Definition: Path.cpp:1022
perms operator~(perms x)
Definition: FileSystem.h:129
directory_iterator & increment(std::error_code &ec)
Definition: FileSystem.h:1171
recursive_directory_iterator - Same as directory_iterator except for it recurses down into child dire...
Definition: FileSystem.h:1228
std::error_code remove_directories(const Twine &path, bool IgnoreErrors=true)
Recursively delete a directory.
Represents the result of a call to sys::fs::status().
Definition: FileSystem.h:229
CD_OpenAlways - When opening a file:
Definition: FileSystem.h:693
ErrorOr< MD5::MD5Result > md5_contents(int FD)
Compute an MD5 hash of a file&#39;s contents.
Definition: Path.cpp:965
bool operator<=(int64_t V1, const APSInt &V2)
Definition: APSInt.h:324
amode Optimize addressing mode
ErrorOr< perms > getPermissions(const Twine &Path)
Get file permissions.
Definition: Path.cpp:1068
std::error_code directory_iterator_increment(DirIterState &)
Definition: BitVector.h:921
perms operator &(perms l, perms r)
Definition: FileSystem.h:117
perms & operator &=(perms &l, perms r)
Definition: FileSystem.h:125
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
bool operator>=(int64_t V1, const APSInt &V2)
Definition: APSInt.h:325
Keeps state for the directory_iterator.
Definition: FileSystem.h:1129
directory_iterator(const Twine &path, std::error_code &ec, bool follow_symlinks=true)
Definition: FileSystem.h:1148
bool operator<(uint32_t Value, UnicodeCharRange Range)
Represents a temporary file.
Definition: FileSystem.h:765
std::error_code file_size(const Twine &Path, uint64_t &Result)
Get file size.
Definition: FileSystem.h:649
const directory_entry & operator*() const
Definition: FileSystem.h:1274
Tagged union holding either a T or a Error.
Definition: CachePruning.h:23
May access map via data and modify it. Written to path.
Definition: FileSystem.h:1038
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:770
bool can_write(const Twine &Path)
Can we write this file?
Definition: FileSystem.h:453
When a child process is launched, this file should remain open in the child process.
Definition: FileSystem.h:724
May only access map via const_data as read only.
Definition: FileSystem.h:1037
CD_CreateNew - When opening a file:
Definition: FileSystem.h:688
uint64_t getFile() const
Definition: FileSystem.h:152
std::error_code is_local(const Twine &path, bool &result)
Is the file mounted on a local filesystem?
std::error_code create_link(const Twine &to, const Twine &from)
Create a link from from to to.
std::stack< directory_iterator, std::vector< directory_iterator > > Stack
Definition: FileSystem.h:1219
directory_iterator(const directory_entry &de, std::error_code &ec, bool follow_symlinks=true)
Definition: FileSystem.h:1158
Delete the file on close. Only makes a difference on windows.
Definition: FileSystem.h:720
The file should be opened in text mode on platforms that make this distinction.
Definition: FileSystem.h:712
std::string getMainExecutable(const char *argv0, void *MainExecAddr)
Return the path to the main executable, given the value of argv[0] from program startup and the addre...
bool operator!=(const directory_iterator &RHS) const
Definition: FileSystem.h:1190
Represents the result of a call to directory_iterator::status().
Definition: FileSystem.h:158
std::error_code copy_file(const Twine &From, const Twine &To)
Copy the contents of From to To.
Definition: Path.cpp:930
const directory_entry * operator->() const
Definition: FileSystem.h:1275
std::error_code real_path(const Twine &path, SmallVectorImpl< char > &output, bool expand_tilde=false)
Collapse all .
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:410
bool operator==(const directory_entry &rhs) const
Definition: FileSystem.h:1112
UniqueID(uint64_t Device, uint64_t File)
Definition: FileSystem.h:141
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
bool operator!=(const directory_entry &rhs) const
Definition: FileSystem.h:1113
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
void no_push()
Does not go down into the current directory_entry.
Definition: FileSystem.h:1306
file_status(file_type Type)
Definition: FileSystem.h:246
std::error_code status(const Twine &path, file_status &result, bool follow=true)
Get file status as if by POSIX stat().
recursive_directory_iterator & increment(std::error_code &ec)
Definition: FileSystem.h:1244
Expected< file_t > openNativeFileForReadWrite(const Twine &Name, CreationDisposition Disp, OpenFlags Flags, unsigned Mode=0666)
Opens the file with the given name in a write-only or read-write mode, returning its open file descri...
Definition: FileSystem.h:971
std::error_code getError() const
Definition: ErrorOr.h:172
bool operator!=(const UniqueID &Other) const
Definition: FileSystem.h:146
std::error_code getUniqueID(const Twine Path, UniqueID &Result)
Definition: Path.cpp:748
std::error_code resize_file(int FD, uint64_t Size)
Resize path to size.
const directory_entry * operator->() const
Definition: FileSystem.h:1178
file_type get_file_type(const Twine &Path, bool Follow=true)
Does status represent a directory?
Definition: Path.cpp:1003
std::error_code make_absolute(const Twine &current_directory, SmallVectorImpl< char > &path)
Make path an absolute path.
Definition: Path.cpp:897
std::error_code create_hard_link(const Twine &to, const Twine &from)
Create a hard link from from to to, or return an error.
basic_file_status(file_type Type)
Definition: FileSystem.h:180
std::error_code openFileForWrite(const Twine &Name, int &ResultFD, CreationDisposition Disp=CD_CreateAlways, OpenFlags Flags=OF_None, unsigned Mode=0666)
Opens the file with the given name in a write-only or read-write mode, returning its open file descri...
Definition: FileSystem.h:910
perms operator|(perms l, perms r)
Definition: FileSystem.h:113
const std::string & path() const
Definition: FileSystem.h:1109
std::error_code rename(const Twine &from, const Twine &to)
Rename from to to.
Keeps state for the recursive_directory_iterator.
Definition: FileSystem.h:1218
auto size(R &&Range, typename std::enable_if< std::is_same< typename std::iterator_traits< decltype(Range.begin())>::iterator_category, std::random_access_iterator_tag >::value, void >::type *=nullptr) -> decltype(std::distance(Range.begin(), Range.end()))
Get the size of a range.
Definition: STLExtras.h:1032
std::error_code directory_iterator_construct(DirIterState &, StringRef, bool)
bool operator==(const recursive_directory_iterator &RHS) const
Definition: FileSystem.h:1308
The file should be opened in append mode.
Definition: FileSystem.h:716
std::error_code createUniqueDirectory(const Twine &Prefix, SmallVectorImpl< char > &ResultPath)
Definition: Path.cpp:822
Expected< file_t > openNativeFileForRead(const Twine &Name, OpenFlags Flags=OF_None, SmallVectorImpl< char > *RealPath=nullptr)
Opens the file with the given name in a read-only mode, returning its open file descriptor.
std::error_code setPermissions(const Twine &Path, perms Permissions)
Set file permissions.
bool is_other(const basic_file_status &status)
Does this status represent something that exists but is not a directory or regular file...
Definition: Path.cpp:1046
file_status(file_type Type, perms Perms, dev_t Dev, nlink_t Links, ino_t Ino, time_t ATime, time_t MTime, uid_t UID, gid_t GID, off_t Size)
Definition: FileSystem.h:249
std::error_code set_current_path(const Twine &path)
Set the current path.
ErrorOr< space_info > disk_space(const Twine &Path)
Get disk space usage information.
std::error_code directory_iterator_destruct(DirIterState &)
directory_iterator - Iterates through the entries in path.
Definition: FileSystem.h:1143
bool operator!=(const recursive_directory_iterator &RHS) const
Definition: FileSystem.h:1312
file_type
An enumeration for the file system&#39;s view of the type.
Definition: FileSystem.h:67
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
Definition: Path.cpp:581
std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix, int &ResultFD, SmallVectorImpl< char > &ResultPath)
Create a file in the system temporary directory.
Definition: Path.cpp:802
bool operator==(const directory_iterator &RHS) const
Definition: FileSystem.h:1180
std::error_code getPotentiallyUniqueTempFileName(const Twine &Prefix, StringRef Suffix, SmallVectorImpl< char > &ResultPath)
Get a unique temporary file name, not currently exisiting in the filesystem.
Definition: Path.cpp:837
uint64_t getDevice() const
Definition: FileSystem.h:151
std::error_code create_directory(const Twine &path, bool IgnoreExisting=true, perms Perms=owner_all|group_all)
Create the directory in path.
bool operator==(const UniqueID &Other) const
Definition: FileSystem.h:143
std::string str() const
Return the twine contents as a std::string.
Definition: Twine.cpp:18
std::error_code getPotentiallyUniqueFileName(const Twine &Model, SmallVectorImpl< char > &ResultPath)
Get a unique name, not currently exisiting in the filesystem.
Definition: Path.cpp:830
Provides ErrorOr<T> smart pointer.
void assign(const Twine &path, basic_file_status st=basic_file_status())
Definition: FileSystem.h:1101
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
bool equivalent(file_status A, file_status B)
Do file_status&#39;s represent the same thing?
CD_CreateAlways - When opening a file:
Definition: FileSystem.h:683
perms & operator|=(perms &l, perms r)
Definition: FileSystem.h:121
std::error_code openFile(const Twine &Name, int &ResultFD, CreationDisposition Disp, FileAccess Access, OpenFlags Flags, unsigned Mode=0666)
Opens a file with the specified creation disposition, access mode, and flags and returns a file descr...
int level() const
Gets the current level. Starting path is at level 0.
Definition: FileSystem.h:1279
constexpr char Size[]
Key for Kernel::Arg::Metadata::mSize.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
bool no_push_request() const
Returns true if no_push has been called for this directory_entry.
Definition: FileSystem.h:1282
directory_entry - A single entry in a directory.
Definition: FileSystem.h:1089
std::error_code access(const Twine &Path, AccessMode Mode)
Can the file be accessed?
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
CD_OpenAlways - When opening a file:
Definition: FileSystem.h:698
bool is_symlink_file(const basic_file_status &status)
Does status represent a symlink file?
Definition: Path.cpp:1034
bool exists(const basic_file_status &status)
Does file exist?
Definition: Path.cpp:995
basic_file_status(file_type Type, perms Perms, time_t ATime, time_t MTime, uid_t UID, gid_t GID, off_t Size)
Definition: FileSystem.h:183
std::chrono::time_point< std::chrono::system_clock, D > TimePoint
A time point on the system clock.
Definition: Chrono.h:34