1 //===------------------- FaultMaps.h - The "FaultMaps" section --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_CODEGEN_FAULTMAPS_H
11 #define LLVM_CODEGEN_FAULTMAPS_H
13 #include "llvm/MC/MCSymbol.h"
14 #include "llvm/Support/Endian.h"
15 #include "llvm/Support/Format.h"
29 enum FaultKind { FaultingLoad = 1, FaultKindMax };
31 static const char *faultTypeToString(FaultKind);
33 explicit FaultMaps(AsmPrinter &AP);
35 void recordFaultingOp(FaultKind FaultTy, const MCSymbol *HandlerLabel);
36 void serializeToFaultMapSection();
39 static const char *WFMP;
43 const MCExpr *FaultingOffsetExpr;
44 const MCExpr *HandlerOffsetExpr;
47 : Kind(FaultKindMax), FaultingOffsetExpr(nullptr),
48 HandlerOffsetExpr(nullptr) {}
50 explicit FaultInfo(FaultMaps::FaultKind Kind, const MCExpr *FaultingOffset,
51 const MCExpr *HandlerOffset)
52 : Kind(Kind), FaultingOffsetExpr(FaultingOffset),
53 HandlerOffsetExpr(HandlerOffset) {}
56 typedef std::vector<FaultInfo> FunctionFaultInfos;
58 // We'd like to keep a stable iteration order for FunctionInfos to help
59 // FileCheck based testing.
60 struct MCSymbolComparator {
61 bool operator()(const MCSymbol *LHS, const MCSymbol *RHS) const {
62 return LHS->getName() < RHS->getName();
66 std::map<const MCSymbol *, FunctionFaultInfos, MCSymbolComparator>
70 void emitFunctionInfo(const MCSymbol *FnLabel, const FunctionFaultInfos &FFI);
73 /// A parser for the __llvm_faultmaps section generated by the FaultMaps class
74 /// above. This parser is version locked with with the __llvm_faultmaps section
75 /// generated by the version of LLVM that includes it. No guarantees are made
76 /// with respect to forward or backward compatibility.
77 class FaultMapParser {
78 typedef uint8_t FaultMapVersionType;
79 static const size_t FaultMapVersionOffset = 0;
81 typedef uint8_t Reserved0Type;
82 static const size_t Reserved0Offset =
83 FaultMapVersionOffset + sizeof(FaultMapVersionType);
85 typedef uint16_t Reserved1Type;
86 static const size_t Reserved1Offset = Reserved0Offset + sizeof(Reserved0Type);
88 typedef uint32_t NumFunctionsType;
89 static const size_t NumFunctionsOffset =
90 Reserved1Offset + sizeof(Reserved1Type);
92 static const size_t FunctionInfosOffset =
93 NumFunctionsOffset + sizeof(NumFunctionsType);
98 template <typename T> static T read(const uint8_t *P, const uint8_t *E) {
99 assert(P + sizeof(T) <= E && "out of bounds read!");
100 return support::endian::read<T, support::little, 1>(P);
104 class FunctionFaultInfoAccessor {
105 typedef uint32_t FaultKindType;
106 static const size_t FaultKindOffset = 0;
108 typedef uint32_t FaultingPCOffsetType;
109 static const size_t FaultingPCOffsetOffset =
110 FaultKindOffset + sizeof(FaultKindType);
112 typedef uint32_t HandlerPCOffsetType;
113 static const size_t HandlerPCOffsetOffset =
114 FaultingPCOffsetOffset + sizeof(FaultingPCOffsetType);
120 static const size_t Size =
121 HandlerPCOffsetOffset + sizeof(HandlerPCOffsetType);
123 explicit FunctionFaultInfoAccessor(const uint8_t *P, const uint8_t *E)
126 FaultKindType getFaultKind() const {
127 return read<FaultKindType>(P + FaultKindOffset, E);
130 FaultingPCOffsetType getFaultingPCOffset() const {
131 return read<FaultingPCOffsetType>(P + FaultingPCOffsetOffset, E);
134 HandlerPCOffsetType getHandlerPCOffset() const {
135 return read<HandlerPCOffsetType>(P + HandlerPCOffsetOffset, E);
139 class FunctionInfoAccessor {
140 typedef uint64_t FunctionAddrType;
141 static const size_t FunctionAddrOffset = 0;
143 typedef uint32_t NumFaultingPCsType;
144 static const size_t NumFaultingPCsOffset =
145 FunctionAddrOffset + sizeof(FunctionAddrType);
147 typedef uint32_t ReservedType;
148 static const size_t ReservedOffset =
149 NumFaultingPCsOffset + sizeof(NumFaultingPCsType);
151 static const size_t FunctionFaultInfosOffset =
152 ReservedOffset + sizeof(ReservedType);
154 static const size_t FunctionInfoHeaderSize = FunctionFaultInfosOffset;
160 FunctionInfoAccessor() : P(nullptr), E(nullptr) {}
162 explicit FunctionInfoAccessor(const uint8_t *P, const uint8_t *E)
165 FunctionAddrType getFunctionAddr() const {
166 return read<FunctionAddrType>(P + FunctionAddrOffset, E);
169 NumFaultingPCsType getNumFaultingPCs() const {
170 return read<NumFaultingPCsType>(P + NumFaultingPCsOffset, E);
173 FunctionFaultInfoAccessor getFunctionFaultInfoAt(uint32_t Index) const {
174 assert(Index < getNumFaultingPCs() && "index out of bounds!");
175 const uint8_t *Begin = P + FunctionFaultInfosOffset +
176 FunctionFaultInfoAccessor::Size * Index;
177 return FunctionFaultInfoAccessor(Begin, E);
180 FunctionInfoAccessor getNextFunctionInfo() const {
181 size_t MySize = FunctionInfoHeaderSize +
182 getNumFaultingPCs() * FunctionFaultInfoAccessor::Size;
184 const uint8_t *Begin = P + MySize;
185 assert(Begin < E && "out of bounds!");
186 return FunctionInfoAccessor(Begin, E);
190 explicit FaultMapParser(const uint8_t *Begin, const uint8_t *End)
191 : P(Begin), E(End) {}
193 FaultMapVersionType getFaultMapVersion() const {
194 auto Version = read<FaultMapVersionType>(P + FaultMapVersionOffset, E);
195 assert(Version == 1 && "only version 1 supported!");
199 NumFunctionsType getNumFunctions() const {
200 return read<NumFunctionsType>(P + NumFunctionsOffset, E);
203 FunctionInfoAccessor getFirstFunctionInfo() const {
204 const uint8_t *Begin = P + FunctionInfosOffset;
205 return FunctionInfoAccessor(Begin, E);
210 operator<<(raw_ostream &OS, const FaultMapParser::FunctionFaultInfoAccessor &);
212 raw_ostream &operator<<(raw_ostream &OS,
213 const FaultMapParser::FunctionInfoAccessor &);
215 raw_ostream &operator<<(raw_ostream &OS, const FaultMapParser &);