[FaultMaps] Move FaultMapParser to Object/

[sanjoy]

Summary

That way llvm-objdump can rely on it without adding an extra dependency
on CodeGen.

This change duplicates the FaultKind enum and the code that serializes
it to a string. I could not figure out a way to get around this without
adding a new dependency to Object

[ab]

Fixes it indeed, thanks!

The duplication does seems icky, but I don't know of a good place to share it. Rafael?

include/llvm/Object/FaultMapParser.h

168

Unnecessary whitespace?

[sanjoy]

I think I'll check this in -- I don't want to keep the shared-object build broken any longer.

If there is a better way to solve this, then we can come back and do that later.

include/llvm/CodeGen/FaultMaps.h

 //===------------------- FaultMaps.h - The "FaultMaps" section --*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_CODEGEN_FAULTMAPS_H
 #define LLVM_CODEGEN_FAULTMAPS_H
 
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/MC/MCSymbol.h"
-#include "llvm/Support/Endian.h"
-#include "llvm/Support/Format.h"
 
 #include <vector>
 #include <map>
 
 namespace llvm {
 
 class AsmPrinter;
 class MCExpr;
private:
 
   std::map<const MCSymbol *, FunctionFaultInfos, MCSymbolComparator>
       FunctionInfos;
   AsmPrinter &AP;
 
   void emitFunctionInfo(const MCSymbol *FnLabel, const FunctionFaultInfos &FFI);
 };
 
-/// A parser for the __llvm_faultmaps section generated by the FaultMaps class
-/// above.  This parser is version locked with with the __llvm_faultmaps section
-/// generated by the version of LLVM that includes it.  No guarantees are made
-/// with respect to forward or backward compatibility.
-class FaultMapParser {
-  typedef uint8_t FaultMapVersionType;
-  static const size_t FaultMapVersionOffset = 0;
-
-  typedef uint8_t Reserved0Type;
-  static const size_t Reserved0Offset =
-      FaultMapVersionOffset + sizeof(FaultMapVersionType);
-
-  typedef uint16_t Reserved1Type;
-  static const size_t Reserved1Offset = Reserved0Offset + sizeof(Reserved0Type);
-
-  typedef uint32_t NumFunctionsType;
-  static const size_t NumFunctionsOffset =
-      Reserved1Offset + sizeof(Reserved1Type);
-
-  static const size_t FunctionInfosOffset =
-      NumFunctionsOffset + sizeof(NumFunctionsType);
-
-  const uint8_t *P;
-  const uint8_t *E;
-
-  template <typename T> static T read(const uint8_t *P, const uint8_t *E) {
-    assert(P + sizeof(T) <= E && "out of bounds read!");
-    return support::endian::read<T, support::little, 1>(P);
-  }
-
-public:
-  class FunctionFaultInfoAccessor {
-    typedef uint32_t FaultKindType;
-    static const size_t FaultKindOffset = 0;
-
-    typedef uint32_t FaultingPCOffsetType;
-    static const size_t FaultingPCOffsetOffset =
-        FaultKindOffset + sizeof(FaultKindType);
-
-    typedef uint32_t HandlerPCOffsetType;
-    static const size_t HandlerPCOffsetOffset =
-        FaultingPCOffsetOffset + sizeof(FaultingPCOffsetType);
-
-    const uint8_t *P;
-    const uint8_t *E;
-
-  public:
-    static const size_t Size =
-        HandlerPCOffsetOffset + sizeof(HandlerPCOffsetType);
-
-    explicit FunctionFaultInfoAccessor(const uint8_t *P, const uint8_t *E)
-        : P(P), E(E) {}
-
-    FaultKindType getFaultKind() const {
-      return read<FaultKindType>(P + FaultKindOffset, E);
-    }
-
-    FaultingPCOffsetType getFaultingPCOffset() const {
-      return read<FaultingPCOffsetType>(P + FaultingPCOffsetOffset, E);
-    }
-
-    HandlerPCOffsetType getHandlerPCOffset() const {
-      return read<HandlerPCOffsetType>(P + HandlerPCOffsetOffset, E);
-    }
-  };
-
-  class FunctionInfoAccessor {
-    typedef uint64_t FunctionAddrType;
-    static const size_t FunctionAddrOffset = 0;
-
-    typedef uint32_t NumFaultingPCsType;
-    static const size_t NumFaultingPCsOffset =
-        FunctionAddrOffset + sizeof(FunctionAddrType);
-
-    typedef uint32_t ReservedType;
-    static const size_t ReservedOffset =
-        NumFaultingPCsOffset + sizeof(NumFaultingPCsType);
-
-    static const size_t FunctionFaultInfosOffset =
-        ReservedOffset + sizeof(ReservedType);
-
-    static const size_t FunctionInfoHeaderSize = FunctionFaultInfosOffset;
-
-    const uint8_t *P;
-    const uint8_t *E;
-
-  public:
-    FunctionInfoAccessor() : P(nullptr), E(nullptr) {}
-
-    explicit FunctionInfoAccessor(const uint8_t *P, const uint8_t *E)
-        : P(P), E(E) {}
-
-    FunctionAddrType getFunctionAddr() const {
-      return read<FunctionAddrType>(P + FunctionAddrOffset, E);
-    }
-
-    NumFaultingPCsType getNumFaultingPCs() const {
-      return read<NumFaultingPCsType>(P + NumFaultingPCsOffset, E);
-    }
-
-    FunctionFaultInfoAccessor getFunctionFaultInfoAt(uint32_t Index) const {
-      assert(Index < getNumFaultingPCs() && "index out of bounds!");
-      const uint8_t *Begin = P + FunctionFaultInfosOffset +
-                             FunctionFaultInfoAccessor::Size * Index;
-      return FunctionFaultInfoAccessor(Begin, E);
-    }
-
-    FunctionInfoAccessor getNextFunctionInfo() const {
-      size_t MySize = FunctionInfoHeaderSize +
-                      getNumFaultingPCs() * FunctionFaultInfoAccessor::Size;
-
-      const uint8_t *Begin = P + MySize;
-      assert(Begin < E && "out of bounds!");
-      return FunctionInfoAccessor(Begin, E);
-    }
-  };
-
-  explicit FaultMapParser(const uint8_t *Begin, const uint8_t *End)
-      : P(Begin), E(End) {}
-
-  FaultMapVersionType getFaultMapVersion() const {
-    auto Version = read<FaultMapVersionType>(P + FaultMapVersionOffset, E);
-    assert(Version == 1 && "only version 1 supported!");
-    return Version;
-  }
-
-  NumFunctionsType getNumFunctions() const {
-    return read<NumFunctionsType>(P + NumFunctionsOffset, E);
-  }
-
-  FunctionInfoAccessor getFirstFunctionInfo() const {
-    const uint8_t *Begin = P + FunctionInfosOffset;
-    return FunctionInfoAccessor(Begin, E);
-  }
-};
-
-raw_ostream &
-operator<<(raw_ostream &OS, const FaultMapParser::FunctionFaultInfoAccessor &);
-
-raw_ostream &operator<<(raw_ostream &OS,
-                        const FaultMapParser::FunctionInfoAccessor &);
-
-raw_ostream &operator<<(raw_ostream &OS, const FaultMapParser &);
-
 } // namespace llvm
 
 #endif

include/llvm/Object/FaultMapParser.h

-//===------------------- FaultMaps.h - The "FaultMaps" section --*- C++ -*-===//
+//===-- FaultMapParser.h - Parser for the  "FaultMaps" section --*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_CODEGEN_FAULTMAPS_H
-#define LLVM_CODEGEN_FAULTMAPS_H
-
-#include "llvm/ADT/DenseMap.h"
-#include "llvm/MC/MCSymbol.h"
 #include "llvm/Support/Endian.h"
-#include "llvm/Support/Format.h"
+#include "llvm/Support/raw_ostream.h"
 
-#include <vector>
-#include <map>
+#ifndef LLVM_OBJECT_FAULTMAPPARSER_H
+#define LLVM_OBJECT_FAULTMAPPARSER_H
 
 namespace llvm {
 
-class AsmPrinter;
-class MCExpr;
-class MCSymbol;
-class MCStreamer;
-
-class FaultMaps {
-public:
-  enum FaultKind { FaultingLoad = 1, FaultKindMax };
-
-  static const char *faultTypeToString(FaultKind);
-
-  explicit FaultMaps(AsmPrinter &AP);
-
-  void recordFaultingOp(FaultKind FaultTy, const MCSymbol *HandlerLabel);
-  void serializeToFaultMapSection();
-
-private:
-  static const char *WFMP;
-
-  struct FaultInfo {
-    FaultKind Kind;
-    const MCExpr *FaultingOffsetExpr;
-    const MCExpr *HandlerOffsetExpr;
-
-    FaultInfo()
-        : Kind(FaultKindMax), FaultingOffsetExpr(nullptr),
-          HandlerOffsetExpr(nullptr) {}
-
-    explicit FaultInfo(FaultMaps::FaultKind Kind, const MCExpr *FaultingOffset,
-                       const MCExpr *HandlerOffset)
-        : Kind(Kind), FaultingOffsetExpr(FaultingOffset),
-          HandlerOffsetExpr(HandlerOffset) {}
-  };
-
-  typedef std::vector<FaultInfo> FunctionFaultInfos;
-
-  // We'd like to keep a stable iteration order for FunctionInfos to help
-  // FileCheck based testing.
-  struct MCSymbolComparator {
-    bool operator()(const MCSymbol *LHS, const MCSymbol *RHS) const {
-      return LHS->getName() < RHS->getName();
-    }
-  };
-
-  std::map<const MCSymbol *, FunctionFaultInfos, MCSymbolComparator>
-      FunctionInfos;
-  AsmPrinter &AP;
-
-  void emitFunctionInfo(const MCSymbol *FnLabel, const FunctionFaultInfos &FFI);
-};
-
 /// A parser for the __llvm_faultmaps section generated by the FaultMaps class
-/// above.  This parser is version locked with with the __llvm_faultmaps section
-/// generated by the version of LLVM that includes it.  No guarantees are made
-/// with respect to forward or backward compatibility.
+/// declared in llvm/CodeGen/FaultMaps.h.  This parser is version locked with
+/// with the __llvm_faultmaps section generated by the version of LLVM that
+/// includes it.  No guarantees are made with respect to forward or backward
+/// compatibility.
 class FaultMapParser {
   typedef uint8_t FaultMapVersionType;
   static const size_t FaultMapVersionOffset = 0;
 
   typedef uint8_t Reserved0Type;
   static const size_t Reserved0Offset =
       FaultMapVersionOffset + sizeof(FaultMapVersionType);
 
class FaultMapParser {
   const uint8_t *E;
 
   template <typename T> static T read(const uint8_t *P, const uint8_t *E) {
     assert(P + sizeof(T) <= E && "out of bounds read!");
     return support::endian::read<T, support::little, 1>(P);
   }
 
 public:
+  enum FaultKind { FaultingLoad = 1, FaultKindMax };
+
   class FunctionFaultInfoAccessor {
     typedef uint32_t FaultKindType;
     static const size_t FaultKindOffset = 0;
 
     typedef uint32_t FaultingPCOffsetType;
     static const size_t FaultingPCOffsetOffset =
         FaultKindOffset + sizeof(FaultKindType);
 

 raw_ostream &operator<<(raw_ostream &OS,
                         const FaultMapParser::FunctionInfoAccessor &);
 
 raw_ostream &operator<<(raw_ostream &OS, const FaultMapParser &);
 
 } // namespace llvm
 
 #endif
+

lib/CodeGen/FaultMaps.cpp

const char *FaultMaps::faultTypeToString(FaultMaps::FaultKind FT) {
   switch (FT) {
   default:
     llvm_unreachable("unhandled fault type!");
 
   case FaultMaps::FaultingLoad:
     return "FaultingLoad";
   }
 }
-
-raw_ostream &llvm::
-operator<<(raw_ostream &OS,
-           const FaultMapParser::FunctionFaultInfoAccessor &FFI) {
-  OS << "Fault kind: "
-     << FaultMaps::faultTypeToString((FaultMaps::FaultKind)FFI.getFaultKind())
-     << ", faulting PC offset: " << FFI.getFaultingPCOffset()
-     << ", handling PC offset: " << FFI.getHandlerPCOffset();
-  return OS;
-}
-
-raw_ostream &llvm::
-operator<<(raw_ostream &OS, const FaultMapParser::FunctionInfoAccessor &FI) {
-  OS << "FunctionAddress: " << format_hex(FI.getFunctionAddr(), 8)
-     << ", NumFaultingPCs: " << FI.getNumFaultingPCs() << "\n";
-  for (unsigned i = 0, e = FI.getNumFaultingPCs(); i != e; ++i)
-    OS << FI.getFunctionFaultInfoAt(i) << "\n";
-  return OS;
-}
-
-raw_ostream &llvm::operator<<(raw_ostream &OS, const FaultMapParser &FMP) {
-  OS << "Version: " << format_hex(FMP.getFaultMapVersion(), 2) << "\n";
-  OS << "NumFunctions: " << FMP.getNumFunctions() << "\n";
-
-  if (FMP.getNumFunctions() == 0)
-    return OS;
-
-  FaultMapParser::FunctionInfoAccessor FI;
-
-  for (unsigned i = 0, e = FMP.getNumFunctions(); i != e; ++i) {
-    FI = (i == 0) ? FMP.getFirstFunctionInfo() : FI.getNextFunctionInfo();
-    OS << FI;
-  }
-
-  return OS;
-}

lib/Object/CMakeLists.txt

 add_llvm_library(LLVMObject
   Archive.cpp
   ArchiveWriter.cpp
   Binary.cpp
   COFFObjectFile.cpp
   COFFYAML.cpp
   ELF.cpp
   ELFObjectFile.cpp
   ELFYAML.cpp
   Error.cpp
+  FaultMapParser.cpp
   IRObjectFile.cpp
   MachOObjectFile.cpp
   MachOUniversal.cpp
   Object.cpp
   ObjectFile.cpp
   RecordStreamer.cpp
   SymbolicFile.cpp
 
   ADDITIONAL_HEADER_DIRS
   ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object
 
   DEPENDS
   intrinsics_gen
   )

lib/Object/FaultMapParser.cpp

+//===----------------------- FaultMapParser.cpp ---------------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Object/FaultMapParser.h"
+
+#include "llvm/Support/ErrorHandling.h"
+#include "llvm/Support/Format.h"
+
+using namespace llvm;
+
+const char *faultKindToString(FaultMapParser::FaultKind FT) {
+  switch (FT) {
+  default:
+    llvm_unreachable("unhandled fault type!");
+
+  case FaultMapParser::FaultingLoad:
+    return "FaultingLoad";
+  }
+}
+
+raw_ostream &llvm::
+operator<<(raw_ostream &OS,
+           const FaultMapParser::FunctionFaultInfoAccessor &FFI) {
+  OS << "Fault kind: "
+     << faultKindToString((FaultMapParser::FaultKind)FFI.getFaultKind())
+     << ", faulting PC offset: " << FFI.getFaultingPCOffset()
+     << ", handling PC offset: " << FFI.getHandlerPCOffset();
+  return OS;
+}
+
+raw_ostream &llvm::
+operator<<(raw_ostream &OS, const FaultMapParser::FunctionInfoAccessor &FI) {
+  OS << "FunctionAddress: " << format_hex(FI.getFunctionAddr(), 8)
+     << ", NumFaultingPCs: " << FI.getNumFaultingPCs() << "\n";
+  for (unsigned i = 0, e = FI.getNumFaultingPCs(); i != e; ++i)
+    OS << FI.getFunctionFaultInfoAt(i) << "\n";
+  return OS;
+}
+
+raw_ostream &llvm::operator<<(raw_ostream &OS, const FaultMapParser &FMP) {
+  OS << "Version: " << format_hex(FMP.getFaultMapVersion(), 2) << "\n";
+  OS << "NumFunctions: " << FMP.getNumFunctions() << "\n";
+
+  if (FMP.getNumFunctions() == 0)
+    return OS;
+
+  FaultMapParser::FunctionInfoAccessor FI;
+
+  for (unsigned i = 0, e = FMP.getNumFunctions(); i != e; ++i) {
+    FI = (i == 0) ? FMP.getFirstFunctionInfo() : FI.getNextFunctionInfo();
+    OS << FI;
+  }
+
+  return OS;
+}

tools/llvm-objdump/llvm-objdump.cpp

 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm-objdump.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/StringExtras.h"
 #include "llvm/ADT/Triple.h"
-#include "llvm/CodeGen/FaultMaps.h"
 #include "llvm/MC/MCAsmInfo.h"
 #include "llvm/MC/MCContext.h"
 #include "llvm/MC/MCDisassembler.h"
 #include "llvm/MC/MCInst.h"
 #include "llvm/MC/MCInstPrinter.h"
 #include "llvm/MC/MCInstrAnalysis.h"
 #include "llvm/MC/MCInstrInfo.h"
 #include "llvm/MC/MCObjectFileInfo.h"
 #include "llvm/MC/MCRegisterInfo.h"
 #include "llvm/MC/MCRelocationInfo.h"
 #include "llvm/MC/MCSubtargetInfo.h"
 #include "llvm/Object/Archive.h"
 #include "llvm/Object/ELFObjectFile.h"
+#include "llvm/Object/FaultMapParser.h"
 #include "llvm/Object/COFF.h"
 #include "llvm/Object/MachO.h"
 #include "llvm/Object/ObjectFile.h"
 #include "llvm/Support/Casting.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/Errc.h"
 #include "llvm/Support/FileSystem.h"