include/llvm/XRay/FDRTraceWriter.h

   1 //===- FDRTraceWriter.h - XRay FDR Trace Writer -----------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Test a utility that can write out XRay FDR Mode formatted trace files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13 #ifndef LLVM_INCLUDE_LLVM_XRAY_FDRTRACEWRITER_H_
  14 #define LLVM_INCLUDE_LLVM_XRAY_FDRTRACEWRITER_H_
  15
  16 #include "llvm/Support/raw_ostream.h"
  17 #include "llvm/Support/EndianStream.h"
  18 #include "llvm/XRay/FDRRecords.h"
  19 #include "llvm/XRay/XRayRecord.h"
  20
  21 namespace llvm {
  22 namespace xray {
  23
  24 /// The FDRTraceWriter allows us to hand-craft an XRay Flight Data Recorder
  25 /// (FDR) mode log file. This is used primarily for testing, generating
  26 /// sequences of FDR records that can be read/processed. It can also be used to
  27 /// generate various kinds of execution traces without using the XRay runtime.
  28 /// Note that this writer does not do any validation, but uses the types of
  29 /// records defined in the FDRRecords.h file.
  30 class FDRTraceWriter : public RecordVisitor {
  31 public:
  32   // Construct an FDRTraceWriter associated with an output stream.
  33   explicit FDRTraceWriter(raw_ostream &O, const XRayFileHeader &H);
  34   ~FDRTraceWriter();
  35
  36   Error visit(BufferExtents &) override;
  37   Error visit(WallclockRecord &) override;
  38   Error visit(NewCPUIDRecord &) override;
  39   Error visit(TSCWrapRecord &) override;
  40   Error visit(CustomEventRecord &) override;
  41   Error visit(CallArgRecord &) override;
  42   Error visit(PIDRecord &) override;
  43   Error visit(NewBufferRecord &) override;
  44   Error visit(EndBufferRecord &) override;
  45   Error visit(FunctionRecord &) override;
  46
  47 private:
  48   support::endian::Writer OS;
  49 };
  50
  51 } // namespace xray
  52 } // namespace llvm
  53
  54 #endif // LLVM_INCLUDE_LLVM_XRAY_FDRTRACEWRITER_H_