[PATCH] D54201: [XRay] Improve FDR trace handling and error messaging

[Dean Michael Berris via Phabricator via llvm-commits]

dberris created this revision.
dberris added a reviewer: mboerger.
Herald added subscribers: jfb, hiraditya.

This change covers a number of things spanning LLVM and compiler-rt,
which are related in a non-trivial way.

In LLVM, we have a library that handles the FDR mode even log loading,
which uses C++'s runtime polymorphism feature to better faithfully
represent the events that are written down by the FDR mode runtime. We
do this by interpreting a trace that's serliased in a common format
agreed upon by both the trace loading library and the FDR mode runtime.
This library is under active development, which consists of features
allowing us to reconstitute a higher-level event log.

This event log is used by the conversion and visualisation tools we have
for interpreting XRay traces.

One of the tools we have is a diagnostic tool in llvm-xray called
`fdr-dump` which we've been using to debug our expectations of what the
FDR runtime should be writing and what the logical FDR event log
structures are. We use this fairly extensively to reason about why some
non-trivial traces we're generating with FDR mode runtimes fail to
convert or fail to parse correctly.

One of these failures we've found in manual debugging of some of the
traces we've seen involve an inconsistency between the buffer extents (a
record indicating how many bytes to follow are part of a logical
thread's event log) and the record of the bytes written into the log --
sometimes it turns out the data could be garbage, due to buffers being
recycled, but sometimes we're seeing the buffer extent indicating a log
is "shorter" than the actual records associated with the buffer. This
case happens particularly with function entry records with a call
argument.

This change for now updates the FDR mode runtime to write the bytes for
the function call and arg record before updating the buffer extents
atomically, allowing multiple threads to see a consistent view of the
data in the buffer using the atomic counter associated with a buffer.
What we're trying to prevent here is partial updates where we see the
intermediary updates to the buffer extents (function record size then
call argument record size) becoming observable from another thread, for
instance, one doing the serialization/flushing.

To do both diagnose this issue properly, we need to be able to honour
the extents being set in the `BufferExtents` records marking the
beginning of the logical buffers when reading an FDR trace. Since LLVM
doesn't use C++'s RTTI mechanism, we instead follow the advice in the
documentation for LLVM Style RTTI
(https://llvm.org/docs/HowToSetUpLLVMStyleRTTI.html). We then rely on
this RTTI feature to ensure that our file-based record producer (our
streaming "deserializer") can honour the extents of individual buffers
as we interpret traces.

This also sets us up to be able to eventually do smart
skipping/continuation of FDR logs, seeking instead to find BufferExtents
records in cases where we find potentially recoverable errors. In the
meantime, we make this change to operate in a strict mode when reading
logical buffers with extent records.


https://reviews.llvm.org/D54201

Files:
  compiler-rt/lib/xray/tests/unit/fdr_controller_test.cc
  compiler-rt/lib/xray/xray_fdr_controller.h
  compiler-rt/lib/xray/xray_fdr_log_writer.h
  llvm/include/llvm/XRay/FDRRecordProducer.h
  llvm/include/llvm/XRay/FDRRecords.h
  llvm/lib/XRay/FDRRecordProducer.cpp
  llvm/lib/XRay/FDRRecords.cpp
  llvm/lib/XRay/FDRTraceWriter.cpp
  llvm/lib/XRay/RecordInitializer.cpp
  llvm/unittests/XRay/FDRProducerConsumerTest.cpp

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D54201.172910.patch
Type: text/x-patch
Size: 34090 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20181107/00a39b3a/attachment-0001.bin>