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