LLVM  14.0.0git
DbiModuleList.h
Go to the documentation of this file.
1 //===- DbiModuleList.h - PDB module information list ------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_DEBUGINFO_PDB_NATIVE_DBIMODULELIST_H
10 #define LLVM_DEBUGINFO_PDB_NATIVE_DBIMODULELIST_H
11 
12 #include "llvm/ADT/StringRef.h"
13 #include "llvm/ADT/iterator.h"
18 #include "llvm/Support/Endian.h"
19 #include "llvm/Support/Error.h"
20 #include <cstddef>
21 #include <cstdint>
22 #include <iterator>
23 #include <vector>
24 
25 namespace llvm {
26 namespace pdb {
27 
28 class DbiModuleList;
29 struct FileInfoSubstreamHeader;
30 
32  : public iterator_facade_base<DbiModuleSourceFilesIterator,
33  std::random_access_iterator_tag, StringRef> {
34  using BaseType =
36  std::random_access_iterator_tag, StringRef>;
37 
38 public:
40  uint16_t Filei);
41  DbiModuleSourceFilesIterator() = default;
44  operator=(const DbiModuleSourceFilesIterator &R) = default;
45 
46  bool operator==(const DbiModuleSourceFilesIterator &R) const;
47 
48  const StringRef &operator*() const { return ThisValue; }
49  StringRef &operator*() { return ThisValue; }
50 
51  bool operator<(const DbiModuleSourceFilesIterator &RHS) const;
52  std::ptrdiff_t operator-(const DbiModuleSourceFilesIterator &R) const;
53  DbiModuleSourceFilesIterator &operator+=(std::ptrdiff_t N);
54  DbiModuleSourceFilesIterator &operator-=(std::ptrdiff_t N);
55 
56 private:
57  void setValue();
58 
59  bool isEnd() const;
60  bool isCompatible(const DbiModuleSourceFilesIterator &R) const;
61  bool isUniversalEnd() const;
62 
63  StringRef ThisValue;
64  const DbiModuleList *Modules{nullptr};
65  uint32_t Modi{0};
66  uint16_t Filei{0};
67 };
68 
71 
72 public:
74 
76  uint32_t getModuleCount() const;
79 
81  source_files(uint32_t Modi) const;
82 
84 
85 private:
86  Error initializeModInfo(BinaryStreamRef ModInfo);
87  Error initializeFileInfo(BinaryStreamRef FileInfo);
88 
90 
93 
94  // For each module, there are multiple filenames, which can be obtained by
95  // knowing the index of the file. Given the index of the file, one can use
96  // that as an offset into the FileNameOffsets array, which contains the
97  // absolute offset of the file name in NamesBuffer. Thus, for each module
98  // we store the first index in the FileNameOffsets array for this module.
99  // The number of files for the corresponding module is stored in
100  // ModFileCountArray.
101  std::vector<uint32_t> ModuleInitialFileIndex;
102 
103  // In order to provide random access into the Descriptors array, we iterate it
104  // once up front to find the offsets of the individual items and store them in
105  // this array.
106  std::vector<uint32_t> ModuleDescriptorOffsets;
107 
108  const FileInfoSubstreamHeader *FileInfoHeader = nullptr;
109 
110  BinaryStreamRef ModInfoSubstream;
111  BinaryStreamRef FileInfoSubstream;
112  BinaryStreamRef NamesBuffer;
113 };
114 
115 } // end namespace pdb
116 } // end namespace llvm
117 
118 #endif // LLVM_DEBUGINFO_PDB_NATIVE_DBIMODULELIST_H
llvm::pdb::DbiModuleList::getModuleCount
uint32_t getModuleCount() const
Definition: DbiModuleList.cpp:241
llvm
This file implements support for optimizing divisions by a constant.
Definition: AllocatorList.h:23
llvm::pdb::DbiModuleList::initialize
Error initialize(BinaryStreamRef ModInfo, BinaryStreamRef FileInfo)
Definition: DbiModuleList.cpp:162
StringRef.h
DbiModuleDescriptor.h
Error.h
llvm::Expected
Tagged union holding either a T or a Error.
Definition: APFloat.h:42
llvm::FixedStreamArray
FixedStreamArray is similar to VarStreamArray, except with each record having a fixed-length.
Definition: BinaryStreamArray.h:262
llvm::pdb::DbiModuleSourceFilesIterator::operator*
StringRef & operator*()
Definition: DbiModuleList.h:49
llvm::pdb::DbiModuleList
Definition: DbiModuleList.h:69
llvm::VarStreamArray
Definition: BinaryStreamArray.h:92
llvm::pdb::DbiModuleList::getSourceFileCount
uint32_t getSourceFileCount() const
Definition: DbiModuleList.cpp:245
llvm::pdb::DbiModuleSourceFilesIterator::operator=
DbiModuleSourceFilesIterator & operator=(const DbiModuleSourceFilesIterator &R)=default
llvm::pdb::DbiModuleSourceFilesIterator::operator-
std::ptrdiff_t operator-(const DbiModuleSourceFilesIterator &R) const
Definition: DbiModuleList.cpp:71
llvm::pdb::DbiModuleSourceFilesIterator::DbiModuleSourceFilesIterator
DbiModuleSourceFilesIterator()=default
Index
uint32_t Index
Definition: ELFObjHandler.cpp:84
llvm::pdb::FileInfoSubstreamHeader
The header preceding the File Info Substream of the DBI stream.
Definition: RawTypes.h:180
iterator.h
llvm::iterator_facade_base
CRTP base class which implements the entire standard iterator facade in terms of a minimal subset of ...
Definition: iterator.h:66
BinaryStreamArray.h
iterator_range.h
llvm::pdb::DbiModuleSourceFilesIterator::operator==
bool operator==(const DbiModuleSourceFilesIterator &R) const
Definition: DbiModuleList.cpp:30
llvm::pdb::DbiModuleSourceFilesIterator::operator+=
DbiModuleSourceFilesIterator & operator+=(std::ptrdiff_t N)
Definition: DbiModuleList.cpp:96
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
BinaryStreamRef.h
uint32_t
llvm::pdb::DbiModuleList::getFileName
Expected< StringRef > getFileName(uint32_t Index) const
Definition: DbiModuleList.cpp:268
llvm::pdb::DbiModuleSourceFilesIterator::operator-=
DbiModuleSourceFilesIterator & operator-=(std::ptrdiff_t N)
Definition: DbiModuleList.cpp:106
uint16_t
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
N
#define N
llvm::pdb::DbiModuleSourceFilesIterator
Definition: DbiModuleList.h:31
llvm::pdb::DbiModuleList::getModuleDescriptor
DbiModuleDescriptor getModuleDescriptor(uint32_t Modi) const
Definition: DbiModuleList.cpp:253
llvm::pdb::DbiModuleSourceFilesIterator::operator<
bool operator<(const DbiModuleSourceFilesIterator &RHS) const
Definition: DbiModuleList.cpp:58
llvm::iterator_range
A range adaptor for a pair of iterators.
Definition: iterator_range.h:30
llvm::pdb::DbiModuleSourceFilesIterator::operator*
const StringRef & operator*() const
Definition: DbiModuleList.h:48
llvm::pdb::DbiModuleDescriptor
Definition: DbiModuleDescriptor.h:23
Endian.h
llvm::pdb::DbiModuleList::source_files
iterator_range< DbiModuleSourceFilesIterator > source_files(uint32_t Modi) const
Definition: DbiModuleList.cpp:262
llvm::BinaryStreamRef
BinaryStreamRef is to BinaryStream what ArrayRef is to an Array.
Definition: BinaryStreamRef.h:156