granicus.if.org Git - clang/blob - include/clang/Basic/FileManager.h

   1 //===--- FileManager.h - File System Probing and Caching --------*- 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 /// \file
  11 /// \brief Defines the clang::FileManager interface and associated types.
  12 ///
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_FILEMANAGER_H
  16 #define LLVM_CLANG_FILEMANAGER_H
  17
  18 #include "clang/Basic/FileSystemOptions.h"
  19 #include "clang/Basic/LLVM.h"
  20 #include "clang/Basic/VirtualFileSystem.h"
  21 #include "llvm/ADT/DenseMap.h"
  22 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  23 #include "llvm/ADT/OwningPtr.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/ADT/StringMap.h"
  26 #include "llvm/ADT/StringRef.h"
  27 #include "llvm/Support/Allocator.h"
  28 // FIXME: Enhance libsystem to support inode and other fields in stat.
  29 #include <sys/types.h>
  30 #include <map>
  31
  32 #ifdef _MSC_VER
  33 typedef unsigned short mode_t;
  34 #endif
  35
  36 struct stat;
  37
  38 namespace llvm {
  39 class MemoryBuffer;
  40 }
  41
  42 namespace clang {
  43 class FileManager;
  44 class FileSystemStatCache;
  45
  46 /// \brief Cached information about one directory (either on disk or in
  47 /// the virtual file system).
  48 class DirectoryEntry {
  49   const char *Name;   // Name of the directory.
  50   friend class FileManager;
  51 public:
  52   DirectoryEntry() : Name(0) {}
  53   const char *getName() const { return Name; }
  54 };
  55
  56 /// \brief Cached information about one file (either on disk
  57 /// or in the virtual file system).
  58 ///
  59 /// If the 'File' member is valid, then this FileEntry has an open file
  60 /// descriptor for the file.
  61 class FileEntry {
  62   const char *Name;           // Name of the file.
  63   off_t Size;                 // File size in bytes.
  64   time_t ModTime;             // Modification time of file.
  65   const DirectoryEntry *Dir;  // Directory file lives in.
  66   unsigned UID;               // A unique (small) ID for the file.
  67   llvm::sys::fs::UniqueID UniqueID;
  68   bool IsNamedPipe;
  69   bool InPCH;
  70   bool IsValid;               // Is this \c FileEntry initialized and valid?
  71
  72   /// \brief The open file, if it is owned by the \p FileEntry.
  73   mutable OwningPtr<vfs::File> File;
  74   friend class FileManager;
  75
  76   void closeFile() const {
  77     File.reset(0); // rely on destructor to close File
  78   }
  79
  80   FileEntry(const FileEntry &) LLVM_DELETED_FUNCTION;
  81   void operator=(const FileEntry &) LLVM_DELETED_FUNCTION;
  82
  83 public:
  84   FileEntry()
  85       : Name(0), UniqueID(0, 0), IsNamedPipe(false), InPCH(false),
  86         IsValid(false)
  87   {}
  88
  89   const char *getName() const { return Name; }
  90   bool isValid() const { return IsValid; }
  91   off_t getSize() const { return Size; }
  92   unsigned getUID() const { return UID; }
  93   const llvm::sys::fs::UniqueID &getUniqueID() const { return UniqueID; }
  94   bool isInPCH() const { return InPCH; }
  95   time_t getModificationTime() const { return ModTime; }
  96
  97   /// \brief Return the directory the file lives in.
  98   const DirectoryEntry *getDir() const { return Dir; }
  99
 100   bool operator<(const FileEntry &RHS) const { return UniqueID < RHS.UniqueID; }
 101
 102   /// \brief Check whether the file is a named pipe (and thus can't be opened by
 103   /// the native FileManager methods).
 104   bool isNamedPipe() const { return IsNamedPipe; }
 105 };
 106
 107 struct FileData;
 108
 109 /// \brief Implements support for file system lookup, file system caching,
 110 /// and directory search management.
 111 ///
 112 /// This also handles more advanced properties, such as uniquing files based
 113 /// on "inode", so that a file with two names (e.g. symlinked) will be treated
 114 /// as a single file.
 115 ///
 116 class FileManager : public RefCountedBase<FileManager> {
 117   IntrusiveRefCntPtr<vfs::FileSystem> FS;
 118   FileSystemOptions FileSystemOpts;
 119
 120   /// \brief Cache for existing real directories.
 121   std::map<llvm::sys::fs::UniqueID, DirectoryEntry> UniqueRealDirs;
 122
 123   /// \brief Cache for existing real files.
 124   std::map<llvm::sys::fs::UniqueID, FileEntry> UniqueRealFiles;
 125
 126   /// \brief The virtual directories that we have allocated.
 127   ///
 128   /// For each virtual file (e.g. foo/bar/baz.cpp), we add all of its parent
 129   /// directories (foo/ and foo/bar/) here.
 130   SmallVector<DirectoryEntry*, 4> VirtualDirectoryEntries;
 131   /// \brief The virtual files that we have allocated.
 132   SmallVector<FileEntry*, 4> VirtualFileEntries;
 133
 134   /// \brief A cache that maps paths to directory entries (either real or
 135   /// virtual) we have looked up
 136   ///
 137   /// The actual Entries for real directories/files are
 138   /// owned by UniqueRealDirs/UniqueRealFiles above, while the Entries
 139   /// for virtual directories/files are owned by
 140   /// VirtualDirectoryEntries/VirtualFileEntries above.
 141   ///
 142   llvm::StringMap<DirectoryEntry*, llvm::BumpPtrAllocator> SeenDirEntries;
 143
 144   /// \brief A cache that maps paths to file entries (either real or
 145   /// virtual) we have looked up.
 146   ///
 147   /// \see SeenDirEntries
 148   llvm::StringMap<FileEntry*, llvm::BumpPtrAllocator> SeenFileEntries;
 149
 150   /// \brief The canonical names of directories.
 151   llvm::DenseMap<const DirectoryEntry *, llvm::StringRef> CanonicalDirNames;
 152
 153   /// \brief Storage for canonical names that we have computed.
 154   llvm::BumpPtrAllocator CanonicalNameStorage;
 155
 156   /// \brief Each FileEntry we create is assigned a unique ID #.
 157   ///
 158   unsigned NextFileUID;
 159
 160   // Statistics.
 161   unsigned NumDirLookups, NumFileLookups;
 162   unsigned NumDirCacheMisses, NumFileCacheMisses;
 163
 164   // Caching.
 165   OwningPtr<FileSystemStatCache> StatCache;
 166
 167   bool getStatValue(const char *Path, FileData &Data, bool isFile,
 168                     vfs::File **F);
 169
 170   /// Add all ancestors of the given path (pointing to either a file
 171   /// or a directory) as virtual directories.
 172   void addAncestorsAsVirtualDirs(StringRef Path);
 173
 174 public:
 175   FileManager(const FileSystemOptions &FileSystemOpts,
 176               IntrusiveRefCntPtr<vfs::FileSystem> FS = 0);
 177   ~FileManager();
 178
 179   /// \brief Installs the provided FileSystemStatCache object within
 180   /// the FileManager.
 181   ///
 182   /// Ownership of this object is transferred to the FileManager.
 183   ///
 184   /// \param statCache the new stat cache to install. Ownership of this
 185   /// object is transferred to the FileManager.
 186   ///
 187   /// \param AtBeginning whether this new stat cache must be installed at the
 188   /// beginning of the chain of stat caches. Otherwise, it will be added to
 189   /// the end of the chain.
 190   void addStatCache(FileSystemStatCache *statCache, bool AtBeginning = false);
 191
 192   /// \brief Removes the specified FileSystemStatCache object from the manager.
 193   void removeStatCache(FileSystemStatCache *statCache);
 194
 195   /// \brief Removes all FileSystemStatCache objects from the manager.
 196   void clearStatCaches();
 197
 198   /// \brief Lookup, cache, and verify the specified directory (real or
 199   /// virtual).
 200   ///
 201   /// This returns NULL if the directory doesn't exist.
 202   ///
 203   /// \param CacheFailure If true and the file does not exist, we'll cache
 204   /// the failure to find this file.
 205   const DirectoryEntry *getDirectory(StringRef DirName,
 206                                      bool CacheFailure = true);
 207
 208   /// \brief Lookup, cache, and verify the specified file (real or
 209   /// virtual).
 210   ///
 211   /// This returns NULL if the file doesn't exist.
 212   ///
 213   /// \param OpenFile if true and the file exists, it will be opened.
 214   ///
 215   /// \param CacheFailure If true and the file does not exist, we'll cache
 216   /// the failure to find this file.
 217   const FileEntry *getFile(StringRef Filename, bool OpenFile = false,
 218                            bool CacheFailure = true);
 219
 220   /// \brief Returns the current file system options
 221   const FileSystemOptions &getFileSystemOptions() { return FileSystemOpts; }
 222
 223   IntrusiveRefCntPtr<vfs::FileSystem> getVirtualFileSystem() const {
 224     return FS;
 225   }
 226
 227   /// \brief Retrieve a file entry for a "virtual" file that acts as
 228   /// if there were a file with the given name on disk.
 229   ///
 230   /// The file itself is not accessed.
 231   const FileEntry *getVirtualFile(StringRef Filename, off_t Size,
 232                                   time_t ModificationTime);
 233
 234   /// \brief Open the specified file as a MemoryBuffer, returning a new
 235   /// MemoryBuffer if successful, otherwise returning null.
 236   llvm::MemoryBuffer *getBufferForFile(const FileEntry *Entry,
 237                                        std::string *ErrorStr = 0,
 238                                        bool isVolatile = false);
 239   llvm::MemoryBuffer *getBufferForFile(StringRef Filename,
 240                                        std::string *ErrorStr = 0);
 241
 242   /// \brief Get the 'stat' information for the given \p Path.
 243   ///
 244   /// If the path is relative, it will be resolved against the WorkingDir of the
 245   /// FileManager's FileSystemOptions.
 246   ///
 247   /// \returns false on success, true on error.
 248   bool getNoncachedStatValue(StringRef Path,
 249                              vfs::Status &Result);
 250
 251   /// \brief Remove the real file \p Entry from the cache.
 252   void invalidateCache(const FileEntry *Entry);
 253
 254   /// \brief If path is not absolute and FileSystemOptions set the working
 255   /// directory, the path is modified to be relative to the given
 256   /// working directory.
 257   void FixupRelativePath(SmallVectorImpl<char> &path) const;
 258
 259   /// \brief Produce an array mapping from the unique IDs assigned to each
 260   /// file to the corresponding FileEntry pointer.
 261   void GetUniqueIDMapping(
 262                     SmallVectorImpl<const FileEntry *> &UIDToFiles) const;
 263
 264   /// \brief Modifies the size and modification time of a previously created
 265   /// FileEntry. Use with caution.
 266   static void modifyFileEntry(FileEntry *File, off_t Size,
 267                               time_t ModificationTime);
 268
 269   /// \brief Retrieve the canonical name for a given directory.
 270   ///
 271   /// This is a very expensive operation, despite its results being cached,
 272   /// and should only be used when the physical layout of the file system is
 273   /// required, which is (almost) never.
 274   StringRef getCanonicalName(const DirectoryEntry *Dir);
 275
 276   void PrintStats() const;
 277 };
 278
 279 }  // end namespace clang
 280
 281 #endif