198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//===--- ModuleManager.cpp - Module Manager ---------------------*- C++ -*-===//
298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//
398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//                     The LLVM Compiler Infrastructure
498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//
598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// This file is distributed under the University of Illinois Open Source
698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor// License. See LICENSE.TXT for details.
798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//
898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//===----------------------------------------------------------------------===//
998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//
1098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//  This file defines the ModuleManager class, which manages a set of loaded
1198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//  modules for the ASTReader.
1298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//
1398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor//===----------------------------------------------------------------------===//
1498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
1598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#ifndef LLVM_CLANG_SERIALIZATION_MODULE_MANAGER_H
1698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#define LLVM_CLANG_SERIALIZATION_MODULE_MANAGER_H
1798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
1898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#include "clang/Basic/FileManager.h"
1930a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Serialization/Module.h"
2098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#include "llvm/ADT/DenseMap.h"
21ef8225444452a1486bd721f3285301fe84643b00Stephen Hines#include "llvm/ADT/SmallPtrSet.h"
2298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
2398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregornamespace clang {
2498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
25fa69fc19121da3fc5673ccc00d4e8afa5b540a4fDouglas Gregorclass GlobalModuleIndex;
26677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregorclass ModuleMap;
27188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor
2898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregornamespace serialization {
29fa69fc19121da3fc5673ccc00d4e8afa5b540a4fDouglas Gregor
3098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor/// \brief Manages the set of modules loaded by an AST reader.
31fa69fc19121da3fc5673ccc00d4e8afa5b540a4fDouglas Gregorclass ModuleManager {
3298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief The chain of AST files. The first entry is the one named by the
3398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// user, the last one is the one that doesn't depend on anything further.
34cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko  SmallVector<ModuleFile *, 2> Chain;
3598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
3698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief All loaded modules, indexed by name.
371a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor  llvm::DenseMap<const FileEntry *, ModuleFile *> Modules;
3898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
3998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief FileManager that handles translating between filenames and
4098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// FileEntry *.
41d64c26f6676eef69d1713f353ca8a3c2fe963f17Argyrios Kyrtzidis  FileManager &FileMgr;
4298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
4398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief A lookup of in-memory (virtual file) buffers
4498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  llvm::DenseMap<const FileEntry *, llvm::MemoryBuffer *> InMemoryBuffers;
45d07865b42dcb32154c75134fded51b38cc55a0c4Douglas Gregor
46d07865b42dcb32154c75134fded51b38cc55a0c4Douglas Gregor  /// \brief The visitation order.
47d07865b42dcb32154c75134fded51b38cc55a0c4Douglas Gregor  SmallVector<ModuleFile *, 4> VisitOrder;
48d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
49188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// \brief The list of module files that both we and the global module index
50188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// know about.
51188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  ///
52188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// Either the global index or the module manager may have modules that the
53188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// other does not know about, because the global index can be out-of-date
54188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// (in which case the module manager could have modules it does not) and
55188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// this particular translation unit might not have loaded all of the modules
56188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// known to the global index.
57188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  SmallVector<ModuleFile *, 4> ModulesInCommonWithGlobalIndex;
58188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor
59188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// \brief The global module index, if one is attached.
60188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  ///
61188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// The global module index will actually be owned by the ASTReader; this is
62188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// just an non-owning pointer.
63188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  GlobalModuleIndex *GlobalIndex;
64188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor
65d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  /// \brief State used by the "visit" operation to avoid malloc traffic in
66d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  /// calls to visit().
67d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  struct VisitState {
68d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    explicit VisitState(unsigned N)
696bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines      : VisitNumber(N, 0), NextVisitNumber(1), NextState(nullptr)
70d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    {
71d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor      Stack.reserve(N);
72d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    }
73d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
74d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    ~VisitState() {
75d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor      delete NextState;
76d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    }
77d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
78d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    /// \brief The stack used when marking the imports of a particular module
79d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    /// as not-to-be-visited.
80d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    SmallVector<ModuleFile *, 4> Stack;
81d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
82d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    /// \brief The visit number of each module file, which indicates when
83d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    /// this module file was last visited.
84d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    SmallVector<unsigned, 4> VisitNumber;
85d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
86d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    /// \brief The next visit number to use to mark visited module files.
87d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    unsigned NextVisitNumber;
88d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
89d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    /// \brief The next visit state.
90d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor    VisitState *NextState;
91d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  };
92d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
93d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  /// \brief The first visit() state in the chain.
94d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  VisitState *FirstVisitState;
95d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
96d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  VisitState *allocateVisitState();
97d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor  void returnVisitState(VisitState *State);
98d3cf5fba332fc77f7e72ef58077822606718671dDouglas Gregor
9998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregorpublic:
10009d19efaa147762f84aed55efa7930bb3616a4e5Craig Topper  typedef SmallVectorImpl<ModuleFile*>::iterator ModuleIterator;
10109d19efaa147762f84aed55efa7930bb3616a4e5Craig Topper  typedef SmallVectorImpl<ModuleFile*>::const_iterator ModuleConstIterator;
10209d19efaa147762f84aed55efa7930bb3616a4e5Craig Topper  typedef SmallVectorImpl<ModuleFile*>::reverse_iterator ModuleReverseIterator;
10398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  typedef std::pair<uint32_t, StringRef> ModuleOffset;
10498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
105d64c26f6676eef69d1713f353ca8a3c2fe963f17Argyrios Kyrtzidis  explicit ModuleManager(FileManager &FileMgr);
10698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ~ModuleManager();
10798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
10898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Forward iterator to traverse all loaded modules.  This is reverse
10998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// source-order.
11098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ModuleIterator begin() { return Chain.begin(); }
11198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Forward iterator end-point to traverse all loaded modules
11298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ModuleIterator end() { return Chain.end(); }
11398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
11498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Const forward iterator to traverse all loaded modules.  This is
11598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// in reverse source-order.
11698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ModuleConstIterator begin() const { return Chain.begin(); }
11798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Const forward iterator end-point to traverse all loaded modules
11898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ModuleConstIterator end() const { return Chain.end(); }
11998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
12098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Reverse iterator to traverse all loaded modules.  This is in
12198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// source order.
12298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ModuleReverseIterator rbegin() { return Chain.rbegin(); }
12398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Reverse iterator end-point to traverse all loaded modules.
12498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ModuleReverseIterator rend() { return Chain.rend(); }
12598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
12698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Returns the primary module associated with the manager, that is,
12798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// the first module loaded
1281a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor  ModuleFile &getPrimaryModule() { return *Chain[0]; }
12998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
13098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Returns the primary module associated with the manager, that is,
13198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// the first module loaded.
1321a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor  ModuleFile &getPrimaryModule() const { return *Chain[0]; }
13398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
13498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Returns the module associated with the given index
1351a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor  ModuleFile &operator[](unsigned Index) const { return *Chain[Index]; }
13698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
13798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Returns the module associated with the given name
1381a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor  ModuleFile *lookup(StringRef Name);
139c544ba09695e300f31355af342258bd57619e737Douglas Gregor
140c544ba09695e300f31355af342258bd57619e737Douglas Gregor  /// \brief Returns the module associated with the given module file.
141c544ba09695e300f31355af342258bd57619e737Douglas Gregor  ModuleFile *lookup(const FileEntry *File);
142c544ba09695e300f31355af342258bd57619e737Douglas Gregor
14398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Returns the in-memory (virtual file) buffer with the given name
14498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  llvm::MemoryBuffer *lookupBuffer(StringRef Name);
14598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
14698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Number of modules loaded
14798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  unsigned size() const { return Chain.size(); }
148677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor
149677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \brief The result of attempting to add a new module.
150677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  enum AddModuleResult {
151677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    /// \brief The module file had already been loaded.
152677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    AlreadyLoaded,
153677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    /// \brief The module file was just loaded in response to this call.
154677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    NewlyLoaded,
155677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    /// \brief The module file is missing.
156677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    Missing,
157677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    /// \brief The module file is out-of-date.
158677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor    OutOfDate
159677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  };
160677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor
16198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Attempts to create a new module and add it to the list of known
16298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// modules.
16398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
16498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param FileName The file name of the module to be loaded.
16598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
16698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param Type The kind of module being loaded.
16798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
16887e2cfcec7231daaa3f367dc32df74b411251e46Douglas Gregor  /// \param ImportLoc The location at which the module is imported.
16987e2cfcec7231daaa3f367dc32df74b411251e46Douglas Gregor  ///
17098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param ImportedBy The module that is importing this module, or NULL if
17198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// this module is imported directly by the user.
17298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
173057df20b3107cef764052d271c89b8591b98b3ceDouglas Gregor  /// \param Generation The generation in which this module was loaded.
174057df20b3107cef764052d271c89b8591b98b3ceDouglas Gregor  ///
175677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \param ExpectedSize The expected size of the module file, used for
176677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// validation. This will be zero if unknown.
177677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
178677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \param ExpectedModTime The expected modification time of the module
179677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// file, used for validation. This will be zero if unknown.
180677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
181677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \param Module A pointer to the module file if the module was successfully
182677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// loaded.
183677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
18498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param ErrorStr Will be set to a non-empty string if any errors occurred
18598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// while trying to load the module.
18698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
18798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \return A pointer to the module that corresponds to this file name,
188677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// and a value indicating whether the module was loaded.
189677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  AddModuleResult addModule(StringRef FileName, ModuleKind Type,
190677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                            SourceLocation ImportLoc,
191677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                            ModuleFile *ImportedBy, unsigned Generation,
192677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                            off_t ExpectedSize, time_t ExpectedModTime,
193677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                            ModuleFile *&Module,
194677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                            std::string &ErrorStr);
1957cdd28162dc7ade4b14bf237e87b4bbc17b2f023Douglas Gregor
1967cdd28162dc7ade4b14bf237e87b4bbc17b2f023Douglas Gregor  /// \brief Remove the given set of modules.
197677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  void removeModules(ModuleIterator first, ModuleIterator last,
198ef8225444452a1486bd721f3285301fe84643b00Stephen Hines                     llvm::SmallPtrSetImpl<ModuleFile *> &LoadedSuccessfully,
199677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                     ModuleMap *modMap);
2007cdd28162dc7ade4b14bf237e87b4bbc17b2f023Douglas Gregor
20198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Add an in-memory buffer the list of known buffers
20298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  void addInMemoryBuffer(StringRef FileName, llvm::MemoryBuffer *Buffer);
203188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor
204188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// \brief Set the global module index.
205188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  void setGlobalIndex(GlobalModuleIndex *Index);
206188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor
207fa69fc19121da3fc5673ccc00d4e8afa5b540a4fDouglas Gregor  /// \brief Notification from the AST reader that the given module file
208fa69fc19121da3fc5673ccc00d4e8afa5b540a4fDouglas Gregor  /// has been "accepted", and will not (can not) be unloaded.
209fa69fc19121da3fc5673ccc00d4e8afa5b540a4fDouglas Gregor  void moduleFileAccepted(ModuleFile *MF);
210fa69fc19121da3fc5673ccc00d4e8afa5b540a4fDouglas Gregor
21198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Visit each of the modules.
21298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
21398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// This routine visits each of the modules, starting with the
21498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// "root" modules that no other loaded modules depend on, and
21598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// proceeding to the leaf modules, visiting each module only once
21698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// during the traversal.
21798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
21898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// This traversal is intended to support various "lookup"
21998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// operations that can find data in any of the loaded modules.
22098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
22198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param Visitor A visitor function that will be invoked with each
22298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// module and the given user data pointer. The return value must be
22398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// convertible to bool; when false, the visitation continues to
22498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// modules that the current module depends on. When true, the
22598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// visitation skips any modules that the current module depends on.
22698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
22798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param UserData User data associated with the visitor object, which
22898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// will be passed along to the visitor.
229188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  ///
230188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// \param ModuleFilesHit If non-NULL, contains the set of module files
231188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// that we know we need to visit because the global module index told us to.
232188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// Any module that is known to both the global module index and the module
233188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  /// manager that is *not* in this set can be skipped.
234188bdcd1aaf5e9f457cec6851707d7dc3e7bbb15Douglas Gregor  void visit(bool (*Visitor)(ModuleFile &M, void *UserData), void *UserData,
2356bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines             llvm::SmallPtrSet<ModuleFile *, 4> *ModuleFilesHit = nullptr);
23698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
23798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \brief Visit each of the modules with a depth-first traversal.
23898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
23998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// This routine visits each of the modules known to the module
24098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// manager using a depth-first search, starting with the first
24198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// loaded module. The traversal invokes the callback both before
24298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// traversing the children (preorder traversal) and after
24398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// traversing the children (postorder traversal).
24498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
24598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param Visitor A visitor function that will be invoked with each
24698339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// module and given a \c Preorder flag that indicates whether we're
24798339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// visiting the module before or after visiting its children.  The
24898339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// visitor may return true at any time to abort the depth-first
24998339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// visitation.
25098339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  ///
25198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// \param UserData User data ssociated with the visitor object,
25298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor  /// which will be passed along to the user.
2531a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor  void visitDepthFirst(bool (*Visitor)(ModuleFile &M, bool Preorder,
25498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor                                       void *UserData),
25598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor                       void *UserData);
256677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor
257677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \brief Attempt to resolve the given module file name to a file entry.
258677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
259677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \param FileName The name of the module file.
260677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
261677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \param ExpectedSize The size that the module file is expected to have.
262677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// If the actual size differs, the resolver should return \c true.
263677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
264677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \param ExpectedModTime The modification time that the module file is
265677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// expected to have. If the actual modification time differs, the resolver
266677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// should return \c true.
267677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
268677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \param File Will be set to the file if there is one, or null
269677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// otherwise.
270677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  ///
271677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// \returns True if a file exists but does not meet the size/
272677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// modification time criteria, false if the file is either available and
273677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  /// suitable, or is missing.
274677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor  bool lookupModuleFile(StringRef FileName,
275677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                        off_t ExpectedSize,
276677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                        time_t ExpectedModTime,
277677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor                        const FileEntry *&File);
278677e15ffee2ecc9c1c8f46fd77cab4b5afb59640Douglas Gregor
2792492c89882b5c5ce03afb4704fee67b7eff8f5eeDouglas Gregor  /// \brief View the graphviz representation of the module graph.
2802492c89882b5c5ce03afb4704fee67b7eff8f5eeDouglas Gregor  void viewGraph();
28198339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor};
28298339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
28398339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor} } // end namespace clang::serialization
28498339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor
28598339b96a8089a6da715487e432c5abfca0ca0dfDouglas Gregor#endif
286