1 //===- llvm/Support/FileSystem.h - File System OS Concept -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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
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
25 //===----------------------------------------------------------------------===//
27 #ifndef LLVM_SUPPORT_FILE_SYSTEM_H
28 #define LLVM_SUPPORT_FILE_SYSTEM_H
30 #include "llvm/ADT/IntrusiveRefCntPtr.h"
31 #include "llvm/ADT/SmallString.h"
32 #include "llvm/ADT/Twine.h"
33 #include "llvm/Support/DataTypes.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/PathV1.h"
36 #include "llvm/Support/system_error.h"
50 /// file_type - An "enum class" enumeration for the file system's view of the
66 file_type(_ v) : v_(v) {}
67 explicit file_type(int v) : v_(_(v)) {}
68 operator int() const {return v_;}
74 /// copy_option - An "enum class" enumeration of copy semantics for copy
82 copy_option(_ v) : v_(v) {}
83 explicit copy_option(int v) : v_(_(v)) {}
84 operator int() const {return v_;}
90 /// space_info - Self explanatory.
97 /// file_status - Represents the result of a call to stat and friends. It has
98 /// a platform specific member to store the result.
101 #if defined(LLVM_ON_UNIX)
104 #elif defined (LLVM_ON_WIN32)
105 uint32_t LastWriteTimeHigh;
106 uint32_t LastWriteTimeLow;
107 uint32_t VolumeSerialNumber;
108 uint32_t FileSizeHigh;
109 uint32_t FileSizeLow;
110 uint32_t FileIndexHigh;
111 uint32_t FileIndexLow;
113 friend bool equivalent(file_status A, file_status B);
114 friend error_code status(const Twine &path, file_status &result);
117 explicit file_status(file_type v=file_type::status_error)
120 file_type type() const { return Type; }
121 void type(file_type v) { Type = v; }
125 /// @name Physical Operators
128 /// @brief Make \a path an absolute path.
130 /// Makes \a path absolute using the current directory if it is not already. An
131 /// empty \a path will result in the current directory.
133 /// /absolute/path => /absolute/path
134 /// relative/../path => <current-directory>/relative/../path
136 /// @param path A path that is modified to be an absolute path.
137 /// @returns errc::success if \a path has been made absolute, otherwise a
138 /// platform specific error_code.
139 error_code make_absolute(SmallVectorImpl<char> &path);
141 /// @brief Copy the file at \a from to the path \a to.
143 /// @param from The path to copy the file from.
144 /// @param to The path to copy the file to.
145 /// @param copt Behavior if \a to already exists.
146 /// @returns errc::success if the file has been successfully copied.
147 /// errc::file_exists if \a to already exists and \a copt ==
148 /// copy_option::fail_if_exists. Otherwise a platform specific
150 error_code copy_file(const Twine &from, const Twine &to,
151 copy_option copt = copy_option::fail_if_exists);
153 /// @brief Create all the non-existent directories in path.
155 /// @param path Directories to create.
156 /// @param existed Set to true if \a path already existed, false otherwise.
157 /// @returns errc::success if is_directory(path) and existed have been set,
158 /// otherwise a platform specific error_code.
159 error_code create_directories(const Twine &path, bool &existed);
161 /// @brief Create the directory in path.
163 /// @param path Directory to create.
164 /// @param existed Set to true if \a path already existed, false otherwise.
165 /// @returns errc::success if is_directory(path) and existed have been set,
166 /// otherwise a platform specific error_code.
167 error_code create_directory(const Twine &path, bool &existed);
169 /// @brief Create a hard link from \a from to \a to.
171 /// @param to The path to hard link to.
172 /// @param from The path to hard link from. This is created.
173 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
174 /// , otherwise a platform specific error_code.
175 error_code create_hard_link(const Twine &to, const Twine &from);
177 /// @brief Create a symbolic link from \a from to \a to.
179 /// @param to The path to symbolically link to.
180 /// @param from The path to symbolically link from. This is created.
181 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
182 /// otherwise a platform specific error_code.
183 error_code create_symlink(const Twine &to, const Twine &from);
185 /// @brief Get the current path.
187 /// @param result Holds the current path on return.
188 /// @results errc::success if the current path has been stored in result,
189 /// otherwise a platform specific error_code.
190 error_code current_path(SmallVectorImpl<char> &result);
192 /// @brief Remove path. Equivalent to POSIX remove().
194 /// @param path Input path.
195 /// @param existed Set to true if \a path existed, false if it did not.
196 /// undefined otherwise.
197 /// @results errc::success if path has been removed and existed has been
198 /// successfully set, otherwise a platform specific error_code.
199 error_code remove(const Twine &path, bool &existed);
201 /// @brief Recursively remove all files below \a path, then \a path. Files are
202 /// removed as if by POSIX remove().
204 /// @param path Input path.
205 /// @param num_removed Number of files removed.
206 /// @results errc::success if path has been removed and num_removed has been
207 /// successfully set, otherwise a platform specific error_code.
208 error_code remove_all(const Twine &path, uint32_t &num_removed);
210 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
212 /// @param from The path to rename from.
213 /// @param to The path to rename to. This is created.
214 error_code rename(const Twine &from, const Twine &to);
216 /// @brief Resize path to size. File is resized as if by POSIX truncate().
218 /// @param path Input path.
219 /// @param size Size to resize to.
220 /// @returns errc::success if \a path has been resized to \a size, otherwise a
221 /// platform specific error_code.
222 error_code resize_file(const Twine &path, uint64_t size);
225 /// @name Physical Observers
228 /// @brief Does file exist?
230 /// @param status A file_status previously returned from stat.
231 /// @results True if the file represented by status exists, false if it does
233 bool exists(file_status status);
235 /// @brief Does file exist?
237 /// @param path Input path.
238 /// @param result Set to true if the file represented by status exists, false if
239 /// it does not. Undefined otherwise.
240 /// @results errc::success if result has been successfully set, otherwise a
241 /// platform specific error_code.
242 error_code exists(const Twine &path, bool &result);
244 /// @brief Simpler version of exists for clients that don't need to
245 /// differentiate between an error and false.
246 inline bool exists(const Twine &path) {
248 return !exists(path, result) && result;
251 /// @brief Do file_status's represent the same thing?
253 /// @param A Input file_status.
254 /// @param B Input file_status.
256 /// assert(status_known(A) || status_known(B));
258 /// @results True if A and B both represent the same file system entity, false
260 bool equivalent(file_status A, file_status B);
262 /// @brief Do paths represent the same thing?
264 /// assert(status_known(A) || status_known(B));
266 /// @param A Input path A.
267 /// @param B Input path B.
268 /// @param result Set to true if stat(A) and stat(B) have the same device and
269 /// inode (or equivalent).
270 /// @results errc::success if result has been successfully set, otherwise a
271 /// platform specific error_code.
272 error_code equivalent(const Twine &A, const Twine &B, bool &result);
274 /// @brief Get file size.
276 /// @param path Input path.
277 /// @param result Set to the size of the file in \a path.
278 /// @returns errc::success if result has been successfully set, otherwise a
279 /// platform specific error_code.
280 error_code file_size(const Twine &path, uint64_t &result);
282 /// @brief Does status represent a directory?
284 /// @param status A file_status previously returned from status.
285 /// @results status.type() == file_type::directory_file.
286 bool is_directory(file_status status);
288 /// @brief Is path a directory?
290 /// @param path Input path.
291 /// @param result Set to true if \a path is a directory, false if it is not.
292 /// Undefined otherwise.
293 /// @results errc::success if result has been successfully set, otherwise a
294 /// platform specific error_code.
295 error_code is_directory(const Twine &path, bool &result);
297 /// @brief Does status represent a regular file?
299 /// @param status A file_status previously returned from status.
300 /// @results status_known(status) && status.type() == file_type::regular_file.
301 bool is_regular_file(file_status status);
303 /// @brief Is path a regular file?
305 /// @param path Input path.
306 /// @param result Set to true if \a path is a regular file, false if it is not.
307 /// Undefined otherwise.
308 /// @results errc::success if result has been successfully set, otherwise a
309 /// platform specific error_code.
310 error_code is_regular_file(const Twine &path, bool &result);
312 /// @brief Does this status represent something that exists but is not a
313 /// directory, regular file, or symlink?
315 /// @param status A file_status previously returned from status.
316 /// @results exists(s) && !is_regular_file(s) && !is_directory(s) &&
318 bool is_other(file_status status);
320 /// @brief Is path something that exists but is not a directory,
321 /// regular file, or symlink?
323 /// @param path Input path.
324 /// @param result Set to true if \a path exists, but is not a directory, regular
325 /// file, or a symlink, false if it does not. Undefined otherwise.
326 /// @results errc::success if result has been successfully set, otherwise a
327 /// platform specific error_code.
328 error_code is_other(const Twine &path, bool &result);
330 /// @brief Does status represent a symlink?
332 /// @param status A file_status previously returned from stat.
333 /// @param result status.type() == symlink_file.
334 bool is_symlink(file_status status);
336 /// @brief Is path a symlink?
338 /// @param path Input path.
339 /// @param result Set to true if \a path is a symlink, false if it is not.
340 /// Undefined otherwise.
341 /// @results errc::success if result has been successfully set, otherwise a
342 /// platform specific error_code.
343 error_code is_symlink(const Twine &path, bool &result);
345 /// @brief Get file status as if by POSIX stat().
347 /// @param path Input path.
348 /// @param result Set to the file status.
349 /// @results errc::success if result has been successfully set, otherwise a
350 /// platform specific error_code.
351 error_code status(const Twine &path, file_status &result);
353 /// @brief Is status available?
355 /// @param path Input path.
356 /// @results True if status() != status_error.
357 bool status_known(file_status s);
359 /// @brief Is status available?
361 /// @param path Input path.
362 /// @param result Set to true if status() != status_error.
363 /// @results errc::success if result has been successfully set, otherwise a
364 /// platform specific error_code.
365 error_code status_known(const Twine &path, bool &result);
367 /// @brief Generate a unique path and open it as a file.
369 /// Generates a unique path suitable for a temporary file and then opens it as a
370 /// file. The name is based on \a model with '%' replaced by a random char in
371 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
372 /// directory will be prepended.
374 /// This is an atomic operation. Either the file is created and opened, or the
375 /// file system is left untouched.
377 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
379 /// @param model Name to base unique path off of.
380 /// @param result_fs Set to the opened file's file descriptor.
381 /// @param result_path Set to the opened file's absolute path.
382 /// @param makeAbsolute If true and @model is not an absolute path, a temp
383 /// directory will be prepended.
384 /// @results errc::success if result_{fd,path} have been successfully set,
385 /// otherwise a platform specific error_code.
386 error_code unique_file(const Twine &model, int &result_fd,
387 SmallVectorImpl<char> &result_path,
388 bool makeAbsolute = true);
390 /// @brief Canonicalize path.
392 /// Sets result to the file system's idea of what path is. The result is always
393 /// absolute and has the same capitalization as the file system.
395 /// @param path Input path.
396 /// @param result Set to the canonicalized version of \a path.
397 /// @results errc::success if result has been successfully set, otherwise a
398 /// platform specific error_code.
399 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
401 /// @brief Are \a path's first bytes \a magic?
403 /// @param path Input path.
404 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
405 /// @results errc::success if result has been successfully set, otherwise a
406 /// platform specific error_code.
407 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
409 /// @brief Get \a path's first \a len bytes.
411 /// @param path Input path.
412 /// @param len Number of magic bytes to get.
413 /// @param result Set to the first \a len bytes in the file pointed to by
414 /// \a path. Or the entire file if file_size(path) < len, in which
415 /// case result.size() returns the size of the file.
416 /// @results errc::success if result has been successfully set,
417 /// errc::value_too_large if len is larger then the file pointed to by
418 /// \a path, otherwise a platform specific error_code.
419 error_code get_magic(const Twine &path, uint32_t len,
420 SmallVectorImpl<char> &result);
422 /// @brief Get and identify \a path's type based on its content.
424 /// @param path Input path.
425 /// @param result Set to the type of file, or LLVMFileType::Unknown_FileType.
426 /// @results errc::success if result has been successfully set, otherwise a
427 /// platform specific error_code.
428 error_code identify_magic(const Twine &path, LLVMFileType &result);
430 /// @brief Get library paths the system linker uses.
432 /// @param result Set to the list of system library paths.
433 /// @results errc::success if result has been successfully set, otherwise a
434 /// platform specific error_code.
435 error_code GetSystemLibraryPaths(SmallVectorImpl<std::string> &result);
437 /// @brief Get bitcode library paths the system linker uses
438 /// + LLVM_LIB_SEARCH_PATH + LLVM_LIBDIR.
440 /// @param result Set to the list of bitcode library paths.
441 /// @results errc::success if result has been successfully set, otherwise a
442 /// platform specific error_code.
443 error_code GetBitcodeLibraryPaths(SmallVectorImpl<std::string> &result);
445 /// @brief Find a library.
447 /// Find the path to a library using its short name. Use the system
448 /// dependent library paths to locate the library.
450 /// c => /usr/lib/libc.so
452 /// @param short_name Library name one would give to the system linker.
453 /// @param result Set to the absolute path \a short_name represents.
454 /// @results errc::success if result has been successfully set, otherwise a
455 /// platform specific error_code.
456 error_code FindLibrary(const Twine &short_name, SmallVectorImpl<char> &result);
458 /// @brief Get absolute path of main executable.
460 /// @param argv0 The program name as it was spelled on the command line.
461 /// @param MainAddr Address of some symbol in the executable (not in a library).
462 /// @param result Set to the absolute path of the current executable.
463 /// @results errc::success if result has been successfully set, otherwise a
464 /// platform specific error_code.
465 error_code GetMainExecutable(const char *argv0, void *MainAddr,
466 SmallVectorImpl<char> &result);
472 /// directory_entry - A single entry in a directory. Caches the status either
473 /// from the result of the iteration syscall, or the first time status is
475 class directory_entry {
477 mutable file_status Status;
480 explicit directory_entry(const Twine &path, file_status st = file_status())
486 void assign(const Twine &path, file_status st = file_status()) {
491 void replace_filename(const Twine &filename, file_status st = file_status());
493 const std::string &path() const { return Path; }
494 error_code status(file_status &result) const;
496 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
497 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
498 bool operator< (const directory_entry& rhs) const;
499 bool operator<=(const directory_entry& rhs) const;
500 bool operator> (const directory_entry& rhs) const;
501 bool operator>=(const directory_entry& rhs) const;
507 error_code directory_iterator_construct(DirIterState&, StringRef);
508 error_code directory_iterator_increment(DirIterState&);
509 error_code directory_iterator_destruct(DirIterState&);
511 /// DirIterState - Keeps state for the directory_iterator. It is reference
512 /// counted in order to preserve InputIterator semantics on copy.
513 struct DirIterState : public RefCountedBase<DirIterState> {
515 : IterationHandle(0) {}
518 directory_iterator_destruct(*this);
521 intptr_t IterationHandle;
522 directory_entry CurrentEntry;
526 /// directory_iterator - Iterates through the entries in path. There is no
527 /// operator++ because we need an error_code. If it's really needed we can make
528 /// it call report_fatal_error on error.
529 class directory_iterator {
530 IntrusiveRefCntPtr<detail::DirIterState> State;
533 explicit directory_iterator(const Twine &path, error_code &ec) {
534 State = new detail::DirIterState;
535 SmallString<128> path_storage;
536 ec = detail::directory_iterator_construct(*State,
537 path.toStringRef(path_storage));
540 explicit directory_iterator(const directory_entry &de, error_code &ec) {
541 State = new detail::DirIterState;
542 ec = detail::directory_iterator_construct(*State, de.path());
545 /// Construct end iterator.
546 directory_iterator() : State(new detail::DirIterState) {}
548 // No operator++ because we need error_code.
549 directory_iterator &increment(error_code &ec) {
550 ec = directory_iterator_increment(*State);
554 const directory_entry &operator*() const { return State->CurrentEntry; }
555 const directory_entry *operator->() const { return &State->CurrentEntry; }
557 bool operator==(const directory_iterator &RHS) const {
558 return State->CurrentEntry == RHS.State->CurrentEntry;
561 bool operator!=(const directory_iterator &RHS) const {
562 return !(*this == RHS);
564 // Other members as required by
565 // C++ Std, 24.1.1 Input iterators [input.iterators]
569 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
570 /// reference counted in order to preserve InputIterator semantics on copy.
571 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
574 , HasNoPushRequest(false) {}
576 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
578 bool HasNoPushRequest;
582 /// recursive_directory_iterator - Same as directory_iterator except for it
583 /// recurses down into child directories.
584 class recursive_directory_iterator {
585 IntrusiveRefCntPtr<detail::RecDirIterState> State;
588 recursive_directory_iterator() {}
589 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
590 : State(new detail::RecDirIterState) {
591 State->Stack.push(directory_iterator(path, ec));
592 if (State->Stack.top() == directory_iterator())
595 // No operator++ because we need error_code.
596 recursive_directory_iterator &increment(error_code &ec) {
597 static const directory_iterator end_itr;
599 if (State->HasNoPushRequest)
600 State->HasNoPushRequest = false;
603 if ((ec = State->Stack.top()->status(st))) return *this;
604 if (is_directory(st)) {
605 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
606 if (ec) return *this;
607 if (State->Stack.top() != end_itr) {
615 while (!State->Stack.empty()
616 && State->Stack.top().increment(ec) == end_itr) {
621 // Check if we are done. If so, create an end iterator.
622 if (State->Stack.empty())
628 const directory_entry &operator*() const { return *State->Stack.top(); };
629 const directory_entry *operator->() const { return &*State->Stack.top(); };
632 /// Gets the current level. Starting path is at level 0.
633 int level() const { return State->Level; }
635 /// Returns true if no_push has been called for this directory_entry.
636 bool no_push_request() const { return State->HasNoPushRequest; }
639 /// Goes up one level if Level > 0.
641 assert(State && "Cannot pop and end itertor!");
642 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
644 static const directory_iterator end_itr;
648 report_fatal_error("Error incrementing directory iterator.");
651 } while (!State->Stack.empty()
652 && State->Stack.top().increment(ec) == end_itr);
654 // Check if we are done. If so, create an end iterator.
655 if (State->Stack.empty())
659 /// Does not go down into the current directory_entry.
660 void no_push() { State->HasNoPushRequest = true; }
662 bool operator==(const recursive_directory_iterator &RHS) const {
663 return State == RHS.State;
666 bool operator!=(const recursive_directory_iterator &RHS) const {
667 return !(*this == RHS);
669 // Other members as required by
670 // C++ Std, 24.1.1 Input iterators [input.iterators]
675 } // end namespace fs
676 } // end namespace sys
677 } // end namespace llvm