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"
14#include "llvm/ADT/iterator_range.h"
15#include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptor.h"
16#include "llvm/Support/BinaryStreamArray.h"
17#include "llvm/Support/BinaryStreamRef.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
25namespace llvm {
26namespace pdb {
27
28class DbiModuleList;
29struct FileInfoSubstreamHeader;
30
31class DbiModuleSourceFilesIterator
32    : public iterator_facade_base<DbiModuleSourceFilesIterator,
33                                  std::random_access_iterator_tag, StringRef> {
34  using BaseType =
35      iterator_facade_base<DbiModuleSourceFilesIterator,
36                           std::random_access_iterator_tag, StringRef>;
37
38public:
39  DbiModuleSourceFilesIterator(const DbiModuleList &Modules, uint32_t Modi,
40                               uint16_t Filei);
41  DbiModuleSourceFilesIterator() = default;
42  DbiModuleSourceFilesIterator(const DbiModuleSourceFilesIterator &R) = default;
43  DbiModuleSourceFilesIterator &
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
56private:
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
69class DbiModuleList {
70  friend DbiModuleSourceFilesIterator;
71
72public:
73  Error initialize(BinaryStreamRef ModInfo, BinaryStreamRef FileInfo);
74
75  Expected<StringRef> getFileName(uint32_t Index) const;
76  uint32_t getModuleCount() const;
77  uint32_t getSourceFileCount() const;
78  uint16_t getSourceFileCount(uint32_t Modi) const;
79
80  iterator_range<DbiModuleSourceFilesIterator>
81  source_files(uint32_t Modi) const;
82
83  DbiModuleDescriptor getModuleDescriptor(uint32_t Modi) const;
84
85private:
86  Error initializeModInfo(BinaryStreamRef ModInfo);
87  Error initializeFileInfo(BinaryStreamRef FileInfo);
88
89  VarStreamArray<DbiModuleDescriptor> Descriptors;
90
91  FixedStreamArray<support::little32_t> FileNameOffsets;
92  FixedStreamArray<support::ulittle16_t> ModFileCountArray;
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
119