contrib/llvm/include/llvm/DebugInfo/CodeView/SymbolDeserializer.h

   1 //===- SymbolDeserializer.h -------------------------------------*- 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 #ifndef LLVM_DEBUGINFO_CODEVIEW_SYMBOLDESERIALIZER_H
  11 #define LLVM_DEBUGINFO_CODEVIEW_SYMBOLDESERIALIZER_H
  12
  13 #include "llvm/ADT/ArrayRef.h"
  14 #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
  15 #include "llvm/DebugInfo/CodeView/SymbolRecordMapping.h"
  16 #include "llvm/DebugInfo/CodeView/SymbolVisitorCallbacks.h"
  17 #include "llvm/DebugInfo/CodeView/SymbolVisitorDelegate.h"
  18 #include "llvm/Support/BinaryByteStream.h"
  19 #include "llvm/Support/BinaryStreamReader.h"
  20 #include "llvm/Support/Error.h"
  21
  22 namespace llvm {
  23 namespace codeview {
  24 class SymbolVisitorDelegate;
  25 class SymbolDeserializer : public SymbolVisitorCallbacks {
  26   struct MappingInfo {
  27     explicit MappingInfo(ArrayRef<uint8_t> RecordData)
  28         : Stream(RecordData, llvm::support::little), Reader(Stream),
  29           Mapping(Reader) {}
  30
  31     BinaryByteStream Stream;
  32     BinaryStreamReader Reader;
  33     SymbolRecordMapping Mapping;
  34   };
  35
  36 public:
  37   template <typename T> static Error deserializeAs(CVSymbol Symbol, T &Record) {
  38     SymbolDeserializer S(nullptr);
  39     if (auto EC = S.visitSymbolBegin(Symbol))
  40       return EC;
  41     if (auto EC = S.visitKnownRecord(Symbol, Record))
  42       return EC;
  43     if (auto EC = S.visitSymbolEnd(Symbol))
  44       return EC;
  45     return Error::success();
  46   }
  47
  48   explicit SymbolDeserializer(SymbolVisitorDelegate *Delegate)
  49       : Delegate(Delegate) {}
  50
  51   Error visitSymbolBegin(CVSymbol &Record) override {
  52     assert(!Mapping && "Already in a symbol mapping!");
  53     Mapping = llvm::make_unique<MappingInfo>(Record.content());
  54     return Mapping->Mapping.visitSymbolBegin(Record);
  55   }
  56   Error visitSymbolEnd(CVSymbol &Record) override {
  57     assert(Mapping && "Not in a symbol mapping!");
  58     auto EC = Mapping->Mapping.visitSymbolEnd(Record);
  59     Mapping.reset();
  60     return EC;
  61   }
  62
  63 #define SYMBOL_RECORD(EnumName, EnumVal, Name)                                 \
  64   Error visitKnownRecord(CVSymbol &CVR, Name &Record) override {               \
  65     return visitKnownRecordImpl(CVR, Record);                                  \
  66   }
  67 #define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, Name, AliasName)
  68 #include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
  69
  70 private:
  71   template <typename T> Error visitKnownRecordImpl(CVSymbol &CVR, T &Record) {
  72
  73     Record.RecordOffset =
  74         Delegate ? Delegate->getRecordOffset(Mapping->Reader) : 0;
  75     if (auto EC = Mapping->Mapping.visitKnownRecord(CVR, Record))
  76       return EC;
  77     return Error::success();
  78   }
  79
  80   SymbolVisitorDelegate *Delegate;
  81   std::unique_ptr<MappingInfo> Mapping;
  82 };
  83 }
  84 }
  85
  86 #endif