Removed SrcMgr::FileInfo and SrcMgr::InfoRec and replaced them with a

single class: ContentCache.  This simplifies the logic in
SourceManager and makes the ownership of MemoryBuffers clearer.


git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@43518 91177308-0d34-0410-b5e6-96231b3b80d8

Basic/SourceManager.cpp

@@ -17,6 +17,8 @@
 #include "llvm/Support/Compiler.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/System/Path.h"
+#include "llvm/Bitcode/Serialize.h"
+#include "llvm/Bitcode/Deserialize.h"
 #include <algorithm>
 #include <iostream>
 #include <fcntl.h>
@@ -24,21 +26,11 @@ using namespace clang;
 using namespace SrcMgr;
 using llvm::MemoryBuffer;
 
-SourceManager::~SourceManager() {
-  for (std::map<const FileEntry *, FileInfo>::iterator I = FileInfos.begin(),
-       E = FileInfos.end(); I != E; ++I) {
-    delete I->second.Buffer;
-    delete[] I->second.SourceLineCache;
-  }
-  
-  for (std::list<InfoRec>::iterator I = MemBufferInfos.begin(), 
-       E = MemBufferInfos.end(); I != E; ++I) {
-    delete I->second.Buffer;
-    delete[] I->second.SourceLineCache;
-  }
+ContentCache::~ContentCache() {
+  delete Buffer;
+  delete [] SourceLineCache;
 }
 
-
 // FIXME: REMOVE THESE
 #include <unistd.h>
 #include <sys/types.h>
@@ -100,13 +92,14 @@ static const MemoryBuffer *ReadFileFast(const FileEntry *FileEnt) {
 
 /// getFileInfo - Create or return a cached FileInfo for the specified file.
 ///
-const InfoRec *
-SourceManager::getInfoRec(const FileEntry *FileEnt) {
+const ContentCache* SourceManager::getContentCache(const FileEntry *FileEnt) {
+
   assert(FileEnt && "Didn't specify a file entry to use?");
   // Do we already have information about this file?
-  std::map<const FileEntry *, FileInfo>::iterator I = 
-    FileInfos.lower_bound(FileEnt);
-  if (I != FileInfos.end() && I->first == FileEnt)
+  std::set<ContentCache>::iterator I = 
+    FileInfos.lower_bound(ContentCache(FileEnt));
+  
+  if (I != FileInfos.end() && I->Entry == FileEnt)
     return &*I;
   
   // Nope, get information.
@@ -114,41 +107,37 @@ SourceManager::getInfoRec(const FileEntry *FileEnt) {
   if (File == 0)
     return 0;
 
-  const InfoRec &Entry =
-    *FileInfos.insert(I, std::make_pair(FileEnt, FileInfo()));
-  FileInfo &Info = const_cast<FileInfo &>(Entry.second);
+  ContentCache& Entry = const_cast<ContentCache&>(*FileInfos.insert(I,FileEnt));
 
-  Info.Buffer = File;
-  Info.SourceLineCache = 0;
-  Info.NumLines = 0;
+  Entry.Buffer = File;
+  Entry.SourceLineCache = 0;
+  Entry.NumLines = 0;
   return &Entry;
 }
 
 
 /// createMemBufferInfoRec - Create a new info record for the specified memory
 /// buffer.  This does no caching.
-const InfoRec *
-SourceManager::createMemBufferInfoRec(const MemoryBuffer *Buffer) {
+const ContentCache*
+SourceManager::createMemBufferContentCache(const MemoryBuffer *Buffer) {
   // Add a new info record to the MemBufferInfos list and return it.
-  FileInfo FI;
-  FI.Buffer = Buffer;
-  FI.SourceLineCache = 0;
-  FI.NumLines = 0;
-  MemBufferInfos.push_back(InfoRec(0, FI));
-  return &MemBufferInfos.back();
+  MemBufferInfos.push_back(ContentCache());
+  ContentCache& Entry = const_cast<ContentCache&>(MemBufferInfos.back());
+  Entry.Buffer = Buffer;
+  return &Entry;
 }
 
 
 /// createFileID - Create a new fileID for the specified InfoRec and include
 /// position.  This works regardless of whether the InfoRec corresponds to a
 /// file or some other input source.
-unsigned SourceManager::createFileID(const InfoRec *File,
+unsigned SourceManager::createFileID(const ContentCache *File,
                                      SourceLocation IncludePos) {
   // If FileEnt is really large (e.g. it's a large .i file), we may not be able
   // to fit an arbitrary position in the file in the FilePos field.  To handle
   // this, we create one FileID for each chunk of the file that fits in a
   // FilePos field.
-  unsigned FileSize = File->second.Buffer->getBufferSize();
+  unsigned FileSize = File->Buffer->getBufferSize();
   if (FileSize+1 < (1 << SourceLocation::FilePosBits)) {
     FileIDs.push_back(FileIDInfo::get(IncludePos, 0, File));
     assert(FileIDs.size() < (1 << SourceLocation::FileIDBits) &&
@@ -225,7 +214,7 @@ const char *SourceManager::getCharacterData(SourceLocation SL) const {
   // heavily used by -E mode.
   SL = getPhysicalLoc(SL);
   
-  return getFileInfo(SL.getFileID())->Buffer->getBufferStart() + 
+  return getContentCache(SL.getFileID())->Buffer->getBufferStart() + 
          getFullFilePos(SL);
 }
 
@@ -253,11 +242,11 @@ unsigned SourceManager::getColumnNumber(SourceLocation Loc) const {
 const char *SourceManager::getSourceName(SourceLocation Loc) const {
   unsigned FileID = Loc.getFileID();
   if (FileID == 0) return "";
-  return getFileInfo(FileID)->Buffer->getBufferIdentifier();
+  return getContentCache(FileID)->Buffer->getBufferIdentifier();
 }
 
-static void ComputeLineNumbers(FileInfo *FI) DISABLE_INLINE;
-static void ComputeLineNumbers(FileInfo *FI) {
+static void ComputeLineNumbers(ContentCache* FI) DISABLE_INLINE;
+static void ComputeLineNumbers(ContentCache* FI) {
   const MemoryBuffer *Buffer = FI->Buffer;
   
   // Find the file offsets of all of the *physical* source lines.  This does
@@ -308,23 +297,24 @@ static void ComputeLineNumbers(FileInfo *FI) {
 unsigned SourceManager::getLineNumber(SourceLocation Loc) {
   unsigned FileID = Loc.getFileID();
   if (FileID == 0) return 0;
-  FileInfo *FileInfo;
+
+  ContentCache* Content;
   
   if (LastLineNoFileIDQuery == FileID)
-    FileInfo = LastLineNoFileInfo;
+    Content = LastLineNoContentCache;
   else
-    FileInfo = getFileInfo(FileID);
+    Content = const_cast<ContentCache*>(getContentCache(FileID));
   
   // If this is the first use of line information for this buffer, compute the
   /// SourceLineCache for it on demand.
-  if (FileInfo->SourceLineCache == 0)
-    ComputeLineNumbers(FileInfo);
+  if (Content->SourceLineCache == 0)
+    ComputeLineNumbers(Content);
 
   // Okay, we know we have a line number table.  Do a binary search to find the
   // line number that this character position lands on.
-  unsigned *SourceLineCache = FileInfo->SourceLineCache;
+  unsigned *SourceLineCache = Content->SourceLineCache;
   unsigned *SourceLineCacheStart = SourceLineCache;
-  unsigned *SourceLineCacheEnd = SourceLineCache + FileInfo->NumLines;
+  unsigned *SourceLineCacheEnd = SourceLineCache + Content->NumLines;
   
   unsigned QueriedFilePos = getFullFilePos(Loc)+1;
 
@@ -361,10 +351,10 @@ unsigned SourceManager::getLineNumber(SourceLocation Loc) {
   // NOTE: This is currently disabled, as it does not appear to be profitable in
   // initial measurements.
   if (0 && SourceLineCacheEnd-SourceLineCache > 20) {
-    unsigned FileLen = FileInfo->SourceLineCache[FileInfo->NumLines-1];
+    unsigned FileLen = Content->SourceLineCache[Content->NumLines-1];
     
     // Take a stab at guessing where it is.
-    unsigned ApproxPos = FileInfo->NumLines*QueriedFilePos / FileLen;
+    unsigned ApproxPos = Content->NumLines*QueriedFilePos / FileLen;
     
     // Check for -10 and +10 lines.
     unsigned LowerBound = std::max(int(ApproxPos-10), 0);
@@ -386,7 +376,7 @@ unsigned SourceManager::getLineNumber(SourceLocation Loc) {
   unsigned LineNo = Pos-SourceLineCacheStart;
   
   LastLineNoFileIDQuery = FileID;
-  LastLineNoFileInfo = FileInfo;
+  LastLineNoContentCache = Content;
   LastLineNoFilePos = QueriedFilePos;
   LastLineNoResult = LineNo;
   return LineNo;
@@ -402,15 +392,14 @@ void SourceManager::PrintStats() const {
   std::cerr << "  " << FileIDs.size() << " normal buffer FileID's, "
             << MacroIDs.size() << " macro expansion FileID's.\n";
     
-  
-  
   unsigned NumLineNumsComputed = 0;
   unsigned NumFileBytesMapped = 0;
-  for (std::map<const FileEntry *, FileInfo>::const_iterator I = 
+  for (std::set<ContentCache>::const_iterator I = 
        FileInfos.begin(), E = FileInfos.end(); I != E; ++I) {
-    NumLineNumsComputed += I->second.SourceLineCache != 0;
-    NumFileBytesMapped  += I->second.Buffer->getBufferSize();
+    NumLineNumsComputed += I->SourceLineCache != 0;
+    NumFileBytesMapped  += I->Buffer->getBufferSize();
   }
+  
   std::cerr << NumFileBytesMapped << " bytes of files mapped, "
             << NumLineNumsComputed << " files with line #'s computed.\n";
 }

include/clang/Basic/SourceManager.h

@@ -15,8 +15,9 @@
 #define LLVM_CLANG_SOURCEMANAGER_H
 
 #include "clang/Basic/SourceLocation.h"
+#include "llvm/Bitcode/SerializationFwd.h"
 #include <vector>
-#include <map>
+#include <set>
 #include <list>
 #include <cassert>
 
@@ -33,24 +34,31 @@ class IdentifierTokenInfo;
 /// SrcMgr - Private classes that are part of the SourceManager implementation.
 ///
 namespace SrcMgr {
-  /// FileInfo - Once instance of this struct is kept for every file loaded or
-  /// used.  This object owns the MemoryBuffer object.
-  struct FileInfo {
+  /// ContentCache - Once instance of this struct is kept for every file
+  ///  loaded or used.  This object owns the MemoryBuffer object.
+  struct ContentCache {
+    /// Reference to the file entry.  This reference does not own
+    /// the FileEntry object.  It is possible for this to be NULL if
+    /// the ContentCache encapsulates an imaginary text buffer.
+    const FileEntry* Entry;
+    
     /// Buffer - The actual buffer containing the characters from the input
-    /// file.
-    const llvm::MemoryBuffer *Buffer;
+    /// file.  This is owned by the FileInfo object.
+    const llvm::MemoryBuffer* Buffer;
     
     /// SourceLineCache - A new[]'d array of offsets for each source line.  This
-    /// is lazily computed.
-    ///
-    unsigned *SourceLineCache;
+    /// is lazily computed.  This is owned by the FileInfo object.
+    unsigned* SourceLineCache;
     
     /// NumLines - The number of lines in this FileInfo.  This is only valid if
     /// SourceLineCache is non-null.
     unsigned NumLines;
-  };
         
-  typedef std::pair<const FileEntry * const, FileInfo> InfoRec;
+    ContentCache(const FileEntry* e = NULL)
+    : Entry(e), Buffer(NULL), SourceLineCache(NULL), NumLines(0) {}
+
+    ~ContentCache();
+  };  
 
   /// FileIDInfo - Information about a FileID, basically just the logical file
   /// that it represents and include stack information.  A File SourceLocation
@@ -81,23 +89,23 @@ namespace SrcMgr {
     /// chunk number of this FileID.
     unsigned ChunkNo;
     
-    /// Info - Information about the source buffer itself.
-    ///
-    const InfoRec *Info;
-  public:
+    /// Content - Information about the source buffer itself.
+    const ContentCache* Content;
     
+  public:
     /// get - Return a FileIDInfo object.
-    static FileIDInfo get(SourceLocation IL, unsigned CN, const InfoRec *Inf) {
+    static FileIDInfo get(SourceLocation IL, unsigned CN, 
+                          const ContentCache *Con) {
       FileIDInfo X;
       X.IncludeLoc = IL;
       X.ChunkNo = CN;
-      X.Info = Inf;
+      X.Content = Con;
       return X;
     }
     
     SourceLocation getIncludeLoc() const { return IncludeLoc; }
     unsigned getChunkNo() const { return ChunkNo; }
-    const InfoRec *getInfo() const { return Info; }
+    const ContentCache* getContentCache() const { return Content; }
   };
   
   /// MacroIDInfo - Macro SourceLocations refer to these records by their ID.
@@ -123,7 +131,18 @@ namespace SrcMgr {
     }
   };
 }  // end SrcMgr namespace.
+} // end clang namespace
 
+namespace std {
+template <> struct less<clang::SrcMgr::ContentCache> {
+  inline bool operator()(const clang::SrcMgr::ContentCache& L,
+                         const clang::SrcMgr::ContentCache& R) const {
+    return L.Entry < R.Entry;
+  }
+};
+} // end std namespace
+
+namespace clang {
   
 /// SourceManager - This file handles loading and caching of source files into
 /// memory.  This object owns the MemoryBuffer objects for all of the loaded
@@ -140,12 +159,12 @@ namespace SrcMgr {
 class SourceManager {
   /// FileInfos - Memoized information about all of the files tracked by this
   /// SourceManager.
-  std::map<const FileEntry *, SrcMgr::FileInfo> FileInfos;
+  std::set<SrcMgr::ContentCache> FileInfos;
   
   /// MemBufferInfos - Information about various memory buffers that we have
   /// read in.  This is a list, instead of a vector, because we need pointers to
   /// the FileInfo objects to be stable.
-  std::list<SrcMgr::InfoRec> MemBufferInfos;
+  std::list<SrcMgr::ContentCache> MemBufferInfos;
   
   /// FileIDs - Information about each FileID.  FileID #0 is not valid, so all
   /// entries are off by one.
@@ -157,25 +176,26 @@ class SourceManager {
   /// LastLineNo - These ivars serve as a cache used in the getLineNumber
   /// method which is used to speedup getLineNumber calls to nearby locations.
   unsigned LastLineNoFileIDQuery;
-  SrcMgr::FileInfo *LastLineNoFileInfo;
+  SrcMgr::ContentCache *LastLineNoContentCache;
   unsigned LastLineNoFilePos;
   unsigned LastLineNoResult;
+  
 public:
   SourceManager() : LastLineNoFileIDQuery(~0U) {}
-  ~SourceManager();
+  ~SourceManager() {}
   
   void clearIDTables() {
     FileIDs.clear();
     MacroIDs.clear();
     LastLineNoFileIDQuery = ~0U;
-    LastLineNoFileInfo = 0;
+    LastLineNoContentCache = 0;
   }
   
   /// createFileID - Create a new FileID that represents the specified file
   /// being #included from the specified IncludePosition.  This returns 0 on
   /// error and translates NULL into standard input.
   unsigned createFileID(const FileEntry *SourceFile, SourceLocation IncludePos){
-    const SrcMgr::InfoRec *IR = getInfoRec(SourceFile);
+    const SrcMgr::ContentCache *IR = getContentCache(SourceFile);
     if (IR == 0) return 0;    // Error opening file?
     return createFileID(IR, IncludePos);
   }
@@ -184,7 +204,7 @@ public:
   /// specified memory buffer.  This does no caching of the buffer and takes
   /// ownership of the MemoryBuffer, so only pass a MemoryBuffer to this once.
   unsigned createFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer) {
-    return createFileID(createMemBufferInfoRec(Buffer), SourceLocation());
+    return createFileID(createMemBufferContentCache(Buffer), SourceLocation());
   }
   
   /// getInstantiationLoc - Return a new SourceLocation that encodes the fact
@@ -195,7 +215,7 @@ public:
   /// getBuffer - Return the buffer for the specified FileID.
   ///
   const llvm::MemoryBuffer *getBuffer(unsigned FileID) const {
-    return getFileInfo(FileID)->Buffer;
+    return getContentCache(FileID)->Buffer;
   }
   
   /// getBufferData - Return a pointer to the start and end of the character
@@ -266,13 +286,19 @@ public:
     return PLoc.getFileLocWithOffset(Loc.getMacroPhysOffs());
   }
 
-  /// getFileEntryForLoc - Return the FileEntry record for the physloc of the 
+  /// getContentCacheForLoc - Return the ContentCache for the physloc of the 
   /// specified SourceLocation, if one exists.
-  const FileEntry *getFileEntryForLoc(SourceLocation Loc) const {
+  const SrcMgr::ContentCache* getContentCacheForLoc(SourceLocation Loc) const {
     Loc = getPhysicalLoc(Loc);
     unsigned FileID = Loc.getFileID();
     assert(FileID-1 < FileIDs.size() && "Invalid FileID!");
-    return FileIDs[FileID-1].getInfo()->first;
+    return FileIDs[FileID-1].getContentCache();
+  }
+  
+  /// getFileEntryForLoc - Return the FileEntry record for the physloc of the
+  ///  specified SourceLocation, if one exists.
+  const FileEntry* getFileEntryForLoc(SourceLocation Loc) const {
+    return getContentCacheForLoc(Loc)->Entry;
   }
   
   /// getDecomposedFileLoc - Decompose the specified file location into a raw
@@ -296,42 +322,39 @@ public:
   /// PrintStats - Print statistics to stderr.
   ///
   void PrintStats() const;
+
 private:
-  /// createFileID - Create a new fileID for the specified InfoRec and include
-  /// position.  This works regardless of whether the InfoRec corresponds to a
-  /// file or some other input source.
-  unsigned createFileID(const SrcMgr::InfoRec *File, SourceLocation IncludePos);
+  /// createFileID - Create a new fileID for the specified ContentCache and
+  ///  include position.  This works regardless of whether the ContentCache
+  ///  corresponds to a file or some other input source.
+  unsigned createFileID(const SrcMgr::ContentCache* File,
+                        SourceLocation IncludePos);
     
-  /// getInfoRec - Create or return a cached FileInfo for the specified file.
-  /// This returns null on failure.
-  const SrcMgr::InfoRec *getInfoRec(const FileEntry *SourceFile);
+  /// getContentCache - Create or return a cached ContentCache for the specified
+  ///  file.  This returns null on failure.
+  const SrcMgr::ContentCache* getContentCache(const FileEntry* SourceFile);
   
-  /// createMemBufferInfoRec - Create a new info record for the specified memory
-  /// buffer.  This does no caching.
-  const SrcMgr::InfoRec *createMemBufferInfoRec(const llvm::MemoryBuffer *Buf);
+  /// createMemBufferContentCache - Create a new ContentCache for the specified
+  ///  memory buffer.
+  const SrcMgr::ContentCache* 
+  createMemBufferContentCache(const llvm::MemoryBuffer* Buf);
 
-  const SrcMgr::FileIDInfo *getFIDInfo(unsigned FileID) const {
+  const SrcMgr::FileIDInfo* getFIDInfo(unsigned FileID) const {
     assert(FileID-1 < FileIDs.size() && "Invalid FileID!");
     return &FileIDs[FileID-1];
   }
   
-  const SrcMgr::InfoRec *getInfoRec(unsigned FileID) const {
-    return getInfoRec(getFIDInfo(FileID));
+  const SrcMgr::ContentCache *getContentCache(unsigned FileID) const {
+    return getContentCache(getFIDInfo(FileID));
   }
   
-  SrcMgr::FileInfo *getFileInfo(unsigned FileID) const {
-    if (const SrcMgr::InfoRec *IR = getInfoRec(FileID))
-      return const_cast<SrcMgr::FileInfo *>(&IR->second);
-    return 0;
+  /// Return the ContentCache structure for the specified FileID.  
+  ///  This is always the physical reference for the ID.
+  const SrcMgr::ContentCache*
+  getContentCache(const SrcMgr::FileIDInfo* FIDInfo) const {
+    return FIDInfo->getContentCache();
   }  
   
-  /// Return the InfoRec structure for the specified FileID.  This is always the
-  /// physical reference for the ID.
-  const SrcMgr::InfoRec *getInfoRec(const SrcMgr::FileIDInfo *FIDInfo) const {
-    return FIDInfo->getInfo();
-  }
-  
-  
   /// getFullFilePos - This (efficient) method returns the offset from the start
   /// of the file that the specified physical SourceLocation represents.  This
   /// returns the location of the physical character data, not the logical file