Files
gps/tools/local/circt/include/llvm/DebugInfo/PDB/Native/TpiStream.h
T
2026-07-12 11:01:51 +03:00

117 lines
3.6 KiB
C++

//===- TpiStream.cpp - PDB Type Info (TPI) Stream 2 Access ------*- 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
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_DEBUGINFO_PDB_NATIVE_TPISTREAM_H
#define LLVM_DEBUGINFO_PDB_NATIVE_TPISTREAM_H
#include "llvm/DebugInfo/CodeView/CVRecord.h"
#include "llvm/DebugInfo/PDB/Native/HashTable.h"
#include "llvm/DebugInfo/PDB/Native/RawConstants.h"
#include "llvm/Support/BinaryStreamArray.h"
#include "llvm/Support/BinaryStreamRef.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/Error.h"
namespace llvm {
class BinaryStream;
namespace codeview {
class TypeIndex;
struct TypeIndexOffset;
class LazyRandomTypeCollection;
}
namespace msf {
class MappedBlockStream;
}
namespace pdb {
struct TpiStreamHeader;
class PDBFile;
class TpiStream {
friend class TpiStreamBuilder;
public:
LLVM_ABI TpiStream(PDBFile &File,
std::unique_ptr<msf::MappedBlockStream> Stream);
LLVM_ABI ~TpiStream();
LLVM_ABI Error reload();
LLVM_ABI PdbRaw_TpiVer getTpiVersion() const;
LLVM_ABI uint32_t TypeIndexBegin() const;
LLVM_ABI uint32_t TypeIndexEnd() const;
LLVM_ABI uint32_t getNumTypeRecords() const;
LLVM_ABI uint16_t getTypeHashStreamIndex() const;
LLVM_ABI uint16_t getTypeHashStreamAuxIndex() const;
LLVM_ABI uint32_t getHashKeySize() const;
LLVM_ABI uint32_t getNumHashBuckets() const;
LLVM_ABI FixedStreamArray<support::ulittle32_t> getHashValues() const;
LLVM_ABI FixedStreamArray<codeview::TypeIndexOffset>
getTypeIndexOffsets() const;
LLVM_ABI HashTable<support::ulittle32_t> &getHashAdjusters();
LLVM_ABI codeview::CVTypeRange types(bool *HadError) const;
const codeview::CVTypeArray &typeArray() const { return TypeRecords; }
codeview::LazyRandomTypeCollection &typeCollection() { return *Types; }
LLVM_ABI Expected<codeview::TypeIndex>
findFullDeclForForwardRef(codeview::TypeIndex ForwardRefTI) const;
LLVM_ABI std::vector<codeview::TypeIndex>
findRecordsByName(StringRef Name) const;
/// Get a type by its index. \p Index must be a valid type index.
/// Otherwise, this method asserts in Debug mode.
LLVM_ABI codeview::CVType getType(codeview::TypeIndex Index);
/// The same as getType() except that the return value is defined
/// (empty/invalid) if \p Index doesn't exist. Use codeview::CVType::valid()
/// to check the return value.
LLVM_ABI codeview::CVType getTypeOrEmpty(codeview::TypeIndex Index);
/// Get the type at \p Index if it exists or \c std::nullopt otherwise.
LLVM_ABI std::optional<codeview::CVType>
tryGetType(codeview::TypeIndex Index);
/// Get the type at \p Index if it exists or an error about the failure.
LLVM_ABI Expected<codeview::CVType> getTypeOrError(codeview::TypeIndex Index);
LLVM_ABI BinarySubstreamRef getTypeRecordsSubstream() const;
LLVM_ABI Error commit();
LLVM_ABI void buildHashMap();
LLVM_ABI bool supportsTypeLookup() const;
private:
PDBFile &Pdb;
std::unique_ptr<msf::MappedBlockStream> Stream;
std::unique_ptr<codeview::LazyRandomTypeCollection> Types;
BinarySubstreamRef TypeRecordsSubstream;
codeview::CVTypeArray TypeRecords;
std::unique_ptr<BinaryStream> HashStream;
FixedStreamArray<support::ulittle32_t> HashValues;
FixedStreamArray<codeview::TypeIndexOffset> TypeIndexOffsets;
HashTable<support::ulittle32_t> HashAdjusters;
std::vector<std::vector<codeview::TypeIndex>> HashMap;
const TpiStreamHeader *Header;
};
}
}
#endif