Support skewed stream arrays.
authorZachary Turner <zturner@google.com>
Thu, 6 Dec 2018 16:55:00 +0000 (16:55 +0000)
committerZachary Turner <zturner@google.com>
Thu, 6 Dec 2018 16:55:00 +0000 (16:55 +0000)
commit579264bd5999931aea53b8e9bb7687f93a828247
tree6149f93ae63a3f1f76500f79e2437cc8abd5a730
parentbb650daeaf5d7dd9786ce90431c4c68afb09fabc
Support skewed stream arrays.

VarStreamArray was built on the assumption that it is backed by a
StreamRef, and offset 0 of that StreamRef is the first byte of the first
record in the array.

This is a logical and intuitive assumption, but unfortunately we have
use cases where it doesn't hold. Specifically, a PDB module's symbol
stream is prefixed by 4 bytes containing a magic value, and the first
byte of record data in the array is actually at offset 4 of this byte
sequence.

Previously, we would just truncate the first 4 bytes and then construct
the VarStreamArray with the resulting StreamRef, so that offset 0 of the
underlying stream did correspond to the first byte of the first record,
but this is problematic, because symbol records reference other symbol
records by the absolute offset including that initial magic 4 bytes. So
if another record wants to refer to the first record in the array, it
would say "the record at offset 4".

This led to extremely confusing hacks and semantics in loading code, and
after spending 30 minutes trying to get some math right and failing, I
decided to fix this in the underlying implementation of VarStreamArray.
Now, we can say that a stream is skewed by a particular amount. This
way, when we access a record by absolute offset, we can use the same
values that the records themselves contain, instead of having to do
fixups.

Differential Revision: https://reviews.llvm.org/D55344

llvm-svn: 348499
lldb/source/Plugins/SymbolFile/NativePDB/PdbIndex.cpp
llvm/include/llvm/Support/BinaryStreamArray.h
llvm/include/llvm/Support/BinaryStreamReader.h
llvm/lib/DebugInfo/CodeView/CVSymbolVisitor.cpp
llvm/lib/DebugInfo/PDB/Native/ModuleDebugStream.cpp
llvm/test/DebugInfo/PDB/module-bytes.test