LLVM 23.0.0git
Public Member Functions | List of all members
llvm::codeview::LazyRandomTypeCollection Class Reference

Provides amortized O(1) random access to a CodeView type stream. More...

#include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h"

Inheritance diagram for llvm::codeview::LazyRandomTypeCollection:
[legend]

Public Member Functions

 LazyRandomTypeCollection (uint32_t RecordCountHint)
 LazyRandomTypeCollection (StringRef Data, uint32_t RecordCountHint)
 LazyRandomTypeCollection (ArrayRef< uint8_t > Data, uint32_t RecordCountHint)
 LazyRandomTypeCollection (const CVTypeArray &Types, uint32_t RecordCountHint, PartialOffsetArray PartialOffsets)
 LazyRandomTypeCollection (const CVTypeArray &Types, uint32_t RecordCountHint)
void reset (ArrayRef< uint8_t > Data, uint32_t RecordCountHint)
void reset (StringRef Data, uint32_t RecordCountHint)
void reset (BinaryStreamReader &Reader, uint32_t RecordCountHint)
uint32_t getOffsetOfType (TypeIndex Index)
std::optional< CVType > tryGetType (TypeIndex Index)
llvm::Expected< CVType > getTypeOrError (TypeIndex Index)
CVType getType (TypeIndex Index) override
StringRef getTypeName (TypeIndex Index) override
bool contains (TypeIndex Index) override
uint32_t size () override
uint32_t capacity () override
std::optional< TypeIndex > getFirst () override
std::optional< TypeIndex > getNext (TypeIndex Prev) override
bool replaceType (TypeIndex &Index, CVType Data, bool Stabilize) override
Public Member Functions inherited from llvm::codeview::TypeCollection
virtual ~TypeCollection ()=default
bool empty ()
template<typename TFunc>
void ForEachRecord (TFunc Func)

Detailed Description

Provides amortized O(1) random access to a CodeView type stream.

Normally to access a type from a type stream, you must know its byte offset into the type stream, because type records are variable-lengthed. However, this is not the way we prefer to access them. For example, given a symbol record one of the fields may be the TypeIndex of the symbol's type record. Or given a type record such as an array type, there might be a TypeIndex for the element type. Sequential access is perfect when we're just dumping every entry, but it's very poor for real world usage.

Type streams in PDBs contain an additional field which is a list of pairs containing indices and their corresponding offsets, roughly every ~8KB of record data. This general idea need not be confined to PDBs though. By supplying such an array, the producer of a type stream can allow the consumer much better access time, because the consumer can find the nearest index in this array, and do a linear scan forward only from there.

LazyRandomTypeCollection implements this algorithm, but additionally goes one step further by caching offsets of every record that has been visited at least once. This way, even repeated visits of the same record will never require more than one linear scan. For a type stream of N elements divided into M chunks of roughly equal size, this yields a worst case lookup time of O(N/M) and an amortized time of O(1).

Definition at line 49 of file LazyRandomTypeCollection.h.

Constructor & Destructor Documentation

◆ LazyRandomTypeCollection() [1/5]

LazyRandomTypeCollection::LazyRandomTypeCollection ( uint32_t RecordCountHint)
explicit

Definition at line 31 of file LazyRandomTypeCollection.cpp.

References LazyRandomTypeCollection().

Referenced by LazyRandomTypeCollection(), LazyRandomTypeCollection(), LazyRandomTypeCollection(), and LazyRandomTypeCollection().

◆ LazyRandomTypeCollection() [2/5]

LazyRandomTypeCollection::LazyRandomTypeCollection ( StringRef Data,
uint32_t RecordCountHint )

Definition at line 47 of file LazyRandomTypeCollection.cpp.

References llvm::Data, and LazyRandomTypeCollection().

◆ LazyRandomTypeCollection() [3/5]

LazyRandomTypeCollection::LazyRandomTypeCollection ( ArrayRef< uint8_t > Data,
uint32_t RecordCountHint )

Definition at line 42 of file LazyRandomTypeCollection.cpp.

References llvm::Data, and LazyRandomTypeCollection().

◆ LazyRandomTypeCollection() [4/5]

LazyRandomTypeCollection::LazyRandomTypeCollection ( const CVTypeArray & Types,
uint32_t RecordCountHint,
PartialOffsetArray PartialOffsets )

Definition at line 35 of file LazyRandomTypeCollection.cpp.

◆ LazyRandomTypeCollection() [5/5]

LazyRandomTypeCollection::LazyRandomTypeCollection ( const CVTypeArray & Types,
uint32_t RecordCountHint )

Definition at line 52 of file LazyRandomTypeCollection.cpp.

References LazyRandomTypeCollection().

Member Function Documentation

◆ capacity()

uint32_t LazyRandomTypeCollection::capacity ( )
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 153 of file LazyRandomTypeCollection.cpp.

◆ contains()

bool LazyRandomTypeCollection::contains ( TypeIndex Index)
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 140 of file LazyRandomTypeCollection.cpp.

Referenced by getOffsetOfType(), getType(), and getTypeOrError().

◆ getFirst()

std::optional< TypeIndex > LazyRandomTypeCollection::getFirst ( )
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 209 of file LazyRandomTypeCollection.cpp.

References llvm::consumeError(), llvm::codeview::EC, and llvm::codeview::TypeIndex::fromArrayIndex().

◆ getNext()

std::optional< TypeIndex > LazyRandomTypeCollection::getNext ( TypeIndex Prev)
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 218 of file LazyRandomTypeCollection.cpp.

References llvm::consumeError(), and llvm::codeview::EC.

◆ getOffsetOfType()

uint32_t LazyRandomTypeCollection::getOffsetOfType ( TypeIndex Index)

Definition at line 79 of file LazyRandomTypeCollection.cpp.

References assert(), contains(), and error.

◆ getType()

CVType LazyRandomTypeCollection::getType ( TypeIndex Index)
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 86 of file LazyRandomTypeCollection.cpp.

References assert(), llvm::consumeError(), contains(), and llvm::codeview::EC.

Referenced by llvm::pdb::NativeInlineSiteSymbol::getName().

◆ getTypeName()

StringRef LazyRandomTypeCollection::getTypeName ( TypeIndex Index)
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 118 of file LazyRandomTypeCollection.cpp.

References llvm::codeview::computeTypeName(), llvm::consumeError(), llvm::codeview::EC, I, and llvm::codeview::TypeIndex::simpleTypeName().

Referenced by llvm::pdb::NativeInlineSiteSymbol::getName().

◆ getTypeOrError()

llvm::Expected< CVType > LazyRandomTypeCollection::getTypeOrError ( TypeIndex Index)

Definition at line 101 of file LazyRandomTypeCollection.cpp.

References contains(), llvm::createStringError(), and llvm::codeview::EC.

Referenced by tryGetType().

◆ replaceType()

bool LazyRandomTypeCollection::replaceType ( TypeIndex & Index,
CVType Data,
bool Stabilize )
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 286 of file LazyRandomTypeCollection.cpp.

References llvm::Data, and llvm_unreachable.

◆ reset() [1/3]

void LazyRandomTypeCollection::reset ( ArrayRef< uint8_t > Data,
uint32_t RecordCountHint )

Definition at line 73 of file LazyRandomTypeCollection.cpp.

References llvm::Data, llvm::little, and reset().

Referenced by reset(), and reset().

◆ reset() [2/3]

void LazyRandomTypeCollection::reset ( BinaryStreamReader & Reader,
uint32_t RecordCountHint )

Definition at line 56 of file LazyRandomTypeCollection.cpp.

References llvm::BinaryStreamReader::bytesRemaining(), error, and llvm::BinaryStreamReader::readArray().

◆ reset() [3/3]

void LazyRandomTypeCollection::reset ( StringRef Data,
uint32_t RecordCountHint )

Definition at line 68 of file LazyRandomTypeCollection.cpp.

References llvm::Data, llvm::little, and reset().

◆ size()

uint32_t LazyRandomTypeCollection::size ( )
overridevirtual

Implements llvm::codeview::TypeCollection.

Definition at line 151 of file LazyRandomTypeCollection.cpp.

◆ tryGetType()

std::optional< CVType > LazyRandomTypeCollection::tryGetType ( TypeIndex Index)

Definition at line 114 of file LazyRandomTypeCollection.cpp.

References llvm::expectedToOptional(), and getTypeOrError().

The documentation for this class was generated from the following files:
Generated on for LLVM by doxygen 1.14.0