ModuleManager.h

Go to the documentation of this file.

//===- ModuleManager.cpp - Module Manager -----------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
//  This file defines the ModuleManager class, which manages a set of loaded
//  modules for the ASTReader.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_CLANG_SERIALIZATION_MODULEMANAGER_H
#define LLVM_CLANG_SERIALIZATION_MODULEMANAGER_H
 
#include "clang/Basic/LLVM.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Lex/HeaderSearch.h"
#include "clang/Serialization/ModuleFile.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/iterator.h"
#include "llvm/ADT/iterator_range.h"
#include <cstdint>
#include <ctime>
#include <memory>
#include <string>
#include <utility>
 
namespace clang {
 
class FileEntry;
class FileManager;
class GlobalModuleIndex;
class HeaderSearch;
class ModuleCache;
class PCHContainerReader;
 
namespace serialization {
 
/// The result of attempting to add a new module.
class AddModuleResult {
public:
  enum Kind {
    /// State at construction.
    None,
    /// The module file had already been loaded.
    AlreadyLoaded,
    /// The module file was just loaded in response to this call.
    NewlyLoaded,
    /// The module file is missing.
    Missing,
    /// The module file is out-of-date.
    OutOfDate
  };
 
  Kind getKind() const { return K; };
 
  ModuleFile *getModule() const { return Module; }
 
  StringRef getBufferError() const {
    assert(K == Missing && !Module);
    return BufferError;
  }
 
  const SmallVector<Change, 2> &getChanges() const {
    assert(K == OutOfDate && !Module);
    return Changes;
  }
 
  InputFilesValidation getValidationStatus() const {
    assert(K == OutOfDate && !Module);
    return ValidationStatus;
  }
 
  StringRef getSignatureError() const {
    assert(K == OutOfDate && !Module);
    return SignatureError;
  }
 
  void setOutOfDate(InputFilesValidation Status) {
    K = OutOfDate;
    ValidationStatus = Status;
  }
 
private:
  friend class ModuleManager;
 
  Kind K = None;
  ModuleFile *Module = nullptr;
  SmallVector<Change, 2> Changes;
  InputFilesValidation ValidationStatus = InputFilesValidation::NotStarted;
  std::string BufferError;
  std::string SignatureError;
};
 
/// Manages the set of modules loaded by an AST reader.
class ModuleManager {
  /// The chain of AST files, in the order in which we started to load
  /// them.
  SmallVector<std::unique_ptr<ModuleFile>, 2> Chain;
 
  /// The chain of non-module PCH files. The first entry is the one named
  /// by the user, the last one is the one that doesn't depend on anything
  /// further.
  SmallVector<ModuleFile *, 2> PCHChain;
 
  // The roots of the dependency DAG of AST files. This is used
  // to implement short-circuiting logic when running DFS over the dependencies.
  SmallVector<ModuleFile *, 2> Roots;
 
  /// All loaded modules.
  llvm::DenseMap<ModuleFileKey, ModuleFile *> Modules;
 
  /// FileManager that handles translating between filenames and
  /// FileEntry *.
  FileManager &FileMgr;
 
  /// Cache of PCM files.
  ModuleCache &ModCache;
 
  /// Knows how to unwrap module containers.
  const PCHContainerReader &PCHContainerRdr;
 
  /// Preprocessor's HeaderSearchInfo containing the module map.
  const HeaderSearch &HeaderSearchInfo;
 
  /// The visitation order.
  SmallVector<ModuleFile *, 4> VisitOrder;
 
  /// The list of module files that both we and the global module index
  /// know about.
  ///
  /// Either the global index or the module manager may have modules that the
  /// other does not know about, because the global index can be out-of-date
  /// (in which case the module manager could have modules it does not) and
  /// this particular translation unit might not have loaded all of the modules
  /// known to the global index.
  SmallVector<ModuleFile *, 4> ModulesInCommonWithGlobalIndex;
 
  /// The global module index, if one is attached.
  ///
  /// The global module index will actually be owned by the ASTReader; this is
  /// just an non-owning pointer.
  GlobalModuleIndex *GlobalIndex = nullptr;
 
  bool isModuleFileOutOfDate(off_t Size, time_t ModTime, off_t ExpectedSize,
                             time_t ExpectedModTime, AddModuleResult &Result);
 
  bool checkSignature(ASTFileSignature Signature,
                      ASTFileSignature ExpectedSignature,
                      AddModuleResult &Result);
 
  /// State used by the "visit" operation to avoid malloc traffic in
  /// calls to visit().
  struct VisitState {
    explicit VisitState(unsigned N) : VisitNumber(N, 0) {
      Stack.reserve(N);
    }
 
    /// The stack used when marking the imports of a particular module
    /// as not-to-be-visited.
    SmallVector<ModuleFile *, 4> Stack;
 
    /// The visit number of each module file, which indicates when
    /// this module file was last visited.
    SmallVector<unsigned, 4> VisitNumber;
 
    /// The next visit number to use to mark visited module files.
    unsigned NextVisitNumber = 1;
 
    /// The next visit state.
    std::unique_ptr<VisitState> NextState;
  };
 
  /// The first visit() state in the chain.
  std::unique_ptr<VisitState> FirstVisitState;
 
  std::unique_ptr<VisitState> allocateVisitState();
  void returnVisitState(std::unique_ptr<VisitState> State);
 
public:
  using ModuleIterator = llvm::pointee_iterator<
      SmallVectorImpl<std::unique_ptr<ModuleFile>>::iterator>;
  using ModuleConstIterator = llvm::pointee_iterator<
      SmallVectorImpl<std::unique_ptr<ModuleFile>>::const_iterator>;
  using ModuleReverseIterator = llvm::pointee_iterator<
      SmallVectorImpl<std::unique_ptr<ModuleFile>>::reverse_iterator>;
  using ModuleOffset = std::pair<uint32_t, StringRef>;
 
  ModuleManager(FileManager &FileMgr, ModuleCache &ModCache,
                const PCHContainerReader &PCHContainerRdr,
                const HeaderSearch &HeaderSearchInfo);
 
  /// Forward iterator to traverse all loaded modules.
  ModuleIterator begin() { return Chain.begin(); }
 
  /// Forward iterator end-point to traverse all loaded modules
  ModuleIterator end() { return Chain.end(); }
 
  /// Const forward iterator to traverse all loaded modules.
  ModuleConstIterator begin() const { return Chain.begin(); }
 
  /// Const forward iterator end-point to traverse all loaded modules
  ModuleConstIterator end() const { return Chain.end(); }
 
  /// Reverse iterator to traverse all loaded modules.
  ModuleReverseIterator rbegin() { return Chain.rbegin(); }
 
  /// Reverse iterator end-point to traverse all loaded modules.
  ModuleReverseIterator rend() { return Chain.rend(); }
 
  /// A range covering the PCH and preamble module files loaded.
  llvm::iterator_range<SmallVectorImpl<ModuleFile *>::const_iterator>
  pch_modules() const {
    return llvm::make_range(PCHChain.begin(), PCHChain.end());
  }
 
  /// Returns the primary module associated with the manager, that is,
  /// the first module loaded
  ModuleFile &getPrimaryModule() { return *Chain[0]; }
 
  /// Returns the primary module associated with the manager, that is,
  /// the first module loaded.
  ModuleFile &getPrimaryModule() const { return *Chain[0]; }
 
  /// Returns the module associated with the given index
  ModuleFile &operator[](unsigned Index) const { return *Chain[Index]; }
 
  /// Returns the module associated with the given module name.
  ModuleFile *lookupByModuleName(StringRef ModName) const;
 
  /// Returns the module associated with the given module file name.
  ModuleFile *lookupByFileName(ModuleFileName FileName) const;
 
  /// Returns the module associated with the given module file key.
  ModuleFile *lookup(ModuleFileKey Key) const;
 
  /// Number of modules loaded
  unsigned size() const { return Chain.size(); }
 
  using ASTFileSignatureReader = ASTFileSignature (*)(StringRef);
 
  /// Attempts to create a new module and add it to the list of known
  /// modules.
  ///
  /// \param FileName The file name of the module to be loaded.
  ///
  /// \param Type The kind of module being loaded.
  ///
  /// \param ImportLoc The location at which the module is imported.
  ///
  /// \param ImportedBy The module that is importing this module, or NULL if
  /// this module is imported directly by the user.
  ///
  /// \param Generation The generation in which this module was loaded.
  ///
  /// \param ExpectedSize The expected size of the module file, used for
  /// validation. This will be zero if unknown.
  ///
  /// \param ExpectedModTime The expected modification time of the module
  /// file, used for validation. This will be zero if unknown.
  ///
  /// \param ExpectedSignature The expected signature of the module file, used
  /// for validation. This will be zero if unknown.
  ///
  /// \param ReadSignature Reads the signature from an AST file without actually
  /// loading it.
  ///
  /// \return The result of attempting to add the module, including a pointer
  /// to the module file if successfully loaded.
  AddModuleResult addModule(ModuleFileName FileName, ModuleKind Type,
                            SourceLocation ImportLoc, ModuleFile *ImportedBy,
                            unsigned Generation, off_t ExpectedSize,
                            time_t ExpectedModTime,
                            ASTFileSignature ExpectedSignature,
                            ASTFileSignatureReader ReadSignature);
 
  /// Remove the modules starting from First (to the end).
  void removeModules(ModuleIterator First);
 
  /// Set the global module index.
  void setGlobalIndex(GlobalModuleIndex *Index);
 
  /// Notification from the AST reader that the given module file
  /// has been "accepted", and will not (can not) be unloaded.
  void moduleFileAccepted(ModuleFile *MF);
 
  /// Visit each of the modules.
  ///
  /// This routine visits each of the modules, starting with the
  /// "root" modules that no other loaded modules depend on, and
  /// proceeding to the leaf modules, visiting each module only once
  /// during the traversal.
  ///
  /// This traversal is intended to support various "lookup"
  /// operations that can find data in any of the loaded modules.
  ///
  /// \param Visitor A visitor function that will be invoked with each
  /// module. The return value must be convertible to bool; when false, the
  /// visitation continues to modules that the current module depends on. When
  /// true, the visitation skips any modules that the current module depends on.
  ///
  /// \param ModuleFilesHit If non-NULL, contains the set of module files
  /// that we know we need to visit because the global module index told us to.
  /// Any module that is known to both the global module index and the module
  /// manager that is *not* in this set can be skipped.
  void visit(llvm::function_ref<bool(ModuleFile &M)> Visitor,
             llvm::SmallPtrSetImpl<ModuleFile *> *ModuleFilesHit = nullptr);
 
  /// View the graphviz representation of the module graph.
  void viewGraph();
 
  /// Creates the deduplication key for use in \c ModuleManager.
  /// Returns an empty optional if:
  /// * the module cache does not exist for an implicit module name,
  /// * the module file does not exist for an explicit module name.
  std::optional<ModuleFileKey> makeKey(const ModuleFileName &Name) const;
 
  ModuleCache &getModuleCache() const { return ModCache; }
};
 
} // namespace serialization
 
} // namespace clang
 
#endif // LLVM_CLANG_SERIALIZATION_MODULEMANAGER_H