aboutsummaryrefslogtreecommitdiff
path: root/backend/lib/CodeGen/MachineCFIInfo.cpp
blob: db9f31912c9b556ef51eb1c86da83aa60784b69b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
// SPDX-License-Identifier: GPL-3.0-or-later

#include "rcc/CodeGen/MachineCFIInfo.h"

#include <cstddef>
#include <cstdint>
#include <limits>
#include <string>
#include <utility>

namespace rcc {
namespace {

[[nodiscard]] Expected<void> verifyVectorRegisters(const MachineCFIVectorRegistersRule &Rule,
                                                   ErrorCode Code) {
  if (Rule.VectorRegisters.empty()) {
    return makeUnexpected(Code, "CFI vector-register rule must contain at least one lane");
  }
  return {};
}

} // namespace

MachineCFIInstruction MachineCFIInstruction::sameValue(DwarfRegisterNumber Register) {
  return MachineCFIInstruction(MachineCFIOperation::SameValue, MachineCFIRegisterRule{Register});
}

MachineCFIInstruction MachineCFIInstruction::rememberState() {
  return MachineCFIInstruction(MachineCFIOperation::RememberState, MachineCFINoOperands{});
}

MachineCFIInstruction MachineCFIInstruction::restoreState() {
  return MachineCFIInstruction(MachineCFIOperation::RestoreState, MachineCFINoOperands{});
}

MachineCFIInstruction MachineCFIInstruction::offset(DwarfRegisterNumber Register,
                                                    std::int64_t Offset) {
  return MachineCFIInstruction(MachineCFIOperation::Offset,
                               MachineCFIRegisterOffsetRule{Register, Offset});
}

MachineCFIInstruction MachineCFIInstruction::llvmDefAddressSpaceCFA(DwarfRegisterNumber Register,
                                                                    std::int64_t Offset,
                                                                    std::uint32_t AddressSpace) {
  return MachineCFIInstruction(MachineCFIOperation::LLVMDefAddressSpaceCFA,
                               MachineCFIAddressSpaceCFARule{Register, Offset, AddressSpace});
}

MachineCFIInstruction MachineCFIInstruction::defCFARegister(DwarfRegisterNumber Register) {
  return MachineCFIInstruction(MachineCFIOperation::DefCFARegister,
                               MachineCFIRegisterRule{Register});
}

MachineCFIInstruction MachineCFIInstruction::defCFAOffset(std::int64_t Offset) {
  return MachineCFIInstruction(MachineCFIOperation::DefCFAOffset, MachineCFIOffsetRule{Offset});
}

MachineCFIInstruction MachineCFIInstruction::defCFA(DwarfRegisterNumber Register,
                                                    std::int64_t Offset) {
  return MachineCFIInstruction(MachineCFIOperation::DefCFA,
                               MachineCFIRegisterOffsetRule{Register, Offset});
}

MachineCFIInstruction MachineCFIInstruction::relativeOffset(DwarfRegisterNumber Register,
                                                            std::int64_t Offset) {
  return MachineCFIInstruction(MachineCFIOperation::RelativeOffset,
                               MachineCFIRegisterOffsetRule{Register, Offset});
}

MachineCFIInstruction MachineCFIInstruction::adjustCFAOffset(std::int64_t Offset) {
  return MachineCFIInstruction(MachineCFIOperation::AdjustCFAOffset, MachineCFIOffsetRule{Offset});
}

Expected<MachineCFIInstruction> MachineCFIInstruction::escape(std::vector<std::uint8_t> Bytes) {
  if (Bytes.empty())
    return makeUnexpected(ErrorCode::InvalidArgument, "CFI escape byte sequence cannot be empty");
  return MachineCFIInstruction(MachineCFIOperation::Escape, MachineCFIEscapeRule{std::move(Bytes)});
}

MachineCFIInstruction MachineCFIInstruction::restore(DwarfRegisterNumber Register) {
  return MachineCFIInstruction(MachineCFIOperation::Restore, MachineCFIRegisterRule{Register});
}

MachineCFIInstruction MachineCFIInstruction::undefined(DwarfRegisterNumber Register) {
  return MachineCFIInstruction(MachineCFIOperation::Undefined, MachineCFIRegisterRule{Register});
}

MachineCFIInstruction MachineCFIInstruction::registerRule(DwarfRegisterNumber Register,
                                                          DwarfRegisterNumber SourceRegister) {
  return MachineCFIInstruction(MachineCFIOperation::Register,
                               MachineCFIRegisterRegisterRule{Register, SourceRegister});
}

MachineCFIInstruction MachineCFIInstruction::windowSave() {
  return MachineCFIInstruction(MachineCFIOperation::WindowSave, MachineCFINoOperands{});
}

MachineCFIInstruction MachineCFIInstruction::negateReturnAddressState() {
  return MachineCFIInstruction(MachineCFIOperation::NegateReturnAddressState,
                               MachineCFINoOperands{});
}

MachineCFIInstruction MachineCFIInstruction::negateReturnAddressStateWithPC() {
  return MachineCFIInstruction(MachineCFIOperation::NegateReturnAddressStateWithPC,
                               MachineCFINoOperands{});
}

MachineCFIInstruction MachineCFIInstruction::gnuArgsSize(std::int64_t Size) {
  return MachineCFIInstruction(MachineCFIOperation::GNUArgsSize, MachineCFIOffsetRule{Size});
}

Expected<MachineCFIInstruction> MachineCFIInstruction::label(std::string Symbol) {
  if (Symbol.empty())
    return makeUnexpected(ErrorCode::InvalidArgument, "CFI label symbol cannot be empty");
  return MachineCFIInstruction(MachineCFIOperation::Label, MachineCFILabelRule{std::move(Symbol)});
}

MachineCFIInstruction MachineCFIInstruction::valueOffset(DwarfRegisterNumber Register,
                                                         std::int64_t Offset) {
  return MachineCFIInstruction(MachineCFIOperation::ValueOffset,
                               MachineCFIRegisterOffsetRule{Register, Offset});
}

MachineCFIInstruction MachineCFIInstruction::llvmRegisterPair(MachineCFIRegisterPairRule Rule) {
  return MachineCFIInstruction(MachineCFIOperation::LLVMRegisterPair, Rule);
}

Expected<MachineCFIInstruction>
MachineCFIInstruction::llvmVectorRegisters(MachineCFIVectorRegistersRule Rule) {
  auto Verification = verifyVectorRegisters(Rule, ErrorCode::InvalidArgument);
  if (!Verification)
    return std::unexpected(Verification.error());
  return MachineCFIInstruction(MachineCFIOperation::LLVMVectorRegisters, std::move(Rule));
}

MachineCFIInstruction MachineCFIInstruction::llvmVectorOffset(MachineCFIVectorOffsetRule Rule) {
  return MachineCFIInstruction(MachineCFIOperation::LLVMVectorOffset, Rule);
}

MachineCFIInstruction
MachineCFIInstruction::llvmVectorRegisterMask(MachineCFIVectorRegisterMaskRule Rule) {
  return MachineCFIInstruction(MachineCFIOperation::LLVMVectorRegisterMask, Rule);
}

Expected<void> MachineCFIInstruction::verify() const {
  switch (Operation) {
  case MachineCFIOperation::SameValue:
  case MachineCFIOperation::DefCFARegister:
  case MachineCFIOperation::Restore:
  case MachineCFIOperation::Undefined:
    if (getIf<MachineCFIRegisterRule>() == nullptr)
      break;
    return {};
  case MachineCFIOperation::RememberState:
  case MachineCFIOperation::RestoreState:
  case MachineCFIOperation::WindowSave:
  case MachineCFIOperation::NegateReturnAddressState:
  case MachineCFIOperation::NegateReturnAddressStateWithPC:
    if (getIf<MachineCFINoOperands>() == nullptr)
      break;
    return {};
  case MachineCFIOperation::Offset:
  case MachineCFIOperation::DefCFA:
  case MachineCFIOperation::RelativeOffset:
  case MachineCFIOperation::ValueOffset:
    if (getIf<MachineCFIRegisterOffsetRule>() == nullptr)
      break;
    return {};
  case MachineCFIOperation::LLVMDefAddressSpaceCFA:
    if (getIf<MachineCFIAddressSpaceCFARule>() == nullptr)
      break;
    return {};
  case MachineCFIOperation::DefCFAOffset:
  case MachineCFIOperation::AdjustCFAOffset:
  case MachineCFIOperation::GNUArgsSize:
    if (getIf<MachineCFIOffsetRule>() == nullptr)
      break;
    return {};
  case MachineCFIOperation::Escape: {
    const auto *Rule = getIf<MachineCFIEscapeRule>();
    if (Rule == nullptr)
      break;
    if (Rule->Bytes.empty()) {
      return makeUnexpected(ErrorCode::VerificationError,
                            "CFI escape byte sequence cannot be empty");
    }
    return {};
  }
  case MachineCFIOperation::Register:
    if (getIf<MachineCFIRegisterRegisterRule>() == nullptr)
      break;
    return {};
  case MachineCFIOperation::Label: {
    const auto *Rule = getIf<MachineCFILabelRule>();
    if (Rule == nullptr)
      break;
    if (Rule->Symbol.empty())
      return makeUnexpected(ErrorCode::VerificationError, "CFI label symbol cannot be empty");
    return {};
  }
  case MachineCFIOperation::LLVMRegisterPair: {
    const auto *Rule = getIf<MachineCFIRegisterPairRule>();
    if (Rule == nullptr)
      break;
    return {};
  }
  case MachineCFIOperation::LLVMVectorRegisters: {
    const auto *Rule = getIf<MachineCFIVectorRegistersRule>();
    if (Rule == nullptr)
      break;
    return verifyVectorRegisters(*Rule, ErrorCode::VerificationError);
  }
  case MachineCFIOperation::LLVMVectorOffset: {
    const auto *Rule = getIf<MachineCFIVectorOffsetRule>();
    if (Rule == nullptr)
      break;
    return {};
  }
  case MachineCFIOperation::LLVMVectorRegisterMask: {
    const auto *Rule = getIf<MachineCFIVectorRegisterMaskRule>();
    if (Rule == nullptr)
      break;
    return {};
  }
  case MachineCFIOperation::Count:
    break;
  }
  return makeUnexpected(ErrorCode::VerificationError,
                        "CFI instruction operation and payload do not match");
}

Expected<CFIInstructionIndex> MachineCFIInfo::addInstruction(MachineCFIInstruction Instruction) {
  auto Verification = Instruction.verify();
  if (!Verification)
    return std::unexpected(Verification.error());
  if (Instructions.size() > std::numeric_limits<std::uint32_t>::max()) {
    return makeUnexpected(ErrorCode::Unsupported, "CFI instruction index space is exhausted");
  }

  const auto Index =
      CFIInstructionIndex::fromValue(static_cast<std::uint32_t>(Instructions.size()));
  Instructions.push_back(std::move(Instruction));
  return Index;
}

const MachineCFIInstruction *MachineCFIInfo::instruction(CFIInstructionIndex Index) const noexcept {
  if (Index.value() >= Instructions.size())
    return nullptr;
  return &Instructions[Index.value()];
}

Expected<void> MachineCFIInfo::verify() const {
  for (const MachineCFIInstruction &Instruction : Instructions) {
    auto Verification = Instruction.verify();
    if (!Verification)
      return std::unexpected(Verification.error());
  }
  return {};
}

Expected<MachineCFIInfo> MachineCFIInfo::clone() const {
  auto Verification = verify();
  if (!Verification)
    return std::unexpected(Verification.error());

  MachineCFIInfo Result;
  for (const MachineCFIInstruction &Instruction : Instructions) {
    auto Index = Result.addInstruction(Instruction);
    if (!Index)
      return std::unexpected(Index.error());
  }
  return Result;
}

} // namespace rcc