LLVM 24.0.0git
Verifier.cpp
Go to the documentation of this file.
1//===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the function verifier interface, that can be used for some
10// basic correctness checking of input to the system.
11//
12// Note that this does not provide full `Java style' security and verifications,
13// instead it just tries to ensure that code is well-formed.
14//
15// * Both of a binary operator's parameters are of the same type
16// * Verify that the indices of mem access instructions match other operands
17// * Verify that arithmetic and other things are only performed on first-class
18// types. Verify that shifts & logicals only happen on integrals f.e.
19// * All of the constants in a switch statement are of the correct type
20// * The code is in valid SSA form
21// * It should be illegal to put a label into any other type (like a structure)
22// or to return one. [except constant arrays!]
23// * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
24// * PHI nodes must have an entry for each predecessor, with no extras.
25// * PHI nodes must be the first thing in a basic block, all grouped together
26// * All basic blocks should only end with terminator insts, not contain them
27// * The entry node to a function must not have predecessors
28// * All Instructions must be embedded into a basic block
29// * Functions cannot take a void-typed parameter
30// * Verify that a function's argument list agrees with it's declared type.
31// * It is illegal to specify a name for a void value.
32// * It is illegal to have a internal global value with no initializer
33// * It is illegal to have a ret instruction that returns a value that does not
34// agree with the function return value type.
35// * Function call argument types match the function prototype
36// * A landing pad is defined by a landingpad instruction, and can be jumped to
37// only by the unwind edge of an invoke instruction.
38// * A landingpad instruction must be the first non-PHI instruction in the
39// block.
40// * Landingpad instructions must be in a function with a personality function.
41// * Convergence control intrinsics are introduced in ConvergentOperations.rst.
42// The applied restrictions are too numerous to list here.
43// * The convergence entry intrinsic and the loop heart must be the first
44// non-PHI instruction in their respective block. This does not conflict with
45// the landing pads, since these two kinds cannot occur in the same block.
46// * All other things that are tested by asserts spread about the code...
47//
48//===----------------------------------------------------------------------===//
49
50#include "llvm/IR/Verifier.h"
51#include "IROptions.h"
52#include "VerifierInternal.h"
53#include "llvm/ADT/APFloat.h"
54#include "llvm/ADT/APInt.h"
55#include "llvm/ADT/ArrayRef.h"
56#include "llvm/ADT/DenseMap.h"
57#include "llvm/ADT/MapVector.h"
58#include "llvm/ADT/STLExtras.h"
62#include "llvm/ADT/StringRef.h"
63#include "llvm/ADT/Twine.h"
65#include "llvm/IR/Argument.h"
67#include "llvm/IR/Attributes.h"
68#include "llvm/IR/AutoUpgrade.h"
69#include "llvm/IR/BasicBlock.h"
71#include "llvm/IR/CFG.h"
72#include "llvm/IR/CallingConv.h"
73#include "llvm/IR/Comdat.h"
74#include "llvm/IR/Constant.h"
77#include "llvm/IR/Constants.h"
79#include "llvm/IR/DataLayout.h"
80#include "llvm/IR/DebugInfo.h"
82#include "llvm/IR/DebugLoc.h"
84#include "llvm/IR/Dominators.h"
86#include "llvm/IR/FPEnv.h"
87#include "llvm/IR/Function.h"
88#include "llvm/IR/GCStrategy.h"
90#include "llvm/IR/GlobalAlias.h"
91#include "llvm/IR/GlobalValue.h"
93#include "llvm/IR/InlineAsm.h"
94#include "llvm/IR/InstVisitor.h"
95#include "llvm/IR/InstrTypes.h"
96#include "llvm/IR/Instruction.h"
99#include "llvm/IR/Intrinsics.h"
100#include "llvm/IR/IntrinsicsAArch64.h"
101#include "llvm/IR/IntrinsicsARM.h"
102#include "llvm/IR/IntrinsicsBPF.h"
103#include "llvm/IR/IntrinsicsNVPTX.h"
104#include "llvm/IR/IntrinsicsRISCV.h"
105#include "llvm/IR/IntrinsicsWebAssembly.h"
106#include "llvm/IR/LLVMContext.h"
108#include "llvm/IR/Metadata.h"
109#include "llvm/IR/Module.h"
111#include "llvm/IR/PassManager.h"
113#include "llvm/IR/Statepoint.h"
114#include "llvm/IR/Type.h"
115#include "llvm/IR/Use.h"
116#include "llvm/IR/User.h"
118#include "llvm/IR/Value.h"
120#include "llvm/Pass.h"
123#include "llvm/Support/Casting.h"
124#include "llvm/Support/CodeGen.h"
128#include "llvm/Support/ModRef.h"
135#include <algorithm>
136#include <cassert>
137#include <cstdint>
138#include <limits>
139#include <memory>
140#include <optional>
141#include <queue>
142#include <string>
143#include <utility>
144
145using namespace llvm;
146
147namespace {
148
149class Verifier : public InstVisitor<Verifier>, VerifierSupport {
150 friend class InstVisitor<Verifier>;
151 DominatorTree DT;
152
153 /// When verifying a basic block, keep track of all of the
154 /// instructions we have seen so far.
155 ///
156 /// This allows us to do efficient dominance checks for the case when an
157 /// instruction has an operand that is an instruction in the same block.
158 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
159
160 /// Keep track of the metadata nodes that have been checked already.
161 SmallPtrSet<const Metadata *, 32> MDNodes;
162
163 /// Keep track which DISubprogram is attached to which function.
164 DenseMap<const DISubprogram *, const Function *> DISubprogramAttachments;
165
166 /// For each visited DIScope, whether walking its scope chain reaches a
167 /// repeated node.
168 DenseMap<const Metadata *, bool> DIScopeChainReachesCycle;
169
170 /// Track all DICompileUnits visited.
171 SmallPtrSet<const Metadata *, 2> CUVisited;
172
173 /// The result type for a landingpad.
174 Type *LandingPadResultTy;
175
176 /// Whether we've seen a call to @llvm.localescape in this function
177 /// already.
178 bool SawFrameEscape;
179
180 /// Whether the current function has a DISubprogram attached to it.
181 bool HasDebugInfo = false;
182
183 /// Stores the count of how many objects were passed to llvm.localescape for a
184 /// given function and the largest index passed to llvm.localrecover.
185 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
186
187 // Maps catchswitches and cleanuppads that unwind to siblings to the
188 // terminators that indicate the unwind, used to detect cycles therein.
189 MapVector<Instruction *, Instruction *> SiblingFuncletInfo;
190
191 /// Cache which blocks are in which funclet, if an EH funclet personality is
192 /// in use. Otherwise empty.
193 DenseMap<BasicBlock *, ColorVector> BlockEHFuncletColors;
194
195 /// Cache of constants visited in search of ConstantExprs.
196 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
197
198 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
199 SmallVector<const Function *, 4> DeoptimizeDeclarations;
200
201 /// Cache of attribute lists verified.
202 SmallPtrSet<const void *, 32> AttributeListsVisited;
203
204 // Verify that this GlobalValue is only used in this module.
205 // This map is used to avoid visiting uses twice. We can arrive at a user
206 // twice, if they have multiple operands. In particular for very large
207 // constant expressions, we can arrive at a particular user many times.
208 SmallPtrSet<const Value *, 32> GlobalValueVisited;
209
210 // Keeps track of duplicate function argument debug info.
212
213 TBAAVerifier TBAAVerifyHelper;
214 ConvergenceVerifier ConvergenceVerifyHelper;
215
216 SmallVector<IntrinsicInst *, 4> NoAliasScopeDecls;
217
218 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
219
220public:
221 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
222 const Module &M)
223 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
224 SawFrameEscape(false), TBAAVerifyHelper(this) {
225 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
226 }
227
228 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
229
230 bool verify(const Function &F) {
231 llvm::TimeTraceScope timeScope("Verifier");
232 assert(F.getParent() == &M &&
233 "An instance of this class only works with a specific module!");
234
235 // First ensure the function is well-enough formed to compute dominance
236 // information, and directly compute a dominance tree. We don't rely on the
237 // pass manager to provide this as it isolates us from a potentially
238 // out-of-date dominator tree and makes it significantly more complex to run
239 // this code outside of a pass manager.
240
241 // First check that every basic block has a terminator, otherwise we can't
242 // even inspect the CFG.
243 for (const BasicBlock &BB : F) {
244 if (!BB.empty() && BB.back().isTerminator())
245 continue;
246
247 if (OS) {
248 *OS << "Basic Block in function '" << F.getName()
249 << "' does not have terminator!\n";
250 BB.printAsOperand(*OS, true, MST);
251 *OS << "\n";
252 }
253 return false;
254 }
255
256 // FIXME: It's really gross that we have to cast away constness here.
257 if (!F.empty())
258 DT.recalculate(const_cast<Function &>(F));
259
260 auto FailureCB = [this](const Twine &Message) {
261 this->CheckFailed(Message);
262 };
263 ConvergenceVerifyHelper.initialize(OS, FailureCB, F);
264
265 Broken = false;
266 // FIXME: We strip const here because the inst visitor strips const.
267 visit(const_cast<Function &>(F));
268 verifySiblingFuncletUnwinds();
269
270 if (ConvergenceVerifyHelper.sawTokens())
271 ConvergenceVerifyHelper.verify(DT);
272
273 InstsInThisBlock.clear();
274 DebugFnArgs.clear();
275 DIScopeChainReachesCycle.clear();
276 LandingPadResultTy = nullptr;
277 SawFrameEscape = false;
278 SiblingFuncletInfo.clear();
279 verifyNoAliasScopeDecl();
280 NoAliasScopeDecls.clear();
281
282 return !Broken;
283 }
284
285 /// Verify the module that this instance of \c Verifier was initialized with.
286 bool verify() {
287 Broken = false;
288
289 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
290 for (const Function &F : M)
291 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
292 DeoptimizeDeclarations.push_back(&F);
293
294 // Now that we've visited every function, verify that we never asked to
295 // recover a frame index that wasn't escaped.
296 verifyFrameRecoverIndices();
297 for (const GlobalVariable &GV : M.globals())
298 visitGlobalVariable(GV);
299
300 for (const GlobalAlias &GA : M.aliases())
301 visitGlobalAlias(GA);
302
303 for (const GlobalIFunc &GI : M.ifuncs())
304 visitGlobalIFunc(GI);
305
306 for (const NamedMDNode &NMD : M.named_metadata())
307 visitNamedMDNode(NMD);
308
309 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
310 visitComdat(SMEC.getValue());
311
312 visitModuleFlags();
313 visitModuleIdents();
314 visitModuleCommandLines();
315 visitModuleErrnoTBAA();
316 visitModuleRawSections();
317
318 verifyCompileUnits();
319
320 verifyDeoptimizeCallingConvs();
321 DISubprogramAttachments.clear();
322 DIScopeChainReachesCycle.clear();
323 return !Broken;
324 }
325
326private:
327 /// Whether a metadata node is allowed to be, or contain, a DILocation.
328 enum class AreDebugLocsAllowed { No, Yes };
329
330 /// Metadata that should be treated as a range, with slightly different
331 /// requirements.
332 enum class RangeLikeMetadataKind {
333 Range, // MD_range
334 AbsoluteSymbol, // MD_absolute_symbol
335 NoaliasAddrspace // MD_noalias_addrspace
336 };
337
338 // Verification methods...
339 void visitGlobalValue(const GlobalValue &GV);
340 void visitGlobalVariable(const GlobalVariable &GV);
341 void visitGlobalAlias(const GlobalAlias &GA);
342 void visitGlobalIFunc(const GlobalIFunc &GI);
343 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
344 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
345 const GlobalAlias &A, const Constant &C);
346 void visitNamedMDNode(const NamedMDNode &NMD);
347 void visitMDNode(const MDNode &MD, AreDebugLocsAllowed AllowLocs);
348 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
349 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
350 void visitDIArgList(const DIArgList &AL, Function *F);
351 void visitComdat(const Comdat &C);
352 void visitModuleIdents();
353 void visitModuleCommandLines();
354 void visitModuleErrnoTBAA();
355 void visitModuleRawSections();
356 void visitModuleFlags();
357 void visitModuleFlag(const MDNode *Op,
358 DenseMap<const MDString *, const MDNode *> &SeenIDs,
359 SmallVectorImpl<const MDNode *> &Requirements);
360 void visitModuleFlagCGProfileEntry(const MDOperand &MDO);
361 void visitFunction(const Function &F);
362 void visitBasicBlock(BasicBlock &BB);
363 void verifyRangeLikeMetadata(const Value &V, const MDNode *Range, Type *Ty,
364 RangeLikeMetadataKind Kind);
365 void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty);
366 void visitNoFPClassMetadata(Instruction &I, MDNode *Range, Type *Ty);
367 void visitNoaliasAddrspaceMetadata(Instruction &I, MDNode *Range, Type *Ty);
368 void visitDereferenceableMetadata(Instruction &I, MDNode *MD);
369 void visitNoFreeObjMetadata(Instruction &I, MDNode *MD);
370 void visitProfMetadata(Instruction &I, MDNode *MD);
371 void visitCallStackMetadata(MDNode *MD);
372 void visitMemProfMetadata(Instruction &I, MDNode *MD);
373 void visitCallsiteMetadata(Instruction &I, MDNode *MD);
374 void visitCalleeTypeMetadata(Instruction &I, MDNode *MD);
375 void visitDIAssignIDMetadata(Instruction &I, MDNode *MD);
376 void visitMMRAMetadata(Instruction &I, MDNode *MD);
377 void visitAnnotationMetadata(MDNode *Annotation);
378 void visitAliasScopeMetadata(const MDNode *MD);
379 void visitAliasScopeListMetadata(const MDNode *MD);
380 void visitAccessGroupMetadata(const MDNode *MD);
381 void visitCapturesMetadata(Instruction &I, const MDNode *Captures);
382 void visitAllocTokenMetadata(Instruction &I, MDNode *MD);
383 void visitInlineHistoryMetadata(Instruction &I, MDNode *MD);
384 void visitMemCacheHintMetadata(Instruction &I, MDNode *MD);
385
386#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
387#include "llvm/IR/Metadata.def"
388 void visitDIType(const DIType &N);
389 void visitDIScope(const DIScope &N);
390 void visitDIScopeChain(const DIScope &N);
391 bool hasDIScopeCycle(const Metadata *S);
392 DISubprogram *getSubprogram(Metadata *LocalScope);
393 void visitDIVariable(const DIVariable &N);
394 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
395 void visitDITemplateParameter(const DITemplateParameter &N);
396
397 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
398
399 void visit(DbgLabelRecord &DLR);
400 void visit(DbgVariableRecord &DVR);
401 // InstVisitor overrides...
402 using InstVisitor<Verifier>::visit;
403 void visitDbgRecords(Instruction &I);
404 void visit(Instruction &I);
405
406 void visitTruncInst(TruncInst &I);
407 void visitZExtInst(ZExtInst &I);
408 void visitSExtInst(SExtInst &I);
409 void visitFPTruncInst(FPTruncInst &I);
410 void visitFPExtInst(FPExtInst &I);
411 void visitFPToUIInst(FPToUIInst &I);
412 void visitFPToSIInst(FPToSIInst &I);
413 void visitUIToFPInst(UIToFPInst &I);
414 void visitSIToFPInst(SIToFPInst &I);
415 void visitIntToPtrInst(IntToPtrInst &I);
416 void checkPtrToAddr(Type *SrcTy, Type *DestTy, const Value &V);
417 void visitPtrToAddrInst(PtrToAddrInst &I);
418 void visitPtrToIntInst(PtrToIntInst &I);
419 void visitBitCastInst(BitCastInst &I);
420 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
421 void visitPHINode(PHINode &PN);
422 void visitCallBase(CallBase &Call);
423 void visitUnaryOperator(UnaryOperator &U);
424 void visitBinaryOperator(BinaryOperator &B);
425 void visitICmpInst(ICmpInst &IC);
426 void visitFCmpInst(FCmpInst &FC);
427 void visitExtractElementInst(ExtractElementInst &EI);
428 void visitInsertElementInst(InsertElementInst &EI);
429 void visitShuffleVectorInst(ShuffleVectorInst &EI);
430 void visitBitInsertInst(BitInsertInst &BII);
431 void visitBitExtractInst(BitExtractInst &BEI);
432 void visitVAArgInst(VAArgInst &VAA);
433 void visitCallInst(CallInst &CI);
434 void visitInvokeInst(InvokeInst &II);
435 void checkGEPOperator(const GEPOperator &GEP);
436 void visitGetElementPtrInst(GetElementPtrInst &GEP);
437 void visitLoadInst(LoadInst &LI);
438 void visitStoreInst(StoreInst &SI);
439 void verifyDominatesUse(Instruction &I, unsigned i);
440 void visitInstruction(Instruction &I);
441 void visitTerminator(Instruction &I);
442 void visitCondBrInst(CondBrInst &BI);
443 void visitReturnInst(ReturnInst &RI);
444 void visitSwitchInst(SwitchInst &SI);
445 void visitIndirectBrInst(IndirectBrInst &BI);
446 void visitCallBrInst(CallBrInst &CBI);
447 void visitSelectInst(SelectInst &SI);
448 void visitUserOp1(Instruction &I);
449 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
450 void visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call);
451 void visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI);
452 void visitVPIntrinsic(VPIntrinsic &VPI);
453 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
454 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
455 void visitFenceInst(FenceInst &FI);
456 void visitAllocaInst(AllocaInst &AI);
457 void visitExtractValueInst(ExtractValueInst &EVI);
458 void visitInsertValueInst(InsertValueInst &IVI);
459 void visitEHPadPredecessors(Instruction &I);
460 void visitLandingPadInst(LandingPadInst &LPI);
461 void visitResumeInst(ResumeInst &RI);
462 void visitCatchPadInst(CatchPadInst &CPI);
463 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
464 void visitCleanupPadInst(CleanupPadInst &CPI);
465 void visitFuncletPadInst(FuncletPadInst &FPI);
466 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
467 void visitCleanupReturnInst(CleanupReturnInst &CRI);
468
469 void verifySwiftErrorCall(CallBase &Call, const Value *SwiftErrorVal);
470 void verifySwiftErrorValue(const Value *SwiftErrorVal);
471 void verifyTailCCMustTailAttrs(const AttrBuilder &Attrs, StringRef Context);
472 void verifyMustTailCall(CallInst &CI);
473 bool verifyAttributeCount(AttributeList Attrs, unsigned Params);
474 void verifyAttributeTypes(AttributeSet Attrs, const Value *V);
475 void verifyParameterAttrs(AttributeSet Attrs, Type *Ty, const Value *V);
476 void checkUnsignedBaseTenFuncAttr(AttributeList Attrs, StringRef Attr,
477 const Value *V);
478 void verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
479 const Value *V, bool IsIntrinsic, bool IsInlineAsm);
480 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
481 void verifyUnknownProfileMetadata(MDNode *MD);
482 void visitConstantExprsRecursively(const Constant *EntryC);
483 void visitConstantExpr(const ConstantExpr *CE);
484 void visitConstantPtrAuth(const ConstantPtrAuth *CPA);
485 void verifyInlineAsmCall(const CallBase &Call);
486 void verifyStatepoint(const CallBase &Call);
487 void verifyFrameRecoverIndices();
488 void verifySiblingFuncletUnwinds();
489
490 void verifyFragmentExpression(const DbgVariableRecord &I);
491 template <typename ValueOrMetadata>
492 void verifyFragmentExpression(const DIVariable &V,
494 ValueOrMetadata *Desc);
495 void verifyFnArgs(const DbgVariableRecord &DVR);
496 void verifyNotEntryValue(const DbgVariableRecord &I);
497
498 /// Module-level debug info verification...
499 void verifyCompileUnits();
500
501 /// Module-level verification that all @llvm.experimental.deoptimize
502 /// declarations share the same calling convention.
503 void verifyDeoptimizeCallingConvs();
504
505 void verifyAttachedCallBundle(const CallBase &Call,
506 const OperandBundleUse &BU);
507
508 /// Verify the llvm.experimental.noalias.scope.decl declarations
509 void verifyNoAliasScopeDecl();
510};
511
512} // end anonymous namespace
513
514/// We know that cond should be true, if not print an error message.
515#define Check(C, ...) \
516 do { \
517 if (!(C)) { \
518 CheckFailed(__VA_ARGS__); \
519 return; \
520 } \
521 } while (false)
522
523/// We know that a debug info condition should be true, if not print
524/// an error message.
525#define CheckDI(C, ...) \
526 do { \
527 if (!(C)) { \
528 DebugInfoCheckFailed(__VA_ARGS__); \
529 return; \
530 } \
531 } while (false)
532
533void Verifier::visitDbgRecords(Instruction &I) {
534 if (!I.getDbgMarker())
535 return;
536 CheckDI(I.getDbgMarker()->MarkedInstr == &I,
537 "Instruction has invalid DebugMarker", &I);
538 CheckDI(!isa<PHINode>(&I) || !I.hasDbgRecords(),
539 "PHI Node must not have any attached DbgRecords", &I);
540 for (DbgRecord &DR : I.getDbgRecordRange()) {
541 CheckDI(DR.getMarker() == I.getDbgMarker(),
542 "DbgRecord had invalid DebugMarker", &I, &DR);
543 if (auto *Loc =
544 dyn_cast_or_null<DILocation>(DR.getDebugLoc().getAsMDNode()))
545 visitMDNode(*Loc, AreDebugLocsAllowed::Yes);
546 if (auto *DVR = dyn_cast<DbgVariableRecord>(&DR)) {
547 visit(*DVR);
548 // These have to appear after `visit` for consistency with existing
549 // intrinsic behaviour.
550 verifyFragmentExpression(*DVR);
551 verifyNotEntryValue(*DVR);
552 } else if (auto *DLR = dyn_cast<DbgLabelRecord>(&DR)) {
553 visit(*DLR);
554 }
555 }
556}
557
558void Verifier::visit(Instruction &I) {
559 visitDbgRecords(I);
560 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
561 Check(I.getOperand(i) != nullptr, "Operand is null", &I);
563}
564
565// Helper to iterate over indirect users. By returning false, the callback can ask to stop traversing further.
566static void forEachUser(const Value *User,
568 llvm::function_ref<bool(const Value *)> Callback) {
569 if (!Visited.insert(User).second)
570 return;
571
573 while (!WorkList.empty()) {
574 const Value *Cur = WorkList.pop_back_val();
575 if (!Visited.insert(Cur).second)
576 continue;
577 if (Callback(Cur))
578 append_range(WorkList, Cur->materialized_users());
579 }
580}
581
582void Verifier::visitGlobalValue(const GlobalValue &GV) {
584 "Global is external, but doesn't have external or weak linkage!", &GV);
585
586 if (const auto *GO = dyn_cast<GlobalObject>(&GV)) {
587 if (const MDNode *Associated =
588 GO->getMetadata(LLVMContext::MD_associated)) {
589 Check(Associated->getNumOperands() == 1,
590 "associated metadata must have one operand", &GV, Associated);
591 const Metadata *Op = Associated->getOperand(0).get();
592 Check(Op, "associated metadata must have a global value", GO, Associated);
593
594 const auto *VM = dyn_cast_or_null<ValueAsMetadata>(Op);
595 Check(VM, "associated metadata must be ValueAsMetadata", GO, Associated);
596 if (VM) {
597 Check(isa<PointerType>(VM->getValue()->getType()),
598 "associated value must be pointer typed", GV, Associated);
599
600 const Value *Stripped = VM->getValue()->stripPointerCastsAndAliases();
601 Check(isa<GlobalObject>(Stripped) || isa<Constant>(Stripped),
602 "associated metadata must point to a GlobalObject", GO, Stripped);
603 Check(Stripped != GO,
604 "global values should not associate to themselves", GO,
605 Associated);
606 }
607 }
608
609 // FIXME: Why is getMetadata on GlobalValue protected?
610 if (const MDNode *AbsoluteSymbol =
611 GO->getMetadata(LLVMContext::MD_absolute_symbol)) {
612 verifyRangeLikeMetadata(*GO, AbsoluteSymbol,
613 DL.getIntPtrType(GO->getType()),
614 RangeLikeMetadataKind::AbsoluteSymbol);
615 }
616
617 if (GO->hasMetadata(LLVMContext::MD_implicit_ref)) {
618 Check(!GO->isDeclaration(),
619 "ref metadata must not be placed on a declaration", GO);
620
622 GO->getMetadata(LLVMContext::MD_implicit_ref, MDs);
623 for (const MDNode *MD : MDs) {
624 Check(MD->getNumOperands() == 1, "ref metadata must have one operand",
625 &GV, MD);
626 const Metadata *Op = MD->getOperand(0).get();
627 const auto *VM = dyn_cast_or_null<ValueAsMetadata>(Op);
628 Check(VM, "ref metadata must be ValueAsMetadata", GO, MD);
629 if (VM) {
630 Check(isa<PointerType>(VM->getValue()->getType()),
631 "ref value must be pointer typed", GV, MD);
632
633 const Value *Stripped = VM->getValue()->stripPointerCastsAndAliases();
634 Check(isa<GlobalObject>(Stripped) || isa<Constant>(Stripped),
635 "ref metadata must point to a GlobalObject", GO, Stripped);
636 Check(Stripped != GO, "values should not reference themselves", GO,
637 MD);
638 }
639 }
640 }
641
642 if (auto *Props = GO->getMetadata(LLVMContext::MD_elf_section_properties)) {
643 Check(Props->getNumOperands() == 2,
644 "elf_section_properties metadata must have two operands", GO,
645 Props);
646 if (Props->getNumOperands() == 2) {
647 auto *Type = dyn_cast<ConstantAsMetadata>(Props->getOperand(0));
648 Check(Type, "type field must be ConstantAsMetadata", GO, Props);
649 auto *TypeInt = dyn_cast<ConstantInt>(Type->getValue());
650 Check(TypeInt, "type field must be ConstantInt", GO, Props);
651
652 auto *Entsize = dyn_cast<ConstantAsMetadata>(Props->getOperand(1));
653 Check(Entsize, "entsize field must be ConstantAsMetadata", GO, Props);
654 auto *EntsizeInt = dyn_cast<ConstantInt>(Entsize->getValue());
655 Check(EntsizeInt, "entsize field must be ConstantInt", GO, Props);
656 }
657 }
658 }
659
661 "Only global variables can have appending linkage!", &GV);
662
663 if (GV.hasAppendingLinkage()) {
664 const auto *GVar = dyn_cast<GlobalVariable>(&GV);
665 Check(GVar && GVar->getValueType()->isArrayTy(),
666 "Only global arrays can have appending linkage!", GVar);
667 }
668
669 if (GV.isDeclarationForLinker())
670 Check(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
671
672 if (GV.hasDLLExportStorageClass()) {
674 "dllexport GlobalValue must have default or protected visibility",
675 &GV);
676 }
677 if (GV.hasDLLImportStorageClass()) {
679 "dllimport GlobalValue must have default visibility", &GV);
680 Check(!GV.isDSOLocal(), "GlobalValue with DLLImport Storage is dso_local!",
681 &GV);
682
683 Check((GV.isDeclaration() &&
686 "Global is marked as dllimport, but not external", &GV);
687 }
688
689 if (GV.isImplicitDSOLocal())
690 Check(GV.isDSOLocal(),
691 "GlobalValue with local linkage or non-default "
692 "visibility must be dso_local!",
693 &GV);
694
695 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
696 if (const auto *I = dyn_cast<Instruction>(V)) {
697 if (!I->getParent() || !I->getParent()->getParent())
698 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
699 I);
700 else if (I->getParent()->getParent()->getParent() != &M)
701 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
702 I->getParent()->getParent(),
703 I->getParent()->getParent()->getParent());
704 return false;
705 } else if (const auto *F = dyn_cast<Function>(V)) {
706 if (F->getParent() != &M)
707 CheckFailed("Global is used by function in a different module", &GV, &M,
708 F, F->getParent());
709 return false;
710 }
711 return true;
712 });
713}
714
715void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
716 // Target-specific global variable checks. Done first because this function
717 // returns early for a global without an initializer.
719
720 Type *GVType = GV.getValueType();
721
722 if (MaybeAlign A = GV.getAlign()) {
723 Check(A->value() <= Value::MaximumAlignment,
724 "huge alignment values are unsupported", &GV);
725 }
726
727 if (GV.hasInitializer()) {
728 Check(GV.getInitializer()->getType() == GVType,
729 "Global variable initializer type does not match global "
730 "variable type!",
731 &GV);
733 "Global variable initializer must be sized", &GV);
734 visitConstantExprsRecursively(GV.getInitializer());
735 // If the global has common linkage, it must have a zero initializer and
736 // cannot be constant.
737 if (GV.hasCommonLinkage()) {
739 "'common' global must have a zero initializer!", &GV);
740 Check(!GV.isConstant(), "'common' global may not be marked constant!",
741 &GV);
742 Check(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
743 }
744 }
745
746 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
747 GV.getName() == "llvm.global_dtors")) {
749 "invalid linkage for intrinsic global variable", &GV);
751 "invalid uses of intrinsic global variable", &GV);
752
753 // Don't worry about emitting an error for it not being an array,
754 // visitGlobalValue will complain on appending non-array.
755 if (const auto *ATy = dyn_cast<ArrayType>(GVType)) {
756 const auto *STy = dyn_cast<StructType>(ATy->getElementType());
757 PointerType *FuncPtrTy =
758 PointerType::get(Context, DL.getProgramAddressSpace());
759 Check(STy && (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
760 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
761 STy->getTypeAtIndex(1) == FuncPtrTy,
762 "wrong type for intrinsic global variable", &GV);
763 Check(STy->getNumElements() == 3,
764 "the third field of the element type is mandatory, "
765 "specify ptr null to migrate from the obsoleted 2-field form");
766 Type *ETy = STy->getTypeAtIndex(2);
767 Check(ETy->isPointerTy(), "wrong type for intrinsic global variable",
768 &GV);
769 }
770
771 auto *Init = GV.hasInitializer()
773 : nullptr;
774 if (Init) {
775 for (const Use &U : Init->operands()) {
776 auto *Structor = dyn_cast<ConstantStruct>(U);
777 if (!Structor || Structor->getNumOperands() != 3)
778 continue;
779 Check(!isa<ConstantPtrAuth>(Structor->getOperand(1)),
780 "signing of ctors/dtors should be requested via module flags");
781 }
782 }
783 }
784
785 if (GV.hasName() && (GV.getName() == "llvm.used" ||
786 GV.getName() == "llvm.compiler.used")) {
788 "invalid linkage for intrinsic global variable", &GV);
790 "invalid uses of intrinsic global variable", &GV);
791
792 if (const auto *ATy = dyn_cast<ArrayType>(GVType)) {
793 const auto *PTy = dyn_cast<PointerType>(ATy->getElementType());
794 Check(PTy, "wrong type for intrinsic global variable", &GV);
795 if (GV.hasInitializer()) {
796 const Constant *Init = GV.getInitializer();
797 const auto *InitArray = dyn_cast<ConstantArray>(Init);
798 Check(InitArray, "wrong initializer for intrinsic global variable",
799 Init);
800 for (Value *Op : InitArray->operands()) {
801 Value *V = Op->stripPointerCasts();
804 Twine("invalid ") + GV.getName() + " member", V);
805 Check(V->hasName(),
806 Twine("members of ") + GV.getName() + " must be named", V);
807 }
808 }
809 }
810 }
811
812 // Visit any debug info attachments.
814 GV.getMetadata(LLVMContext::MD_dbg, MDs);
815 for (MDNode *MD : MDs) {
816 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
817 visitDIGlobalVariableExpression(*GVE);
818 else
819 CheckDI(false, "!dbg attachment of global variable must be a "
820 "DIGlobalVariableExpression");
821 }
822
823 // Scalable vectors cannot be global variables, since we don't know
824 // the runtime size.
825 Check(!GVType->isScalableTy(), "Globals cannot contain scalable types", &GV);
826
827 // Check if it is or contains a target extension type that disallows being
828 // used as a global.
830 "Global @" + GV.getName() + " has illegal target extension type",
831 GVType);
832
833 // Check that the the address space can hold all bits of the type, recognized
834 // by an access in the address space being able to reach all bytes of the
835 // type.
836 Check(!GVType->isSized() ||
837 isUIntN(DL.getAddressSizeInBits(GV.getAddressSpace()),
838 GV.getGlobalSize(DL)),
839 "Global variable is too large to fit into the address space", &GV,
840 GVType);
841
842 if (!GV.hasInitializer()) {
843 visitGlobalValue(GV);
844 return;
845 }
846
847 // Walk any aggregate initializers looking for bitcasts between address spaces
848 visitConstantExprsRecursively(GV.getInitializer());
849
850 visitGlobalValue(GV);
851}
852
853void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
854 SmallPtrSet<const GlobalAlias*, 4> Visited;
855 Visited.insert(&GA);
856 visitAliaseeSubExpr(Visited, GA, C);
857}
858
859void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
860 const GlobalAlias &GA, const Constant &C) {
863 cast<GlobalValue>(C).hasAvailableExternallyLinkage(),
864 "available_externally alias must point to available_externally "
865 "global value",
866 &GA);
867 }
868 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
870 Check(!GV->isDeclarationForLinker(), "Alias must point to a definition",
871 &GA);
872 }
873
874 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
875 Check(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
876
877 Check(!GA2->isInterposable(),
878 "Alias cannot point to an interposable alias", &GA);
879 } else {
880 // Only continue verifying subexpressions of GlobalAliases.
881 // Do not recurse into global initializers.
882 return;
883 }
884 }
885
886 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
887 visitConstantExprsRecursively(CE);
888
889 for (const Use &U : C.operands()) {
890 Value *V = &*U;
891 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
892 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
893 else if (const auto *C2 = dyn_cast<Constant>(V))
894 visitAliaseeSubExpr(Visited, GA, *C2);
895 }
896}
897
898void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
900 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
901 "weak_odr, external, or available_externally linkage!",
902 &GA);
903 const Constant *Aliasee = GA.getAliasee();
904 Check(Aliasee, "Aliasee cannot be NULL!", &GA);
905 Check(GA.getType() == Aliasee->getType(),
906 "Alias and aliasee types should match!", &GA);
907
908 Check(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
909 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
910
911 visitAliaseeSubExpr(GA, *Aliasee);
912
913 visitGlobalValue(GA);
914}
915
916void Verifier::visitGlobalIFunc(const GlobalIFunc &GI) {
917 visitGlobalValue(GI);
918
920 GI.getAllMetadata(MDs);
921 for (const auto &I : MDs) {
922 CheckDI(I.first != LLVMContext::MD_dbg,
923 "an ifunc may not have a !dbg attachment", &GI);
924 Check(I.first != LLVMContext::MD_prof,
925 "an ifunc may not have a !prof attachment", &GI);
926 visitMDNode(*I.second, AreDebugLocsAllowed::No);
927 }
928
930 "IFunc should have private, internal, linkonce, weak, linkonce_odr, "
931 "weak_odr, or external linkage!",
932 &GI);
933 // Pierce through ConstantExprs and GlobalAliases and check that the resolver
934 // is a Function definition.
935 const Function *Resolver = GI.getResolverFunction();
936 Check(Resolver, "IFunc must have a Function resolver", &GI);
937 Check(!Resolver->isDeclarationForLinker(),
938 "IFunc resolver must be a definition", &GI);
939
940 // Check that the immediate resolver operand (prior to any bitcasts) has the
941 // correct type.
942 const Type *ResolverTy = GI.getResolver()->getType();
943
945 "IFunc resolver must return a pointer", &GI);
946
947 Check(ResolverTy == PointerType::get(Context, GI.getAddressSpace()),
948 "IFunc resolver has incorrect type", &GI);
949}
950
951void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
952 // There used to be various other llvm.dbg.* nodes, but we don't support
953 // upgrading them and we want to reserve the namespace for future uses.
954 if (NMD.getName().starts_with("llvm.dbg."))
955 CheckDI(NMD.getName() == "llvm.dbg.cu",
956 "unrecognized named metadata node in the llvm.dbg namespace", &NMD);
957 for (const MDNode *MD : NMD.operands()) {
958 if (NMD.getName() == "llvm.dbg.cu")
959 CheckDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
960
961 if (!MD)
962 continue;
963
964 visitMDNode(*MD, AreDebugLocsAllowed::Yes);
965 }
966}
967
968/// Parent scope operand of \p S, or null if \p S has no parent (a \c DIFile,
969/// \c DICompileUnit, or non-scope). Mirrors \c DIScope::getScope() without
970/// asserting on unexpected metadata kinds.
971static const Metadata *getRawDIScopeParent(const Metadata *S) {
972 if (!S)
973 return nullptr;
974 if (auto *T = dyn_cast<DIType>(S))
975 return T->getRawScope();
976 if (auto *SP = dyn_cast<DISubprogram>(S))
977 return SP->getRawScope();
978 if (auto *LB = dyn_cast<DILexicalBlockBase>(S))
979 return LB->getRawScope();
980 if (auto *NS = dyn_cast<DINamespace>(S))
981 return NS->getRawScope();
982 if (auto *CB = dyn_cast<DICommonBlock>(S))
983 return CB->getRawScope();
984 if (auto *M = dyn_cast<DIModule>(S))
985 return M->getRawScope();
986 return nullptr;
987}
988
989/// True if following the scope operand from \p S repeats a node.
990bool Verifier::hasDIScopeCycle(const Metadata *S) {
991 SmallPtrSet<const Metadata *, 8> Seen;
992 auto CacheSeen = [&](bool HasCycle) {
993 for (const Metadata *M : Seen)
994 DIScopeChainReachesCycle[M] = HasCycle;
995 return HasCycle;
996 };
997
998 while (auto *Scope = dyn_cast_or_null<DIScope>(S)) {
999 auto It = DIScopeChainReachesCycle.find(Scope);
1000 bool IsInCache = It != DIScopeChainReachesCycle.end();
1001 if (IsInCache)
1002 return CacheSeen(It->second);
1003 bool AlreadySeen = !Seen.insert(Scope).second;
1004 if (AlreadySeen) // New cycle detected
1005 return CacheSeen(true);
1006 // No new cycle detected
1007 S = getRawDIScopeParent(Scope);
1008 }
1009
1010 // Finished walking node chain without detecting any cycles
1011 return CacheSeen(false);
1012}
1013
1014void Verifier::visitDIScopeChain(const DIScope &N) {
1015 CheckDI(!hasDIScopeCycle(&N), "DIScope scope chain must not contain a cycle",
1016 &N);
1017}
1018
1019void Verifier::visitMDNode(const MDNode &BaseMD,
1020 AreDebugLocsAllowed AllowLocs) {
1021 // Only visit each node once. Metadata can be mutually recursive, so this
1022 // avoids infinite recursion here, as well as being an optimization.
1023 if (!MDNodes.insert(&BaseMD).second)
1024 return;
1025
1026 std::queue<const MDNode *> Worklist;
1027 Worklist.push(&BaseMD);
1028
1029 while (!Worklist.empty()) {
1030 const MDNode *CurrentMD = Worklist.front();
1031 Worklist.pop();
1032 Check(&CurrentMD->getContext() == &Context,
1033 "MDNode context does not match Module context!", CurrentMD);
1034
1035 switch (CurrentMD->getMetadataID()) {
1036 default:
1037 llvm_unreachable("Invalid MDNode subclass");
1038 case Metadata::MDTupleKind:
1039 break;
1040#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
1041 case Metadata::CLASS##Kind: \
1042 visit##CLASS(cast<CLASS>(*CurrentMD)); \
1043 break;
1044#include "llvm/IR/Metadata.def"
1045 }
1046
1047 // A scope chain must terminate.
1048 if (const auto *S = dyn_cast<DIScope>(CurrentMD))
1049 visitDIScopeChain(*S);
1050
1051 for (const Metadata *Op : CurrentMD->operands()) {
1052 if (!Op)
1053 continue;
1054 Check(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
1055 CurrentMD, Op);
1056 CheckDI(!isa<DILocation>(Op) || AllowLocs == AreDebugLocsAllowed::Yes,
1057 "DILocation not allowed within this metadata node", CurrentMD,
1058 Op);
1059 if (auto *N = dyn_cast<MDNode>(Op)) {
1060 if (MDNodes.insert(N).second)
1061 Worklist.push(N);
1062 continue;
1063 }
1064 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
1065 visitValueAsMetadata(*V, nullptr);
1066 continue;
1067 }
1068 }
1069
1070 // FIXME: The nested llvm.loop.* property tags (llvm.loop.align,
1071 // llvm.loop.estimated_trip_count, the boolean enable/disable tags below)
1072 // are only meaningful as operands of an llvm.loop node. Neither llvm.loop's
1073 // structure nor the requirement that these tags appear only within it is
1074 // validated here; the checks below fire on any matching tuple regardless of
1075 // where it appears.
1076
1077 // Check llvm.loop.estimated_trip_count.
1078 if (CurrentMD->getNumOperands() > 0 &&
1080 Check(CurrentMD->getNumOperands() == 2, "Expected two operands",
1081 CurrentMD);
1082 auto *Count =
1084 Check(Count && Count->getType()->isIntegerTy() &&
1085 cast<IntegerType>(Count->getType())->getBitWidth() <= 32,
1086 "Expected second operand to be an integer constant of type i32 or "
1087 "smaller",
1088 CurrentMD);
1089 }
1090
1091 // Check llvm.loop.align.
1092 if (CurrentMD->getNumOperands() > 0 &&
1093 CurrentMD->getOperand(0).equalsStr("llvm.loop.align")) {
1094 Check(CurrentMD->getNumOperands() == 2, "Expected two operands",
1095 CurrentMD);
1096 auto *AlignMD =
1098 Check(AlignMD && AlignMD->getType()->isIntegerTy(32),
1099 "Expected the alignment to be an integer constant of type i32",
1100 CurrentMD);
1101 if (AlignMD) {
1102 uint64_t Align = AlignMD->getValue().getZExtValue();
1103 Check(isPowerOf2_64(Align),
1104 "Expected the alignment to be a power of two", CurrentMD);
1105 Check(Align <= Value::MaximumAlignment,
1106 "Alignment is larger than the implementation defined limit",
1107 CurrentMD);
1108 }
1109 }
1110
1111 // Enforce the single-operand form of the loop enable/disable pairs.
1112 if (CurrentMD->getNumOperands() > 0 &&
1113 any_of(OldBooleanLoopTags, [CurrentMD](const BooleanLoopTags &Tags) {
1114 return CurrentMD->getOperand(0).equalsStr(Tags.Enable) ||
1115 CurrentMD->getOperand(0).equalsStr(Tags.Disable);
1116 }))
1117 Check(CurrentMD->getNumOperands() == 1,
1118 "Expecting only the metadata name", CurrentMD);
1119
1120 // Check these last, so we diagnose problems in operands first.
1121 Check(!CurrentMD->isTemporary(), "Expected no forward declarations!",
1122 CurrentMD);
1123 Check(CurrentMD->isResolved(), "All nodes should be resolved!", CurrentMD);
1124 }
1125}
1126
1127void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
1128 Check(MD.getValue(), "Expected valid value", &MD);
1129 Check(!MD.getValue()->getType()->isMetadataTy(),
1130 "Unexpected metadata round-trip through values", &MD, MD.getValue());
1131
1132 auto *L = dyn_cast<LocalAsMetadata>(&MD);
1133 if (!L)
1134 return;
1135
1136 Check(F, "function-local metadata used outside a function", L);
1137
1138 // If this was an instruction, bb, or argument, verify that it is in the
1139 // function that we expect.
1140 Function *ActualF = nullptr;
1141 if (auto *I = dyn_cast<Instruction>(L->getValue())) {
1142 Check(I->getParent(), "function-local metadata not in basic block", L, I);
1143 ActualF = I->getParent()->getParent();
1144 } else if (auto *BB = dyn_cast<BasicBlock>(L->getValue())) {
1145 ActualF = BB->getParent();
1146 } else if (auto *A = dyn_cast<Argument>(L->getValue())) {
1147 ActualF = A->getParent();
1148 }
1149 assert(ActualF && "Unimplemented function local metadata case!");
1150
1151 Check(ActualF == F, "function-local metadata used in wrong function", L);
1152}
1153
1154void Verifier::visitDIArgList(const DIArgList &AL, Function *F) {
1155 for (const ValueAsMetadata *VAM : AL.getArgs())
1156 visitValueAsMetadata(*VAM, F);
1157}
1158
1159void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
1160 Metadata *MD = MDV.getMetadata();
1161 if (auto *N = dyn_cast<MDNode>(MD)) {
1162 visitMDNode(*N, AreDebugLocsAllowed::No);
1163 return;
1164 }
1165
1166 // Only visit each node once. Metadata can be mutually recursive, so this
1167 // avoids infinite recursion here, as well as being an optimization.
1168 if (!MDNodes.insert(MD).second)
1169 return;
1170
1171 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
1172 visitValueAsMetadata(*V, F);
1173
1174 if (auto *AL = dyn_cast<DIArgList>(MD))
1175 visitDIArgList(*AL, F);
1176}
1177
1178static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
1179static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
1180static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
1181static bool isMDTuple(const Metadata *MD) { return !MD || isa<MDTuple>(MD); }
1182
1183void Verifier::visitDILocation(const DILocation &N) {
1184 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1185 "location requires a valid scope", &N, N.getRawScope());
1186 if (auto *IA = N.getRawInlinedAt())
1187 CheckDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
1188 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
1189 CheckDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
1190 if (auto *L = N.getRawIRLayers())
1191 CheckDI(isa<DILayerLocList>(L), "irlayers must be a DILayerLocList", &N, L);
1192}
1193
1194void Verifier::visitDILayerLoc(const DILayerLoc &N) {
1195 CheckDI(isa_and_nonnull<MDString>(N.getRawKind()),
1196 "layer kind must be a non-null MDString", &N, N.getRawKind());
1197 CheckDI(isa_and_nonnull<DIFile>(N.getRawFile()),
1198 "layer file must be a non-null DIFile", &N, N.getRawFile());
1199}
1200
1201void Verifier::visitDILayerLocList(const DILayerLocList &N) {
1202 CheckDI(N.getNumLayers() > 0, "DILayerLocList must be non-empty", &N);
1203 for (const MDOperand &Op : N.layers())
1205 "DILayerLocList entry must be a DILayerLoc", &N, Op.get());
1206}
1207
1208void Verifier::visitGenericDINode(const GenericDINode &N) {
1209 CheckDI(N.getTag(), "invalid tag", &N);
1210}
1211
1212void Verifier::visitDIScope(const DIScope &N) {
1213 if (auto *F = N.getRawFile())
1214 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1215}
1216
1217void Verifier::visitDIType(const DIType &N) {
1218 CheckDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
1219 visitDIScope(N);
1220 CheckDI(N.getRawFile() || N.getLine() == 0, "line specified with no file", &N,
1221 N.getLine());
1222}
1223
1224void Verifier::visitDISubrangeType(const DISubrangeType &N) {
1225 visitDIType(N);
1226
1227 CheckDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
1228 auto *BaseType = N.getRawBaseType();
1229 CheckDI(!BaseType || isType(BaseType), "BaseType must be a type");
1230 auto *LBound = N.getRawLowerBound();
1231 CheckDI(!LBound || isa<ConstantAsMetadata>(LBound) ||
1232 isa<DIVariable>(LBound) || isa<DIExpression>(LBound) ||
1233 isa<DIDerivedType>(LBound),
1234 "LowerBound must be signed constant or DIVariable or DIExpression or "
1235 "DIDerivedType",
1236 &N);
1237 auto *UBound = N.getRawUpperBound();
1238 CheckDI(!UBound || isa<ConstantAsMetadata>(UBound) ||
1239 isa<DIVariable>(UBound) || isa<DIExpression>(UBound) ||
1240 isa<DIDerivedType>(UBound),
1241 "UpperBound must be signed constant or DIVariable or DIExpression or "
1242 "DIDerivedType",
1243 &N);
1244 auto *Stride = N.getRawStride();
1245 CheckDI(!Stride || isa<ConstantAsMetadata>(Stride) ||
1246 isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
1247 "Stride must be signed constant or DIVariable or DIExpression", &N);
1248 auto *Bias = N.getRawBias();
1249 CheckDI(!Bias || isa<ConstantAsMetadata>(Bias) || isa<DIVariable>(Bias) ||
1250 isa<DIExpression>(Bias),
1251 "Bias must be signed constant or DIVariable or DIExpression", &N);
1252 // Subrange types currently only support constant size.
1253 auto *Size = N.getRawSizeInBits();
1255 "SizeInBits must be a constant");
1256}
1257
1258void Verifier::visitDISubrange(const DISubrange &N) {
1259 CheckDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
1260 CheckDI(!N.getRawCountNode() || !N.getRawUpperBound(),
1261 "Subrange can have any one of count or upperBound", &N);
1262 auto *CBound = N.getRawCountNode();
1263 CheckDI(!CBound || isa<ConstantAsMetadata>(CBound) ||
1264 isa<DIVariable>(CBound) || isa<DIExpression>(CBound),
1265 "Count must be signed constant or DIVariable or DIExpression", &N);
1266 auto Count = N.getCount();
1268 cast<ConstantInt *>(Count)->getSExtValue() >= -1,
1269 "invalid subrange count", &N);
1270 auto *LBound = N.getRawLowerBound();
1271 CheckDI(!LBound || isa<ConstantAsMetadata>(LBound) ||
1272 isa<DIVariable>(LBound) || isa<DIExpression>(LBound),
1273 "LowerBound must be signed constant or DIVariable or DIExpression",
1274 &N);
1275 auto *UBound = N.getRawUpperBound();
1276 CheckDI(!UBound || isa<ConstantAsMetadata>(UBound) ||
1277 isa<DIVariable>(UBound) || isa<DIExpression>(UBound),
1278 "UpperBound must be signed constant or DIVariable or DIExpression",
1279 &N);
1280 auto *Stride = N.getRawStride();
1281 CheckDI(!Stride || isa<ConstantAsMetadata>(Stride) ||
1282 isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
1283 "Stride must be signed constant or DIVariable or DIExpression", &N);
1284}
1285
1286void Verifier::visitDIGenericSubrange(const DIGenericSubrange &N) {
1287 CheckDI(N.getTag() == dwarf::DW_TAG_generic_subrange, "invalid tag", &N);
1288 CheckDI(!N.getRawCountNode() || !N.getRawUpperBound(),
1289 "GenericSubrange can have any one of count or upperBound", &N);
1290 auto *CBound = N.getRawCountNode();
1291 CheckDI(!CBound || isa<DIVariable>(CBound) || isa<DIExpression>(CBound),
1292 "Count must be signed constant or DIVariable or DIExpression", &N);
1293 auto *LBound = N.getRawLowerBound();
1294 CheckDI(LBound, "GenericSubrange must contain lowerBound", &N);
1295 CheckDI(isa<DIVariable>(LBound) || isa<DIExpression>(LBound),
1296 "LowerBound must be signed constant or DIVariable or DIExpression",
1297 &N);
1298 auto *UBound = N.getRawUpperBound();
1299 CheckDI(!UBound || isa<DIVariable>(UBound) || isa<DIExpression>(UBound),
1300 "UpperBound must be signed constant or DIVariable or DIExpression",
1301 &N);
1302 auto *Stride = N.getRawStride();
1303 CheckDI(Stride, "GenericSubrange must contain stride", &N);
1304 CheckDI(isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
1305 "Stride must be signed constant or DIVariable or DIExpression", &N);
1306}
1307
1308void Verifier::visitDIEnumerator(const DIEnumerator &N) {
1309 CheckDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
1310}
1311
1312void Verifier::visitDIBasicType(const DIBasicType &N) {
1313 visitDIType(N);
1314
1315 CheckDI(N.getTag() == dwarf::DW_TAG_base_type ||
1316 N.getTag() == dwarf::DW_TAG_unspecified_type ||
1317 N.getTag() == dwarf::DW_TAG_string_type,
1318 "invalid tag", &N);
1319 // Basic types currently only support constant size.
1320 auto *Size = N.getRawSizeInBits();
1322 "SizeInBits must be a constant");
1323}
1324
1325void Verifier::visitDIFixedPointType(const DIFixedPointType &N) {
1326 visitDIBasicType(N);
1327
1328 CheckDI(N.getTag() == dwarf::DW_TAG_base_type, "invalid tag", &N);
1329 CheckDI(N.getEncoding() == dwarf::DW_ATE_signed_fixed ||
1330 N.getEncoding() == dwarf::DW_ATE_unsigned_fixed,
1331 "invalid encoding", &N);
1335 "invalid kind", &N);
1337 N.getFactorRaw() == 0,
1338 "factor should be 0 for rationals", &N);
1340 (N.getNumeratorRaw() == 0 && N.getDenominatorRaw() == 0),
1341 "numerator and denominator should be 0 for non-rationals", &N);
1342}
1343
1344void Verifier::visitDIStringType(const DIStringType &N) {
1345 visitDIType(N);
1346
1347 CheckDI(N.getTag() == dwarf::DW_TAG_string_type, "invalid tag", &N);
1348 CheckDI(!(N.isBigEndian() && N.isLittleEndian()), "has conflicting flags",
1349 &N);
1350 if (N.getRawCharType())
1351 CheckDI(isa<DIType>(N.getRawCharType()), "invalid character type", &N,
1352 N.getRawCharType());
1353}
1354
1355void Verifier::visitDIDerivedType(const DIDerivedType &N) {
1356 // Common type checks.
1357 visitDIType(N);
1358
1359 CheckDI(N.getTag() == dwarf::DW_TAG_typedef ||
1360 N.getTag() == dwarf::DW_TAG_pointer_type ||
1361 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
1362 N.getTag() == dwarf::DW_TAG_reference_type ||
1363 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
1364 N.getTag() == dwarf::DW_TAG_const_type ||
1365 N.getTag() == dwarf::DW_TAG_immutable_type ||
1366 N.getTag() == dwarf::DW_TAG_volatile_type ||
1367 N.getTag() == dwarf::DW_TAG_restrict_type ||
1368 N.getTag() == dwarf::DW_TAG_atomic_type ||
1369 N.getTag() == dwarf::DW_TAG_LLVM_ptrauth_type ||
1370 N.getTag() == dwarf::DW_TAG_member ||
1371 (N.getTag() == dwarf::DW_TAG_variable && N.isStaticMember()) ||
1372 N.getTag() == dwarf::DW_TAG_inheritance ||
1373 N.getTag() == dwarf::DW_TAG_friend ||
1374 N.getTag() == dwarf::DW_TAG_set_type ||
1375 N.getTag() == dwarf::DW_TAG_template_alias,
1376 "invalid tag", &N);
1377 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
1378 CheckDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
1379 N.getRawExtraData());
1380 } else if (N.getTag() == dwarf::DW_TAG_template_alias) {
1381 CheckDI(isMDTuple(N.getRawExtraData()), "invalid template parameters", &N,
1382 N.getRawExtraData());
1383 } else if (N.getTag() == dwarf::DW_TAG_inheritance ||
1384 N.getTag() == dwarf::DW_TAG_member ||
1385 N.getTag() == dwarf::DW_TAG_variable) {
1386 auto *ExtraData = N.getRawExtraData();
1387 auto IsValidExtraData = [&]() {
1388 if (ExtraData == nullptr)
1389 return true;
1390 if (isa<ConstantAsMetadata>(ExtraData) || isa<MDString>(ExtraData) ||
1391 isa<DIObjCProperty>(ExtraData))
1392 return true;
1393 if (auto *Tuple = dyn_cast<MDTuple>(ExtraData)) {
1394 if (Tuple->getNumOperands() != 1)
1395 return false;
1396 return isa_and_nonnull<ConstantAsMetadata>(Tuple->getOperand(0).get());
1397 }
1398 return false;
1399 };
1400 CheckDI(IsValidExtraData(),
1401 "extraData must be ConstantAsMetadata, MDString, DIObjCProperty, "
1402 "or MDTuple with single ConstantAsMetadata operand",
1403 &N, ExtraData);
1404 }
1405
1406 if (N.getTag() == dwarf::DW_TAG_set_type) {
1407 if (auto *T = N.getRawBaseType()) {
1411 CheckDI(
1412 (Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type) ||
1413 (Subrange && Subrange->getTag() == dwarf::DW_TAG_subrange_type) ||
1414 (Basic && (Basic->getEncoding() == dwarf::DW_ATE_unsigned ||
1415 Basic->getEncoding() == dwarf::DW_ATE_signed ||
1416 Basic->getEncoding() == dwarf::DW_ATE_unsigned_char ||
1417 Basic->getEncoding() == dwarf::DW_ATE_signed_char ||
1418 Basic->getEncoding() == dwarf::DW_ATE_boolean)),
1419 "invalid set base type", &N, T);
1420 }
1421 }
1422
1423 CheckDI(isType(N.getRawBaseType()), "invalid base type", &N,
1424 N.getRawBaseType());
1425
1426 if (N.getDWARFAddressSpace()) {
1427 CheckDI(N.getTag() == dwarf::DW_TAG_pointer_type ||
1428 N.getTag() == dwarf::DW_TAG_reference_type ||
1429 N.getTag() == dwarf::DW_TAG_rvalue_reference_type,
1430 "DWARF address space only applies to pointer or reference types",
1431 &N);
1432 }
1433
1434 auto *Size = N.getRawSizeInBits();
1437 "SizeInBits must be a constant or DIVariable or DIExpression");
1438}
1439
1440/// Detect mutually exclusive flags.
1441static bool hasConflictingReferenceFlags(unsigned Flags) {
1442 return ((Flags & DINode::FlagLValueReference) &&
1443 (Flags & DINode::FlagRValueReference)) ||
1444 ((Flags & DINode::FlagTypePassByValue) &&
1445 (Flags & DINode::FlagTypePassByReference));
1446}
1447
1448void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
1449 auto *Params = dyn_cast<MDTuple>(&RawParams);
1450 CheckDI(Params, "invalid template params", &N, &RawParams);
1451 for (Metadata *Op : Params->operands()) {
1452 CheckDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
1453 &N, Params, Op);
1454 }
1455}
1456
1457void Verifier::visitDICompositeType(const DICompositeType &N) {
1458 // Common type checks.
1459 visitDIType(N);
1460
1461 CheckDI(N.getTag() == dwarf::DW_TAG_array_type ||
1462 N.getTag() == dwarf::DW_TAG_structure_type ||
1463 N.getTag() == dwarf::DW_TAG_union_type ||
1464 N.getTag() == dwarf::DW_TAG_enumeration_type ||
1465 N.getTag() == dwarf::DW_TAG_class_type ||
1466 N.getTag() == dwarf::DW_TAG_variant_part ||
1467 N.getTag() == dwarf::DW_TAG_variant ||
1468 N.getTag() == dwarf::DW_TAG_namelist,
1469 "invalid tag", &N);
1470
1471 CheckDI(isType(N.getRawBaseType()), "invalid base type", &N,
1472 N.getRawBaseType());
1473
1474 CheckDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
1475 "invalid composite elements", &N, N.getRawElements());
1476 CheckDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
1477 N.getRawVTableHolder());
1479 "invalid reference flags", &N);
1480 unsigned DIBlockByRefStruct = 1 << 4;
1481 CheckDI((N.getFlags() & DIBlockByRefStruct) == 0,
1482 "DIBlockByRefStruct on DICompositeType is no longer supported", &N);
1483 CheckDI(llvm::all_of(N.getElements(), [](const DINode *N) { return N; }),
1484 "DISubprogram contains null entry in `elements` field", &N);
1485
1486 if (N.isVector()) {
1487 const DINodeArray Elements = N.getElements();
1488 CheckDI(Elements.size() == 1 &&
1489 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type,
1490 "invalid vector, expected one element of type subrange", &N);
1491 }
1492
1493 if (auto *Params = N.getRawTemplateParams())
1494 visitTemplateParams(N, *Params);
1495
1496 if (auto *D = N.getRawDiscriminator()) {
1497 CheckDI(isa<DIDerivedType>(D) && N.getTag() == dwarf::DW_TAG_variant_part,
1498 "discriminator can only appear on variant part");
1499 }
1500
1501 if (N.getRawDataLocation()) {
1502 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1503 "dataLocation can only appear in array type");
1504 }
1505
1506 if (N.getRawAssociated()) {
1507 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1508 "associated can only appear in array type");
1509 }
1510
1511 if (N.getRawAllocated()) {
1512 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1513 "allocated can only appear in array type");
1514 }
1515
1516 if (N.getRawRank()) {
1517 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1518 "rank can only appear in array type");
1519 }
1520
1521 if (N.getTag() == dwarf::DW_TAG_array_type) {
1522 CheckDI(N.getRawBaseType(), "array types must have a base type", &N);
1523 }
1524
1525 auto *Size = N.getRawSizeInBits();
1528 "SizeInBits must be a constant or DIVariable or DIExpression");
1529}
1530
1531void Verifier::visitDISubroutineType(const DISubroutineType &N) {
1532 visitDIType(N);
1533 CheckDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
1534 if (auto *Types = N.getRawTypeArray()) {
1535 CheckDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
1536 for (Metadata *Ty : N.getTypeArray()->operands()) {
1537 CheckDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
1538 }
1539 }
1541 "invalid reference flags", &N);
1542}
1543
1544void Verifier::visitDIFile(const DIFile &N) {
1545 CheckDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
1546 std::optional<DIFile::ChecksumInfo<StringRef>> Checksum = N.getChecksum();
1547 if (Checksum) {
1548 CheckDI(Checksum->Kind <= DIFile::ChecksumKind::CSK_Last,
1549 "invalid checksum kind", &N);
1550 size_t Size;
1551 switch (Checksum->Kind) {
1552 case DIFile::CSK_MD5:
1553 Size = 32;
1554 break;
1555 case DIFile::CSK_SHA1:
1556 Size = 40;
1557 break;
1558 case DIFile::CSK_SHA256:
1559 Size = 64;
1560 break;
1561 }
1562 CheckDI(Checksum->Value.size() == Size, "invalid checksum length", &N);
1563 CheckDI(Checksum->Value.find_if_not(llvm::isHexDigit) == StringRef::npos,
1564 "invalid checksum", &N);
1565 }
1566}
1567
1568void Verifier::visitDICompileUnit(const DICompileUnit &N) {
1569 CheckDI(N.isDistinct(), "compile units must be distinct", &N);
1570 CheckDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
1571
1572 // Don't bother verifying the compilation directory or producer string
1573 // as those could be empty.
1574 CheckDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
1575 N.getRawFile());
1576 CheckDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
1577 N.getFile());
1578
1579 CheckDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
1580 "invalid emission kind", &N);
1581
1582 CheckDI(N.getSourceLanguage().getDialect() <= dwarf::DW_LLVM_LANG_DIALECT_max,
1583 "invalid language dialect", &N);
1584
1585 if (auto *Array = N.getRawEnumTypes()) {
1586 CheckDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
1587 for (Metadata *Op : N.getEnumTypes()->operands()) {
1589 CheckDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
1590 "invalid enum type", &N, N.getEnumTypes(), Op);
1591 CheckDI(!Enum->getScope() || !isa<DILocalScope>(Enum->getScope()),
1592 "function-local enum in a DICompileUnit's enum list", &N,
1593 N.getEnumTypes(), Op);
1594 }
1595 }
1596 if (auto *Array = N.getRawRetainedTypes()) {
1597 CheckDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
1598 for (Metadata *Op : N.getRetainedTypes()->operands()) {
1599 CheckDI(
1600 Op && (isa<DIType>(Op) || (isa<DISubprogram>(Op) &&
1601 !cast<DISubprogram>(Op)->isDefinition())),
1602 "invalid retained type", &N, Op);
1603 }
1604 }
1605 if (auto *Array = N.getRawGlobalVariables()) {
1606 CheckDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
1607 for (Metadata *Op : N.getGlobalVariables()->operands()) {
1609 CheckDI(GVE, "invalid global variable ref", &N, Op);
1610 CheckDI(!isa_and_nonnull<DILocalScope>(GVE->getVariable()->getScope()),
1611 "function-local variables are not allowed in a DICompileUnit's "
1612 "global variables list",
1613 &N, Op);
1614 }
1615 }
1616 if (auto *Array = N.getRawImportedEntities()) {
1617 CheckDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
1618 for (Metadata *Op : N.getImportedEntities()->operands()) {
1620 CheckDI(IE, "invalid imported entity ref", &N, Op);
1622 "function-local imports are not allowed in a DICompileUnit's "
1623 "imported entities list",
1624 &N, Op);
1625 }
1626 }
1627 if (auto *Array = N.getRawMacros()) {
1628 CheckDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1629 for (Metadata *Op : N.getMacros()->operands()) {
1630 CheckDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1631 }
1632 }
1633 CUVisited.insert(&N);
1634}
1635
1636void Verifier::visitDISubprogram(const DISubprogram &N) {
1637 CheckDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1638 CheckDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
1639 if (auto *F = N.getRawFile())
1640 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1641 else
1642 CheckDI(N.getLine() == 0, "line specified with no file", &N, N.getLine());
1643 auto *T = N.getRawType();
1644 CheckDI(T, "DISubprogram requires a non-null type", &N);
1645 CheckDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1646 CheckDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1647 N.getRawContainingType());
1648 if (auto *Params = N.getRawTemplateParams())
1649 visitTemplateParams(N, *Params);
1650 if (auto *S = N.getRawDeclaration())
1651 CheckDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1652 "invalid subprogram declaration", &N, S);
1653 if (auto *RawNode = N.getRawRetainedNodes()) {
1654 auto *Node = dyn_cast<MDTuple>(RawNode);
1655 CheckDI(Node, "invalid retained nodes list", &N, RawNode);
1656
1657 DenseMap<unsigned, DILocalVariable *> Args;
1658 for (Metadata *Op : Node->operands()) {
1659 CheckDI(Op, "nullptr in retained nodes", &N, Node);
1660
1661 auto True = [](const Metadata *) { return true; };
1662 auto False = [](const Metadata *) { return false; };
1663 bool IsTypeCorrect = DISubprogram::visitRetainedNode<bool>(
1664 Op, True, True, True, True, True, False);
1665 CheckDI(IsTypeCorrect,
1666 "invalid retained nodes, expected DILocalVariable, DILabel, "
1667 "DIImportedEntity, DIType or DIGlobalVariableExpression",
1668 &N, Node, Op);
1669
1670 auto *RetainedNode = cast<MDNode>(Op);
1671 auto *RetainedNodeScope = dyn_cast_or_null<DILocalScope>(
1673 CheckDI(RetainedNodeScope,
1674 "invalid retained nodes, retained node is not local", &N, Node,
1675 RetainedNode);
1676
1677 DISubprogram *RetainedNodeSP = getSubprogram(RetainedNodeScope);
1678 DICompileUnit *RetainedNodeUnit =
1679 RetainedNodeSP ? RetainedNodeSP->getUnit() : nullptr;
1680 CheckDI(
1681 RetainedNodeSP == &N,
1682 "invalid retained nodes, retained node does not belong to subprogram",
1683 &N, Node, RetainedNode, RetainedNodeScope, RetainedNodeSP,
1684 RetainedNodeUnit);
1685
1686 auto *DV = dyn_cast<DILocalVariable>(RetainedNode);
1687 if (!DV)
1688 continue;
1689 if (unsigned ArgNum = DV->getArg()) {
1690 auto [ArgI, Inserted] = Args.insert({ArgNum, DV});
1691 CheckDI(Inserted || DV == ArgI->second,
1692 "invalid retained nodes, more than one local variable with the "
1693 "same argument index",
1694 &N, N.getUnit(), Node, RetainedNode, Args[ArgNum]);
1695 }
1696 }
1697 }
1699 "invalid reference flags", &N);
1700
1701 auto *Unit = N.getRawUnit();
1702 if (N.isDefinition()) {
1703 // Subprogram definitions (not part of the type hierarchy).
1704 CheckDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1705 CheckDI(Unit, "subprogram definitions must have a compile unit", &N);
1706 CheckDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
1707 // There's no good way to cross the CU boundary to insert a nested
1708 // DISubprogram definition in one CU into a type defined in another CU.
1709 auto *CT = dyn_cast_or_null<DICompositeType>(N.getRawScope());
1710 if (CT && CT->getRawIdentifier() &&
1711 M.getContext().isODRUniquingDebugTypes())
1712 CheckDI(N.getDeclaration(),
1713 "definition subprograms cannot be nested within DICompositeType "
1714 "when enabling ODR",
1715 &N);
1716 } else {
1717 // Subprogram declarations (part of the type hierarchy).
1718 CheckDI(!Unit, "subprogram declarations must not have a compile unit", &N);
1719 CheckDI(!N.getRawDeclaration(),
1720 "subprogram declaration must not have a declaration field");
1721 }
1722
1723 if (auto *RawThrownTypes = N.getRawThrownTypes()) {
1724 auto *ThrownTypes = dyn_cast<MDTuple>(RawThrownTypes);
1725 CheckDI(ThrownTypes, "invalid thrown types list", &N, RawThrownTypes);
1726 for (Metadata *Op : ThrownTypes->operands())
1727 CheckDI(Op && isa<DIType>(Op), "invalid thrown type", &N, ThrownTypes,
1728 Op);
1729 }
1730
1731 if (N.areAllCallsDescribed())
1732 CheckDI(N.isDefinition(),
1733 "DIFlagAllCallsDescribed must be attached to a definition");
1734}
1735
1736void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1737 CheckDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1738 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1739 "invalid local scope", &N, N.getRawScope());
1740 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
1741 CheckDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
1742}
1743
1744void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1745 visitDILexicalBlockBase(N);
1746
1747 CheckDI(N.getLine() || !N.getColumn(),
1748 "cannot have column info without line info", &N);
1749}
1750
1751void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1752 visitDILexicalBlockBase(N);
1753}
1754
1755void Verifier::visitDICommonBlock(const DICommonBlock &N) {
1756 CheckDI(N.getTag() == dwarf::DW_TAG_common_block, "invalid tag", &N);
1757 if (auto *S = N.getRawScope())
1758 CheckDI(isa<DIScope>(S), "invalid scope ref", &N, S);
1759 if (auto *S = N.getRawDecl())
1760 CheckDI(isa<DIGlobalVariable>(S), "invalid declaration", &N, S);
1761}
1762
1763void Verifier::visitDINamespace(const DINamespace &N) {
1764 CheckDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1765 if (auto *S = N.getRawScope())
1766 CheckDI(isa<DIScope>(S), "invalid scope ref", &N, S);
1767}
1768
1769void Verifier::visitDIMacro(const DIMacro &N) {
1770 CheckDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1771 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1772 "invalid macinfo type", &N);
1773 CheckDI(!N.getName().empty(), "anonymous macro", &N);
1774 if (!N.getValue().empty()) {
1775 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1776 }
1777}
1778
1779void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1780 CheckDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1781 "invalid macinfo type", &N);
1782 if (auto *F = N.getRawFile())
1783 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1784
1785 if (auto *Array = N.getRawElements()) {
1786 CheckDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1787 for (Metadata *Op : N.getElements()->operands()) {
1788 CheckDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1789 }
1790 }
1791}
1792
1793void Verifier::visitDIModule(const DIModule &N) {
1794 CheckDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1795 CheckDI(!N.getName().empty(), "anonymous module", &N);
1796}
1797
1798void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1799 CheckDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1800}
1801
1802void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1803 visitDITemplateParameter(N);
1804
1805 CheckDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1806 &N);
1807}
1808
1809void Verifier::visitDITemplateValueParameter(
1810 const DITemplateValueParameter &N) {
1811 visitDITemplateParameter(N);
1812
1813 CheckDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1814 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1815 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1816 "invalid tag", &N);
1817}
1818
1819void Verifier::visitDIVariable(const DIVariable &N) {
1820 if (auto *S = N.getRawScope())
1821 CheckDI(isa<DIScope>(S), "invalid scope", &N, S);
1822 if (auto *F = N.getRawFile())
1823 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1824}
1825
1826void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1827 // Checks common to all variables.
1828 visitDIVariable(N);
1829
1830 CheckDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1831 CheckDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1832 // Check only if the global variable is not an extern
1833 if (N.isDefinition())
1834 CheckDI(N.getType(), "missing global variable type", &N);
1835 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1837 "invalid static data member declaration", &N, Member);
1838 }
1839}
1840
1841void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1842 // Checks common to all variables.
1843 visitDIVariable(N);
1844
1845 CheckDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1846 CheckDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1847 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1848 "local variable requires a valid scope", &N, N.getRawScope());
1849 if (auto Ty = N.getType())
1850 CheckDI(!isa<DISubroutineType>(Ty), "invalid type", &N, N.getType());
1851}
1852
1853void Verifier::visitDIAssignID(const DIAssignID &N) {
1854 CheckDI(!N.getNumOperands(), "DIAssignID has no arguments", &N);
1855 CheckDI(N.isDistinct(), "DIAssignID must be distinct", &N);
1856}
1857
1858void Verifier::visitDILabel(const DILabel &N) {
1859 if (auto *S = N.getRawScope())
1860 CheckDI(isa<DIScope>(S), "invalid scope", &N, S);
1861 if (auto *F = N.getRawFile())
1862 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1863
1864 CheckDI(N.getTag() == dwarf::DW_TAG_label, "invalid tag", &N);
1865 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1866 "label requires a valid scope", &N, N.getRawScope());
1867}
1868
1869void Verifier::visitDIExpression(const DIExpression &N) {
1870 CheckDI(N.isValid(), "invalid expression", &N);
1871}
1872
1873void Verifier::visitDIGlobalVariableExpression(
1874 const DIGlobalVariableExpression &GVE) {
1875 CheckDI(GVE.getVariable(), "missing variable");
1876 if (auto *Var = GVE.getVariable())
1877 visitDIGlobalVariable(*Var);
1878 if (auto *Expr = GVE.getExpression()) {
1879 visitDIExpression(*Expr);
1880 if (auto Fragment = Expr->getFragmentInfo())
1881 verifyFragmentExpression(*GVE.getVariable(), *Fragment, &GVE);
1882 }
1883}
1884
1885void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1886 CheckDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1887 if (auto *T = N.getRawType())
1888 CheckDI(isType(T), "invalid type ref", &N, T);
1889 if (auto *F = N.getRawFile())
1890 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1891}
1892
1893void Verifier::visitDIProperty(const DIProperty &N) {
1894 CheckDI(N.getTag() == dwarf::DW_TAG_property, "invalid tag", &N);
1895 if (auto *T = N.getRawType())
1896 CheckDI(isType(T), "invalid type ref", &N, T);
1897 if (auto *F = N.getRawFile())
1898 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1899 // DWARF allows a property getter to forward to a subprogram, variable, or
1900 // constant too, but the backend only knows how to forward to a member.
1901 if (DINode *BackingStorage = N.getBackingStorage()) {
1902 auto *DT = dyn_cast<DIDerivedType>(BackingStorage);
1903 CheckDI(DT && DT->getTag() == dwarf::DW_TAG_member,
1904 "property backing storage must be a member", &N, BackingStorage);
1905 }
1906}
1907
1908void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1909 CheckDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1910 N.getTag() == dwarf::DW_TAG_imported_declaration,
1911 "invalid tag", &N);
1912 if (auto *S = N.getRawScope())
1913 CheckDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1914 CheckDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1915 N.getRawEntity());
1916}
1917
1918void Verifier::visitComdat(const Comdat &C) {
1919 // In COFF the Module is invalid if the GlobalValue has private linkage.
1920 // Entities with private linkage don't have entries in the symbol table.
1921 if (TT.isOSBinFormatCOFF())
1922 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
1923 Check(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1924 GV);
1925}
1926
1927void Verifier::visitModuleIdents() {
1928 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1929 if (!Idents)
1930 return;
1931
1932 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1933 // Scan each llvm.ident entry and make sure that this requirement is met.
1934 for (const MDNode *N : Idents->operands()) {
1935 Check(N->getNumOperands() == 1,
1936 "incorrect number of operands in llvm.ident metadata", N);
1937 Check(dyn_cast_or_null<MDString>(N->getOperand(0)),
1938 ("invalid value for llvm.ident metadata entry operand"
1939 "(the operand should be a string)"),
1940 N->getOperand(0));
1941 }
1942}
1943
1944void Verifier::visitModuleCommandLines() {
1945 const NamedMDNode *CommandLines = M.getNamedMetadata("llvm.commandline");
1946 if (!CommandLines)
1947 return;
1948
1949 // llvm.commandline takes a list of metadata entry. Each entry has only one
1950 // string. Scan each llvm.commandline entry and make sure that this
1951 // requirement is met.
1952 for (const MDNode *N : CommandLines->operands()) {
1953 Check(N->getNumOperands() == 1,
1954 "incorrect number of operands in llvm.commandline metadata", N);
1955 Check(dyn_cast_or_null<MDString>(N->getOperand(0)),
1956 ("invalid value for llvm.commandline metadata entry operand"
1957 "(the operand should be a string)"),
1958 N->getOperand(0));
1959 }
1960}
1961
1962void Verifier::visitModuleErrnoTBAA() {
1963 const NamedMDNode *ErrnoTBAA = M.getNamedMetadata("llvm.errno.tbaa");
1964 if (!ErrnoTBAA)
1965 return;
1966
1967 Check(ErrnoTBAA->getNumOperands() >= 1,
1968 "llvm.errno.tbaa must have at least one operand", ErrnoTBAA);
1969
1970 for (const MDNode *N : ErrnoTBAA->operands())
1971 TBAAVerifyHelper.visitTBAAMetadata(nullptr, N);
1972}
1973
1974void Verifier::visitModuleRawSections() {
1975 const NamedMDNode *RawSections = M.getNamedMetadata("llvm.raw.sections");
1976 if (!RawSections)
1977 return;
1978
1979 for (const MDNode *N : RawSections->operands()) {
1980 if (N->getNumOperands() != 4) {
1981 CheckFailed("llvm.raw.sections entry must have four operands", N);
1982 continue;
1983 }
1984 Check(dyn_cast_or_null<MDString>(N->getOperand(0)),
1985 "llvm.raw.sections entry operand 0 must be a string "
1986 "(section name)",
1987 N);
1988 auto *AlignCI = mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(1));
1989 Check(AlignCI,
1990 "llvm.raw.sections entry operand 1 must be an integer "
1991 "(alignment)",
1992 N);
1993 if (!isPowerOf2_64(AlignCI->getZExtValue())) {
1994 CheckFailed("llvm.raw.sections entry operand 1 must be a power of two "
1995 "(alignment)",
1996 N);
1997 continue;
1998 }
1999 auto *FlagsCI = mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(2));
2000 Check(FlagsCI,
2001 "llvm.raw.sections entry operand 2 must be an integer "
2002 "(flags)",
2003 N);
2004 if (FlagsCI->getZExtValue() != 0) {
2005 CheckFailed("llvm.raw.sections entry operand 2 must be zero (flags are "
2006 "reserved for future use)",
2007 N);
2008 continue;
2009 }
2010 Check(dyn_cast_or_null<MDString>(N->getOperand(3)),
2011 "llvm.raw.sections entry operand 3 must be a string "
2012 "(section data)",
2013 N);
2014 }
2015}
2016
2017void Verifier::visitModuleFlags() {
2018 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
2019 if (!Flags) return;
2020
2021 // Scan each flag, and track the flags and requirements.
2022 DenseMap<const MDString*, const MDNode*> SeenIDs;
2023 SmallVector<const MDNode*, 16> Requirements;
2024
2025 // Either both aarch64-elf-pauthabi-* flags should be set or none at all.
2026 std::optional<uint64_t> PAuthABIPlatform;
2027 std::optional<uint64_t> PAuthABIVersion;
2028 // Signing of init/fini pointers: address diversity implies basic signing.
2029 uint64_t HasPtrauthInitFini = 0;
2030 uint64_t HasPtrauthInitFiniAddr = 0;
2031
2032 for (const MDNode *MDN : Flags->operands()) {
2033 visitModuleFlag(MDN, SeenIDs, Requirements);
2034 if (MDN->getNumOperands() != 3)
2035 continue;
2036
2037 if (const auto *FlagName = dyn_cast_or_null<MDString>(MDN->getOperand(1))) {
2038 auto GetFlagNamed = [&](StringRef Name) -> std::optional<uint64_t> {
2039 if (FlagName->getString() != Name)
2040 return std::nullopt;
2041 if (const auto *FlagValue =
2043 return FlagValue->getZExtValue();
2044
2045 CheckFailed(Name + ": module flag expects integer value");
2046 return std::nullopt;
2047 };
2048
2049 if (auto Value = GetFlagNamed("aarch64-elf-pauthabi-platform"))
2050 PAuthABIPlatform = *Value;
2051 else if (auto Value = GetFlagNamed("aarch64-elf-pauthabi-version"))
2052 PAuthABIVersion = *Value;
2053 else if (auto Value = GetFlagNamed("ptrauth-init-fini"))
2054 HasPtrauthInitFini = *Value;
2055 else if (auto Value =
2056 GetFlagNamed("ptrauth-init-fini-address-discrimination"))
2057 HasPtrauthInitFiniAddr = *Value;
2058 }
2059 }
2060
2061 Check(llvm::is_contained({0u, 1u}, HasPtrauthInitFini),
2062 "ptrauth-init-fini must be 0 or 1");
2063 Check(llvm::is_contained({0u, 1u}, HasPtrauthInitFiniAddr),
2064 "ptrauth-init-fini-address-discrimination must be 0 or 1, if set");
2065 if (HasPtrauthInitFiniAddr)
2066 Check(HasPtrauthInitFini, "ptrauth-init-fini-address-discrimination module "
2067 "flag requires ptrauth-init-fini");
2068
2069 if (PAuthABIPlatform.has_value() != PAuthABIVersion.has_value())
2070 CheckFailed("either both or no 'aarch64-elf-pauthabi-platform' and "
2071 "'aarch64-elf-pauthabi-version' module flags must be present");
2072
2073 // Validate that the requirements in the module are valid.
2074 for (const MDNode *Requirement : Requirements) {
2075 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
2076 const Metadata *ReqValue = Requirement->getOperand(1);
2077
2078 const MDNode *Op = SeenIDs.lookup(Flag);
2079 if (!Op) {
2080 CheckFailed("invalid requirement on flag, flag is not present in module",
2081 Flag);
2082 continue;
2083 }
2084
2085 if (Op->getOperand(2) != ReqValue) {
2086 CheckFailed(("invalid requirement on flag, "
2087 "flag does not have the required value"),
2088 Flag);
2089 continue;
2090 }
2091 }
2092}
2093
2094void
2095Verifier::visitModuleFlag(const MDNode *Op,
2096 DenseMap<const MDString *, const MDNode *> &SeenIDs,
2097 SmallVectorImpl<const MDNode *> &Requirements) {
2098 // Each module flag should have three arguments, the merge behavior (a
2099 // constant int), the flag ID (an MDString), and the value.
2100 Check(Op->getNumOperands() == 3,
2101 "incorrect number of operands in module flag", Op);
2102 Module::ModFlagBehavior MFB;
2103 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
2105 "invalid behavior operand in module flag (expected constant integer)",
2106 Op->getOperand(0));
2107 Check(false,
2108 "invalid behavior operand in module flag (unexpected constant)",
2109 Op->getOperand(0));
2110 }
2111 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
2112 Check(ID, "invalid ID operand in module flag (expected metadata string)",
2113 Op->getOperand(1));
2114
2115 // Check the values for behaviors with additional requirements.
2116 switch (MFB) {
2117 case Module::Error:
2118 case Module::Warning:
2119 case Module::Override:
2120 // These behavior types accept any value.
2121 break;
2122
2123 case Module::Min: {
2124 auto *V = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
2125 Check(V && V->getValue().isNonNegative(),
2126 "invalid value for 'min' module flag (expected constant non-negative "
2127 "integer)",
2128 Op->getOperand(2));
2129 break;
2130 }
2131
2132 case Module::Max: {
2134 "invalid value for 'max' module flag (expected constant integer)",
2135 Op->getOperand(2));
2136 break;
2137 }
2138
2139 case Module::Require: {
2140 // The value should itself be an MDNode with two operands, a flag ID (an
2141 // MDString), and a value.
2142 auto *Value = dyn_cast<MDNode>(Op->getOperand(2));
2143 Check(Value && Value->getNumOperands() == 2,
2144 "invalid value for 'require' module flag (expected metadata pair)",
2145 Op->getOperand(2));
2146 Check(isa<MDString>(Value->getOperand(0)),
2147 ("invalid value for 'require' module flag "
2148 "(first value operand should be a string)"),
2149 Value->getOperand(0));
2150
2151 // Append it to the list of requirements, to check once all module flags are
2152 // scanned.
2153 Requirements.push_back(Value);
2154 break;
2155 }
2156
2157 case Module::Append:
2158 case Module::AppendUnique: {
2159 // These behavior types require the operand be an MDNode.
2160 Check(isa<MDNode>(Op->getOperand(2)),
2161 "invalid value for 'append'-type module flag "
2162 "(expected a metadata node)",
2163 Op->getOperand(2));
2164 break;
2165 }
2166 }
2167
2168 // Unless this is a "requires" flag, check the ID is unique.
2169 if (MFB != Module::Require) {
2170 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
2171 Check(Inserted,
2172 "module flag identifiers must be unique (or of 'require' type)", ID);
2173 }
2174
2175 StringRef Name = ID->getString();
2176 if (Name == "wchar_size") {
2177 ConstantInt *Value
2179 Check(Value, "wchar_size metadata requires constant integer argument");
2180 return;
2181 }
2182
2183 if (Name == "long-double-type") {
2184 Check(MFB == Module::Error,
2185 "long-double-type module flag must use 'error' merge behavior", Op);
2186 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2187 Check(Value, "long-double-type metadata requires a string argument");
2188 if (Value)
2189 Check(parseLongDoubleFormat(Value->getString()).has_value(),
2190 "invalid long-double-type metadata value", Op);
2191 return;
2192 }
2193
2194 if (Name == "float-abi") {
2195 Check(MFB == Module::Error,
2196 "float-abi module flag must use 'error' merge behavior", Op);
2197 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2198 Check(Value, "float-abi metadata requires a string argument");
2199 if (Value)
2200 Check(FloatABI::parseABIType(Value->getString()).has_value(),
2201 "invalid float-abi metadata value", Op);
2202 return;
2203 }
2204
2205 if (Name == "thread-model") {
2206 Check(MFB == Module::Error,
2207 "thread-model module flag must use 'error' merge behavior", Op);
2208 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2209 Check(Value, "thread-model metadata requires a string argument");
2210 if (Value)
2211 Check(parseThreadModel(Value->getString()).has_value(),
2212 "invalid thread-model metadata value", Op);
2213 return;
2214 }
2215
2216 if (Name == "target-abi") {
2217 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2218 Check(Value && !Value->getString().empty(),
2219 "target-abi metadata requires a non-empty string argument", Op);
2220 return;
2221 }
2222
2223 if (ID->getString() == "exception-model") {
2224 Check(MFB == Module::Error,
2225 "exception-model module flag must use 'error' merge behavior", Op);
2226 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2227 Check(Value, "exception-model metadata requires a string argument");
2228 if (Value)
2229 Check(parseExceptionModel(Value->getString()).has_value(),
2230 "invalid exception-model metadata value", Op);
2231 return;
2232 }
2233
2234 if (Name == "debugger-tuning") {
2235 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2236 Check(Value && !Value->getString().empty(),
2237 "debugger-tuning metadata requires a non-empty string argument", Op);
2238 return;
2239 }
2240
2241 if (Name == "Linker Options") {
2242 // If the llvm.linker.options named metadata exists, we assume that the
2243 // bitcode reader has upgraded the module flag. Otherwise the flag might
2244 // have been created by a client directly.
2245 Check(M.getNamedMetadata("llvm.linker.options"),
2246 "'Linker Options' named metadata no longer supported");
2247 return;
2248 }
2249
2250 if (Name == "SemanticInterposition") {
2251 ConstantInt *Value =
2253 Check(Value,
2254 "SemanticInterposition metadata requires constant integer argument");
2255 return;
2256 }
2257
2258 if (Name == "CG Profile") {
2259 for (const MDOperand &MDO : cast<MDNode>(Op->getOperand(2))->operands())
2260 visitModuleFlagCGProfileEntry(MDO);
2261 return;
2262 }
2263
2264 // Target-specific module flag checks.
2265 verifyAMDGPUModuleFlag(*this, ID, MFB, Op);
2266}
2267
2268void Verifier::visitModuleFlagCGProfileEntry(const MDOperand &MDO) {
2269 auto CheckFunction = [&](const MDOperand &FuncMDO) {
2270 if (!FuncMDO)
2271 return;
2272 auto F = dyn_cast<ValueAsMetadata>(FuncMDO);
2273 Check(F && isa<Function>(F->getValue()->stripPointerCasts()),
2274 "expected a Function or null", FuncMDO);
2275 };
2276 auto Node = dyn_cast_or_null<MDNode>(MDO);
2277 Check(Node && Node->getNumOperands() == 3, "expected a MDNode triple", MDO);
2278 CheckFunction(Node->getOperand(0));
2279 CheckFunction(Node->getOperand(1));
2280 auto Count = dyn_cast_or_null<ConstantAsMetadata>(Node->getOperand(2));
2281 Check(Count && Count->getType()->isIntegerTy(),
2282 "expected an integer constant", Node->getOperand(2));
2283}
2284
2285void Verifier::verifyAttributeTypes(AttributeSet Attrs, const Value *V) {
2286 for (Attribute A : Attrs) {
2287
2288 if (A.isStringAttribute()) {
2289#define GET_ATTR_NAMES
2290#define ATTRIBUTE_ENUM(ENUM_NAME, DISPLAY_NAME)
2291#define ATTRIBUTE_STRBOOL(ENUM_NAME, DISPLAY_NAME) \
2292 if (A.getKindAsString() == #DISPLAY_NAME) { \
2293 auto V = A.getValueAsString(); \
2294 if (!(V.empty() || V == "true" || V == "false")) \
2295 CheckFailed("invalid value for '" #DISPLAY_NAME "' attribute: " + V + \
2296 ""); \
2297 }
2298
2299#include "llvm/IR/Attributes.inc"
2300 continue;
2301 }
2302
2303 if (A.isIntAttribute() != Attribute::isIntAttrKind(A.getKindAsEnum())) {
2304 CheckFailed("Attribute '" + A.getAsString() + "' should have an Argument",
2305 V);
2306 return;
2307 }
2308 }
2309}
2310
2311// VerifyParameterAttrs - Check the given attributes for an argument or return
2312// value of the specified type. The value V is printed in error messages.
2313void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty,
2314 const Value *V) {
2315 if (!Attrs.hasAttributes())
2316 return;
2317
2318 verifyAttributeTypes(Attrs, V);
2319
2320 for (Attribute Attr : Attrs)
2321 Check(Attr.isStringAttribute() ||
2322 Attribute::canUseAsParamAttr(Attr.getKindAsEnum()),
2323 "Attribute '" + Attr.getAsString() + "' does not apply to parameters",
2324 V);
2325
2326 if (Attrs.hasAttribute(Attribute::ImmArg)) {
2327 unsigned AttrCount =
2328 Attrs.getNumAttributes() - Attrs.hasAttribute(Attribute::Range);
2329 Check(AttrCount == 1,
2330 "Attribute 'immarg' is incompatible with other attributes except the "
2331 "'range' attribute",
2332 V);
2333 }
2334
2335 // Check for mutually incompatible attributes. Only inreg is compatible with
2336 // sret.
2337 unsigned AttrCount = 0;
2338 AttrCount += Attrs.hasAttribute(Attribute::ByVal);
2339 AttrCount += Attrs.hasAttribute(Attribute::InAlloca);
2340 AttrCount += Attrs.hasAttribute(Attribute::Preallocated);
2341 AttrCount += Attrs.hasAttribute(Attribute::StructRet) ||
2342 Attrs.hasAttribute(Attribute::InReg);
2343 AttrCount += Attrs.hasAttribute(Attribute::Nest);
2344 AttrCount += Attrs.hasAttribute(Attribute::ByRef);
2345 Check(AttrCount <= 1,
2346 "Attributes 'byval', 'inalloca', 'preallocated', 'inreg', 'nest', "
2347 "'byref', and 'sret' are incompatible!",
2348 V);
2349
2350 Check(!(Attrs.hasAttribute(Attribute::InAlloca) &&
2351 Attrs.hasAttribute(Attribute::ReadOnly)),
2352 "Attributes "
2353 "'inalloca and readonly' are incompatible!",
2354 V);
2355
2356 Check(!(Attrs.hasAttribute(Attribute::StructRet) &&
2357 Attrs.hasAttribute(Attribute::Returned)),
2358 "Attributes "
2359 "'sret and returned' are incompatible!",
2360 V);
2361
2362 Check(!(Attrs.hasAttribute(Attribute::ZExt) &&
2363 Attrs.hasAttribute(Attribute::SExt)),
2364 "Attributes "
2365 "'zeroext and signext' are incompatible!",
2366 V);
2367
2368 Check(!(Attrs.hasAttribute(Attribute::ReadNone) &&
2369 Attrs.hasAttribute(Attribute::ReadOnly)),
2370 "Attributes "
2371 "'readnone and readonly' are incompatible!",
2372 V);
2373
2374 Check(!(Attrs.hasAttribute(Attribute::ReadNone) &&
2375 Attrs.hasAttribute(Attribute::WriteOnly)),
2376 "Attributes "
2377 "'readnone and writeonly' are incompatible!",
2378 V);
2379
2380 Check(!(Attrs.hasAttribute(Attribute::ReadOnly) &&
2381 Attrs.hasAttribute(Attribute::WriteOnly)),
2382 "Attributes "
2383 "'readonly and writeonly' are incompatible!",
2384 V);
2385
2386 Check(!(Attrs.hasAttribute(Attribute::NoInline) &&
2387 Attrs.hasAttribute(Attribute::AlwaysInline)),
2388 "Attributes "
2389 "'noinline and alwaysinline' are incompatible!",
2390 V);
2391
2392 Check(!(Attrs.hasAttribute(Attribute::Writable) &&
2393 Attrs.hasAttribute(Attribute::ReadNone)),
2394 "Attributes writable and readnone are incompatible!", V);
2395
2396 Check(!(Attrs.hasAttribute(Attribute::Writable) &&
2397 Attrs.hasAttribute(Attribute::ReadOnly)),
2398 "Attributes writable and readonly are incompatible!", V);
2399
2400 AttributeMask IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty, Attrs);
2401 for (Attribute Attr : Attrs) {
2402 if (!Attr.isStringAttribute() &&
2403 IncompatibleAttrs.contains(Attr.getKindAsEnum())) {
2404 CheckFailed("Attribute '" + Attr.getAsString() +
2405 "' applied to incompatible type!", V);
2406 return;
2407 }
2408 }
2409
2410 if (isa<PointerType>(Ty)) {
2411 if (Attrs.hasAttribute(Attribute::Alignment)) {
2412 Align AttrAlign = Attrs.getAlignment().valueOrOne();
2413 Check(AttrAlign.value() <= Value::MaximumAlignment,
2414 "huge alignment values are unsupported", V);
2415 }
2416 if (Attrs.hasAttribute(Attribute::ByVal)) {
2417 Type *ByValTy = Attrs.getByValType();
2418 Check(ByValTy->isSized(),
2419 "Attribute 'byval' does not support unsized types!", V);
2420 // Check if it is or contains a target extension type that disallows being
2421 // used on the stack.
2423 "'byval' argument has illegal target extension type", V);
2424 // The copy is placed in the caller's frame, which needs its size at
2425 // compile time.
2426 Check(!ByValTy->isScalableTy(),
2427 "scalable 'byval' arguments are unsupported", V);
2428 Check(DL.getTypeAllocSize(ByValTy).getKnownMinValue() < (1ULL << 32),
2429 "huge 'byval' arguments are unsupported", V);
2430 }
2431 if (Attrs.hasAttribute(Attribute::ByRef)) {
2432 Check(Attrs.getByRefType()->isSized(),
2433 "Attribute 'byref' does not support unsized types!", V);
2434 Check(DL.getTypeAllocSize(Attrs.getByRefType()).getKnownMinValue() <
2435 (1ULL << 32),
2436 "huge 'byref' arguments are unsupported", V);
2437 }
2438 if (Attrs.hasAttribute(Attribute::InAlloca)) {
2439 Check(Attrs.getInAllocaType()->isSized(),
2440 "Attribute 'inalloca' does not support unsized types!", V);
2441 Check(DL.getTypeAllocSize(Attrs.getInAllocaType()).getKnownMinValue() <
2442 (1ULL << 32),
2443 "huge 'inalloca' arguments are unsupported", V);
2444 }
2445 if (Attrs.hasAttribute(Attribute::Preallocated)) {
2446 Check(Attrs.getPreallocatedType()->isSized(),
2447 "Attribute 'preallocated' does not support unsized types!", V);
2448 Check(
2449 DL.getTypeAllocSize(Attrs.getPreallocatedType()).getKnownMinValue() <
2450 (1ULL << 32),
2451 "huge 'preallocated' arguments are unsupported", V);
2452 }
2453 }
2454
2455 if (Attrs.hasAttribute(Attribute::Initializes)) {
2456 auto Inits = Attrs.getAttribute(Attribute::Initializes).getInitializes();
2457 Check(!Inits.empty(), "Attribute 'initializes' does not support empty list",
2458 V);
2460 "Attribute 'initializes' does not support unordered ranges", V);
2461 }
2462
2463 if (Attrs.hasAttribute(Attribute::NoFPClass)) {
2464 uint64_t Val = Attrs.getAttribute(Attribute::NoFPClass).getValueAsInt();
2465 Check(Val != 0, "Attribute 'nofpclass' must have at least one test bit set",
2466 V);
2467 Check((Val & ~static_cast<unsigned>(fcAllFlags)) == 0,
2468 "Invalid value for 'nofpclass' test mask", V);
2469 }
2470 if (Attrs.hasAttribute(Attribute::Range)) {
2471 const ConstantRange &CR =
2472 Attrs.getAttribute(Attribute::Range).getValueAsConstantRange();
2474 "Range bit width must match type bit width!", V);
2475 }
2476}
2477
2478void Verifier::checkUnsignedBaseTenFuncAttr(AttributeList Attrs, StringRef Attr,
2479 const Value *V) {
2480 if (Attrs.hasFnAttr(Attr)) {
2481 StringRef S = Attrs.getFnAttr(Attr).getValueAsString();
2482 unsigned N;
2483 if (S.getAsInteger(10, N))
2484 CheckFailed("\"" + Attr + "\" takes an unsigned integer: " + S, V);
2485 }
2486}
2487
2488// Check parameter attributes against a function type.
2489// The value V is printed in error messages.
2490void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
2491 const Value *V, bool IsIntrinsic,
2492 bool IsInlineAsm) {
2493 if (Attrs.isEmpty())
2494 return;
2495
2496 if (AttributeListsVisited.insert(Attrs.getRawPointer()).second) {
2497 Check(Attrs.hasParentContext(Context),
2498 "Attribute list does not match Module context!", &Attrs, V);
2499 for (const auto &AttrSet : Attrs) {
2500 Check(!AttrSet.hasAttributes() || AttrSet.hasParentContext(Context),
2501 "Attribute set does not match Module context!", &AttrSet, V);
2502 for (const auto &A : AttrSet) {
2503 Check(A.hasParentContext(Context),
2504 "Attribute does not match Module context!", &A, V);
2505 }
2506 }
2507 }
2508
2509 bool SawNest = false;
2510 bool SawReturned = false;
2511 bool SawSRet = false;
2512 bool SawSwiftSelf = false;
2513 bool SawSwiftAsync = false;
2514 bool SawSwiftError = false;
2515
2516 // Verify return value attributes.
2517 AttributeSet RetAttrs = Attrs.getRetAttrs();
2518 for (Attribute RetAttr : RetAttrs)
2519 Check(RetAttr.isStringAttribute() ||
2520 Attribute::canUseAsRetAttr(RetAttr.getKindAsEnum()),
2521 "Attribute '" + RetAttr.getAsString() +
2522 "' does not apply to function return values",
2523 V);
2524
2525 unsigned MaxParameterWidth = 0;
2526 auto GetMaxParameterWidth = [&MaxParameterWidth](Type *Ty) {
2527 if (Ty->isVectorTy()) {
2528 if (auto *VT = dyn_cast<FixedVectorType>(Ty)) {
2529 unsigned Size = VT->getPrimitiveSizeInBits().getFixedValue();
2530 if (Size > MaxParameterWidth)
2531 MaxParameterWidth = Size;
2532 }
2533 }
2534 };
2535 GetMaxParameterWidth(FT->getReturnType());
2536 verifyParameterAttrs(RetAttrs, FT->getReturnType(), V);
2537
2538 // Verify parameter attributes.
2539 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2540 Type *Ty = FT->getParamType(i);
2541 AttributeSet ArgAttrs = Attrs.getParamAttrs(i);
2542
2543 if (!IsIntrinsic) {
2544 Check(!ArgAttrs.hasAttribute(Attribute::ImmArg),
2545 "immarg attribute only applies to intrinsics", V);
2546 if (!IsInlineAsm)
2547 Check(!ArgAttrs.hasAttribute(Attribute::ElementType),
2548 "Attribute 'elementtype' can only be applied to intrinsics"
2549 " and inline asm.",
2550 V);
2551 }
2552
2553 verifyParameterAttrs(ArgAttrs, Ty, V);
2554 GetMaxParameterWidth(Ty);
2555
2556 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
2557 Check(!SawNest, "More than one parameter has attribute nest!", V);
2558 SawNest = true;
2559 }
2560
2561 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
2562 Check(!SawReturned, "More than one parameter has attribute returned!", V);
2563 Check(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
2564 "Incompatible argument and return types for 'returned' attribute",
2565 V);
2566 SawReturned = true;
2567 }
2568
2569 if (ArgAttrs.hasAttribute(Attribute::StructRet)) {
2570 Check(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
2571 Check(i == 0 || i == 1,
2572 "Attribute 'sret' is not on first or second parameter!", V);
2573 SawSRet = true;
2574 }
2575
2576 if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) {
2577 Check(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
2578 SawSwiftSelf = true;
2579 }
2580
2581 if (ArgAttrs.hasAttribute(Attribute::SwiftAsync)) {
2582 Check(!SawSwiftAsync, "Cannot have multiple 'swiftasync' parameters!", V);
2583 SawSwiftAsync = true;
2584 }
2585
2586 if (ArgAttrs.hasAttribute(Attribute::SwiftError)) {
2587 Check(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!", V);
2588 SawSwiftError = true;
2589 }
2590
2591 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) {
2592 Check(i == FT->getNumParams() - 1,
2593 "inalloca isn't on the last parameter!", V);
2594 }
2595 }
2596
2597 if (!Attrs.hasFnAttrs())
2598 return;
2599
2600 verifyAttributeTypes(Attrs.getFnAttrs(), V);
2601 for (Attribute FnAttr : Attrs.getFnAttrs())
2602 Check(FnAttr.isStringAttribute() ||
2603 Attribute::canUseAsFnAttr(FnAttr.getKindAsEnum()),
2604 "Attribute '" + FnAttr.getAsString() +
2605 "' does not apply to functions!",
2606 V);
2607
2608 Check(!(Attrs.hasFnAttr(Attribute::NoInline) &&
2609 Attrs.hasFnAttr(Attribute::AlwaysInline)),
2610 "Attributes 'noinline and alwaysinline' are incompatible!", V);
2611
2612 if (Attrs.hasFnAttr(Attribute::OptimizeNone)) {
2613 Check(Attrs.hasFnAttr(Attribute::NoInline),
2614 "Attribute 'optnone' requires 'noinline'!", V);
2615
2616 Check(!Attrs.hasFnAttr(Attribute::OptimizeForSize),
2617 "Attributes 'optsize and optnone' are incompatible!", V);
2618
2619 Check(!Attrs.hasFnAttr(Attribute::MinSize),
2620 "Attributes 'minsize and optnone' are incompatible!", V);
2621
2622 Check(!Attrs.hasFnAttr(Attribute::OptimizeForDebugging),
2623 "Attributes 'optdebug and optnone' are incompatible!", V);
2624 }
2625
2626 Check(!(Attrs.hasFnAttr(Attribute::SanitizeRealtime) &&
2627 Attrs.hasFnAttr(Attribute::SanitizeRealtimeBlocking)),
2628 "Attributes "
2629 "'sanitize_realtime and sanitize_realtime_blocking' are incompatible!",
2630 V);
2631
2632 Check(!(Attrs.hasFnAttr(Attribute::SanitizeThread) &&
2633 Attrs.hasFnAttr(Attribute::SanitizeConcurrency)),
2634 "Attributes 'sanitize_thread and sanitize_concurrency' are "
2635 "incompatible!",
2636 V);
2637
2638 if (Attrs.hasFnAttr(Attribute::OptimizeForDebugging)) {
2639 Check(!Attrs.hasFnAttr(Attribute::OptimizeForSize),
2640 "Attributes 'optsize and optdebug' are incompatible!", V);
2641
2642 Check(!Attrs.hasFnAttr(Attribute::MinSize),
2643 "Attributes 'minsize and optdebug' are incompatible!", V);
2644 }
2645
2646 Check(!Attrs.hasAttrSomewhere(Attribute::Writable) ||
2647 isModSet(Attrs.getMemoryEffects().getModRef(IRMemLocation::ArgMem)),
2648 "Attribute writable and memory without argmem: write are incompatible!",
2649 V);
2650
2651 if (Attrs.hasFnAttr("aarch64_pstate_sm_enabled")) {
2652 Check(!Attrs.hasFnAttr("aarch64_pstate_sm_compatible"),
2653 "Attributes 'aarch64_pstate_sm_enabled and "
2654 "aarch64_pstate_sm_compatible' are incompatible!",
2655 V);
2656 }
2657
2658 Check((Attrs.hasFnAttr("aarch64_new_za") + Attrs.hasFnAttr("aarch64_in_za") +
2659 Attrs.hasFnAttr("aarch64_inout_za") +
2660 Attrs.hasFnAttr("aarch64_out_za") +
2661 Attrs.hasFnAttr("aarch64_preserves_za") +
2662 Attrs.hasFnAttr("aarch64_za_state_agnostic")) <= 1,
2663 "Attributes 'aarch64_new_za', 'aarch64_in_za', 'aarch64_out_za', "
2664 "'aarch64_inout_za', 'aarch64_preserves_za' and "
2665 "'aarch64_za_state_agnostic' are mutually exclusive",
2666 V);
2667
2668 Check((Attrs.hasFnAttr("aarch64_new_zt0") +
2669 Attrs.hasFnAttr("aarch64_in_zt0") +
2670 Attrs.hasFnAttr("aarch64_inout_zt0") +
2671 Attrs.hasFnAttr("aarch64_out_zt0") +
2672 Attrs.hasFnAttr("aarch64_preserves_zt0") +
2673 Attrs.hasFnAttr("aarch64_za_state_agnostic")) <= 1,
2674 "Attributes 'aarch64_new_zt0', 'aarch64_in_zt0', 'aarch64_out_zt0', "
2675 "'aarch64_inout_zt0', 'aarch64_preserves_zt0' and "
2676 "'aarch64_za_state_agnostic' are mutually exclusive",
2677 V);
2678
2679 if (Attrs.hasFnAttr(Attribute::JumpTable)) {
2680 const GlobalValue *GV = cast<GlobalValue>(V);
2682 "Attribute 'jumptable' requires 'unnamed_addr'", V);
2683 }
2684
2685 if (auto Args = Attrs.getFnAttrs().getAllocSizeArgs()) {
2686 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
2687 if (ParamNo >= FT->getNumParams()) {
2688 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
2689 return false;
2690 }
2691
2692 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
2693 CheckFailed("'allocsize' " + Name +
2694 " argument must refer to an integer parameter",
2695 V);
2696 return false;
2697 }
2698
2699 return true;
2700 };
2701
2702 if (!CheckParam("element size", Args->first))
2703 return;
2704
2705 if (Args->second && !CheckParam("number of elements", *Args->second))
2706 return;
2707 }
2708
2709 if (Attrs.hasFnAttr(Attribute::AllocKind)) {
2710 AllocFnKind K = Attrs.getAllocKind();
2712 K & (AllocFnKind::Alloc | AllocFnKind::Realloc | AllocFnKind::Free);
2713 if (!is_contained(
2714 {AllocFnKind::Alloc, AllocFnKind::Realloc, AllocFnKind::Free},
2715 Type))
2716 CheckFailed(
2717 "'allockind()' requires exactly one of alloc, realloc, and free");
2718 if ((Type == AllocFnKind::Free) &&
2719 ((K & (AllocFnKind::Uninitialized | AllocFnKind::Zeroed |
2720 AllocFnKind::Aligned)) != AllocFnKind::Unknown))
2721 CheckFailed("'allockind(\"free\")' doesn't allow uninitialized, zeroed, "
2722 "or aligned modifiers.");
2723 AllocFnKind ZeroedUninit = AllocFnKind::Uninitialized | AllocFnKind::Zeroed;
2724 if ((K & ZeroedUninit) == ZeroedUninit)
2725 CheckFailed("'allockind()' can't be both zeroed and uninitialized");
2726 }
2727
2728 if (Attribute A = Attrs.getFnAttr("alloc-variant-zeroed"); A.isValid()) {
2729 StringRef S = A.getValueAsString();
2730 Check(!S.empty(), "'alloc-variant-zeroed' must not be empty");
2731 Function *Variant = M.getFunction(S);
2732 if (Variant) {
2733 Attribute Family = Attrs.getFnAttr("alloc-family");
2734 Attribute VariantFamily = Variant->getFnAttribute("alloc-family");
2735 if (Family.isValid())
2736 Check(VariantFamily.isValid() &&
2737 VariantFamily.getValueAsString() == Family.getValueAsString(),
2738 "'alloc-variant-zeroed' must name a function belonging to the "
2739 "same 'alloc-family'");
2740
2741 Check(Variant->hasFnAttribute(Attribute::AllocKind) &&
2742 (Variant->getFnAttribute(Attribute::AllocKind).getAllocKind() &
2743 AllocFnKind::Zeroed) != AllocFnKind::Unknown,
2744 "'alloc-variant-zeroed' must name a function with "
2745 "'allockind(\"zeroed\")'");
2746
2747 Check(FT == Variant->getFunctionType(),
2748 "'alloc-variant-zeroed' must name a function with the same "
2749 "signature");
2750
2751 if (const auto *F = dyn_cast<Function>(V))
2752 Check(F->getCallingConv() == Variant->getCallingConv(),
2753 "'alloc-variant-zeroed' must name a function with the same "
2754 "calling convention");
2755 }
2756 }
2757
2758 if (Attrs.hasFnAttr(Attribute::VScaleRange)) {
2759 unsigned VScaleMin = Attrs.getFnAttrs().getVScaleRangeMin();
2760 if (VScaleMin == 0)
2761 CheckFailed("'vscale_range' minimum must be greater than 0", V);
2762 else if (!isPowerOf2_32(VScaleMin))
2763 CheckFailed("'vscale_range' minimum must be power-of-two value", V);
2764 std::optional<unsigned> VScaleMax = Attrs.getFnAttrs().getVScaleRangeMax();
2765 if (VScaleMax && VScaleMin > VScaleMax)
2766 CheckFailed("'vscale_range' minimum cannot be greater than maximum", V);
2767 else if (VScaleMax && !isPowerOf2_32(*VScaleMax))
2768 CheckFailed("'vscale_range' maximum must be power-of-two value", V);
2769 }
2770
2771 if (Attribute FPAttr = Attrs.getFnAttr("frame-pointer"); FPAttr.isValid()) {
2772 StringRef FP = FPAttr.getValueAsString();
2773 if (FP != "all" && FP != "non-leaf" && FP != "none" && FP != "reserved" &&
2774 FP != "non-leaf-no-reserve")
2775 CheckFailed("invalid value for 'frame-pointer' attribute: " + FP, V);
2776 }
2777
2778 checkUnsignedBaseTenFuncAttr(Attrs, "tail-pad-to-size", V);
2779 checkUnsignedBaseTenFuncAttr(Attrs, "tail-pad-value", V);
2780 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-prefix", V);
2781 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-entry", V);
2782 if (Attrs.hasFnAttr("patchable-function-entry-section"))
2783 Check(!Attrs.getFnAttr("patchable-function-entry-section")
2784 .getValueAsString()
2785 .empty(),
2786 "\"patchable-function-entry-section\" must not be empty");
2787 checkUnsignedBaseTenFuncAttr(Attrs, "warn-stack-size", V);
2788 checkUnsignedBaseTenFuncAttr(Attrs, "unsafe-stack-size", V);
2789 for (StringLiteral Attr : NVVMAttr::AbiPreserveAttrs)
2790 checkUnsignedBaseTenFuncAttr(Attrs, Attr, V);
2791
2792 if (auto A = Attrs.getFnAttr("sign-return-address"); A.isValid()) {
2793 StringRef S = A.getValueAsString();
2794 if (S != "none" && S != "all" && S != "non-leaf")
2795 CheckFailed("invalid value for 'sign-return-address' attribute: " + S, V);
2796 }
2797
2798 if (auto A = Attrs.getFnAttr("sign-return-address-key"); A.isValid()) {
2799 StringRef S = A.getValueAsString();
2800 if (S != "a_key" && S != "b_key")
2801 CheckFailed("invalid value for 'sign-return-address-key' attribute: " + S,
2802 V);
2803 if (auto AA = Attrs.getFnAttr("sign-return-address"); !AA.isValid()) {
2804 CheckFailed(
2805 "'sign-return-address-key' present without `sign-return-address`");
2806 }
2807 }
2808
2809 if (auto A = Attrs.getFnAttr("sign-return-address-harden"); A.isValid()) {
2810 StringRef S = A.getValueAsString();
2811 if (S != "load-return-address" && S != "none")
2812 CheckFailed(
2813 "invalid value for 'sign-return-address-harden' attribute: " + S, V);
2814 auto SignRetA = Attrs.getFnAttr("sign-return-address");
2815 auto PAuthRetA = Attrs.getFnAttr("ptrauth-returns");
2816 if (!SignRetA.isValid() && !PAuthRetA.isValid())
2817 CheckFailed("'sign-return-address-harden' present without "
2818 "'sign-return-address' or 'ptrauth-returns'");
2819 }
2820
2821 if (auto A = Attrs.getFnAttr("branch-target-enforcement"); A.isValid()) {
2822 StringRef S = A.getValueAsString();
2823 if (S != "" && S != "true" && S != "false")
2824 CheckFailed(
2825 "invalid value for 'branch-target-enforcement' attribute: " + S, V);
2826 }
2827
2828 if (auto A = Attrs.getFnAttr("branch-protection-pauth-lr"); A.isValid()) {
2829 StringRef S = A.getValueAsString();
2830 if (S != "" && S != "true" && S != "false")
2831 CheckFailed(
2832 "invalid value for 'branch-protection-pauth-lr' attribute: " + S, V);
2833 }
2834
2835 if (auto A = Attrs.getFnAttr("guarded-control-stack"); A.isValid()) {
2836 StringRef S = A.getValueAsString();
2837 if (S != "" && S != "true" && S != "false")
2838 CheckFailed("invalid value for 'guarded-control-stack' attribute: " + S,
2839 V);
2840 }
2841
2842 if (auto A = Attrs.getFnAttr("vector-function-abi-variant"); A.isValid()) {
2843 StringRef S = A.getValueAsString();
2844 const std::optional<VFInfo> Info = VFABI::tryDemangleForVFABI(S, FT);
2845 if (!Info)
2846 CheckFailed("invalid name for a VFABI variant: " + S, V);
2847 }
2848
2849 if (auto A = Attrs.getFnAttr("modular-format"); A.isValid()) {
2850 StringRef S = A.getValueAsString();
2852 S.split(Args, ',');
2853 Check(Args.size() >= 5,
2854 "modular-format attribute requires at least 5 arguments", V);
2855 unsigned UpperBound = FT->getNumParams() + (FT->isVarArg() ? 1 : 0);
2856 unsigned FormatIdx;
2857 Check(!Args[1].getAsInteger(10, FormatIdx),
2858 "modular-format attribute format string index is not an integer", V);
2859 Check(FormatIdx > 0,
2860 "modular-format attribute format string index must be greater than 0",
2861 V);
2862 Check(FormatIdx <= UpperBound,
2863 "modular-format attribute format string index is out of bounds", V);
2864 unsigned FirstArgIdx;
2865 Check(!Args[2].getAsInteger(10, FirstArgIdx),
2866 "modular-format attribute first arg index is not an integer", V);
2867 Check(FirstArgIdx <= UpperBound,
2868 "modular-format attribute first arg index is out of bounds", V);
2869 Check(!Args[3].empty(),
2870 "modular-format attribute modular implementation function name "
2871 "cannot be empty",
2872 V);
2873 Check(!Args[4].empty(),
2874 "modular-format attribute implementation name cannot be empty", V);
2875 }
2876
2877 if (auto A = Attrs.getFnAttr("target-features"); A.isValid()) {
2878 StringRef S = A.getValueAsString();
2879 if (!S.empty()) {
2880 for (auto FeatureFlag : split(S, ',')) {
2881 if (FeatureFlag.empty())
2882 CheckFailed(
2883 "target-features attribute should not contain an empty string");
2884 else
2885 Check(FeatureFlag[0] == '+' || FeatureFlag[0] == '-',
2886 "target feature '" + FeatureFlag +
2887 "' must start with a '+' or '-'",
2888 V);
2889 }
2890 }
2891 }
2892
2893 Check(!(Attrs.hasFnAttr(Attribute::Hot) && Attrs.hasFnAttr(Attribute::Cold)),
2894 "Attributes 'hot' and 'cold' are incompatible");
2895
2896 if (Attrs.hasFnAttr("mnop-mcount")) {
2897 auto A = Attrs.getFnAttr("fentry-call");
2898 Check(A.isValid() && A.getValueAsString() == "true",
2899 "mnop-mcount only supported with fentry-call");
2900 }
2901
2902 if (Attrs.hasFnAttr("mrecord-mcount")) {
2903 auto A = Attrs.getFnAttr("fentry-call");
2904 Check(A.isValid() && A.getValueAsString() == "true",
2905 "mrecord-mcount only supported with fentry-call");
2906 }
2907}
2908
2909void Verifier::verifyUnknownProfileMetadata(MDNode *MD) {
2910 Check(MD->getNumOperands() == 2,
2911 "'unknown' !prof should have a single additional operand", MD);
2912 auto *PassName = dyn_cast<MDString>(MD->getOperand(1));
2913 Check(PassName != nullptr,
2914 "'unknown' !prof should have an additional operand of type "
2915 "string");
2916 Check(!PassName->getString().empty(),
2917 "the 'unknown' !prof operand should not be an empty string");
2918}
2919
2920void Verifier::verifyFunctionMetadata(
2921 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
2922 for (const auto &Pair : MDs) {
2923 if (Pair.first == LLVMContext::MD_prof) {
2924 MDNode *MD = Pair.second;
2925 Check(MD->getNumOperands() >= 2,
2926 "!prof annotations should have no less than 2 operands", MD);
2927 // We may have functions that are synthesized by the compiler, e.g. in
2928 // WPD, that we can't currently determine the entry count.
2929 if (MD->getOperand(0).equalsStr(
2931 verifyUnknownProfileMetadata(MD);
2932 continue;
2933 }
2934
2935 // Check first operand.
2936 Check(MD->getOperand(0) != nullptr, "first operand should not be null",
2937 MD);
2939 "expected string with name of the !prof annotation", MD);
2940 MDString *MDS = cast<MDString>(MD->getOperand(0));
2941 StringRef ProfName = MDS->getString();
2943 "first operand should be 'function_entry_count'", MD);
2944
2945 // Check second operand.
2946 Check(MD->getOperand(1) != nullptr, "second operand should not be null",
2947 MD);
2949 "expected integer argument to function_entry_count", MD);
2950 } else if (Pair.first == LLVMContext::MD_kcfi_type) {
2951 MDNode *MD = Pair.second;
2952 Check(MD->getNumOperands() == 1,
2953 "!kcfi_type must have exactly one operand", MD);
2954 Check(MD->getOperand(0) != nullptr, "!kcfi_type operand must not be null",
2955 MD);
2957 "expected a constant operand for !kcfi_type", MD);
2958 Constant *C = cast<ConstantAsMetadata>(MD->getOperand(0))->getValue();
2959 Check(isa<ConstantInt>(C) && isa<IntegerType>(C->getType()),
2960 "expected a constant integer operand for !kcfi_type", MD);
2962 "expected a 32-bit integer constant operand for !kcfi_type", MD);
2963 } else if (Pair.first == Context.getMDKindID("reqd_work_group_size")) {
2964 MDNode *MD = Pair.second;
2965 Check(MD->getNumOperands() == 3,
2966 "reqd_work_group_size must have exactly three operands", MD);
2967 if (MD->getNumOperands() != 3)
2968 continue;
2969
2970 uint64_t Product = 1;
2971 for (unsigned I = 0; I != 3; ++I) {
2972 ConstantInt *C = mdconst::dyn_extract<ConstantInt>(MD->getOperand(I));
2973 Check(C, "reqd_work_group_size operands must be integer constants", MD);
2974 if (!C)
2975 break;
2976
2977 const APInt &Value = C->getValue();
2978 Check(Value.getActiveBits() <= 64,
2979 "reqd_work_group_size operands must fit in 64 bits", MD);
2980 if (Value.getActiveBits() > 64)
2981 break;
2982
2983 uint64_t Dim = Value.getZExtValue();
2984 Check(Dim == 0 || Product <= std::numeric_limits<uint64_t>::max() / Dim,
2985 "reqd_work_group_size product must fit in 64 bits", MD);
2986 if (Dim != 0 && Product > std::numeric_limits<uint64_t>::max() / Dim)
2987 break;
2988 Product *= Dim;
2989 }
2990 }
2991 }
2992}
2993
2994void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
2995 if (EntryC->getNumOperands() == 0)
2996 return;
2997
2998 if (!ConstantExprVisited.insert(EntryC).second)
2999 return;
3000
3002 Stack.push_back(EntryC);
3003
3004 while (!Stack.empty()) {
3005 const Constant *C = Stack.pop_back_val();
3006
3007 // Check this constant expression.
3008 if (const auto *CE = dyn_cast<ConstantExpr>(C))
3009 visitConstantExpr(CE);
3010
3011 if (const auto *CPA = dyn_cast<ConstantPtrAuth>(C))
3012 visitConstantPtrAuth(CPA);
3013
3014 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
3015 // Global Values get visited separately, but we do need to make sure
3016 // that the global value is in the correct module
3017 Check(GV->getParent() == &M, "Referencing global in another module!",
3018 EntryC, &M, GV, GV->getParent());
3019 continue;
3020 }
3021
3022 // Visit all sub-expressions.
3023 for (const Use &U : C->operands()) {
3024 const auto *OpC = dyn_cast<Constant>(U);
3025 if (!OpC)
3026 continue;
3027 if (!ConstantExprVisited.insert(OpC).second)
3028 continue;
3029 Stack.push_back(OpC);
3030 }
3031 }
3032}
3033
3034void Verifier::visitConstantExpr(const ConstantExpr *CE) {
3035 if (CE->getOpcode() == Instruction::BitCast) {
3036 Check(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
3037 CE->getType()),
3038 "Invalid bitcast", CE);
3039 Check(DL.getTypeSizeInBits(CE->getOperand(0)->getType()) ==
3040 DL.getTypeSizeInBits(CE->getType()),
3041 "Invalid bitcast", CE);
3042 } else if (CE->getOpcode() == Instruction::PtrToAddr)
3043 checkPtrToAddr(CE->getOperand(0)->getType(), CE->getType(), *CE);
3044 else if (CE->getOpcode() == Instruction::GetElementPtr)
3045 checkGEPOperator(cast<GEPOperator>(*CE));
3046}
3047
3048void Verifier::visitConstantPtrAuth(const ConstantPtrAuth *CPA) {
3049 Check(CPA->getPointer()->getType()->isPointerTy(),
3050 "signed ptrauth constant base pointer must have pointer type");
3051
3052 Check(CPA->getType() == CPA->getPointer()->getType(),
3053 "signed ptrauth constant must have same type as its base pointer");
3054
3055 Check(CPA->getKey()->getBitWidth() == 32,
3056 "signed ptrauth constant key must be i32 constant integer");
3057
3059 "signed ptrauth constant address discriminator must be a pointer");
3060
3061 Check(CPA->getDiscriminator()->getBitWidth() == 64,
3062 "signed ptrauth constant discriminator must be i64 constant integer");
3063
3065 "signed ptrauth constant deactivation symbol must be a pointer");
3066
3069 "signed ptrauth constant deactivation symbol must be a global value "
3070 "or null");
3071}
3072
3073bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) {
3074 // There shouldn't be more attribute sets than there are parameters plus the
3075 // function and return value.
3076 return Attrs.getNumAttrSets() <= Params + 2;
3077}
3078
3079void Verifier::verifyInlineAsmCall(const CallBase &Call) {
3080 const InlineAsm *IA = cast<InlineAsm>(Call.getCalledOperand());
3081 unsigned ArgNo = 0;
3082 unsigned LabelNo = 0;
3083 for (const InlineAsm::ConstraintInfo &CI : IA->ParseConstraints()) {
3084 if (CI.Type == InlineAsm::isLabel) {
3085 ++LabelNo;
3086 continue;
3087 }
3088
3089 // Only deal with constraints that correspond to call arguments.
3090 if (!CI.hasArg())
3091 continue;
3092
3093 if (CI.isIndirect) {
3094 const Value *Arg = Call.getArgOperand(ArgNo);
3095 Check(Arg->getType()->isPointerTy(),
3096 "Operand for indirect constraint must have pointer type", &Call);
3097
3099 "Operand for indirect constraint must have elementtype attribute",
3100 &Call);
3101 } else {
3102 Check(!Call.paramHasAttr(ArgNo, Attribute::ElementType),
3103 "Elementtype attribute can only be applied for indirect "
3104 "constraints",
3105 &Call);
3106 }
3107
3108 ArgNo++;
3109 }
3110
3111 if (auto *CallBr = dyn_cast<CallBrInst>(&Call)) {
3112 Check(LabelNo == CallBr->getNumIndirectDests(),
3113 "Number of label constraints does not match number of callbr dests",
3114 &Call);
3115 } else {
3116 Check(LabelNo == 0, "Label constraints can only be used with callbr",
3117 &Call);
3118 }
3119}
3120
3121/// Verify that statepoint intrinsic is well formed.
3122void Verifier::verifyStatepoint(const CallBase &Call) {
3123 assert(Call.getIntrinsicID() == Intrinsic::experimental_gc_statepoint);
3124
3127 "gc.statepoint must read and write all memory to preserve "
3128 "reordering restrictions required by safepoint semantics",
3129 Call);
3130
3131 const int64_t NumPatchBytes =
3132 cast<ConstantInt>(Call.getArgOperand(1))->getSExtValue();
3133 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
3134 Check(NumPatchBytes >= 0,
3135 "gc.statepoint number of patchable bytes must be "
3136 "positive",
3137 Call);
3138
3139 Type *TargetElemType = Call.getParamElementType(2);
3140 Check(TargetElemType,
3141 "gc.statepoint callee argument must have elementtype attribute", Call);
3142 auto *TargetFuncType = dyn_cast<FunctionType>(TargetElemType);
3143 Check(TargetFuncType,
3144 "gc.statepoint callee elementtype must be function type", Call);
3145
3146 const int NumCallArgs = cast<ConstantInt>(Call.getArgOperand(3))->getZExtValue();
3147 Check(NumCallArgs >= 0,
3148 "gc.statepoint number of arguments to underlying call "
3149 "must be positive",
3150 Call);
3151 const int NumParams = (int)TargetFuncType->getNumParams();
3152 if (TargetFuncType->isVarArg()) {
3153 Check(NumCallArgs >= NumParams,
3154 "gc.statepoint mismatch in number of vararg call args", Call);
3155
3156 // TODO: Remove this limitation
3157 Check(TargetFuncType->getReturnType()->isVoidTy(),
3158 "gc.statepoint doesn't support wrapping non-void "
3159 "vararg functions yet",
3160 Call);
3161 } else
3162 Check(NumCallArgs == NumParams,
3163 "gc.statepoint mismatch in number of call args", Call);
3164
3165 const uint64_t Flags
3166 = cast<ConstantInt>(Call.getArgOperand(4))->getZExtValue();
3167 Check((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
3168 "unknown flag used in gc.statepoint flags argument", Call);
3169
3170 // Verify that the types of the call parameter arguments match
3171 // the type of the wrapped callee.
3172 AttributeList Attrs = Call.getAttributes();
3173 for (int i = 0; i < NumParams; i++) {
3174 Type *ParamType = TargetFuncType->getParamType(i);
3175 Type *ArgType = Call.getArgOperand(5 + i)->getType();
3176 Check(ArgType == ParamType,
3177 "gc.statepoint call argument does not match wrapped "
3178 "function type",
3179 Call);
3180
3181 if (TargetFuncType->isVarArg()) {
3182 AttributeSet ArgAttrs = Attrs.getParamAttrs(5 + i);
3183 Check(!ArgAttrs.hasAttribute(Attribute::StructRet),
3184 "Attribute 'sret' cannot be used for vararg call arguments!", Call);
3185 }
3186 }
3187
3188 const int EndCallArgsInx = 4 + NumCallArgs;
3189
3190 const Value *NumTransitionArgsV = Call.getArgOperand(EndCallArgsInx + 1);
3191 Check(isa<ConstantInt>(NumTransitionArgsV),
3192 "gc.statepoint number of transition arguments "
3193 "must be constant integer",
3194 Call);
3195 const int NumTransitionArgs =
3196 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
3197 Check(NumTransitionArgs == 0,
3198 "gc.statepoint w/inline transition bundle is deprecated", Call);
3199 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
3200
3201 const Value *NumDeoptArgsV = Call.getArgOperand(EndTransitionArgsInx + 1);
3202 Check(isa<ConstantInt>(NumDeoptArgsV),
3203 "gc.statepoint number of deoptimization arguments "
3204 "must be constant integer",
3205 Call);
3206 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
3207 Check(NumDeoptArgs == 0,
3208 "gc.statepoint w/inline deopt operands is deprecated", Call);
3209
3210 const int ExpectedNumArgs = 7 + NumCallArgs;
3211 Check(ExpectedNumArgs == (int)Call.arg_size(),
3212 "gc.statepoint too many arguments", Call);
3213
3214 // Check that the only uses of this gc.statepoint are gc.result or
3215 // gc.relocate calls which are tied to this statepoint and thus part
3216 // of the same statepoint sequence
3217 for (const User *U : Call.users()) {
3218 const auto *UserCall = dyn_cast<const CallInst>(U);
3219 Check(UserCall, "illegal use of statepoint token", Call, U);
3220 if (!UserCall)
3221 continue;
3222 Check(isa<GCRelocateInst>(UserCall) || isa<GCResultInst>(UserCall),
3223 "gc.result or gc.relocate are the only value uses "
3224 "of a gc.statepoint",
3225 Call, U);
3226 if (isa<GCResultInst>(UserCall)) {
3227 Check(UserCall->getArgOperand(0) == &Call,
3228 "gc.result connected to wrong gc.statepoint", Call, UserCall);
3229 } else if (isa<GCRelocateInst>(Call)) {
3230 Check(UserCall->getArgOperand(0) == &Call,
3231 "gc.relocate connected to wrong gc.statepoint", Call, UserCall);
3232 }
3233 }
3234
3235 // Note: It is legal for a single derived pointer to be listed multiple
3236 // times. It's non-optimal, but it is legal. It can also happen after
3237 // insertion if we strip a bitcast away.
3238 // Note: It is really tempting to check that each base is relocated and
3239 // that a derived pointer is never reused as a base pointer. This turns
3240 // out to be problematic since optimizations run after safepoint insertion
3241 // can recognize equality properties that the insertion logic doesn't know
3242 // about. See example statepoint.ll in the verifier subdirectory
3243}
3244
3245void Verifier::verifyFrameRecoverIndices() {
3246 for (auto &Counts : FrameEscapeInfo) {
3247 Function *F = Counts.first;
3248 unsigned EscapedObjectCount = Counts.second.first;
3249 unsigned MaxRecoveredIndex = Counts.second.second;
3250 Check(MaxRecoveredIndex <= EscapedObjectCount,
3251 "all indices passed to llvm.localrecover must be less than the "
3252 "number of arguments passed to llvm.localescape in the parent "
3253 "function",
3254 F);
3255 }
3256}
3257
3258static Instruction *getSuccPad(Instruction *Terminator) {
3259 BasicBlock *UnwindDest;
3260 if (auto *II = dyn_cast<InvokeInst>(Terminator))
3261 UnwindDest = II->getUnwindDest();
3262 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
3263 UnwindDest = CSI->getUnwindDest();
3264 else
3265 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
3266 return &*UnwindDest->getFirstNonPHIIt();
3267}
3268
3269void Verifier::verifySiblingFuncletUnwinds() {
3270 llvm::TimeTraceScope timeScope("Verifier verify sibling funclet unwinds");
3271 SmallPtrSet<Instruction *, 8> Visited;
3272 SmallPtrSet<Instruction *, 8> Active;
3273 for (const auto &Pair : SiblingFuncletInfo) {
3274 Instruction *PredPad = Pair.first;
3275 if (Visited.count(PredPad))
3276 continue;
3277 Active.insert(PredPad);
3278 Instruction *Terminator = Pair.second;
3279 do {
3280 Instruction *SuccPad = getSuccPad(Terminator);
3281 if (Active.count(SuccPad)) {
3282 // Found a cycle; report error
3283 Instruction *CyclePad = SuccPad;
3284 SmallVector<Instruction *, 8> CycleNodes;
3285 do {
3286 CycleNodes.push_back(CyclePad);
3287 Instruction *CycleTerminator = SiblingFuncletInfo[CyclePad];
3288 if (CycleTerminator != CyclePad)
3289 CycleNodes.push_back(CycleTerminator);
3290 CyclePad = getSuccPad(CycleTerminator);
3291 } while (CyclePad != SuccPad);
3292 Check(false, "EH pads can't handle each other's exceptions",
3293 ArrayRef<Instruction *>(CycleNodes));
3294 }
3295 // Don't re-walk a node we've already checked
3296 if (!Visited.insert(SuccPad).second)
3297 break;
3298 // Walk to this successor if it has a map entry.
3299 PredPad = SuccPad;
3300 auto TermI = SiblingFuncletInfo.find(PredPad);
3301 if (TermI == SiblingFuncletInfo.end())
3302 break;
3303 Terminator = TermI->second;
3304 Active.insert(PredPad);
3305 } while (true);
3306 // Each node only has one successor, so we've walked all the active
3307 // nodes' successors.
3308 Active.clear();
3309 }
3310}
3311
3312// visitFunction - Verify that a function is ok.
3313//
3314void Verifier::visitFunction(const Function &F) {
3315 visitGlobalValue(F);
3316
3317 // Check function arguments.
3318 FunctionType *FT = F.getFunctionType();
3319 unsigned NumArgs = F.arg_size();
3320
3321 Check(&Context == &F.getContext(),
3322 "Function context does not match Module context!", &F);
3323
3324 Check(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
3325 Check(FT->getNumParams() == NumArgs,
3326 "# formal arguments must match # of arguments for function type!", &F,
3327 FT);
3328 Check(F.getReturnType()->isFirstClassType() ||
3329 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
3330 "Functions cannot return aggregate values!", &F);
3331
3332 Check(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
3333 "Invalid struct return type!", &F);
3334
3335 if (MaybeAlign A = F.getAlign()) {
3336 Check(A->value() <= Value::MaximumAlignment,
3337 "huge alignment values are unsupported", &F);
3338 }
3339
3340 AttributeList Attrs = F.getAttributes();
3341
3342 Check(verifyAttributeCount(Attrs, FT->getNumParams()),
3343 "Attribute after last parameter!", &F);
3344
3345 bool IsIntrinsic = F.isIntrinsic();
3346
3347 // Check function attributes.
3348 verifyFunctionAttrs(FT, Attrs, &F, IsIntrinsic, /* IsInlineAsm */ false);
3349
3350 // On function declarations/definitions, we do not support the builtin
3351 // attribute. We do not check this in VerifyFunctionAttrs since that is
3352 // checking for Attributes that can/can not ever be on functions.
3353 Check(!Attrs.hasFnAttr(Attribute::Builtin),
3354 "Attribute 'builtin' can only be applied to a callsite.", &F);
3355
3356 Check(!Attrs.hasAttrSomewhere(Attribute::ElementType),
3357 "Attribute 'elementtype' can only be applied to a callsite.", &F);
3358
3359 if (Attrs.hasFnAttr(Attribute::Naked))
3360 for (const Argument &Arg : F.args())
3361 Check(Arg.use_empty(), "cannot use argument of naked function", &Arg);
3362
3363 // Check that this function meets the restrictions on this calling convention.
3364 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
3365 // restrictions can be lifted.
3366 switch (F.getCallingConv()) {
3367 default:
3368 case CallingConv::C:
3369 break;
3370 case CallingConv::X86_INTR: {
3371 Check(F.arg_empty() || Attrs.hasParamAttr(0, Attribute::ByVal),
3372 "Calling convention parameter requires byval", &F);
3373 break;
3374 }
3375 case CallingConv::AMDGPU_KERNEL:
3376 case CallingConv::SPIR_KERNEL:
3377 case CallingConv::AMDGPU_CS_Chain:
3378 case CallingConv::AMDGPU_CS_ChainPreserve:
3379 Check(F.getReturnType()->isVoidTy(),
3380 "Calling convention requires void return type", &F);
3381 [[fallthrough]];
3382 case CallingConv::AMDGPU_VS:
3383 case CallingConv::AMDGPU_HS:
3384 case CallingConv::AMDGPU_GS:
3385 case CallingConv::AMDGPU_PS:
3386 case CallingConv::AMDGPU_CS:
3387 Check(!F.hasStructRetAttr(), "Calling convention does not allow sret", &F);
3388 if (F.getCallingConv() != CallingConv::SPIR_KERNEL) {
3389 const unsigned StackAS = DL.getAllocaAddrSpace();
3390 unsigned i = 0;
3391 for (const Argument &Arg : F.args()) {
3392 Check(!Attrs.hasParamAttr(i, Attribute::ByVal),
3393 "Calling convention disallows byval", &F);
3394 Check(!Attrs.hasParamAttr(i, Attribute::Preallocated),
3395 "Calling convention disallows preallocated", &F);
3396 Check(!Attrs.hasParamAttr(i, Attribute::InAlloca),
3397 "Calling convention disallows inalloca", &F);
3398
3399 if (Attrs.hasParamAttr(i, Attribute::ByRef)) {
3400 // FIXME: Should also disallow LDS and GDS, but we don't have the enum
3401 // value here.
3402 Check(Arg.getType()->getPointerAddressSpace() != StackAS,
3403 "Calling convention disallows stack byref", &F);
3404 }
3405
3406 ++i;
3407 }
3408 }
3409
3410 [[fallthrough]];
3411 case CallingConv::Fast:
3412 case CallingConv::Cold:
3413 case CallingConv::Intel_OCL_BI:
3414 case CallingConv::PTX_Device:
3415 Check(!F.isVarArg(),
3416 "Calling convention does not support varargs or "
3417 "perfect forwarding!",
3418 &F);
3419 break;
3420 case CallingConv::PTX_Kernel:
3421 // PTX permits the abi_preserve directives only between a .func directive
3422 // and its body, so a kernel cannot express them.
3423 for (StringLiteral Attr : NVVMAttr::AbiPreserveAttrs)
3424 Check(!F.hasFnAttribute(Attr),
3425 "'" + Attr + "' is not allowed on kernel functions", &F);
3426 Check(!F.isVarArg(),
3427 "Calling convention does not support varargs or "
3428 "perfect forwarding!",
3429 &F);
3430 break;
3431 case CallingConv::AMDGPU_Gfx_WholeWave:
3432 Check(!F.arg_empty() && F.arg_begin()->getType()->isIntegerTy(1),
3433 "Calling convention requires first argument to be i1", &F);
3434 Check(!F.arg_begin()->hasInRegAttr(),
3435 "Calling convention requires first argument to not be inreg", &F);
3436 Check(!F.isVarArg(),
3437 "Calling convention does not support varargs or "
3438 "perfect forwarding!",
3439 &F);
3440 break;
3441 }
3442
3443 // Check that the argument values match the function type for this function...
3444 unsigned i = 0;
3445 for (const Argument &Arg : F.args()) {
3446 Check(Arg.getType() == FT->getParamType(i),
3447 "Argument value does not match function argument type!", &Arg,
3448 FT->getParamType(i));
3449 Check(Arg.getType()->isFirstClassType(),
3450 "Function arguments must have first-class types!", &Arg);
3451 if (!IsIntrinsic) {
3452 Check(!Arg.getType()->isMetadataTy(),
3453 "Function takes metadata but isn't an intrinsic", &Arg, &F);
3454 Check(!Arg.getType()->isTokenLikeTy(),
3455 "Function takes token but isn't an intrinsic", &Arg, &F);
3456 Check(!Arg.getType()->isX86_AMXTy(),
3457 "Function takes x86_amx but isn't an intrinsic", &Arg, &F);
3458 }
3459
3460 // Check that swifterror argument is only used by loads and stores.
3461 if (Attrs.hasParamAttr(i, Attribute::SwiftError)) {
3462 verifySwiftErrorValue(&Arg);
3463 }
3464 ++i;
3465 }
3466
3467 if (!IsIntrinsic) {
3468 Check(!F.getReturnType()->isTokenLikeTy(),
3469 "Function returns a token but isn't an intrinsic", &F);
3470 Check(!F.getReturnType()->isX86_AMXTy(),
3471 "Function returns a x86_amx but isn't an intrinsic", &F);
3472 }
3473
3474 // Get the function metadata attachments.
3476 F.getAllMetadata(MDs);
3477 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
3478 verifyFunctionMetadata(MDs);
3479
3480 // Target-specific function metadata checks.
3482
3483 // Check validity of the personality function
3484 if (F.hasPersonalityFn()) {
3485 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
3486 if (Per)
3487 Check(Per->getParent() == F.getParent(),
3488 "Referencing personality function in another module!", &F,
3489 F.getParent(), Per, Per->getParent());
3490 }
3491
3492 // EH funclet coloring can be expensive, recompute on-demand
3493 BlockEHFuncletColors.clear();
3494
3495 if (F.isMaterializable()) {
3496 // Function has a body somewhere we can't see.
3497 Check(MDs.empty(), "unmaterialized function cannot have metadata", &F,
3498 MDs.empty() ? nullptr : MDs.front().second);
3499 } else if (F.isDeclaration()) {
3500 for (const auto &I : MDs) {
3501 // This is used for call site debug information.
3502 CheckDI(I.first != LLVMContext::MD_dbg ||
3503 !cast<DISubprogram>(I.second)->isDistinct(),
3504 "function declaration may only have a unique !dbg attachment",
3505 &F);
3506 Check(I.first != LLVMContext::MD_prof,
3507 "function declaration may not have a !prof attachment", &F);
3508
3509 // Verify the metadata itself.
3510 visitMDNode(*I.second, AreDebugLocsAllowed::Yes);
3511 }
3512 Check(!F.hasPersonalityFn(),
3513 "Function declaration shouldn't have a personality routine", &F);
3514 } else {
3515 // Verify that this function (which has a body) is not named "llvm.*". It
3516 // is not legal to define intrinsics.
3517 Check(!IsIntrinsic, "llvm intrinsics cannot be defined!", &F);
3518
3519 // Check the entry node
3520 const BasicBlock *Entry = &F.getEntryBlock();
3521 Check(pred_empty(Entry),
3522 "Entry block to function must not have predecessors!", Entry);
3523
3524 // The address of the entry block cannot be taken, unless it is dead.
3525 if (Entry->hasAddressTaken()) {
3526 Check(!BlockAddress::lookup(Entry)->isConstantUsed(),
3527 "blockaddress may not be used with the entry block!", Entry);
3528 }
3529
3530 unsigned NumDebugAttachments = 0, NumProfAttachments = 0,
3531 NumKCFIAttachments = 0;
3532 // Visit metadata attachments.
3533 for (const auto &I : MDs) {
3534 // Verify that the attachment is legal.
3535 auto AllowLocs = AreDebugLocsAllowed::No;
3536 switch (I.first) {
3537 default:
3538 break;
3539 case LLVMContext::MD_dbg: {
3540 ++NumDebugAttachments;
3541 CheckDI(NumDebugAttachments == 1,
3542 "function must have a single !dbg attachment", &F, I.second);
3543 CheckDI(isa<DISubprogram>(I.second),
3544 "function !dbg attachment must be a subprogram", &F, I.second);
3545 CheckDI(cast<DISubprogram>(I.second)->isDistinct(),
3546 "function definition may only have a distinct !dbg attachment",
3547 &F);
3548
3549 auto *SP = cast<DISubprogram>(I.second);
3550 const Function *&AttachedTo = DISubprogramAttachments[SP];
3551 CheckDI(!AttachedTo || AttachedTo == &F,
3552 "DISubprogram attached to more than one function", SP, &F);
3553 AttachedTo = &F;
3554 AllowLocs = AreDebugLocsAllowed::Yes;
3555 break;
3556 }
3557 case LLVMContext::MD_prof:
3558 ++NumProfAttachments;
3559 Check(NumProfAttachments == 1,
3560 "function must have a single !prof attachment", &F, I.second);
3561 break;
3562 case LLVMContext::MD_kcfi_type:
3563 ++NumKCFIAttachments;
3564 Check(NumKCFIAttachments == 1,
3565 "function must have a single !kcfi_type attachment", &F,
3566 I.second);
3567 break;
3568 case LLVMContext::MD_annotation:
3569 visitAnnotationMetadata(I.second);
3570 break;
3571 }
3572
3573 // Verify the metadata itself.
3574 visitMDNode(*I.second, AllowLocs);
3575 }
3576 }
3577
3578 // If this function is actually an intrinsic, verify that it is only used in
3579 // direct call/invokes, never having its "address taken".
3580 // Only do this if the module is materialized, otherwise we don't have all the
3581 // uses.
3582 bool isMaterialized = F.getParent()->isMaterialized();
3583 if (F.isIntrinsic() && isMaterialized) {
3584 const User *U;
3585 if (F.hasAddressTaken(&U, false, true, false,
3586 /*IgnoreARCAttachedCall=*/true))
3587 Check(false, "Invalid user of intrinsic instruction!", U);
3588 }
3589
3590 // Verify if the intrinsic's signature and name are valid. We do this if
3591 // the intrinsic has at least one materialized use, or if the module is fully
3592 // materialized.
3593 Intrinsic::ID IID = F.getIntrinsicID();
3594 if (IID && (isMaterialized || !F.materialized_use_empty())) {
3595 // Verify that the intrinsic prototype lines up with what the .td files
3596 // describe.
3597 std::string ErrMsg;
3598 raw_string_ostream ErrOS(ErrMsg);
3599 SmallVector<Type *, 4> OverloadTys;
3600 bool IsValid = Intrinsic::isSignatureValid(IID, FT, OverloadTys, ErrOS);
3601 Printable PrintDecl([&F](raw_ostream &OS) { F.print(OS); });
3602 Check(IsValid, ErrMsg, PrintDecl);
3603
3604 // Now that we have the intrinsic ID and the actual argument types (and we
3605 // know they are legal for the intrinsic!) get the intrinsic name through
3606 // the usual means. This allows us to verify the mangling of argument types
3607 // into the name.
3608 const std::string ExpectedName = Intrinsic::getName(
3609 IID, OverloadTys, const_cast<Module *>(F.getParent()), FT);
3610 Check(ExpectedName == F.getName(),
3611 "Intrinsic name not mangled correctly for type arguments! "
3612 "Should be: " +
3613 ExpectedName,
3614 PrintDecl);
3615 }
3616
3617 // Oracle functions of llvm.speculative.load may not be referenced in any
3618 // other way.
3619 if (isMaterialized && F.hasFnAttribute("oracle-function")) {
3620 Check(F.hasLocalLinkage(), "oracle function must have local linkage", &F);
3621 for (const Use &U : F.uses()) {
3622 auto *II = dyn_cast<IntrinsicInst>(U.getUser());
3623 Check(II && II->getIntrinsicID() == Intrinsic::speculative_load &&
3624 II->isArgOperand(&U) && II->getArgOperandNo(&U) == 2,
3625 "oracle function may only be used as the oracle operand of "
3626 "llvm.speculative.load",
3627 &F, U.getUser());
3628 }
3629 }
3630
3631 auto *N = F.getSubprogram();
3632 HasDebugInfo = (N != nullptr);
3633 if (!HasDebugInfo)
3634 return;
3635
3636 // Check that all !dbg attachments lead to back to N.
3637 //
3638 // FIXME: Check this incrementally while visiting !dbg attachments.
3639 // FIXME: Only check when N is the canonical subprogram for F.
3640 SmallPtrSet<const MDNode *, 32> Seen;
3641 auto VisitDebugLoc = [&](const Instruction &I, const MDNode *Node) {
3642 // Be careful about using DILocation here since we might be dealing with
3643 // broken code (this is the Verifier after all).
3644 const DILocation *DL = dyn_cast_or_null<DILocation>(Node);
3645 if (!DL)
3646 return;
3647 if (!Seen.insert(DL).second)
3648 return;
3649
3650 Metadata *Parent = DL->getRawScope();
3651 CheckDI(Parent && isa<DILocalScope>(Parent),
3652 "DILocation's scope must be a DILocalScope", N, &F, &I, DL, Parent);
3653
3654 DILocalScope *Scope = DL->getInlinedAtScope();
3655 Check(Scope, "Failed to find DILocalScope", DL);
3656
3657 if (!Seen.insert(Scope).second)
3658 return;
3659
3660 // Cycles are diagnosed when the DIScope nodes themselves are visited.
3661 if (hasDIScopeCycle(Scope))
3662 return;
3663
3664 DISubprogram *SP = Scope->getSubprogram();
3665
3666 // Scope and SP could be the same MDNode and we don't want to skip
3667 // validation in that case
3668 if ((Scope != SP) && !Seen.insert(SP).second)
3669 return;
3670
3671 CheckDI(SP->describes(&F),
3672 "!dbg attachment points at wrong subprogram for function", N, &F,
3673 &I, DL, Scope, SP);
3674 };
3675 for (auto &BB : F)
3676 for (auto &I : BB) {
3677 VisitDebugLoc(I, I.getDebugLoc().getAsMDNode());
3678 // The llvm.loop annotations also contain two DILocations.
3679 if (auto MD = I.getMetadata(LLVMContext::MD_loop))
3680 for (unsigned i = 1; i < MD->getNumOperands(); ++i)
3681 VisitDebugLoc(I, dyn_cast_or_null<MDNode>(MD->getOperand(i)));
3682 if (BrokenDebugInfo)
3683 return;
3684 }
3685}
3686
3687// verifyBasicBlock - Verify that a basic block is well formed...
3688//
3689void Verifier::visitBasicBlock(BasicBlock &BB) {
3690 InstsInThisBlock.clear();
3691 ConvergenceVerifyHelper.visit(BB);
3692
3693 // Check constraints that this basic block imposes on all of the PHI nodes in
3694 // it.
3695 if (isa<PHINode>(BB.front())) {
3696 SmallVector<BasicBlock *, 8> Preds(predecessors(&BB));
3698 llvm::sort(Preds);
3699 for (const PHINode &PN : BB.phis()) {
3700 Check(PN.getNumIncomingValues() == Preds.size(),
3701 "PHINode should have one entry for each predecessor of its "
3702 "parent basic block!",
3703 &PN);
3704
3705 // Get and sort all incoming values in the PHI node...
3706 Values.clear();
3707 Values.reserve(PN.getNumIncomingValues());
3708 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
3709 Values.push_back(
3710 std::make_pair(PN.getIncomingBlock(i), PN.getIncomingValue(i)));
3712
3713 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
3714 // Check to make sure that if there is more than one entry for a
3715 // particular basic block in this PHI node, that the incoming values are
3716 // all identical.
3717 //
3718 Check(i == 0 || Values[i].first != Values[i - 1].first ||
3719 Values[i].second == Values[i - 1].second,
3720 "PHI node has multiple entries for the same basic block with "
3721 "different incoming values!",
3722 &PN, Values[i].first, Values[i].second, Values[i - 1].second);
3723
3724 // Check to make sure that the predecessors and PHI node entries are
3725 // matched up.
3726 Check(Values[i].first == Preds[i],
3727 "PHI node entries do not match predecessors!", &PN,
3728 Values[i].first, Preds[i]);
3729 }
3730 }
3731 }
3732
3733 // Check that all instructions have their parent pointers set up correctly.
3734 for (auto &I : BB)
3735 {
3736 Check(I.getParent() == &BB, "Instruction has bogus parent pointer!");
3737 }
3738
3739 // Confirm that no issues arise from the debug program.
3740 CheckDI(!BB.getTrailingDbgRecords(), "Basic Block has trailing DbgRecords!",
3741 &BB);
3742}
3743
3744void Verifier::visitTerminator(Instruction &I) {
3745 // Ensure that terminators only exist at the end of the basic block.
3746 Check(&I == I.getParent()->getTerminator(),
3747 "Terminator found in the middle of a basic block!", I.getParent());
3748 visitInstruction(I);
3749}
3750
3751void Verifier::visitCondBrInst(CondBrInst &BI) {
3753 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
3754 visitTerminator(BI);
3755}
3756
3757void Verifier::visitReturnInst(ReturnInst &RI) {
3758 Function *F = RI.getParent()->getParent();
3759 unsigned N = RI.getNumOperands();
3760 if (F->getReturnType()->isVoidTy())
3761 Check(N == 0,
3762 "Found return instr that returns non-void in Function of void "
3763 "return type!",
3764 &RI, F->getReturnType());
3765 else
3766 Check(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
3767 "Function return type does not match operand "
3768 "type of return inst!",
3769 &RI, F->getReturnType());
3770
3771 // Check to make sure that the return value has necessary properties for
3772 // terminators...
3773 visitTerminator(RI);
3774}
3775
3776void Verifier::visitSwitchInst(SwitchInst &SI) {
3777 Check(SI.getType()->isVoidTy(), "Switch must have void result type!", &SI);
3778 // Check to make sure that all of the constants in the switch instruction
3779 // have the same type as the switched-on value.
3780 Type *SwitchTy = SI.getCondition()->getType();
3781 SmallPtrSet<ConstantInt*, 32> Constants;
3782 for (auto &Case : SI.cases()) {
3783 Check(isa<ConstantInt>(Case.getCaseValue()),
3784 "Case value is not a constant integer.", &SI);
3785 Check(Case.getCaseValue()->getType() == SwitchTy,
3786 "Switch constants must all be same type as switch value!", &SI);
3787 Check(Constants.insert(Case.getCaseValue()).second,
3788 "Duplicate integer as switch case", &SI, Case.getCaseValue());
3789 }
3790
3791 visitTerminator(SI);
3792}
3793
3794void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
3796 "Indirectbr operand must have pointer type!", &BI);
3797 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
3799 "Indirectbr destinations must all have pointer type!", &BI);
3800
3801 visitTerminator(BI);
3802}
3803
3805 // Currently we only support callbr for amdgcn.kill. Add more checks here as
3806 // needed.
3807 return isAMDGPUCallBrIntrinsic(ID);
3808}
3809
3810void Verifier::visitCallBrInst(CallBrInst &CBI) {
3811 if (!CBI.isInlineAsm()) {
3813 "callbr: indirect function / invalid signature");
3814 Check(!CBI.hasOperandBundles(),
3815 "callbr for intrinsics currently doesn't support operand bundles");
3816
3818 CheckFailed(
3819 "callbr currently only supports asm-goto and selected intrinsics");
3820 }
3821 visitIntrinsicCall(CBI.getIntrinsicID(), CBI);
3822 } else {
3823 const InlineAsm *IA = cast<InlineAsm>(CBI.getCalledOperand());
3824 Check(!IA->canThrow(), "Unwinding from Callbr is not allowed");
3825
3826 verifyInlineAsmCall(CBI);
3827 }
3828 visitTerminator(CBI);
3829}
3830
3831void Verifier::visitSelectInst(SelectInst &SI) {
3832 Check(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
3833 SI.getOperand(2)),
3834 "Invalid operands for select instruction!", &SI);
3835
3836 Check(SI.getTrueValue()->getType() == SI.getType(),
3837 "Select values must have same type as select instruction!", &SI);
3838 visitInstruction(SI);
3839}
3840
3841/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
3842/// a pass, if any exist, it's an error.
3843///
3844void Verifier::visitUserOp1(Instruction &I) {
3845 Check(false, "User-defined operators should not live outside of a pass!", &I);
3846}
3847
3848void Verifier::visitTruncInst(TruncInst &I) {
3849 // Get the source and destination types
3850 Type *SrcTy = I.getOperand(0)->getType();
3851 Type *DestTy = I.getType();
3852
3853 // Get the size of the types in bits, we'll need this later
3854 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3855 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3856
3857 Check(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
3858 Check(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
3859 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3860 "trunc source and destination must both be a vector or neither", &I);
3861 Check(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
3862
3863 visitInstruction(I);
3864}
3865
3866void Verifier::visitZExtInst(ZExtInst &I) {
3867 // Get the source and destination types
3868 Type *SrcTy = I.getOperand(0)->getType();
3869 Type *DestTy = I.getType();
3870
3871 // Get the size of the types in bits, we'll need this later
3872 Check(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
3873 Check(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
3874 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3875 "zext source and destination must both be a vector or neither", &I);
3876 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3877 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3878
3879 Check(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
3880
3881 visitInstruction(I);
3882}
3883
3884void Verifier::visitSExtInst(SExtInst &I) {
3885 // Get the source and destination types
3886 Type *SrcTy = I.getOperand(0)->getType();
3887 Type *DestTy = I.getType();
3888
3889 // Get the size of the types in bits, we'll need this later
3890 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3891 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3892
3893 Check(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
3894 Check(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
3895 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3896 "sext source and destination must both be a vector or neither", &I);
3897 Check(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
3898
3899 visitInstruction(I);
3900}
3901
3902void Verifier::visitFPTruncInst(FPTruncInst &I) {
3903 // Get the source and destination types
3904 Type *SrcTy = I.getOperand(0)->getType();
3905 Type *DestTy = I.getType();
3906 // Get the size of the types in bits, we'll need this later
3907 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3908 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3909
3910 Check(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
3911 Check(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
3912 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3913 "fptrunc source and destination must both be a vector or neither", &I);
3914 Check(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
3915
3916 visitInstruction(I);
3917}
3918
3919void Verifier::visitFPExtInst(FPExtInst &I) {
3920 // Get the source and destination types
3921 Type *SrcTy = I.getOperand(0)->getType();
3922 Type *DestTy = I.getType();
3923
3924 // Get the size of the types in bits, we'll need this later
3925 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3926 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3927
3928 Check(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
3929 Check(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
3930 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3931 "fpext source and destination must both be a vector or neither", &I);
3932 Check(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
3933
3934 visitInstruction(I);
3935}
3936
3937void Verifier::visitUIToFPInst(UIToFPInst &I) {
3938 // Get the source and destination types
3939 Type *SrcTy = I.getOperand(0)->getType();
3940 Type *DestTy = I.getType();
3941
3942 bool SrcVec = SrcTy->isVectorTy();
3943 bool DstVec = DestTy->isVectorTy();
3944
3945 Check(SrcVec == DstVec,
3946 "UIToFP source and dest must both be vector or scalar", &I);
3947 Check(SrcTy->isIntOrIntVectorTy(),
3948 "UIToFP source must be integer or integer vector", &I);
3949 Check(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
3950 &I);
3951
3952 if (SrcVec && DstVec)
3953 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3954 cast<VectorType>(DestTy)->getElementCount(),
3955 "UIToFP source and dest vector length mismatch", &I);
3956
3957 visitInstruction(I);
3958}
3959
3960void Verifier::visitSIToFPInst(SIToFPInst &I) {
3961 // Get the source and destination types
3962 Type *SrcTy = I.getOperand(0)->getType();
3963 Type *DestTy = I.getType();
3964
3965 bool SrcVec = SrcTy->isVectorTy();
3966 bool DstVec = DestTy->isVectorTy();
3967
3968 Check(SrcVec == DstVec,
3969 "SIToFP source and dest must both be vector or scalar", &I);
3970 Check(SrcTy->isIntOrIntVectorTy(),
3971 "SIToFP source must be integer or integer vector", &I);
3972 Check(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
3973 &I);
3974
3975 if (SrcVec && DstVec)
3976 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3977 cast<VectorType>(DestTy)->getElementCount(),
3978 "SIToFP source and dest vector length mismatch", &I);
3979
3980 visitInstruction(I);
3981}
3982
3983void Verifier::visitFPToUIInst(FPToUIInst &I) {
3984 // Get the source and destination types
3985 Type *SrcTy = I.getOperand(0)->getType();
3986 Type *DestTy = I.getType();
3987
3988 bool SrcVec = SrcTy->isVectorTy();
3989 bool DstVec = DestTy->isVectorTy();
3990
3991 Check(SrcVec == DstVec,
3992 "FPToUI source and dest must both be vector or scalar", &I);
3993 Check(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector", &I);
3994 Check(DestTy->isIntOrIntVectorTy(),
3995 "FPToUI result must be integer or integer vector", &I);
3996
3997 if (SrcVec && DstVec)
3998 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3999 cast<VectorType>(DestTy)->getElementCount(),
4000 "FPToUI source and dest vector length mismatch", &I);
4001
4002 visitInstruction(I);
4003}
4004
4005void Verifier::visitFPToSIInst(FPToSIInst &I) {
4006 // Get the source and destination types
4007 Type *SrcTy = I.getOperand(0)->getType();
4008 Type *DestTy = I.getType();
4009
4010 bool SrcVec = SrcTy->isVectorTy();
4011 bool DstVec = DestTy->isVectorTy();
4012
4013 Check(SrcVec == DstVec,
4014 "FPToSI source and dest must both be vector or scalar", &I);
4015 Check(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector", &I);
4016 Check(DestTy->isIntOrIntVectorTy(),
4017 "FPToSI result must be integer or integer vector", &I);
4018
4019 if (SrcVec && DstVec)
4020 Check(cast<VectorType>(SrcTy)->getElementCount() ==
4021 cast<VectorType>(DestTy)->getElementCount(),
4022 "FPToSI source and dest vector length mismatch", &I);
4023
4024 visitInstruction(I);
4025}
4026
4027void Verifier::checkPtrToAddr(Type *SrcTy, Type *DestTy, const Value &V) {
4028 Check(SrcTy->isPtrOrPtrVectorTy(), "PtrToAddr source must be pointer", V);
4029 Check(DestTy->isIntOrIntVectorTy(), "PtrToAddr result must be integral", V);
4030 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToAddr type mismatch",
4031 V);
4032
4033 if (SrcTy->isVectorTy()) {
4034 auto *VSrc = cast<VectorType>(SrcTy);
4035 auto *VDest = cast<VectorType>(DestTy);
4036 Check(VSrc->getElementCount() == VDest->getElementCount(),
4037 "PtrToAddr vector length mismatch", V);
4038 }
4039
4040 Type *AddrTy = DL.getAddressType(SrcTy);
4041 Check(AddrTy == DestTy, "PtrToAddr result must be address width", V);
4042}
4043
4044void Verifier::visitPtrToAddrInst(PtrToAddrInst &I) {
4045 checkPtrToAddr(I.getOperand(0)->getType(), I.getType(), I);
4046 visitInstruction(I);
4047}
4048
4049void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
4050 // Get the source and destination types
4051 Type *SrcTy = I.getOperand(0)->getType();
4052 Type *DestTy = I.getType();
4053
4054 Check(SrcTy->isPtrOrPtrVectorTy(), "PtrToInt source must be pointer", &I);
4055
4056 Check(DestTy->isIntOrIntVectorTy(), "PtrToInt result must be integral", &I);
4057 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
4058 &I);
4059
4060 if (SrcTy->isVectorTy()) {
4061 auto *VSrc = cast<VectorType>(SrcTy);
4062 auto *VDest = cast<VectorType>(DestTy);
4063 Check(VSrc->getElementCount() == VDest->getElementCount(),
4064 "PtrToInt Vector length mismatch", &I);
4065 }
4066
4067 visitInstruction(I);
4068}
4069
4070void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
4071 // Get the source and destination types
4072 Type *SrcTy = I.getOperand(0)->getType();
4073 Type *DestTy = I.getType();
4074
4075 Check(SrcTy->isIntOrIntVectorTy(), "IntToPtr source must be an integral", &I);
4076 Check(DestTy->isPtrOrPtrVectorTy(), "IntToPtr result must be a pointer", &I);
4077
4078 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
4079 &I);
4080 if (SrcTy->isVectorTy()) {
4081 auto *VSrc = cast<VectorType>(SrcTy);
4082 auto *VDest = cast<VectorType>(DestTy);
4083 Check(VSrc->getElementCount() == VDest->getElementCount(),
4084 "IntToPtr Vector length mismatch", &I);
4085 }
4086 visitInstruction(I);
4087}
4088
4089void Verifier::visitBitCastInst(BitCastInst &I) {
4090 Check(
4091 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
4092 "Invalid bitcast", &I);
4093 Check(DL.getTypeSizeInBits(I.getSrcTy()) ==
4094 DL.getTypeSizeInBits(I.getDestTy()),
4095 "Invalid bitcast", &I);
4096 visitInstruction(I);
4097}
4098
4099void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
4100 Type *SrcTy = I.getOperand(0)->getType();
4101 Type *DestTy = I.getType();
4102
4103 Check(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
4104 &I);
4105 Check(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
4106 &I);
4108 "AddrSpaceCast must be between different address spaces", &I);
4109 if (auto *SrcVTy = dyn_cast<VectorType>(SrcTy))
4110 Check(SrcVTy->getElementCount() ==
4111 cast<VectorType>(DestTy)->getElementCount(),
4112 "AddrSpaceCast vector pointer number of elements mismatch", &I);
4113 visitInstruction(I);
4114}
4115
4116/// visitPHINode - Ensure that a PHI node is well formed.
4117///
4118void Verifier::visitPHINode(PHINode &PN) {
4119 // Ensure that the PHI nodes are all grouped together at the top of the block.
4120 // This can be tested by checking whether the instruction before this is
4121 // either nonexistent (because this is begin()) or is a PHI node. If not,
4122 // then there is some other instruction before a PHI.
4123 Check(&PN == &PN.getParent()->front() ||
4125 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
4126
4127 // Check that a PHI doesn't yield a Token.
4128 Check(!PN.getType()->isTokenLikeTy(), "PHI nodes cannot have token type!");
4129
4130 // Check that all of the values of the PHI node have the same type as the
4131 // result.
4132 for (Value *IncValue : PN.incoming_values()) {
4133 Check(PN.getType() == IncValue->getType(),
4134 "PHI node operands are not the same type as the result!", &PN);
4135 }
4136
4137 // All other PHI node constraints are checked in the visitBasicBlock method.
4138
4139 visitInstruction(PN);
4140}
4141
4142void Verifier::visitCallBase(CallBase &Call) {
4144 "Called function must be a pointer!", Call);
4145 FunctionType *FTy = Call.getFunctionType();
4146
4147 // Verify that the correct number of arguments are being passed
4148 if (FTy->isVarArg())
4149 Check(Call.arg_size() >= FTy->getNumParams(),
4150 "Called function requires more parameters than were provided!", Call);
4151 else
4152 Check(Call.arg_size() == FTy->getNumParams(),
4153 "Incorrect number of arguments passed to called function!", Call);
4154
4155 // Verify that all arguments to the call match the function type.
4156 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
4157 Check(Call.getArgOperand(i)->getType() == FTy->getParamType(i),
4158 "Call parameter type does not match function signature!",
4159 Call.getArgOperand(i), FTy->getParamType(i), Call);
4160
4161 AttributeList Attrs = Call.getAttributes();
4162
4163 Check(verifyAttributeCount(Attrs, Call.arg_size()),
4164 "Attribute after last parameter!", Call);
4165
4166 auto *Callee =
4168 bool IsIntrinsic = Callee && Callee->isIntrinsic();
4169 if (IsIntrinsic)
4170 Check(Callee->getFunctionType() == FTy,
4171 "Intrinsic called with incompatible signature", Call);
4172
4173 // Verify if the calling convention of the callee is callable.
4175 "calling convention does not permit calls", Call);
4176
4177 // Disallow passing/returning values with alignment higher than we can
4178 // represent.
4179 // FIXME: Consider making DataLayout cap the alignment, so this isn't
4180 // necessary.
4181 auto VerifyTypeAlign = [&](Type *Ty, const Twine &Message) {
4182 if (!Ty->isSized())
4183 return;
4184 Align ABIAlign = DL.getABITypeAlign(Ty);
4185 Check(ABIAlign.value() <= Value::MaximumAlignment,
4186 "Incorrect alignment of " + Message + " to called function!", Call);
4187 };
4188
4189 if (!IsIntrinsic) {
4190 VerifyTypeAlign(FTy->getReturnType(), "return type");
4191 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
4192 Type *Ty = FTy->getParamType(i);
4193 VerifyTypeAlign(Ty, "argument passed");
4194 }
4195 }
4196
4197 if (Attrs.hasFnAttr(Attribute::Speculatable)) {
4198 // Don't allow speculatable on call sites, unless the underlying function
4199 // declaration is also speculatable.
4200 Check(Callee && Callee->isSpeculatable(),
4201 "speculatable attribute may not apply to call sites", Call);
4202 }
4203
4204 if (Attrs.hasFnAttr(Attribute::Preallocated)) {
4205 Check(Call.getIntrinsicID() == Intrinsic::call_preallocated_arg,
4206 "preallocated as a call site attribute can only be on "
4207 "llvm.call.preallocated.arg");
4208 }
4209
4210 Check(!Attrs.hasFnAttr(Attribute::DenormalFPEnv),
4211 "denormal_fpenv attribute may not apply to call sites", Call);
4212
4213 // Verify call attributes.
4214 verifyFunctionAttrs(FTy, Attrs, &Call, IsIntrinsic, Call.isInlineAsm());
4215
4216 // Conservatively check the inalloca argument.
4217 // We have a bug if we can find that there is an underlying alloca without
4218 // inalloca.
4219 if (Call.hasInAllocaArgument()) {
4220 Value *InAllocaArg = Call.getArgOperand(FTy->getNumParams() - 1);
4221 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
4222 Check(AI->isUsedWithInAlloca(),
4223 "inalloca argument for call has mismatched alloca", AI, Call);
4224 }
4225
4226 // For each argument of the callsite, if it has the swifterror argument,
4227 // make sure the underlying alloca/parameter it comes from has a swifterror as
4228 // well.
4229 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
4230 if (Call.paramHasAttr(i, Attribute::SwiftError)) {
4231 Value *SwiftErrorArg = Call.getArgOperand(i);
4232 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
4233 Check(AI->isSwiftError(),
4234 "swifterror argument for call has mismatched alloca", AI, Call);
4235 continue;
4236 }
4237 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
4238 Check(ArgI, "swifterror argument should come from an alloca or parameter",
4239 SwiftErrorArg, Call);
4240 Check(ArgI->hasSwiftErrorAttr(),
4241 "swifterror argument for call has mismatched parameter", ArgI,
4242 Call);
4243 }
4244
4245 if (Attrs.hasParamAttr(i, Attribute::ImmArg)) {
4246 // Don't allow immarg on call sites, unless the underlying declaration
4247 // also has the matching immarg.
4248 Check(Callee && Callee->hasParamAttribute(i, Attribute::ImmArg),
4249 "immarg may not apply only to call sites", Call.getArgOperand(i),
4250 Call);
4251 }
4252
4253 if (Call.paramHasAttr(i, Attribute::ImmArg)) {
4254 Value *ArgVal = Call.getArgOperand(i);
4255 Check((isa<ConstantInt>(ArgVal) || isa<ConstantFP>(ArgVal)) &&
4256 !isa<VectorType>(ArgVal->getType()),
4257 "immarg operand has non-immediate parameter", ArgVal, Call);
4258
4259 // If the imm-arg is an integer and also has a range attached,
4260 // check if the given value is within the range.
4261 if (Call.paramHasAttr(i, Attribute::Range)) {
4262 if (auto *CI = dyn_cast<ConstantInt>(ArgVal)) {
4263 const ConstantRange &CR =
4264 Call.getParamAttr(i, Attribute::Range).getValueAsConstantRange();
4265 Check(CR.contains(CI->getValue()),
4266 formatv("immarg value {} for arg {} out of range {}",
4267 CI->getValue(), i, CR),
4268 Call);
4269 }
4270 }
4271 if (auto *CI = dyn_cast<ConstantInt>(ArgVal))
4273 CI->getValue()),
4274 formatv("immarg value {} for arg {} out of range set",
4275 CI->getValue(), i),
4276 Call);
4277 }
4278
4279 if (Call.paramHasAttr(i, Attribute::Preallocated)) {
4280 Value *ArgVal = Call.getArgOperand(i);
4281 bool hasOB =
4283 bool isMustTail = Call.isMustTailCall();
4284 Check(hasOB != isMustTail,
4285 "preallocated operand either requires a preallocated bundle or "
4286 "the call to be musttail (but not both)",
4287 ArgVal, Call);
4288 }
4289 }
4290
4291 if (FTy->isVarArg()) {
4292 // FIXME? is 'nest' even legal here?
4293 bool SawNest = false;
4294 bool SawReturned = false;
4295
4296 for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) {
4297 if (Attrs.hasParamAttr(Idx, Attribute::Nest))
4298 SawNest = true;
4299 if (Attrs.hasParamAttr(Idx, Attribute::Returned))
4300 SawReturned = true;
4301 }
4302
4303 // Check attributes on the varargs part.
4304 for (unsigned Idx = FTy->getNumParams(); Idx < Call.arg_size(); ++Idx) {
4305 Type *Ty = Call.getArgOperand(Idx)->getType();
4306 AttributeSet ArgAttrs = Attrs.getParamAttrs(Idx);
4307 verifyParameterAttrs(ArgAttrs, Ty, &Call);
4308
4309 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
4310 Check(!SawNest, "More than one parameter has attribute nest!", Call);
4311 SawNest = true;
4312 }
4313
4314 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
4315 Check(!SawReturned, "More than one parameter has attribute returned!",
4316 Call);
4317 Check(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
4318 "Incompatible argument and return types for 'returned' "
4319 "attribute",
4320 Call);
4321 SawReturned = true;
4322 }
4323
4324 // Statepoint intrinsic is vararg but the wrapped function may be not.
4325 // Allow sret here and check the wrapped function in verifyStatepoint.
4326 if (Call.getIntrinsicID() != Intrinsic::experimental_gc_statepoint)
4327 Check(!ArgAttrs.hasAttribute(Attribute::StructRet),
4328 "Attribute 'sret' cannot be used for vararg call arguments!",
4329 Call);
4330
4331 if (ArgAttrs.hasAttribute(Attribute::InAlloca))
4332 Check(Idx == Call.arg_size() - 1,
4333 "inalloca isn't on the last argument!", Call);
4334 }
4335 }
4336
4337 // Verify that there's no metadata unless it's a direct call to an intrinsic.
4338 if (!IsIntrinsic) {
4339 for (Type *ParamTy : FTy->params()) {
4340 Check(!ParamTy->isMetadataTy(),
4341 "Function has metadata parameter but isn't an intrinsic", Call);
4342 Check(!ParamTy->isTokenLikeTy(),
4343 "Function has token parameter but isn't an intrinsic", Call);
4344 }
4345 }
4346
4347 // Verify that indirect calls don't return tokens.
4348 if (!Call.getCalledFunction()) {
4349 Check(!FTy->getReturnType()->isTokenLikeTy(),
4350 "Return type cannot be token for indirect call!");
4351 Check(!FTy->getReturnType()->isX86_AMXTy(),
4352 "Return type cannot be x86_amx for indirect call!");
4353 }
4354
4356 visitIntrinsicCall(ID, Call);
4357
4358 // Verify that a callsite has at most one "deopt", at most one "funclet", at
4359 // most one "gc-transition", at most one "cfguardtarget", at most one
4360 // "preallocated" operand bundle, and at most one "ptrauth" operand bundle.
4361 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
4362 FoundGCTransitionBundle = false, FoundCFGuardTargetBundle = false,
4363 FoundPreallocatedBundle = false, FoundGCLiveBundle = false,
4364 FoundPtrauthBundle = false, FoundKCFIBundle = false,
4365 FoundAttachedCallBundle = false;
4366 for (unsigned i = 0, e = Call.getNumOperandBundles(); i < e; ++i) {
4367 OperandBundleUse BU = Call.getOperandBundleAt(i);
4368 for (const Value *Input : BU.Inputs)
4369 Check(!Input->getType()->isLabelTy(),
4370 "Operand bundle operands cannot be labels", Call);
4371 uint32_t Tag = BU.getTagID();
4372 if (Tag == LLVMContext::OB_deopt) {
4373 Check(!FoundDeoptBundle, "Multiple deopt operand bundles", Call);
4374 FoundDeoptBundle = true;
4375 } else if (Tag == LLVMContext::OB_gc_transition) {
4376 Check(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
4377 Call);
4378 FoundGCTransitionBundle = true;
4379 } else if (Tag == LLVMContext::OB_funclet) {
4380 Check(!FoundFuncletBundle, "Multiple funclet operand bundles", Call);
4381 FoundFuncletBundle = true;
4382 Check(BU.Inputs.size() == 1,
4383 "Expected exactly one funclet bundle operand", Call);
4384 Check(isa<FuncletPadInst>(BU.Inputs.front()),
4385 "Funclet bundle operands should correspond to a FuncletPadInst",
4386 Call);
4387 } else if (Tag == LLVMContext::OB_cfguardtarget) {
4388 Check(!FoundCFGuardTargetBundle, "Multiple CFGuardTarget operand bundles",
4389 Call);
4390 FoundCFGuardTargetBundle = true;
4391 Check(BU.Inputs.size() == 1,
4392 "Expected exactly one cfguardtarget bundle operand", Call);
4393 } else if (Tag == LLVMContext::OB_ptrauth) {
4394 Check(!FoundPtrauthBundle, "Multiple ptrauth operand bundles", Call);
4395 FoundPtrauthBundle = true;
4396 Check(BU.Inputs.size() == 2,
4397 "Expected exactly two ptrauth bundle operands", Call);
4398 Check(isa<ConstantInt>(BU.Inputs[0]) &&
4399 BU.Inputs[0]->getType()->isIntegerTy(32),
4400 "Ptrauth bundle key operand must be an i32 constant", Call);
4401 Check(BU.Inputs[1]->getType()->isIntegerTy(64),
4402 "Ptrauth bundle discriminator operand must be an i64", Call);
4403 } else if (Tag == LLVMContext::OB_kcfi) {
4404 Check(!FoundKCFIBundle, "Multiple kcfi operand bundles", Call);
4405 FoundKCFIBundle = true;
4406 Check(BU.Inputs.size() == 1, "Expected exactly one kcfi bundle operand",
4407 Call);
4408 Check(isa<ConstantInt>(BU.Inputs[0]) &&
4409 BU.Inputs[0]->getType()->isIntegerTy(32),
4410 "Kcfi bundle operand must be an i32 constant", Call);
4411 } else if (Tag == LLVMContext::OB_preallocated) {
4412 Check(!FoundPreallocatedBundle, "Multiple preallocated operand bundles",
4413 Call);
4414 FoundPreallocatedBundle = true;
4415 Check(BU.Inputs.size() == 1,
4416 "Expected exactly one preallocated bundle operand", Call);
4417 auto Input = dyn_cast<IntrinsicInst>(BU.Inputs.front());
4418 Check(Input &&
4419 Input->getIntrinsicID() == Intrinsic::call_preallocated_setup,
4420 "\"preallocated\" argument must be a token from "
4421 "llvm.call.preallocated.setup",
4422 Call);
4423 } else if (Tag == LLVMContext::OB_gc_live) {
4424 Check(!FoundGCLiveBundle, "Multiple gc-live operand bundles", Call);
4425 FoundGCLiveBundle = true;
4427 Check(!FoundAttachedCallBundle,
4428 "Multiple \"clang.arc.attachedcall\" operand bundles", Call);
4429 FoundAttachedCallBundle = true;
4430 verifyAttachedCallBundle(Call, BU);
4431 }
4432 }
4433
4434 // Verify that callee and callsite agree on whether to use pointer auth.
4435 Check(!(Call.getCalledFunction() && FoundPtrauthBundle),
4436 "Direct call cannot have a ptrauth bundle", Call);
4437
4438 // Verify that each inlinable callsite of a debug-info-bearing function in a
4439 // debug-info-bearing function has a debug location attached to it. Failure to
4440 // do so causes assertion failures when the inliner sets up inline scope info
4441 // (Interposable functions are not inlinable, neither are functions without
4442 // definitions. noipa does not prevent inlining, so it is ignored here.)
4444 !Call.getCalledFunction()->isInterposable(/*CheckNoIPA=*/false) &&
4448 "inlinable function call in a function with "
4449 "debug info must have a !dbg location",
4450 Call);
4451
4452 if (Call.isInlineAsm())
4453 verifyInlineAsmCall(Call);
4454
4455 ConvergenceVerifyHelper.visit(Call);
4456
4457 visitInstruction(Call);
4458}
4459
4460void Verifier::verifyTailCCMustTailAttrs(const AttrBuilder &Attrs,
4461 StringRef Context) {
4462 Check(!Attrs.contains(Attribute::InAlloca),
4463 Twine("inalloca attribute not allowed in ") + Context);
4464 Check(!Attrs.contains(Attribute::InReg),
4465 Twine("inreg attribute not allowed in ") + Context);
4466 Check(!Attrs.contains(Attribute::SwiftError),
4467 Twine("swifterror attribute not allowed in ") + Context);
4468 Check(!Attrs.contains(Attribute::Preallocated),
4469 Twine("preallocated attribute not allowed in ") + Context);
4470 Check(!Attrs.contains(Attribute::ByRef),
4471 Twine("byref attribute not allowed in ") + Context);
4472}
4473
4474static AttrBuilder getParameterABIAttributes(LLVMContext& C, unsigned I, AttributeList Attrs) {
4475 static const Attribute::AttrKind ABIAttrs[] = {
4476 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
4477 Attribute::InReg, Attribute::StackAlignment, Attribute::SwiftSelf,
4478 Attribute::SwiftAsync, Attribute::SwiftError, Attribute::Preallocated,
4479 Attribute::ByRef};
4480 AttrBuilder Copy(C);
4481 for (auto AK : ABIAttrs) {
4482 Attribute Attr = Attrs.getParamAttrs(I).getAttribute(AK);
4483 if (Attr.isValid())
4484 Copy.addAttribute(Attr);
4485 }
4486
4487 // `align` is ABI-affecting only in combination with `byval` or `byref`.
4488 if (Attrs.hasParamAttr(I, Attribute::Alignment) &&
4489 (Attrs.hasParamAttr(I, Attribute::ByVal) ||
4490 Attrs.hasParamAttr(I, Attribute::ByRef)))
4491 Copy.addAlignmentAttr(Attrs.getParamAlignment(I));
4492 return Copy;
4493}
4494
4495void Verifier::verifyMustTailCall(CallInst &CI) {
4496 Check(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
4497
4498 Function *F = CI.getParent()->getParent();
4499 FunctionType *CallerTy = F->getFunctionType();
4500 FunctionType *CalleeTy = CI.getFunctionType();
4501 Check(CallerTy->isVarArg() == CalleeTy->isVarArg(),
4502 "cannot guarantee tail call due to mismatched varargs", &CI);
4503 Check(CallerTy->getReturnType() == CalleeTy->getReturnType(),
4504 "cannot guarantee tail call due to mismatched return types", &CI);
4505
4506 // - The calling conventions of the caller and callee must match.
4507 Check(F->getCallingConv() == CI.getCallingConv(),
4508 "cannot guarantee tail call due to mismatched calling conv", &CI);
4509
4510 // - The call must immediately precede a :ref:`ret <i_ret>` instruction.
4511 // - The ret instruction must return the value produced by the call or void.
4513
4514 // Check the return.
4515 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
4516 Check(Ret, "musttail call must precede a ret", &CI);
4517 Check(!Ret->getReturnValue() || Ret->getReturnValue() == &CI ||
4519 "musttail call result must be returned", Ret);
4520
4521 AttributeList CallerAttrs = F->getAttributes();
4522 AttributeList CalleeAttrs = CI.getAttributes();
4523 if (CI.getCallingConv() == CallingConv::SwiftTail ||
4524 CI.getCallingConv() == CallingConv::Tail) {
4525 StringRef CCName =
4526 CI.getCallingConv() == CallingConv::Tail ? "tailcc" : "swifttailcc";
4527
4528 // - Only sret, byval, swiftself, and swiftasync ABI-impacting attributes
4529 // are allowed in swifttailcc call
4530 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4531 AttrBuilder ABIAttrs = getParameterABIAttributes(F->getContext(), I, CallerAttrs);
4532 SmallString<32> Context{CCName, StringRef(" musttail caller")};
4533 verifyTailCCMustTailAttrs(ABIAttrs, Context);
4534 }
4535 for (unsigned I = 0, E = CalleeTy->getNumParams(); I != E; ++I) {
4536 AttrBuilder ABIAttrs = getParameterABIAttributes(F->getContext(), I, CalleeAttrs);
4537 SmallString<32> Context{CCName, StringRef(" musttail callee")};
4538 verifyTailCCMustTailAttrs(ABIAttrs, Context);
4539 }
4540 // - Varargs functions are not allowed
4541 Check(!CallerTy->isVarArg(), Twine("cannot guarantee ") + CCName +
4542 " tail call for varargs function");
4543 return;
4544 }
4545
4546 // - The caller and callee prototypes must match.
4547 if (!CI.getIntrinsicID()) {
4548 Check(CallerTy->getNumParams() == CalleeTy->getNumParams(),
4549 "cannot guarantee tail call due to mismatched parameter counts", &CI);
4550 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4551 Check(CallerTy->getParamType(I) == CalleeTy->getParamType(I),
4552 "cannot guarantee tail call due to mismatched parameter types",
4553 &CI);
4554 }
4555 }
4556
4557 // - All ABI-impacting function attributes, such as sret, byval, inreg,
4558 // returned, preallocated, and inalloca, must match.
4559 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4560 AttrBuilder CallerABIAttrs = getParameterABIAttributes(F->getContext(), I, CallerAttrs);
4561 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(F->getContext(), I, CalleeAttrs);
4562 Check(CallerABIAttrs == CalleeABIAttrs,
4563 "cannot guarantee tail call due to mismatched ABI impacting "
4564 "function attributes",
4565 &CI, CI.getOperand(I));
4566 }
4567}
4568
4569void Verifier::visitCallInst(CallInst &CI) {
4570 visitCallBase(CI);
4571
4572 if (CI.isMustTailCall())
4573 verifyMustTailCall(CI);
4574}
4575
4576void Verifier::visitInvokeInst(InvokeInst &II) {
4577 visitCallBase(II);
4578
4579 // Verify that the first non-PHI instruction of the unwind destination is an
4580 // exception handling instruction.
4581 Check(
4582 II.getUnwindDest()->isEHPad(),
4583 "The unwind destination does not have an exception handling instruction!",
4584 &II);
4585
4586 visitTerminator(II);
4587}
4588
4589/// visitUnaryOperator - Check the argument to the unary operator.
4590///
4591void Verifier::visitUnaryOperator(UnaryOperator &U) {
4592 Check(U.getType() == U.getOperand(0)->getType(),
4593 "Unary operators must have same type for"
4594 "operands and result!",
4595 &U);
4596
4597 switch (U.getOpcode()) {
4598 // Check that floating-point arithmetic operators are only used with
4599 // floating-point operands.
4600 case Instruction::FNeg:
4601 Check(U.getType()->isFPOrFPVectorTy(),
4602 "FNeg operator only works with float types!", &U);
4603 break;
4604 default:
4605 llvm_unreachable("Unknown UnaryOperator opcode!");
4606 }
4607
4608 visitInstruction(U);
4609}
4610
4611/// visitBinaryOperator - Check that both arguments to the binary operator are
4612/// of the same type!
4613///
4614void Verifier::visitBinaryOperator(BinaryOperator &B) {
4615 Check(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
4616 "Both operands to a binary operator are not of the same type!", &B);
4617
4618 switch (B.getOpcode()) {
4619 // Check that integer arithmetic operators are only used with
4620 // integral operands.
4621 case Instruction::Add:
4622 case Instruction::Sub:
4623 case Instruction::Mul:
4624 case Instruction::SDiv:
4625 case Instruction::UDiv:
4626 case Instruction::SRem:
4627 case Instruction::URem:
4628 Check(B.getType()->isIntOrIntVectorTy(),
4629 "Integer arithmetic operators only work with integral types!", &B);
4630 Check(B.getType() == B.getOperand(0)->getType(),
4631 "Integer arithmetic operators must have same type "
4632 "for operands and result!",
4633 &B);
4634 break;
4635 // Check that floating-point arithmetic operators are only used with
4636 // floating-point operands.
4637 case Instruction::FAdd:
4638 case Instruction::FSub:
4639 case Instruction::FMul:
4640 case Instruction::FDiv:
4641 case Instruction::FRem:
4642 Check(B.getType()->isFPOrFPVectorTy(),
4643 "Floating-point arithmetic operators only work with "
4644 "floating-point types!",
4645 &B);
4646 Check(B.getType() == B.getOperand(0)->getType(),
4647 "Floating-point arithmetic operators must have same type "
4648 "for operands and result!",
4649 &B);
4650 break;
4651 // Check that logical operators are only used with integral operands.
4652 case Instruction::And:
4653 case Instruction::Or:
4654 case Instruction::Xor:
4655 Check(B.getType()->isIntOrIntVectorTy(),
4656 "Logical operators only work with integral types!", &B);
4657 Check(B.getType() == B.getOperand(0)->getType(),
4658 "Logical operators must have same type for operands and result!", &B);
4659 break;
4660 case Instruction::Shl:
4661 case Instruction::LShr:
4662 case Instruction::AShr:
4663 Check(B.getType()->isIntOrIntVectorTy(),
4664 "Shifts only work with integral types!", &B);
4665 Check(B.getType() == B.getOperand(0)->getType(),
4666 "Shift return type must be same as operands!", &B);
4667 break;
4668 default:
4669 llvm_unreachable("Unknown BinaryOperator opcode!");
4670 }
4671
4672 visitInstruction(B);
4673}
4674
4675void Verifier::visitICmpInst(ICmpInst &IC) {
4676 // Check that the operands are the same type
4677 Type *Op0Ty = IC.getOperand(0)->getType();
4678 Type *Op1Ty = IC.getOperand(1)->getType();
4679 Check(Op0Ty == Op1Ty,
4680 "Both operands to ICmp instruction are not of the same type!", &IC);
4681 // Check that the operands are the right type
4682 Check(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPtrOrPtrVectorTy(),
4683 "Invalid operand types for ICmp instruction", &IC);
4684 // Check that the predicate is valid.
4685 Check(IC.isIntPredicate(), "Invalid predicate in ICmp instruction!", &IC);
4686
4687 visitInstruction(IC);
4688}
4689
4690void Verifier::visitFCmpInst(FCmpInst &FC) {
4691 // Check that the operands are the same type
4692 Type *Op0Ty = FC.getOperand(0)->getType();
4693 Type *Op1Ty = FC.getOperand(1)->getType();
4694 Check(Op0Ty == Op1Ty,
4695 "Both operands to FCmp instruction are not of the same type!", &FC);
4696 // Check that the operands are the right type
4697 Check(Op0Ty->isFPOrFPVectorTy(), "Invalid operand types for FCmp instruction",
4698 &FC);
4699 // Check that the predicate is valid.
4700 Check(FC.isFPPredicate(), "Invalid predicate in FCmp instruction!", &FC);
4701
4702 visitInstruction(FC);
4703}
4704
4705void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
4707 "Invalid extractelement operands!", &EI);
4708 visitInstruction(EI);
4709}
4710
4711void Verifier::visitInsertElementInst(InsertElementInst &IE) {
4712 Check(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
4713 IE.getOperand(2)),
4714 "Invalid insertelement operands!", &IE);
4715 visitInstruction(IE);
4716}
4717
4718void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
4719 Check(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
4720 SV.getShuffleMask()),
4721 "Invalid shufflevector operands!", &SV);
4722 visitInstruction(SV);
4723}
4724
4725void Verifier::visitBitInsertInst(BitInsertInst &BII) {
4726 if (const char *Reason = BitInsertInst::areInvalidOperands(
4727 BII.getOperand(0), BII.getOperand(1), BII.getOperand(2)))
4728 Check(false, Reason, &BII);
4729 Check(DL.getTypeSizeInBits(BII.getOperand(0)->getType()) >=
4730 DL.getTypeSizeInBits(BII.getOperand(1)->getType()),
4731 "bitinsert val type cannot be wider than base type!", &BII);
4732 visitInstruction(BII);
4733}
4734
4735void Verifier::visitVAArgInst(VAArgInst &VAA) {
4736 // No target can lower va_arg of an aggregate, so frontends expand it.
4737 Check(!VAA.getType()->isAggregateType(),
4738 "va_arg with an aggregate type is not supported", &VAA);
4739 visitInstruction(VAA);
4740}
4741
4742void Verifier::visitBitExtractInst(BitExtractInst &BEI) {
4743 if (const char *Reason = BitExtractInst::areInvalidOperands(
4744 BEI.getType(), BEI.getOperand(0), BEI.getOperand(1)))
4745 Check(false, Reason, &BEI);
4746 Check(DL.getTypeSizeInBits(BEI.getType()) <=
4747 DL.getTypeSizeInBits(BEI.getOperand(0)->getType()),
4748 "bitextract result type cannot be wider than source type!", &BEI);
4749 visitInstruction(BEI);
4750}
4751
4752void Verifier::checkGEPOperator(const GEPOperator &GEP) {
4753 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
4754
4755 Check(isa<PointerType>(TargetTy),
4756 "GEP base pointer is not a vector or a vector of pointers", &GEP);
4757 Check(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
4758
4759 Type *SrcTy = GEP.getSourceElementType();
4760 while (auto *ATy = dyn_cast<ArrayType>(SrcTy))
4761 SrcTy = ATy->getElementType();
4762 Check(!isa<StructType>(SrcTy) || !SrcTy->isScalableTy(),
4763 "getelementptr cannot target structure that contains scalable vector "
4764 "type",
4765 &GEP);
4766
4767 SmallVector<Value *, 16> Idxs(GEP.indices());
4768 Check(
4769 all_of(Idxs, [](Value *V) { return V->getType()->isIntOrIntVectorTy(); }),
4770 "GEP indexes must be integers", &GEP);
4771 Type *ElTy =
4772 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
4773 Check(ElTy, "Invalid indices for GEP pointer type!", &GEP);
4774
4775 auto *PtrTy = dyn_cast<PointerType>(GEP.getType()->getScalarType());
4776
4777 Check(PtrTy && GEP.getResultElementType() == ElTy,
4778 "GEP is not of right type for indices!", &GEP, ElTy);
4779
4780 if (auto *GEPVTy = dyn_cast<VectorType>(GEP.getType())) {
4781 // Additional checks for vector GEPs.
4782 ElementCount GEPWidth = GEPVTy->getElementCount();
4783 if (GEP.getPointerOperandType()->isVectorTy())
4784 Check(
4785 GEPWidth ==
4786 cast<VectorType>(GEP.getPointerOperandType())->getElementCount(),
4787 "Vector GEP result width doesn't match operand's", &GEP);
4788 for (Value *Idx : Idxs) {
4789 Type *IndexTy = Idx->getType();
4790 if (auto *IndexVTy = dyn_cast<VectorType>(IndexTy)) {
4791 ElementCount IndexWidth = IndexVTy->getElementCount();
4792 Check(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
4793 }
4794 Check(IndexTy->isIntOrIntVectorTy(),
4795 "All GEP indices should be of integer type");
4796 }
4797 }
4798
4799 // Check that GEP does not index into a vector with non-byte-addressable
4800 // elements.
4802 GTI != GTE; ++GTI) {
4803 if (GTI.isVector()) {
4804 Type *ElemTy = GTI.getIndexedType();
4805 Check(DL.typeSizeEqualsStoreSize(ElemTy),
4806 "GEP into vector with non-byte-addressable element type", &GEP);
4807 }
4808 }
4809
4810 Check(GEP.getPointerAddressSpace() == PtrTy->getAddressSpace(),
4811 "GEP address space doesn't match type", &GEP);
4812}
4813
4814void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
4816 GEP.getModule()->getModuleFlag("require-logical-pointer")))
4817 Check(!MD->getZExtValue(),
4818 "Non-logical getelementptr disallowed for this module.");
4819
4820 checkGEPOperator(cast<GEPOperator>(GEP));
4821 visitInstruction(GEP);
4822}
4823
4824static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
4825 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
4826}
4827
4828/// Verify !range and !absolute_symbol metadata. These have the same
4829/// restrictions, except !absolute_symbol allows the full set.
4830void Verifier::verifyRangeLikeMetadata(const Value &I, const MDNode *Range,
4831 Type *Ty, RangeLikeMetadataKind Kind) {
4832 unsigned NumOperands = Range->getNumOperands();
4833 Check(NumOperands % 2 == 0, "Unfinished range!", Range);
4834 unsigned NumRanges = NumOperands / 2;
4835 Check(NumRanges >= 1, "It should have at least one range!", Range);
4836
4837 ConstantRange LastRange(1, true); // Dummy initial value
4838 for (unsigned i = 0; i < NumRanges; ++i) {
4839 ConstantInt *Low =
4840 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
4841 Check(Low, "The lower limit must be an integer!", Low);
4842 ConstantInt *High =
4843 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
4844 Check(High, "The upper limit must be an integer!", High);
4845
4846 Check(High->getType() == Low->getType(), "Range pair types must match!",
4847 &I);
4848
4849 if (Kind == RangeLikeMetadataKind::NoaliasAddrspace) {
4850 Check(High->getType()->isIntegerTy(32),
4851 "noalias.addrspace type must be i32!", &I);
4852 } else {
4853 Check(High->getType() == Ty->getScalarType(),
4854 "Range types must match instruction type!", &I);
4855 }
4856
4857 APInt HighV = High->getValue();
4858 APInt LowV = Low->getValue();
4859
4860 // ConstantRange asserts if the ranges are the same except for the min/max
4861 // value. Leave the cases it tolerates for the empty range error below.
4862 Check(LowV != HighV || LowV.isMaxValue() || LowV.isMinValue(),
4863 "The upper and lower limits cannot be the same value", &I);
4864
4865 ConstantRange CurRange(LowV, HighV);
4866 Check(!CurRange.isEmptySet() &&
4867 (Kind == RangeLikeMetadataKind::AbsoluteSymbol ||
4868 !CurRange.isFullSet()),
4869 "Range must not be empty!", Range);
4870 if (i != 0) {
4871 Check(CurRange.intersectWith(LastRange).isEmptySet(),
4872 "Intervals are overlapping", Range);
4873 Check(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
4874 Range);
4875 Check(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
4876 Range);
4877 }
4878 LastRange = ConstantRange(LowV, HighV);
4879 }
4880 if (NumRanges > 2) {
4881 APInt FirstLow =
4882 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
4883 APInt FirstHigh =
4884 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
4885 ConstantRange FirstRange(FirstLow, FirstHigh);
4886 Check(FirstRange.intersectWith(LastRange).isEmptySet(),
4887 "Intervals are overlapping", Range);
4888 Check(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
4889 Range);
4890 }
4891}
4892
4893void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
4894 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
4895 "precondition violation");
4896 verifyRangeLikeMetadata(I, Range, Ty, RangeLikeMetadataKind::Range);
4897}
4898
4899void Verifier::visitNoFPClassMetadata(Instruction &I, MDNode *NoFPClass,
4900 Type *Ty) {
4901 Check(AttributeFuncs::isNoFPClassCompatibleType(Ty),
4902 "nofpclass only applies to floating-point typed loads", I);
4903
4904 Check(NoFPClass->getNumOperands() == 1,
4905 "nofpclass must have exactly one entry", NoFPClass);
4906 ConstantInt *MaskVal =
4908 Check(MaskVal && MaskVal->getType()->isIntegerTy(32),
4909 "nofpclass entry must be a constant i32", NoFPClass);
4910 uint32_t Val = MaskVal->getZExtValue();
4911 Check(Val != 0, "'nofpclass' must have at least one test bit set", NoFPClass,
4912 I);
4913
4914 Check((Val & ~static_cast<unsigned>(fcAllFlags)) == 0,
4915 "Invalid value for 'nofpclass' test mask", NoFPClass, I);
4916}
4917
4918void Verifier::visitNoaliasAddrspaceMetadata(Instruction &I, MDNode *Range,
4919 Type *Ty) {
4920 assert(Range && Range == I.getMetadata(LLVMContext::MD_noalias_addrspace) &&
4921 "precondition violation");
4922 verifyRangeLikeMetadata(I, Range, Ty,
4923 RangeLikeMetadataKind::NoaliasAddrspace);
4924}
4925
4926void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
4927 unsigned Size = DL.getTypeSizeInBits(Ty).getFixedValue();
4928 Check(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
4929 Check(!(Size & (Size - 1)),
4930 "atomic memory access' operand must have a power-of-two size", Ty, I);
4931}
4932
4933void Verifier::visitLoadInst(LoadInst &LI) {
4934 auto *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
4935 Check(PTy, "Load operand must be a pointer.", &LI);
4936 Type *ElTy = LI.getType();
4937 if (MaybeAlign A = LI.getAlign()) {
4938 Check(A->value() <= Value::MaximumAlignment,
4939 "huge alignment values are unsupported", &LI);
4940 }
4941 Check(ElTy->isSized(), "loading unsized types is not allowed", &LI);
4942 if (LI.isAtomic()) {
4943 Check(LI.getOrdering() != AtomicOrdering::Release &&
4944 LI.getOrdering() != AtomicOrdering::AcquireRelease,
4945 "Load cannot have Release ordering", &LI);
4946
4947 if (LI.isElementwise()) {
4948 Check(LI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4949 "atomic elementwise load cannot be sequentially consistent.", &LI);
4950 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
4951 Check(VecTy,
4952 "atomic elementwise load operand must have fixed vector type!", &LI,
4953 ElTy);
4954 if (VecTy)
4955 checkAtomicMemAccessSize(VecTy->getElementType(), &LI);
4956 }
4957
4958 Check(ElTy->getScalarType()->isIntOrPtrTy() ||
4959 ElTy->getScalarType()->isByteTy() ||
4961 "atomic load operand must have integer, byte, pointer, floating "
4962 "point, or vector type!",
4963 ElTy, &LI);
4964
4965 checkAtomicMemAccessSize(ElTy, &LI);
4966 } else {
4967 Check(!LI.isElementwise(), "non-atomic load cannot be elementwise", &LI);
4969 "Non-atomic load cannot have SynchronizationScope specified", &LI);
4970 }
4971
4972 visitInstruction(LI);
4973}
4974
4975void Verifier::visitStoreInst(StoreInst &SI) {
4976 auto *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
4977 Check(PTy, "Store operand must be a pointer.", &SI);
4978 Type *ElTy = SI.getOperand(0)->getType();
4979 if (MaybeAlign A = SI.getAlign()) {
4980 Check(A->value() <= Value::MaximumAlignment,
4981 "huge alignment values are unsupported", &SI);
4982 }
4983 Check(ElTy->isSized(), "storing unsized types is not allowed", &SI);
4984 if (SI.isAtomic()) {
4985 Check(SI.getOrdering() != AtomicOrdering::Acquire &&
4986 SI.getOrdering() != AtomicOrdering::AcquireRelease,
4987 "Store cannot have Acquire ordering", &SI);
4988
4989 if (SI.isElementwise()) {
4990 Check(SI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4991 "atomic elementwise store cannot be sequentially consistent.", &SI);
4992
4993 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
4994 Check(VecTy,
4995 "atomic elementwise store operand must have fixed vector type!",
4996 &SI, ElTy);
4997 if (VecTy)
4998 checkAtomicMemAccessSize(VecTy->getElementType(), &SI);
4999 }
5000
5001 Check(ElTy->getScalarType()->isIntOrPtrTy() ||
5002 ElTy->getScalarType()->isByteTy() ||
5004 "atomic store operand must have integer, byte, pointer, floating "
5005 "point, or vector type!",
5006 ElTy, &SI);
5007 checkAtomicMemAccessSize(ElTy, &SI);
5008 } else {
5009 Check(!SI.isElementwise(), "non-atomic store cannot be elementwise", &SI);
5010 Check(SI.getSyncScopeID() == SyncScope::System,
5011 "Non-atomic store cannot have SynchronizationScope specified", &SI);
5012 }
5013 visitInstruction(SI);
5014}
5015
5016/// Check that SwiftErrorVal is used as a swifterror argument in CS.
5017void Verifier::verifySwiftErrorCall(CallBase &Call,
5018 const Value *SwiftErrorVal) {
5019 for (const auto &I : llvm::enumerate(Call.args())) {
5020 if (I.value() == SwiftErrorVal) {
5021 Check(Call.paramHasAttr(I.index(), Attribute::SwiftError),
5022 "swifterror value when used in a callsite should be marked "
5023 "with swifterror attribute",
5024 SwiftErrorVal, Call);
5025 }
5026 }
5027}
5028
5029void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
5030 // Check that swifterror value is only used by loads, stores, or as
5031 // a swifterror argument.
5032 for (const User *U : SwiftErrorVal->users()) {
5034 isa<InvokeInst>(U),
5035 "swifterror value can only be loaded and stored from, or "
5036 "as a swifterror argument!",
5037 SwiftErrorVal, U);
5038 // If it is used by a store, check it is the second operand.
5039 if (auto StoreI = dyn_cast<StoreInst>(U))
5040 Check(StoreI->getOperand(1) == SwiftErrorVal,
5041 "swifterror value should be the second operand when used "
5042 "by stores",
5043 SwiftErrorVal, U);
5044 if (auto *Call = dyn_cast<CallBase>(U))
5045 verifySwiftErrorCall(*const_cast<CallBase *>(Call), SwiftErrorVal);
5046 }
5047}
5048
5049void Verifier::visitAllocaInst(AllocaInst &AI) {
5051 AI.getModule()->getModuleFlag("require-logical-pointer")))
5052 Check(!MD->getZExtValue(),
5053 "Non-logical alloca disallowed for this module.");
5054
5055 Type *Ty = AI.getAllocatedType();
5056 Check(Ty->isSized(), "Cannot allocate unsized type", &AI);
5057 // Check if it's a target extension type that disallows being used on the
5058 // stack.
5060 "Alloca has illegal target extension type", &AI);
5062 "Alloca array size must have integer type", &AI);
5063 if (MaybeAlign A = AI.getAlign()) {
5064 Check(A->value() <= Value::MaximumAlignment,
5065 "huge alignment values are unsupported", &AI);
5066 }
5067
5068 if (AI.isSwiftError()) {
5069 Check(Ty->isPointerTy(), "swifterror alloca must have pointer type", &AI);
5071 "swifterror alloca must not be array allocation", &AI);
5072 verifySwiftErrorValue(&AI);
5073 }
5074
5075 visitInstruction(AI);
5076
5077 // Target-specific alloca checks.
5078 verifyAMDGPUAlloca(*this, AI);
5079}
5080
5081void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
5082 Type *ElTy = CXI.getOperand(1)->getType();
5083 Check(ElTy->isIntOrPtrTy(),
5084 "cmpxchg operand must have integer or pointer type", ElTy, &CXI);
5085 checkAtomicMemAccessSize(ElTy, &CXI);
5086 visitInstruction(CXI);
5087}
5088
5089void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
5090 Check(RMWI.getOrdering() != AtomicOrdering::Unordered,
5091 "atomicrmw instructions cannot be unordered.", &RMWI);
5092 auto Op = RMWI.getOperation();
5093 Type *ElTy = RMWI.getOperand(1)->getType();
5094 Check(!ElTy->isScalableTy(), "atomicrmw operand may not be scalable", &RMWI);
5095 if (RMWI.isElementwise()) {
5096 Check(RMWI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
5097 "atomicrmw elementwise cannot be sequentially consistent.", &RMWI);
5098 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
5099 Check(VecTy, "atomicrmw elementwise operand must have fixed vector type!",
5100 &RMWI, ElTy);
5101 if (VecTy)
5102 checkAtomicMemAccessSize(VecTy->getElementType(), &RMWI);
5103 }
5104
5105 if (Op == AtomicRMWInst::Xchg) {
5106 Check((ElTy->isIntOrIntVectorTy() || ElTy->isFPOrFPVectorTy() ||
5107 ElTy->isPtrOrPtrVectorTy()),
5108 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5109 " operand must be an integer type, a floating-point type, a "
5110 "pointer type, or a fixed vector of any of these types!",
5111 &RMWI, ElTy);
5112 } else if (AtomicRMWInst::isFPOperation(Op)) {
5113 Check(ElTy->isFPOrFPVectorTy(),
5114 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5115 " operand must have floating-point or fixed vector of "
5116 "floating-point "
5117 "type!",
5118 &RMWI, ElTy);
5119 } else {
5120 Check(ElTy->isIntOrIntVectorTy(),
5121 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5122 " operand must have integer or fixed vector of integer type!",
5123 &RMWI, ElTy);
5124 }
5125 checkAtomicMemAccessSize(ElTy, &RMWI);
5127 "Invalid binary operation!", &RMWI);
5128 visitInstruction(RMWI);
5129}
5130
5131void Verifier::visitFenceInst(FenceInst &FI) {
5132 const AtomicOrdering Ordering = FI.getOrdering();
5133 Check(Ordering == AtomicOrdering::Acquire ||
5134 Ordering == AtomicOrdering::Release ||
5135 Ordering == AtomicOrdering::AcquireRelease ||
5136 Ordering == AtomicOrdering::SequentiallyConsistent,
5137 "fence instructions may only have acquire, release, acq_rel, or "
5138 "seq_cst ordering.",
5139 &FI);
5140 visitInstruction(FI);
5141}
5142
5143void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
5145 EVI.getIndices()) == EVI.getType(),
5146 "Invalid ExtractValueInst operands!", &EVI);
5147
5148 visitInstruction(EVI);
5149}
5150
5151void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
5153 IVI.getIndices()) ==
5154 IVI.getOperand(1)->getType(),
5155 "Invalid InsertValueInst operands!", &IVI);
5156
5157 visitInstruction(IVI);
5158}
5159
5160static Value *getParentPad(Value *EHPad) {
5161 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
5162 return FPI->getParentPad();
5163
5164 return cast<CatchSwitchInst>(EHPad)->getParentPad();
5165}
5166
5167void Verifier::visitEHPadPredecessors(Instruction &I) {
5168 assert(I.isEHPad());
5169
5170 BasicBlock *BB = I.getParent();
5171 Function *F = BB->getParent();
5172
5173 Check(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
5174
5175 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
5176 // The landingpad instruction defines its parent as a landing pad block. The
5177 // landing pad block may be branched to only by the unwind edge of an
5178 // invoke.
5179 for (BasicBlock *PredBB : predecessors(BB)) {
5180 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
5181 Check(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
5182 "Block containing LandingPadInst must be jumped to "
5183 "only by the unwind edge of an invoke.",
5184 LPI);
5185 }
5186 return;
5187 }
5188 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
5189 if (!pred_empty(BB))
5190 Check(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
5191 "Block containg CatchPadInst must be jumped to "
5192 "only by its catchswitch.",
5193 CPI);
5194 Check(BB != CPI->getCatchSwitch()->getUnwindDest(),
5195 "Catchswitch cannot unwind to one of its catchpads",
5196 CPI->getCatchSwitch(), CPI);
5197 return;
5198 }
5199
5200 // Verify that each pred has a legal terminator with a legal to/from EH
5201 // pad relationship.
5202 Instruction *ToPad = &I;
5203 Value *ToPadParent = getParentPad(ToPad);
5204 for (BasicBlock *PredBB : predecessors(BB)) {
5205 Instruction *TI = PredBB->getTerminator();
5206 Value *FromPad;
5207 if (auto *II = dyn_cast<InvokeInst>(TI)) {
5208 Check(II->getUnwindDest() == BB && II->getNormalDest() != BB,
5209 "EH pad must be jumped to via an unwind edge", ToPad, II);
5210 auto *CalledFn =
5211 dyn_cast<Function>(II->getCalledOperand()->stripPointerCasts());
5212 if (CalledFn && CalledFn->isIntrinsic() && II->doesNotThrow() &&
5213 !IntrinsicInst::mayLowerToFunctionCall(CalledFn->getIntrinsicID()))
5214 continue;
5215 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
5216 FromPad = Bundle->Inputs[0];
5217 else
5218 FromPad = ConstantTokenNone::get(II->getContext());
5219 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
5220 FromPad = CRI->getOperand(0);
5221 Check(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
5222 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
5223 FromPad = CSI;
5224 } else {
5225 Check(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
5226 }
5227
5228 // The edge may exit from zero or more nested pads.
5229 SmallPtrSet<Value *, 8> Seen;
5230 for (;; FromPad = getParentPad(FromPad)) {
5231 Check(FromPad != ToPad,
5232 "EH pad cannot handle exceptions raised within it", FromPad, TI);
5233 if (FromPad == ToPadParent) {
5234 // This is a legal unwind edge.
5235 break;
5236 }
5237 Check(!isa<ConstantTokenNone>(FromPad),
5238 "A single unwind edge may only enter one EH pad", TI);
5239 Check(Seen.insert(FromPad).second, "EH pad jumps through a cycle of pads",
5240 FromPad);
5241
5242 // This will be diagnosed on the corresponding instruction already. We
5243 // need the extra check here to make sure getParentPad() works.
5244 Check(isa<FuncletPadInst>(FromPad) || isa<CatchSwitchInst>(FromPad),
5245 "Parent pad must be catchpad/cleanuppad/catchswitch", TI);
5246 }
5247 }
5248}
5249
5250void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
5251 // The landingpad instruction is ill-formed if it doesn't have any clauses and
5252 // isn't a cleanup.
5253 Check(LPI.getNumClauses() > 0 || LPI.isCleanup(),
5254 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
5255
5256 visitEHPadPredecessors(LPI);
5257
5258 if (!LandingPadResultTy)
5259 LandingPadResultTy = LPI.getType();
5260 else
5261 Check(LandingPadResultTy == LPI.getType(),
5262 "The landingpad instruction should have a consistent result type "
5263 "inside a function.",
5264 &LPI);
5265
5266 Function *F = LPI.getParent()->getParent();
5267 Check(F->hasPersonalityFn(),
5268 "LandingPadInst needs to be in a function with a personality.", &LPI);
5269
5270 // The landingpad instruction must be the first non-PHI instruction in the
5271 // block.
5272 Check(LPI.getParent()->getLandingPadInst() == &LPI,
5273 "LandingPadInst not the first non-PHI instruction in the block.", &LPI);
5274
5275 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
5276 Constant *Clause = LPI.getClause(i);
5277 if (LPI.isCatch(i)) {
5278 Check(isa<PointerType>(Clause->getType()),
5279 "Catch operand does not have pointer type!", &LPI);
5280 } else {
5281 Check(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
5283 "Filter operand is not an array of constants!", &LPI);
5284 }
5285 }
5286
5287 visitInstruction(LPI);
5288}
5289
5290void Verifier::visitResumeInst(ResumeInst &RI) {
5292 "ResumeInst needs to be in a function with a personality.", &RI);
5293
5294 if (!LandingPadResultTy)
5295 LandingPadResultTy = RI.getValue()->getType();
5296 else
5297 Check(LandingPadResultTy == RI.getValue()->getType(),
5298 "The resume instruction should have a consistent result type "
5299 "inside a function.",
5300 &RI);
5301
5302 visitTerminator(RI);
5303}
5304
5305void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
5306 BasicBlock *BB = CPI.getParent();
5307
5308 Function *F = BB->getParent();
5309 Check(F->hasPersonalityFn(),
5310 "CatchPadInst needs to be in a function with a personality.", &CPI);
5311
5313 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
5314 CPI.getParentPad());
5315
5316 // The catchpad instruction must be the first non-PHI instruction in the
5317 // block.
5318 Check(&*BB->getFirstNonPHIIt() == &CPI,
5319 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
5320
5322 [](Use &U) {
5323 auto *V = U.get();
5324 return isa<Constant>(V) || isa<AllocaInst>(V);
5325 }),
5326 "Argument operand must be alloca or constant.", &CPI);
5327
5328 visitEHPadPredecessors(CPI);
5329 visitFuncletPadInst(CPI);
5330}
5331
5332void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
5333 Check(isa<CatchPadInst>(CatchReturn.getOperand(0)),
5334 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
5335 CatchReturn.getOperand(0));
5336
5337 visitTerminator(CatchReturn);
5338}
5339
5340void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
5341 BasicBlock *BB = CPI.getParent();
5342
5343 Function *F = BB->getParent();
5344 Check(F->hasPersonalityFn(),
5345 "CleanupPadInst needs to be in a function with a personality.", &CPI);
5346
5347 // The cleanuppad instruction must be the first non-PHI instruction in the
5348 // block.
5349 Check(&*BB->getFirstNonPHIIt() == &CPI,
5350 "CleanupPadInst not the first non-PHI instruction in the block.", &CPI);
5351
5352 auto *ParentPad = CPI.getParentPad();
5353 Check(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
5354 "CleanupPadInst has an invalid parent.", &CPI);
5355
5356 visitEHPadPredecessors(CPI);
5357 visitFuncletPadInst(CPI);
5358}
5359
5360void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
5361 User *FirstUser = nullptr;
5362 Value *FirstUnwindPad = nullptr;
5363 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
5364 SmallPtrSet<FuncletPadInst *, 8> Seen;
5365
5366 while (!Worklist.empty()) {
5367 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
5368 Check(Seen.insert(CurrentPad).second,
5369 "FuncletPadInst must not be nested within itself", CurrentPad);
5370 Value *UnresolvedAncestorPad = nullptr;
5371 for (User *U : CurrentPad->users()) {
5372 BasicBlock *UnwindDest;
5373 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
5374 UnwindDest = CRI->getUnwindDest();
5375 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
5376 // We allow catchswitch unwind to caller to nest
5377 // within an outer pad that unwinds somewhere else,
5378 // because catchswitch doesn't have a nounwind variant.
5379 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
5380 if (CSI->unwindsToCaller())
5381 continue;
5382 UnwindDest = CSI->getUnwindDest();
5383 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
5384 UnwindDest = II->getUnwindDest();
5385 } else if (isa<CallInst>(U)) {
5386 // Calls which don't unwind may be found inside funclet
5387 // pads that unwind somewhere else. We don't *require*
5388 // such calls to be annotated nounwind.
5389 continue;
5390 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
5391 // The unwind dest for a cleanup can only be found by
5392 // recursive search. Add it to the worklist, and we'll
5393 // search for its first use that determines where it unwinds.
5394 Worklist.push_back(CPI);
5395 continue;
5396 } else {
5397 Check(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
5398 continue;
5399 }
5400
5401 Value *UnwindPad;
5402 bool ExitsFPI;
5403 if (UnwindDest) {
5404 UnwindPad = &*UnwindDest->getFirstNonPHIIt();
5405 if (!cast<Instruction>(UnwindPad)->isEHPad())
5406 continue;
5407 Value *UnwindParent = getParentPad(UnwindPad);
5408 // Ignore unwind edges that don't exit CurrentPad.
5409 if (UnwindParent == CurrentPad)
5410 continue;
5411 // Determine whether the original funclet pad is exited,
5412 // and if we are scanning nested pads determine how many
5413 // of them are exited so we can stop searching their
5414 // children.
5415 Value *ExitedPad = CurrentPad;
5416 ExitsFPI = false;
5417 do {
5418 if (ExitedPad == &FPI) {
5419 ExitsFPI = true;
5420 // Now we can resolve any ancestors of CurrentPad up to
5421 // FPI, but not including FPI since we need to make sure
5422 // to check all direct users of FPI for consistency.
5423 UnresolvedAncestorPad = &FPI;
5424 break;
5425 }
5426 Value *ExitedParent = getParentPad(ExitedPad);
5427 if (ExitedParent == UnwindParent) {
5428 // ExitedPad is the ancestor-most pad which this unwind
5429 // edge exits, so we can resolve up to it, meaning that
5430 // ExitedParent is the first ancestor still unresolved.
5431 UnresolvedAncestorPad = ExitedParent;
5432 break;
5433 }
5434 ExitedPad = ExitedParent;
5435 } while (!isa<ConstantTokenNone>(ExitedPad));
5436 } else {
5437 // Unwinding to caller exits all pads.
5438 UnwindPad = ConstantTokenNone::get(FPI.getContext());
5439 ExitsFPI = true;
5440 UnresolvedAncestorPad = &FPI;
5441 }
5442
5443 if (ExitsFPI) {
5444 // This unwind edge exits FPI. Make sure it agrees with other
5445 // such edges.
5446 if (FirstUser) {
5447 Check(UnwindPad == FirstUnwindPad,
5448 "Unwind edges out of a funclet "
5449 "pad must have the same unwind "
5450 "dest",
5451 &FPI, U, FirstUser);
5452 } else {
5453 FirstUser = U;
5454 FirstUnwindPad = UnwindPad;
5455 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
5456 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
5457 getParentPad(UnwindPad) == getParentPad(&FPI))
5458 SiblingFuncletInfo[&FPI] = cast<Instruction>(U);
5459 }
5460 }
5461 // Make sure we visit all uses of FPI, but for nested pads stop as
5462 // soon as we know where they unwind to.
5463 if (CurrentPad != &FPI)
5464 break;
5465 }
5466 if (UnresolvedAncestorPad) {
5467 if (CurrentPad == UnresolvedAncestorPad) {
5468 // When CurrentPad is FPI itself, we don't mark it as resolved even if
5469 // we've found an unwind edge that exits it, because we need to verify
5470 // all direct uses of FPI.
5471 assert(CurrentPad == &FPI);
5472 continue;
5473 }
5474 // Pop off the worklist any nested pads that we've found an unwind
5475 // destination for. The pads on the worklist are the uncles,
5476 // great-uncles, etc. of CurrentPad. We've found an unwind destination
5477 // for all ancestors of CurrentPad up to but not including
5478 // UnresolvedAncestorPad.
5479 Value *ResolvedPad = CurrentPad;
5480 while (!Worklist.empty()) {
5481 Value *UnclePad = Worklist.back();
5482 Value *AncestorPad = getParentPad(UnclePad);
5483 // Walk ResolvedPad up the ancestor list until we either find the
5484 // uncle's parent or the last resolved ancestor.
5485 while (ResolvedPad != AncestorPad) {
5486 Value *ResolvedParent = getParentPad(ResolvedPad);
5487 if (ResolvedParent == UnresolvedAncestorPad) {
5488 break;
5489 }
5490 ResolvedPad = ResolvedParent;
5491 }
5492 // If the resolved ancestor search didn't find the uncle's parent,
5493 // then the uncle is not yet resolved.
5494 if (ResolvedPad != AncestorPad)
5495 break;
5496 // This uncle is resolved, so pop it from the worklist.
5497 Worklist.pop_back();
5498 }
5499 }
5500 }
5501
5502 if (FirstUnwindPad) {
5503 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
5504 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
5505 Value *SwitchUnwindPad;
5506 if (SwitchUnwindDest)
5507 SwitchUnwindPad = &*SwitchUnwindDest->getFirstNonPHIIt();
5508 else
5509 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
5510 Check(SwitchUnwindPad == FirstUnwindPad,
5511 "Unwind edges out of a catch must have the same unwind dest as "
5512 "the parent catchswitch",
5513 &FPI, FirstUser, CatchSwitch);
5514 }
5515 }
5516
5517 visitInstruction(FPI);
5518}
5519
5520void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
5521 BasicBlock *BB = CatchSwitch.getParent();
5522
5523 Function *F = BB->getParent();
5524 Check(F->hasPersonalityFn(),
5525 "CatchSwitchInst needs to be in a function with a personality.",
5526 &CatchSwitch);
5527
5528 // The catchswitch instruction must be the first non-PHI instruction in the
5529 // block.
5530 Check(&*BB->getFirstNonPHIIt() == &CatchSwitch,
5531 "CatchSwitchInst not the first non-PHI instruction in the block.",
5532 &CatchSwitch);
5533
5534 auto *ParentPad = CatchSwitch.getParentPad();
5535 Check(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
5536 "CatchSwitchInst has an invalid parent.", ParentPad);
5537
5538 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
5539 BasicBlock::iterator I = UnwindDest->getFirstNonPHIIt();
5540 Check(I->isEHPad() && !isa<LandingPadInst>(I),
5541 "CatchSwitchInst must unwind to an EH block which is not a "
5542 "landingpad.",
5543 &CatchSwitch);
5544
5545 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
5546 if (getParentPad(&*I) == ParentPad)
5547 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
5548 }
5549
5550 Check(CatchSwitch.getNumHandlers() != 0,
5551 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
5552
5553 for (BasicBlock *Handler : CatchSwitch.handlers()) {
5554 Check(isa<CatchPadInst>(Handler->getFirstNonPHIIt()),
5555 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
5556 }
5557
5558 visitEHPadPredecessors(CatchSwitch);
5559 visitTerminator(CatchSwitch);
5560}
5561
5562void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
5564 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
5565 CRI.getOperand(0));
5566
5567 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
5568 BasicBlock::iterator I = UnwindDest->getFirstNonPHIIt();
5569 Check(I->isEHPad() && !isa<LandingPadInst>(I),
5570 "CleanupReturnInst must unwind to an EH block which is not a "
5571 "landingpad.",
5572 &CRI);
5573 }
5574
5575 visitTerminator(CRI);
5576}
5577
5578void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
5579 Instruction *Op = cast<Instruction>(I.getOperand(i));
5580 // If the we have an invalid invoke, don't try to compute the dominance.
5581 // We already reject it in the invoke specific checks and the dominance
5582 // computation doesn't handle multiple edges.
5583 if (auto *II = dyn_cast<InvokeInst>(Op)) {
5584 if (II->getNormalDest() == II->getUnwindDest())
5585 return;
5586 }
5587
5588 // Quick check whether the def has already been encountered in the same block.
5589 // PHI nodes are not checked to prevent accepting preceding PHIs, because PHI
5590 // uses are defined to happen on the incoming edge, not at the instruction.
5591 //
5592 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
5593 // wrapping an SSA value, assert that we've already encountered it. See
5594 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
5595 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
5596 return;
5597
5598 const Use &U = I.getOperandUse(i);
5599 Check(DT.dominates(Op, U), "Instruction does not dominate all uses!", Op, &I);
5600}
5601
5602void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
5603 Check(I.getType()->isPointerTy(),
5604 "dereferenceable, dereferenceable_or_null "
5605 "apply only to pointer types",
5606 &I);
5608 "dereferenceable, dereferenceable_or_null apply only to load"
5609 " and inttoptr instructions, use attributes for calls or invokes",
5610 &I);
5611 Check(MD->getNumOperands() == 1,
5612 "dereferenceable, dereferenceable_or_null "
5613 "take one operand!",
5614 &I);
5615 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
5616 Check(CI && CI->getType()->isIntegerTy(64),
5617 "dereferenceable, "
5618 "dereferenceable_or_null metadata value must be an i64!",
5619 &I);
5620}
5621
5622void Verifier::visitNoFreeObjMetadata(Instruction &I, MDNode *MD) {
5623 Check(I.getType()->isPointerTy(), "nofreeobj applies only to pointer types",
5624 &I);
5626 "nofreeobj applies only to inttoptr instruction", &I);
5627 Check(MD->getNumOperands() == 0, "nofreeobj metadata must be empty", &I);
5628}
5629
5630void Verifier::visitProfMetadata(Instruction &I, MDNode *MD) {
5631 auto GetBranchingTerminatorNumOperands = [&]() {
5632 unsigned ExpectedNumOperands = 0;
5633 if (auto *BI = dyn_cast<CondBrInst>(&I))
5634 ExpectedNumOperands = BI->getNumSuccessors();
5635 else if (auto *SI = dyn_cast<SwitchInst>(&I))
5636 ExpectedNumOperands = SI->getNumSuccessors();
5637 else if (isa<CallInst>(&I))
5638 ExpectedNumOperands = 1;
5639 else if (auto *IBI = dyn_cast<IndirectBrInst>(&I))
5640 ExpectedNumOperands = IBI->getNumDestinations();
5641 else if (isa<SelectInst>(&I))
5642 ExpectedNumOperands = 2;
5643 else if (auto *CI = dyn_cast<CallBrInst>(&I))
5644 ExpectedNumOperands = CI->getNumSuccessors();
5645 return ExpectedNumOperands;
5646 };
5647 Check(MD->getNumOperands() >= 1,
5648 "!prof annotations should have at least 1 operand", MD);
5649 // Check first operand.
5650 Check(MD->getOperand(0) != nullptr, "first operand should not be null", MD);
5652 "expected string with name of the !prof annotation", MD);
5653 MDString *MDS = cast<MDString>(MD->getOperand(0));
5654 StringRef ProfName = MDS->getString();
5655
5657 Check(GetBranchingTerminatorNumOperands() != 0 || isa<InvokeInst>(I),
5658 "'unknown' !prof should only appear on instructions on which "
5659 "'branch_weights' would",
5660 MD);
5661 verifyUnknownProfileMetadata(MD);
5662 return;
5663 }
5664
5665 Check(MD->getNumOperands() >= 2,
5666 "!prof annotations should have no less than 2 operands", MD);
5667
5668 // Check consistency of !prof branch_weights metadata.
5669 if (ProfName == MDProfLabels::BranchWeights) {
5670 unsigned NumBranchWeights = getNumBranchWeights(*MD);
5671 if (isa<InvokeInst>(&I)) {
5672 Check(NumBranchWeights == 1 || NumBranchWeights == 2,
5673 "Wrong number of InvokeInst branch_weights operands", MD);
5674 } else {
5675 const unsigned ExpectedNumOperands = GetBranchingTerminatorNumOperands();
5676 if (ExpectedNumOperands == 0)
5677 CheckFailed("!prof branch_weights are not allowed for this instruction",
5678 MD);
5679
5680 Check(NumBranchWeights == ExpectedNumOperands, "Wrong number of operands",
5681 MD);
5682 }
5683 for (unsigned i = getBranchWeightOffset(MD); i < MD->getNumOperands();
5684 ++i) {
5685 auto &MDO = MD->getOperand(i);
5686 Check(MDO, "second operand should not be null", MD);
5688 "!prof brunch_weights operand is not a const int");
5689 }
5690 } else if (ProfName == MDProfLabels::ValueProfile) {
5691 Check(isValueProfileMD(MD), "invalid value profiling metadata", MD);
5692 ConstantInt *KindInt = mdconst::dyn_extract<ConstantInt>(MD->getOperand(1));
5693 Check(KindInt, "VP !prof missing kind argument", MD);
5694
5695 auto Kind = KindInt->getZExtValue();
5696 Check(Kind >= InstrProfValueKind::IPVK_First &&
5697 Kind <= InstrProfValueKind::IPVK_Last,
5698 "Invalid VP !prof kind", MD);
5699 Check(MD->getNumOperands() % 2 == 1,
5700 "VP !prof should have an even number "
5701 "of arguments after 'VP'",
5702 MD);
5703 if (Kind == InstrProfValueKind::IPVK_IndirectCallTarget ||
5704 Kind == InstrProfValueKind::IPVK_MemOPSize)
5706 "VP !prof indirect call or memop size expected to be applied to "
5707 "CallBase instructions only",
5708 MD);
5709
5710 DenseSet<uint64_t> ProfileValues;
5711 for (unsigned I = 3; I < MD->getNumOperands(); I += 2) {
5712 ConstantInt *ProfileValue =
5714 Check(ProfileValue, "VP !prof value operand is not a const int", MD);
5715 uint64_t ProfileValueInt = ProfileValue->getZExtValue();
5716 auto [ValueIt, Inserted] = ProfileValues.insert(ProfileValueInt);
5717 Check(Inserted, "VP !prof should not have duplicate profile values", MD);
5718 }
5719 } else {
5720 CheckFailed("expected either branch_weights or VP profile name", MD);
5721 }
5722}
5723
5724void Verifier::visitDIAssignIDMetadata(Instruction &I, MDNode *MD) {
5725 assert(I.hasMetadata(LLVMContext::MD_DIAssignID));
5726 // DIAssignID metadata must be attached to either an alloca or some form of
5727 // store/memory-writing instruction.
5728 // FIXME: We allow all intrinsic insts here to avoid trying to enumerate all
5729 // possible store intrinsics.
5730 bool ExpectedInstTy =
5732 CheckDI(ExpectedInstTy, "!DIAssignID attached to unexpected instruction kind",
5733 I, MD);
5734 for (DbgVariableRecord *DVR : at::getAssignmentMarkers(cast<DIAssignID>(MD)))
5735 CheckDI(DVR->getFunction() == I.getFunction(),
5736 "DVRAssign not in same function as inst", DVR, &I);
5737}
5738
5739void Verifier::visitMMRAMetadata(Instruction &I, MDNode *MD) {
5741 "!mmra metadata attached to unexpected instruction kind", I, MD);
5742
5743 // MMRA Metadata should either be a tag, e.g. !{!"foo", !"bar"}, or a
5744 // list of tags such as !2 in the following example:
5745 // !0 = !{!"a", !"b"}
5746 // !1 = !{!"c", !"d"}
5747 // !2 = !{!0, !1}
5748 if (MMRAMetadata::isTagMD(MD))
5749 return;
5750
5751 Check(isa<MDTuple>(MD), "!mmra expected to be a metadata tuple", I, MD);
5752 for (const MDOperand &MDOp : MD->operands())
5753 Check(MMRAMetadata::isTagMD(MDOp.get()),
5754 "!mmra metadata tuple operand is not an MMRA tag", I, MDOp.get());
5755}
5756
5757void Verifier::visitCallStackMetadata(MDNode *MD) {
5758 // Call stack metadata should consist of a list of at least 1 constant int
5759 // (representing a hash of the location).
5760 Check(MD->getNumOperands() >= 1,
5761 "call stack metadata should have at least 1 operand", MD);
5762
5763 for (const auto &Op : MD->operands())
5765 "call stack metadata operand should be constant integer", Op);
5766}
5767
5768void Verifier::visitMemProfMetadata(Instruction &I, MDNode *MD) {
5769 Check(isa<CallBase>(I), "!memprof metadata should only exist on calls", &I);
5770 if (isa<CallBase>(I))
5771 Check(I.hasMetadata(LLVMContext::MD_callsite),
5772 "!memprof metadata requires !callsite metadata", &I, MD);
5773 Check(MD->getNumOperands() >= 1,
5774 "!memprof annotations should have at least 1 metadata operand "
5775 "(MemInfoBlock)",
5776 MD);
5777
5778 // Check each MIB
5779 for (auto &MIBOp : MD->operands()) {
5780 auto *MIB = dyn_cast<MDNode>(MIBOp);
5781 // The first operand of an MIB should be the call stack metadata.
5782 // There rest of the operands should be MDString tags, and there should be
5783 // at least one.
5784 Check(MIB->getNumOperands() >= 2,
5785 "Each !memprof MemInfoBlock should have at least 2 operands", MIB);
5786
5787 // Check call stack metadata (first operand).
5788 Check(MIB->getOperand(0) != nullptr,
5789 "!memprof MemInfoBlock first operand should not be null", MIB);
5790 Check(isa<MDNode>(MIB->getOperand(0)),
5791 "!memprof MemInfoBlock first operand should be an MDNode", MIB);
5792 auto *StackMD = dyn_cast<MDNode>(MIB->getOperand(0));
5793 visitCallStackMetadata(StackMD);
5794
5795 // The second MIB operand should be MDString.
5796 Check(isa<MDString>(MIB->getOperand(1)),
5797 "!memprof MemInfoBlock second operand should be an MDString", MIB);
5798
5799 // Any remaining should be MDNode that are pairs of integers
5800 for (unsigned I = 2; I < MIB->getNumOperands(); ++I) {
5801 auto *OpNode = dyn_cast<MDNode>(MIB->getOperand(I));
5802 Check(OpNode, "Not all !memprof MemInfoBlock operands 2 to N are MDNode",
5803 MIB);
5804 Check(OpNode->getNumOperands() == 2,
5805 "Not all !memprof MemInfoBlock operands 2 to N are MDNode with 2 "
5806 "operands",
5807 MIB);
5808 // Check that all of Op's operands are ConstantInt.
5809 Check(llvm::all_of(OpNode->operands(),
5810 [](const MDOperand &Op) {
5811 return mdconst::hasa<ConstantInt>(Op);
5812 }),
5813 "Not all !memprof MemInfoBlock operands 2 to N are MDNode with "
5814 "ConstantInt operands",
5815 MIB);
5816 }
5817 }
5818}
5819
5820void Verifier::visitCallsiteMetadata(Instruction &I, MDNode *MD) {
5821 Check(isa<CallBase>(I), "!callsite metadata should only exist on calls", &I);
5822 // Verify the partial callstack annotated from memprof profiles. This callsite
5823 // is a part of a profiled allocation callstack.
5824 visitCallStackMetadata(MD);
5825}
5826
5827void Verifier::visitCalleeTypeMetadata(Instruction &I, MDNode *MD) {
5828 Check(isa<CallBase>(I), "!callee_type metadata should only exist on calls",
5829 &I);
5830 for (Metadata *Op : MD->operands()) {
5832 "The callee_type metadata must be a list of callgraph metadata nodes",
5833 Op);
5834 auto *CallgraphMD = cast<MDNode>(Op);
5835 Check(CallgraphMD->getNumOperands() == 1,
5836 "Well-formed callgraph metadata must contain exactly one "
5837 "operand",
5838 Op);
5839 Check(isa<MDString>(CallgraphMD->getOperand(0)),
5840 "The operand of callgraph metadata for functions must be an MDString",
5841 Op);
5842 }
5843}
5844
5845void Verifier::visitAnnotationMetadata(MDNode *Annotation) {
5846 Check(isa<MDTuple>(Annotation), "annotation must be a tuple");
5847 Check(Annotation->getNumOperands() >= 1,
5848 "annotation must have at least one operand");
5849 for (const MDOperand &Op : Annotation->operands()) {
5850 bool TupleOfStrings =
5851 isa<MDTuple>(Op.get()) &&
5852 all_of(cast<MDTuple>(Op)->operands(), [](auto &Annotation) {
5853 return isa<MDString>(Annotation.get());
5854 });
5855 Check(isa<MDString>(Op.get()) || TupleOfStrings,
5856 "operands must be a string or a tuple of strings");
5857 }
5858}
5859
5860void Verifier::visitAliasScopeMetadata(const MDNode *MD) {
5861 unsigned NumOps = MD->getNumOperands();
5862 Check(NumOps >= 2 && NumOps <= 3, "scope must have two or three operands",
5863 MD);
5864 Check(MD->getOperand(0).get() == MD || isa<MDString>(MD->getOperand(0)),
5865 "first scope operand must be self-referential or string", MD);
5866 if (NumOps == 3)
5868 "third scope operand must be string (if used)", MD);
5869
5870 auto *Domain = dyn_cast<MDNode>(MD->getOperand(1));
5871 Check(Domain != nullptr, "second scope operand must be MDNode", MD);
5872
5873 unsigned NumDomainOps = Domain->getNumOperands();
5874 Check(NumDomainOps >= 2 && NumDomainOps <= 3,
5875 "domain must have two or three operands", Domain);
5876 Check(Domain->getOperand(0).get() == Domain ||
5877 isa<MDString>(Domain->getOperand(0)),
5878 "first domain operand must be self-referential or string", Domain);
5879 const auto *Disjoint =
5881 Check(Disjoint && Disjoint->getBitWidth() == 1,
5882 "second domain operand must be an i1 constant", Domain);
5883 if (NumDomainOps == 3)
5884 Check(isa<MDString>(Domain->getOperand(2)),
5885 "third domain operand must be string (if used)", Domain);
5886}
5887
5888void Verifier::visitAliasScopeListMetadata(const MDNode *MD) {
5889 for (const MDOperand &Op : MD->operands()) {
5890 const auto *OpMD = dyn_cast<MDNode>(Op);
5891 Check(OpMD != nullptr, "scope list must consist of MDNodes", MD);
5892 visitAliasScopeMetadata(OpMD);
5893 }
5894}
5895
5896void Verifier::visitAccessGroupMetadata(const MDNode *MD) {
5897 auto IsValidAccessScope = [](const MDNode *MD) {
5898 return MD->getNumOperands() == 0 && MD->isDistinct();
5899 };
5900
5901 // An empty node is an access scope, and it must be 'distinct'. It is never a
5902 // list, because an empty list is not allowed: it would look the same as an
5903 // access scope.
5904 if (MD->getNumOperands() == 0) {
5905 Check(MD->isDistinct(), "Access scope must be 'distinct'", MD);
5906 return;
5907 }
5908
5909 // A non-empty node is a list of access scopes.
5910 for (const MDOperand &Op : MD->operands()) {
5911 const auto *OpMD = dyn_cast<MDNode>(Op);
5912 Check(OpMD != nullptr, "Access scope list must consist of MDNodes", MD);
5913 Check(IsValidAccessScope(OpMD),
5914 "Access scope list contains invalid access scope", MD);
5915 }
5916}
5917
5918void Verifier::visitCapturesMetadata(Instruction &I, const MDNode *Captures) {
5919 static const char *ValidArgs[] = {"address_is_null", "address",
5920 "read_provenance", "provenance"};
5921
5922 auto *SI = dyn_cast<StoreInst>(&I);
5923 Check(SI, "!captures metadata can only be applied to store instructions", &I);
5924 Check(SI->getValueOperand()->getType()->isPointerTy(),
5925 "!captures metadata can only be applied to store with value operand of "
5926 "pointer type",
5927 &I);
5928 Check(Captures->getNumOperands() != 0, "!captures metadata cannot be empty",
5929 &I);
5930
5931 for (Metadata *Op : Captures->operands()) {
5932 auto *Str = dyn_cast<MDString>(Op);
5933 Check(Str, "!captures metadata must be a list of strings", &I);
5934 Check(is_contained(ValidArgs, Str->getString()),
5935 "invalid entry in !captures metadata", &I, Str);
5936 }
5937}
5938
5939void Verifier::visitAllocTokenMetadata(Instruction &I, MDNode *MD) {
5940 Check(isa<CallBase>(I), "!alloc_token should only exist on calls", &I);
5941 Check(MD->getNumOperands() == 2 || MD->getNumOperands() == 3,
5942 "!alloc_token must have 2 or 3 operands", MD);
5943 Check(isa_and_nonnull<MDString>(MD->getOperand(0)), "expected string", MD);
5945 "expected integer constant", MD);
5946 if (MD->getNumOperands() == 3)
5948 "expected function name string", MD);
5949}
5950
5951void Verifier::visitInlineHistoryMetadata(Instruction &I, MDNode *MD) {
5952 Check(isa<CallBase>(I), "!inline_history should only exist on calls", &I);
5953 for (Metadata *Op : MD->operands()) {
5954 // Can be null when a function is erased.
5955 if (!Op)
5956 continue;
5959 ->getValue()
5960 ->stripPointerCastsAndAliases()),
5961 "!inline_history operands must be functions or null", MD);
5962 }
5963}
5964
5965void Verifier::visitMemCacheHintMetadata(Instruction &I, MDNode *MD) {
5966 Check(I.mayReadOrWriteMemory(),
5967 "!mem.cache_hint is only valid on memory operations", &I);
5968
5969 Check(MD->getNumOperands() % 2 == 0,
5970 "!mem.cache_hint must have even number of operands "
5971 "(operand_no, hint_node pairs)",
5972 MD);
5973
5974 const auto *CB = dyn_cast<CallBase>(&I);
5975 if (CB)
5976 Check(CB->getIntrinsicID() != Intrinsic::not_intrinsic,
5977 "!mem.cache_hint is not supported on non-intrinsic calls", &I);
5978
5979 unsigned NumOperands = CB ? CB->arg_size() : I.getNumOperands();
5980
5981 SmallDenseSet<unsigned, 4> SeenOperandNos;
5982 std::optional<uint64_t> LastOperandNo;
5983
5984 // Top-level metadata alternates: i32 operand_no, MDNode hint_node.
5985 for (unsigned J = 0; J + 1 < MD->getNumOperands(); J += 2) {
5986 auto *OpNoCI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(J));
5987 Check(OpNoCI,
5988 "!mem.cache_hint must alternate between i32 operand numbers and "
5989 "metadata hint nodes",
5990 MD);
5991
5992 Check(OpNoCI->getValue().isNonNegative(),
5993 "!mem.cache_hint operand number must be non-negative", MD);
5994
5995 uint64_t OperandNo = OpNoCI->getZExtValue();
5996 Check(OperandNo < NumOperands,
5997 "!mem.cache_hint operand number is out of range", &I);
5998
5999 Value *Operand =
6000 CB ? CB->getArgOperand(OperandNo) : I.getOperand(OperandNo);
6001 Check(Operand->getType()->isPtrOrPtrVectorTy(),
6002 "!mem.cache_hint operand number must refer to a pointer operand", &I);
6003
6004 bool Inserted = SeenOperandNos.insert(OperandNo).second;
6005 Check(Inserted, "!mem.cache_hint contains duplicate operand number", MD);
6006
6007 Check(!Inserted || !LastOperandNo || OperandNo > *LastOperandNo,
6008 "!mem.cache_hint operand numbers must be in increasing order", MD);
6009 LastOperandNo = OperandNo;
6010
6011 const auto *Node = dyn_cast<MDNode>(MD->getOperand(J + 1));
6012 Check(Node,
6013 "!mem.cache_hint must alternate between i32 operand numbers and "
6014 "metadata hint nodes",
6015 MD);
6016
6017 Check(Node->getNumOperands() % 2 == 0,
6018 "!mem.cache_hint hint node must have even number of operands "
6019 "(key-value pairs)",
6020 Node);
6021
6022 StringSet<> SeenKeys;
6023 for (unsigned K = 0; K + 1 < Node->getNumOperands(); K += 2) {
6024 const auto *Key = dyn_cast<MDString>(Node->getOperand(K));
6025 Check(Key, "!mem.cache_hint key must be a string", Node);
6026
6027 StringRef KeyStr = Key->getString();
6028 Check(SeenKeys.insert(KeyStr).second,
6029 "!mem.cache_hint hint node contains duplicate key", Node);
6030
6031 const Metadata *Value = Node->getOperand(K + 1).get();
6034 "!mem.cache_hint value must be a string or integer", Node);
6035 }
6036 }
6037}
6038
6039/// verifyInstruction - Verify that an instruction is well formed.
6040///
6041void Verifier::visitInstruction(Instruction &I) {
6042 BasicBlock *BB = I.getParent();
6043 Check(BB, "Instruction not embedded in basic block!", &I);
6044
6045 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
6046 for (User *U : I.users()) {
6047 Check(U != (User *)&I || !DT.isReachableFromEntry(BB),
6048 "Only PHI nodes may reference their own value!", &I);
6049 }
6050 }
6051
6052 // Check that void typed values don't have names
6053 Check(!I.getType()->isVoidTy() || !I.hasName(),
6054 "Instruction has a name, but provides a void value!", &I);
6055
6056 // Check that the return value of the instruction is either void or a legal
6057 // value type.
6058 Check(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
6059 "Instruction returns a non-scalar type!", &I);
6060
6061 // Check that the instruction doesn't produce metadata. Calls are already
6062 // checked against the callee type.
6063 Check(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
6064 "Invalid use of metadata!", &I);
6065
6066 // Check that all uses of the instruction, if they are instructions
6067 // themselves, actually have parent basic blocks. If the use is not an
6068 // instruction, it is an error!
6069 for (Use &U : I.uses()) {
6070 if (auto *Used = dyn_cast<Instruction>(U.getUser()))
6071 Check(Used->getParent() != nullptr,
6072 "Instruction referencing"
6073 " instruction not embedded in a basic block!",
6074 &I, Used);
6075 else {
6076 CheckFailed("Use of instruction is not an instruction!", U);
6077 return;
6078 }
6079 }
6080
6081 // Get a pointer to the call base of the instruction if it is some form of
6082 // call.
6083 const auto *CBI = dyn_cast<CallBase>(&I);
6084
6085 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
6086 Check(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
6087
6088 // Check to make sure that only first-class-values are operands to
6089 // instructions.
6090 if (!I.getOperand(i)->getType()->isFirstClassType()) {
6091 Check(false, "Instruction operands must be first-class values!", &I);
6092 }
6093
6094 if (auto *F = dyn_cast<Function>(I.getOperand(i))) {
6095 // This code checks whether the function is used as the operand of a
6096 // clang_arc_attachedcall operand bundle.
6097 auto IsAttachedCallOperand = [](Function *F, const CallBase *CBI,
6098 int Idx) {
6099 return CBI && CBI->isOperandBundleOfType(
6101 };
6102
6103 // Check to make sure that the "address of" an intrinsic function is never
6104 // taken. Ignore cases where the address of the intrinsic function is used
6105 // as the argument of operand bundle "clang.arc.attachedcall" as those
6106 // cases are handled in verifyAttachedCallBundle.
6107 Check((!F->isIntrinsic() ||
6108 (CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i)) ||
6109 IsAttachedCallOperand(F, CBI, i)),
6110 "Cannot take the address of an intrinsic!", &I);
6111 Check(!F->isIntrinsic() || isa<CallInst>(I) || isa<CallBrInst>(I) ||
6112 F->getIntrinsicID() == Intrinsic::donothing ||
6113 F->getIntrinsicID() == Intrinsic::seh_try_begin ||
6114 F->getIntrinsicID() == Intrinsic::seh_try_end ||
6115 F->getIntrinsicID() == Intrinsic::seh_scope_begin ||
6116 F->getIntrinsicID() == Intrinsic::seh_scope_end ||
6117 F->getIntrinsicID() == Intrinsic::coro_resume ||
6118 F->getIntrinsicID() == Intrinsic::coro_destroy ||
6119 F->getIntrinsicID() == Intrinsic::coro_await_suspend_void ||
6120 F->getIntrinsicID() == Intrinsic::coro_await_suspend_bool ||
6121 F->getIntrinsicID() == Intrinsic::coro_await_suspend_handle ||
6122 F->getIntrinsicID() ==
6123 Intrinsic::experimental_patchpoint_void ||
6124 F->getIntrinsicID() == Intrinsic::experimental_patchpoint ||
6125 F->getIntrinsicID() == Intrinsic::fake_use ||
6126 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint ||
6127 F->getIntrinsicID() == Intrinsic::wasm_throw ||
6128 F->getIntrinsicID() == Intrinsic::wasm_rethrow ||
6129 F->getIntrinsicID() == Intrinsic::bpf_unwind_exit ||
6130 IsAttachedCallOperand(F, CBI, i),
6131 "Cannot invoke an intrinsic other than donothing, patchpoint, "
6132 "statepoint, coro_resume, coro_destroy, clang.arc.attachedcall, "
6133 "wasm.(re)throw or bpf.unwind.exit",
6134 &I);
6135 Check(F->getParent() == &M, "Referencing function in another module!", &I,
6136 &M, F, F->getParent());
6137 } else if (auto *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
6138 Check(OpBB->getParent() == BB->getParent(),
6139 "Referring to a basic block in another function!", &I);
6140 } else if (auto *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
6141 Check(OpArg->getParent() == BB->getParent(),
6142 "Referring to an argument in another function!", &I);
6143 } else if (auto *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
6144 Check(GV->getParent() == &M, "Referencing global in another module!", &I,
6145 &M, GV, GV->getParent());
6146 } else if (auto *OpInst = dyn_cast<Instruction>(I.getOperand(i))) {
6147 Check(OpInst->getFunction() == BB->getParent(),
6148 "Referring to an instruction in another function!", &I);
6149 verifyDominatesUse(I, i);
6150 } else if (isa<InlineAsm>(I.getOperand(i))) {
6151 Check(CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i),
6152 "Cannot take the address of an inline asm!", &I);
6153 } else if (auto *C = dyn_cast<Constant>(I.getOperand(i))) {
6154 visitConstantExprsRecursively(C);
6155 }
6156 }
6157
6158 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
6160 "fpmath requires a floating point result!", &I);
6161 Check(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
6162 if (ConstantFP *CFP0 =
6164 const APFloat &Accuracy = CFP0->getValueAPF();
6165 Check(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
6166 "fpmath accuracy must have float type", &I);
6167 Check(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
6168 "fpmath accuracy not a positive number!", &I);
6169 } else {
6170 Check(false, "invalid fpmath accuracy!", &I);
6171 }
6172 }
6173
6174 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
6176 "Ranges are only for loads, calls and invokes!", &I);
6177 visitRangeMetadata(I, Range, I.getType());
6178 }
6179
6180 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nofpclass)) {
6181 Check(isa<LoadInst>(I), "nofpclass is only for loads", &I);
6182 visitNoFPClassMetadata(I, MD, I.getType());
6183 }
6184
6185 if (MDNode *Range = I.getMetadata(LLVMContext::MD_noalias_addrspace)) {
6188 "noalias.addrspace are only for memory operations!", &I);
6189 visitNoaliasAddrspaceMetadata(I, Range, I.getType());
6190 }
6191
6192 if (I.hasMetadata(LLVMContext::MD_invariant_group)) {
6194 "invariant.group metadata is only for loads and stores", &I);
6195 }
6196
6197 if (I.hasMetadata(LLVMContext::MD_invariant_load)) {
6198 auto *II = dyn_cast<IntrinsicInst>(&I);
6199 Check(isa<LoadInst>(I) || (II && II->onlyReadsMemory()),
6200 "invariant.load metadata is only for loads and readonly "
6201 "intrinsic calls",
6202 &I);
6203 }
6204
6205 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nonnull)) {
6206 Check(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
6207 &I);
6209 "nonnull applies only to load instructions, use attributes"
6210 " for calls or invokes",
6211 &I);
6212 Check(MD->getNumOperands() == 0, "nonnull metadata must be empty", &I);
6213 }
6214
6215 if (MDNode *MD = I.getMetadata(LLVMContext::MD_noundef)) {
6216 Check(isa<LoadInst>(I), "noundef applies only to load instructions", &I);
6217 Check(MD->getNumOperands() == 0, "noundef metadata must be empty", &I);
6218 }
6219
6220 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
6221 visitDereferenceableMetadata(I, MD);
6222
6223 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
6224 visitDereferenceableMetadata(I, MD);
6225
6226 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nofreeobj))
6227 visitNoFreeObjMetadata(I, MD);
6228
6229 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
6230 TBAAVerifyHelper.visitTBAAMetadata(&I, TBAA);
6231
6232 if (MDNode *TBAAStruct = I.getMetadata(LLVMContext::MD_tbaa_struct))
6233 TBAAVerifyHelper.visitTBAAStructMetadata(&I, TBAAStruct);
6234
6235 if (MDNode *MD = I.getMetadata(LLVMContext::MD_noalias))
6236 visitAliasScopeListMetadata(MD);
6237 if (MDNode *MD = I.getMetadata(LLVMContext::MD_alias_scope))
6238 visitAliasScopeListMetadata(MD);
6239
6240 if (MDNode *MD = I.getMetadata(LLVMContext::MD_access_group))
6241 visitAccessGroupMetadata(MD);
6242
6243 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
6244 Check(I.getType()->isPointerTy(), "align applies only to pointer types",
6245 &I);
6247 "align applies only to load instructions, "
6248 "use attributes for calls or invokes",
6249 &I);
6250 Check(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
6251 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
6252 Check(CI && CI->getType()->isIntegerTy(64),
6253 "align metadata value must be an i64!", &I);
6254 uint64_t Align = CI->getZExtValue();
6255 Check(isPowerOf2_64(Align), "align metadata value must be a power of 2!",
6256 &I);
6257 Check(Align <= Value::MaximumAlignment,
6258 "alignment is larger that implementation defined limit", &I);
6259 }
6260
6261 if (MDNode *MD = I.getMetadata(LLVMContext::MD_prof))
6262 visitProfMetadata(I, MD);
6263
6264 if (MDNode *MD = I.getMetadata(LLVMContext::MD_memprof))
6265 visitMemProfMetadata(I, MD);
6266
6267 if (MDNode *MD = I.getMetadata(LLVMContext::MD_callsite))
6268 visitCallsiteMetadata(I, MD);
6269
6270 if (MDNode *MD = I.getMetadata(LLVMContext::MD_callee_type))
6271 visitCalleeTypeMetadata(I, MD);
6272
6273 if (MDNode *MD = I.getMetadata(LLVMContext::MD_DIAssignID))
6274 visitDIAssignIDMetadata(I, MD);
6275
6276 if (MDNode *MMRA = I.getMetadata(LLVMContext::MD_mmra))
6277 visitMMRAMetadata(I, MMRA);
6278
6279 if (MDNode *Annotation = I.getMetadata(LLVMContext::MD_annotation))
6280 visitAnnotationMetadata(Annotation);
6281
6282 if (MDNode *Captures = I.getMetadata(LLVMContext::MD_captures))
6283 visitCapturesMetadata(I, Captures);
6284
6285 if (MDNode *MD = I.getMetadata(LLVMContext::MD_alloc_token))
6286 visitAllocTokenMetadata(I, MD);
6287
6288 if (MDNode *MD = I.getMetadata(LLVMContext::MD_inline_history))
6289 visitInlineHistoryMetadata(I, MD);
6290
6291 if (MDNode *MD = I.getMetadata(LLVMContext::MD_mem_cache_hint))
6292 visitMemCacheHintMetadata(I, MD);
6293
6294 if (MDNode *MD = I.getMetadata("amdgpu.expected.active.lanes")) {
6295 Check(MD->getNumOperands() == 1,
6296 "!amdgpu.expected.active.lanes must have exactly one operand", &I,
6297 MD);
6298 ConstantInt *CI =
6300 Check(CI && CI->getType()->isIntegerTy(32),
6301 "!amdgpu.expected.active.lanes operand must be an i32 constant", &I,
6302 MD);
6303 }
6304
6305 if (MDNode *MD = I.getMetadata("amdgpu.cfs")) {
6306 Check(MD->getNumOperands() == 1,
6307 "!amdgpu.cfs must have exactly one operand", &I, MD);
6308 ConstantInt *CI =
6310 Check(CI && CI->getType()->isIntegerTy(32),
6311 "!amdgpu.cfs operand must be an i32 constant", &I, MD);
6312 Check(CI->getZExtValue() <= 3,
6313 "!amdgpu.cfs operand must be in the range [0, 3]", &I, MD);
6314 }
6315
6316 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
6317 CheckDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
6318 visitMDNode(*N, AreDebugLocsAllowed::Yes);
6319
6320 if (auto *DL = dyn_cast<DILocation>(N)) {
6321 if (DL->getAtomGroup()) {
6322 DISubprogram *SP = getSubprogram(DL->getRawScope());
6323 CheckDI(SP && SP->getKeyInstructionsEnabled(),
6324 "DbgLoc uses atomGroup but DISubprogram doesn't have Key "
6325 "Instructions enabled",
6326 DL, SP);
6327 }
6328 }
6329 }
6330
6332 I.getAllMetadata(MDs);
6333 for (auto Attachment : MDs) {
6334 unsigned Kind = Attachment.first;
6335 auto AllowLocs =
6336 (Kind == LLVMContext::MD_dbg || Kind == LLVMContext::MD_loop)
6337 ? AreDebugLocsAllowed::Yes
6338 : AreDebugLocsAllowed::No;
6339 visitMDNode(*Attachment.second, AllowLocs);
6340 }
6341
6342 InstsInThisBlock.insert(&I);
6343}
6344
6345/// Allow intrinsics to be verified in different ways.
6346void Verifier::visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call) {
6348
6349 // If the intrinsic takes MDNode arguments, verify that they are either global
6350 // or are local to *this* function.
6351 for (Value *V : Call.args()) {
6352 if (auto *MD = dyn_cast<MetadataAsValue>(V))
6353 visitMetadataAsValue(*MD, Call.getCaller());
6354 if (auto *Const = dyn_cast<Constant>(V))
6355 Check(!Const->getType()->isX86_AMXTy(),
6356 "const x86_amx is not allowed in argument!");
6357 }
6358
6359 // Verify intrinsic signature, so following checks can rely on it. The actual
6360 // error is reported at the intrinsic declaration.
6361 SmallVector<Type *, 4> OverloadTys;
6362 if (!Intrinsic::isSignatureValid(ID, Call.getFunctionType(), OverloadTys))
6363 return;
6364
6365 switch (ID) {
6366 default:
6367 break;
6368 case Intrinsic::assume: {
6369 if (Call.hasOperandBundles()) {
6371 Check(Cond && Cond->isOne(),
6372 "assume with operand bundles must have i1 true condition", Call);
6373 }
6374 for (auto OBU : Call.operand_bundles()) {
6375 // Separate storage assumptions are special insofar as they're the only
6376 // operand bundles allowed on assumes that aren't parameter attributes.
6377
6378 auto GetTypeAt = [&](unsigned Index) {
6379 return OBU.Inputs[Index]->getType();
6380 };
6381
6382 switch (getBundleAttrFromOBU(OBU)) {
6383 case BundleAttr::None:
6384 CheckFailed("tags must be valid attribute names", Call);
6385 break;
6386 case BundleAttr::Align:
6387 Check(OBU.Inputs.size() >= 2 && OBU.Inputs.size() <= 3,
6388 "alignment assumptions should have 2 or 3 arguments", Call);
6389 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6390 Call);
6391 Check(GetTypeAt(1)->isIntegerTy() &&
6392 GetTypeAt(1)->getIntegerBitWidth() <= 64,
6393 "second argument should be an integer with a maximum width of 64 "
6394 "bits",
6395 Call);
6396 Check(OBU.Inputs.size() < 3 ||
6397 (GetTypeAt(2)->isIntegerTy() &&
6398 GetTypeAt(2)->getIntegerBitWidth() <= 64),
6399 "third argument should be an integer with a maximum width of 64 "
6400 "bits if present",
6401 Call);
6402 break;
6403 case BundleAttr::Cold:
6404 Check(OBU.Inputs.size() == 0,
6405 "cold assumptions should have no arguments", Call);
6406 break;
6407 case BundleAttr::Dereferenceable:
6408 case BundleAttr::DereferenceableOrNull:
6409 Check(OBU.Inputs.size() == 2,
6410 "dereferenceable assumptions should have 2 arguments", Call);
6411 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6412 Call);
6413 Check(GetTypeAt(1)->isIntegerTy() &&
6414 GetTypeAt(1)->getIntegerBitWidth() <= 64,
6415 "second argument should be an integer with a maximum width of 64 "
6416 "bits",
6417 Call);
6418 break;
6419 case BundleAttr::Ignore:
6420 break;
6421 case BundleAttr::NonNull:
6422 Check(OBU.Inputs.size() == 1,
6423 "nonnull assumptions should have 1 argument", Call);
6424 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6425 Call);
6426 break;
6427 case BundleAttr::NoUndef:
6428 Check(OBU.Inputs.size() == 1,
6429 "noundef assumptions should have 1 argument", Call);
6430 break;
6431 case BundleAttr::Range: {
6432 Check(OBU.Inputs.size() == 3,
6433 "range assumptions should have 3 arguments", Call);
6434 Check(GetTypeAt(0)->isIntegerTy(),
6435 "first argument should be an integer", Call);
6436 auto *LowerBound = dyn_cast<ConstantInt>(OBU.Inputs[1]);
6437 Check(LowerBound, "second argument should be a constant integer", Call);
6438 auto *UpperBound = dyn_cast<ConstantInt>(OBU.Inputs[2]);
6439 Check(UpperBound, "third argument should be a constant integer", Call);
6440 Check(LowerBound != UpperBound || LowerBound->isZero(),
6441 "an empty range has to be represented as `0, 0`");
6442 Check(GetTypeAt(0)->getIntegerBitWidth() ==
6443 GetTypeAt(1)->getIntegerBitWidth() &&
6444 GetTypeAt(1)->getIntegerBitWidth() ==
6445 GetTypeAt(2)->getIntegerBitWidth(),
6446 "all arguments should have the same bit width", Call);
6447 } break;
6448 case BundleAttr::SeparateStorage:
6449 Check(OBU.Inputs.size() == 2,
6450 "separate_storage assumptions should have 2 arguments", Call);
6451 Check(GetTypeAt(0)->isPointerTy() && GetTypeAt(1)->isPointerTy(),
6452 "arguments to separate_storage assumptions should be pointers",
6453 Call);
6454 break;
6455 }
6456 }
6457 break;
6458 }
6459 case Intrinsic::ucmp:
6460 case Intrinsic::scmp: {
6461 Type *SrcTy = Call.getOperand(0)->getType();
6462 Type *DestTy = Call.getType();
6463
6464 Check(DestTy->getScalarSizeInBits() >= 2,
6465 "result type must be at least 2 bits wide", Call);
6466
6467 bool IsDestTypeVector = DestTy->isVectorTy();
6468 Check(SrcTy->isVectorTy() == IsDestTypeVector,
6469 "ucmp/scmp argument and result types must both be either vector or "
6470 "scalar types",
6471 Call);
6472 if (IsDestTypeVector) {
6473 auto SrcVecLen = cast<VectorType>(SrcTy)->getElementCount();
6474 auto DestVecLen = cast<VectorType>(DestTy)->getElementCount();
6475 Check(SrcVecLen == DestVecLen,
6476 "return type and arguments must have the same number of "
6477 "elements",
6478 Call);
6479 }
6480 break;
6481 }
6482 case Intrinsic::coro_begin:
6483 case Intrinsic::coro_begin_custom_abi:
6485 "id argument of llvm.coro.begin must refer to coro.id");
6486 break;
6487 case Intrinsic::coro_id: {
6489 "align argument only accepts constants");
6490 auto *Promise = Call.getArgOperand(1);
6491 Check(isa<ConstantPointerNull>(Promise) || isa<AllocaInst>(Promise),
6492 "promise argument must refer to an alloca");
6493
6494 auto *CoroAddr = Call.getArgOperand(2)->stripPointerCastsAndAliases();
6495 bool BeforeCoroEarly = isa<ConstantPointerNull>(CoroAddr);
6496 Check(BeforeCoroEarly || isa<Function>(CoroAddr),
6497 "coro argument must refer to a function");
6498
6499 auto *InfoArg = Call.getArgOperand(3);
6500 bool BeforeCoroSplit = isa<ConstantPointerNull>(InfoArg);
6501 if (BeforeCoroSplit)
6502 break;
6503
6504 Check(!BeforeCoroEarly, "cannot run CoroSplit before CoroEarly");
6505 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
6506 Check(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
6507 "info argument of llvm.coro.id must refer to an initialized "
6508 "constant");
6509 Constant *Init = GV->getInitializer();
6511 "info argument of llvm.coro.id must refer to either a struct or "
6512 "an array");
6513 break;
6514 }
6515 case Intrinsic::is_fpclass: {
6516 const ConstantInt *TestMask = cast<ConstantInt>(Call.getOperand(1));
6517 Check((TestMask->getZExtValue() & ~static_cast<unsigned>(fcAllFlags)) == 0,
6518 "unsupported bits for llvm.is.fpclass test mask");
6519 break;
6520 }
6521 case Intrinsic::fptrunc_round: {
6522 // Check the rounding mode
6523 Metadata *MD = nullptr;
6525 if (MAV)
6526 MD = MAV->getMetadata();
6527
6528 Check(MD != nullptr, "missing rounding mode argument", Call);
6529
6530 Check(isa<MDString>(MD),
6531 ("invalid value for llvm.fptrunc.round metadata operand"
6532 " (the operand should be a string)"),
6533 MD);
6534
6535 std::optional<RoundingMode> RoundMode =
6536 convertStrToRoundingMode(cast<MDString>(MD)->getString());
6537 Check(RoundMode && *RoundMode != RoundingMode::Dynamic,
6538 "unsupported rounding mode argument", Call);
6539 break;
6540 }
6541 case Intrinsic::convert_to_arbitrary_fp: {
6542 // Check that vector element counts are consistent.
6543 Type *ValueTy = Call.getArgOperand(0)->getType();
6544 Type *IntTy = Call.getType();
6545
6546 if (auto *ValueVecTy = dyn_cast<VectorType>(ValueTy)) {
6547 auto *IntVecTy = dyn_cast<VectorType>(IntTy);
6548 Check(IntVecTy,
6549 "if floating-point operand is a vector, integer operand must also "
6550 "be a vector",
6551 Call);
6552 Check(ValueVecTy->getElementCount() == IntVecTy->getElementCount(),
6553 "floating-point and integer vector operands must have the same "
6554 "element count",
6555 Call);
6556 }
6557
6558 // Check interpretation metadata (argoperand 1).
6559 auto *InterpMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(1));
6560 Check(InterpMAV, "missing interpretation metadata operand", Call);
6561 auto *InterpStr = dyn_cast<MDString>(InterpMAV->getMetadata());
6562 Check(InterpStr, "interpretation metadata operand must be a string", Call);
6563 StringRef Interp = InterpStr->getString();
6564
6565 Check(!Interp.empty(), "interpretation metadata string must not be empty",
6566 Call);
6567
6568 // Valid interpretation strings: mini-float format names.
6570 "unsupported interpretation metadata string", Call);
6571
6572 // The integer type width must equal the arbitrary FP format width.
6573 if (unsigned FormatBits =
6575 Check(IntTy->getScalarSizeInBits() == FormatBits,
6576 "integer type bit width must equal the arbitrary FP format width",
6577 Call);
6578
6579 // Check rounding mode metadata (argoperand 2).
6580 auto *RoundingMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(2));
6581 Check(RoundingMAV, "missing rounding mode metadata operand", Call);
6582 auto *RoundingStr = dyn_cast<MDString>(RoundingMAV->getMetadata());
6583 Check(RoundingStr, "rounding mode metadata operand must be a string", Call);
6584
6585 std::optional<RoundingMode> RM =
6586 convertStrToRoundingMode(RoundingStr->getString());
6587 Check(RM && *RM != RoundingMode::Dynamic,
6588 "unsupported rounding mode argument", Call);
6589 break;
6590 }
6591 case Intrinsic::convert_from_arbitrary_fp: {
6592 // Check that vector element counts are consistent.
6593 Type *IntTy = Call.getArgOperand(0)->getType();
6594 Type *ValueTy = Call.getType();
6595
6596 if (auto *ValueVecTy = dyn_cast<VectorType>(ValueTy)) {
6597 auto *IntVecTy = dyn_cast<VectorType>(IntTy);
6598 Check(IntVecTy,
6599 "if floating-point operand is a vector, integer operand must also "
6600 "be a vector",
6601 Call);
6602 Check(ValueVecTy->getElementCount() == IntVecTy->getElementCount(),
6603 "floating-point and integer vector operands must have the same "
6604 "element count",
6605 Call);
6606 }
6607
6608 // Check interpretation metadata (argoperand 1).
6609 auto *InterpMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(1));
6610 Check(InterpMAV, "missing interpretation metadata operand", Call);
6611 auto *InterpStr = dyn_cast<MDString>(InterpMAV->getMetadata());
6612 Check(InterpStr, "interpretation metadata operand must be a string", Call);
6613 StringRef Interp = InterpStr->getString();
6614
6615 Check(!Interp.empty(), "interpretation metadata string must not be empty",
6616 Call);
6617
6618 // Valid interpretation strings: mini-float format names.
6620 "unsupported interpretation metadata string", Call);
6621
6622 // The integer type width must equal the arbitrary FP format width.
6623 if (unsigned FormatBits =
6625 Check(IntTy->getScalarSizeInBits() == FormatBits,
6626 "integer type bit width must equal the arbitrary FP format width",
6627 Call);
6628 break;
6629 }
6630#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
6631#include "llvm/IR/VPIntrinsics.def"
6632#undef BEGIN_REGISTER_VP_INTRINSIC
6633 visitVPIntrinsic(cast<VPIntrinsic>(Call));
6634 break;
6635#define INSTRUCTION(NAME, NARGS, ROUND_MODE, INTRINSIC) \
6636 case Intrinsic::INTRINSIC:
6637#include "llvm/IR/ConstrainedOps.def"
6638#undef INSTRUCTION
6639 visitConstrainedFPIntrinsic(cast<ConstrainedFPIntrinsic>(Call));
6640 break;
6641 case Intrinsic::dbg_declare: // llvm.dbg.declare
6642 case Intrinsic::dbg_value: // llvm.dbg.value
6643 case Intrinsic::dbg_assign: // llvm.dbg.assign
6644 case Intrinsic::dbg_label: // llvm.dbg.label
6645 // We no longer interpret debug intrinsics (the old variable-location
6646 // design). They're meaningless as far as LLVM is concerned we could make
6647 // it an error for them to appear, but it's possible we'll have users
6648 // converting back to intrinsics for the forseeable future (such as DXIL),
6649 // so tolerate their existance.
6650 break;
6651 case Intrinsic::memcpy:
6652 case Intrinsic::memcpy_inline:
6653 case Intrinsic::memmove:
6654 case Intrinsic::memset:
6655 case Intrinsic::memset_inline:
6656 break;
6657 case Intrinsic::experimental_memset_pattern: {
6658 const auto Memset = cast<MemSetPatternInst>(&Call);
6659 Check(Memset->getValue()->getType()->isSized(),
6660 "unsized types cannot be used as memset patterns", Call);
6661 break;
6662 }
6663 case Intrinsic::memcpy_element_unordered_atomic:
6664 case Intrinsic::memmove_element_unordered_atomic:
6665 case Intrinsic::memset_element_unordered_atomic: {
6666 const auto *AMI = cast<AnyMemIntrinsic>(&Call);
6667
6668 ConstantInt *ElementSizeCI =
6669 cast<ConstantInt>(AMI->getRawElementSizeInBytes());
6670 const APInt &ElementSizeVal = ElementSizeCI->getValue();
6671 Check(ElementSizeVal.isPowerOf2(),
6672 "element size of the element-wise atomic memory intrinsic "
6673 "must be a power of 2",
6674 Call);
6675
6676 auto IsValidAlignment = [&](MaybeAlign Alignment) {
6677 return Alignment && ElementSizeVal.ule(Alignment->value());
6678 };
6679 Check(IsValidAlignment(AMI->getDestAlign()),
6680 "incorrect alignment of the destination argument", Call);
6681 if (const auto *AMT = dyn_cast<AnyMemTransferInst>(AMI)) {
6682 Check(IsValidAlignment(AMT->getSourceAlign()),
6683 "incorrect alignment of the source argument", Call);
6684 }
6685 break;
6686 }
6687 case Intrinsic::call_preallocated_setup: {
6688 auto *NumArgs = cast<ConstantInt>(Call.getArgOperand(0));
6689 bool FoundCall = false;
6690 for (User *U : Call.users()) {
6691 auto *UseCall = dyn_cast<CallBase>(U);
6692 Check(UseCall != nullptr,
6693 "Uses of llvm.call.preallocated.setup must be calls");
6694 Intrinsic::ID IID = UseCall->getIntrinsicID();
6695 if (IID == Intrinsic::call_preallocated_arg) {
6696 auto *AllocArgIndex = dyn_cast<ConstantInt>(UseCall->getArgOperand(1));
6697 Check(AllocArgIndex != nullptr,
6698 "llvm.call.preallocated.alloc arg index must be a constant");
6699 auto AllocArgIndexInt = AllocArgIndex->getValue();
6700 Check(AllocArgIndexInt.sge(0) &&
6701 AllocArgIndexInt.slt(NumArgs->getValue()),
6702 "llvm.call.preallocated.alloc arg index must be between 0 and "
6703 "corresponding "
6704 "llvm.call.preallocated.setup's argument count");
6705 } else if (IID == Intrinsic::call_preallocated_teardown) {
6706 // nothing to do
6707 } else {
6708 Check(!FoundCall, "Can have at most one call corresponding to a "
6709 "llvm.call.preallocated.setup");
6710 FoundCall = true;
6711 size_t NumPreallocatedArgs = 0;
6712 for (unsigned i = 0; i < UseCall->arg_size(); i++) {
6713 if (UseCall->paramHasAttr(i, Attribute::Preallocated)) {
6714 ++NumPreallocatedArgs;
6715 }
6716 }
6717 Check(NumPreallocatedArgs != 0,
6718 "cannot use preallocated intrinsics on a call without "
6719 "preallocated arguments");
6720 Check(NumArgs->equalsInt(NumPreallocatedArgs),
6721 "llvm.call.preallocated.setup arg size must be equal to number "
6722 "of preallocated arguments "
6723 "at call site",
6724 Call, *UseCall);
6725 // getOperandBundle() cannot be called if more than one of the operand
6726 // bundle exists. There is already a check elsewhere for this, so skip
6727 // here if we see more than one.
6728 if (UseCall->countOperandBundlesOfType(LLVMContext::OB_preallocated) >
6729 1) {
6730 return;
6731 }
6732 auto PreallocatedBundle =
6733 UseCall->getOperandBundle(LLVMContext::OB_preallocated);
6734 Check(PreallocatedBundle,
6735 "Use of llvm.call.preallocated.setup outside intrinsics "
6736 "must be in \"preallocated\" operand bundle");
6737 Check(PreallocatedBundle->Inputs.front().get() == &Call,
6738 "preallocated bundle must have token from corresponding "
6739 "llvm.call.preallocated.setup");
6740 }
6741 }
6742 break;
6743 }
6744 case Intrinsic::call_preallocated_arg: {
6745 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
6746 Check(Token &&
6747 Token->getIntrinsicID() == Intrinsic::call_preallocated_setup,
6748 "llvm.call.preallocated.arg token argument must be a "
6749 "llvm.call.preallocated.setup");
6750 Check(Call.hasFnAttr(Attribute::Preallocated),
6751 "llvm.call.preallocated.arg must be called with a \"preallocated\" "
6752 "call site attribute");
6753 break;
6754 }
6755 case Intrinsic::call_preallocated_teardown: {
6756 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
6757 Check(Token &&
6758 Token->getIntrinsicID() == Intrinsic::call_preallocated_setup,
6759 "llvm.call.preallocated.teardown token argument must be a "
6760 "llvm.call.preallocated.setup");
6761 break;
6762 }
6763 case Intrinsic::gcroot:
6764 case Intrinsic::gcwrite:
6765 case Intrinsic::gcread:
6766 if (ID == Intrinsic::gcroot) {
6767 auto *AI =
6769 Check(AI, "llvm.gcroot parameter #1 must be an alloca.", Call);
6771 "llvm.gcroot parameter #2 must be a constant.", Call);
6772 if (!AI->getAllocatedType()->isPointerTy()) {
6774 "llvm.gcroot parameter #1 must either be a pointer alloca, "
6775 "or argument #2 must be a non-null constant.",
6776 Call);
6777 }
6778 }
6779
6780 Check(Call.getParent()->getParent()->hasGC(),
6781 "Enclosing function does not use GC.", Call);
6782 break;
6783 case Intrinsic::init_trampoline:
6785 "llvm.init_trampoline parameter #2 must resolve to a function.",
6786 Call);
6787 break;
6788 case Intrinsic::reloc_none: {
6790 cast<MetadataAsValue>(Call.getArgOperand(0))->getMetadata()),
6791 "llvm.reloc.none argument must be a metadata string", &Call);
6792 break;
6793 }
6794 case Intrinsic::stackprotector:
6796 "llvm.stackprotector parameter #2 must resolve to an alloca.", Call);
6797 break;
6798 case Intrinsic::localescape: {
6799 BasicBlock *BB = Call.getParent();
6800 Check(BB->isEntryBlock(), "llvm.localescape used outside of entry block",
6801 Call);
6802 Check(!SawFrameEscape, "multiple calls to llvm.localescape in one function",
6803 Call);
6804 for (Value *Arg : Call.args()) {
6805 if (isa<ConstantPointerNull>(Arg))
6806 continue; // Null values are allowed as placeholders.
6807 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
6808 Check(AI && AI->isStaticAlloca(),
6809 "llvm.localescape only accepts static allocas", Call);
6810 }
6811 FrameEscapeInfo[BB->getParent()].first = Call.arg_size();
6812 SawFrameEscape = true;
6813 break;
6814 }
6815 case Intrinsic::localrecover: {
6817 auto *Fn = dyn_cast<Function>(FnArg);
6818 Check(Fn && !Fn->isDeclaration(),
6819 "llvm.localrecover first "
6820 "argument must be function defined in this module",
6821 Call);
6822 auto *IdxArg = cast<ConstantInt>(Call.getArgOperand(2));
6823 auto &Entry = FrameEscapeInfo[Fn];
6824 Entry.second = unsigned(
6825 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
6826 break;
6827 }
6828
6829 case Intrinsic::experimental_gc_statepoint:
6830 if (auto *CI = dyn_cast<CallInst>(&Call))
6831 Check(!CI->isInlineAsm(),
6832 "gc.statepoint support for inline assembly unimplemented", CI);
6833 Check(Call.getParent()->getParent()->hasGC(),
6834 "Enclosing function does not use GC.", Call);
6835
6836 verifyStatepoint(Call);
6837 break;
6838 case Intrinsic::experimental_gc_result: {
6839 Check(Call.getParent()->getParent()->hasGC(),
6840 "Enclosing function does not use GC.", Call);
6841
6842 auto *Statepoint = Call.getArgOperand(0);
6843 if (isa<UndefValue>(Statepoint))
6844 break;
6845
6846 // Are we tied to a statepoint properly?
6847 const auto *StatepointCall = dyn_cast<CallBase>(Statepoint);
6848 Check(StatepointCall && StatepointCall->getIntrinsicID() ==
6849 Intrinsic::experimental_gc_statepoint,
6850 "gc.result operand #1 must be from a statepoint", Call,
6851 Call.getArgOperand(0));
6852
6853 // Check that result type matches wrapped callee.
6854 auto *TargetFuncType =
6855 cast<FunctionType>(StatepointCall->getParamElementType(2));
6856 Check(Call.getType() == TargetFuncType->getReturnType(),
6857 "gc.result result type does not match wrapped callee", Call);
6858 break;
6859 }
6860 case Intrinsic::experimental_gc_relocate: {
6862 "gc.relocate must return a pointer or a vector of pointers", Call);
6863
6864 // Check that this relocate is correctly tied to the statepoint
6865
6866 // This is case for relocate on the unwinding path of an invoke statepoint
6867 if (auto *LandingPad = dyn_cast<LandingPadInst>(Call.getArgOperand(0))) {
6868
6869 const BasicBlock *InvokeBB =
6870 LandingPad->getParent()->getUniquePredecessor();
6871
6872 // Landingpad relocates should have only one predecessor with invoke
6873 // statepoint terminator
6874 Check(InvokeBB, "safepoints should have unique landingpads",
6875 LandingPad->getParent());
6877 "gc relocate should be linked to a statepoint", InvokeBB);
6878 } else {
6879 // In all other cases relocate should be tied to the statepoint directly.
6880 // This covers relocates on a normal return path of invoke statepoint and
6881 // relocates of a call statepoint.
6882 auto *Token = Call.getArgOperand(0);
6884 "gc relocate is incorrectly tied to the statepoint", Call, Token);
6885 }
6886
6887 // Verify rest of the relocate arguments.
6888 const Value &StatepointCall = *cast<GCRelocateInst>(Call).getStatepoint();
6889
6890 // Both the base and derived must be piped through the safepoint.
6893 "gc.relocate operand #2 must be integer offset", Call);
6894
6895 Value *Derived = Call.getArgOperand(2);
6896 Check(isa<ConstantInt>(Derived),
6897 "gc.relocate operand #3 must be integer offset", Call);
6898
6899 const uint64_t BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
6900 const uint64_t DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
6901
6902 // Check the bounds
6903 if (isa<UndefValue>(StatepointCall))
6904 break;
6905 if (auto Opt = cast<GCStatepointInst>(StatepointCall)
6906 .getOperandBundle(LLVMContext::OB_gc_live)) {
6907 Check(BaseIndex < Opt->Inputs.size(),
6908 "gc.relocate: statepoint base index out of bounds", Call);
6909 Check(DerivedIndex < Opt->Inputs.size(),
6910 "gc.relocate: statepoint derived index out of bounds", Call);
6911 }
6912
6913 GCRelocateInst &Relocate = cast<GCRelocateInst>(Call);
6914 auto *DerivedType = Relocate.getDerivedPtr()->getType();
6915 auto *BaseType = Relocate.getBasePtr()->getType();
6916
6917 Check(BaseType->isPtrOrPtrVectorTy(),
6918 "gc.relocate: relocated value must be a pointer", Call);
6919 Check(DerivedType->isPtrOrPtrVectorTy(),
6920 "gc.relocate: relocated value must be a pointer", Call);
6921 Check(Call.getType() == DerivedType,
6922 "gc.relocate: must return the type of the relocated value", Call);
6923
6924 auto GC = llvm::getGCStrategy(Relocate.getFunction()->getGC());
6925 Check(GC, "gc.relocate: calling function must have GCStrategy",
6926 Call.getFunction());
6927 if (GC) {
6928 auto isGCPtr = [&GC](Type *PTy) {
6929 return GC->isGCManagedPointer(PTy->getScalarType()).value_or(true);
6930 };
6931 Check(isGCPtr(BaseType),
6932 "gc.relocate: relocated value must be a gc pointer", Call);
6933 Check(isGCPtr(DerivedType),
6934 "gc.relocate: relocated value must be a gc pointer", Call);
6935 }
6936 break;
6937 }
6938 case Intrinsic::experimental_patchpoint: {
6939 if (Call.getCallingConv() == CallingConv::AnyReg) {
6941 "patchpoint: invalid return type used with anyregcc", Call);
6942 }
6943 break;
6944 }
6945 case Intrinsic::eh_exceptioncode:
6946 case Intrinsic::eh_exceptionpointer: {
6948 "eh.exceptionpointer argument must be a catchpad", Call);
6949 break;
6950 }
6951 case Intrinsic::get_active_lane_mask: {
6952 Type *ElemTy = Call.getType()->getScalarType();
6953 Check(ElemTy->isIntegerTy(1),
6954 "get_active_lane_mask: element type is not i1", Call);
6955 break;
6956 }
6957 case Intrinsic::mask_beforefirst: {
6959 "mask.beforefirst element type must be i1", Call);
6960 break;
6961 }
6962 case Intrinsic::experimental_get_vector_length: {
6963 auto *VF = cast<ConstantInt>(Call.getArgOperand(1));
6964 Check(!VF->isNegative() && !VF->isZero(),
6965 "get_vector_length: VF must be positive", Call);
6966 break;
6967 }
6968 case Intrinsic::experimental_guard: {
6969 Check(isa<CallInst>(Call), "experimental_guard cannot be invoked", Call);
6971 "experimental_guard must have exactly one "
6972 "\"deopt\" operand bundle");
6973 break;
6974 }
6975
6976 case Intrinsic::experimental_deoptimize: {
6977 Check(isa<CallInst>(Call), "experimental_deoptimize cannot be invoked",
6978 Call);
6980 "experimental_deoptimize must have exactly one "
6981 "\"deopt\" operand bundle");
6983 "experimental_deoptimize return type must match caller return type");
6984
6985 if (isa<CallInst>(Call)) {
6987 Check(RI,
6988 "calls to experimental_deoptimize must be followed by a return");
6989
6990 if (!Call.getType()->isVoidTy() && RI)
6991 Check(RI->getReturnValue() == &Call,
6992 "calls to experimental_deoptimize must be followed by a return "
6993 "of the value computed by experimental_deoptimize");
6994 }
6995
6996 break;
6997 }
6998 case Intrinsic::vastart: {
7000 "va_start called in a non-varargs function");
7001 break;
7002 }
7003 case Intrinsic::get_dynamic_area_offset: {
7004 Check(DL.getPointerSizeInBits(DL.getAllocaAddrSpace()) ==
7006 "get_dynamic_area_offset result type must match alloca address "
7007 "space width",
7008 Call);
7009 break;
7010 }
7011 case Intrinsic::smul_fix:
7012 case Intrinsic::smul_fix_sat:
7013 case Intrinsic::umul_fix:
7014 case Intrinsic::umul_fix_sat:
7015 case Intrinsic::sdiv_fix:
7016 case Intrinsic::sdiv_fix_sat:
7017 case Intrinsic::udiv_fix:
7018 case Intrinsic::udiv_fix_sat: {
7019 Value *Op1 = Call.getArgOperand(0);
7020 auto *Op3 = cast<ConstantInt>(Call.getArgOperand(2));
7021
7022 if (ID == Intrinsic::smul_fix || ID == Intrinsic::smul_fix_sat ||
7023 ID == Intrinsic::sdiv_fix || ID == Intrinsic::sdiv_fix_sat) {
7024 Check(Op3->getZExtValue() < Op1->getType()->getScalarSizeInBits(),
7025 "the scale of s[mul|div]_fix[_sat] must be less than the width of "
7026 "the operands");
7027 } else {
7028 Check(Op3->getZExtValue() <= Op1->getType()->getScalarSizeInBits(),
7029 "the scale of u[mul|div]_fix[_sat] must be less than or equal "
7030 "to the width of the operands");
7031 }
7032 break;
7033 }
7034 case Intrinsic::lrint:
7035 case Intrinsic::llrint:
7036 case Intrinsic::lround:
7037 case Intrinsic::llround: {
7038 Type *ValTy = Call.getArgOperand(0)->getType();
7039 Type *ResultTy = Call.getType();
7040 Check(ValTy->isVectorTy() == ResultTy->isVectorTy(),
7041 IF->getName() + ": argument and result disagree on vector use",
7042 &Call);
7043 if (auto *VTy = dyn_cast<VectorType>(ValTy)) {
7044 auto *RTy = dyn_cast<VectorType>(ResultTy);
7045 Check(VTy->getElementCount() == RTy->getElementCount(),
7046 IF->getName() + ": argument must be same length as result", &Call);
7047 }
7048 break;
7049 }
7050 case Intrinsic::bswap: {
7051 Type *Ty = Call.getType();
7052 unsigned Size = Ty->getScalarSizeInBits();
7053 Check(Size % 16 == 0, "bswap must be an even number of bytes", &Call);
7054 break;
7055 }
7056 case Intrinsic::invariant_start: {
7057 auto *InvariantSize = dyn_cast<ConstantInt>(Call.getArgOperand(0));
7058 Check(InvariantSize &&
7059 (!InvariantSize->isNegative() || InvariantSize->isMinusOne()),
7060 "invariant_start parameter must be -1, 0 or a positive number",
7061 &Call);
7062 break;
7063 }
7064 case Intrinsic::matrix_multiply:
7065 case Intrinsic::matrix_transpose:
7066 case Intrinsic::matrix_column_major_load:
7067 case Intrinsic::matrix_column_major_store: {
7069 Value *Stride = nullptr;
7070 ConstantInt *NumRows;
7071 ConstantInt *NumColumns;
7072 FixedVectorType *ResultTy;
7073 Type *Op0ElemTy = nullptr;
7074 Type *Op1ElemTy = nullptr;
7075 switch (ID) {
7076 case Intrinsic::matrix_multiply: {
7077 NumRows = cast<ConstantInt>(Call.getArgOperand(2));
7078 ConstantInt *N = cast<ConstantInt>(Call.getArgOperand(3));
7079 NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
7082 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
7083 Check(Op0Ty && Op1Ty && RetTy,
7084 "Matrix operations require fixed-length vectors!", &Call);
7085 Check(Op0Ty->getNumElements() ==
7086 NumRows->getZExtValue() * N->getZExtValue(),
7087 "First argument of a matrix operation does not match specified "
7088 "shape!");
7089 Check(Op1Ty->getNumElements() ==
7090 N->getZExtValue() * NumColumns->getZExtValue(),
7091 "Second argument of a matrix operation does not match specified "
7092 "shape!");
7093
7094 ResultTy = RetTy;
7095 Op0ElemTy = Op0Ty->getElementType();
7096 Op1ElemTy = Op1Ty->getElementType();
7097 break;
7098 }
7099 case Intrinsic::matrix_transpose: {
7100 NumRows = cast<ConstantInt>(Call.getArgOperand(1));
7101 NumColumns = cast<ConstantInt>(Call.getArgOperand(2));
7103 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
7104 Check(Op0Ty && RetTy, "Matrix operations require fixed-length vectors!",
7105 &Call);
7106 ResultTy = RetTy;
7107 Op0ElemTy = Op0Ty->getElementType();
7108 break;
7109 }
7110 case Intrinsic::matrix_column_major_load: {
7111 Stride = Call.getArgOperand(1);
7112 NumRows = cast<ConstantInt>(Call.getArgOperand(3));
7113 NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
7114 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
7115 Check(RetTy, "Matrix operations require fixed-length vectors!", &Call);
7116 ResultTy = RetTy;
7117 break;
7118 }
7119 case Intrinsic::matrix_column_major_store: {
7120 Stride = Call.getArgOperand(2);
7121 NumRows = cast<ConstantInt>(Call.getArgOperand(4));
7122 NumColumns = cast<ConstantInt>(Call.getArgOperand(5));
7124 Check(Op0Ty, "Matrix operations require fixed-length vectors!", &Call);
7125 ResultTy = Op0Ty;
7126 Op0ElemTy = Op0Ty->getElementType();
7127 break;
7128 }
7129 default:
7130 llvm_unreachable("unexpected intrinsic");
7131 }
7132
7133 Check(ResultTy->getElementType()->isIntegerTy() ||
7134 ResultTy->getElementType()->isFloatingPointTy(),
7135 "Result type must be an integer or floating-point type!", IF);
7136
7137 if (Op0ElemTy)
7138 Check(ResultTy->getElementType() == Op0ElemTy,
7139 "Vector element type mismatch of the result and first operand "
7140 "vector!",
7141 IF);
7142
7143 if (Op1ElemTy)
7144 Check(ResultTy->getElementType() == Op1ElemTy,
7145 "Vector element type mismatch of the result and second operand "
7146 "vector!",
7147 IF);
7148
7149 Check(ResultTy->getNumElements() ==
7150 NumRows->getZExtValue() * NumColumns->getZExtValue(),
7151 "Result of a matrix operation does not fit in the returned vector!");
7152
7153 if (Stride)
7154 Check(Stride->getType()->getIntegerBitWidth() <= 64,
7155 "Stride bitwidth cannot exceed 64!", IF);
7156
7157 break;
7158 }
7159 case Intrinsic::stepvector: {
7160 auto *VecTy = cast<VectorType>(Call.getType());
7161 Check(VecTy->getScalarSizeInBits() >= 8,
7162 "stepvector only supported for vectors of integers "
7163 "with a bitwidth of at least 8.",
7164 &Call);
7165 break;
7166 }
7167 case Intrinsic::experimental_vector_match: {
7168 Value *Op1 = Call.getArgOperand(0);
7169 Value *Op2 = Call.getArgOperand(1);
7170
7171 auto *Op1Ty = cast<VectorType>(Op1->getType());
7172 auto *Op2Ty = cast<VectorType>(Op2->getType());
7173
7175 "Second operand must be a fixed length vector.", &Call);
7176 Check(Op1Ty->getElementType() == Op2Ty->getElementType(),
7177 "First two operands must have the same element type.", &Call);
7178 break;
7179 }
7180 case Intrinsic::speculative_load: {
7181 Type *LoadTy = Call.getType();
7182 Check(LoadTy->isByteTy() || LoadTy->isVectorTy(),
7183 "llvm.speculative.load return type must be a byte type or a "
7184 "vector type",
7185 &Call);
7186 if (LoadTy->isByteOrByteVectorTy()) {
7187 unsigned BitWidth = LoadTy->getScalarType()->getByteBitWidth();
7188 Check((BitWidth % 8) == 0,
7189 "llvm.speculative.load byte type must have a bit width that is "
7190 "a multiple of 8",
7191 &Call);
7192 }
7193
7194 uint64_t MinSizeInBits = DL.getTypeSizeInBits(LoadTy).getKnownMinValue();
7195 Check((MinSizeInBits % 8) == 0 && isPowerOf2_64(MinSizeInBits / 8),
7196 "llvm.speculative.load return type size in bytes must be a "
7197 "positive power of 2",
7198 &Call);
7199
7200 constexpr unsigned NumFixedArgs = 3;
7201 unsigned NumArgs = Call.arg_size();
7202 Check(NumArgs >= NumFixedArgs,
7203 "llvm.speculative.load requires at least 3 arguments", &Call);
7204
7205 Value *PayloadArg = Call.getArgOperand(NumFixedArgs - 1);
7206 if (PayloadArg->getType()->isIntegerTy(64)) {
7207 // Direct form: (ptr, i1 from_end, i64 num_accessible_bytes)
7208 Check(NumArgs == NumFixedArgs,
7209 "llvm.speculative.load direct form has too many arguments", &Call);
7210 } else {
7211 // Oracle form: (ptr, i1 from_end, oracle_fn_ptr, args...)
7212 auto *OracleFn = dyn_cast<Function>(PayloadArg);
7213 Check(OracleFn,
7214 "llvm.speculative.load third argument must be i64 or a direct "
7215 "reference to an oracle function",
7216 &Call);
7217
7218 Check(OracleFn->hasFnAttribute("oracle-function"),
7219 "llvm.speculative.load oracle function must have the "
7220 "\"oracle-function\" attribute",
7221 &Call);
7222
7223 // Make sure the called oracle matches the attributes of the intrinsic.
7224 Check(OracleFn->onlyReadsMemory() && OracleFn->onlyAccessesArgMemory() &&
7225 OracleFn->doesNotThrow() && OracleFn->hasNoSync() &&
7226 OracleFn->willReturn(),
7227 "llvm.speculative.load oracle function must be nounwind, nosync "
7228 "and willreturn, must not have side effects and may only read "
7229 "memory through its arguments",
7230 &Call);
7231
7232 FunctionType *FTy = OracleFn->getFunctionType();
7233 Check(FTy->getReturnType()->isIntegerTy(64),
7234 "llvm.speculative.load oracle function must return i64", &Call);
7235
7236 Check(!FTy->isVarArg(),
7237 "llvm.speculative.load oracle function must have a fixed argument "
7238 "list",
7239 &Call);
7240 Check(NumArgs - NumFixedArgs == FTy->getNumParams(),
7241 "llvm.speculative.load oracle function argument count mismatch",
7242 &Call);
7243 for (auto [ParamTy, Arg] :
7244 zip_equal(FTy->params(), drop_begin(Call.args(), NumFixedArgs)))
7245 Check(ParamTy == Arg->getType(),
7246 "llvm.speculative.load oracle function argument type mismatch",
7247 &Call);
7248 }
7249 break;
7250 }
7251 case Intrinsic::vector_repeat: {
7252 auto *ResultTy = dyn_cast<ScalableVectorType>(Call.getType());
7254
7255 Check(ArgTy, "vector_repeat argument must be a fixed-length vector.",
7256 &Call);
7257 Check(ResultTy, "vector_repeat result must be a scalable vector.", &Call);
7258 Check(ResultTy->getElementType() == ArgTy->getElementType(),
7259 "vector_repeat argument and result must have the same element "
7260 "type.",
7261 &Call);
7262 Check(ArgTy->getNumElements() == ResultTy->getMinNumElements(),
7263 "vector_repeat argument and result must have the same minimum "
7264 "element count.",
7265 &Call);
7266 break;
7267 }
7268 case Intrinsic::vector_insert: {
7269 Value *Vec = Call.getArgOperand(0);
7270 Value *SubVec = Call.getArgOperand(1);
7272 unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue();
7273
7274 VectorType *VecTy = cast<VectorType>(Vec->getType());
7276
7277 ElementCount VecEC = VecTy->getElementCount();
7278 ElementCount SubVecEC = SubVecTy->getElementCount();
7279 Check(VecTy->getElementType() == SubVecTy->getElementType(),
7280 "vector_insert parameters must have the same element "
7281 "type.",
7282 &Call);
7283 Check(IdxN % SubVecEC.getKnownMinValue() == 0,
7284 "vector_insert index must be a constant multiple of "
7285 "the subvector's known minimum vector length.");
7286
7287 // The only allowed 'mixed' case is inserting a fixed vector into a
7288 // scalable vector.
7289 if (SubVecEC.isScalable()) {
7290 Check(VecEC.isScalable(), "cannot vector_insert a scalable vector into "
7291 "a fixed vector.");
7292 }
7293
7294 // If this insertion is not the 'mixed' case where a fixed vector is
7295 // inserted into a scalable vector, ensure that the insertion of the
7296 // subvector does not overrun the parent vector.
7297 if (VecEC.isScalable() == SubVecEC.isScalable()) {
7298 Check(IdxN < VecEC.getKnownMinValue() &&
7299 IdxN + SubVecEC.getKnownMinValue() <= VecEC.getKnownMinValue(),
7300 "subvector operand of vector_insert would overrun the "
7301 "vector being inserted into.");
7302 }
7303 break;
7304 }
7305 case Intrinsic::vector_extract: {
7306 Value *Vec = Call.getArgOperand(0);
7308 unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue();
7309
7310 VectorType *ResultTy = cast<VectorType>(Call.getType());
7311 VectorType *VecTy = cast<VectorType>(Vec->getType());
7312
7313 ElementCount VecEC = VecTy->getElementCount();
7314 ElementCount ResultEC = ResultTy->getElementCount();
7315
7316 Check(ResultTy->getElementType() == VecTy->getElementType(),
7317 "vector_extract result must have the same element "
7318 "type as the input vector.",
7319 &Call);
7320 Check(IdxN % ResultEC.getKnownMinValue() == 0,
7321 "vector_extract index must be a constant multiple of "
7322 "the result type's known minimum vector length.");
7323
7324 // The only allowed 'mixed' case is extracting a fixed vector from a
7325 // scalable vector.
7326 if (ResultEC.isScalable()) {
7327 Check(VecEC.isScalable(), "cannot vector_extract a scalable vector from "
7328 "a fixed vector.");
7329 }
7330
7331 // If this extraction is not the 'mixed' case where a fixed vector is
7332 // extracted from a scalable vector, ensure that the extraction does not
7333 // overrun the parent vector.
7334 if (VecEC.isScalable() == ResultEC.isScalable()) {
7335 Check(IdxN < VecEC.getKnownMinValue() &&
7336 IdxN + ResultEC.getKnownMinValue() <= VecEC.getKnownMinValue(),
7337 "vector_extract would overrun.");
7338 }
7339 break;
7340 }
7341 case Intrinsic::vector_partial_reduce_fadd:
7342 case Intrinsic::vector_partial_reduce_add: {
7345
7346 unsigned VecWidth = VecTy->getElementCount().getKnownMinValue();
7347 unsigned AccWidth = AccTy->getElementCount().getKnownMinValue();
7348
7349 Check((VecWidth % AccWidth) == 0,
7350 "Invalid vector widths for partial "
7351 "reduction. The width of the input vector "
7352 "must be a positive integer multiple of "
7353 "the width of the accumulator vector.");
7354
7355 Check(AccTy->getElementType() == VecTy->getElementType(),
7356 "The element type of the input vector must match the element type "
7357 "of the accumulator vector.",
7358 &Call);
7359 break;
7360 }
7361 case Intrinsic::experimental_noalias_scope_decl: {
7362 NoAliasScopeDecls.push_back(cast<IntrinsicInst>(&Call));
7363 break;
7364 }
7365 case Intrinsic::preserve_array_access_index:
7366 case Intrinsic::preserve_struct_access_index:
7367 case Intrinsic::aarch64_ldaxr:
7368 case Intrinsic::aarch64_ldxr:
7369 case Intrinsic::arm_ldaex:
7370 case Intrinsic::arm_ldrex: {
7371 Type *ElemTy = Call.getParamElementType(0);
7372 Check(ElemTy, "Intrinsic requires elementtype attribute on first argument.",
7373 &Call);
7374 break;
7375 }
7376 case Intrinsic::aarch64_stlxr:
7377 case Intrinsic::aarch64_stxr:
7378 case Intrinsic::arm_stlex:
7379 case Intrinsic::arm_strex: {
7380 Type *ElemTy = Call.getAttributes().getParamElementType(1);
7381 Check(ElemTy,
7382 "Intrinsic requires elementtype attribute on second argument.",
7383 &Call);
7384 break;
7385 }
7386 case Intrinsic::aarch64_prefetch: {
7387 Check(cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue() < 2,
7388 "write argument to llvm.aarch64.prefetch must be 0 or 1", Call);
7389 Check(cast<ConstantInt>(Call.getArgOperand(2))->getZExtValue() < 4,
7390 "target argument to llvm.aarch64.prefetch must be 0-3", Call);
7391 Check(cast<ConstantInt>(Call.getArgOperand(3))->getZExtValue() < 2,
7392 "stream argument to llvm.aarch64.prefetch must be 0 or 1", Call);
7393 Check(cast<ConstantInt>(Call.getArgOperand(4))->getZExtValue() < 2,
7394 "isdata argument to llvm.aarch64.prefetch must be 0 or 1", Call);
7395 break;
7396 }
7397 case Intrinsic::aarch64_range_prefetch: {
7398 Check(cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue() < 2,
7399 "write argument to llvm.aarch64.range.prefetch must be 0 or 1", Call);
7400 Check(cast<ConstantInt>(Call.getArgOperand(2))->getZExtValue() < 2,
7401 "stream argument to llvm.aarch64.range.prefetch must be 0 or 1",
7402 Call);
7403 break;
7404 }
7405 case Intrinsic::riscv_vsetvli:
7406 case Intrinsic::riscv_vsetvlimax: {
7407 // The result models VLMAX (or a VL bounded by it) and is only defined for
7408 // XLen (i32/i64). Narrower types cannot represent the architectural VLMAX
7409 // range of [1, 65536], which value analyses rely on.
7411 "llvm.riscv.vsetvli/vsetvlimax result must be i32 or i64", &Call);
7412
7413 // VSEW and VLMUL select the vtype and must encode a valid SEW/LMUL pair.
7414 bool HasAVL = ID == Intrinsic::riscv_vsetvli;
7415 unsigned Offset = HasAVL ? 1 : 0;
7416 uint64_t VSEW =
7417 cast<ConstantInt>(Call.getArgOperand(Offset))->getZExtValue();
7418 uint64_t VLMUL =
7419 cast<ConstantInt>(Call.getArgOperand(Offset + 1))->getZExtValue();
7420 Check(VSEW <= 3, "llvm.riscv.vsetvli/vsetvlimax VSEW must be 0-3", &Call);
7421 Check(VLMUL <= 7 && VLMUL != RISCVVType::LMUL_RESERVED,
7422 "llvm.riscv.vsetvli/vsetvlimax VLMUL is reserved", &Call);
7423 break;
7424 }
7425 case Intrinsic::riscv_sati: {
7426 unsigned BitWidth = Call.getType()->getScalarSizeInBits();
7427 uint64_t Imm = cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue();
7428 Check(Imm >= 1 && Imm <= BitWidth,
7429 "llvm.riscv.sati immediate must be in the range [1, bitwidth]",
7430 &Call);
7431 break;
7432 }
7433 case Intrinsic::riscv_usati: {
7434 unsigned BitWidth = Call.getType()->getScalarSizeInBits();
7435 uint64_t Imm = cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue();
7436 Check(Imm < BitWidth,
7437 "llvm.riscv.usati immediate must be in the range [0, bitwidth-1]",
7438 &Call);
7439 break;
7440 }
7441 case Intrinsic::callbr_landingpad: {
7442 const auto *CBR = dyn_cast<CallBrInst>(Call.getOperand(0));
7443 Check(CBR, "intrinstic requires callbr operand", &Call);
7444 if (!CBR)
7445 break;
7446
7447 const BasicBlock *LandingPadBB = Call.getParent();
7448 const BasicBlock *PredBB = LandingPadBB->getUniquePredecessor();
7449 if (!PredBB) {
7450 CheckFailed("Intrinsic in block must have 1 unique predecessor", &Call);
7451 break;
7452 }
7453 if (!isa<CallBrInst>(PredBB->getTerminator())) {
7454 CheckFailed("Intrinsic must have corresponding callbr in predecessor",
7455 &Call);
7456 break;
7457 }
7458 Check(llvm::is_contained(CBR->getIndirectDests(), LandingPadBB),
7459 "Intrinsic's corresponding callbr must have intrinsic's parent basic "
7460 "block in indirect destination list",
7461 &Call);
7462 const Instruction &First = *LandingPadBB->begin();
7463 Check(&First == &Call, "No other instructions may proceed intrinsic",
7464 &Call);
7465 break;
7466 }
7467 case Intrinsic::structured_gep: {
7468 // Parser should refuse those 2 cases.
7469 assert(Call.arg_size() >= 1);
7471
7472 Check(Call.paramHasAttr(0, Attribute::ElementType),
7473 "Intrinsic first parameter is missing an ElementType attribute",
7474 &Call);
7475
7476 Type *T = Call.getParamAttr(0, Attribute::ElementType).getValueAsType();
7477 for (unsigned I = 1; I < Call.arg_size(); ++I) {
7479 auto *CI = dyn_cast<ConstantInt>(Index);
7480 Check(Index->getType()->isIntegerTy(),
7481 "Index operand type must be an integer", &Call);
7482
7483 if (auto *AT = dyn_cast<ArrayType>(T)) {
7484 T = AT->getElementType();
7485 } else if (auto *ST = dyn_cast<StructType>(T)) {
7486 Check(CI, "Indexing into a struct requires a constant int", &Call);
7487 Check(CI->getZExtValue() < ST->getNumElements(),
7488 "Indexing in a struct should be inbounds", &Call);
7489 T = ST->getElementType(CI->getZExtValue());
7490 } else if (auto *VT = dyn_cast<VectorType>(T)) {
7491 T = VT->getElementType();
7492 } else {
7493 CheckFailed("Reached a non-composite type with more indices to process",
7494 &Call);
7495 }
7496 }
7497 break;
7498 }
7499 case Intrinsic::structured_alloca:
7500 Check(Call.hasRetAttr(Attribute::ElementType),
7501 "@llvm.structured.alloca calls require elementtype attribute.",
7502 &Call);
7503 break;
7504 case Intrinsic::nvvm_setmaxnreg_inc_sync_aligned_u32:
7505 case Intrinsic::nvvm_setmaxnreg_dec_sync_aligned_u32: {
7506 Value *V = Call.getArgOperand(0);
7507 unsigned RegCount = cast<ConstantInt>(V)->getZExtValue();
7508 Check(RegCount % 8 == 0,
7509 "reg_count argument to nvvm.setmaxnreg must be in multiples of 8");
7510 break;
7511 }
7512 case Intrinsic::nvvm_cp_async_bulk_global_to_shared_cta:
7513 case Intrinsic::nvvm_cp_async_bulk_global_to_shared_cta_relaxed: {
7514 const unsigned ArgSize = Call.arg_size();
7515 const unsigned FlagValidPatternIndex = ArgSize - 1;
7516 const unsigned IgnoreOOBFlagIndex = 8;
7517 bool IgnoreOOB =
7518 cast<ConstantInt>(Call.getArgOperand(IgnoreOOBFlagIndex))->isOne();
7519 const auto *FlagValidPattern =
7520 cast<ConstantInt>(Call.getArgOperand(FlagValidPatternIndex));
7521 Check(!IgnoreOOB || FlagValidPattern->isZero(),
7522 "flag_valid_pattern must be 0 (disabled) when ignore_oob is enabled",
7523 &Call);
7524 break;
7525 }
7526 case Intrinsic::experimental_convergence_entry:
7527 case Intrinsic::experimental_convergence_anchor:
7528 break;
7529 case Intrinsic::experimental_convergence_loop:
7530 break;
7531 case Intrinsic::ptrmask: {
7532 Type *Ty0 = Call.getArgOperand(0)->getType();
7533 Type *Ty1 = Call.getArgOperand(1)->getType();
7535 "llvm.ptrmask intrinsic first argument must be pointer or vector "
7536 "of pointers",
7537 &Call);
7538 Check(
7539 Ty0->isVectorTy() == Ty1->isVectorTy(),
7540 "llvm.ptrmask intrinsic arguments must be both scalars or both vectors",
7541 &Call);
7542 if (Ty0->isVectorTy())
7543 Check(cast<VectorType>(Ty0)->getElementCount() ==
7544 cast<VectorType>(Ty1)->getElementCount(),
7545 "llvm.ptrmask intrinsic arguments must have the same number of "
7546 "elements",
7547 &Call);
7548 Check(DL.getIndexTypeSizeInBits(Ty0) == Ty1->getScalarSizeInBits(),
7549 "llvm.ptrmask intrinsic second argument bitwidth must match "
7550 "pointer index type size of first argument",
7551 &Call);
7552 break;
7553 }
7554 case Intrinsic::thread_pointer: {
7556 DL.getDefaultGlobalsAddressSpace(),
7557 "llvm.thread.pointer intrinsic return type must be for the globals "
7558 "address space",
7559 &Call);
7560 break;
7561 }
7562 case Intrinsic::threadlocal_address: {
7563 const Value &Arg0 = *Call.getArgOperand(0);
7564 Check(isa<GlobalValue>(Arg0),
7565 "llvm.threadlocal.address first argument must be a GlobalValue");
7566 Check(cast<GlobalValue>(Arg0).isThreadLocal(),
7567 "llvm.threadlocal.address operand isThreadLocal() must be true");
7568 break;
7569 }
7570 case Intrinsic::lifetime_start:
7571 case Intrinsic::lifetime_end: {
7572 Value *Ptr = Call.getArgOperand(0);
7573 auto *II = dyn_cast<IntrinsicInst>(Ptr);
7574 Check(isa<AllocaInst>(Ptr) || isa<PoisonValue>(Ptr) ||
7575 (II && II->getIntrinsicID() == Intrinsic::structured_alloca),
7576 "llvm.lifetime.start/end can only be used on alloca or poison",
7577 &Call);
7578 break;
7579 }
7580 case Intrinsic::sponentry: {
7581 const unsigned StackAS = DL.getAllocaAddrSpace();
7582 const Type *RetTy = Call.getFunctionType()->getReturnType();
7583 Check(RetTy->getPointerAddressSpace() == StackAS,
7584 "llvm.sponentry must return a pointer to the stack", &Call);
7585 break;
7586 }
7587 case Intrinsic::write_volatile_register: {
7588 auto *MD = cast<MDNode>(
7589 cast<MetadataAsValue>(Call.getArgOperand(0))->getMetadata());
7590 Check(MD->getNumOperands() == 1 && isa<MDString>(MD->getOperand(0)),
7591 "llvm.write_volatile_register metadata must be a single MDString",
7592 &Call);
7593 break;
7594 }
7595 case Intrinsic::ptrauth_auth_with_pc_and_resign: {
7596 // Verify that the auth key is IA (0) or IB (1), not DA (2) or DB (3)
7597 auto *AuthKey = cast<ConstantInt>(Call.getArgOperand(1));
7598 uint64_t Key = AuthKey->getZExtValue();
7599 Check(Key == 0 || Key == 1,
7600 "ptrauth.auth.with.pc.and.resign key must be IA (0) or IB (1)",
7601 &Call);
7602 break;
7603 }
7604 };
7605
7606 // Verify that there aren't any unmediated control transfers between funclets.
7608 Function *F = Call.getParent()->getParent();
7609 if (F->hasPersonalityFn() &&
7610 isScopedEHPersonality(classifyEHPersonality(F->getPersonalityFn()))) {
7611 // Run EH funclet coloring on-demand and cache results for other intrinsic
7612 // calls in this function
7613 if (BlockEHFuncletColors.empty())
7614 BlockEHFuncletColors = colorEHFunclets(*F);
7615
7616 // colorEHFunclets() leaves unreachable blocks colorless. Such a call
7617 // is in no funclet and WinEHPrepare will not see it, so there is
7618 // nothing to check.
7619 BasicBlock *CallBB = Call.getParent();
7620 auto ColorsIt = BlockEHFuncletColors.find(CallBB);
7621 if (ColorsIt != BlockEHFuncletColors.end()) {
7622 // Check for catch-/cleanup-pad in first funclet block
7623 bool InEHFunclet = false;
7624 const ColorVector &CV = ColorsIt->second;
7625 assert(CV.size() > 0 && "Uncolored block");
7626 for (BasicBlock *ColorFirstBB : CV)
7627 if (auto It = ColorFirstBB->getFirstNonPHIIt();
7628 It != ColorFirstBB->end())
7630 InEHFunclet = true;
7631
7632 // Check for funclet operand bundle
7633 bool HasToken = false;
7634 for (unsigned I = 0, E = Call.getNumOperandBundles(); I != E; ++I)
7636 HasToken = true;
7637
7638 // This would cause silent code truncation in WinEHPrepare
7639 if (InEHFunclet)
7640 Check(HasToken, "Missing funclet token on intrinsic call", &Call);
7641 }
7642 }
7643 }
7644
7645 // Target-specific intrinsic call checks.
7646 verifyAMDGPUIntrinsicCall(*this, ID, Call);
7647 verifyNVVMIntrinsicCall(*this, ID, Call);
7648}
7649
7650/// Carefully grab the subprogram from a local scope.
7651///
7652/// This carefully grabs the subprogram from a local scope, avoiding the
7653/// built-in assertions that would typically fire.
7654DISubprogram *Verifier::getSubprogram(Metadata *LocalScope) {
7655 if (hasDIScopeCycle(LocalScope))
7656 return nullptr;
7657
7658 if (!LocalScope)
7659 return nullptr;
7660
7661 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
7662 return SP;
7663
7664 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
7665 return getSubprogram(LB->getRawScope());
7666
7667 // Just return null; broken scope chains are checked elsewhere.
7668 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
7669 return nullptr;
7670}
7671
7672void Verifier::visit(DbgLabelRecord &DLR) {
7674 "invalid #dbg_label intrinsic variable", &DLR, DLR.getRawLabel());
7675
7676 // Ignore broken !dbg attachments; they're checked elsewhere.
7677 if (MDNode *N = DLR.getDebugLoc().getAsMDNode())
7678 if (!isa<DILocation>(N))
7679 return;
7680
7681 BasicBlock *BB = DLR.getParent();
7682 Function *F = BB ? BB->getParent() : nullptr;
7683
7684 // The scopes for variables and !dbg attachments must agree.
7685 DILabel *Label = DLR.getLabel();
7686 DILocation *Loc = DLR.getDebugLoc();
7687 CheckDI(Loc, "#dbg_label record requires a !dbg attachment", &DLR, BB, F);
7688
7689 DISubprogram *LabelSP = getSubprogram(Label->getRawScope());
7690 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
7691 if (!LabelSP || !LocSP)
7692 return;
7693
7694 CheckDI(LabelSP == LocSP,
7695 "mismatched subprogram between #dbg_label label and !dbg attachment",
7696 &DLR, BB, F, Label, Label->getScope()->getSubprogram(), Loc,
7697 Loc->getScope()->getSubprogram());
7698}
7699
7700void Verifier::visit(DbgVariableRecord &DVR) {
7701 BasicBlock *BB = DVR.getParent();
7702 Function *F = BB->getParent();
7703
7704 CheckDI(DVR.getType() == DbgVariableRecord::LocationType::Value ||
7705 DVR.getType() == DbgVariableRecord::LocationType::Declare ||
7706 DVR.getType() == DbgVariableRecord::LocationType::DeclareValue ||
7707 DVR.getType() == DbgVariableRecord::LocationType::Assign,
7708 "invalid #dbg record type", &DVR, DVR.getType(), BB, F);
7709
7710 // The location for a DbgVariableRecord must be either a ValueAsMetadata,
7711 // DIArgList, or an empty MDNode (which is a legacy representation for an
7712 // "undef" location).
7713 auto *MD = DVR.getRawLocation();
7714 CheckDI(MD && (isa<ValueAsMetadata>(MD) || isa<DIArgList>(MD) ||
7715 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands())),
7716 "invalid #dbg record address/value", &DVR, MD, BB, F);
7717 CheckDI(DVR.isDbgAssign() || !isa<DIAssignID>(MD),
7718 "!DIAssignID should only be used by Assign DVRs.", MD, &DVR);
7719 if (auto *VAM = dyn_cast<ValueAsMetadata>(MD)) {
7720 visitValueAsMetadata(*VAM, F);
7721 if (DVR.isDbgDeclare()) {
7722 // Allow integers here to support inttoptr salvage.
7723 Type *Ty = VAM->getValue()->getType();
7724 CheckDI(Ty->isPointerTy() || Ty->isIntegerTy(),
7725 "location of #dbg_declare must be a pointer or int", &DVR, MD, BB,
7726 F);
7727 }
7728 } else if (auto *AL = dyn_cast<DIArgList>(MD)) {
7729 visitDIArgList(*AL, F);
7730 }
7731
7733 "invalid #dbg record variable", &DVR, DVR.getRawVariable(), BB, F);
7734 visitMDNode(*DVR.getRawVariable(), AreDebugLocsAllowed::No);
7735
7737 "invalid #dbg record expression", &DVR, DVR.getRawExpression(), BB,
7738 F);
7739 visitMDNode(*DVR.getExpression(), AreDebugLocsAllowed::No);
7740
7741 const DIExpression *Expr = DVR.getExpression();
7742 if (Expr->isValid() && !DVR.isKillLocation() &&
7743 (isa<ValueAsMetadata>(MD) || isa<DIArgList>(MD))) {
7744 unsigned NumLocationOps = DVR.getNumVariableLocationOps();
7745 for (DIExpression::ExprOperand Op : Expr->expr_ops()) {
7746 if (Op.getOp() != dwarf::DW_OP_LLVM_arg)
7747 continue;
7748 CheckDI(Op.getArg(0) < NumLocationOps,
7749 "#dbg record expression references nonexistent location operand",
7750 &DVR, Expr, BB, F);
7751 }
7752 }
7753
7754 if (DVR.isDbgAssign()) {
7756 "invalid #dbg_assign DIAssignID", &DVR, DVR.getRawAssignID(), BB,
7757 F);
7758 visitMDNode(*cast<DIAssignID>(DVR.getRawAssignID()),
7759 AreDebugLocsAllowed::No);
7760
7761 const auto *RawAddr = DVR.getRawAddress();
7762 // Similarly to the location above, the address for an assign
7763 // DbgVariableRecord must be a ValueAsMetadata or an empty MDNode, which
7764 // represents an undef address.
7765 CheckDI(
7766 isa<ValueAsMetadata>(RawAddr) ||
7767 (isa<MDNode>(RawAddr) && !cast<MDNode>(RawAddr)->getNumOperands()),
7768 "invalid #dbg_assign address", &DVR, DVR.getRawAddress(), BB, F);
7769 if (auto *VAM = dyn_cast<ValueAsMetadata>(RawAddr))
7770 visitValueAsMetadata(*VAM, F);
7771
7773 "invalid #dbg_assign address expression", &DVR,
7774 DVR.getRawAddressExpression(), BB, F);
7775 visitMDNode(*DVR.getAddressExpression(), AreDebugLocsAllowed::No);
7776
7777 // All of the linked instructions should be in the same function as DVR.
7778 for (Instruction *I : at::getAssignmentInsts(&DVR))
7779 CheckDI(DVR.getFunction() == I->getFunction(),
7780 "inst not in same function as #dbg_assign", I, &DVR, BB, F);
7781 }
7782
7783 // This check is redundant with one in visitLocalVariable().
7784 DILocalVariable *Var = DVR.getVariable();
7785 CheckDI(isType(Var->getRawType()), "invalid type ref", Var, Var->getRawType(),
7786 BB, F);
7787
7788 auto *DLNode = DVR.getDebugLoc().getAsMDNode();
7789 CheckDI(isa_and_nonnull<DILocation>(DLNode), "invalid #dbg record DILocation",
7790 &DVR, DLNode, BB, F);
7791 DILocation *Loc = DVR.getDebugLoc();
7792
7793 // The scopes for variables and !dbg attachments must agree.
7794 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
7795 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
7796 if (!VarSP || !LocSP)
7797 return; // Broken scope chains are checked elsewhere.
7798
7799 CheckDI(VarSP == LocSP,
7800 "mismatched subprogram between #dbg record variable and DILocation",
7801 &DVR, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
7802 Loc->getScope()->getSubprogram(), BB, F);
7803
7804 verifyFnArgs(DVR);
7805}
7806
7807void Verifier::visitVPIntrinsic(VPIntrinsic &VPI) {
7808 switch (VPI.getIntrinsicID()) {
7809 case Intrinsic::experimental_vp_splice: {
7810 VectorType *VecTy = cast<VectorType>(VPI.getType());
7811 int64_t Idx = cast<ConstantInt>(VPI.getArgOperand(2))->getSExtValue();
7812 int64_t KnownMinNumElements = VecTy->getElementCount().getKnownMinValue();
7813 if (VPI.getParent() && VPI.getParent()->getParent()) {
7814 AttributeList Attrs = VPI.getParent()->getParent()->getAttributes();
7815 if (Attrs.hasFnAttr(Attribute::VScaleRange))
7816 KnownMinNumElements *= Attrs.getFnAttrs().getVScaleRangeMin();
7817 }
7818 Check((Idx < 0 && std::abs(Idx) <= KnownMinNumElements) ||
7819 (Idx >= 0 && Idx < KnownMinNumElements),
7820 "The splice index exceeds the range [-VL, VL-1] where VL is the "
7821 "known minimum number of elements in the vector. For scalable "
7822 "vectors the minimum number of elements is determined from "
7823 "vscale_range.",
7824 &VPI);
7825 break;
7826 }
7827 }
7828}
7829
7830void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
7831 switch (FPI.getIntrinsicID()) {
7832 case Intrinsic::experimental_constrained_fcmp:
7833 case Intrinsic::experimental_constrained_fcmps: {
7834 auto Pred = cast<ConstrainedFPCmpIntrinsic>(&FPI)->getPredicate();
7836 "invalid predicate for constrained FP comparison intrinsic", &FPI);
7837 break;
7838 }
7839
7840 case Intrinsic::experimental_constrained_fptosi:
7841 case Intrinsic::experimental_constrained_fptoui: {
7842 Value *Operand = FPI.getArgOperand(0);
7843 ElementCount SrcEC;
7844 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7845 SrcEC = cast<VectorType>(OperandT)->getElementCount();
7846 }
7847
7848 Operand = &FPI;
7849 Check(SrcEC.isNonZero() == Operand->getType()->isVectorTy(),
7850 "Intrinsic first argument and result disagree on vector use", &FPI);
7851 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7852 Check(SrcEC == cast<VectorType>(OperandT)->getElementCount(),
7853 "Intrinsic first argument and result vector lengths must be equal",
7854 &FPI);
7855 }
7856 break;
7857 }
7858
7859 case Intrinsic::experimental_constrained_sitofp:
7860 case Intrinsic::experimental_constrained_uitofp: {
7861 Value *Operand = FPI.getArgOperand(0);
7862 ElementCount SrcEC;
7863 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7864 SrcEC = cast<VectorType>(OperandT)->getElementCount();
7865 }
7866
7867 Operand = &FPI;
7868 Check(SrcEC.isNonZero() == Operand->getType()->isVectorTy(),
7869 "Intrinsic first argument and result disagree on vector use", &FPI);
7870 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7871 Check(SrcEC == cast<VectorType>(OperandT)->getElementCount(),
7872 "Intrinsic first argument and result vector lengths must be equal",
7873 &FPI);
7874 }
7875 break;
7876 }
7877
7878 case Intrinsic::experimental_constrained_fptrunc:
7879 case Intrinsic::experimental_constrained_fpext: {
7880 Value *Operand = FPI.getArgOperand(0);
7881 Type *OperandTy = Operand->getType();
7882 Value *Result = &FPI;
7883 Type *ResultTy = Result->getType();
7884 Check(OperandTy->isVectorTy() == ResultTy->isVectorTy(),
7885 "Intrinsic first argument and result disagree on vector use", &FPI);
7886 if (OperandTy->isVectorTy()) {
7887 Check(cast<VectorType>(OperandTy)->getElementCount() ==
7888 cast<VectorType>(ResultTy)->getElementCount(),
7889 "Intrinsic first argument and result vector lengths must be equal",
7890 &FPI);
7891 }
7892 if (FPI.getIntrinsicID() == Intrinsic::experimental_constrained_fptrunc) {
7893 Check(OperandTy->getScalarSizeInBits() > ResultTy->getScalarSizeInBits(),
7894 "Intrinsic first argument's type must be larger than result type",
7895 &FPI);
7896 } else {
7897 Check(OperandTy->getScalarSizeInBits() < ResultTy->getScalarSizeInBits(),
7898 "Intrinsic first argument's type must be smaller than result type",
7899 &FPI);
7900 }
7901 break;
7902 }
7903
7904 default:
7905 break;
7906 }
7907
7908 // If a non-metadata argument is passed in a metadata slot then the
7909 // error will be caught earlier when the incorrect argument doesn't
7910 // match the specification in the intrinsic call table. Thus, no
7911 // argument type check is needed here.
7912
7913 Check(FPI.getExceptionBehavior().has_value(),
7914 "invalid exception behavior argument", &FPI);
7916 Check(FPI.getRoundingMode().has_value(), "invalid rounding mode argument",
7917 &FPI);
7918 }
7919}
7920
7921void Verifier::verifyFragmentExpression(const DbgVariableRecord &DVR) {
7922 DILocalVariable *V = dyn_cast_or_null<DILocalVariable>(DVR.getRawVariable());
7923 DIExpression *E = dyn_cast_or_null<DIExpression>(DVR.getRawExpression());
7924
7925 // We don't know whether this intrinsic verified correctly.
7926 if (!V || !E || !E->isValid())
7927 return;
7928
7929 // Nothing to do if this isn't a DW_OP_LLVM_fragment expression.
7930 auto Fragment = E->getFragmentInfo();
7931 if (!Fragment)
7932 return;
7933
7934 // The frontend helps out GDB by emitting the members of local anonymous
7935 // unions as artificial local variables with shared storage. When SROA splits
7936 // the storage for artificial local variables that are smaller than the entire
7937 // union, the overhang piece will be outside of the allotted space for the
7938 // variable and this check fails.
7939 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
7940 if (V->isArtificial())
7941 return;
7942
7943 verifyFragmentExpression(*V, *Fragment, &DVR);
7944}
7945
7946template <typename ValueOrMetadata>
7947void Verifier::verifyFragmentExpression(const DIVariable &V,
7949 ValueOrMetadata *Desc) {
7950 // If there's no size, the type is broken, but that should be checked
7951 // elsewhere.
7952 auto VarSize = V.getSizeInBits();
7953 if (!VarSize)
7954 return;
7955
7956 unsigned FragSize = Fragment.SizeInBits;
7957 unsigned FragOffset = Fragment.OffsetInBits;
7958 CheckDI(FragSize + FragOffset <= *VarSize,
7959 "fragment is larger than or outside of variable", Desc, &V);
7960 CheckDI(FragSize != *VarSize, "fragment covers entire variable", Desc, &V);
7961}
7962
7963void Verifier::verifyFnArgs(const DbgVariableRecord &DVR) {
7964 // This function does not take the scope of noninlined function arguments into
7965 // account. Don't run it if current function is nodebug, because it may
7966 // contain inlined debug intrinsics.
7967 if (!HasDebugInfo)
7968 return;
7969
7970 // For performance reasons only check non-inlined ones.
7971 if (DVR.getDebugLoc()->getInlinedAt())
7972 return;
7973
7974 DILocalVariable *Var = DVR.getVariable();
7975 CheckDI(Var, "#dbg record without variable");
7976
7977 unsigned ArgNo = Var->getArg();
7978 if (!ArgNo)
7979 return;
7980
7981 // Verify there are no duplicate function argument debug info entries.
7982 // These will cause hard-to-debug assertions in the DWARF backend.
7983 if (DebugFnArgs.size() < ArgNo)
7984 DebugFnArgs.resize(ArgNo, nullptr);
7985
7986 auto *Prev = DebugFnArgs[ArgNo - 1];
7987 DebugFnArgs[ArgNo - 1] = Var;
7988 CheckDI(!Prev || (Prev == Var), "conflicting debug info for argument", &DVR,
7989 Prev, Var);
7990}
7991
7992void Verifier::verifyNotEntryValue(const DbgVariableRecord &DVR) {
7993 DIExpression *E = dyn_cast_or_null<DIExpression>(DVR.getRawExpression());
7994
7995 // We don't know whether this intrinsic verified correctly.
7996 if (!E || !E->isValid())
7997 return;
7998
8000 Value *VarValue = DVR.getVariableLocationOp(0);
8001 if (isa<UndefValue>(VarValue) || isa<PoisonValue>(VarValue))
8002 return;
8003 // We allow EntryValues for swift async arguments, as they have an
8004 // ABI-guarantee to be turned into a specific register.
8005 if (auto *ArgLoc = dyn_cast_or_null<Argument>(VarValue);
8006 ArgLoc && ArgLoc->hasAttribute(Attribute::SwiftAsync))
8007 return;
8008 }
8009
8010 CheckDI(!E->isEntryValue(),
8011 "Entry values are only allowed in MIR unless they target a "
8012 "swiftasync Argument",
8013 &DVR);
8014}
8015
8016void Verifier::verifyCompileUnits() {
8017 // When more than one Module is imported into the same context, such as during
8018 // an LTO build before linking the modules, ODR type uniquing may cause types
8019 // to point to a different CU. This check does not make sense in this case.
8020 if (M.getContext().isODRUniquingDebugTypes())
8021 return;
8022 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
8023 SmallPtrSet<const Metadata *, 2> Listed;
8024 if (CUs)
8025 Listed.insert_range(CUs->operands());
8026 for (const auto *CU : CUVisited)
8027 CheckDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU);
8028 CUVisited.clear();
8029}
8030
8031void Verifier::verifyDeoptimizeCallingConvs() {
8032 if (DeoptimizeDeclarations.empty())
8033 return;
8034
8035 const Function *First = DeoptimizeDeclarations[0];
8036 for (const auto *F : ArrayRef(DeoptimizeDeclarations).slice(1)) {
8037 Check(First->getCallingConv() == F->getCallingConv(),
8038 "All llvm.experimental.deoptimize declarations must have the same "
8039 "calling convention",
8040 First, F);
8041 }
8042}
8043
8044void Verifier::verifyAttachedCallBundle(const CallBase &Call,
8045 const OperandBundleUse &BU) {
8046 FunctionType *FTy = Call.getFunctionType();
8047
8048 Check((FTy->getReturnType()->isPointerTy() ||
8049 (Call.doesNotReturn() && FTy->getReturnType()->isVoidTy())),
8050 "a call with operand bundle \"clang.arc.attachedcall\" must call a "
8051 "function returning a pointer or a non-returning function that has a "
8052 "void return type",
8053 Call);
8054
8055 Check(BU.Inputs.size() == 1 && isa<Function>(BU.Inputs.front()),
8056 "operand bundle \"clang.arc.attachedcall\" requires one function as "
8057 "an argument",
8058 Call);
8059
8060 auto *Fn = cast<Function>(BU.Inputs.front());
8061 Intrinsic::ID IID = Fn->getIntrinsicID();
8062
8063 if (IID) {
8064 Check((IID == Intrinsic::objc_retainAutoreleasedReturnValue ||
8065 IID == Intrinsic::objc_claimAutoreleasedReturnValue ||
8066 IID == Intrinsic::objc_unsafeClaimAutoreleasedReturnValue),
8067 "invalid function argument", Call);
8068 } else {
8069 StringRef FnName = Fn->getName();
8070 Check((FnName == "objc_retainAutoreleasedReturnValue" ||
8071 FnName == "objc_claimAutoreleasedReturnValue" ||
8072 FnName == "objc_unsafeClaimAutoreleasedReturnValue"),
8073 "invalid function argument", Call);
8074 }
8075}
8076
8077void Verifier::verifyNoAliasScopeDecl() {
8078 if (NoAliasScopeDecls.empty())
8079 return;
8080
8081 // only a single scope must be declared at a time.
8082 for (auto *II : NoAliasScopeDecls) {
8083 assert(II->getIntrinsicID() == Intrinsic::experimental_noalias_scope_decl &&
8084 "Not a llvm.experimental.noalias.scope.decl ?");
8085 const auto *ScopeListMV = dyn_cast<MetadataAsValue>(
8087 Check(ScopeListMV != nullptr,
8088 "llvm.experimental.noalias.scope.decl must have a MetadataAsValue "
8089 "argument",
8090 II);
8091
8092 const auto *ScopeListMD = dyn_cast<MDNode>(ScopeListMV->getMetadata());
8093 Check(ScopeListMD != nullptr, "!id.scope.list must point to an MDNode", II);
8094 Check(ScopeListMD->getNumOperands() == 1,
8095 "!id.scope.list must point to a list with a single scope", II);
8096 visitAliasScopeListMetadata(ScopeListMD);
8097 }
8098
8099 // Only check the domination rule when requested. Once all passes have been
8100 // adapted this option can go away.
8101 if (!getIROptions(M.getContext()).verify_noalias_scope_decl_dom)
8102 return;
8103
8104 // Now sort the intrinsics based on the scope MDNode so that declarations of
8105 // the same scopes are next to each other.
8106 auto GetScope = [](IntrinsicInst *II) {
8107 const auto *ScopeListMV = cast<MetadataAsValue>(
8109 return &cast<MDNode>(ScopeListMV->getMetadata())->getOperand(0);
8110 };
8111
8112 // We are sorting on MDNode pointers here. For valid input IR this is ok.
8113 // TODO: Sort on Metadata ID to avoid non-deterministic error messages.
8114 auto Compare = [GetScope](IntrinsicInst *Lhs, IntrinsicInst *Rhs) {
8115 return GetScope(Lhs) < GetScope(Rhs);
8116 };
8117
8118 llvm::sort(NoAliasScopeDecls, Compare);
8119
8120 // Go over the intrinsics and check that for the same scope, they are not
8121 // dominating each other.
8122 auto ItCurrent = NoAliasScopeDecls.begin();
8123 while (ItCurrent != NoAliasScopeDecls.end()) {
8124 auto CurScope = GetScope(*ItCurrent);
8125 auto ItNext = ItCurrent;
8126 do {
8127 ++ItNext;
8128 } while (ItNext != NoAliasScopeDecls.end() &&
8129 GetScope(*ItNext) == CurScope);
8130
8131 // [ItCurrent, ItNext) represents the declarations for the same scope.
8132 // Ensure they are not dominating each other.. but only if it is not too
8133 // expensive.
8134 if (ItNext - ItCurrent < 32)
8135 for (auto *I : llvm::make_range(ItCurrent, ItNext))
8136 for (auto *J : llvm::make_range(ItCurrent, ItNext))
8137 if (I != J)
8138 Check(!DT.dominates(I, J),
8139 "llvm.experimental.noalias.scope.decl dominates another one "
8140 "with the same scope",
8141 I);
8142 ItCurrent = ItNext;
8143 }
8144}
8145
8146//===----------------------------------------------------------------------===//
8147// Implement the public interfaces to this file...
8148//===----------------------------------------------------------------------===//
8149
8151 Function &F = const_cast<Function &>(f);
8152
8153 // Don't use a raw_null_ostream. Printing IR is expensive.
8154 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
8155
8156 // Note that this function's return value is inverted from what you would
8157 // expect of a function called "verify".
8158 return !V.verify(F);
8159}
8160
8162 bool *BrokenDebugInfo) {
8163 // Don't use a raw_null_ostream. Printing IR is expensive.
8164 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
8165
8166 bool Broken = false;
8167 for (const Function &F : M)
8168 Broken |= !V.verify(F);
8169
8170 Broken |= !V.verify();
8171 if (BrokenDebugInfo)
8172 *BrokenDebugInfo = V.hasBrokenDebugInfo();
8173 // Note that this function's return value is inverted from what you would
8174 // expect of a function called "verify".
8175 return Broken;
8176}
8177
8178namespace {
8179
8180struct VerifierLegacyPass : public FunctionPass {
8181 static char ID;
8182
8183 std::unique_ptr<Verifier> V;
8184 bool FatalErrors = true;
8185
8186 VerifierLegacyPass() : FunctionPass(ID) {}
8187 explicit VerifierLegacyPass(bool FatalErrors)
8188 : FunctionPass(ID), FatalErrors(FatalErrors) {}
8189
8190 bool doInitialization(Module &M) override {
8191 V = std::make_unique<Verifier>(
8192 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
8193 return false;
8194 }
8195
8196 bool runOnFunction(Function &F) override {
8197 if (!V->verify(F) && FatalErrors) {
8198 errs() << "in function " << F.getName() << '\n';
8199 report_fatal_error("Broken function found, compilation aborted!");
8200 }
8201 return false;
8202 }
8203
8204 bool doFinalization(Module &M) override {
8205 bool HasErrors = false;
8206 for (Function &F : M)
8207 if (F.isDeclaration())
8208 HasErrors |= !V->verify(F);
8209
8210 HasErrors |= !V->verify();
8211 if (FatalErrors && (HasErrors || V->hasBrokenDebugInfo()))
8212 report_fatal_error("Broken module found, compilation aborted!");
8213 return false;
8214 }
8215
8216 void getAnalysisUsage(AnalysisUsage &AU) const override {
8217 AU.setPreservesAll();
8218 }
8219};
8220
8221} // end anonymous namespace
8222
8223/// Helper to issue failure from the TBAA verification
8224template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
8225 if (Diagnostic)
8226 return Diagnostic->CheckFailed(Args...);
8227}
8228
8229#define CheckTBAA(C, ...) \
8230 do { \
8231 if (!(C)) { \
8232 CheckFailed(__VA_ARGS__); \
8233 return false; \
8234 } \
8235 } while (false)
8236
8237/// Verify that \p BaseNode can be used as the "base type" in the struct-path
8238/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
8239/// struct-type node describing an aggregate data structure (like a struct).
8240TBAAVerifier::TBAABaseNodeSummary
8241TBAAVerifier::verifyTBAABaseNode(const Instruction *I, const MDNode *BaseNode,
8242 bool IsNewFormat) {
8243 if (BaseNode->getNumOperands() < 2) {
8244 CheckFailed("Base nodes must have at least two operands", I, BaseNode);
8245 return {true, ~0u};
8246 }
8247
8248 auto Itr = TBAABaseNodes.find(BaseNode);
8249 if (Itr != TBAABaseNodes.end())
8250 return Itr->second;
8251
8252 auto Result = verifyTBAABaseNodeImpl(I, BaseNode, IsNewFormat);
8253 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
8254 (void)InsertResult;
8255 assert(InsertResult.second && "We just checked!");
8256 return Result;
8257}
8258
8259TBAAVerifier::TBAABaseNodeSummary
8260TBAAVerifier::verifyTBAABaseNodeImpl(const Instruction *I,
8261 const MDNode *BaseNode, bool IsNewFormat) {
8262 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
8263
8264 if (BaseNode->getNumOperands() == 2) {
8265 // Scalar nodes can only be accessed at offset 0.
8266 return isValidScalarTBAANode(BaseNode)
8267 ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
8268 : InvalidNode;
8269 }
8270
8271 if (IsNewFormat) {
8272 if (BaseNode->getNumOperands() % 3 != 0) {
8273 CheckFailed("Access tag nodes must have the number of operands that is a "
8274 "multiple of 3!", BaseNode);
8275 return InvalidNode;
8276 }
8277 } else {
8278 if (BaseNode->getNumOperands() % 2 != 1) {
8279 CheckFailed("Struct tag nodes must have an odd number of operands!",
8280 BaseNode);
8281 return InvalidNode;
8282 }
8283 }
8284
8285 // Check the type size field.
8286 if (IsNewFormat) {
8287 auto *TypeSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
8288 BaseNode->getOperand(1));
8289 if (!TypeSizeNode) {
8290 CheckFailed("Type size nodes must be constants!", I, BaseNode);
8291 return InvalidNode;
8292 }
8293 }
8294
8295 // Check the type name field. In the new format it can be anything.
8296 if (!IsNewFormat && !isa<MDString>(BaseNode->getOperand(0))) {
8297 CheckFailed("Struct tag nodes have a string as their first operand",
8298 BaseNode);
8299 return InvalidNode;
8300 }
8301
8302 bool Failed = false;
8303
8304 std::optional<APInt> PrevOffset;
8305 unsigned BitWidth = ~0u;
8306
8307 // We've already checked that BaseNode is not a degenerate root node with one
8308 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
8309 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
8310 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
8311 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
8312 Idx += NumOpsPerField) {
8313 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
8314 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
8315 if (!isa<MDNode>(FieldTy)) {
8316 CheckFailed("Incorrect field entry in struct type node!", I, BaseNode);
8317 Failed = true;
8318 continue;
8319 }
8320
8321 auto *OffsetEntryCI =
8323 if (!OffsetEntryCI) {
8324 CheckFailed("Offset entries must be constants!", I, BaseNode);
8325 Failed = true;
8326 continue;
8327 }
8328
8329 if (BitWidth == ~0u)
8330 BitWidth = OffsetEntryCI->getBitWidth();
8331
8332 if (OffsetEntryCI->getBitWidth() != BitWidth) {
8333 CheckFailed(
8334 "Bitwidth between the offsets and struct type entries must match", I,
8335 BaseNode);
8336 Failed = true;
8337 continue;
8338 }
8339
8340 // NB! As far as I can tell, we generate a non-strictly increasing offset
8341 // sequence only from structs that have zero size bit fields. When
8342 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
8343 // pick the field lexically the latest in struct type metadata node. This
8344 // mirrors the actual behavior of the alias analysis implementation.
8345 bool IsAscending =
8346 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
8347
8348 if (!IsAscending) {
8349 CheckFailed("Offsets must be increasing!", I, BaseNode);
8350 Failed = true;
8351 }
8352
8353 PrevOffset = OffsetEntryCI->getValue();
8354
8355 if (IsNewFormat) {
8356 auto *MemberSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
8357 BaseNode->getOperand(Idx + 2));
8358 if (!MemberSizeNode) {
8359 CheckFailed("Member size entries must be constants!", I, BaseNode);
8360 Failed = true;
8361 continue;
8362 }
8363 }
8364 }
8365
8366 return Failed ? InvalidNode
8367 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
8368}
8369
8370static bool IsRootTBAANode(const MDNode *MD) {
8371 return MD->getNumOperands() < 2;
8372}
8373
8374static bool IsScalarTBAANodeImpl(const MDNode *MD,
8376 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
8377 return false;
8378
8379 if (!isa<MDString>(MD->getOperand(0)))
8380 return false;
8381
8382 if (MD->getNumOperands() == 3) {
8384 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
8385 return false;
8386 }
8387
8388 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
8389 return Parent && Visited.insert(Parent).second &&
8390 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
8391}
8392
8393bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
8394 auto ResultIt = TBAAScalarNodes.find(MD);
8395 if (ResultIt != TBAAScalarNodes.end())
8396 return ResultIt->second;
8397
8398 SmallPtrSet<const MDNode *, 4> Visited;
8399 bool Result = IsScalarTBAANodeImpl(MD, Visited);
8400 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
8401 (void)InsertResult;
8402 assert(InsertResult.second && "Just checked!");
8403
8404 return Result;
8405}
8406
8407/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
8408/// Offset in place to be the offset within the field node returned.
8409///
8410/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
8411MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(const Instruction *I,
8412 const MDNode *BaseNode,
8413 APInt &Offset,
8414 bool IsNewFormat) {
8415 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
8416
8417 // Scalar nodes have only one possible "field" -- their parent in the access
8418 // hierarchy. Offset must be zero at this point, but our caller is supposed
8419 // to check that.
8420 if (BaseNode->getNumOperands() == 2)
8421 return cast<MDNode>(BaseNode->getOperand(1));
8422
8423 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
8424 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
8425 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
8426 Idx += NumOpsPerField) {
8427 auto *OffsetEntryCI =
8428 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
8429 if (OffsetEntryCI->getValue().ugt(Offset)) {
8430 if (Idx == FirstFieldOpNo) {
8431 CheckFailed("Could not find TBAA parent in struct type node", I,
8432 BaseNode, &Offset);
8433 return nullptr;
8434 }
8435
8436 unsigned PrevIdx = Idx - NumOpsPerField;
8437 auto *PrevOffsetEntryCI =
8438 mdconst::extract<ConstantInt>(BaseNode->getOperand(PrevIdx + 1));
8439 Offset -= PrevOffsetEntryCI->getValue();
8440 return cast<MDNode>(BaseNode->getOperand(PrevIdx));
8441 }
8442 }
8443
8444 unsigned LastIdx = BaseNode->getNumOperands() - NumOpsPerField;
8445 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
8446 BaseNode->getOperand(LastIdx + 1));
8447 Offset -= LastOffsetEntryCI->getValue();
8448 return cast<MDNode>(BaseNode->getOperand(LastIdx));
8449}
8450
8452 if (!Type || Type->getNumOperands() < 3)
8453 return false;
8454
8455 // In the new format type nodes shall have a reference to the parent type as
8456 // its first operand.
8457 return isa_and_nonnull<MDNode>(Type->getOperand(0));
8458}
8459
8460/// Returns true if the parent chain of the TBAA type node \p MD is acyclic.
8461static bool hasAcyclicTBAAParentChain(const MDNode *MD) {
8463 for (const MDNode *N = MD; N;) {
8464 if (!Visited.insert(N).second)
8465 return false;
8467 N = cast<MDNode>(N->getOperand(0));
8468 } else {
8469 N = IsRootTBAANode(N) ? nullptr
8470 : dyn_cast_or_null<MDNode>(N->getOperand(1));
8471 }
8472 }
8473 return true;
8474}
8475
8477 CheckTBAA(MD->getNumOperands() > 0, "TBAA metadata cannot have 0 operands", I,
8478 MD);
8479
8480 if (I)
8484 "This instruction shall not have a TBAA access tag!", I);
8485
8486 bool IsStructPathTBAA =
8487 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
8488
8489 CheckTBAA(IsStructPathTBAA,
8490 "Old-style TBAA is no longer allowed, use struct-path TBAA instead",
8491 I);
8492
8493 auto *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
8494 auto *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
8495
8496 bool IsNewFormat = isNewFormatTBAATypeNode(AccessType);
8497
8498 if (IsNewFormat) {
8499 CheckTBAA(MD->getNumOperands() == 4 || MD->getNumOperands() == 5,
8500 "Access tag metadata must have either 4 or 5 operands", I, MD);
8501 } else {
8502 CheckTBAA(MD->getNumOperands() < 5,
8503 "Struct tag metadata must have either 3 or 4 operands", I, MD);
8504 }
8505
8506 // Check the access size field.
8507 if (IsNewFormat) {
8508 auto *AccessSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
8509 MD->getOperand(3));
8510 CheckTBAA(AccessSizeNode, "Access size field must be a constant", I, MD);
8511 }
8512
8513 // Check the immutability flag.
8514 unsigned ImmutabilityFlagOpNo = IsNewFormat ? 4 : 3;
8515 if (MD->getNumOperands() == ImmutabilityFlagOpNo + 1) {
8516 auto *IsImmutableCI = mdconst::dyn_extract_or_null<ConstantInt>(
8517 MD->getOperand(ImmutabilityFlagOpNo));
8518 CheckTBAA(IsImmutableCI,
8519 "Immutability tag on struct tag metadata must be a constant", I,
8520 MD);
8521 CheckTBAA(
8522 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
8523 "Immutability part of the struct tag metadata must be either 0 or 1", I,
8524 MD);
8525 }
8526
8527 CheckTBAA(BaseNode && AccessType,
8528 "Malformed struct tag metadata: base and access-type "
8529 "should be non-null and point to Metadata nodes",
8530 I, MD, BaseNode, AccessType);
8531
8532 if (!IsNewFormat) {
8533 CheckTBAA(isValidScalarTBAANode(AccessType),
8534 "Access type node must be a valid scalar type", I, MD,
8535 AccessType);
8536 } else {
8538 "Cycle detected in access type parent chain", I, MD, AccessType);
8539 }
8540
8542 CheckTBAA(OffsetCI, "Offset must be constant integer", I, MD);
8543
8544 APInt Offset = OffsetCI->getValue();
8545 bool SeenAccessTypeInPath = false;
8546
8547 SmallPtrSet<MDNode *, 4> StructPath;
8548
8549 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
8550 BaseNode =
8551 getFieldNodeFromTBAABaseNode(I, BaseNode, Offset, IsNewFormat)) {
8552 if (!StructPath.insert(BaseNode).second) {
8553 CheckFailed("Cycle detected in struct path", I, MD);
8554 return false;
8555 }
8556
8557 bool Invalid;
8558 unsigned BaseNodeBitWidth;
8559 std::tie(Invalid, BaseNodeBitWidth) =
8560 verifyTBAABaseNode(I, BaseNode, IsNewFormat);
8561
8562 // If the base node is invalid in itself, then we've already printed all the
8563 // errors we wanted to print.
8564 if (Invalid)
8565 return false;
8566
8567 SeenAccessTypeInPath |= BaseNode == AccessType;
8568
8569 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
8570 CheckTBAA(Offset == 0, "Offset not zero at the point of scalar access", I,
8571 MD, &Offset);
8572
8573 CheckTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
8574 (BaseNodeBitWidth == 0 && Offset == 0) ||
8575 (IsNewFormat && BaseNodeBitWidth == ~0u),
8576 "Access bit-width not the same as description bit-width", I, MD,
8577 BaseNodeBitWidth, Offset.getBitWidth());
8578
8579 if (IsNewFormat && SeenAccessTypeInPath)
8580 break;
8581 }
8582
8583 CheckTBAA(SeenAccessTypeInPath, "Did not see access type in access path!", I,
8584 MD);
8585 return true;
8586}
8587
8589 const MDNode *MD) {
8590 // !tbaa.struct is a list of (offset, size, tag) triples with ascending
8591 // offsets. Offset and size must be constants; a tag must be null or a valid
8592 // access tag.
8593 CheckTBAA(MD->getNumOperands() % 3 == 0,
8594 "!tbaa.struct operands must come in groups of three", I, MD);
8595
8596 std::optional<APInt> PrevOffset;
8597 for (unsigned Idx = 0, E = MD->getNumOperands(); Idx != E; Idx += 3) {
8598 auto *OffsetCI =
8600 CheckTBAA(OffsetCI, "!tbaa.struct field offset must be a constant integer",
8601 I, MD);
8602 CheckTBAA(
8604 "!tbaa.struct field size must be a constant integer", I, MD);
8605 if (const Metadata *TagMD = MD->getOperand(Idx + 2)) {
8606 auto *Tag = dyn_cast<MDNode>(TagMD);
8607 CheckTBAA(Tag, "!tbaa.struct field tag must be null or an MDNode", I, MD);
8608 if (!visitTBAAMetadata(I, Tag))
8609 return false;
8610 }
8611
8612 const APInt &Offset = OffsetCI->getValue();
8613 if (PrevOffset) {
8614 unsigned Width =
8615 std::max(PrevOffset->getBitWidth(), Offset.getBitWidth());
8616 CheckTBAA(PrevOffset->zext(Width).ule(Offset.zext(Width)),
8617 "!tbaa.struct field offsets must be non-decreasing", I, MD);
8618 }
8619 PrevOffset = Offset;
8620 }
8621 return true;
8622}
8623
8624char VerifierLegacyPass::ID = 0;
8625INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
8626
8628 return new VerifierLegacyPass(FatalErrors);
8629}
8630
8631AnalysisKey VerifierAnalysis::Key;
8638
8643
8645 auto Res = AM.getResult<VerifierAnalysis>(M);
8646 if (FatalErrors && (Res.IRBroken || Res.DebugInfoBroken))
8647 report_fatal_error("Broken module found, compilation aborted!");
8648
8649 return PreservedAnalyses::all();
8650}
8651
8653 auto res = AM.getResult<VerifierAnalysis>(F);
8654 if (res.IRBroken && FatalErrors)
8655 report_fatal_error("Broken function found, compilation aborted!");
8656
8657 return PreservedAnalyses::all();
8658}
SDValue Pred
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
uint64_t uint64_t
uint64_t Imm
This file declares a class to represent arbitrary precision floating point values and provide a varie...
This file implements a class to represent arbitrary precision integral constant values and operations...
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
Function Alias Analysis false
Atomic ordering constants.
@ RetAttr
@ FnAttr
This file contains the simple types necessary to represent the attributes associated with functions a...
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
This file declares the LLVM IR specialization of the GenericConvergenceVerifier template.
static DISubprogram * getSubprogram(bool IsDistinct, Ts &&...Args)
dxil translate DXIL Translate Metadata
This file defines the DenseMap class.
This file contains constants used for implementing Dwarf debug support.
static bool runOnFunction(Function &F, bool PostInlining)
This file contains the declarations of entities that describe floating point environment and related ...
#define Check(C,...)
Hexagon Common GEP
This file provides various utilities for inspecting and working with the control flow graph in LLVM I...
Module.h This file contains the declarations for the Module class.
This header defines various interfaces for pass management in LLVM.
This defines the Use class.
static constexpr Value * getValue(Ty &ValueOrUse)
const size_t AbstractManglingParser< Derived, Alloc >::NumOps
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Machine Check Debug Module
This file implements a map that provides insertion order iteration.
This file provides utility for Memory Model Relaxation Annotations (MMRAs).
static bool isContiguous(const ConstantRange &A, const ConstantRange &B)
This file contains the declarations for metadata subclasses.
#define T
ConstantRange Range(APInt(BitWidth, Low), APInt(BitWidth, High))
uint64_t High
uint64_t IntrinsicInst * II
ppc ctr loops verify
#define INITIALIZE_PASS(passName, arg, name, cfg, analysis)
Definition PassSupport.h:56
This file contains the declarations for profiling metadata utility functions.
SmallVector< MachineOperand, 4 > Cond
static void visit(BasicBlock &Start, std::function< bool(BasicBlock *)> op)
This file contains some templates that are useful if you are working with the STL at all.
verify safepoint Safepoint IR Verifier
BaseType
A given derived pointer can have multiple base pointers through phi/selects.
This file defines the SmallPtrSet class.
This file defines the SmallVector class.
This file contains some functions that are useful when dealing with strings.
static unsigned getBitWidth(Type *Ty, const DataLayout &DL)
Returns the bitwidth of the given scalar or pointer type.
static bool IsScalarTBAANodeImpl(const MDNode *MD, SmallPtrSetImpl< const MDNode * > &Visited)
static bool isType(const Metadata *MD)
static Instruction * getSuccPad(Instruction *Terminator)
static bool isMDTuple(const Metadata *MD)
#define CheckDI(C,...)
We know that a debug info condition should be true, if not print an error message.
Definition Verifier.cpp:525
static void forEachUser(const Value *User, SmallPtrSet< const Value *, 32 > &Visited, llvm::function_ref< bool(const Value *)> Callback)
Definition Verifier.cpp:566
static const Metadata * getRawDIScopeParent(const Metadata *S)
Parent scope operand of S, or null if S has no parent (a DIFile, DICompileUnit, or non-scope).
Definition Verifier.cpp:971
static bool isDINode(const Metadata *MD)
static bool isSupportedCallBrIntrinsic(Intrinsic::ID ID)
static bool isScope(const Metadata *MD)
static bool hasAcyclicTBAAParentChain(const MDNode *MD)
Returns true if the parent chain of the TBAA type node MD is acyclic.
#define CheckTBAA(C,...)
static bool IsRootTBAANode(const MDNode *MD)
static Value * getParentPad(Value *EHPad)
static bool hasConflictingReferenceFlags(unsigned Flags)
Detect mutually exclusive flags.
static AttrBuilder getParameterABIAttributes(LLVMContext &C, unsigned I, AttributeList Attrs)
static bool isNewFormatTBAATypeNode(const MDNode *Type)
static const char PassName[]
static LLVM_ABI bool isValidArbitraryFPFormat(StringRef Format)
Returns true if the given string is a valid arbitrary floating-point format interpretation for llvm....
Definition APFloat.cpp:6336
static LLVM_ABI unsigned getArbitraryFPFormatSizeInBits(StringRef Format)
Returns the size in bits of a valid arbitrary floating-point format string, or 0 if the string is not...
Definition APFloat.cpp:6319
bool isFiniteNonZero() const
Definition APFloat.h:1593
bool isNegative() const
Definition APFloat.h:1583
const fltSemantics & getSemantics() const
Definition APFloat.h:1591
Class for arbitrary precision integers.
Definition APInt.h:78
bool sgt(const APInt &RHS) const
Signed greater than comparison.
Definition APInt.h:1205
bool isMinValue() const
Determine if this is the smallest unsigned value.
Definition APInt.h:413
bool ule(const APInt &RHS) const
Unsigned less or equal comparison.
Definition APInt.h:1154
bool isPowerOf2() const
Check if this APInt's value is a power of two greater than zero.
Definition APInt.h:436
bool isMaxValue() const
Determine if this is the largest unsigned value.
Definition APInt.h:395
This class represents a conversion between pointers from one address space to another.
bool isSwiftError() const
Return true if this alloca is used as a swifterror argument to a call.
LLVM_ABI bool isStaticAlloca() const
Return true if this alloca is in the entry block of the function and is a constant size.
Align getAlign() const
Return the alignment of the memory that is being allocated by the instruction.
Type * getAllocatedType() const
Return the type that is being allocated by the instruction.
LLVM_ABI bool isArrayAllocation() const
Return true if there is an allocation size parameter to the allocation instruction that is not 1.
const Value * getArraySize() const
Get the number of elements allocated.
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
void setPreservesAll()
Set by analyses that do not transform their input at all.
bool isElementwise() const
Return true if this RMW has elementwise vector semantics.
static bool isFPOperation(BinOp Op)
BinOp getOperation() const
static LLVM_ABI StringRef getOperationName(BinOp Op)
AtomicOrdering getOrdering() const
Returns the ordering constraint of this rmw instruction.
bool contains(Attribute::AttrKind A) const
Return true if the builder has the specified attribute.
LLVM_ABI bool hasAttribute(Attribute::AttrKind Kind) const
Return true if the attribute exists in this set.
Functions, function parameters, and return types can have attributes to indicate how they should be t...
Definition Attributes.h:106
LLVM_ABI const ConstantRange & getValueAsConstantRange() const
Return the attribute's value as a ConstantRange.
LLVM_ABI StringRef getValueAsString() const
Return the attribute's value as a string.
AttrKind
This enumeration lists the attributes that can be associated with parameters, function results,...
Definition Attributes.h:125
bool isValid() const
Return true if the attribute is any kind of attribute.
Definition Attributes.h:262
LLVM_ABI Type * getValueAsType() const
Return the attribute's value as a Type.
LLVM Basic Block Representation.
Definition BasicBlock.h:62
iterator begin()
Instruction iterator methods.
Definition BasicBlock.h:440
iterator_range< const_phi_iterator > phis() const
Returns a range that iterates over the phis in the basic block.
Definition BasicBlock.h:509
const Function * getParent() const
Return the enclosing method, or null if none.
Definition BasicBlock.h:213
LLVM_ABI InstListType::const_iterator getFirstNonPHIIt() const
Returns an iterator to the first instruction in this block that is not a PHINode instruction.
LLVM_ABI bool isEntryBlock() const
Return true if this is the entry block of the containing function.
const Instruction & front() const
Definition BasicBlock.h:463
LLVM_ABI const BasicBlock * getUniquePredecessor() const
Return the predecessor of this block if it has a unique predecessor block.
InstListType::iterator iterator
Instruction iterators...
Definition BasicBlock.h:170
const Instruction * getTerminator() const LLVM_READONLY
Returns the terminator instruction; assumes that the block is well-formed.
Definition BasicBlock.h:237
This class represents a no-op cast from one type to another.
static LLVM_ABI const char * areInvalidOperands(const Type *Ty, Value *Val, Value *Offset)
Return a string if the specified operands are invalid for a bitextract operation, otherwise return nu...
static LLVM_ABI const char * areInvalidOperands(Value *Base, Value *Val, Value *Offset)
Return a string if the specified operands are invalid for a bitinsert operation, otherwise return nul...
static LLVM_ABI BlockAddress * lookup(const BasicBlock *BB)
Lookup an existing BlockAddress constant for the given BasicBlock.
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
bool isInlineAsm() const
Check if this call is an inline asm statement.
auto operand_bundles() const
bool hasInAllocaArgument() const
Determine if there are is an inalloca argument.
OperandBundleUse getOperandBundleAt(unsigned Index) const
Return the operand bundle at a specific index.
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
bool doesNotAccessMemory(unsigned OpNo) const
bool hasFnAttr(Attribute::AttrKind Kind) const
Determine whether this call has the given attribute.
bool hasRetAttr(Attribute::AttrKind Kind) const
Determine whether the return value has the given attribute.
unsigned getNumOperandBundles() const
Return the number of operand bundles associated with this User.
CallingConv::ID getCallingConv() const
LLVM_ABI bool paramHasAttr(unsigned ArgNo, Attribute::AttrKind Kind) const
Determine whether the argument or parameter has the given attribute.
Attribute getParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) const
Get the attribute of a given kind from a given arg.
unsigned countOperandBundlesOfType(StringRef Name) const
Return the number of operand bundles with the tag Name attached to this instruction.
bool onlyReadsMemory(unsigned OpNo) const
Value * getCalledOperand() const
Type * getParamElementType(unsigned ArgNo) const
Extract the elementtype type for a parameter.
Value * getArgOperand(unsigned i) const
FunctionType * getFunctionType() const
LLVM_ABI Intrinsic::ID getIntrinsicID() const
Returns the intrinsic ID of the intrinsic called or Intrinsic::not_intrinsic if the called function i...
iterator_range< User::op_iterator > args()
Iteration adapter for range-for loops.
bool doesNotReturn() const
Determine if the call cannot return.
LLVM_ABI bool onlyAccessesArgMemory() const
Determine if the call can access memmory only using pointers based on its arguments.
unsigned arg_size() const
AttributeList getAttributes() const
Return the attributes for this call.
bool hasOperandBundles() const
Return true if this User has any operand bundles.
LLVM_ABI Function * getCaller()
Helper to get the caller (the parent function).
CallBr instruction, tracking function calls that may not return control but instead transfer it to a ...
This class represents a function call, abstracting a target machine's calling convention.
bool isMustTailCall() const
static LLVM_ABI bool castIsValid(Instruction::CastOps op, Type *SrcTy, Type *DstTy)
This method can be used to determine if a cast from SrcTy to DstTy using Opcode op is valid or not.
unsigned getNumHandlers() const
return the number of 'handlers' in this catchswitch instruction, except the default handler
Value * getParentPad() const
BasicBlock * getUnwindDest() const
handler_range handlers()
iteration adapter for range-for loops.
BasicBlock * getUnwindDest() const
bool isFPPredicate() const
Definition InstrTypes.h:845
static bool isIntPredicate(Predicate P)
Definition InstrTypes.h:839
Conditional Branch instruction.
Value * getCondition() const
unsigned getBitWidth() const
getBitWidth - Return the scalar bitwidth of this constant.
Definition Constants.h:162
uint64_t getZExtValue() const
Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate...
Definition Constants.h:168
const APInt & getValue() const
Return the constant as an APInt value reference.
Definition Constants.h:159
Constant * getAddrDiscriminator() const
The address discriminator if any, or the null constant.
Definition Constants.h:1264
Constant * getPointer() const
The pointer that is signed in this ptrauth signed pointer.
Definition Constants.h:1251
ConstantInt * getKey() const
The Key ID, an i32 constant.
Definition Constants.h:1254
Constant * getDeactivationSymbol() const
Definition Constants.h:1273
ConstantInt * getDiscriminator() const
The integer discriminator, an i64 constant, or 0.
Definition Constants.h:1257
static LLVM_ABI bool isOrderedRanges(ArrayRef< ConstantRange > RangesRef)
This class represents a range of values.
LLVM_ABI bool contains(const APInt &Val) const
Return true if the specified value is in the set.
uint32_t getBitWidth() const
Get the bit width of this ConstantRange.
static LLVM_ABI ConstantTokenNone * get(LLVMContext &Context)
Return the ConstantTokenNone.
bool isNullValue() const
Return true if this is the value that would be returned by getNullValue.
Definition Constant.h:65
LLVM_ABI std::optional< fp::ExceptionBehavior > getExceptionBehavior() const
LLVM_ABI std::optional< RoundingMode > getRoundingMode() const
iterator_range< expr_op_iterator > expr_ops() const
DbgVariableFragmentInfo FragmentInfo
LLVM_ABI bool isValid() const
@ FixedPointBinary
Scale factor 2^Factor.
@ FixedPointDecimal
Scale factor 10^Factor.
@ FixedPointRational
Arbitrary rational scale factor.
DIGlobalVariable * getVariable() const
LLVM_ABI DISubprogram * getSubprogram() const
Get the subprogram for this scope.
DILocalScope * getScope() const
Get the local scope for this variable.
Metadata * getRawScope() const
Base class for scope-like contexts.
Subprogram description. Uses SubclassData1.
static LLVM_ABI const DIScope * getRawRetainedNodeScope(const MDNode *N)
Base class for template parameters.
Base class for types.
Base class for variables.
Metadata * getRawType() const
Metadata * getRawScope() const
Records a position in IR for a source label (DILabel).
Base class for non-instruction debug metadata records that have positions within IR.
DebugLoc getDebugLoc() const
LLVM_ABI BasicBlock * getParent()
LLVM_ABI Function * getFunction()
Record of a variable value-assignment, aka a non instruction representation of the dbg....
LLVM_ABI bool isKillLocation() const
LLVM_ABI Value * getVariableLocationOp(unsigned OpIdx) const
LLVM_ABI unsigned getNumVariableLocationOps() const
DIExpression * getExpression() const
DILocalVariable * getVariable() const
Metadata * getRawLocation() const
Returns the metadata operand for the first location description.
DIExpression * getAddressExpression() const
LLVM_ABI MDNode * getAsMDNode() const
Return this as a bar MDNode.
Definition DebugLoc.cpp:81
bool empty() const
Definition DenseMap.h:716
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:766
iterator end()
Definition DenseMap.h:686
ValueT lookup(const_arg_type_t< KeyT > Val) const
Return the entry for the specified key, or a default constructed value if no such entry exists.
Definition DenseMap.h:793
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition DenseMap.h:827
This instruction extracts a single (scalar) element from a VectorType value.
static LLVM_ABI bool isValidOperands(const Value *Vec, const Value *Idx)
Return true if an extractelement instruction can be formed with the specified operands.
ArrayRef< unsigned > getIndices() const
static LLVM_ABI Type * getIndexedType(Type *Agg, ArrayRef< unsigned > Idxs)
Returns the type of the element that would be extracted with an extractvalue instruction with the spe...
This instruction compares its operands according to the predicate given to the constructor.
This class represents an extension of floating point types.
static bool isSupportedFloatingPointType(Type *Ty)
Returns true if Ty is a supported floating-point type for phi, select, or call FPMathOperators.
Definition Operator.h:302
This class represents a cast from floating point to signed integer.
This class represents a cast from floating point to unsigned integer.
This class represents a truncation of floating point types.
AtomicOrdering getOrdering() const
Returns the ordering constraint of this fence instruction.
unsigned getNumElements() const
op_range arg_operands()
arg_operands - iteration adapter for range-for loops.
Value * getParentPad() const
Convenience accessors.
FunctionPass class - This class is used to implement most global optimizations.
Definition Pass.h:312
Type * getReturnType() const
FunctionType * getFunctionType() const
Returns the FunctionType for me.
Definition Function.h:212
DISubprogram * getSubprogram() const
Get the attached subprogram.
bool hasPersonalityFn() const
Check whether this function has a personality function.
Definition Function.h:890
const Function & getFunction() const
Definition Function.h:167
const std::string & getGC() const
Definition Function.cpp:821
Type * getReturnType() const
Returns the type of the ret val.
Definition Function.h:217
bool isVarArg() const
isVarArg - Return true if this function takes a variable number of arguments.
Definition Function.h:230
LLVM_ABI Value * getBasePtr() const
LLVM_ABI Value * getDerivedPtr() const
an instruction for type-safe pointer arithmetic to access elements of arrays and structs
static LLVM_ABI Type * getIndexedType(Type *Ty, ArrayRef< Value * > IdxList)
Returns the result type of a getelementptr with the given source element type and indexes.
static bool isValidLinkage(LinkageTypes L)
Definition GlobalAlias.h:98
const Constant * getAliasee() const
Definition GlobalAlias.h:87
LLVM_ABI const Function * getResolverFunction() const
Definition Globals.cpp:759
static bool isValidLinkage(LinkageTypes L)
Definition GlobalIFunc.h:86
const Constant * getResolver() const
Definition GlobalIFunc.h:73
LLVM_ABI void getAllMetadata(SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
Appends all metadata attached to this value to MDs, sorting by KindID.
bool hasComdat() const
MDNode * getMetadata(unsigned KindID) const
Get the metadata of given kind attached to this GlobalObject.
bool hasExternalLinkage() const
bool isDSOLocal() const
bool isImplicitDSOLocal() const
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:408
bool hasValidDeclarationLinkage() const
LinkageTypes getLinkage() const
bool hasDefaultVisibility() const
bool hasPrivateLinkage() const
bool hasHiddenVisibility() const
bool hasExternalWeakLinkage() const
bool hasDLLImportStorageClass() const
bool hasDLLExportStorageClass() const
bool isDeclarationForLinker() const
unsigned getAddressSpace() const
Module * getParent()
Get the module that this global value is contained inside of...
PointerType * getType() const
Global values are always pointers.
bool hasComdat() const
bool hasCommonLinkage() const
bool hasGlobalUnnamedAddr() const
bool hasAppendingLinkage() const
bool hasAvailableExternallyLinkage() const
Type * getValueType() const
LLVM_ABI bool isInterposable(bool CheckNoIPA=true) const
Return true if this global's definition can be substituted with an arbitrary definition at link time ...
Definition Globals.cpp:178
const Constant * getInitializer() const
getInitializer - Return the initializer for this global variable.
bool hasInitializer() const
Definitions have initializers, declarations don't.
MaybeAlign getAlign() const
Returns the alignment of the given variable.
LLVM_ABI uint64_t getGlobalSize(const DataLayout &DL) const
Get the size of this global variable in bytes.
Definition Globals.cpp:640
bool isConstant() const
If the value is a global constant, its value is immutable throughout the runtime execution of the pro...
bool hasDefinitiveInitializer() const
hasDefinitiveInitializer - Whether the global variable has an initializer, and any other instances of...
This instruction compares its operands according to the predicate given to the constructor.
Indirect Branch Instruction.
BasicBlock * getDestination(unsigned i)
Return the specified destination.
unsigned getNumDestinations() const
return the number of possible destinations in this indirectbr instruction.
unsigned getNumSuccessors() const
This instruction inserts a single (scalar) element into a VectorType value.
static LLVM_ABI bool isValidOperands(const Value *Vec, const Value *NewElt, const Value *Idx)
Return true if an insertelement instruction can be formed with the specified operands.
ArrayRef< unsigned > getIndices() const
Base class for instruction visitors.
Definition InstVisitor.h:78
void visit(Iterator Start, Iterator End)
Definition InstVisitor.h:87
LLVM_ABI unsigned getNumSuccessors() const LLVM_READONLY
Return the number of successors that this instruction has.
const DebugLoc & getDebugLoc() const
Return the debug location for this node as a DebugLoc.
LLVM_ABI const Module * getModule() const
Return the module owning the function this instruction belongs to or nullptr it the function does not...
LLVM_ABI bool isAtomic() const LLVM_READONLY
Return true if this instruction has an AtomicOrdering of unordered or higher.
LLVM_ABI const Function * getFunction() const
Return the function this instruction belongs to.
iterator_range< user_iterator > users()
This class represents a cast from an integer to a pointer.
static LLVM_ABI bool mayLowerToFunctionCall(Intrinsic::ID IID)
Check if the intrinsic might lower into a regular function call in the course of IR transformations.
Intrinsic::ID getIntrinsicID() const
Return the intrinsic ID of this intrinsic.
Invoke instruction.
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:76
bool isCleanup() const
Return 'true' if this landingpad instruction is a cleanup.
unsigned getNumClauses() const
Get the number of clauses for this landing pad.
bool isCatch(unsigned Idx) const
Return 'true' if the clause and index Idx is a catch clause.
bool isFilter(unsigned Idx) const
Return 'true' if the clause and index Idx is a filter clause.
Constant * getClause(unsigned Idx) const
Get the value of the clause at index Idx.
An instruction for reading from memory.
AtomicOrdering getOrdering() const
Returns the ordering constraint of this load instruction.
SyncScope::ID getSyncScopeID() const
Returns the synchronization scope ID of this load instruction.
bool isElementwise() const
Return true if this is an elementwise atomic load.
Align getAlign() const
Return the alignment of the access that is being performed.
Metadata node.
Definition Metadata.h:1081
const MDOperand & getOperand(unsigned I) const
Definition Metadata.h:1437
bool isTemporary() const
Definition Metadata.h:1265
ArrayRef< MDOperand > operands() const
Definition Metadata.h:1435
unsigned getNumOperands() const
Return number of MDNode operands.
Definition Metadata.h:1443
bool isDistinct() const
Definition Metadata.h:1264
bool isResolved() const
Check if node is fully resolved.
Definition Metadata.h:1261
LLVMContext & getContext() const
Definition Metadata.h:1245
bool equalsStr(StringRef Str) const
Definition Metadata.h:924
Metadata * get() const
Definition Metadata.h:931
LLVM_ABI StringRef getString() const
Definition Metadata.cpp:613
static LLVM_ABI bool isTagMD(const Metadata *MD)
Metadata * getMetadata() const
Definition Metadata.h:202
Root of the metadata hierarchy.
Definition Metadata.h:64
unsigned getMetadataID() const
Definition Metadata.h:104
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:68
Metadata * getModuleFlag(StringRef Key) const
Return the corresponding value if Key appears in module flags, otherwise return null.
Definition Module.cpp:358
LLVM_ABI StringRef getName() const
LLVM_ABI unsigned getNumOperands() const
iterator_range< op_iterator > operands()
Definition Metadata.h:1893
op_range incoming_values()
A set of analyses that are preserved following a run of a transformation pass.
Definition Analysis.h:112
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition Analysis.h:118
This class represents a cast from a pointer to an address (non-capturing ptrtoint).
This class represents a cast from a pointer to an integer.
Value * getValue() const
Convenience accessor.
Return a value (possibly void), from a function.
Value * getReturnValue() const
Convenience accessor. Returns null if there is no return value.
This class represents a sign extension of integer types.
This class represents a cast from signed integer to floating point.
This class represents the LLVM 'select' instruction.
static LLVM_ABI const char * areInvalidOperands(Value *Cond, Value *True, Value *False)
Return a string if the specified operands are invalid for a select operation, otherwise return null.
This instruction constructs a fixed permutation of two input vectors.
static LLVM_ABI bool isValidOperands(const Value *V1, const Value *V2, const Value *Mask)
Return true if a shufflevector instruction can be formed with the specified operands.
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
size_type count(ConstPtrType Ptr) const
count - Return 1 if the specified pointer is in the set, 0 otherwise.
void insert_range(Range &&R)
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
iterator insert(iterator I, T &&Elt)
void resize(size_type N)
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
An instruction for storing to memory.
std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition StringRef.h:736
static constexpr size_t npos
Definition StringRef.h:58
bool getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition StringRef.h:490
bool starts_with(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition StringRef.h:258
constexpr bool empty() const
Check if the string is empty.
Definition StringRef.h:141
std::pair< typename Base::iterator, bool > insert(StringRef key)
Definition StringSet.h:41
Multiway switch.
LLVM_ABI bool visitTBAAMetadata(const Instruction *I, const MDNode *MD)
Visit an instruction, or a TBAA node itself as part of a metadata, and return true if it is valid,...
LLVM_ABI bool visitTBAAStructMetadata(const Instruction *I, const MDNode *MD)
unsigned size() const
This class represents a truncation of integer types.
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
LLVM_ABI unsigned getIntegerBitWidth() const
bool isByteTy() const
True if this is an instance of ByteType.
Definition Type.h:237
bool isVectorTy() const
True if this is an instance of VectorType.
Definition Type.h:283
bool isLabelTy() const
Return true if this is 'label'.
Definition Type.h:225
bool isIntOrIntVectorTy() const
Return true if this is an integer type or a vector of integer types.
Definition Type.h:258
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:277
LLVM_ABI bool isTokenLikeTy() const
Returns true if this is 'token' or a token-like target type.s.
Definition Type.cpp:1113
LLVM_ABI unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
bool isSingleValueType() const
Return true if the type is a valid type for a register in codegen.
Definition Type.h:306
LLVM_ABI bool canLosslesslyBitCastTo(Type *Ty) const
Return true if this type could be converted with a lossless BitCast to type 'Ty'.
Definition Type.cpp:143
bool isSized() const
Return true if it makes sense to take the size of this type.
Definition Type.h:321
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition Type.h:363
bool isByteOrByteVectorTy() const
Return true if this is a byte type or a vector of byte types.
Definition Type.h:243
bool isAggregateType() const
Return true if the type is an aggregate type.
Definition Type.h:314
LLVM_ABI unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
Definition Type.cpp:222
bool isFloatingPointTy() const
Return true if this is one of the floating-point types.
Definition Type.h:186
bool isPtrOrPtrVectorTy() const
Return true if this is a pointer type or a vector of pointer types.
Definition Type.h:280
LLVM_ABI unsigned getByteBitWidth() const
LLVM_ABI bool isScalableTy() const
Return true if this is a type whose size is a known multiple of vscale.
Definition Type.cpp:61
bool isIntOrPtrTy() const
Return true if this is an integer type or a pointer type.
Definition Type.h:265
bool isIntegerTy() const
True if this is an instance of IntegerType.
Definition Type.h:252
bool isFPOrFPVectorTy() const
Return true if this is a FP type or a vector of FP.
Definition Type.h:222
LLVM_ABI bool containsNonLocalTargetExtType() const
Return true if this type is or contains a target extension type that disallows being used as a local.
Definition Type.cpp:86
LLVM_ABI bool containsNonGlobalTargetExtType() const
Return true if this type is or contains a target extension type that disallows being used as a global...
Definition Type.cpp:76
bool isVoidTy() const
Return true if this is 'void'.
Definition Type.h:141
bool isMetadataTy() const
Return true if this is 'metadata'.
Definition Type.h:228
This class represents a cast unsigned integer to floating point.
Value * getOperand(unsigned i) const
Definition User.h:207
unsigned getNumOperands() const
Definition User.h:229
This class represents the va_arg llvm instruction, which returns an argument of the specified type gi...
Value * getValue() const
Definition Metadata.h:510
LLVM Value Representation.
Definition Value.h:75
iterator_range< user_iterator > materialized_users()
Definition Value.h:422
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:257
LLVM_ABI const Value * stripPointerCastsAndAliases() const
Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
Definition Value.cpp:711
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:260
LLVM_ABI const Value * stripInBoundsOffsets(function_ref< void(const Value *)> Func=[](const Value *) {}) const
Strip off pointer casts and inbounds GEPs.
Definition Value.cpp:823
iterator_range< user_iterator > users()
Definition Value.h:428
bool materialized_use_empty() const
Definition Value.h:353
LLVM_ABI const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs and address space casts.
Definition Value.cpp:707
bool hasName() const
Definition Value.h:263
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:314
Type * getElementType() const
Check a module for errors, and report separate error states for IR and debug info errors.
Definition Verifier.h:110
LLVM_ABI Result run(Module &M, ModuleAnalysisManager &)
LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM)
This class represents zero extension of integer types.
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:210
constexpr bool isNonZero() const
Definition TypeSize.h:156
constexpr bool isScalable() const
Returns whether the quantity is scaled by a runtime quantity (vscale).
Definition TypeSize.h:169
constexpr ScalarTy getKnownMinValue() const
Returns the minimum value this quantity can represent.
Definition TypeSize.h:166
An efficient, type-erasing, non-owning reference to a callable.
const ParentTy * getParent() const
Definition ilist_node.h:34
NodeTy * getNextNode()
Get the next node, or nullptr for the list tail.
Definition ilist_node.h:348
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
CallInst * Call
This file contains the declaration of the Comdat class, which represents a single COMDAT in LLVM.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
constexpr char Attrs[]
Key for Kernel::Metadata::mAttrs.
@ Entry
Definition COFF.h:862
std::optional< ABIType > parseABIType(StringRef S)
Parse the string spelling used by the "float-abi" IR module flag into an ABIType.
Definition CodeGen.h:167
@ BasicBlock
Various leaf nodes.
Definition ISDOpcodes.h:83
LLVM_ABI bool hasConstrainedFPRoundingModeOperand(ID QID)
Returns true if the intrinsic ID is for one of the "ConstrainedFloating-Point Intrinsics" that take r...
LLVM_ABI StringRef getName(ID id)
Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx".
static const int NoAliasScopeDeclScopeArg
Definition Intrinsics.h:44
LLVM_ABI bool isSignatureValid(Intrinsic::ID ID, FunctionType *FT, SmallVectorImpl< Type * > &OverloadTys, raw_ostream &OS=nulls())
Returns true if FT is a valid function type for intrinsic ID.
LLVM_ABI bool isImmArgValueInRangeSet(ID IID, unsigned ArgIdx, const APInt &Value)
Returns true if Value satisfies the range constraints specified for argument ArgIdx of intrinsic IID.
std::variant< std::monostate, Loc::Single, Loc::Multi, Loc::MMI, Loc::EntryValue > Variant
Alias for the std::variant specialization base class of DbgVariable.
Definition DwarfDebug.h:190
Flag
These should be considered private to the implementation of the MCInstrDesc class.
constexpr MCPhysReg SP
constexpr StringLiteral AbiPreserveAttrs[]
@ System
Synchronized with respect to all concurrently executing threads.
Definition LLVMContext.h:66
LLVM_ABI std::optional< VFInfo > tryDemangleForVFABI(StringRef MangledName, const FunctionType *FTy)
Function to construct a VFInfo out of a mangled names in the following format:
@ CE
Windows NT (Windows on ARM)
Definition MCAsmInfo.h:51
AssignmentInstRange getAssignmentInsts(DIAssignID *ID)
Return a range of instructions (typically just one) that have ID as an attachment.
Definition DebugInfo.h:190
SmallVector< DbgVariableRecord * > getAssignmentMarkers(DIAssignID *ID)
Definition DebugInfo.h:202
@ DW_LLVM_LANG_DIALECT_max
Definition Dwarf.h:212
@ DW_OP_LLVM_arg
Only used in LLVM metadata.
Definition Dwarf.h:149
@ DW_MACINFO_undef
Definition Dwarf.h:921
@ DW_MACINFO_start_file
Definition Dwarf.h:922
@ DW_MACINFO_define
Definition Dwarf.h:920
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > dyn_extract_or_null(Y &&MD)
Extract a Value from Metadata, if any, allowing null.
Definition Metadata.h:720
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > extract_or_null(Y &&MD)
Extract a Value from Metadata, allowing null.
Definition Metadata.h:694
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > dyn_extract(Y &&MD)
Extract a Value from Metadata, if any.
Definition Metadata.h:707
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > extract(Y &&MD)
Extract a Value from Metadata.
Definition Metadata.h:679
@ User
could "use" a pointer
NodeAddr< UseNode * > Use
Definition RDFGraph.h:385
NodeAddr< NodeBase * > Node
Definition RDFGraph.h:381
bool empty() const
Definition BasicBlock.h:101
friend class Instruction
Iterator for Instructions in a `BasicBlock.
Definition BasicBlock.h:73
This is an optimization pass for GlobalISel generic memory operations.
std::optional< LongDoubleFormat > parseLongDoubleFormat(StringRef Name)
Parses an IR floating-point type name into a LongDoubleFormat, returning std::nullopt if it does not ...
Definition CodeGen.h:144
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
Definition STLExtras.h:316
@ Low
Lower the current thread's priority such that it does not affect foreground tasks significantly.
Definition Threading.h:280
@ Offset
Definition DWP.cpp:577
bool all_of(R &&range, UnaryPredicate P)
Provide wrappers to std::all_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1755
LLVM_ABI bool canInstructionHaveMMRAs(const Instruction &I)
detail::zippy< detail::zip_first, T, U, Args... > zip_equal(T &&t, U &&u, Args &&...args)
zip iterator that assumes that all iteratees have the same length.
Definition STLExtras.h:856
LLVM_ABI unsigned getBranchWeightOffset(const MDNode *ProfileData)
Return the offset to the first branch weight data.
constexpr bool isInt(int64_t x)
Checks if an integer fits into the given bit width.
Definition MathExtras.h:166
RelativeUniformCounterPtr Values
Definition InstrProf.h:91
BundleAttr getBundleAttrFromOBU(OperandBundleUse OBU)
auto enumerate(FirstRange &&First, RestRanges &&...Rest)
Given two or more input ranges, returns a new range whose values are tuples (A, B,...
Definition STLExtras.h:2570
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
LLVM_ABI bool verifyFunction(const Function &F, raw_ostream *OS=nullptr)
Check a function for errors, useful for use when debugging a pass.
AllocFnKind
Definition Attributes.h:54
testing::Matcher< const detail::ErrorHolder & > Failed()
Definition Error.h:198
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
Definition STLExtras.h:2224
LLVM_ABI DenseMap< BasicBlock *, ColorVector > colorEHFunclets(Function &F)
If an EH funclet personality is in use (see isFuncletEHPersonality), this will recompute which blocks...
constexpr bool isUIntN(unsigned N, uint64_t x)
Checks if an unsigned integer fits into the given (dynamic) bit width.
Definition MathExtras.h:244
void verifyAMDGPUAlloca(VerifierSupport &VS, const AllocaInst &AI)
constexpr bool isPowerOf2_64(uint64_t Value)
Return true if the argument is a power of two > 0 (64 bit edition.)
Definition MathExtras.h:285
gep_type_iterator gep_type_end(const User *GEP)
bool isa_and_nonnull(const Y &Val)
Definition Casting.h:676
Op::Description Desc
bool isScopedEHPersonality(EHPersonality Pers)
Returns true if this personality uses scope-style EH IR instructions: catchswitch,...
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Value
Definition InstrProf.h:143
void verifyAMDGPUFunctionMetadata(VerifierSupport &VS, const Function &F)
std::optional< ExceptionHandling > parseExceptionModel(StringRef Name)
Parses the string spelling used by the "exception-model" IR module flag into an ExceptionHandling val...
Definition CodeGen.h:98
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1762
auto formatv(bool Validate, const char *Fmt, Ts &&...Vals)
GenericConvergenceVerifier< SSAContext > ConvergenceVerifier
constexpr bool isPowerOf2_32(uint32_t Value)
Return true if the argument is a power of two > 0.
Definition MathExtras.h:280
bool isModSet(const ModRefInfo MRI)
Definition ModRef.h:49
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1652
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:209
void verifyAMDGPUIntrinsicCall(VerifierSupport &VS, Intrinsic::ID ID, CallBase &Call)
bool isPointerTy(const Type *T)
Definition SPIRVUtils.h:373
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
generic_gep_type_iterator<> gep_type_iterator
LLVM_ABI EHPersonality classifyEHPersonality(const Value *Pers)
See if the given exception handling personality function is one that we understand.
iterator_range< SplittingIterator > split(StringRef Str, StringRef Separator)
Split the specified string over a separator and return a range-compatible iterable over its partition...
constexpr BooleanLoopTags OldBooleanLoopTags[]
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ABI bool isValueProfileMD(const MDNode *ProfileData)
Checks if an MDNode contains value profiling Metadata.
LLVM_ATTRIBUTE_VISIBILITY_DEFAULT AnalysisKey InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
LLVM_ABI unsigned getNumBranchWeights(const MDNode &ProfileData)
AtomicOrdering
Atomic ordering for LLVM's memory model.
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
Definition ModRef.h:74
LLVM_ABI FunctionPass * createVerifierPass(bool FatalErrors=true)
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Count
Definition InstrProf.h:145
DWARFExpression::Operation Op
std::optional< ThreadModel > parseThreadModel(StringRef S)
Parse the string spelling used by the "thread-model" IR module flag into a ThreadModel.
Definition CodeGen.h:198
ArrayRef(const T &OneElt) -> ArrayRef< T >
const IROptions & getIROptions(const LLVMContext &C)
Definition IROptions.h:27
constexpr unsigned BitWidth
TinyPtrVector< BasicBlock * > ColorVector
LLVM_ABI const char * LLVMLoopEstimatedTripCount
Profile-based loop metadata that should be accessed only by using llvm::getLoopEstimatedTripCount and...
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
LLVM_ABI std::optional< RoundingMode > convertStrToRoundingMode(StringRef)
Returns a valid RoundingMode enumerator when given a string that is valid as input in constrained int...
Definition FPEnv.cpp:25
gep_type_iterator gep_type_begin(const User *GEP)
LLVM_ABI std::unique_ptr< GCStrategy > getGCStrategy(const StringRef Name)
Lookup the GCStrategy object associated with the given gc name.
auto predecessors(const MachineBasicBlock *BB)
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition STLExtras.h:1963
void verifyNVVMIntrinsicCall(VerifierSupport &VS, Intrinsic::ID ID, CallBase &Call)
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Next
Definition InstrProf.h:147
bool pred_empty(const BasicBlock *BB)
Definition CFG.h:107
void verifyAMDGPUGlobalVariable(VerifierSupport &VS, const GlobalVariable &GV)
bool isHexDigit(char C)
Checks if character C is a hexadecimal numeric character.
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
void verifyAMDGPUModuleFlag(VerifierSupport &VS, const MDString *ID, Module::ModFlagBehavior MFB, const MDNode *Op)
bool isAMDGPUCallBrIntrinsic(Intrinsic::ID ID)
constexpr bool isCallableCC(CallingConv::ID CC)
LLVM_ABI bool verifyModule(const Module &M, raw_ostream *OS=nullptr, bool *BrokenDebugInfo=nullptr)
Check a module for errors.
AnalysisManager< Module > ModuleAnalysisManager
Convenience typedef for the Module analysis manager.
Definition MIRParser.h:39
#define N
constexpr uint64_t value() const
This is a hole in the type system and should not be abused.
Definition Alignment.h:82
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition Analysis.h:29
StringLiteral Disable
StringLiteral Enable
static LLVM_ABI const char * UnknownBranchWeightsMarker
static LLVM_ABI const char * ValueProfile
static LLVM_ABI const char * FunctionEntryCount
static LLVM_ABI const char * BranchWeights
uint32_t getTagID() const
Return the tag of this operand bundle as an integer.
ArrayRef< Use > Inputs