1 //===- StackMaps.h - StackMaps ----------------------------------*- 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_STACKMAPS_H
11 #define LLVM_CODEGEN_STACKMAPS_H
13 #include "llvm/ADT/MapVector.h"
14 #include "llvm/ADT/SmallVector.h"
15 #include "llvm/CodeGen/MachineInstr.h"
16 #include "llvm/IR/CallingConv.h"
17 #include "llvm/Support/Debug.h"
30 class TargetRegisterInfo;
32 /// \brief MI-level stackmap operands.
34 /// MI stackmap operations take the form:
35 /// <id>, <numBytes>, live args...
38 /// Enumerate the meta operands.
39 enum { IDPos, NBytesPos };
42 const MachineInstr* MI;
45 explicit StackMapOpers(const MachineInstr *MI);
47 /// Return the ID for the given stackmap
48 uint64_t getID() const { return MI->getOperand(IDPos).getImm(); }
50 /// Return the number of patchable bytes the given stackmap should emit.
51 uint32_t getNumPatchBytes() const {
52 return MI->getOperand(NBytesPos).getImm();
55 /// Get the operand index of the variable list of non-argument operands.
56 /// These hold the "live state".
57 unsigned getVarIdx() const {
58 // Skip ID, nShadowBytes.
63 /// \brief MI-level patchpoint operands.
65 /// MI patchpoint operations take the form:
66 /// [<def>], <id>, <numBytes>, <target>, <numArgs>, <cc>, ...
68 /// IR patchpoint intrinsics do not have the <cc> operand because calling
69 /// convention is part of the subclass data.
71 /// SD patchpoint nodes do not have a def operand because it is part of the
74 /// Patchpoints following the anyregcc convention are handled specially. For
75 /// these, the stack map also records the location of the return value and
77 class PatchPointOpers {
79 /// Enumerate the meta operands.
80 enum { IDPos, NBytesPos, TargetPos, NArgPos, CCPos, MetaEnd };
83 const MachineInstr *MI;
86 unsigned getMetaIdx(unsigned Pos = 0) const {
87 assert(Pos < MetaEnd && "Meta operand index out of range.");
88 return (HasDef ? 1 : 0) + Pos;
91 const MachineOperand &getMetaOper(unsigned Pos) const {
92 return MI->getOperand(getMetaIdx(Pos));
96 explicit PatchPointOpers(const MachineInstr *MI);
98 bool isAnyReg() const { return (getCallingConv() == CallingConv::AnyReg); }
99 bool hasDef() const { return HasDef; }
101 /// Return the ID for the given patchpoint.
102 uint64_t getID() const { return getMetaOper(IDPos).getImm(); }
104 /// Return the number of patchable bytes the given patchpoint should emit.
105 uint32_t getNumPatchBytes() const {
106 return getMetaOper(NBytesPos).getImm();
109 /// Returns the target of the underlying call.
110 const MachineOperand &getCallTarget() const {
111 return getMetaOper(TargetPos);
114 /// Returns the calling convention
115 CallingConv::ID getCallingConv() const {
116 return getMetaOper(CCPos).getImm();
119 unsigned getArgIdx() const { return getMetaIdx() + MetaEnd; }
121 /// Return the number of call arguments
122 uint32_t getNumCallArgs() const {
123 return MI->getOperand(getMetaIdx(NArgPos)).getImm();
126 /// Get the operand index of the variable list of non-argument operands.
127 /// These hold the "live state".
128 unsigned getVarIdx() const {
129 return getMetaIdx() + MetaEnd + getNumCallArgs();
132 /// Get the index at which stack map locations will be recorded.
133 /// Arguments are not recorded unless the anyregcc convention is used.
134 unsigned getStackMapStartIdx() const {
140 /// \brief Get the next scratch register operand index.
141 unsigned getNextScratchIdx(unsigned StartIdx = 0) const;
144 /// MI-level Statepoint operands
146 /// Statepoint operands take the form:
147 /// <id>, <num patch bytes >, <num call arguments>, <call target>,
148 /// [call arguments], <StackMaps::ConstantOp>, <calling convention>,
149 /// <StackMaps::ConstantOp>, <statepoint flags>,
150 /// <StackMaps::ConstantOp>, <num other args>, [other args],
152 class StatepointOpers {
154 // These values are aboolute offsets into the operands of the statepoint
156 enum { IDPos, NBytesPos, NCallArgsPos, CallTargetPos, MetaEnd };
158 // These values are relative offests from the start of the statepoint meta
159 // arguments (i.e. the end of the call arguments).
160 enum { CCOffset = 1, FlagsOffset = 3, NumVMSArgsOffset = 5 };
163 explicit StatepointOpers(const MachineInstr *MI) : MI(MI) {}
165 /// Get starting index of non call related arguments
166 /// (calling convention, statepoint flags, vm state and gc state).
167 unsigned getVarIdx() const {
168 return MI->getOperand(NCallArgsPos).getImm() + MetaEnd;
171 /// Return the ID for the given statepoint.
172 uint64_t getID() const { return MI->getOperand(IDPos).getImm(); }
174 /// Return the number of patchable bytes the given statepoint should emit.
175 uint32_t getNumPatchBytes() const {
176 return MI->getOperand(NBytesPos).getImm();
179 /// Returns the target of the underlying call.
180 const MachineOperand &getCallTarget() const {
181 return MI->getOperand(CallTargetPos);
185 const MachineInstr *MI;
199 LocationType Type = Unprocessed;
204 Location() = default;
205 Location(LocationType Type, unsigned Size, unsigned Reg, int64_t Offset)
206 : Type(Type), Size(Size), Reg(Reg), Offset(Offset) {}
210 unsigned short Reg = 0;
211 unsigned short DwarfRegNum = 0;
212 unsigned short Size = 0;
214 LiveOutReg() = default;
215 LiveOutReg(unsigned short Reg, unsigned short DwarfRegNum,
217 : Reg(Reg), DwarfRegNum(DwarfRegNum), Size(Size) {}
220 // OpTypes are used to encode information about the following logical
221 // operand (which may consist of several MachineOperands) for the
223 typedef enum { DirectMemRefOp, IndirectMemRefOp, ConstantOp } OpType;
225 StackMaps(AsmPrinter &AP);
233 /// \brief Generate a stackmap record for a stackmap instruction.
235 /// MI must be a raw STACKMAP, not a PATCHPOINT.
236 void recordStackMap(const MachineInstr &MI);
238 /// \brief Generate a stackmap record for a patchpoint instruction.
239 void recordPatchPoint(const MachineInstr &MI);
241 /// \brief Generate a stackmap record for a statepoint instruction.
242 void recordStatepoint(const MachineInstr &MI);
244 /// If there is any stack map data, create a stack map section and serialize
245 /// the map info into it. This clears the stack map data structures
247 void serializeToStackMapSection();
250 static const char *WSMP;
251 typedef SmallVector<Location, 8> LocationVec;
252 typedef SmallVector<LiveOutReg, 8> LiveOutVec;
253 typedef MapVector<uint64_t, uint64_t> ConstantPool;
255 struct FunctionInfo {
256 uint64_t StackSize = 0;
257 uint64_t RecordCount = 1;
259 FunctionInfo() = default;
260 explicit FunctionInfo(uint64_t StackSize) : StackSize(StackSize) {}
263 struct CallsiteInfo {
264 const MCExpr *CSOffsetExpr = nullptr;
266 LocationVec Locations;
269 CallsiteInfo() = default;
270 CallsiteInfo(const MCExpr *CSOffsetExpr, uint64_t ID,
271 LocationVec &&Locations, LiveOutVec &&LiveOuts)
272 : CSOffsetExpr(CSOffsetExpr), ID(ID), Locations(std::move(Locations)),
273 LiveOuts(std::move(LiveOuts)) {}
276 typedef MapVector<const MCSymbol *, FunctionInfo> FnInfoMap;
277 typedef std::vector<CallsiteInfo> CallsiteInfoList;
280 CallsiteInfoList CSInfos;
281 ConstantPool ConstPool;
284 MachineInstr::const_mop_iterator
285 parseOperand(MachineInstr::const_mop_iterator MOI,
286 MachineInstr::const_mop_iterator MOE, LocationVec &Locs,
287 LiveOutVec &LiveOuts) const;
289 /// \brief Create a live-out register record for the given register @p Reg.
290 LiveOutReg createLiveOutReg(unsigned Reg,
291 const TargetRegisterInfo *TRI) const;
293 /// \brief Parse the register live-out mask and return a vector of live-out
294 /// registers that need to be recorded in the stackmap.
295 LiveOutVec parseRegisterLiveOutMask(const uint32_t *Mask) const;
297 /// This should be called by the MC lowering code _immediately_ before
298 /// lowering the MI to an MCInst. It records where the operands for the
299 /// instruction are stored, and outputs a label to record the offset of
300 /// the call from the start of the text section. In special cases (e.g. AnyReg
301 /// calling convention) the return register is also recorded if requested.
302 void recordStackMapOpers(const MachineInstr &MI, uint64_t ID,
303 MachineInstr::const_mop_iterator MOI,
304 MachineInstr::const_mop_iterator MOE,
305 bool recordResult = false);
307 /// \brief Emit the stackmap header.
308 void emitStackmapHeader(MCStreamer &OS);
310 /// \brief Emit the function frame record for each function.
311 void emitFunctionFrameRecords(MCStreamer &OS);
313 /// \brief Emit the constant pool.
314 void emitConstantPoolEntries(MCStreamer &OS);
316 /// \brief Emit the callsite info for each stackmap/patchpoint intrinsic call.
317 void emitCallsiteEntries(MCStreamer &OS);
319 void print(raw_ostream &OS);
320 void debug() { print(dbgs()); }
323 } // end namespace llvm
325 #endif // LLVM_CODEGEN_STACKMAPS_H