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 "VerifierInternal.h"
52#include "llvm/ADT/APFloat.h"
53#include "llvm/ADT/APInt.h"
54#include "llvm/ADT/ArrayRef.h"
55#include "llvm/ADT/DenseMap.h"
56#include "llvm/ADT/MapVector.h"
57#include "llvm/ADT/STLExtras.h"
61#include "llvm/ADT/StringRef.h"
62#include "llvm/ADT/Twine.h"
64#include "llvm/IR/Argument.h"
66#include "llvm/IR/Attributes.h"
67#include "llvm/IR/AutoUpgrade.h"
68#include "llvm/IR/BasicBlock.h"
70#include "llvm/IR/CFG.h"
71#include "llvm/IR/CallingConv.h"
72#include "llvm/IR/Comdat.h"
73#include "llvm/IR/Constant.h"
76#include "llvm/IR/Constants.h"
78#include "llvm/IR/DataLayout.h"
79#include "llvm/IR/DebugInfo.h"
81#include "llvm/IR/DebugLoc.h"
83#include "llvm/IR/Dominators.h"
85#include "llvm/IR/FPEnv.h"
86#include "llvm/IR/Function.h"
87#include "llvm/IR/GCStrategy.h"
89#include "llvm/IR/GlobalAlias.h"
90#include "llvm/IR/GlobalValue.h"
92#include "llvm/IR/InlineAsm.h"
93#include "llvm/IR/InstVisitor.h"
94#include "llvm/IR/InstrTypes.h"
95#include "llvm/IR/Instruction.h"
98#include "llvm/IR/Intrinsics.h"
99#include "llvm/IR/IntrinsicsAArch64.h"
100#include "llvm/IR/IntrinsicsARM.h"
101#include "llvm/IR/IntrinsicsNVPTX.h"
102#include "llvm/IR/IntrinsicsRISCV.h"
103#include "llvm/IR/IntrinsicsWebAssembly.h"
104#include "llvm/IR/LLVMContext.h"
106#include "llvm/IR/Metadata.h"
107#include "llvm/IR/Module.h"
109#include "llvm/IR/PassManager.h"
111#include "llvm/IR/Statepoint.h"
112#include "llvm/IR/Type.h"
113#include "llvm/IR/Use.h"
114#include "llvm/IR/User.h"
116#include "llvm/IR/Value.h"
118#include "llvm/Pass.h"
121#include "llvm/Support/Casting.h"
122#include "llvm/Support/CodeGen.h"
127#include "llvm/Support/ModRef.h"
133#include <algorithm>
134#include <cassert>
135#include <cstdint>
136#include <limits>
137#include <memory>
138#include <optional>
139#include <queue>
140#include <string>
141#include <utility>
142
143using namespace llvm;
144
146 "verify-noalias-scope-decl-dom", cl::Hidden, cl::init(false),
147 cl::desc("Ensure that llvm.experimental.noalias.scope.decl for identical "
148 "scopes are not dominating"));
149
150namespace {
151
152class Verifier : public InstVisitor<Verifier>, VerifierSupport {
153 friend class InstVisitor<Verifier>;
154 DominatorTree DT;
155
156 /// When verifying a basic block, keep track of all of the
157 /// instructions we have seen so far.
158 ///
159 /// This allows us to do efficient dominance checks for the case when an
160 /// instruction has an operand that is an instruction in the same block.
161 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
162
163 /// Keep track of the metadata nodes that have been checked already.
165
166 /// Keep track which DISubprogram is attached to which function.
168
169 /// For each visited DIScope, whether walking its scope chain reaches a
170 /// repeated node.
171 DenseMap<const Metadata *, bool> DIScopeChainReachesCycle;
172
173 /// Track all DICompileUnits visited.
175
176 /// The result type for a landingpad.
177 Type *LandingPadResultTy;
178
179 /// Whether we've seen a call to @llvm.localescape in this function
180 /// already.
181 bool SawFrameEscape;
182
183 /// Whether the current function has a DISubprogram attached to it.
184 bool HasDebugInfo = false;
185
186 /// Stores the count of how many objects were passed to llvm.localescape for a
187 /// given function and the largest index passed to llvm.localrecover.
189
190 // Maps catchswitches and cleanuppads that unwind to siblings to the
191 // terminators that indicate the unwind, used to detect cycles therein.
193
194 /// Cache which blocks are in which funclet, if an EH funclet personality is
195 /// in use. Otherwise empty.
196 DenseMap<BasicBlock *, ColorVector> BlockEHFuncletColors;
197
198 /// Cache of constants visited in search of ConstantExprs.
199 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
200
201 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
202 SmallVector<const Function *, 4> DeoptimizeDeclarations;
203
204 /// Cache of attribute lists verified.
205 SmallPtrSet<const void *, 32> AttributeListsVisited;
206
207 // Verify that this GlobalValue is only used in this module.
208 // This map is used to avoid visiting uses twice. We can arrive at a user
209 // twice, if they have multiple operands. In particular for very large
210 // constant expressions, we can arrive at a particular user many times.
211 SmallPtrSet<const Value *, 32> GlobalValueVisited;
212
213 // Keeps track of duplicate function argument debug info.
215
216 TBAAVerifier TBAAVerifyHelper;
217 ConvergenceVerifier ConvergenceVerifyHelper;
218
219 SmallVector<IntrinsicInst *, 4> NoAliasScopeDecls;
220
221 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
222
223public:
224 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
225 const Module &M)
226 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
227 SawFrameEscape(false), TBAAVerifyHelper(this) {
228 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
229 }
230
231 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
232
233 bool verify(const Function &F) {
234 llvm::TimeTraceScope timeScope("Verifier");
235 assert(F.getParent() == &M &&
236 "An instance of this class only works with a specific module!");
237
238 // First ensure the function is well-enough formed to compute dominance
239 // information, and directly compute a dominance tree. We don't rely on the
240 // pass manager to provide this as it isolates us from a potentially
241 // out-of-date dominator tree and makes it significantly more complex to run
242 // this code outside of a pass manager.
243
244 // First check that every basic block has a terminator, otherwise we can't
245 // even inspect the CFG.
246 for (const BasicBlock &BB : F) {
247 if (!BB.empty() && BB.back().isTerminator())
248 continue;
249
250 if (OS) {
251 *OS << "Basic Block in function '" << F.getName()
252 << "' does not have terminator!\n";
253 BB.printAsOperand(*OS, true, MST);
254 *OS << "\n";
255 }
256 return false;
257 }
258
259 // FIXME: It's really gross that we have to cast away constness here.
260 if (!F.empty())
261 DT.recalculate(const_cast<Function &>(F));
262
263 auto FailureCB = [this](const Twine &Message) {
264 this->CheckFailed(Message);
265 };
266 ConvergenceVerifyHelper.initialize(OS, FailureCB, F);
267
268 Broken = false;
269 // FIXME: We strip const here because the inst visitor strips const.
270 visit(const_cast<Function &>(F));
271 verifySiblingFuncletUnwinds();
272
273 if (ConvergenceVerifyHelper.sawTokens())
274 ConvergenceVerifyHelper.verify(DT);
275
276 InstsInThisBlock.clear();
277 DebugFnArgs.clear();
278 DIScopeChainReachesCycle.clear();
279 LandingPadResultTy = nullptr;
280 SawFrameEscape = false;
281 SiblingFuncletInfo.clear();
282 verifyNoAliasScopeDecl();
283 NoAliasScopeDecls.clear();
284
285 return !Broken;
286 }
287
288 /// Verify the module that this instance of \c Verifier was initialized with.
289 bool verify() {
290 Broken = false;
291
292 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
293 for (const Function &F : M)
294 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
295 DeoptimizeDeclarations.push_back(&F);
296
297 // Now that we've visited every function, verify that we never asked to
298 // recover a frame index that wasn't escaped.
299 verifyFrameRecoverIndices();
300 for (const GlobalVariable &GV : M.globals())
301 visitGlobalVariable(GV);
302
303 for (const GlobalAlias &GA : M.aliases())
304 visitGlobalAlias(GA);
305
306 for (const GlobalIFunc &GI : M.ifuncs())
307 visitGlobalIFunc(GI);
308
309 for (const NamedMDNode &NMD : M.named_metadata())
310 visitNamedMDNode(NMD);
311
312 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
313 visitComdat(SMEC.getValue());
314
315 visitModuleFlags();
316 visitModuleIdents();
317 visitModuleCommandLines();
318 visitModuleErrnoTBAA();
319
320 verifyCompileUnits();
321
322 verifyDeoptimizeCallingConvs();
323 DISubprogramAttachments.clear();
324 DIScopeChainReachesCycle.clear();
325 return !Broken;
326 }
327
328private:
329 /// Whether a metadata node is allowed to be, or contain, a DILocation.
330 enum class AreDebugLocsAllowed { No, Yes };
331
332 /// Metadata that should be treated as a range, with slightly different
333 /// requirements.
334 enum class RangeLikeMetadataKind {
335 Range, // MD_range
336 AbsoluteSymbol, // MD_absolute_symbol
337 NoaliasAddrspace // MD_noalias_addrspace
338 };
339
340 // Verification methods...
341 void visitGlobalValue(const GlobalValue &GV);
342 void visitGlobalVariable(const GlobalVariable &GV);
343 void visitGlobalAlias(const GlobalAlias &GA);
344 void visitGlobalIFunc(const GlobalIFunc &GI);
345 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
346 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
347 const GlobalAlias &A, const Constant &C);
348 void visitNamedMDNode(const NamedMDNode &NMD);
349 void visitMDNode(const MDNode &MD, AreDebugLocsAllowed AllowLocs);
350 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
351 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
352 void visitDIArgList(const DIArgList &AL, Function *F);
353 void visitComdat(const Comdat &C);
354 void visitModuleIdents();
355 void visitModuleCommandLines();
356 void visitModuleErrnoTBAA();
357 void visitModuleFlags();
358 void visitModuleFlag(const MDNode *Op,
359 DenseMap<const MDString *, const MDNode *> &SeenIDs,
360 SmallVectorImpl<const MDNode *> &Requirements);
361 void visitModuleFlagCGProfileEntry(const MDOperand &MDO);
362 void visitFunction(const Function &F);
363 void visitBasicBlock(BasicBlock &BB);
364 void verifyRangeLikeMetadata(const Value &V, const MDNode *Range, Type *Ty,
365 RangeLikeMetadataKind Kind);
366 void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty);
367 void visitNoFPClassMetadata(Instruction &I, MDNode *Range, Type *Ty);
368 void visitNoaliasAddrspaceMetadata(Instruction &I, MDNode *Range, Type *Ty);
369 void visitDereferenceableMetadata(Instruction &I, MDNode *MD);
370 void visitNoFreeObjMetadata(Instruction &I, MDNode *MD);
371 void visitProfMetadata(Instruction &I, MDNode *MD);
372 void visitCallStackMetadata(MDNode *MD);
373 void visitMemProfMetadata(Instruction &I, MDNode *MD);
374 void visitCallsiteMetadata(Instruction &I, MDNode *MD);
375 void visitCalleeTypeMetadata(Instruction &I, MDNode *MD);
376 void visitDIAssignIDMetadata(Instruction &I, MDNode *MD);
377 void visitMMRAMetadata(Instruction &I, MDNode *MD);
378 void visitAnnotationMetadata(MDNode *Annotation);
379 void visitAliasScopeMetadata(const MDNode *MD);
380 void visitAliasScopeListMetadata(const MDNode *MD);
381 void visitAccessGroupMetadata(const MDNode *MD);
382 void visitCapturesMetadata(Instruction &I, const MDNode *Captures);
383 void visitAllocTokenMetadata(Instruction &I, MDNode *MD);
384 void visitInlineHistoryMetadata(Instruction &I, MDNode *MD);
385 void visitMemCacheHintMetadata(Instruction &I, MDNode *MD);
386
387#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
388#include "llvm/IR/Metadata.def"
389 void visitDIType(const DIType &N);
390 void visitDIScope(const DIScope &N);
391 void visitDIScopeChain(const DIScope &N);
392 bool hasDIScopeCycle(const Metadata *S);
393 DISubprogram *getSubprogram(Metadata *LocalScope);
394 void visitDIVariable(const DIVariable &N);
395 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
396 void visitDITemplateParameter(const DITemplateParameter &N);
397
398 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
399
400 void visit(DbgLabelRecord &DLR);
401 void visit(DbgVariableRecord &DVR);
402 // InstVisitor overrides...
403 using InstVisitor<Verifier>::visit;
404 void visitDbgRecords(Instruction &I);
405 void visit(Instruction &I);
406
407 void visitTruncInst(TruncInst &I);
408 void visitZExtInst(ZExtInst &I);
409 void visitSExtInst(SExtInst &I);
410 void visitFPTruncInst(FPTruncInst &I);
411 void visitFPExtInst(FPExtInst &I);
412 void visitFPToUIInst(FPToUIInst &I);
413 void visitFPToSIInst(FPToSIInst &I);
414 void visitUIToFPInst(UIToFPInst &I);
415 void visitSIToFPInst(SIToFPInst &I);
416 void visitIntToPtrInst(IntToPtrInst &I);
417 void checkPtrToAddr(Type *SrcTy, Type *DestTy, const Value &V);
418 void visitPtrToAddrInst(PtrToAddrInst &I);
419 void visitPtrToIntInst(PtrToIntInst &I);
420 void visitBitCastInst(BitCastInst &I);
421 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
422 void visitPHINode(PHINode &PN);
423 void visitCallBase(CallBase &Call);
424 void visitUnaryOperator(UnaryOperator &U);
425 void visitBinaryOperator(BinaryOperator &B);
426 void visitICmpInst(ICmpInst &IC);
427 void visitFCmpInst(FCmpInst &FC);
428 void visitExtractElementInst(ExtractElementInst &EI);
429 void visitInsertElementInst(InsertElementInst &EI);
430 void visitShuffleVectorInst(ShuffleVectorInst &EI);
431 void visitBitInsertInst(BitInsertInst &BII);
432 void visitBitExtractInst(BitExtractInst &BEI);
433 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
434 void visitCallInst(CallInst &CI);
435 void visitInvokeInst(InvokeInst &II);
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::visitModuleFlags() {
1975 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1976 if (!Flags) return;
1977
1978 // Scan each flag, and track the flags and requirements.
1979 DenseMap<const MDString*, const MDNode*> SeenIDs;
1980 SmallVector<const MDNode*, 16> Requirements;
1981
1982 // Either both aarch64-elf-pauthabi-* flags should be set or none at all.
1983 std::optional<uint64_t> PAuthABIPlatform;
1984 std::optional<uint64_t> PAuthABIVersion;
1985 // Signing of init/fini pointers: address diversity implies basic signing.
1986 uint64_t HasPtrauthInitFini = 0;
1987 uint64_t HasPtrauthInitFiniAddr = 0;
1988
1989 for (const MDNode *MDN : Flags->operands()) {
1990 visitModuleFlag(MDN, SeenIDs, Requirements);
1991 if (MDN->getNumOperands() != 3)
1992 continue;
1993
1994 if (const auto *FlagName = dyn_cast_or_null<MDString>(MDN->getOperand(1))) {
1995 auto GetFlagNamed = [&](StringRef Name) -> std::optional<uint64_t> {
1996 if (FlagName->getString() != Name)
1997 return std::nullopt;
1998 if (const auto *FlagValue =
2000 return FlagValue->getZExtValue();
2001
2002 CheckFailed(Name + ": module flag expects integer value");
2003 return std::nullopt;
2004 };
2005
2006 if (auto Value = GetFlagNamed("aarch64-elf-pauthabi-platform"))
2007 PAuthABIPlatform = *Value;
2008 else if (auto Value = GetFlagNamed("aarch64-elf-pauthabi-version"))
2009 PAuthABIVersion = *Value;
2010 else if (auto Value = GetFlagNamed("ptrauth-init-fini"))
2011 HasPtrauthInitFini = *Value;
2012 else if (auto Value =
2013 GetFlagNamed("ptrauth-init-fini-address-discrimination"))
2014 HasPtrauthInitFiniAddr = *Value;
2015 }
2016 }
2017
2018 Check(llvm::is_contained({0u, 1u}, HasPtrauthInitFini),
2019 "ptrauth-init-fini must be 0 or 1");
2020 Check(llvm::is_contained({0u, 1u}, HasPtrauthInitFiniAddr),
2021 "ptrauth-init-fini-address-discrimination must be 0 or 1, if set");
2022 if (HasPtrauthInitFiniAddr)
2023 Check(HasPtrauthInitFini, "ptrauth-init-fini-address-discrimination module "
2024 "flag requires ptrauth-init-fini");
2025
2026 if (PAuthABIPlatform.has_value() != PAuthABIVersion.has_value())
2027 CheckFailed("either both or no 'aarch64-elf-pauthabi-platform' and "
2028 "'aarch64-elf-pauthabi-version' module flags must be present");
2029
2030 // Validate that the requirements in the module are valid.
2031 for (const MDNode *Requirement : Requirements) {
2032 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
2033 const Metadata *ReqValue = Requirement->getOperand(1);
2034
2035 const MDNode *Op = SeenIDs.lookup(Flag);
2036 if (!Op) {
2037 CheckFailed("invalid requirement on flag, flag is not present in module",
2038 Flag);
2039 continue;
2040 }
2041
2042 if (Op->getOperand(2) != ReqValue) {
2043 CheckFailed(("invalid requirement on flag, "
2044 "flag does not have the required value"),
2045 Flag);
2046 continue;
2047 }
2048 }
2049}
2050
2051void
2052Verifier::visitModuleFlag(const MDNode *Op,
2053 DenseMap<const MDString *, const MDNode *> &SeenIDs,
2054 SmallVectorImpl<const MDNode *> &Requirements) {
2055 // Each module flag should have three arguments, the merge behavior (a
2056 // constant int), the flag ID (an MDString), and the value.
2057 Check(Op->getNumOperands() == 3,
2058 "incorrect number of operands in module flag", Op);
2059 Module::ModFlagBehavior MFB;
2060 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
2062 "invalid behavior operand in module flag (expected constant integer)",
2063 Op->getOperand(0));
2064 Check(false,
2065 "invalid behavior operand in module flag (unexpected constant)",
2066 Op->getOperand(0));
2067 }
2068 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
2069 Check(ID, "invalid ID operand in module flag (expected metadata string)",
2070 Op->getOperand(1));
2071
2072 // Check the values for behaviors with additional requirements.
2073 switch (MFB) {
2074 case Module::Error:
2075 case Module::Warning:
2076 case Module::Override:
2077 // These behavior types accept any value.
2078 break;
2079
2080 case Module::Min: {
2081 auto *V = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
2082 Check(V && V->getValue().isNonNegative(),
2083 "invalid value for 'min' module flag (expected constant non-negative "
2084 "integer)",
2085 Op->getOperand(2));
2086 break;
2087 }
2088
2089 case Module::Max: {
2091 "invalid value for 'max' module flag (expected constant integer)",
2092 Op->getOperand(2));
2093 break;
2094 }
2095
2096 case Module::Require: {
2097 // The value should itself be an MDNode with two operands, a flag ID (an
2098 // MDString), and a value.
2099 auto *Value = dyn_cast<MDNode>(Op->getOperand(2));
2100 Check(Value && Value->getNumOperands() == 2,
2101 "invalid value for 'require' module flag (expected metadata pair)",
2102 Op->getOperand(2));
2103 Check(isa<MDString>(Value->getOperand(0)),
2104 ("invalid value for 'require' module flag "
2105 "(first value operand should be a string)"),
2106 Value->getOperand(0));
2107
2108 // Append it to the list of requirements, to check once all module flags are
2109 // scanned.
2110 Requirements.push_back(Value);
2111 break;
2112 }
2113
2114 case Module::Append:
2115 case Module::AppendUnique: {
2116 // These behavior types require the operand be an MDNode.
2117 Check(isa<MDNode>(Op->getOperand(2)),
2118 "invalid value for 'append'-type module flag "
2119 "(expected a metadata node)",
2120 Op->getOperand(2));
2121 break;
2122 }
2123 }
2124
2125 // Unless this is a "requires" flag, check the ID is unique.
2126 if (MFB != Module::Require) {
2127 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
2128 Check(Inserted,
2129 "module flag identifiers must be unique (or of 'require' type)", ID);
2130 }
2131
2132 StringRef Name = ID->getString();
2133 if (Name == "wchar_size") {
2134 ConstantInt *Value
2136 Check(Value, "wchar_size metadata requires constant integer argument");
2137 return;
2138 }
2139
2140 if (Name == "long-double-type") {
2141 Check(MFB == Module::Error,
2142 "long-double-type module flag must use 'error' merge behavior", Op);
2143 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2144 Check(Value, "long-double-type metadata requires a string argument");
2145 if (Value)
2146 Check(parseLongDoubleFormat(Value->getString()).has_value(),
2147 "invalid long-double-type metadata value", Op);
2148 return;
2149 }
2150
2151 if (Name == "float-abi") {
2152 Check(MFB == Module::Error,
2153 "float-abi module flag must use 'error' merge behavior", Op);
2154 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2155 Check(Value, "float-abi metadata requires a string argument");
2156 if (Value)
2157 Check(FloatABI::parseABIType(Value->getString()).has_value(),
2158 "invalid float-abi metadata value", Op);
2159 return;
2160 }
2161
2162 if (Name == "thread-model") {
2163 Check(MFB == Module::Error,
2164 "thread-model module flag must use 'error' merge behavior", Op);
2165 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2166 Check(Value, "thread-model metadata requires a string argument");
2167 if (Value)
2168 Check(parseThreadModel(Value->getString()).has_value(),
2169 "invalid thread-model metadata value", Op);
2170 return;
2171 }
2172
2173 if (Name == "target-abi") {
2174 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2175 Check(Value && !Value->getString().empty(),
2176 "target-abi metadata requires a non-empty string argument", Op);
2177 return;
2178 }
2179
2180 if (ID->getString() == "exception-model") {
2181 Check(MFB == Module::Error,
2182 "exception-model module flag must use 'error' merge behavior", Op);
2183 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2184 Check(Value, "exception-model metadata requires a string argument");
2185 if (Value)
2186 Check(parseExceptionModel(Value->getString()).has_value(),
2187 "invalid exception-model metadata value", Op);
2188 return;
2189 }
2190
2191 if (Name == "Linker Options") {
2192 // If the llvm.linker.options named metadata exists, we assume that the
2193 // bitcode reader has upgraded the module flag. Otherwise the flag might
2194 // have been created by a client directly.
2195 Check(M.getNamedMetadata("llvm.linker.options"),
2196 "'Linker Options' named metadata no longer supported");
2197 return;
2198 }
2199
2200 if (Name == "SemanticInterposition") {
2201 ConstantInt *Value =
2203 Check(Value,
2204 "SemanticInterposition metadata requires constant integer argument");
2205 return;
2206 }
2207
2208 if (Name == "CG Profile") {
2209 for (const MDOperand &MDO : cast<MDNode>(Op->getOperand(2))->operands())
2210 visitModuleFlagCGProfileEntry(MDO);
2211 return;
2212 }
2213
2214 // Target-specific module flag checks.
2215 verifyAMDGPUModuleFlag(*this, ID, MFB, Op);
2216}
2217
2218void Verifier::visitModuleFlagCGProfileEntry(const MDOperand &MDO) {
2219 auto CheckFunction = [&](const MDOperand &FuncMDO) {
2220 if (!FuncMDO)
2221 return;
2222 auto F = dyn_cast<ValueAsMetadata>(FuncMDO);
2223 Check(F && isa<Function>(F->getValue()->stripPointerCasts()),
2224 "expected a Function or null", FuncMDO);
2225 };
2226 auto Node = dyn_cast_or_null<MDNode>(MDO);
2227 Check(Node && Node->getNumOperands() == 3, "expected a MDNode triple", MDO);
2228 CheckFunction(Node->getOperand(0));
2229 CheckFunction(Node->getOperand(1));
2230 auto Count = dyn_cast_or_null<ConstantAsMetadata>(Node->getOperand(2));
2231 Check(Count && Count->getType()->isIntegerTy(),
2232 "expected an integer constant", Node->getOperand(2));
2233}
2234
2235void Verifier::verifyAttributeTypes(AttributeSet Attrs, const Value *V) {
2236 for (Attribute A : Attrs) {
2237
2238 if (A.isStringAttribute()) {
2239#define GET_ATTR_NAMES
2240#define ATTRIBUTE_ENUM(ENUM_NAME, DISPLAY_NAME)
2241#define ATTRIBUTE_STRBOOL(ENUM_NAME, DISPLAY_NAME) \
2242 if (A.getKindAsString() == #DISPLAY_NAME) { \
2243 auto V = A.getValueAsString(); \
2244 if (!(V.empty() || V == "true" || V == "false")) \
2245 CheckFailed("invalid value for '" #DISPLAY_NAME "' attribute: " + V + \
2246 ""); \
2247 }
2248
2249#include "llvm/IR/Attributes.inc"
2250 continue;
2251 }
2252
2253 if (A.isIntAttribute() != Attribute::isIntAttrKind(A.getKindAsEnum())) {
2254 CheckFailed("Attribute '" + A.getAsString() + "' should have an Argument",
2255 V);
2256 return;
2257 }
2258 }
2259}
2260
2261// VerifyParameterAttrs - Check the given attributes for an argument or return
2262// value of the specified type. The value V is printed in error messages.
2263void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty,
2264 const Value *V) {
2265 if (!Attrs.hasAttributes())
2266 return;
2267
2268 verifyAttributeTypes(Attrs, V);
2269
2270 for (Attribute Attr : Attrs)
2271 Check(Attr.isStringAttribute() ||
2272 Attribute::canUseAsParamAttr(Attr.getKindAsEnum()),
2273 "Attribute '" + Attr.getAsString() + "' does not apply to parameters",
2274 V);
2275
2276 if (Attrs.hasAttribute(Attribute::ImmArg)) {
2277 unsigned AttrCount =
2278 Attrs.getNumAttributes() - Attrs.hasAttribute(Attribute::Range);
2279 Check(AttrCount == 1,
2280 "Attribute 'immarg' is incompatible with other attributes except the "
2281 "'range' attribute",
2282 V);
2283 }
2284
2285 // Check for mutually incompatible attributes. Only inreg is compatible with
2286 // sret.
2287 unsigned AttrCount = 0;
2288 AttrCount += Attrs.hasAttribute(Attribute::ByVal);
2289 AttrCount += Attrs.hasAttribute(Attribute::InAlloca);
2290 AttrCount += Attrs.hasAttribute(Attribute::Preallocated);
2291 AttrCount += Attrs.hasAttribute(Attribute::StructRet) ||
2292 Attrs.hasAttribute(Attribute::InReg);
2293 AttrCount += Attrs.hasAttribute(Attribute::Nest);
2294 AttrCount += Attrs.hasAttribute(Attribute::ByRef);
2295 Check(AttrCount <= 1,
2296 "Attributes 'byval', 'inalloca', 'preallocated', 'inreg', 'nest', "
2297 "'byref', and 'sret' are incompatible!",
2298 V);
2299
2300 Check(!(Attrs.hasAttribute(Attribute::InAlloca) &&
2301 Attrs.hasAttribute(Attribute::ReadOnly)),
2302 "Attributes "
2303 "'inalloca and readonly' are incompatible!",
2304 V);
2305
2306 Check(!(Attrs.hasAttribute(Attribute::StructRet) &&
2307 Attrs.hasAttribute(Attribute::Returned)),
2308 "Attributes "
2309 "'sret and returned' are incompatible!",
2310 V);
2311
2312 Check(!(Attrs.hasAttribute(Attribute::ZExt) &&
2313 Attrs.hasAttribute(Attribute::SExt)),
2314 "Attributes "
2315 "'zeroext and signext' are incompatible!",
2316 V);
2317
2318 Check(!(Attrs.hasAttribute(Attribute::ReadNone) &&
2319 Attrs.hasAttribute(Attribute::ReadOnly)),
2320 "Attributes "
2321 "'readnone and readonly' are incompatible!",
2322 V);
2323
2324 Check(!(Attrs.hasAttribute(Attribute::ReadNone) &&
2325 Attrs.hasAttribute(Attribute::WriteOnly)),
2326 "Attributes "
2327 "'readnone and writeonly' are incompatible!",
2328 V);
2329
2330 Check(!(Attrs.hasAttribute(Attribute::ReadOnly) &&
2331 Attrs.hasAttribute(Attribute::WriteOnly)),
2332 "Attributes "
2333 "'readonly and writeonly' are incompatible!",
2334 V);
2335
2336 Check(!(Attrs.hasAttribute(Attribute::NoInline) &&
2337 Attrs.hasAttribute(Attribute::AlwaysInline)),
2338 "Attributes "
2339 "'noinline and alwaysinline' are incompatible!",
2340 V);
2341
2342 Check(!(Attrs.hasAttribute(Attribute::Writable) &&
2343 Attrs.hasAttribute(Attribute::ReadNone)),
2344 "Attributes writable and readnone are incompatible!", V);
2345
2346 Check(!(Attrs.hasAttribute(Attribute::Writable) &&
2347 Attrs.hasAttribute(Attribute::ReadOnly)),
2348 "Attributes writable and readonly are incompatible!", V);
2349
2350 AttributeMask IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty, Attrs);
2351 for (Attribute Attr : Attrs) {
2352 if (!Attr.isStringAttribute() &&
2353 IncompatibleAttrs.contains(Attr.getKindAsEnum())) {
2354 CheckFailed("Attribute '" + Attr.getAsString() +
2355 "' applied to incompatible type!", V);
2356 return;
2357 }
2358 }
2359
2360 if (isa<PointerType>(Ty)) {
2361 if (Attrs.hasAttribute(Attribute::Alignment)) {
2362 Align AttrAlign = Attrs.getAlignment().valueOrOne();
2363 Check(AttrAlign.value() <= Value::MaximumAlignment,
2364 "huge alignment values are unsupported", V);
2365 }
2366 if (Attrs.hasAttribute(Attribute::ByVal)) {
2367 Type *ByValTy = Attrs.getByValType();
2368 Check(ByValTy->isSized(),
2369 "Attribute 'byval' does not support unsized types!", V);
2370 // Check if it is or contains a target extension type that disallows being
2371 // used on the stack.
2373 "'byval' argument has illegal target extension type", V);
2374 // The copy is placed in the caller's frame, which needs its size at
2375 // compile time.
2376 Check(!ByValTy->isScalableTy(),
2377 "scalable 'byval' arguments are unsupported", V);
2378 Check(DL.getTypeAllocSize(ByValTy).getKnownMinValue() < (1ULL << 32),
2379 "huge 'byval' arguments are unsupported", V);
2380 }
2381 if (Attrs.hasAttribute(Attribute::ByRef)) {
2382 Check(Attrs.getByRefType()->isSized(),
2383 "Attribute 'byref' does not support unsized types!", V);
2384 Check(DL.getTypeAllocSize(Attrs.getByRefType()).getKnownMinValue() <
2385 (1ULL << 32),
2386 "huge 'byref' arguments are unsupported", V);
2387 }
2388 if (Attrs.hasAttribute(Attribute::InAlloca)) {
2389 Check(Attrs.getInAllocaType()->isSized(),
2390 "Attribute 'inalloca' does not support unsized types!", V);
2391 Check(DL.getTypeAllocSize(Attrs.getInAllocaType()).getKnownMinValue() <
2392 (1ULL << 32),
2393 "huge 'inalloca' arguments are unsupported", V);
2394 }
2395 if (Attrs.hasAttribute(Attribute::Preallocated)) {
2396 Check(Attrs.getPreallocatedType()->isSized(),
2397 "Attribute 'preallocated' does not support unsized types!", V);
2398 Check(
2399 DL.getTypeAllocSize(Attrs.getPreallocatedType()).getKnownMinValue() <
2400 (1ULL << 32),
2401 "huge 'preallocated' arguments are unsupported", V);
2402 }
2403 }
2404
2405 if (Attrs.hasAttribute(Attribute::Initializes)) {
2406 auto Inits = Attrs.getAttribute(Attribute::Initializes).getInitializes();
2407 Check(!Inits.empty(), "Attribute 'initializes' does not support empty list",
2408 V);
2410 "Attribute 'initializes' does not support unordered ranges", V);
2411 }
2412
2413 if (Attrs.hasAttribute(Attribute::NoFPClass)) {
2414 uint64_t Val = Attrs.getAttribute(Attribute::NoFPClass).getValueAsInt();
2415 Check(Val != 0, "Attribute 'nofpclass' must have at least one test bit set",
2416 V);
2417 Check((Val & ~static_cast<unsigned>(fcAllFlags)) == 0,
2418 "Invalid value for 'nofpclass' test mask", V);
2419 }
2420 if (Attrs.hasAttribute(Attribute::Range)) {
2421 const ConstantRange &CR =
2422 Attrs.getAttribute(Attribute::Range).getValueAsConstantRange();
2424 "Range bit width must match type bit width!", V);
2425 }
2426}
2427
2428void Verifier::checkUnsignedBaseTenFuncAttr(AttributeList Attrs, StringRef Attr,
2429 const Value *V) {
2430 if (Attrs.hasFnAttr(Attr)) {
2431 StringRef S = Attrs.getFnAttr(Attr).getValueAsString();
2432 unsigned N;
2433 if (S.getAsInteger(10, N))
2434 CheckFailed("\"" + Attr + "\" takes an unsigned integer: " + S, V);
2435 }
2436}
2437
2438// Check parameter attributes against a function type.
2439// The value V is printed in error messages.
2440void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
2441 const Value *V, bool IsIntrinsic,
2442 bool IsInlineAsm) {
2443 if (Attrs.isEmpty())
2444 return;
2445
2446 if (AttributeListsVisited.insert(Attrs.getRawPointer()).second) {
2447 Check(Attrs.hasParentContext(Context),
2448 "Attribute list does not match Module context!", &Attrs, V);
2449 for (const auto &AttrSet : Attrs) {
2450 Check(!AttrSet.hasAttributes() || AttrSet.hasParentContext(Context),
2451 "Attribute set does not match Module context!", &AttrSet, V);
2452 for (const auto &A : AttrSet) {
2453 Check(A.hasParentContext(Context),
2454 "Attribute does not match Module context!", &A, V);
2455 }
2456 }
2457 }
2458
2459 bool SawNest = false;
2460 bool SawReturned = false;
2461 bool SawSRet = false;
2462 bool SawSwiftSelf = false;
2463 bool SawSwiftAsync = false;
2464 bool SawSwiftError = false;
2465
2466 // Verify return value attributes.
2467 AttributeSet RetAttrs = Attrs.getRetAttrs();
2468 for (Attribute RetAttr : RetAttrs)
2469 Check(RetAttr.isStringAttribute() ||
2470 Attribute::canUseAsRetAttr(RetAttr.getKindAsEnum()),
2471 "Attribute '" + RetAttr.getAsString() +
2472 "' does not apply to function return values",
2473 V);
2474
2475 unsigned MaxParameterWidth = 0;
2476 auto GetMaxParameterWidth = [&MaxParameterWidth](Type *Ty) {
2477 if (Ty->isVectorTy()) {
2478 if (auto *VT = dyn_cast<FixedVectorType>(Ty)) {
2479 unsigned Size = VT->getPrimitiveSizeInBits().getFixedValue();
2480 if (Size > MaxParameterWidth)
2481 MaxParameterWidth = Size;
2482 }
2483 }
2484 };
2485 GetMaxParameterWidth(FT->getReturnType());
2486 verifyParameterAttrs(RetAttrs, FT->getReturnType(), V);
2487
2488 // Verify parameter attributes.
2489 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2490 Type *Ty = FT->getParamType(i);
2491 AttributeSet ArgAttrs = Attrs.getParamAttrs(i);
2492
2493 if (!IsIntrinsic) {
2494 Check(!ArgAttrs.hasAttribute(Attribute::ImmArg),
2495 "immarg attribute only applies to intrinsics", V);
2496 if (!IsInlineAsm)
2497 Check(!ArgAttrs.hasAttribute(Attribute::ElementType),
2498 "Attribute 'elementtype' can only be applied to intrinsics"
2499 " and inline asm.",
2500 V);
2501 }
2502
2503 verifyParameterAttrs(ArgAttrs, Ty, V);
2504 GetMaxParameterWidth(Ty);
2505
2506 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
2507 Check(!SawNest, "More than one parameter has attribute nest!", V);
2508 SawNest = true;
2509 }
2510
2511 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
2512 Check(!SawReturned, "More than one parameter has attribute returned!", V);
2513 Check(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
2514 "Incompatible argument and return types for 'returned' attribute",
2515 V);
2516 SawReturned = true;
2517 }
2518
2519 if (ArgAttrs.hasAttribute(Attribute::StructRet)) {
2520 Check(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
2521 Check(i == 0 || i == 1,
2522 "Attribute 'sret' is not on first or second parameter!", V);
2523 SawSRet = true;
2524 }
2525
2526 if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) {
2527 Check(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
2528 SawSwiftSelf = true;
2529 }
2530
2531 if (ArgAttrs.hasAttribute(Attribute::SwiftAsync)) {
2532 Check(!SawSwiftAsync, "Cannot have multiple 'swiftasync' parameters!", V);
2533 SawSwiftAsync = true;
2534 }
2535
2536 if (ArgAttrs.hasAttribute(Attribute::SwiftError)) {
2537 Check(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!", V);
2538 SawSwiftError = true;
2539 }
2540
2541 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) {
2542 Check(i == FT->getNumParams() - 1,
2543 "inalloca isn't on the last parameter!", V);
2544 }
2545 }
2546
2547 if (!Attrs.hasFnAttrs())
2548 return;
2549
2550 verifyAttributeTypes(Attrs.getFnAttrs(), V);
2551 for (Attribute FnAttr : Attrs.getFnAttrs())
2552 Check(FnAttr.isStringAttribute() ||
2553 Attribute::canUseAsFnAttr(FnAttr.getKindAsEnum()),
2554 "Attribute '" + FnAttr.getAsString() +
2555 "' does not apply to functions!",
2556 V);
2557
2558 Check(!(Attrs.hasFnAttr(Attribute::NoInline) &&
2559 Attrs.hasFnAttr(Attribute::AlwaysInline)),
2560 "Attributes 'noinline and alwaysinline' are incompatible!", V);
2561
2562 if (Attrs.hasFnAttr(Attribute::OptimizeNone)) {
2563 Check(Attrs.hasFnAttr(Attribute::NoInline),
2564 "Attribute 'optnone' requires 'noinline'!", V);
2565
2566 Check(!Attrs.hasFnAttr(Attribute::OptimizeForSize),
2567 "Attributes 'optsize and optnone' are incompatible!", V);
2568
2569 Check(!Attrs.hasFnAttr(Attribute::MinSize),
2570 "Attributes 'minsize and optnone' are incompatible!", V);
2571
2572 Check(!Attrs.hasFnAttr(Attribute::OptimizeForDebugging),
2573 "Attributes 'optdebug and optnone' are incompatible!", V);
2574 }
2575
2576 Check(!(Attrs.hasFnAttr(Attribute::SanitizeRealtime) &&
2577 Attrs.hasFnAttr(Attribute::SanitizeRealtimeBlocking)),
2578 "Attributes "
2579 "'sanitize_realtime and sanitize_realtime_blocking' are incompatible!",
2580 V);
2581
2582 if (Attrs.hasFnAttr(Attribute::OptimizeForDebugging)) {
2583 Check(!Attrs.hasFnAttr(Attribute::OptimizeForSize),
2584 "Attributes 'optsize and optdebug' are incompatible!", V);
2585
2586 Check(!Attrs.hasFnAttr(Attribute::MinSize),
2587 "Attributes 'minsize and optdebug' are incompatible!", V);
2588 }
2589
2590 Check(!Attrs.hasAttrSomewhere(Attribute::Writable) ||
2591 isModSet(Attrs.getMemoryEffects().getModRef(IRMemLocation::ArgMem)),
2592 "Attribute writable and memory without argmem: write are incompatible!",
2593 V);
2594
2595 if (Attrs.hasFnAttr("aarch64_pstate_sm_enabled")) {
2596 Check(!Attrs.hasFnAttr("aarch64_pstate_sm_compatible"),
2597 "Attributes 'aarch64_pstate_sm_enabled and "
2598 "aarch64_pstate_sm_compatible' are incompatible!",
2599 V);
2600 }
2601
2602 Check((Attrs.hasFnAttr("aarch64_new_za") + Attrs.hasFnAttr("aarch64_in_za") +
2603 Attrs.hasFnAttr("aarch64_inout_za") +
2604 Attrs.hasFnAttr("aarch64_out_za") +
2605 Attrs.hasFnAttr("aarch64_preserves_za") +
2606 Attrs.hasFnAttr("aarch64_za_state_agnostic")) <= 1,
2607 "Attributes 'aarch64_new_za', 'aarch64_in_za', 'aarch64_out_za', "
2608 "'aarch64_inout_za', 'aarch64_preserves_za' and "
2609 "'aarch64_za_state_agnostic' are mutually exclusive",
2610 V);
2611
2612 Check((Attrs.hasFnAttr("aarch64_new_zt0") +
2613 Attrs.hasFnAttr("aarch64_in_zt0") +
2614 Attrs.hasFnAttr("aarch64_inout_zt0") +
2615 Attrs.hasFnAttr("aarch64_out_zt0") +
2616 Attrs.hasFnAttr("aarch64_preserves_zt0") +
2617 Attrs.hasFnAttr("aarch64_za_state_agnostic")) <= 1,
2618 "Attributes 'aarch64_new_zt0', 'aarch64_in_zt0', 'aarch64_out_zt0', "
2619 "'aarch64_inout_zt0', 'aarch64_preserves_zt0' and "
2620 "'aarch64_za_state_agnostic' are mutually exclusive",
2621 V);
2622
2623 if (Attrs.hasFnAttr(Attribute::JumpTable)) {
2624 const GlobalValue *GV = cast<GlobalValue>(V);
2626 "Attribute 'jumptable' requires 'unnamed_addr'", V);
2627 }
2628
2629 if (auto Args = Attrs.getFnAttrs().getAllocSizeArgs()) {
2630 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
2631 if (ParamNo >= FT->getNumParams()) {
2632 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
2633 return false;
2634 }
2635
2636 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
2637 CheckFailed("'allocsize' " + Name +
2638 " argument must refer to an integer parameter",
2639 V);
2640 return false;
2641 }
2642
2643 return true;
2644 };
2645
2646 if (!CheckParam("element size", Args->first))
2647 return;
2648
2649 if (Args->second && !CheckParam("number of elements", *Args->second))
2650 return;
2651 }
2652
2653 if (Attrs.hasFnAttr(Attribute::AllocKind)) {
2654 AllocFnKind K = Attrs.getAllocKind();
2656 K & (AllocFnKind::Alloc | AllocFnKind::Realloc | AllocFnKind::Free);
2657 if (!is_contained(
2658 {AllocFnKind::Alloc, AllocFnKind::Realloc, AllocFnKind::Free},
2659 Type))
2660 CheckFailed(
2661 "'allockind()' requires exactly one of alloc, realloc, and free");
2662 if ((Type == AllocFnKind::Free) &&
2663 ((K & (AllocFnKind::Uninitialized | AllocFnKind::Zeroed |
2664 AllocFnKind::Aligned)) != AllocFnKind::Unknown))
2665 CheckFailed("'allockind(\"free\")' doesn't allow uninitialized, zeroed, "
2666 "or aligned modifiers.");
2667 AllocFnKind ZeroedUninit = AllocFnKind::Uninitialized | AllocFnKind::Zeroed;
2668 if ((K & ZeroedUninit) == ZeroedUninit)
2669 CheckFailed("'allockind()' can't be both zeroed and uninitialized");
2670 }
2671
2672 if (Attribute A = Attrs.getFnAttr("alloc-variant-zeroed"); A.isValid()) {
2673 StringRef S = A.getValueAsString();
2674 Check(!S.empty(), "'alloc-variant-zeroed' must not be empty");
2675 Function *Variant = M.getFunction(S);
2676 if (Variant) {
2677 Attribute Family = Attrs.getFnAttr("alloc-family");
2678 Attribute VariantFamily = Variant->getFnAttribute("alloc-family");
2679 if (Family.isValid())
2680 Check(VariantFamily.isValid() &&
2681 VariantFamily.getValueAsString() == Family.getValueAsString(),
2682 "'alloc-variant-zeroed' must name a function belonging to the "
2683 "same 'alloc-family'");
2684
2685 Check(Variant->hasFnAttribute(Attribute::AllocKind) &&
2686 (Variant->getFnAttribute(Attribute::AllocKind).getAllocKind() &
2687 AllocFnKind::Zeroed) != AllocFnKind::Unknown,
2688 "'alloc-variant-zeroed' must name a function with "
2689 "'allockind(\"zeroed\")'");
2690
2691 Check(FT == Variant->getFunctionType(),
2692 "'alloc-variant-zeroed' must name a function with the same "
2693 "signature");
2694
2695 if (const auto *F = dyn_cast<Function>(V))
2696 Check(F->getCallingConv() == Variant->getCallingConv(),
2697 "'alloc-variant-zeroed' must name a function with the same "
2698 "calling convention");
2699 }
2700 }
2701
2702 if (Attrs.hasFnAttr(Attribute::VScaleRange)) {
2703 unsigned VScaleMin = Attrs.getFnAttrs().getVScaleRangeMin();
2704 if (VScaleMin == 0)
2705 CheckFailed("'vscale_range' minimum must be greater than 0", V);
2706 else if (!isPowerOf2_32(VScaleMin))
2707 CheckFailed("'vscale_range' minimum must be power-of-two value", V);
2708 std::optional<unsigned> VScaleMax = Attrs.getFnAttrs().getVScaleRangeMax();
2709 if (VScaleMax && VScaleMin > VScaleMax)
2710 CheckFailed("'vscale_range' minimum cannot be greater than maximum", V);
2711 else if (VScaleMax && !isPowerOf2_32(*VScaleMax))
2712 CheckFailed("'vscale_range' maximum must be power-of-two value", V);
2713 }
2714
2715 if (Attribute FPAttr = Attrs.getFnAttr("frame-pointer"); FPAttr.isValid()) {
2716 StringRef FP = FPAttr.getValueAsString();
2717 if (FP != "all" && FP != "non-leaf" && FP != "none" && FP != "reserved" &&
2718 FP != "non-leaf-no-reserve")
2719 CheckFailed("invalid value for 'frame-pointer' attribute: " + FP, V);
2720 }
2721
2722 checkUnsignedBaseTenFuncAttr(Attrs, "tail-pad-to-size", V);
2723 checkUnsignedBaseTenFuncAttr(Attrs, "tail-pad-value", V);
2724 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-prefix", V);
2725 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-entry", V);
2726 if (Attrs.hasFnAttr("patchable-function-entry-section"))
2727 Check(!Attrs.getFnAttr("patchable-function-entry-section")
2728 .getValueAsString()
2729 .empty(),
2730 "\"patchable-function-entry-section\" must not be empty");
2731 checkUnsignedBaseTenFuncAttr(Attrs, "warn-stack-size", V);
2732
2733 if (auto A = Attrs.getFnAttr("sign-return-address"); A.isValid()) {
2734 StringRef S = A.getValueAsString();
2735 if (S != "none" && S != "all" && S != "non-leaf")
2736 CheckFailed("invalid value for 'sign-return-address' attribute: " + S, V);
2737 }
2738
2739 if (auto A = Attrs.getFnAttr("sign-return-address-key"); A.isValid()) {
2740 StringRef S = A.getValueAsString();
2741 if (S != "a_key" && S != "b_key")
2742 CheckFailed("invalid value for 'sign-return-address-key' attribute: " + S,
2743 V);
2744 if (auto AA = Attrs.getFnAttr("sign-return-address"); !AA.isValid()) {
2745 CheckFailed(
2746 "'sign-return-address-key' present without `sign-return-address`");
2747 }
2748 }
2749
2750 if (auto A = Attrs.getFnAttr("sign-return-address-harden"); A.isValid()) {
2751 StringRef S = A.getValueAsString();
2752 if (S != "load-return-address" && S != "none")
2753 CheckFailed(
2754 "invalid value for 'sign-return-address-harden' attribute: " + S, V);
2755 auto SignRetA = Attrs.getFnAttr("sign-return-address");
2756 auto PAuthRetA = Attrs.getFnAttr("ptrauth-returns");
2757 if (!SignRetA.isValid() && !PAuthRetA.isValid())
2758 CheckFailed("'sign-return-address-harden' present without "
2759 "'sign-return-address' or 'ptrauth-returns'");
2760 }
2761
2762 if (auto A = Attrs.getFnAttr("branch-target-enforcement"); A.isValid()) {
2763 StringRef S = A.getValueAsString();
2764 if (S != "" && S != "true" && S != "false")
2765 CheckFailed(
2766 "invalid value for 'branch-target-enforcement' attribute: " + S, V);
2767 }
2768
2769 if (auto A = Attrs.getFnAttr("branch-protection-pauth-lr"); A.isValid()) {
2770 StringRef S = A.getValueAsString();
2771 if (S != "" && S != "true" && S != "false")
2772 CheckFailed(
2773 "invalid value for 'branch-protection-pauth-lr' attribute: " + S, V);
2774 }
2775
2776 if (auto A = Attrs.getFnAttr("guarded-control-stack"); A.isValid()) {
2777 StringRef S = A.getValueAsString();
2778 if (S != "" && S != "true" && S != "false")
2779 CheckFailed("invalid value for 'guarded-control-stack' attribute: " + S,
2780 V);
2781 }
2782
2783 if (auto A = Attrs.getFnAttr("vector-function-abi-variant"); A.isValid()) {
2784 StringRef S = A.getValueAsString();
2785 const std::optional<VFInfo> Info = VFABI::tryDemangleForVFABI(S, FT);
2786 if (!Info)
2787 CheckFailed("invalid name for a VFABI variant: " + S, V);
2788 }
2789
2790 if (auto A = Attrs.getFnAttr("modular-format"); A.isValid()) {
2791 StringRef S = A.getValueAsString();
2793 S.split(Args, ',');
2794 Check(Args.size() >= 5,
2795 "modular-format attribute requires at least 5 arguments", V);
2796 unsigned UpperBound = FT->getNumParams() + (FT->isVarArg() ? 1 : 0);
2797 unsigned FormatIdx;
2798 Check(!Args[1].getAsInteger(10, FormatIdx),
2799 "modular-format attribute format string index is not an integer", V);
2800 Check(FormatIdx > 0,
2801 "modular-format attribute format string index must be greater than 0",
2802 V);
2803 Check(FormatIdx <= UpperBound,
2804 "modular-format attribute format string index is out of bounds", V);
2805 unsigned FirstArgIdx;
2806 Check(!Args[2].getAsInteger(10, FirstArgIdx),
2807 "modular-format attribute first arg index is not an integer", V);
2808 Check(FirstArgIdx <= UpperBound,
2809 "modular-format attribute first arg index is out of bounds", V);
2810 Check(!Args[3].empty(),
2811 "modular-format attribute modular implementation function name "
2812 "cannot be empty",
2813 V);
2814 Check(!Args[4].empty(),
2815 "modular-format attribute implementation name cannot be empty", V);
2816 }
2817
2818 if (auto A = Attrs.getFnAttr("target-features"); A.isValid()) {
2819 StringRef S = A.getValueAsString();
2820 if (!S.empty()) {
2821 for (auto FeatureFlag : split(S, ',')) {
2822 if (FeatureFlag.empty())
2823 CheckFailed(
2824 "target-features attribute should not contain an empty string");
2825 else
2826 Check(FeatureFlag[0] == '+' || FeatureFlag[0] == '-',
2827 "target feature '" + FeatureFlag +
2828 "' must start with a '+' or '-'",
2829 V);
2830 }
2831 }
2832 }
2833}
2834void Verifier::verifyUnknownProfileMetadata(MDNode *MD) {
2835 Check(MD->getNumOperands() == 2,
2836 "'unknown' !prof should have a single additional operand", MD);
2837 auto *PassName = dyn_cast<MDString>(MD->getOperand(1));
2838 Check(PassName != nullptr,
2839 "'unknown' !prof should have an additional operand of type "
2840 "string");
2841 Check(!PassName->getString().empty(),
2842 "the 'unknown' !prof operand should not be an empty string");
2843}
2844
2845void Verifier::verifyFunctionMetadata(
2846 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
2847 for (const auto &Pair : MDs) {
2848 if (Pair.first == LLVMContext::MD_prof) {
2849 MDNode *MD = Pair.second;
2850 Check(MD->getNumOperands() >= 2,
2851 "!prof annotations should have no less than 2 operands", MD);
2852 // We may have functions that are synthesized by the compiler, e.g. in
2853 // WPD, that we can't currently determine the entry count.
2854 if (MD->getOperand(0).equalsStr(
2856 verifyUnknownProfileMetadata(MD);
2857 continue;
2858 }
2859
2860 // Check first operand.
2861 Check(MD->getOperand(0) != nullptr, "first operand should not be null",
2862 MD);
2864 "expected string with name of the !prof annotation", MD);
2865 MDString *MDS = cast<MDString>(MD->getOperand(0));
2866 StringRef ProfName = MDS->getString();
2869 "first operand should be 'function_entry_count'"
2870 " or 'synthetic_function_entry_count'",
2871 MD);
2872
2873 // Check second operand.
2874 Check(MD->getOperand(1) != nullptr, "second operand should not be null",
2875 MD);
2877 "expected integer argument to function_entry_count", MD);
2878 } else if (Pair.first == LLVMContext::MD_kcfi_type) {
2879 MDNode *MD = Pair.second;
2880 Check(MD->getNumOperands() == 1,
2881 "!kcfi_type must have exactly one operand", MD);
2882 Check(MD->getOperand(0) != nullptr, "!kcfi_type operand must not be null",
2883 MD);
2885 "expected a constant operand for !kcfi_type", MD);
2886 Constant *C = cast<ConstantAsMetadata>(MD->getOperand(0))->getValue();
2887 Check(isa<ConstantInt>(C) && isa<IntegerType>(C->getType()),
2888 "expected a constant integer operand for !kcfi_type", MD);
2890 "expected a 32-bit integer constant operand for !kcfi_type", MD);
2891 } else if (Pair.first == Context.getMDKindID("reqd_work_group_size")) {
2892 MDNode *MD = Pair.second;
2893 Check(MD->getNumOperands() == 3,
2894 "reqd_work_group_size must have exactly three operands", MD);
2895 if (MD->getNumOperands() != 3)
2896 continue;
2897
2898 uint64_t Product = 1;
2899 for (unsigned I = 0; I != 3; ++I) {
2900 ConstantInt *C = mdconst::dyn_extract<ConstantInt>(MD->getOperand(I));
2901 Check(C, "reqd_work_group_size operands must be integer constants", MD);
2902 if (!C)
2903 break;
2904
2905 const APInt &Value = C->getValue();
2906 Check(Value.getActiveBits() <= 64,
2907 "reqd_work_group_size operands must fit in 64 bits", MD);
2908 if (Value.getActiveBits() > 64)
2909 break;
2910
2911 uint64_t Dim = Value.getZExtValue();
2912 Check(Dim == 0 || Product <= std::numeric_limits<uint64_t>::max() / Dim,
2913 "reqd_work_group_size product must fit in 64 bits", MD);
2914 if (Dim != 0 && Product > std::numeric_limits<uint64_t>::max() / Dim)
2915 break;
2916 Product *= Dim;
2917 }
2918 }
2919 }
2920}
2921
2922void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
2923 if (EntryC->getNumOperands() == 0)
2924 return;
2925
2926 if (!ConstantExprVisited.insert(EntryC).second)
2927 return;
2928
2930 Stack.push_back(EntryC);
2931
2932 while (!Stack.empty()) {
2933 const Constant *C = Stack.pop_back_val();
2934
2935 // Check this constant expression.
2936 if (const auto *CE = dyn_cast<ConstantExpr>(C))
2937 visitConstantExpr(CE);
2938
2939 if (const auto *CPA = dyn_cast<ConstantPtrAuth>(C))
2940 visitConstantPtrAuth(CPA);
2941
2942 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
2943 // Global Values get visited separately, but we do need to make sure
2944 // that the global value is in the correct module
2945 Check(GV->getParent() == &M, "Referencing global in another module!",
2946 EntryC, &M, GV, GV->getParent());
2947 continue;
2948 }
2949
2950 // Visit all sub-expressions.
2951 for (const Use &U : C->operands()) {
2952 const auto *OpC = dyn_cast<Constant>(U);
2953 if (!OpC)
2954 continue;
2955 if (!ConstantExprVisited.insert(OpC).second)
2956 continue;
2957 Stack.push_back(OpC);
2958 }
2959 }
2960}
2961
2962void Verifier::visitConstantExpr(const ConstantExpr *CE) {
2963 if (CE->getOpcode() == Instruction::BitCast) {
2964 Check(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
2965 CE->getType()),
2966 "Invalid bitcast", CE);
2967 Check(DL.getTypeSizeInBits(CE->getOperand(0)->getType()) ==
2968 DL.getTypeSizeInBits(CE->getType()),
2969 "Invalid bitcast", CE);
2970 } else if (CE->getOpcode() == Instruction::PtrToAddr)
2971 checkPtrToAddr(CE->getOperand(0)->getType(), CE->getType(), *CE);
2972}
2973
2974void Verifier::visitConstantPtrAuth(const ConstantPtrAuth *CPA) {
2975 Check(CPA->getPointer()->getType()->isPointerTy(),
2976 "signed ptrauth constant base pointer must have pointer type");
2977
2978 Check(CPA->getType() == CPA->getPointer()->getType(),
2979 "signed ptrauth constant must have same type as its base pointer");
2980
2981 Check(CPA->getKey()->getBitWidth() == 32,
2982 "signed ptrauth constant key must be i32 constant integer");
2983
2985 "signed ptrauth constant address discriminator must be a pointer");
2986
2987 Check(CPA->getDiscriminator()->getBitWidth() == 64,
2988 "signed ptrauth constant discriminator must be i64 constant integer");
2989
2991 "signed ptrauth constant deactivation symbol must be a pointer");
2992
2995 "signed ptrauth constant deactivation symbol must be a global value "
2996 "or null");
2997}
2998
2999bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) {
3000 // There shouldn't be more attribute sets than there are parameters plus the
3001 // function and return value.
3002 return Attrs.getNumAttrSets() <= Params + 2;
3003}
3004
3005void Verifier::verifyInlineAsmCall(const CallBase &Call) {
3006 const InlineAsm *IA = cast<InlineAsm>(Call.getCalledOperand());
3007 unsigned ArgNo = 0;
3008 unsigned LabelNo = 0;
3009 for (const InlineAsm::ConstraintInfo &CI : IA->ParseConstraints()) {
3010 if (CI.Type == InlineAsm::isLabel) {
3011 ++LabelNo;
3012 continue;
3013 }
3014
3015 // Only deal with constraints that correspond to call arguments.
3016 if (!CI.hasArg())
3017 continue;
3018
3019 if (CI.isIndirect) {
3020 const Value *Arg = Call.getArgOperand(ArgNo);
3021 Check(Arg->getType()->isPointerTy(),
3022 "Operand for indirect constraint must have pointer type", &Call);
3023
3025 "Operand for indirect constraint must have elementtype attribute",
3026 &Call);
3027 } else {
3028 Check(!Call.paramHasAttr(ArgNo, Attribute::ElementType),
3029 "Elementtype attribute can only be applied for indirect "
3030 "constraints",
3031 &Call);
3032 }
3033
3034 ArgNo++;
3035 }
3036
3037 if (auto *CallBr = dyn_cast<CallBrInst>(&Call)) {
3038 Check(LabelNo == CallBr->getNumIndirectDests(),
3039 "Number of label constraints does not match number of callbr dests",
3040 &Call);
3041 } else {
3042 Check(LabelNo == 0, "Label constraints can only be used with callbr",
3043 &Call);
3044 }
3045}
3046
3047/// Verify that statepoint intrinsic is well formed.
3048void Verifier::verifyStatepoint(const CallBase &Call) {
3049 assert(Call.getIntrinsicID() == Intrinsic::experimental_gc_statepoint);
3050
3053 "gc.statepoint must read and write all memory to preserve "
3054 "reordering restrictions required by safepoint semantics",
3055 Call);
3056
3057 const int64_t NumPatchBytes =
3058 cast<ConstantInt>(Call.getArgOperand(1))->getSExtValue();
3059 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
3060 Check(NumPatchBytes >= 0,
3061 "gc.statepoint number of patchable bytes must be "
3062 "positive",
3063 Call);
3064
3065 Type *TargetElemType = Call.getParamElementType(2);
3066 Check(TargetElemType,
3067 "gc.statepoint callee argument must have elementtype attribute", Call);
3068 auto *TargetFuncType = dyn_cast<FunctionType>(TargetElemType);
3069 Check(TargetFuncType,
3070 "gc.statepoint callee elementtype must be function type", Call);
3071
3072 const int NumCallArgs = cast<ConstantInt>(Call.getArgOperand(3))->getZExtValue();
3073 Check(NumCallArgs >= 0,
3074 "gc.statepoint number of arguments to underlying call "
3075 "must be positive",
3076 Call);
3077 const int NumParams = (int)TargetFuncType->getNumParams();
3078 if (TargetFuncType->isVarArg()) {
3079 Check(NumCallArgs >= NumParams,
3080 "gc.statepoint mismatch in number of vararg call args", Call);
3081
3082 // TODO: Remove this limitation
3083 Check(TargetFuncType->getReturnType()->isVoidTy(),
3084 "gc.statepoint doesn't support wrapping non-void "
3085 "vararg functions yet",
3086 Call);
3087 } else
3088 Check(NumCallArgs == NumParams,
3089 "gc.statepoint mismatch in number of call args", Call);
3090
3091 const uint64_t Flags
3092 = cast<ConstantInt>(Call.getArgOperand(4))->getZExtValue();
3093 Check((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
3094 "unknown flag used in gc.statepoint flags argument", Call);
3095
3096 // Verify that the types of the call parameter arguments match
3097 // the type of the wrapped callee.
3098 AttributeList Attrs = Call.getAttributes();
3099 for (int i = 0; i < NumParams; i++) {
3100 Type *ParamType = TargetFuncType->getParamType(i);
3101 Type *ArgType = Call.getArgOperand(5 + i)->getType();
3102 Check(ArgType == ParamType,
3103 "gc.statepoint call argument does not match wrapped "
3104 "function type",
3105 Call);
3106
3107 if (TargetFuncType->isVarArg()) {
3108 AttributeSet ArgAttrs = Attrs.getParamAttrs(5 + i);
3109 Check(!ArgAttrs.hasAttribute(Attribute::StructRet),
3110 "Attribute 'sret' cannot be used for vararg call arguments!", Call);
3111 }
3112 }
3113
3114 const int EndCallArgsInx = 4 + NumCallArgs;
3115
3116 const Value *NumTransitionArgsV = Call.getArgOperand(EndCallArgsInx + 1);
3117 Check(isa<ConstantInt>(NumTransitionArgsV),
3118 "gc.statepoint number of transition arguments "
3119 "must be constant integer",
3120 Call);
3121 const int NumTransitionArgs =
3122 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
3123 Check(NumTransitionArgs == 0,
3124 "gc.statepoint w/inline transition bundle is deprecated", Call);
3125 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
3126
3127 const Value *NumDeoptArgsV = Call.getArgOperand(EndTransitionArgsInx + 1);
3128 Check(isa<ConstantInt>(NumDeoptArgsV),
3129 "gc.statepoint number of deoptimization arguments "
3130 "must be constant integer",
3131 Call);
3132 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
3133 Check(NumDeoptArgs == 0,
3134 "gc.statepoint w/inline deopt operands is deprecated", Call);
3135
3136 const int ExpectedNumArgs = 7 + NumCallArgs;
3137 Check(ExpectedNumArgs == (int)Call.arg_size(),
3138 "gc.statepoint too many arguments", Call);
3139
3140 // Check that the only uses of this gc.statepoint are gc.result or
3141 // gc.relocate calls which are tied to this statepoint and thus part
3142 // of the same statepoint sequence
3143 for (const User *U : Call.users()) {
3144 const auto *UserCall = dyn_cast<const CallInst>(U);
3145 Check(UserCall, "illegal use of statepoint token", Call, U);
3146 if (!UserCall)
3147 continue;
3148 Check(isa<GCRelocateInst>(UserCall) || isa<GCResultInst>(UserCall),
3149 "gc.result or gc.relocate are the only value uses "
3150 "of a gc.statepoint",
3151 Call, U);
3152 if (isa<GCResultInst>(UserCall)) {
3153 Check(UserCall->getArgOperand(0) == &Call,
3154 "gc.result connected to wrong gc.statepoint", Call, UserCall);
3155 } else if (isa<GCRelocateInst>(Call)) {
3156 Check(UserCall->getArgOperand(0) == &Call,
3157 "gc.relocate connected to wrong gc.statepoint", Call, UserCall);
3158 }
3159 }
3160
3161 // Note: It is legal for a single derived pointer to be listed multiple
3162 // times. It's non-optimal, but it is legal. It can also happen after
3163 // insertion if we strip a bitcast away.
3164 // Note: It is really tempting to check that each base is relocated and
3165 // that a derived pointer is never reused as a base pointer. This turns
3166 // out to be problematic since optimizations run after safepoint insertion
3167 // can recognize equality properties that the insertion logic doesn't know
3168 // about. See example statepoint.ll in the verifier subdirectory
3169}
3170
3171void Verifier::verifyFrameRecoverIndices() {
3172 for (auto &Counts : FrameEscapeInfo) {
3173 Function *F = Counts.first;
3174 unsigned EscapedObjectCount = Counts.second.first;
3175 unsigned MaxRecoveredIndex = Counts.second.second;
3176 Check(MaxRecoveredIndex <= EscapedObjectCount,
3177 "all indices passed to llvm.localrecover must be less than the "
3178 "number of arguments passed to llvm.localescape in the parent "
3179 "function",
3180 F);
3181 }
3182}
3183
3184static Instruction *getSuccPad(Instruction *Terminator) {
3185 BasicBlock *UnwindDest;
3186 if (auto *II = dyn_cast<InvokeInst>(Terminator))
3187 UnwindDest = II->getUnwindDest();
3188 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
3189 UnwindDest = CSI->getUnwindDest();
3190 else
3191 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
3192 return &*UnwindDest->getFirstNonPHIIt();
3193}
3194
3195void Verifier::verifySiblingFuncletUnwinds() {
3196 llvm::TimeTraceScope timeScope("Verifier verify sibling funclet unwinds");
3197 SmallPtrSet<Instruction *, 8> Visited;
3198 SmallPtrSet<Instruction *, 8> Active;
3199 for (const auto &Pair : SiblingFuncletInfo) {
3200 Instruction *PredPad = Pair.first;
3201 if (Visited.count(PredPad))
3202 continue;
3203 Active.insert(PredPad);
3204 Instruction *Terminator = Pair.second;
3205 do {
3206 Instruction *SuccPad = getSuccPad(Terminator);
3207 if (Active.count(SuccPad)) {
3208 // Found a cycle; report error
3209 Instruction *CyclePad = SuccPad;
3210 SmallVector<Instruction *, 8> CycleNodes;
3211 do {
3212 CycleNodes.push_back(CyclePad);
3213 Instruction *CycleTerminator = SiblingFuncletInfo[CyclePad];
3214 if (CycleTerminator != CyclePad)
3215 CycleNodes.push_back(CycleTerminator);
3216 CyclePad = getSuccPad(CycleTerminator);
3217 } while (CyclePad != SuccPad);
3218 Check(false, "EH pads can't handle each other's exceptions",
3219 ArrayRef<Instruction *>(CycleNodes));
3220 }
3221 // Don't re-walk a node we've already checked
3222 if (!Visited.insert(SuccPad).second)
3223 break;
3224 // Walk to this successor if it has a map entry.
3225 PredPad = SuccPad;
3226 auto TermI = SiblingFuncletInfo.find(PredPad);
3227 if (TermI == SiblingFuncletInfo.end())
3228 break;
3229 Terminator = TermI->second;
3230 Active.insert(PredPad);
3231 } while (true);
3232 // Each node only has one successor, so we've walked all the active
3233 // nodes' successors.
3234 Active.clear();
3235 }
3236}
3237
3238// visitFunction - Verify that a function is ok.
3239//
3240void Verifier::visitFunction(const Function &F) {
3241 visitGlobalValue(F);
3242
3243 // Check function arguments.
3244 FunctionType *FT = F.getFunctionType();
3245 unsigned NumArgs = F.arg_size();
3246
3247 Check(&Context == &F.getContext(),
3248 "Function context does not match Module context!", &F);
3249
3250 Check(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
3251 Check(FT->getNumParams() == NumArgs,
3252 "# formal arguments must match # of arguments for function type!", &F,
3253 FT);
3254 Check(F.getReturnType()->isFirstClassType() ||
3255 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
3256 "Functions cannot return aggregate values!", &F);
3257
3258 Check(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
3259 "Invalid struct return type!", &F);
3260
3261 if (MaybeAlign A = F.getAlign()) {
3262 Check(A->value() <= Value::MaximumAlignment,
3263 "huge alignment values are unsupported", &F);
3264 }
3265
3266 AttributeList Attrs = F.getAttributes();
3267
3268 Check(verifyAttributeCount(Attrs, FT->getNumParams()),
3269 "Attribute after last parameter!", &F);
3270
3271 bool IsIntrinsic = F.isIntrinsic();
3272
3273 // Check function attributes.
3274 verifyFunctionAttrs(FT, Attrs, &F, IsIntrinsic, /* IsInlineAsm */ false);
3275
3276 // On function declarations/definitions, we do not support the builtin
3277 // attribute. We do not check this in VerifyFunctionAttrs since that is
3278 // checking for Attributes that can/can not ever be on functions.
3279 Check(!Attrs.hasFnAttr(Attribute::Builtin),
3280 "Attribute 'builtin' can only be applied to a callsite.", &F);
3281
3282 Check(!Attrs.hasAttrSomewhere(Attribute::ElementType),
3283 "Attribute 'elementtype' can only be applied to a callsite.", &F);
3284
3285 if (Attrs.hasFnAttr(Attribute::Naked))
3286 for (const Argument &Arg : F.args())
3287 Check(Arg.use_empty(), "cannot use argument of naked function", &Arg);
3288
3289 // Check that this function meets the restrictions on this calling convention.
3290 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
3291 // restrictions can be lifted.
3292 switch (F.getCallingConv()) {
3293 default:
3294 case CallingConv::C:
3295 break;
3296 case CallingConv::X86_INTR: {
3297 Check(F.arg_empty() || Attrs.hasParamAttr(0, Attribute::ByVal),
3298 "Calling convention parameter requires byval", &F);
3299 break;
3300 }
3301 case CallingConv::AMDGPU_KERNEL:
3302 case CallingConv::SPIR_KERNEL:
3303 case CallingConv::AMDGPU_CS_Chain:
3304 case CallingConv::AMDGPU_CS_ChainPreserve:
3305 Check(F.getReturnType()->isVoidTy(),
3306 "Calling convention requires void return type", &F);
3307 [[fallthrough]];
3308 case CallingConv::AMDGPU_VS:
3309 case CallingConv::AMDGPU_HS:
3310 case CallingConv::AMDGPU_GS:
3311 case CallingConv::AMDGPU_PS:
3312 case CallingConv::AMDGPU_CS:
3313 Check(!F.hasStructRetAttr(), "Calling convention does not allow sret", &F);
3314 if (F.getCallingConv() != CallingConv::SPIR_KERNEL) {
3315 const unsigned StackAS = DL.getAllocaAddrSpace();
3316 unsigned i = 0;
3317 for (const Argument &Arg : F.args()) {
3318 Check(!Attrs.hasParamAttr(i, Attribute::ByVal),
3319 "Calling convention disallows byval", &F);
3320 Check(!Attrs.hasParamAttr(i, Attribute::Preallocated),
3321 "Calling convention disallows preallocated", &F);
3322 Check(!Attrs.hasParamAttr(i, Attribute::InAlloca),
3323 "Calling convention disallows inalloca", &F);
3324
3325 if (Attrs.hasParamAttr(i, Attribute::ByRef)) {
3326 // FIXME: Should also disallow LDS and GDS, but we don't have the enum
3327 // value here.
3328 Check(Arg.getType()->getPointerAddressSpace() != StackAS,
3329 "Calling convention disallows stack byref", &F);
3330 }
3331
3332 ++i;
3333 }
3334 }
3335
3336 [[fallthrough]];
3337 case CallingConv::Fast:
3338 case CallingConv::Cold:
3339 case CallingConv::Intel_OCL_BI:
3340 case CallingConv::PTX_Kernel:
3341 case CallingConv::PTX_Device:
3342 Check(!F.isVarArg(),
3343 "Calling convention does not support varargs or "
3344 "perfect forwarding!",
3345 &F);
3346 break;
3347 case CallingConv::AMDGPU_Gfx_WholeWave:
3348 Check(!F.arg_empty() && F.arg_begin()->getType()->isIntegerTy(1),
3349 "Calling convention requires first argument to be i1", &F);
3350 Check(!F.arg_begin()->hasInRegAttr(),
3351 "Calling convention requires first argument to not be inreg", &F);
3352 Check(!F.isVarArg(),
3353 "Calling convention does not support varargs or "
3354 "perfect forwarding!",
3355 &F);
3356 break;
3357 }
3358
3359 // Check that the argument values match the function type for this function...
3360 unsigned i = 0;
3361 for (const Argument &Arg : F.args()) {
3362 Check(Arg.getType() == FT->getParamType(i),
3363 "Argument value does not match function argument type!", &Arg,
3364 FT->getParamType(i));
3365 Check(Arg.getType()->isFirstClassType(),
3366 "Function arguments must have first-class types!", &Arg);
3367 if (!IsIntrinsic) {
3368 Check(!Arg.getType()->isMetadataTy(),
3369 "Function takes metadata but isn't an intrinsic", &Arg, &F);
3370 Check(!Arg.getType()->isTokenLikeTy(),
3371 "Function takes token but isn't an intrinsic", &Arg, &F);
3372 Check(!Arg.getType()->isX86_AMXTy(),
3373 "Function takes x86_amx but isn't an intrinsic", &Arg, &F);
3374 }
3375
3376 // Check that swifterror argument is only used by loads and stores.
3377 if (Attrs.hasParamAttr(i, Attribute::SwiftError)) {
3378 verifySwiftErrorValue(&Arg);
3379 }
3380 ++i;
3381 }
3382
3383 if (!IsIntrinsic) {
3384 Check(!F.getReturnType()->isTokenLikeTy(),
3385 "Function returns a token but isn't an intrinsic", &F);
3386 Check(!F.getReturnType()->isX86_AMXTy(),
3387 "Function returns a x86_amx but isn't an intrinsic", &F);
3388 }
3389
3390 // Get the function metadata attachments.
3392 F.getAllMetadata(MDs);
3393 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
3394 verifyFunctionMetadata(MDs);
3395
3396 // Target-specific function metadata checks.
3398
3399 // Check validity of the personality function
3400 if (F.hasPersonalityFn()) {
3401 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
3402 if (Per)
3403 Check(Per->getParent() == F.getParent(),
3404 "Referencing personality function in another module!", &F,
3405 F.getParent(), Per, Per->getParent());
3406 }
3407
3408 // EH funclet coloring can be expensive, recompute on-demand
3409 BlockEHFuncletColors.clear();
3410
3411 if (F.isMaterializable()) {
3412 // Function has a body somewhere we can't see.
3413 Check(MDs.empty(), "unmaterialized function cannot have metadata", &F,
3414 MDs.empty() ? nullptr : MDs.front().second);
3415 } else if (F.isDeclaration()) {
3416 for (const auto &I : MDs) {
3417 // This is used for call site debug information.
3418 CheckDI(I.first != LLVMContext::MD_dbg ||
3419 !cast<DISubprogram>(I.second)->isDistinct(),
3420 "function declaration may only have a unique !dbg attachment",
3421 &F);
3422 Check(I.first != LLVMContext::MD_prof,
3423 "function declaration may not have a !prof attachment", &F);
3424
3425 // Verify the metadata itself.
3426 visitMDNode(*I.second, AreDebugLocsAllowed::Yes);
3427 }
3428 Check(!F.hasPersonalityFn(),
3429 "Function declaration shouldn't have a personality routine", &F);
3430 } else {
3431 // Verify that this function (which has a body) is not named "llvm.*". It
3432 // is not legal to define intrinsics.
3433 Check(!IsIntrinsic, "llvm intrinsics cannot be defined!", &F);
3434
3435 // Check the entry node
3436 const BasicBlock *Entry = &F.getEntryBlock();
3437 Check(pred_empty(Entry),
3438 "Entry block to function must not have predecessors!", Entry);
3439
3440 // The address of the entry block cannot be taken, unless it is dead.
3441 if (Entry->hasAddressTaken()) {
3442 Check(!BlockAddress::lookup(Entry)->isConstantUsed(),
3443 "blockaddress may not be used with the entry block!", Entry);
3444 }
3445
3446 unsigned NumDebugAttachments = 0, NumProfAttachments = 0,
3447 NumKCFIAttachments = 0;
3448 // Visit metadata attachments.
3449 for (const auto &I : MDs) {
3450 // Verify that the attachment is legal.
3451 auto AllowLocs = AreDebugLocsAllowed::No;
3452 switch (I.first) {
3453 default:
3454 break;
3455 case LLVMContext::MD_dbg: {
3456 ++NumDebugAttachments;
3457 CheckDI(NumDebugAttachments == 1,
3458 "function must have a single !dbg attachment", &F, I.second);
3459 CheckDI(isa<DISubprogram>(I.second),
3460 "function !dbg attachment must be a subprogram", &F, I.second);
3461 CheckDI(cast<DISubprogram>(I.second)->isDistinct(),
3462 "function definition may only have a distinct !dbg attachment",
3463 &F);
3464
3465 auto *SP = cast<DISubprogram>(I.second);
3466 const Function *&AttachedTo = DISubprogramAttachments[SP];
3467 CheckDI(!AttachedTo || AttachedTo == &F,
3468 "DISubprogram attached to more than one function", SP, &F);
3469 AttachedTo = &F;
3470 AllowLocs = AreDebugLocsAllowed::Yes;
3471 break;
3472 }
3473 case LLVMContext::MD_prof:
3474 ++NumProfAttachments;
3475 Check(NumProfAttachments == 1,
3476 "function must have a single !prof attachment", &F, I.second);
3477 break;
3478 case LLVMContext::MD_kcfi_type:
3479 ++NumKCFIAttachments;
3480 Check(NumKCFIAttachments == 1,
3481 "function must have a single !kcfi_type attachment", &F,
3482 I.second);
3483 break;
3484 }
3485
3486 // Verify the metadata itself.
3487 visitMDNode(*I.second, AllowLocs);
3488 }
3489 }
3490
3491 // If this function is actually an intrinsic, verify that it is only used in
3492 // direct call/invokes, never having its "address taken".
3493 // Only do this if the module is materialized, otherwise we don't have all the
3494 // uses.
3495 bool isMaterialized = F.getParent()->isMaterialized();
3496 if (F.isIntrinsic() && isMaterialized) {
3497 const User *U;
3498 if (F.hasAddressTaken(&U, false, true, false,
3499 /*IgnoreARCAttachedCall=*/true))
3500 Check(false, "Invalid user of intrinsic instruction!", U);
3501 }
3502
3503 // Verify if the intrinsic's signature and name are valid. We do this if
3504 // the intrinsic has at least one materialized use, or if the module is fully
3505 // materialized.
3506 Intrinsic::ID IID = F.getIntrinsicID();
3507 if (IID && (isMaterialized || !F.materialized_use_empty())) {
3508 // Verify that the intrinsic prototype lines up with what the .td files
3509 // describe.
3510 std::string ErrMsg;
3511 raw_string_ostream ErrOS(ErrMsg);
3512 SmallVector<Type *, 4> OverloadTys;
3513 bool IsValid = Intrinsic::isSignatureValid(IID, FT, OverloadTys, ErrOS);
3514 Printable PrintDecl([&F](raw_ostream &OS) { F.print(OS); });
3515 Check(IsValid, ErrMsg, PrintDecl);
3516
3517 // Now that we have the intrinsic ID and the actual argument types (and we
3518 // know they are legal for the intrinsic!) get the intrinsic name through
3519 // the usual means. This allows us to verify the mangling of argument types
3520 // into the name.
3521 const std::string ExpectedName = Intrinsic::getName(
3522 IID, OverloadTys, const_cast<Module *>(F.getParent()), FT);
3523 Check(ExpectedName == F.getName(),
3524 "Intrinsic name not mangled correctly for type arguments! "
3525 "Should be: " +
3526 ExpectedName,
3527 PrintDecl);
3528 }
3529
3530 // Oracle functions of llvm.speculative.load may not be referenced in any
3531 // other way.
3532 if (isMaterialized && F.hasFnAttribute("oracle-function")) {
3533 Check(F.hasLocalLinkage(), "oracle function must have local linkage", &F);
3534 for (const Use &U : F.uses()) {
3535 auto *II = dyn_cast<IntrinsicInst>(U.getUser());
3536 Check(II && II->getIntrinsicID() == Intrinsic::speculative_load &&
3537 II->isArgOperand(&U) && II->getArgOperandNo(&U) == 2,
3538 "oracle function may only be used as the oracle operand of "
3539 "llvm.speculative.load",
3540 &F, U.getUser());
3541 }
3542 }
3543
3544 auto *N = F.getSubprogram();
3545 HasDebugInfo = (N != nullptr);
3546 if (!HasDebugInfo)
3547 return;
3548
3549 // Check that all !dbg attachments lead to back to N.
3550 //
3551 // FIXME: Check this incrementally while visiting !dbg attachments.
3552 // FIXME: Only check when N is the canonical subprogram for F.
3553 SmallPtrSet<const MDNode *, 32> Seen;
3554 auto VisitDebugLoc = [&](const Instruction &I, const MDNode *Node) {
3555 // Be careful about using DILocation here since we might be dealing with
3556 // broken code (this is the Verifier after all).
3557 const DILocation *DL = dyn_cast_or_null<DILocation>(Node);
3558 if (!DL)
3559 return;
3560 if (!Seen.insert(DL).second)
3561 return;
3562
3563 Metadata *Parent = DL->getRawScope();
3564 CheckDI(Parent && isa<DILocalScope>(Parent),
3565 "DILocation's scope must be a DILocalScope", N, &F, &I, DL, Parent);
3566
3567 DILocalScope *Scope = DL->getInlinedAtScope();
3568 Check(Scope, "Failed to find DILocalScope", DL);
3569
3570 if (!Seen.insert(Scope).second)
3571 return;
3572
3573 // Cycles are diagnosed when the DIScope nodes themselves are visited.
3574 if (hasDIScopeCycle(Scope))
3575 return;
3576
3577 DISubprogram *SP = Scope->getSubprogram();
3578
3579 // Scope and SP could be the same MDNode and we don't want to skip
3580 // validation in that case
3581 if ((Scope != SP) && !Seen.insert(SP).second)
3582 return;
3583
3584 CheckDI(SP->describes(&F),
3585 "!dbg attachment points at wrong subprogram for function", N, &F,
3586 &I, DL, Scope, SP);
3587 };
3588 for (auto &BB : F)
3589 for (auto &I : BB) {
3590 VisitDebugLoc(I, I.getDebugLoc().getAsMDNode());
3591 // The llvm.loop annotations also contain two DILocations.
3592 if (auto MD = I.getMetadata(LLVMContext::MD_loop))
3593 for (unsigned i = 1; i < MD->getNumOperands(); ++i)
3594 VisitDebugLoc(I, dyn_cast_or_null<MDNode>(MD->getOperand(i)));
3595 if (BrokenDebugInfo)
3596 return;
3597 }
3598}
3599
3600// verifyBasicBlock - Verify that a basic block is well formed...
3601//
3602void Verifier::visitBasicBlock(BasicBlock &BB) {
3603 InstsInThisBlock.clear();
3604 ConvergenceVerifyHelper.visit(BB);
3605
3606 // Check constraints that this basic block imposes on all of the PHI nodes in
3607 // it.
3608 if (isa<PHINode>(BB.front())) {
3609 SmallVector<BasicBlock *, 8> Preds(predecessors(&BB));
3611 llvm::sort(Preds);
3612 for (const PHINode &PN : BB.phis()) {
3613 Check(PN.getNumIncomingValues() == Preds.size(),
3614 "PHINode should have one entry for each predecessor of its "
3615 "parent basic block!",
3616 &PN);
3617
3618 // Get and sort all incoming values in the PHI node...
3619 Values.clear();
3620 Values.reserve(PN.getNumIncomingValues());
3621 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
3622 Values.push_back(
3623 std::make_pair(PN.getIncomingBlock(i), PN.getIncomingValue(i)));
3625
3626 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
3627 // Check to make sure that if there is more than one entry for a
3628 // particular basic block in this PHI node, that the incoming values are
3629 // all identical.
3630 //
3631 Check(i == 0 || Values[i].first != Values[i - 1].first ||
3632 Values[i].second == Values[i - 1].second,
3633 "PHI node has multiple entries for the same basic block with "
3634 "different incoming values!",
3635 &PN, Values[i].first, Values[i].second, Values[i - 1].second);
3636
3637 // Check to make sure that the predecessors and PHI node entries are
3638 // matched up.
3639 Check(Values[i].first == Preds[i],
3640 "PHI node entries do not match predecessors!", &PN,
3641 Values[i].first, Preds[i]);
3642 }
3643 }
3644 }
3645
3646 // Check that all instructions have their parent pointers set up correctly.
3647 for (auto &I : BB)
3648 {
3649 Check(I.getParent() == &BB, "Instruction has bogus parent pointer!");
3650 }
3651
3652 // Confirm that no issues arise from the debug program.
3653 CheckDI(!BB.getTrailingDbgRecords(), "Basic Block has trailing DbgRecords!",
3654 &BB);
3655}
3656
3657void Verifier::visitTerminator(Instruction &I) {
3658 // Ensure that terminators only exist at the end of the basic block.
3659 Check(&I == I.getParent()->getTerminator(),
3660 "Terminator found in the middle of a basic block!", I.getParent());
3661 visitInstruction(I);
3662}
3663
3664void Verifier::visitCondBrInst(CondBrInst &BI) {
3666 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
3667 visitTerminator(BI);
3668}
3669
3670void Verifier::visitReturnInst(ReturnInst &RI) {
3671 Function *F = RI.getParent()->getParent();
3672 unsigned N = RI.getNumOperands();
3673 if (F->getReturnType()->isVoidTy())
3674 Check(N == 0,
3675 "Found return instr that returns non-void in Function of void "
3676 "return type!",
3677 &RI, F->getReturnType());
3678 else
3679 Check(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
3680 "Function return type does not match operand "
3681 "type of return inst!",
3682 &RI, F->getReturnType());
3683
3684 // Check to make sure that the return value has necessary properties for
3685 // terminators...
3686 visitTerminator(RI);
3687}
3688
3689void Verifier::visitSwitchInst(SwitchInst &SI) {
3690 Check(SI.getType()->isVoidTy(), "Switch must have void result type!", &SI);
3691 // Check to make sure that all of the constants in the switch instruction
3692 // have the same type as the switched-on value.
3693 Type *SwitchTy = SI.getCondition()->getType();
3694 SmallPtrSet<ConstantInt*, 32> Constants;
3695 for (auto &Case : SI.cases()) {
3696 Check(isa<ConstantInt>(Case.getCaseValue()),
3697 "Case value is not a constant integer.", &SI);
3698 Check(Case.getCaseValue()->getType() == SwitchTy,
3699 "Switch constants must all be same type as switch value!", &SI);
3700 Check(Constants.insert(Case.getCaseValue()).second,
3701 "Duplicate integer as switch case", &SI, Case.getCaseValue());
3702 }
3703
3704 visitTerminator(SI);
3705}
3706
3707void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
3709 "Indirectbr operand must have pointer type!", &BI);
3710 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
3712 "Indirectbr destinations must all have pointer type!", &BI);
3713
3714 visitTerminator(BI);
3715}
3716
3718 // Currently we only support callbr for amdgcn.kill. Add more checks here as
3719 // needed.
3720 return isAMDGPUCallBrIntrinsic(ID);
3721}
3722
3723void Verifier::visitCallBrInst(CallBrInst &CBI) {
3724 if (!CBI.isInlineAsm()) {
3726 "callbr: indirect function / invalid signature");
3727 Check(!CBI.hasOperandBundles(),
3728 "callbr for intrinsics currently doesn't support operand bundles");
3729
3731 CheckFailed(
3732 "callbr currently only supports asm-goto and selected intrinsics");
3733 }
3734 visitIntrinsicCall(CBI.getIntrinsicID(), CBI);
3735 } else {
3736 const InlineAsm *IA = cast<InlineAsm>(CBI.getCalledOperand());
3737 Check(!IA->canThrow(), "Unwinding from Callbr is not allowed");
3738
3739 verifyInlineAsmCall(CBI);
3740 }
3741 visitTerminator(CBI);
3742}
3743
3744void Verifier::visitSelectInst(SelectInst &SI) {
3745 Check(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
3746 SI.getOperand(2)),
3747 "Invalid operands for select instruction!", &SI);
3748
3749 Check(SI.getTrueValue()->getType() == SI.getType(),
3750 "Select values must have same type as select instruction!", &SI);
3751 visitInstruction(SI);
3752}
3753
3754/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
3755/// a pass, if any exist, it's an error.
3756///
3757void Verifier::visitUserOp1(Instruction &I) {
3758 Check(false, "User-defined operators should not live outside of a pass!", &I);
3759}
3760
3761void Verifier::visitTruncInst(TruncInst &I) {
3762 // Get the source and destination types
3763 Type *SrcTy = I.getOperand(0)->getType();
3764 Type *DestTy = I.getType();
3765
3766 // Get the size of the types in bits, we'll need this later
3767 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3768 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3769
3770 Check(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
3771 Check(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
3772 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3773 "trunc source and destination must both be a vector or neither", &I);
3774 Check(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
3775
3776 visitInstruction(I);
3777}
3778
3779void Verifier::visitZExtInst(ZExtInst &I) {
3780 // Get the source and destination types
3781 Type *SrcTy = I.getOperand(0)->getType();
3782 Type *DestTy = I.getType();
3783
3784 // Get the size of the types in bits, we'll need this later
3785 Check(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
3786 Check(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
3787 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3788 "zext source and destination must both be a vector or neither", &I);
3789 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3790 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3791
3792 Check(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
3793
3794 visitInstruction(I);
3795}
3796
3797void Verifier::visitSExtInst(SExtInst &I) {
3798 // Get the source and destination types
3799 Type *SrcTy = I.getOperand(0)->getType();
3800 Type *DestTy = I.getType();
3801
3802 // Get the size of the types in bits, we'll need this later
3803 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3804 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3805
3806 Check(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
3807 Check(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
3808 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3809 "sext source and destination must both be a vector or neither", &I);
3810 Check(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
3811
3812 visitInstruction(I);
3813}
3814
3815void Verifier::visitFPTruncInst(FPTruncInst &I) {
3816 // Get the source and destination types
3817 Type *SrcTy = I.getOperand(0)->getType();
3818 Type *DestTy = I.getType();
3819 // Get the size of the types in bits, we'll need this later
3820 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3821 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3822
3823 Check(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
3824 Check(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
3825 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3826 "fptrunc source and destination must both be a vector or neither", &I);
3827 Check(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
3828
3829 visitInstruction(I);
3830}
3831
3832void Verifier::visitFPExtInst(FPExtInst &I) {
3833 // Get the source and destination types
3834 Type *SrcTy = I.getOperand(0)->getType();
3835 Type *DestTy = I.getType();
3836
3837 // Get the size of the types in bits, we'll need this later
3838 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3839 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3840
3841 Check(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
3842 Check(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
3843 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3844 "fpext source and destination must both be a vector or neither", &I);
3845 Check(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
3846
3847 visitInstruction(I);
3848}
3849
3850void Verifier::visitUIToFPInst(UIToFPInst &I) {
3851 // Get the source and destination types
3852 Type *SrcTy = I.getOperand(0)->getType();
3853 Type *DestTy = I.getType();
3854
3855 bool SrcVec = SrcTy->isVectorTy();
3856 bool DstVec = DestTy->isVectorTy();
3857
3858 Check(SrcVec == DstVec,
3859 "UIToFP source and dest must both be vector or scalar", &I);
3860 Check(SrcTy->isIntOrIntVectorTy(),
3861 "UIToFP source must be integer or integer vector", &I);
3862 Check(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
3863 &I);
3864
3865 if (SrcVec && DstVec)
3866 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3867 cast<VectorType>(DestTy)->getElementCount(),
3868 "UIToFP source and dest vector length mismatch", &I);
3869
3870 visitInstruction(I);
3871}
3872
3873void Verifier::visitSIToFPInst(SIToFPInst &I) {
3874 // Get the source and destination types
3875 Type *SrcTy = I.getOperand(0)->getType();
3876 Type *DestTy = I.getType();
3877
3878 bool SrcVec = SrcTy->isVectorTy();
3879 bool DstVec = DestTy->isVectorTy();
3880
3881 Check(SrcVec == DstVec,
3882 "SIToFP source and dest must both be vector or scalar", &I);
3883 Check(SrcTy->isIntOrIntVectorTy(),
3884 "SIToFP source must be integer or integer vector", &I);
3885 Check(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
3886 &I);
3887
3888 if (SrcVec && DstVec)
3889 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3890 cast<VectorType>(DestTy)->getElementCount(),
3891 "SIToFP source and dest vector length mismatch", &I);
3892
3893 visitInstruction(I);
3894}
3895
3896void Verifier::visitFPToUIInst(FPToUIInst &I) {
3897 // Get the source and destination types
3898 Type *SrcTy = I.getOperand(0)->getType();
3899 Type *DestTy = I.getType();
3900
3901 bool SrcVec = SrcTy->isVectorTy();
3902 bool DstVec = DestTy->isVectorTy();
3903
3904 Check(SrcVec == DstVec,
3905 "FPToUI source and dest must both be vector or scalar", &I);
3906 Check(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector", &I);
3907 Check(DestTy->isIntOrIntVectorTy(),
3908 "FPToUI result must be integer or integer vector", &I);
3909
3910 if (SrcVec && DstVec)
3911 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3912 cast<VectorType>(DestTy)->getElementCount(),
3913 "FPToUI source and dest vector length mismatch", &I);
3914
3915 visitInstruction(I);
3916}
3917
3918void Verifier::visitFPToSIInst(FPToSIInst &I) {
3919 // Get the source and destination types
3920 Type *SrcTy = I.getOperand(0)->getType();
3921 Type *DestTy = I.getType();
3922
3923 bool SrcVec = SrcTy->isVectorTy();
3924 bool DstVec = DestTy->isVectorTy();
3925
3926 Check(SrcVec == DstVec,
3927 "FPToSI source and dest must both be vector or scalar", &I);
3928 Check(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector", &I);
3929 Check(DestTy->isIntOrIntVectorTy(),
3930 "FPToSI result must be integer or integer vector", &I);
3931
3932 if (SrcVec && DstVec)
3933 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3934 cast<VectorType>(DestTy)->getElementCount(),
3935 "FPToSI source and dest vector length mismatch", &I);
3936
3937 visitInstruction(I);
3938}
3939
3940void Verifier::checkPtrToAddr(Type *SrcTy, Type *DestTy, const Value &V) {
3941 Check(SrcTy->isPtrOrPtrVectorTy(), "PtrToAddr source must be pointer", V);
3942 Check(DestTy->isIntOrIntVectorTy(), "PtrToAddr result must be integral", V);
3943 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToAddr type mismatch",
3944 V);
3945
3946 if (SrcTy->isVectorTy()) {
3947 auto *VSrc = cast<VectorType>(SrcTy);
3948 auto *VDest = cast<VectorType>(DestTy);
3949 Check(VSrc->getElementCount() == VDest->getElementCount(),
3950 "PtrToAddr vector length mismatch", V);
3951 }
3952
3953 Type *AddrTy = DL.getAddressType(SrcTy);
3954 Check(AddrTy == DestTy, "PtrToAddr result must be address width", V);
3955}
3956
3957void Verifier::visitPtrToAddrInst(PtrToAddrInst &I) {
3958 checkPtrToAddr(I.getOperand(0)->getType(), I.getType(), I);
3959 visitInstruction(I);
3960}
3961
3962void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
3963 // Get the source and destination types
3964 Type *SrcTy = I.getOperand(0)->getType();
3965 Type *DestTy = I.getType();
3966
3967 Check(SrcTy->isPtrOrPtrVectorTy(), "PtrToInt source must be pointer", &I);
3968
3969 Check(DestTy->isIntOrIntVectorTy(), "PtrToInt result must be integral", &I);
3970 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
3971 &I);
3972
3973 if (SrcTy->isVectorTy()) {
3974 auto *VSrc = cast<VectorType>(SrcTy);
3975 auto *VDest = cast<VectorType>(DestTy);
3976 Check(VSrc->getElementCount() == VDest->getElementCount(),
3977 "PtrToInt Vector length mismatch", &I);
3978 }
3979
3980 visitInstruction(I);
3981}
3982
3983void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
3984 // Get the source and destination types
3985 Type *SrcTy = I.getOperand(0)->getType();
3986 Type *DestTy = I.getType();
3987
3988 Check(SrcTy->isIntOrIntVectorTy(), "IntToPtr source must be an integral", &I);
3989 Check(DestTy->isPtrOrPtrVectorTy(), "IntToPtr result must be a pointer", &I);
3990
3991 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
3992 &I);
3993 if (SrcTy->isVectorTy()) {
3994 auto *VSrc = cast<VectorType>(SrcTy);
3995 auto *VDest = cast<VectorType>(DestTy);
3996 Check(VSrc->getElementCount() == VDest->getElementCount(),
3997 "IntToPtr Vector length mismatch", &I);
3998 }
3999 visitInstruction(I);
4000}
4001
4002void Verifier::visitBitCastInst(BitCastInst &I) {
4003 Check(
4004 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
4005 "Invalid bitcast", &I);
4006 Check(DL.getTypeSizeInBits(I.getSrcTy()) ==
4007 DL.getTypeSizeInBits(I.getDestTy()),
4008 "Invalid bitcast", &I);
4009 visitInstruction(I);
4010}
4011
4012void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
4013 Type *SrcTy = I.getOperand(0)->getType();
4014 Type *DestTy = I.getType();
4015
4016 Check(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
4017 &I);
4018 Check(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
4019 &I);
4021 "AddrSpaceCast must be between different address spaces", &I);
4022 if (auto *SrcVTy = dyn_cast<VectorType>(SrcTy))
4023 Check(SrcVTy->getElementCount() ==
4024 cast<VectorType>(DestTy)->getElementCount(),
4025 "AddrSpaceCast vector pointer number of elements mismatch", &I);
4026 visitInstruction(I);
4027}
4028
4029/// visitPHINode - Ensure that a PHI node is well formed.
4030///
4031void Verifier::visitPHINode(PHINode &PN) {
4032 // Ensure that the PHI nodes are all grouped together at the top of the block.
4033 // This can be tested by checking whether the instruction before this is
4034 // either nonexistent (because this is begin()) or is a PHI node. If not,
4035 // then there is some other instruction before a PHI.
4036 Check(&PN == &PN.getParent()->front() ||
4038 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
4039
4040 // Check that a PHI doesn't yield a Token.
4041 Check(!PN.getType()->isTokenLikeTy(), "PHI nodes cannot have token type!");
4042
4043 // Check that all of the values of the PHI node have the same type as the
4044 // result.
4045 for (Value *IncValue : PN.incoming_values()) {
4046 Check(PN.getType() == IncValue->getType(),
4047 "PHI node operands are not the same type as the result!", &PN);
4048 }
4049
4050 // All other PHI node constraints are checked in the visitBasicBlock method.
4051
4052 visitInstruction(PN);
4053}
4054
4055void Verifier::visitCallBase(CallBase &Call) {
4057 "Called function must be a pointer!", Call);
4058 FunctionType *FTy = Call.getFunctionType();
4059
4060 // Verify that the correct number of arguments are being passed
4061 if (FTy->isVarArg())
4062 Check(Call.arg_size() >= FTy->getNumParams(),
4063 "Called function requires more parameters than were provided!", Call);
4064 else
4065 Check(Call.arg_size() == FTy->getNumParams(),
4066 "Incorrect number of arguments passed to called function!", Call);
4067
4068 // Verify that all arguments to the call match the function type.
4069 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
4070 Check(Call.getArgOperand(i)->getType() == FTy->getParamType(i),
4071 "Call parameter type does not match function signature!",
4072 Call.getArgOperand(i), FTy->getParamType(i), Call);
4073
4074 AttributeList Attrs = Call.getAttributes();
4075
4076 Check(verifyAttributeCount(Attrs, Call.arg_size()),
4077 "Attribute after last parameter!", Call);
4078
4079 auto *Callee =
4081 bool IsIntrinsic = Callee && Callee->isIntrinsic();
4082 if (IsIntrinsic)
4083 Check(Callee->getFunctionType() == FTy,
4084 "Intrinsic called with incompatible signature", Call);
4085
4086 // Verify if the calling convention of the callee is callable.
4088 "calling convention does not permit calls", Call);
4089
4090 // Disallow passing/returning values with alignment higher than we can
4091 // represent.
4092 // FIXME: Consider making DataLayout cap the alignment, so this isn't
4093 // necessary.
4094 auto VerifyTypeAlign = [&](Type *Ty, const Twine &Message) {
4095 if (!Ty->isSized())
4096 return;
4097 Align ABIAlign = DL.getABITypeAlign(Ty);
4098 Check(ABIAlign.value() <= Value::MaximumAlignment,
4099 "Incorrect alignment of " + Message + " to called function!", Call);
4100 };
4101
4102 if (!IsIntrinsic) {
4103 VerifyTypeAlign(FTy->getReturnType(), "return type");
4104 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
4105 Type *Ty = FTy->getParamType(i);
4106 VerifyTypeAlign(Ty, "argument passed");
4107 }
4108 }
4109
4110 if (Attrs.hasFnAttr(Attribute::Speculatable)) {
4111 // Don't allow speculatable on call sites, unless the underlying function
4112 // declaration is also speculatable.
4113 Check(Callee && Callee->isSpeculatable(),
4114 "speculatable attribute may not apply to call sites", Call);
4115 }
4116
4117 if (Attrs.hasFnAttr(Attribute::Preallocated)) {
4118 Check(Call.getIntrinsicID() == Intrinsic::call_preallocated_arg,
4119 "preallocated as a call site attribute can only be on "
4120 "llvm.call.preallocated.arg");
4121 }
4122
4123 Check(!Attrs.hasFnAttr(Attribute::DenormalFPEnv),
4124 "denormal_fpenv attribute may not apply to call sites", Call);
4125
4126 // Verify call attributes.
4127 verifyFunctionAttrs(FTy, Attrs, &Call, IsIntrinsic, Call.isInlineAsm());
4128
4129 // Conservatively check the inalloca argument.
4130 // We have a bug if we can find that there is an underlying alloca without
4131 // inalloca.
4132 if (Call.hasInAllocaArgument()) {
4133 Value *InAllocaArg = Call.getArgOperand(FTy->getNumParams() - 1);
4134 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
4135 Check(AI->isUsedWithInAlloca(),
4136 "inalloca argument for call has mismatched alloca", AI, Call);
4137 }
4138
4139 // For each argument of the callsite, if it has the swifterror argument,
4140 // make sure the underlying alloca/parameter it comes from has a swifterror as
4141 // well.
4142 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
4143 if (Call.paramHasAttr(i, Attribute::SwiftError)) {
4144 Value *SwiftErrorArg = Call.getArgOperand(i);
4145 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
4146 Check(AI->isSwiftError(),
4147 "swifterror argument for call has mismatched alloca", AI, Call);
4148 continue;
4149 }
4150 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
4151 Check(ArgI, "swifterror argument should come from an alloca or parameter",
4152 SwiftErrorArg, Call);
4153 Check(ArgI->hasSwiftErrorAttr(),
4154 "swifterror argument for call has mismatched parameter", ArgI,
4155 Call);
4156 }
4157
4158 if (Attrs.hasParamAttr(i, Attribute::ImmArg)) {
4159 // Don't allow immarg on call sites, unless the underlying declaration
4160 // also has the matching immarg.
4161 Check(Callee && Callee->hasParamAttribute(i, Attribute::ImmArg),
4162 "immarg may not apply only to call sites", Call.getArgOperand(i),
4163 Call);
4164 }
4165
4166 if (Call.paramHasAttr(i, Attribute::ImmArg)) {
4167 Value *ArgVal = Call.getArgOperand(i);
4168 Check((isa<ConstantInt>(ArgVal) || isa<ConstantFP>(ArgVal)) &&
4169 !isa<VectorType>(ArgVal->getType()),
4170 "immarg operand has non-immediate parameter", ArgVal, Call);
4171
4172 // If the imm-arg is an integer and also has a range attached,
4173 // check if the given value is within the range.
4174 if (Call.paramHasAttr(i, Attribute::Range)) {
4175 if (auto *CI = dyn_cast<ConstantInt>(ArgVal)) {
4176 const ConstantRange &CR =
4177 Call.getParamAttr(i, Attribute::Range).getValueAsConstantRange();
4178 Check(CR.contains(CI->getValue()),
4179 formatv("immarg value {} for arg {} out of range {}",
4180 CI->getValue(), i, CR),
4181 Call);
4182 }
4183 }
4184 if (auto *CI = dyn_cast<ConstantInt>(ArgVal))
4186 CI->getValue()),
4187 formatv("immarg value {} for arg {} out of range set",
4188 CI->getValue(), i),
4189 Call);
4190 }
4191
4192 if (Call.paramHasAttr(i, Attribute::Preallocated)) {
4193 Value *ArgVal = Call.getArgOperand(i);
4194 bool hasOB =
4196 bool isMustTail = Call.isMustTailCall();
4197 Check(hasOB != isMustTail,
4198 "preallocated operand either requires a preallocated bundle or "
4199 "the call to be musttail (but not both)",
4200 ArgVal, Call);
4201 }
4202 }
4203
4204 if (FTy->isVarArg()) {
4205 // FIXME? is 'nest' even legal here?
4206 bool SawNest = false;
4207 bool SawReturned = false;
4208
4209 for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) {
4210 if (Attrs.hasParamAttr(Idx, Attribute::Nest))
4211 SawNest = true;
4212 if (Attrs.hasParamAttr(Idx, Attribute::Returned))
4213 SawReturned = true;
4214 }
4215
4216 // Check attributes on the varargs part.
4217 for (unsigned Idx = FTy->getNumParams(); Idx < Call.arg_size(); ++Idx) {
4218 Type *Ty = Call.getArgOperand(Idx)->getType();
4219 AttributeSet ArgAttrs = Attrs.getParamAttrs(Idx);
4220 verifyParameterAttrs(ArgAttrs, Ty, &Call);
4221
4222 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
4223 Check(!SawNest, "More than one parameter has attribute nest!", Call);
4224 SawNest = true;
4225 }
4226
4227 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
4228 Check(!SawReturned, "More than one parameter has attribute returned!",
4229 Call);
4230 Check(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
4231 "Incompatible argument and return types for 'returned' "
4232 "attribute",
4233 Call);
4234 SawReturned = true;
4235 }
4236
4237 // Statepoint intrinsic is vararg but the wrapped function may be not.
4238 // Allow sret here and check the wrapped function in verifyStatepoint.
4239 if (Call.getIntrinsicID() != Intrinsic::experimental_gc_statepoint)
4240 Check(!ArgAttrs.hasAttribute(Attribute::StructRet),
4241 "Attribute 'sret' cannot be used for vararg call arguments!",
4242 Call);
4243
4244 if (ArgAttrs.hasAttribute(Attribute::InAlloca))
4245 Check(Idx == Call.arg_size() - 1,
4246 "inalloca isn't on the last argument!", Call);
4247 }
4248 }
4249
4250 // Verify that there's no metadata unless it's a direct call to an intrinsic.
4251 if (!IsIntrinsic) {
4252 for (Type *ParamTy : FTy->params()) {
4253 Check(!ParamTy->isMetadataTy(),
4254 "Function has metadata parameter but isn't an intrinsic", Call);
4255 Check(!ParamTy->isTokenLikeTy(),
4256 "Function has token parameter but isn't an intrinsic", Call);
4257 }
4258 }
4259
4260 // Verify that indirect calls don't return tokens.
4261 if (!Call.getCalledFunction()) {
4262 Check(!FTy->getReturnType()->isTokenLikeTy(),
4263 "Return type cannot be token for indirect call!");
4264 Check(!FTy->getReturnType()->isX86_AMXTy(),
4265 "Return type cannot be x86_amx for indirect call!");
4266 }
4267
4269 visitIntrinsicCall(ID, Call);
4270
4271 // Verify that a callsite has at most one "deopt", at most one "funclet", at
4272 // most one "gc-transition", at most one "cfguardtarget", at most one
4273 // "preallocated" operand bundle, and at most one "ptrauth" operand bundle.
4274 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
4275 FoundGCTransitionBundle = false, FoundCFGuardTargetBundle = false,
4276 FoundPreallocatedBundle = false, FoundGCLiveBundle = false,
4277 FoundPtrauthBundle = false, FoundKCFIBundle = false,
4278 FoundAttachedCallBundle = false;
4279 for (unsigned i = 0, e = Call.getNumOperandBundles(); i < e; ++i) {
4280 OperandBundleUse BU = Call.getOperandBundleAt(i);
4281 for (const Value *Input : BU.Inputs)
4282 Check(!Input->getType()->isLabelTy(),
4283 "Operand bundle operands cannot be labels", Call);
4284 uint32_t Tag = BU.getTagID();
4285 if (Tag == LLVMContext::OB_deopt) {
4286 Check(!FoundDeoptBundle, "Multiple deopt operand bundles", Call);
4287 FoundDeoptBundle = true;
4288 } else if (Tag == LLVMContext::OB_gc_transition) {
4289 Check(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
4290 Call);
4291 FoundGCTransitionBundle = true;
4292 } else if (Tag == LLVMContext::OB_funclet) {
4293 Check(!FoundFuncletBundle, "Multiple funclet operand bundles", Call);
4294 FoundFuncletBundle = true;
4295 Check(BU.Inputs.size() == 1,
4296 "Expected exactly one funclet bundle operand", Call);
4297 Check(isa<FuncletPadInst>(BU.Inputs.front()),
4298 "Funclet bundle operands should correspond to a FuncletPadInst",
4299 Call);
4300 } else if (Tag == LLVMContext::OB_cfguardtarget) {
4301 Check(!FoundCFGuardTargetBundle, "Multiple CFGuardTarget operand bundles",
4302 Call);
4303 FoundCFGuardTargetBundle = true;
4304 Check(BU.Inputs.size() == 1,
4305 "Expected exactly one cfguardtarget bundle operand", Call);
4306 } else if (Tag == LLVMContext::OB_ptrauth) {
4307 Check(!FoundPtrauthBundle, "Multiple ptrauth operand bundles", Call);
4308 FoundPtrauthBundle = true;
4309 Check(BU.Inputs.size() == 2,
4310 "Expected exactly two ptrauth bundle operands", Call);
4311 Check(isa<ConstantInt>(BU.Inputs[0]) &&
4312 BU.Inputs[0]->getType()->isIntegerTy(32),
4313 "Ptrauth bundle key operand must be an i32 constant", Call);
4314 Check(BU.Inputs[1]->getType()->isIntegerTy(64),
4315 "Ptrauth bundle discriminator operand must be an i64", Call);
4316 } else if (Tag == LLVMContext::OB_kcfi) {
4317 Check(!FoundKCFIBundle, "Multiple kcfi operand bundles", Call);
4318 FoundKCFIBundle = true;
4319 Check(BU.Inputs.size() == 1, "Expected exactly one kcfi bundle operand",
4320 Call);
4321 Check(isa<ConstantInt>(BU.Inputs[0]) &&
4322 BU.Inputs[0]->getType()->isIntegerTy(32),
4323 "Kcfi bundle operand must be an i32 constant", Call);
4324 } else if (Tag == LLVMContext::OB_preallocated) {
4325 Check(!FoundPreallocatedBundle, "Multiple preallocated operand bundles",
4326 Call);
4327 FoundPreallocatedBundle = true;
4328 Check(BU.Inputs.size() == 1,
4329 "Expected exactly one preallocated bundle operand", Call);
4330 auto Input = dyn_cast<IntrinsicInst>(BU.Inputs.front());
4331 Check(Input &&
4332 Input->getIntrinsicID() == Intrinsic::call_preallocated_setup,
4333 "\"preallocated\" argument must be a token from "
4334 "llvm.call.preallocated.setup",
4335 Call);
4336 } else if (Tag == LLVMContext::OB_gc_live) {
4337 Check(!FoundGCLiveBundle, "Multiple gc-live operand bundles", Call);
4338 FoundGCLiveBundle = true;
4340 Check(!FoundAttachedCallBundle,
4341 "Multiple \"clang.arc.attachedcall\" operand bundles", Call);
4342 FoundAttachedCallBundle = true;
4343 verifyAttachedCallBundle(Call, BU);
4344 }
4345 }
4346
4347 // Verify that callee and callsite agree on whether to use pointer auth.
4348 Check(!(Call.getCalledFunction() && FoundPtrauthBundle),
4349 "Direct call cannot have a ptrauth bundle", Call);
4350
4351 // Verify that each inlinable callsite of a debug-info-bearing function in a
4352 // debug-info-bearing function has a debug location attached to it. Failure to
4353 // do so causes assertion failures when the inliner sets up inline scope info
4354 // (Interposable functions are not inlinable, neither are functions without
4355 // definitions. noipa does not prevent inlining, so it is ignored here.)
4357 !Call.getCalledFunction()->isInterposable(/*CheckNoIPA=*/false) &&
4361 "inlinable function call in a function with "
4362 "debug info must have a !dbg location",
4363 Call);
4364
4365 if (Call.isInlineAsm())
4366 verifyInlineAsmCall(Call);
4367
4368 ConvergenceVerifyHelper.visit(Call);
4369
4370 visitInstruction(Call);
4371}
4372
4373void Verifier::verifyTailCCMustTailAttrs(const AttrBuilder &Attrs,
4374 StringRef Context) {
4375 Check(!Attrs.contains(Attribute::InAlloca),
4376 Twine("inalloca attribute not allowed in ") + Context);
4377 Check(!Attrs.contains(Attribute::InReg),
4378 Twine("inreg attribute not allowed in ") + Context);
4379 Check(!Attrs.contains(Attribute::SwiftError),
4380 Twine("swifterror attribute not allowed in ") + Context);
4381 Check(!Attrs.contains(Attribute::Preallocated),
4382 Twine("preallocated attribute not allowed in ") + Context);
4383 Check(!Attrs.contains(Attribute::ByRef),
4384 Twine("byref attribute not allowed in ") + Context);
4385}
4386
4387static AttrBuilder getParameterABIAttributes(LLVMContext& C, unsigned I, AttributeList Attrs) {
4388 static const Attribute::AttrKind ABIAttrs[] = {
4389 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
4390 Attribute::InReg, Attribute::StackAlignment, Attribute::SwiftSelf,
4391 Attribute::SwiftAsync, Attribute::SwiftError, Attribute::Preallocated,
4392 Attribute::ByRef};
4393 AttrBuilder Copy(C);
4394 for (auto AK : ABIAttrs) {
4395 Attribute Attr = Attrs.getParamAttrs(I).getAttribute(AK);
4396 if (Attr.isValid())
4397 Copy.addAttribute(Attr);
4398 }
4399
4400 // `align` is ABI-affecting only in combination with `byval` or `byref`.
4401 if (Attrs.hasParamAttr(I, Attribute::Alignment) &&
4402 (Attrs.hasParamAttr(I, Attribute::ByVal) ||
4403 Attrs.hasParamAttr(I, Attribute::ByRef)))
4404 Copy.addAlignmentAttr(Attrs.getParamAlignment(I));
4405 return Copy;
4406}
4407
4408void Verifier::verifyMustTailCall(CallInst &CI) {
4409 Check(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
4410
4411 Function *F = CI.getParent()->getParent();
4412 FunctionType *CallerTy = F->getFunctionType();
4413 FunctionType *CalleeTy = CI.getFunctionType();
4414 Check(CallerTy->isVarArg() == CalleeTy->isVarArg(),
4415 "cannot guarantee tail call due to mismatched varargs", &CI);
4416 Check(CallerTy->getReturnType() == CalleeTy->getReturnType(),
4417 "cannot guarantee tail call due to mismatched return types", &CI);
4418
4419 // - The calling conventions of the caller and callee must match.
4420 Check(F->getCallingConv() == CI.getCallingConv(),
4421 "cannot guarantee tail call due to mismatched calling conv", &CI);
4422
4423 // - The call must immediately precede a :ref:`ret <i_ret>` instruction.
4424 // - The ret instruction must return the value produced by the call or void.
4426
4427 // Check the return.
4428 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
4429 Check(Ret, "musttail call must precede a ret", &CI);
4430 Check(!Ret->getReturnValue() || Ret->getReturnValue() == &CI ||
4432 "musttail call result must be returned", Ret);
4433
4434 AttributeList CallerAttrs = F->getAttributes();
4435 AttributeList CalleeAttrs = CI.getAttributes();
4436 if (CI.getCallingConv() == CallingConv::SwiftTail ||
4437 CI.getCallingConv() == CallingConv::Tail) {
4438 StringRef CCName =
4439 CI.getCallingConv() == CallingConv::Tail ? "tailcc" : "swifttailcc";
4440
4441 // - Only sret, byval, swiftself, and swiftasync ABI-impacting attributes
4442 // are allowed in swifttailcc call
4443 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4444 AttrBuilder ABIAttrs = getParameterABIAttributes(F->getContext(), I, CallerAttrs);
4445 SmallString<32> Context{CCName, StringRef(" musttail caller")};
4446 verifyTailCCMustTailAttrs(ABIAttrs, Context);
4447 }
4448 for (unsigned I = 0, E = CalleeTy->getNumParams(); I != E; ++I) {
4449 AttrBuilder ABIAttrs = getParameterABIAttributes(F->getContext(), I, CalleeAttrs);
4450 SmallString<32> Context{CCName, StringRef(" musttail callee")};
4451 verifyTailCCMustTailAttrs(ABIAttrs, Context);
4452 }
4453 // - Varargs functions are not allowed
4454 Check(!CallerTy->isVarArg(), Twine("cannot guarantee ") + CCName +
4455 " tail call for varargs function");
4456 return;
4457 }
4458
4459 // - The caller and callee prototypes must match.
4460 if (!CI.getIntrinsicID()) {
4461 Check(CallerTy->getNumParams() == CalleeTy->getNumParams(),
4462 "cannot guarantee tail call due to mismatched parameter counts", &CI);
4463 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4464 Check(CallerTy->getParamType(I) == CalleeTy->getParamType(I),
4465 "cannot guarantee tail call due to mismatched parameter types",
4466 &CI);
4467 }
4468 }
4469
4470 // - All ABI-impacting function attributes, such as sret, byval, inreg,
4471 // returned, preallocated, and inalloca, must match.
4472 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4473 AttrBuilder CallerABIAttrs = getParameterABIAttributes(F->getContext(), I, CallerAttrs);
4474 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(F->getContext(), I, CalleeAttrs);
4475 Check(CallerABIAttrs == CalleeABIAttrs,
4476 "cannot guarantee tail call due to mismatched ABI impacting "
4477 "function attributes",
4478 &CI, CI.getOperand(I));
4479 }
4480}
4481
4482void Verifier::visitCallInst(CallInst &CI) {
4483 visitCallBase(CI);
4484
4485 if (CI.isMustTailCall())
4486 verifyMustTailCall(CI);
4487}
4488
4489void Verifier::visitInvokeInst(InvokeInst &II) {
4490 visitCallBase(II);
4491
4492 // Verify that the first non-PHI instruction of the unwind destination is an
4493 // exception handling instruction.
4494 Check(
4495 II.getUnwindDest()->isEHPad(),
4496 "The unwind destination does not have an exception handling instruction!",
4497 &II);
4498
4499 visitTerminator(II);
4500}
4501
4502/// visitUnaryOperator - Check the argument to the unary operator.
4503///
4504void Verifier::visitUnaryOperator(UnaryOperator &U) {
4505 Check(U.getType() == U.getOperand(0)->getType(),
4506 "Unary operators must have same type for"
4507 "operands and result!",
4508 &U);
4509
4510 switch (U.getOpcode()) {
4511 // Check that floating-point arithmetic operators are only used with
4512 // floating-point operands.
4513 case Instruction::FNeg:
4514 Check(U.getType()->isFPOrFPVectorTy(),
4515 "FNeg operator only works with float types!", &U);
4516 break;
4517 default:
4518 llvm_unreachable("Unknown UnaryOperator opcode!");
4519 }
4520
4521 visitInstruction(U);
4522}
4523
4524/// visitBinaryOperator - Check that both arguments to the binary operator are
4525/// of the same type!
4526///
4527void Verifier::visitBinaryOperator(BinaryOperator &B) {
4528 Check(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
4529 "Both operands to a binary operator are not of the same type!", &B);
4530
4531 switch (B.getOpcode()) {
4532 // Check that integer arithmetic operators are only used with
4533 // integral operands.
4534 case Instruction::Add:
4535 case Instruction::Sub:
4536 case Instruction::Mul:
4537 case Instruction::SDiv:
4538 case Instruction::UDiv:
4539 case Instruction::SRem:
4540 case Instruction::URem:
4541 Check(B.getType()->isIntOrIntVectorTy(),
4542 "Integer arithmetic operators only work with integral types!", &B);
4543 Check(B.getType() == B.getOperand(0)->getType(),
4544 "Integer arithmetic operators must have same type "
4545 "for operands and result!",
4546 &B);
4547 break;
4548 // Check that floating-point arithmetic operators are only used with
4549 // floating-point operands.
4550 case Instruction::FAdd:
4551 case Instruction::FSub:
4552 case Instruction::FMul:
4553 case Instruction::FDiv:
4554 case Instruction::FRem:
4555 Check(B.getType()->isFPOrFPVectorTy(),
4556 "Floating-point arithmetic operators only work with "
4557 "floating-point types!",
4558 &B);
4559 Check(B.getType() == B.getOperand(0)->getType(),
4560 "Floating-point arithmetic operators must have same type "
4561 "for operands and result!",
4562 &B);
4563 break;
4564 // Check that logical operators are only used with integral operands.
4565 case Instruction::And:
4566 case Instruction::Or:
4567 case Instruction::Xor:
4568 Check(B.getType()->isIntOrIntVectorTy(),
4569 "Logical operators only work with integral types!", &B);
4570 Check(B.getType() == B.getOperand(0)->getType(),
4571 "Logical operators must have same type for operands and result!", &B);
4572 break;
4573 case Instruction::Shl:
4574 case Instruction::LShr:
4575 case Instruction::AShr:
4576 Check(B.getType()->isIntOrIntVectorTy(),
4577 "Shifts only work with integral types!", &B);
4578 Check(B.getType() == B.getOperand(0)->getType(),
4579 "Shift return type must be same as operands!", &B);
4580 break;
4581 default:
4582 llvm_unreachable("Unknown BinaryOperator opcode!");
4583 }
4584
4585 visitInstruction(B);
4586}
4587
4588void Verifier::visitICmpInst(ICmpInst &IC) {
4589 // Check that the operands are the same type
4590 Type *Op0Ty = IC.getOperand(0)->getType();
4591 Type *Op1Ty = IC.getOperand(1)->getType();
4592 Check(Op0Ty == Op1Ty,
4593 "Both operands to ICmp instruction are not of the same type!", &IC);
4594 // Check that the operands are the right type
4595 Check(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPtrOrPtrVectorTy(),
4596 "Invalid operand types for ICmp instruction", &IC);
4597 // Check that the predicate is valid.
4598 Check(IC.isIntPredicate(), "Invalid predicate in ICmp instruction!", &IC);
4599
4600 visitInstruction(IC);
4601}
4602
4603void Verifier::visitFCmpInst(FCmpInst &FC) {
4604 // Check that the operands are the same type
4605 Type *Op0Ty = FC.getOperand(0)->getType();
4606 Type *Op1Ty = FC.getOperand(1)->getType();
4607 Check(Op0Ty == Op1Ty,
4608 "Both operands to FCmp instruction are not of the same type!", &FC);
4609 // Check that the operands are the right type
4610 Check(Op0Ty->isFPOrFPVectorTy(), "Invalid operand types for FCmp instruction",
4611 &FC);
4612 // Check that the predicate is valid.
4613 Check(FC.isFPPredicate(), "Invalid predicate in FCmp instruction!", &FC);
4614
4615 visitInstruction(FC);
4616}
4617
4618void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
4620 "Invalid extractelement operands!", &EI);
4621 visitInstruction(EI);
4622}
4623
4624void Verifier::visitInsertElementInst(InsertElementInst &IE) {
4625 Check(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
4626 IE.getOperand(2)),
4627 "Invalid insertelement operands!", &IE);
4628 visitInstruction(IE);
4629}
4630
4631void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
4632 Check(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
4633 SV.getShuffleMask()),
4634 "Invalid shufflevector operands!", &SV);
4635 visitInstruction(SV);
4636}
4637
4638void Verifier::visitBitInsertInst(BitInsertInst &BII) {
4639 if (const char *Reason = BitInsertInst::areInvalidOperands(
4640 BII.getOperand(0), BII.getOperand(1), BII.getOperand(2)))
4641 Check(false, Reason, &BII);
4642 Check(DL.getTypeSizeInBits(BII.getOperand(0)->getType()) >=
4643 DL.getTypeSizeInBits(BII.getOperand(1)->getType()),
4644 "bitinsert val type cannot be wider than base type!", &BII);
4645 visitInstruction(BII);
4646}
4647
4648void Verifier::visitBitExtractInst(BitExtractInst &BEI) {
4649 if (const char *Reason = BitExtractInst::areInvalidOperands(
4650 BEI.getType(), BEI.getOperand(0), BEI.getOperand(1)))
4651 Check(false, Reason, &BEI);
4652 Check(DL.getTypeSizeInBits(BEI.getType()) <=
4653 DL.getTypeSizeInBits(BEI.getOperand(0)->getType()),
4654 "bitextract result type cannot be wider than source type!", &BEI);
4655 visitInstruction(BEI);
4656}
4657
4658void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
4660 GEP.getModule()->getModuleFlag("require-logical-pointer")))
4661 Check(!MD->getZExtValue(),
4662 "Non-logical getelementptr disallowed for this module.");
4663
4664 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
4665
4666 Check(isa<PointerType>(TargetTy),
4667 "GEP base pointer is not a vector or a vector of pointers", &GEP);
4668 Check(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
4669
4670 if (auto *STy = dyn_cast<StructType>(GEP.getSourceElementType())) {
4671 Check(!STy->isScalableTy(),
4672 "getelementptr cannot target structure that contains scalable vector"
4673 "type",
4674 &GEP);
4675 }
4676
4677 SmallVector<Value *, 16> Idxs(GEP.indices());
4678 Check(
4679 all_of(Idxs, [](Value *V) { return V->getType()->isIntOrIntVectorTy(); }),
4680 "GEP indexes must be integers", &GEP);
4681 Type *ElTy =
4682 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
4683 Check(ElTy, "Invalid indices for GEP pointer type!", &GEP);
4684
4685 auto *PtrTy = dyn_cast<PointerType>(GEP.getType()->getScalarType());
4686
4687 Check(PtrTy && GEP.getResultElementType() == ElTy,
4688 "GEP is not of right type for indices!", &GEP, ElTy);
4689
4690 if (auto *GEPVTy = dyn_cast<VectorType>(GEP.getType())) {
4691 // Additional checks for vector GEPs.
4692 ElementCount GEPWidth = GEPVTy->getElementCount();
4693 if (GEP.getPointerOperandType()->isVectorTy())
4694 Check(
4695 GEPWidth ==
4696 cast<VectorType>(GEP.getPointerOperandType())->getElementCount(),
4697 "Vector GEP result width doesn't match operand's", &GEP);
4698 for (Value *Idx : Idxs) {
4699 Type *IndexTy = Idx->getType();
4700 if (auto *IndexVTy = dyn_cast<VectorType>(IndexTy)) {
4701 ElementCount IndexWidth = IndexVTy->getElementCount();
4702 Check(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
4703 }
4704 Check(IndexTy->isIntOrIntVectorTy(),
4705 "All GEP indices should be of integer type");
4706 }
4707 }
4708
4709 // Check that GEP does not index into a vector with non-byte-addressable
4710 // elements.
4712 GTI != GTE; ++GTI) {
4713 if (GTI.isVector()) {
4714 Type *ElemTy = GTI.getIndexedType();
4715 Check(DL.typeSizeEqualsStoreSize(ElemTy),
4716 "GEP into vector with non-byte-addressable element type", &GEP);
4717 }
4718 }
4719
4720 Check(GEP.getAddressSpace() == PtrTy->getAddressSpace(),
4721 "GEP address space doesn't match type", &GEP);
4722
4723 visitInstruction(GEP);
4724}
4725
4726static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
4727 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
4728}
4729
4730/// Verify !range and !absolute_symbol metadata. These have the same
4731/// restrictions, except !absolute_symbol allows the full set.
4732void Verifier::verifyRangeLikeMetadata(const Value &I, const MDNode *Range,
4733 Type *Ty, RangeLikeMetadataKind Kind) {
4734 unsigned NumOperands = Range->getNumOperands();
4735 Check(NumOperands % 2 == 0, "Unfinished range!", Range);
4736 unsigned NumRanges = NumOperands / 2;
4737 Check(NumRanges >= 1, "It should have at least one range!", Range);
4738
4739 ConstantRange LastRange(1, true); // Dummy initial value
4740 for (unsigned i = 0; i < NumRanges; ++i) {
4741 ConstantInt *Low =
4742 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
4743 Check(Low, "The lower limit must be an integer!", Low);
4744 ConstantInt *High =
4745 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
4746 Check(High, "The upper limit must be an integer!", High);
4747
4748 Check(High->getType() == Low->getType(), "Range pair types must match!",
4749 &I);
4750
4751 if (Kind == RangeLikeMetadataKind::NoaliasAddrspace) {
4752 Check(High->getType()->isIntegerTy(32),
4753 "noalias.addrspace type must be i32!", &I);
4754 } else {
4755 Check(High->getType() == Ty->getScalarType(),
4756 "Range types must match instruction type!", &I);
4757 }
4758
4759 APInt HighV = High->getValue();
4760 APInt LowV = Low->getValue();
4761
4762 // ConstantRange asserts if the ranges are the same except for the min/max
4763 // value. Leave the cases it tolerates for the empty range error below.
4764 Check(LowV != HighV || LowV.isMaxValue() || LowV.isMinValue(),
4765 "The upper and lower limits cannot be the same value", &I);
4766
4767 ConstantRange CurRange(LowV, HighV);
4768 Check(!CurRange.isEmptySet() &&
4769 (Kind == RangeLikeMetadataKind::AbsoluteSymbol ||
4770 !CurRange.isFullSet()),
4771 "Range must not be empty!", Range);
4772 if (i != 0) {
4773 Check(CurRange.intersectWith(LastRange).isEmptySet(),
4774 "Intervals are overlapping", Range);
4775 Check(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
4776 Range);
4777 Check(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
4778 Range);
4779 }
4780 LastRange = ConstantRange(LowV, HighV);
4781 }
4782 if (NumRanges > 2) {
4783 APInt FirstLow =
4784 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
4785 APInt FirstHigh =
4786 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
4787 ConstantRange FirstRange(FirstLow, FirstHigh);
4788 Check(FirstRange.intersectWith(LastRange).isEmptySet(),
4789 "Intervals are overlapping", Range);
4790 Check(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
4791 Range);
4792 }
4793}
4794
4795void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
4796 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
4797 "precondition violation");
4798 verifyRangeLikeMetadata(I, Range, Ty, RangeLikeMetadataKind::Range);
4799}
4800
4801void Verifier::visitNoFPClassMetadata(Instruction &I, MDNode *NoFPClass,
4802 Type *Ty) {
4803 Check(AttributeFuncs::isNoFPClassCompatibleType(Ty),
4804 "nofpclass only applies to floating-point typed loads", I);
4805
4806 Check(NoFPClass->getNumOperands() == 1,
4807 "nofpclass must have exactly one entry", NoFPClass);
4808 ConstantInt *MaskVal =
4810 Check(MaskVal && MaskVal->getType()->isIntegerTy(32),
4811 "nofpclass entry must be a constant i32", NoFPClass);
4812 uint32_t Val = MaskVal->getZExtValue();
4813 Check(Val != 0, "'nofpclass' must have at least one test bit set", NoFPClass,
4814 I);
4815
4816 Check((Val & ~static_cast<unsigned>(fcAllFlags)) == 0,
4817 "Invalid value for 'nofpclass' test mask", NoFPClass, I);
4818}
4819
4820void Verifier::visitNoaliasAddrspaceMetadata(Instruction &I, MDNode *Range,
4821 Type *Ty) {
4822 assert(Range && Range == I.getMetadata(LLVMContext::MD_noalias_addrspace) &&
4823 "precondition violation");
4824 verifyRangeLikeMetadata(I, Range, Ty,
4825 RangeLikeMetadataKind::NoaliasAddrspace);
4826}
4827
4828void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
4829 unsigned Size = DL.getTypeSizeInBits(Ty).getFixedValue();
4830 Check(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
4831 Check(!(Size & (Size - 1)),
4832 "atomic memory access' operand must have a power-of-two size", Ty, I);
4833}
4834
4835void Verifier::visitLoadInst(LoadInst &LI) {
4836 auto *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
4837 Check(PTy, "Load operand must be a pointer.", &LI);
4838 Type *ElTy = LI.getType();
4839 if (MaybeAlign A = LI.getAlign()) {
4840 Check(A->value() <= Value::MaximumAlignment,
4841 "huge alignment values are unsupported", &LI);
4842 }
4843 Check(ElTy->isSized(), "loading unsized types is not allowed", &LI);
4844 if (LI.isAtomic()) {
4845 Check(LI.getOrdering() != AtomicOrdering::Release &&
4846 LI.getOrdering() != AtomicOrdering::AcquireRelease,
4847 "Load cannot have Release ordering", &LI);
4848
4849 if (LI.isElementwise()) {
4850 Check(LI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4851 "atomic elementwise load cannot be sequentially consistent.", &LI);
4852 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
4853 Check(VecTy,
4854 "atomic elementwise load operand must have fixed vector type!", &LI,
4855 ElTy);
4856 if (VecTy)
4857 checkAtomicMemAccessSize(VecTy->getElementType(), &LI);
4858 }
4859
4860 Check(ElTy->getScalarType()->isIntOrPtrTy() ||
4861 ElTy->getScalarType()->isByteTy() ||
4863 "atomic load operand must have integer, byte, pointer, floating "
4864 "point, or vector type!",
4865 ElTy, &LI);
4866
4867 checkAtomicMemAccessSize(ElTy, &LI);
4868 } else {
4869 Check(!LI.isElementwise(), "non-atomic load cannot be elementwise", &LI);
4871 "Non-atomic load cannot have SynchronizationScope specified", &LI);
4872 }
4873
4874 visitInstruction(LI);
4875}
4876
4877void Verifier::visitStoreInst(StoreInst &SI) {
4878 auto *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
4879 Check(PTy, "Store operand must be a pointer.", &SI);
4880 Type *ElTy = SI.getOperand(0)->getType();
4881 if (MaybeAlign A = SI.getAlign()) {
4882 Check(A->value() <= Value::MaximumAlignment,
4883 "huge alignment values are unsupported", &SI);
4884 }
4885 Check(ElTy->isSized(), "storing unsized types is not allowed", &SI);
4886 if (SI.isAtomic()) {
4887 Check(SI.getOrdering() != AtomicOrdering::Acquire &&
4888 SI.getOrdering() != AtomicOrdering::AcquireRelease,
4889 "Store cannot have Acquire ordering", &SI);
4890
4891 if (SI.isElementwise()) {
4892 Check(SI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4893 "atomic elementwise store cannot be sequentially consistent.", &SI);
4894
4895 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
4896 Check(VecTy,
4897 "atomic elementwise store operand must have fixed vector type!",
4898 &SI, ElTy);
4899 if (VecTy)
4900 checkAtomicMemAccessSize(VecTy->getElementType(), &SI);
4901 }
4902
4903 Check(ElTy->getScalarType()->isIntOrPtrTy() ||
4904 ElTy->getScalarType()->isByteTy() ||
4906 "atomic store operand must have integer, byte, pointer, floating "
4907 "point, or vector type!",
4908 ElTy, &SI);
4909 checkAtomicMemAccessSize(ElTy, &SI);
4910 } else {
4911 Check(!SI.isElementwise(), "non-atomic store cannot be elementwise", &SI);
4912 Check(SI.getSyncScopeID() == SyncScope::System,
4913 "Non-atomic store cannot have SynchronizationScope specified", &SI);
4914 }
4915 visitInstruction(SI);
4916}
4917
4918/// Check that SwiftErrorVal is used as a swifterror argument in CS.
4919void Verifier::verifySwiftErrorCall(CallBase &Call,
4920 const Value *SwiftErrorVal) {
4921 for (const auto &I : llvm::enumerate(Call.args())) {
4922 if (I.value() == SwiftErrorVal) {
4923 Check(Call.paramHasAttr(I.index(), Attribute::SwiftError),
4924 "swifterror value when used in a callsite should be marked "
4925 "with swifterror attribute",
4926 SwiftErrorVal, Call);
4927 }
4928 }
4929}
4930
4931void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
4932 // Check that swifterror value is only used by loads, stores, or as
4933 // a swifterror argument.
4934 for (const User *U : SwiftErrorVal->users()) {
4936 isa<InvokeInst>(U),
4937 "swifterror value can only be loaded and stored from, or "
4938 "as a swifterror argument!",
4939 SwiftErrorVal, U);
4940 // If it is used by a store, check it is the second operand.
4941 if (auto StoreI = dyn_cast<StoreInst>(U))
4942 Check(StoreI->getOperand(1) == SwiftErrorVal,
4943 "swifterror value should be the second operand when used "
4944 "by stores",
4945 SwiftErrorVal, U);
4946 if (auto *Call = dyn_cast<CallBase>(U))
4947 verifySwiftErrorCall(*const_cast<CallBase *>(Call), SwiftErrorVal);
4948 }
4949}
4950
4951void Verifier::visitAllocaInst(AllocaInst &AI) {
4953 AI.getModule()->getModuleFlag("require-logical-pointer")))
4954 Check(!MD->getZExtValue(),
4955 "Non-logical alloca disallowed for this module.");
4956
4957 Type *Ty = AI.getAllocatedType();
4958 Check(Ty->isSized(), "Cannot allocate unsized type", &AI);
4959 // Check if it's a target extension type that disallows being used on the
4960 // stack.
4962 "Alloca has illegal target extension type", &AI);
4964 "Alloca array size must have integer type", &AI);
4965 if (MaybeAlign A = AI.getAlign()) {
4966 Check(A->value() <= Value::MaximumAlignment,
4967 "huge alignment values are unsupported", &AI);
4968 }
4969
4970 if (AI.isSwiftError()) {
4971 Check(Ty->isPointerTy(), "swifterror alloca must have pointer type", &AI);
4973 "swifterror alloca must not be array allocation", &AI);
4974 verifySwiftErrorValue(&AI);
4975 }
4976
4977 visitInstruction(AI);
4978
4979 // Target-specific alloca checks.
4980 verifyAMDGPUAlloca(*this, AI);
4981}
4982
4983void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
4984 Type *ElTy = CXI.getOperand(1)->getType();
4985 Check(ElTy->isIntOrPtrTy(),
4986 "cmpxchg operand must have integer or pointer type", ElTy, &CXI);
4987 checkAtomicMemAccessSize(ElTy, &CXI);
4988 visitInstruction(CXI);
4989}
4990
4991void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
4992 Check(RMWI.getOrdering() != AtomicOrdering::Unordered,
4993 "atomicrmw instructions cannot be unordered.", &RMWI);
4994 auto Op = RMWI.getOperation();
4995 Type *ElTy = RMWI.getOperand(1)->getType();
4996 Check(!ElTy->isScalableTy(), "atomicrmw operand may not be scalable", &RMWI);
4997 if (RMWI.isElementwise()) {
4998 Check(RMWI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4999 "atomicrmw elementwise cannot be sequentially consistent.", &RMWI);
5000 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
5001 Check(VecTy, "atomicrmw elementwise operand must have fixed vector type!",
5002 &RMWI, ElTy);
5003 if (VecTy)
5004 checkAtomicMemAccessSize(VecTy->getElementType(), &RMWI);
5005 }
5006
5007 if (Op == AtomicRMWInst::Xchg) {
5008 Check((ElTy->isIntOrIntVectorTy() || ElTy->isFPOrFPVectorTy() ||
5009 ElTy->isPtrOrPtrVectorTy()),
5010 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5011 " operand must be an integer type, a floating-point type, a "
5012 "pointer type, or a fixed vector of any of these types!",
5013 &RMWI, ElTy);
5014 } else if (AtomicRMWInst::isFPOperation(Op)) {
5015 Check(ElTy->isFPOrFPVectorTy(),
5016 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5017 " operand must have floating-point or fixed vector of "
5018 "floating-point "
5019 "type!",
5020 &RMWI, ElTy);
5021 } else {
5022 Check(ElTy->isIntOrIntVectorTy(),
5023 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5024 " operand must have integer or fixed vector of integer type!",
5025 &RMWI, ElTy);
5026 }
5027 checkAtomicMemAccessSize(ElTy, &RMWI);
5029 "Invalid binary operation!", &RMWI);
5030 visitInstruction(RMWI);
5031}
5032
5033void Verifier::visitFenceInst(FenceInst &FI) {
5034 const AtomicOrdering Ordering = FI.getOrdering();
5035 Check(Ordering == AtomicOrdering::Acquire ||
5036 Ordering == AtomicOrdering::Release ||
5037 Ordering == AtomicOrdering::AcquireRelease ||
5038 Ordering == AtomicOrdering::SequentiallyConsistent,
5039 "fence instructions may only have acquire, release, acq_rel, or "
5040 "seq_cst ordering.",
5041 &FI);
5042 visitInstruction(FI);
5043}
5044
5045void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
5047 EVI.getIndices()) == EVI.getType(),
5048 "Invalid ExtractValueInst operands!", &EVI);
5049
5050 visitInstruction(EVI);
5051}
5052
5053void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
5055 IVI.getIndices()) ==
5056 IVI.getOperand(1)->getType(),
5057 "Invalid InsertValueInst operands!", &IVI);
5058
5059 visitInstruction(IVI);
5060}
5061
5062static Value *getParentPad(Value *EHPad) {
5063 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
5064 return FPI->getParentPad();
5065
5066 return cast<CatchSwitchInst>(EHPad)->getParentPad();
5067}
5068
5069void Verifier::visitEHPadPredecessors(Instruction &I) {
5070 assert(I.isEHPad());
5071
5072 BasicBlock *BB = I.getParent();
5073 Function *F = BB->getParent();
5074
5075 Check(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
5076
5077 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
5078 // The landingpad instruction defines its parent as a landing pad block. The
5079 // landing pad block may be branched to only by the unwind edge of an
5080 // invoke.
5081 for (BasicBlock *PredBB : predecessors(BB)) {
5082 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
5083 Check(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
5084 "Block containing LandingPadInst must be jumped to "
5085 "only by the unwind edge of an invoke.",
5086 LPI);
5087 }
5088 return;
5089 }
5090 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
5091 if (!pred_empty(BB))
5092 Check(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
5093 "Block containg CatchPadInst must be jumped to "
5094 "only by its catchswitch.",
5095 CPI);
5096 Check(BB != CPI->getCatchSwitch()->getUnwindDest(),
5097 "Catchswitch cannot unwind to one of its catchpads",
5098 CPI->getCatchSwitch(), CPI);
5099 return;
5100 }
5101
5102 // Verify that each pred has a legal terminator with a legal to/from EH
5103 // pad relationship.
5104 Instruction *ToPad = &I;
5105 Value *ToPadParent = getParentPad(ToPad);
5106 for (BasicBlock *PredBB : predecessors(BB)) {
5107 Instruction *TI = PredBB->getTerminator();
5108 Value *FromPad;
5109 if (auto *II = dyn_cast<InvokeInst>(TI)) {
5110 Check(II->getUnwindDest() == BB && II->getNormalDest() != BB,
5111 "EH pad must be jumped to via an unwind edge", ToPad, II);
5112 auto *CalledFn =
5113 dyn_cast<Function>(II->getCalledOperand()->stripPointerCasts());
5114 if (CalledFn && CalledFn->isIntrinsic() && II->doesNotThrow() &&
5115 !IntrinsicInst::mayLowerToFunctionCall(CalledFn->getIntrinsicID()))
5116 continue;
5117 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
5118 FromPad = Bundle->Inputs[0];
5119 else
5120 FromPad = ConstantTokenNone::get(II->getContext());
5121 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
5122 FromPad = CRI->getOperand(0);
5123 Check(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
5124 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
5125 FromPad = CSI;
5126 } else {
5127 Check(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
5128 }
5129
5130 // The edge may exit from zero or more nested pads.
5131 SmallPtrSet<Value *, 8> Seen;
5132 for (;; FromPad = getParentPad(FromPad)) {
5133 Check(FromPad != ToPad,
5134 "EH pad cannot handle exceptions raised within it", FromPad, TI);
5135 if (FromPad == ToPadParent) {
5136 // This is a legal unwind edge.
5137 break;
5138 }
5139 Check(!isa<ConstantTokenNone>(FromPad),
5140 "A single unwind edge may only enter one EH pad", TI);
5141 Check(Seen.insert(FromPad).second, "EH pad jumps through a cycle of pads",
5142 FromPad);
5143
5144 // This will be diagnosed on the corresponding instruction already. We
5145 // need the extra check here to make sure getParentPad() works.
5146 Check(isa<FuncletPadInst>(FromPad) || isa<CatchSwitchInst>(FromPad),
5147 "Parent pad must be catchpad/cleanuppad/catchswitch", TI);
5148 }
5149 }
5150}
5151
5152void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
5153 // The landingpad instruction is ill-formed if it doesn't have any clauses and
5154 // isn't a cleanup.
5155 Check(LPI.getNumClauses() > 0 || LPI.isCleanup(),
5156 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
5157
5158 visitEHPadPredecessors(LPI);
5159
5160 if (!LandingPadResultTy)
5161 LandingPadResultTy = LPI.getType();
5162 else
5163 Check(LandingPadResultTy == LPI.getType(),
5164 "The landingpad instruction should have a consistent result type "
5165 "inside a function.",
5166 &LPI);
5167
5168 Function *F = LPI.getParent()->getParent();
5169 Check(F->hasPersonalityFn(),
5170 "LandingPadInst needs to be in a function with a personality.", &LPI);
5171
5172 // The landingpad instruction must be the first non-PHI instruction in the
5173 // block.
5174 Check(LPI.getParent()->getLandingPadInst() == &LPI,
5175 "LandingPadInst not the first non-PHI instruction in the block.", &LPI);
5176
5177 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
5178 Constant *Clause = LPI.getClause(i);
5179 if (LPI.isCatch(i)) {
5180 Check(isa<PointerType>(Clause->getType()),
5181 "Catch operand does not have pointer type!", &LPI);
5182 } else {
5183 Check(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
5185 "Filter operand is not an array of constants!", &LPI);
5186 }
5187 }
5188
5189 visitInstruction(LPI);
5190}
5191
5192void Verifier::visitResumeInst(ResumeInst &RI) {
5194 "ResumeInst needs to be in a function with a personality.", &RI);
5195
5196 if (!LandingPadResultTy)
5197 LandingPadResultTy = RI.getValue()->getType();
5198 else
5199 Check(LandingPadResultTy == RI.getValue()->getType(),
5200 "The resume instruction should have a consistent result type "
5201 "inside a function.",
5202 &RI);
5203
5204 visitTerminator(RI);
5205}
5206
5207void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
5208 BasicBlock *BB = CPI.getParent();
5209
5210 Function *F = BB->getParent();
5211 Check(F->hasPersonalityFn(),
5212 "CatchPadInst needs to be in a function with a personality.", &CPI);
5213
5215 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
5216 CPI.getParentPad());
5217
5218 // The catchpad instruction must be the first non-PHI instruction in the
5219 // block.
5220 Check(&*BB->getFirstNonPHIIt() == &CPI,
5221 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
5222
5224 [](Use &U) {
5225 auto *V = U.get();
5226 return isa<Constant>(V) || isa<AllocaInst>(V);
5227 }),
5228 "Argument operand must be alloca or constant.", &CPI);
5229
5230 visitEHPadPredecessors(CPI);
5231 visitFuncletPadInst(CPI);
5232}
5233
5234void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
5235 Check(isa<CatchPadInst>(CatchReturn.getOperand(0)),
5236 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
5237 CatchReturn.getOperand(0));
5238
5239 visitTerminator(CatchReturn);
5240}
5241
5242void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
5243 BasicBlock *BB = CPI.getParent();
5244
5245 Function *F = BB->getParent();
5246 Check(F->hasPersonalityFn(),
5247 "CleanupPadInst needs to be in a function with a personality.", &CPI);
5248
5249 // The cleanuppad instruction must be the first non-PHI instruction in the
5250 // block.
5251 Check(&*BB->getFirstNonPHIIt() == &CPI,
5252 "CleanupPadInst not the first non-PHI instruction in the block.", &CPI);
5253
5254 auto *ParentPad = CPI.getParentPad();
5255 Check(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
5256 "CleanupPadInst has an invalid parent.", &CPI);
5257
5258 visitEHPadPredecessors(CPI);
5259 visitFuncletPadInst(CPI);
5260}
5261
5262void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
5263 User *FirstUser = nullptr;
5264 Value *FirstUnwindPad = nullptr;
5265 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
5266 SmallPtrSet<FuncletPadInst *, 8> Seen;
5267
5268 while (!Worklist.empty()) {
5269 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
5270 Check(Seen.insert(CurrentPad).second,
5271 "FuncletPadInst must not be nested within itself", CurrentPad);
5272 Value *UnresolvedAncestorPad = nullptr;
5273 for (User *U : CurrentPad->users()) {
5274 BasicBlock *UnwindDest;
5275 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
5276 UnwindDest = CRI->getUnwindDest();
5277 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
5278 // We allow catchswitch unwind to caller to nest
5279 // within an outer pad that unwinds somewhere else,
5280 // because catchswitch doesn't have a nounwind variant.
5281 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
5282 if (CSI->unwindsToCaller())
5283 continue;
5284 UnwindDest = CSI->getUnwindDest();
5285 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
5286 UnwindDest = II->getUnwindDest();
5287 } else if (isa<CallInst>(U)) {
5288 // Calls which don't unwind may be found inside funclet
5289 // pads that unwind somewhere else. We don't *require*
5290 // such calls to be annotated nounwind.
5291 continue;
5292 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
5293 // The unwind dest for a cleanup can only be found by
5294 // recursive search. Add it to the worklist, and we'll
5295 // search for its first use that determines where it unwinds.
5296 Worklist.push_back(CPI);
5297 continue;
5298 } else {
5299 Check(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
5300 continue;
5301 }
5302
5303 Value *UnwindPad;
5304 bool ExitsFPI;
5305 if (UnwindDest) {
5306 UnwindPad = &*UnwindDest->getFirstNonPHIIt();
5307 if (!cast<Instruction>(UnwindPad)->isEHPad())
5308 continue;
5309 Value *UnwindParent = getParentPad(UnwindPad);
5310 // Ignore unwind edges that don't exit CurrentPad.
5311 if (UnwindParent == CurrentPad)
5312 continue;
5313 // Determine whether the original funclet pad is exited,
5314 // and if we are scanning nested pads determine how many
5315 // of them are exited so we can stop searching their
5316 // children.
5317 Value *ExitedPad = CurrentPad;
5318 ExitsFPI = false;
5319 do {
5320 if (ExitedPad == &FPI) {
5321 ExitsFPI = true;
5322 // Now we can resolve any ancestors of CurrentPad up to
5323 // FPI, but not including FPI since we need to make sure
5324 // to check all direct users of FPI for consistency.
5325 UnresolvedAncestorPad = &FPI;
5326 break;
5327 }
5328 Value *ExitedParent = getParentPad(ExitedPad);
5329 if (ExitedParent == UnwindParent) {
5330 // ExitedPad is the ancestor-most pad which this unwind
5331 // edge exits, so we can resolve up to it, meaning that
5332 // ExitedParent is the first ancestor still unresolved.
5333 UnresolvedAncestorPad = ExitedParent;
5334 break;
5335 }
5336 ExitedPad = ExitedParent;
5337 } while (!isa<ConstantTokenNone>(ExitedPad));
5338 } else {
5339 // Unwinding to caller exits all pads.
5340 UnwindPad = ConstantTokenNone::get(FPI.getContext());
5341 ExitsFPI = true;
5342 UnresolvedAncestorPad = &FPI;
5343 }
5344
5345 if (ExitsFPI) {
5346 // This unwind edge exits FPI. Make sure it agrees with other
5347 // such edges.
5348 if (FirstUser) {
5349 Check(UnwindPad == FirstUnwindPad,
5350 "Unwind edges out of a funclet "
5351 "pad must have the same unwind "
5352 "dest",
5353 &FPI, U, FirstUser);
5354 } else {
5355 FirstUser = U;
5356 FirstUnwindPad = UnwindPad;
5357 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
5358 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
5359 getParentPad(UnwindPad) == getParentPad(&FPI))
5360 SiblingFuncletInfo[&FPI] = cast<Instruction>(U);
5361 }
5362 }
5363 // Make sure we visit all uses of FPI, but for nested pads stop as
5364 // soon as we know where they unwind to.
5365 if (CurrentPad != &FPI)
5366 break;
5367 }
5368 if (UnresolvedAncestorPad) {
5369 if (CurrentPad == UnresolvedAncestorPad) {
5370 // When CurrentPad is FPI itself, we don't mark it as resolved even if
5371 // we've found an unwind edge that exits it, because we need to verify
5372 // all direct uses of FPI.
5373 assert(CurrentPad == &FPI);
5374 continue;
5375 }
5376 // Pop off the worklist any nested pads that we've found an unwind
5377 // destination for. The pads on the worklist are the uncles,
5378 // great-uncles, etc. of CurrentPad. We've found an unwind destination
5379 // for all ancestors of CurrentPad up to but not including
5380 // UnresolvedAncestorPad.
5381 Value *ResolvedPad = CurrentPad;
5382 while (!Worklist.empty()) {
5383 Value *UnclePad = Worklist.back();
5384 Value *AncestorPad = getParentPad(UnclePad);
5385 // Walk ResolvedPad up the ancestor list until we either find the
5386 // uncle's parent or the last resolved ancestor.
5387 while (ResolvedPad != AncestorPad) {
5388 Value *ResolvedParent = getParentPad(ResolvedPad);
5389 if (ResolvedParent == UnresolvedAncestorPad) {
5390 break;
5391 }
5392 ResolvedPad = ResolvedParent;
5393 }
5394 // If the resolved ancestor search didn't find the uncle's parent,
5395 // then the uncle is not yet resolved.
5396 if (ResolvedPad != AncestorPad)
5397 break;
5398 // This uncle is resolved, so pop it from the worklist.
5399 Worklist.pop_back();
5400 }
5401 }
5402 }
5403
5404 if (FirstUnwindPad) {
5405 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
5406 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
5407 Value *SwitchUnwindPad;
5408 if (SwitchUnwindDest)
5409 SwitchUnwindPad = &*SwitchUnwindDest->getFirstNonPHIIt();
5410 else
5411 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
5412 Check(SwitchUnwindPad == FirstUnwindPad,
5413 "Unwind edges out of a catch must have the same unwind dest as "
5414 "the parent catchswitch",
5415 &FPI, FirstUser, CatchSwitch);
5416 }
5417 }
5418
5419 visitInstruction(FPI);
5420}
5421
5422void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
5423 BasicBlock *BB = CatchSwitch.getParent();
5424
5425 Function *F = BB->getParent();
5426 Check(F->hasPersonalityFn(),
5427 "CatchSwitchInst needs to be in a function with a personality.",
5428 &CatchSwitch);
5429
5430 // The catchswitch instruction must be the first non-PHI instruction in the
5431 // block.
5432 Check(&*BB->getFirstNonPHIIt() == &CatchSwitch,
5433 "CatchSwitchInst not the first non-PHI instruction in the block.",
5434 &CatchSwitch);
5435
5436 auto *ParentPad = CatchSwitch.getParentPad();
5437 Check(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
5438 "CatchSwitchInst has an invalid parent.", ParentPad);
5439
5440 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
5441 BasicBlock::iterator I = UnwindDest->getFirstNonPHIIt();
5442 Check(I->isEHPad() && !isa<LandingPadInst>(I),
5443 "CatchSwitchInst must unwind to an EH block which is not a "
5444 "landingpad.",
5445 &CatchSwitch);
5446
5447 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
5448 if (getParentPad(&*I) == ParentPad)
5449 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
5450 }
5451
5452 Check(CatchSwitch.getNumHandlers() != 0,
5453 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
5454
5455 for (BasicBlock *Handler : CatchSwitch.handlers()) {
5456 Check(isa<CatchPadInst>(Handler->getFirstNonPHIIt()),
5457 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
5458 }
5459
5460 visitEHPadPredecessors(CatchSwitch);
5461 visitTerminator(CatchSwitch);
5462}
5463
5464void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
5466 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
5467 CRI.getOperand(0));
5468
5469 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
5470 BasicBlock::iterator I = UnwindDest->getFirstNonPHIIt();
5471 Check(I->isEHPad() && !isa<LandingPadInst>(I),
5472 "CleanupReturnInst must unwind to an EH block which is not a "
5473 "landingpad.",
5474 &CRI);
5475 }
5476
5477 visitTerminator(CRI);
5478}
5479
5480void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
5481 Instruction *Op = cast<Instruction>(I.getOperand(i));
5482 // If the we have an invalid invoke, don't try to compute the dominance.
5483 // We already reject it in the invoke specific checks and the dominance
5484 // computation doesn't handle multiple edges.
5485 if (auto *II = dyn_cast<InvokeInst>(Op)) {
5486 if (II->getNormalDest() == II->getUnwindDest())
5487 return;
5488 }
5489
5490 // Quick check whether the def has already been encountered in the same block.
5491 // PHI nodes are not checked to prevent accepting preceding PHIs, because PHI
5492 // uses are defined to happen on the incoming edge, not at the instruction.
5493 //
5494 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
5495 // wrapping an SSA value, assert that we've already encountered it. See
5496 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
5497 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
5498 return;
5499
5500 const Use &U = I.getOperandUse(i);
5501 Check(DT.dominates(Op, U), "Instruction does not dominate all uses!", Op, &I);
5502}
5503
5504void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
5505 Check(I.getType()->isPointerTy(),
5506 "dereferenceable, dereferenceable_or_null "
5507 "apply only to pointer types",
5508 &I);
5510 "dereferenceable, dereferenceable_or_null apply only to load"
5511 " and inttoptr instructions, use attributes for calls or invokes",
5512 &I);
5513 Check(MD->getNumOperands() == 1,
5514 "dereferenceable, dereferenceable_or_null "
5515 "take one operand!",
5516 &I);
5517 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
5518 Check(CI && CI->getType()->isIntegerTy(64),
5519 "dereferenceable, "
5520 "dereferenceable_or_null metadata value must be an i64!",
5521 &I);
5522}
5523
5524void Verifier::visitNoFreeObjMetadata(Instruction &I, MDNode *MD) {
5525 Check(I.getType()->isPointerTy(), "nofreeobj applies only to pointer types",
5526 &I);
5528 "nofreeobj applies only to inttoptr instruction", &I);
5529 Check(MD->getNumOperands() == 0, "nofreeobj metadata must be empty", &I);
5530}
5531
5532void Verifier::visitProfMetadata(Instruction &I, MDNode *MD) {
5533 auto GetBranchingTerminatorNumOperands = [&]() {
5534 unsigned ExpectedNumOperands = 0;
5535 if (auto *BI = dyn_cast<CondBrInst>(&I))
5536 ExpectedNumOperands = BI->getNumSuccessors();
5537 else if (auto *SI = dyn_cast<SwitchInst>(&I))
5538 ExpectedNumOperands = SI->getNumSuccessors();
5539 else if (isa<CallInst>(&I))
5540 ExpectedNumOperands = 1;
5541 else if (auto *IBI = dyn_cast<IndirectBrInst>(&I))
5542 ExpectedNumOperands = IBI->getNumDestinations();
5543 else if (isa<SelectInst>(&I))
5544 ExpectedNumOperands = 2;
5545 else if (auto *CI = dyn_cast<CallBrInst>(&I))
5546 ExpectedNumOperands = CI->getNumSuccessors();
5547 return ExpectedNumOperands;
5548 };
5549 Check(MD->getNumOperands() >= 1,
5550 "!prof annotations should have at least 1 operand", MD);
5551 // Check first operand.
5552 Check(MD->getOperand(0) != nullptr, "first operand should not be null", MD);
5554 "expected string with name of the !prof annotation", MD);
5555 MDString *MDS = cast<MDString>(MD->getOperand(0));
5556 StringRef ProfName = MDS->getString();
5557
5559 Check(GetBranchingTerminatorNumOperands() != 0 || isa<InvokeInst>(I),
5560 "'unknown' !prof should only appear on instructions on which "
5561 "'branch_weights' would",
5562 MD);
5563 verifyUnknownProfileMetadata(MD);
5564 return;
5565 }
5566
5567 Check(MD->getNumOperands() >= 2,
5568 "!prof annotations should have no less than 2 operands", MD);
5569
5570 // Check consistency of !prof branch_weights metadata.
5571 if (ProfName == MDProfLabels::BranchWeights) {
5572 unsigned NumBranchWeights = getNumBranchWeights(*MD);
5573 if (isa<InvokeInst>(&I)) {
5574 Check(NumBranchWeights == 1 || NumBranchWeights == 2,
5575 "Wrong number of InvokeInst branch_weights operands", MD);
5576 } else {
5577 const unsigned ExpectedNumOperands = GetBranchingTerminatorNumOperands();
5578 if (ExpectedNumOperands == 0)
5579 CheckFailed("!prof branch_weights are not allowed for this instruction",
5580 MD);
5581
5582 Check(NumBranchWeights == ExpectedNumOperands, "Wrong number of operands",
5583 MD);
5584 }
5585 for (unsigned i = getBranchWeightOffset(MD); i < MD->getNumOperands();
5586 ++i) {
5587 auto &MDO = MD->getOperand(i);
5588 Check(MDO, "second operand should not be null", MD);
5590 "!prof brunch_weights operand is not a const int");
5591 }
5592 } else if (ProfName == MDProfLabels::ValueProfile) {
5593 Check(isValueProfileMD(MD), "invalid value profiling metadata", MD);
5594 ConstantInt *KindInt = mdconst::dyn_extract<ConstantInt>(MD->getOperand(1));
5595 Check(KindInt, "VP !prof missing kind argument", MD);
5596
5597 auto Kind = KindInt->getZExtValue();
5598 Check(Kind >= InstrProfValueKind::IPVK_First &&
5599 Kind <= InstrProfValueKind::IPVK_Last,
5600 "Invalid VP !prof kind", MD);
5601 Check(MD->getNumOperands() % 2 == 1,
5602 "VP !prof should have an even number "
5603 "of arguments after 'VP'",
5604 MD);
5605 if (Kind == InstrProfValueKind::IPVK_IndirectCallTarget ||
5606 Kind == InstrProfValueKind::IPVK_MemOPSize)
5608 "VP !prof indirect call or memop size expected to be applied to "
5609 "CallBase instructions only",
5610 MD);
5611
5612 DenseSet<uint64_t> ProfileValues;
5613 for (unsigned I = 3; I < MD->getNumOperands(); I += 2) {
5614 ConstantInt *ProfileValue =
5616 Check(ProfileValue, "VP !prof value operand is not a const int", MD);
5617 uint64_t ProfileValueInt = ProfileValue->getZExtValue();
5618 auto [ValueIt, Inserted] = ProfileValues.insert(ProfileValueInt);
5619 Check(Inserted, "VP !prof should not have duplicate profile values", MD);
5620 }
5621 } else {
5622 CheckFailed("expected either branch_weights or VP profile name", MD);
5623 }
5624}
5625
5626void Verifier::visitDIAssignIDMetadata(Instruction &I, MDNode *MD) {
5627 assert(I.hasMetadata(LLVMContext::MD_DIAssignID));
5628 // DIAssignID metadata must be attached to either an alloca or some form of
5629 // store/memory-writing instruction.
5630 // FIXME: We allow all intrinsic insts here to avoid trying to enumerate all
5631 // possible store intrinsics.
5632 bool ExpectedInstTy =
5634 CheckDI(ExpectedInstTy, "!DIAssignID attached to unexpected instruction kind",
5635 I, MD);
5636 for (DbgVariableRecord *DVR : at::getAssignmentMarkers(cast<DIAssignID>(MD)))
5637 CheckDI(DVR->getFunction() == I.getFunction(),
5638 "DVRAssign not in same function as inst", DVR, &I);
5639}
5640
5641void Verifier::visitMMRAMetadata(Instruction &I, MDNode *MD) {
5643 "!mmra metadata attached to unexpected instruction kind", I, MD);
5644
5645 // MMRA Metadata should either be a tag, e.g. !{!"foo", !"bar"}, or a
5646 // list of tags such as !2 in the following example:
5647 // !0 = !{!"a", !"b"}
5648 // !1 = !{!"c", !"d"}
5649 // !2 = !{!0, !1}
5650 if (MMRAMetadata::isTagMD(MD))
5651 return;
5652
5653 Check(isa<MDTuple>(MD), "!mmra expected to be a metadata tuple", I, MD);
5654 for (const MDOperand &MDOp : MD->operands())
5655 Check(MMRAMetadata::isTagMD(MDOp.get()),
5656 "!mmra metadata tuple operand is not an MMRA tag", I, MDOp.get());
5657}
5658
5659void Verifier::visitCallStackMetadata(MDNode *MD) {
5660 // Call stack metadata should consist of a list of at least 1 constant int
5661 // (representing a hash of the location).
5662 Check(MD->getNumOperands() >= 1,
5663 "call stack metadata should have at least 1 operand", MD);
5664
5665 for (const auto &Op : MD->operands())
5667 "call stack metadata operand should be constant integer", Op);
5668}
5669
5670void Verifier::visitMemProfMetadata(Instruction &I, MDNode *MD) {
5671 Check(isa<CallBase>(I), "!memprof metadata should only exist on calls", &I);
5672 if (isa<CallBase>(I))
5673 Check(I.hasMetadata(LLVMContext::MD_callsite),
5674 "!memprof metadata requires !callsite metadata", &I, MD);
5675 Check(MD->getNumOperands() >= 1,
5676 "!memprof annotations should have at least 1 metadata operand "
5677 "(MemInfoBlock)",
5678 MD);
5679
5680 // Check each MIB
5681 for (auto &MIBOp : MD->operands()) {
5682 auto *MIB = dyn_cast<MDNode>(MIBOp);
5683 // The first operand of an MIB should be the call stack metadata.
5684 // There rest of the operands should be MDString tags, and there should be
5685 // at least one.
5686 Check(MIB->getNumOperands() >= 2,
5687 "Each !memprof MemInfoBlock should have at least 2 operands", MIB);
5688
5689 // Check call stack metadata (first operand).
5690 Check(MIB->getOperand(0) != nullptr,
5691 "!memprof MemInfoBlock first operand should not be null", MIB);
5692 Check(isa<MDNode>(MIB->getOperand(0)),
5693 "!memprof MemInfoBlock first operand should be an MDNode", MIB);
5694 auto *StackMD = dyn_cast<MDNode>(MIB->getOperand(0));
5695 visitCallStackMetadata(StackMD);
5696
5697 // The second MIB operand should be MDString.
5698 Check(isa<MDString>(MIB->getOperand(1)),
5699 "!memprof MemInfoBlock second operand should be an MDString", MIB);
5700
5701 // Any remaining should be MDNode that are pairs of integers
5702 for (unsigned I = 2; I < MIB->getNumOperands(); ++I) {
5703 auto *OpNode = dyn_cast<MDNode>(MIB->getOperand(I));
5704 Check(OpNode, "Not all !memprof MemInfoBlock operands 2 to N are MDNode",
5705 MIB);
5706 Check(OpNode->getNumOperands() == 2,
5707 "Not all !memprof MemInfoBlock operands 2 to N are MDNode with 2 "
5708 "operands",
5709 MIB);
5710 // Check that all of Op's operands are ConstantInt.
5711 Check(llvm::all_of(OpNode->operands(),
5712 [](const MDOperand &Op) {
5713 return mdconst::hasa<ConstantInt>(Op);
5714 }),
5715 "Not all !memprof MemInfoBlock operands 2 to N are MDNode with "
5716 "ConstantInt operands",
5717 MIB);
5718 }
5719 }
5720}
5721
5722void Verifier::visitCallsiteMetadata(Instruction &I, MDNode *MD) {
5723 Check(isa<CallBase>(I), "!callsite metadata should only exist on calls", &I);
5724 // Verify the partial callstack annotated from memprof profiles. This callsite
5725 // is a part of a profiled allocation callstack.
5726 visitCallStackMetadata(MD);
5727}
5728
5729void Verifier::visitCalleeTypeMetadata(Instruction &I, MDNode *MD) {
5730 Check(isa<CallBase>(I), "!callee_type metadata should only exist on calls",
5731 &I);
5732 for (Metadata *Op : MD->operands()) {
5734 "The callee_type metadata must be a list of callgraph metadata nodes",
5735 Op);
5736 auto *CallgraphMD = cast<MDNode>(Op);
5737 Check(CallgraphMD->getNumOperands() == 1,
5738 "Well-formed callgraph metadata must contain exactly one "
5739 "operand",
5740 Op);
5741 Check(isa<MDString>(CallgraphMD->getOperand(0)),
5742 "The operand of callgraph metadata for functions must be an MDString",
5743 Op);
5744 }
5745}
5746
5747void Verifier::visitAnnotationMetadata(MDNode *Annotation) {
5748 Check(isa<MDTuple>(Annotation), "annotation must be a tuple");
5749 Check(Annotation->getNumOperands() >= 1,
5750 "annotation must have at least one operand");
5751 for (const MDOperand &Op : Annotation->operands()) {
5752 bool TupleOfStrings =
5753 isa<MDTuple>(Op.get()) &&
5754 all_of(cast<MDTuple>(Op)->operands(), [](auto &Annotation) {
5755 return isa<MDString>(Annotation.get());
5756 });
5757 Check(isa<MDString>(Op.get()) || TupleOfStrings,
5758 "operands must be a string or a tuple of strings");
5759 }
5760}
5761
5762void Verifier::visitAliasScopeMetadata(const MDNode *MD) {
5763 unsigned NumOps = MD->getNumOperands();
5764 Check(NumOps >= 2 && NumOps <= 3, "scope must have two or three operands",
5765 MD);
5766 Check(MD->getOperand(0).get() == MD || isa<MDString>(MD->getOperand(0)),
5767 "first scope operand must be self-referential or string", MD);
5768 if (NumOps == 3)
5770 "third scope operand must be string (if used)", MD);
5771
5772 auto *Domain = dyn_cast<MDNode>(MD->getOperand(1));
5773 Check(Domain != nullptr, "second scope operand must be MDNode", MD);
5774
5775 unsigned NumDomainOps = Domain->getNumOperands();
5776 Check(NumDomainOps >= 2 && NumDomainOps <= 3,
5777 "domain must have two or three operands", Domain);
5778 Check(Domain->getOperand(0).get() == Domain ||
5779 isa<MDString>(Domain->getOperand(0)),
5780 "first domain operand must be self-referential or string", Domain);
5781 const auto *Disjoint =
5783 Check(Disjoint && Disjoint->getBitWidth() == 1,
5784 "second domain operand must be an i1 constant", Domain);
5785 if (NumDomainOps == 3)
5786 Check(isa<MDString>(Domain->getOperand(2)),
5787 "third domain operand must be string (if used)", Domain);
5788}
5789
5790void Verifier::visitAliasScopeListMetadata(const MDNode *MD) {
5791 for (const MDOperand &Op : MD->operands()) {
5792 const auto *OpMD = dyn_cast<MDNode>(Op);
5793 Check(OpMD != nullptr, "scope list must consist of MDNodes", MD);
5794 visitAliasScopeMetadata(OpMD);
5795 }
5796}
5797
5798void Verifier::visitAccessGroupMetadata(const MDNode *MD) {
5799 auto IsValidAccessScope = [](const MDNode *MD) {
5800 return MD->getNumOperands() == 0 && MD->isDistinct();
5801 };
5802
5803 // An empty node is an access scope, and it must be 'distinct'. It is never a
5804 // list, because an empty list is not allowed: it would look the same as an
5805 // access scope.
5806 if (MD->getNumOperands() == 0) {
5807 Check(MD->isDistinct(), "Access scope must be 'distinct'", MD);
5808 return;
5809 }
5810
5811 // A non-empty node is a list of access scopes.
5812 for (const MDOperand &Op : MD->operands()) {
5813 const auto *OpMD = dyn_cast<MDNode>(Op);
5814 Check(OpMD != nullptr, "Access scope list must consist of MDNodes", MD);
5815 Check(IsValidAccessScope(OpMD),
5816 "Access scope list contains invalid access scope", MD);
5817 }
5818}
5819
5820void Verifier::visitCapturesMetadata(Instruction &I, const MDNode *Captures) {
5821 static const char *ValidArgs[] = {"address_is_null", "address",
5822 "read_provenance", "provenance"};
5823
5824 auto *SI = dyn_cast<StoreInst>(&I);
5825 Check(SI, "!captures metadata can only be applied to store instructions", &I);
5826 Check(SI->getValueOperand()->getType()->isPointerTy(),
5827 "!captures metadata can only be applied to store with value operand of "
5828 "pointer type",
5829 &I);
5830 Check(Captures->getNumOperands() != 0, "!captures metadata cannot be empty",
5831 &I);
5832
5833 for (Metadata *Op : Captures->operands()) {
5834 auto *Str = dyn_cast<MDString>(Op);
5835 Check(Str, "!captures metadata must be a list of strings", &I);
5836 Check(is_contained(ValidArgs, Str->getString()),
5837 "invalid entry in !captures metadata", &I, Str);
5838 }
5839}
5840
5841void Verifier::visitAllocTokenMetadata(Instruction &I, MDNode *MD) {
5842 Check(isa<CallBase>(I), "!alloc_token should only exist on calls", &I);
5843 Check(MD->getNumOperands() == 2 || MD->getNumOperands() == 3,
5844 "!alloc_token must have 2 or 3 operands", MD);
5845 Check(isa_and_nonnull<MDString>(MD->getOperand(0)), "expected string", MD);
5847 "expected integer constant", MD);
5848 if (MD->getNumOperands() == 3)
5850 "expected function name string", MD);
5851}
5852
5853void Verifier::visitInlineHistoryMetadata(Instruction &I, MDNode *MD) {
5854 Check(isa<CallBase>(I), "!inline_history should only exist on calls", &I);
5855 for (Metadata *Op : MD->operands()) {
5856 // Can be null when a function is erased.
5857 if (!Op)
5858 continue;
5861 ->getValue()
5862 ->stripPointerCastsAndAliases()),
5863 "!inline_history operands must be functions or null", MD);
5864 }
5865}
5866
5867void Verifier::visitMemCacheHintMetadata(Instruction &I, MDNode *MD) {
5868 Check(I.mayReadOrWriteMemory(),
5869 "!mem.cache_hint is only valid on memory operations", &I);
5870
5871 Check(MD->getNumOperands() % 2 == 0,
5872 "!mem.cache_hint must have even number of operands "
5873 "(operand_no, hint_node pairs)",
5874 MD);
5875
5876 const auto *CB = dyn_cast<CallBase>(&I);
5877 if (CB)
5878 Check(CB->getIntrinsicID() != Intrinsic::not_intrinsic,
5879 "!mem.cache_hint is not supported on non-intrinsic calls", &I);
5880
5881 unsigned NumOperands = CB ? CB->arg_size() : I.getNumOperands();
5882
5883 SmallDenseSet<unsigned, 4> SeenOperandNos;
5884 std::optional<uint64_t> LastOperandNo;
5885
5886 // Top-level metadata alternates: i32 operand_no, MDNode hint_node.
5887 for (unsigned J = 0; J + 1 < MD->getNumOperands(); J += 2) {
5888 auto *OpNoCI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(J));
5889 Check(OpNoCI,
5890 "!mem.cache_hint must alternate between i32 operand numbers and "
5891 "metadata hint nodes",
5892 MD);
5893
5894 Check(OpNoCI->getValue().isNonNegative(),
5895 "!mem.cache_hint operand number must be non-negative", MD);
5896
5897 uint64_t OperandNo = OpNoCI->getZExtValue();
5898 Check(OperandNo < NumOperands,
5899 "!mem.cache_hint operand number is out of range", &I);
5900
5901 Value *Operand =
5902 CB ? CB->getArgOperand(OperandNo) : I.getOperand(OperandNo);
5903 Check(Operand->getType()->isPtrOrPtrVectorTy(),
5904 "!mem.cache_hint operand number must refer to a pointer operand", &I);
5905
5906 bool Inserted = SeenOperandNos.insert(OperandNo).second;
5907 Check(Inserted, "!mem.cache_hint contains duplicate operand number", MD);
5908
5909 Check(!Inserted || !LastOperandNo || OperandNo > *LastOperandNo,
5910 "!mem.cache_hint operand numbers must be in increasing order", MD);
5911 LastOperandNo = OperandNo;
5912
5913 const auto *Node = dyn_cast<MDNode>(MD->getOperand(J + 1));
5914 Check(Node,
5915 "!mem.cache_hint must alternate between i32 operand numbers and "
5916 "metadata hint nodes",
5917 MD);
5918
5919 Check(Node->getNumOperands() % 2 == 0,
5920 "!mem.cache_hint hint node must have even number of operands "
5921 "(key-value pairs)",
5922 Node);
5923
5924 StringSet<> SeenKeys;
5925 for (unsigned K = 0; K + 1 < Node->getNumOperands(); K += 2) {
5926 const auto *Key = dyn_cast<MDString>(Node->getOperand(K));
5927 Check(Key, "!mem.cache_hint key must be a string", Node);
5928
5929 StringRef KeyStr = Key->getString();
5930 Check(SeenKeys.insert(KeyStr).second,
5931 "!mem.cache_hint hint node contains duplicate key", Node);
5932
5933 const Metadata *Value = Node->getOperand(K + 1).get();
5936 "!mem.cache_hint value must be a string or integer", Node);
5937 }
5938 }
5939}
5940
5941/// verifyInstruction - Verify that an instruction is well formed.
5942///
5943void Verifier::visitInstruction(Instruction &I) {
5944 BasicBlock *BB = I.getParent();
5945 Check(BB, "Instruction not embedded in basic block!", &I);
5946
5947 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
5948 for (User *U : I.users()) {
5949 Check(U != (User *)&I || !DT.isReachableFromEntry(BB),
5950 "Only PHI nodes may reference their own value!", &I);
5951 }
5952 }
5953
5954 // Check that void typed values don't have names
5955 Check(!I.getType()->isVoidTy() || !I.hasName(),
5956 "Instruction has a name, but provides a void value!", &I);
5957
5958 // Check that the return value of the instruction is either void or a legal
5959 // value type.
5960 Check(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
5961 "Instruction returns a non-scalar type!", &I);
5962
5963 // Check that the instruction doesn't produce metadata. Calls are already
5964 // checked against the callee type.
5965 Check(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
5966 "Invalid use of metadata!", &I);
5967
5968 // Check that all uses of the instruction, if they are instructions
5969 // themselves, actually have parent basic blocks. If the use is not an
5970 // instruction, it is an error!
5971 for (Use &U : I.uses()) {
5972 if (auto *Used = dyn_cast<Instruction>(U.getUser()))
5973 Check(Used->getParent() != nullptr,
5974 "Instruction referencing"
5975 " instruction not embedded in a basic block!",
5976 &I, Used);
5977 else {
5978 CheckFailed("Use of instruction is not an instruction!", U);
5979 return;
5980 }
5981 }
5982
5983 // Get a pointer to the call base of the instruction if it is some form of
5984 // call.
5985 const auto *CBI = dyn_cast<CallBase>(&I);
5986
5987 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
5988 Check(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
5989
5990 // Check to make sure that only first-class-values are operands to
5991 // instructions.
5992 if (!I.getOperand(i)->getType()->isFirstClassType()) {
5993 Check(false, "Instruction operands must be first-class values!", &I);
5994 }
5995
5996 if (auto *F = dyn_cast<Function>(I.getOperand(i))) {
5997 // This code checks whether the function is used as the operand of a
5998 // clang_arc_attachedcall operand bundle.
5999 auto IsAttachedCallOperand = [](Function *F, const CallBase *CBI,
6000 int Idx) {
6001 return CBI && CBI->isOperandBundleOfType(
6003 };
6004
6005 // Check to make sure that the "address of" an intrinsic function is never
6006 // taken. Ignore cases where the address of the intrinsic function is used
6007 // as the argument of operand bundle "clang.arc.attachedcall" as those
6008 // cases are handled in verifyAttachedCallBundle.
6009 Check((!F->isIntrinsic() ||
6010 (CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i)) ||
6011 IsAttachedCallOperand(F, CBI, i)),
6012 "Cannot take the address of an intrinsic!", &I);
6013 Check(!F->isIntrinsic() || isa<CallInst>(I) || isa<CallBrInst>(I) ||
6014 F->getIntrinsicID() == Intrinsic::donothing ||
6015 F->getIntrinsicID() == Intrinsic::seh_try_begin ||
6016 F->getIntrinsicID() == Intrinsic::seh_try_end ||
6017 F->getIntrinsicID() == Intrinsic::seh_scope_begin ||
6018 F->getIntrinsicID() == Intrinsic::seh_scope_end ||
6019 F->getIntrinsicID() == Intrinsic::coro_resume ||
6020 F->getIntrinsicID() == Intrinsic::coro_destroy ||
6021 F->getIntrinsicID() == Intrinsic::coro_await_suspend_void ||
6022 F->getIntrinsicID() == Intrinsic::coro_await_suspend_bool ||
6023 F->getIntrinsicID() == Intrinsic::coro_await_suspend_handle ||
6024 F->getIntrinsicID() ==
6025 Intrinsic::experimental_patchpoint_void ||
6026 F->getIntrinsicID() == Intrinsic::experimental_patchpoint ||
6027 F->getIntrinsicID() == Intrinsic::fake_use ||
6028 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint ||
6029 F->getIntrinsicID() == Intrinsic::wasm_throw ||
6030 F->getIntrinsicID() == Intrinsic::wasm_rethrow ||
6031 IsAttachedCallOperand(F, CBI, i),
6032 "Cannot invoke an intrinsic other than donothing, patchpoint, "
6033 "statepoint, coro_resume, coro_destroy, clang.arc.attachedcall or "
6034 "wasm.(re)throw",
6035 &I);
6036 Check(F->getParent() == &M, "Referencing function in another module!", &I,
6037 &M, F, F->getParent());
6038 } else if (auto *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
6039 Check(OpBB->getParent() == BB->getParent(),
6040 "Referring to a basic block in another function!", &I);
6041 } else if (auto *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
6042 Check(OpArg->getParent() == BB->getParent(),
6043 "Referring to an argument in another function!", &I);
6044 } else if (auto *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
6045 Check(GV->getParent() == &M, "Referencing global in another module!", &I,
6046 &M, GV, GV->getParent());
6047 } else if (auto *OpInst = dyn_cast<Instruction>(I.getOperand(i))) {
6048 Check(OpInst->getFunction() == BB->getParent(),
6049 "Referring to an instruction in another function!", &I);
6050 verifyDominatesUse(I, i);
6051 } else if (isa<InlineAsm>(I.getOperand(i))) {
6052 Check(CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i),
6053 "Cannot take the address of an inline asm!", &I);
6054 } else if (auto *C = dyn_cast<Constant>(I.getOperand(i))) {
6055 visitConstantExprsRecursively(C);
6056 }
6057 }
6058
6059 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
6061 "fpmath requires a floating point result!", &I);
6062 Check(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
6063 if (ConstantFP *CFP0 =
6065 const APFloat &Accuracy = CFP0->getValueAPF();
6066 Check(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
6067 "fpmath accuracy must have float type", &I);
6068 Check(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
6069 "fpmath accuracy not a positive number!", &I);
6070 } else {
6071 Check(false, "invalid fpmath accuracy!", &I);
6072 }
6073 }
6074
6075 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
6077 "Ranges are only for loads, calls and invokes!", &I);
6078 visitRangeMetadata(I, Range, I.getType());
6079 }
6080
6081 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nofpclass)) {
6082 Check(isa<LoadInst>(I), "nofpclass is only for loads", &I);
6083 visitNoFPClassMetadata(I, MD, I.getType());
6084 }
6085
6086 if (MDNode *Range = I.getMetadata(LLVMContext::MD_noalias_addrspace)) {
6089 "noalias.addrspace are only for memory operations!", &I);
6090 visitNoaliasAddrspaceMetadata(I, Range, I.getType());
6091 }
6092
6093 if (I.hasMetadata(LLVMContext::MD_invariant_group)) {
6095 "invariant.group metadata is only for loads and stores", &I);
6096 }
6097
6098 if (I.hasMetadata(LLVMContext::MD_invariant_load)) {
6099 auto *II = dyn_cast<IntrinsicInst>(&I);
6100 Check(isa<LoadInst>(I) || (II && II->onlyReadsMemory()),
6101 "invariant.load metadata is only for loads and readonly "
6102 "intrinsic calls",
6103 &I);
6104 }
6105
6106 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nonnull)) {
6107 Check(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
6108 &I);
6110 "nonnull applies only to load instructions, use attributes"
6111 " for calls or invokes",
6112 &I);
6113 Check(MD->getNumOperands() == 0, "nonnull metadata must be empty", &I);
6114 }
6115
6116 if (MDNode *MD = I.getMetadata(LLVMContext::MD_noundef)) {
6117 Check(isa<LoadInst>(I), "noundef applies only to load instructions", &I);
6118 Check(MD->getNumOperands() == 0, "noundef metadata must be empty", &I);
6119 }
6120
6121 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
6122 visitDereferenceableMetadata(I, MD);
6123
6124 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
6125 visitDereferenceableMetadata(I, MD);
6126
6127 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nofreeobj))
6128 visitNoFreeObjMetadata(I, MD);
6129
6130 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
6131 TBAAVerifyHelper.visitTBAAMetadata(&I, TBAA);
6132
6133 if (MDNode *TBAAStruct = I.getMetadata(LLVMContext::MD_tbaa_struct))
6134 TBAAVerifyHelper.visitTBAAStructMetadata(&I, TBAAStruct);
6135
6136 if (MDNode *MD = I.getMetadata(LLVMContext::MD_noalias))
6137 visitAliasScopeListMetadata(MD);
6138 if (MDNode *MD = I.getMetadata(LLVMContext::MD_alias_scope))
6139 visitAliasScopeListMetadata(MD);
6140
6141 if (MDNode *MD = I.getMetadata(LLVMContext::MD_access_group))
6142 visitAccessGroupMetadata(MD);
6143
6144 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
6145 Check(I.getType()->isPointerTy(), "align applies only to pointer types",
6146 &I);
6148 "align applies only to load instructions, "
6149 "use attributes for calls or invokes",
6150 &I);
6151 Check(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
6152 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
6153 Check(CI && CI->getType()->isIntegerTy(64),
6154 "align metadata value must be an i64!", &I);
6155 uint64_t Align = CI->getZExtValue();
6156 Check(isPowerOf2_64(Align), "align metadata value must be a power of 2!",
6157 &I);
6158 Check(Align <= Value::MaximumAlignment,
6159 "alignment is larger that implementation defined limit", &I);
6160 }
6161
6162 if (MDNode *MD = I.getMetadata(LLVMContext::MD_prof))
6163 visitProfMetadata(I, MD);
6164
6165 if (MDNode *MD = I.getMetadata(LLVMContext::MD_memprof))
6166 visitMemProfMetadata(I, MD);
6167
6168 if (MDNode *MD = I.getMetadata(LLVMContext::MD_callsite))
6169 visitCallsiteMetadata(I, MD);
6170
6171 if (MDNode *MD = I.getMetadata(LLVMContext::MD_callee_type))
6172 visitCalleeTypeMetadata(I, MD);
6173
6174 if (MDNode *MD = I.getMetadata(LLVMContext::MD_DIAssignID))
6175 visitDIAssignIDMetadata(I, MD);
6176
6177 if (MDNode *MMRA = I.getMetadata(LLVMContext::MD_mmra))
6178 visitMMRAMetadata(I, MMRA);
6179
6180 if (MDNode *Annotation = I.getMetadata(LLVMContext::MD_annotation))
6181 visitAnnotationMetadata(Annotation);
6182
6183 if (MDNode *Captures = I.getMetadata(LLVMContext::MD_captures))
6184 visitCapturesMetadata(I, Captures);
6185
6186 if (MDNode *MD = I.getMetadata(LLVMContext::MD_alloc_token))
6187 visitAllocTokenMetadata(I, MD);
6188
6189 if (MDNode *MD = I.getMetadata(LLVMContext::MD_inline_history))
6190 visitInlineHistoryMetadata(I, MD);
6191
6192 if (MDNode *MD = I.getMetadata(LLVMContext::MD_mem_cache_hint))
6193 visitMemCacheHintMetadata(I, MD);
6194
6195 if (MDNode *MD = I.getMetadata("amdgpu.expected.active.lanes")) {
6196 Check(MD->getNumOperands() == 1,
6197 "!amdgpu.expected.active.lanes must have exactly one operand", &I,
6198 MD);
6199 ConstantInt *CI =
6201 Check(CI && CI->getType()->isIntegerTy(32),
6202 "!amdgpu.expected.active.lanes operand must be an i32 constant", &I,
6203 MD);
6204 }
6205
6206 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
6207 CheckDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
6208 visitMDNode(*N, AreDebugLocsAllowed::Yes);
6209
6210 if (auto *DL = dyn_cast<DILocation>(N)) {
6211 if (DL->getAtomGroup()) {
6212 DISubprogram *SP = getSubprogram(DL->getRawScope());
6213 CheckDI(SP && SP->getKeyInstructionsEnabled(),
6214 "DbgLoc uses atomGroup but DISubprogram doesn't have Key "
6215 "Instructions enabled",
6216 DL, SP);
6217 }
6218 }
6219 }
6220
6222 I.getAllMetadata(MDs);
6223 for (auto Attachment : MDs) {
6224 unsigned Kind = Attachment.first;
6225 auto AllowLocs =
6226 (Kind == LLVMContext::MD_dbg || Kind == LLVMContext::MD_loop)
6227 ? AreDebugLocsAllowed::Yes
6228 : AreDebugLocsAllowed::No;
6229 visitMDNode(*Attachment.second, AllowLocs);
6230 }
6231
6232 InstsInThisBlock.insert(&I);
6233}
6234
6235/// Allow intrinsics to be verified in different ways.
6236void Verifier::visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call) {
6238
6239 // If the intrinsic takes MDNode arguments, verify that they are either global
6240 // or are local to *this* function.
6241 for (Value *V : Call.args()) {
6242 if (auto *MD = dyn_cast<MetadataAsValue>(V))
6243 visitMetadataAsValue(*MD, Call.getCaller());
6244 if (auto *Const = dyn_cast<Constant>(V))
6245 Check(!Const->getType()->isX86_AMXTy(),
6246 "const x86_amx is not allowed in argument!");
6247 }
6248
6249 // Verify intrinsic signature, so following checks can rely on it. The actual
6250 // error is reported at the intrinsic declaration.
6251 SmallVector<Type *, 4> OverloadTys;
6252 if (!Intrinsic::isSignatureValid(ID, Call.getFunctionType(), OverloadTys))
6253 return;
6254
6255 switch (ID) {
6256 default:
6257 break;
6258 case Intrinsic::assume: {
6259 if (Call.hasOperandBundles()) {
6261 Check(Cond && Cond->isOne(),
6262 "assume with operand bundles must have i1 true condition", Call);
6263 }
6264 for (auto OBU : Call.operand_bundles()) {
6265 // Separate storage assumptions are special insofar as they're the only
6266 // operand bundles allowed on assumes that aren't parameter attributes.
6267
6268 auto GetTypeAt = [&](unsigned Index) {
6269 return OBU.Inputs[Index]->getType();
6270 };
6271
6272 switch (getBundleAttrFromOBU(OBU)) {
6273 case BundleAttr::None:
6274 CheckFailed("tags must be valid attribute names", Call);
6275 break;
6276 case BundleAttr::Align:
6277 Check(OBU.Inputs.size() >= 2 && OBU.Inputs.size() <= 3,
6278 "alignment assumptions should have 2 or 3 arguments", Call);
6279 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6280 Call);
6281 Check(GetTypeAt(1)->isIntegerTy() &&
6282 GetTypeAt(1)->getIntegerBitWidth() <= 64,
6283 "second argument should be an integer with a maximum width of 64 "
6284 "bits",
6285 Call);
6286 Check(OBU.Inputs.size() < 3 ||
6287 (GetTypeAt(2)->isIntegerTy() &&
6288 GetTypeAt(2)->getIntegerBitWidth() <= 64),
6289 "third argument should be an integer with a maximum width of 64 "
6290 "bits if present",
6291 Call);
6292 break;
6293 case BundleAttr::Cold:
6294 Check(OBU.Inputs.size() == 0,
6295 "cold assumptions should have no arguments", Call);
6296 break;
6297 case BundleAttr::Dereferenceable:
6298 case BundleAttr::DereferenceableOrNull:
6299 Check(OBU.Inputs.size() == 2,
6300 "dereferenceable assumptions should have 2 arguments", Call);
6301 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6302 Call);
6303 Check(GetTypeAt(1)->isIntegerTy() &&
6304 GetTypeAt(1)->getIntegerBitWidth() <= 64,
6305 "second argument should be an integer with a maximum width of 64 "
6306 "bits",
6307 Call);
6308 break;
6309 case BundleAttr::Ignore:
6310 break;
6311 case BundleAttr::NonNull:
6312 Check(OBU.Inputs.size() == 1,
6313 "nonnull assumptions should have 1 argument", Call);
6314 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6315 Call);
6316 break;
6317 case BundleAttr::NoUndef:
6318 Check(OBU.Inputs.size() == 1,
6319 "noundef assumptions should have 1 argument", Call);
6320 break;
6321 case BundleAttr::SeparateStorage:
6322 Check(OBU.Inputs.size() == 2,
6323 "separate_storage assumptions should have 2 arguments", Call);
6324 Check(GetTypeAt(0)->isPointerTy() && GetTypeAt(1)->isPointerTy(),
6325 "arguments to separate_storage assumptions should be pointers",
6326 Call);
6327 break;
6328 }
6329 }
6330 break;
6331 }
6332 case Intrinsic::ucmp:
6333 case Intrinsic::scmp: {
6334 Type *SrcTy = Call.getOperand(0)->getType();
6335 Type *DestTy = Call.getType();
6336
6337 Check(DestTy->getScalarSizeInBits() >= 2,
6338 "result type must be at least 2 bits wide", Call);
6339
6340 bool IsDestTypeVector = DestTy->isVectorTy();
6341 Check(SrcTy->isVectorTy() == IsDestTypeVector,
6342 "ucmp/scmp argument and result types must both be either vector or "
6343 "scalar types",
6344 Call);
6345 if (IsDestTypeVector) {
6346 auto SrcVecLen = cast<VectorType>(SrcTy)->getElementCount();
6347 auto DestVecLen = cast<VectorType>(DestTy)->getElementCount();
6348 Check(SrcVecLen == DestVecLen,
6349 "return type and arguments must have the same number of "
6350 "elements",
6351 Call);
6352 }
6353 break;
6354 }
6355 case Intrinsic::coro_begin:
6356 case Intrinsic::coro_begin_custom_abi:
6358 "id argument of llvm.coro.begin must refer to coro.id");
6359 break;
6360 case Intrinsic::coro_id: {
6362 "align argument only accepts constants");
6363 auto *Promise = Call.getArgOperand(1);
6364 Check(isa<ConstantPointerNull>(Promise) || isa<AllocaInst>(Promise),
6365 "promise argument must refer to an alloca");
6366
6367 auto *CoroAddr = Call.getArgOperand(2)->stripPointerCastsAndAliases();
6368 bool BeforeCoroEarly = isa<ConstantPointerNull>(CoroAddr);
6369 Check(BeforeCoroEarly || isa<Function>(CoroAddr),
6370 "coro argument must refer to a function");
6371
6372 auto *InfoArg = Call.getArgOperand(3);
6373 bool BeforeCoroSplit = isa<ConstantPointerNull>(InfoArg);
6374 if (BeforeCoroSplit)
6375 break;
6376
6377 Check(!BeforeCoroEarly, "cannot run CoroSplit before CoroEarly");
6378 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
6379 Check(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
6380 "info argument of llvm.coro.id must refer to an initialized "
6381 "constant");
6382 Constant *Init = GV->getInitializer();
6384 "info argument of llvm.coro.id must refer to either a struct or "
6385 "an array");
6386 break;
6387 }
6388 case Intrinsic::is_fpclass: {
6389 const ConstantInt *TestMask = cast<ConstantInt>(Call.getOperand(1));
6390 Check((TestMask->getZExtValue() & ~static_cast<unsigned>(fcAllFlags)) == 0,
6391 "unsupported bits for llvm.is.fpclass test mask");
6392 break;
6393 }
6394 case Intrinsic::fptrunc_round: {
6395 // Check the rounding mode
6396 Metadata *MD = nullptr;
6398 if (MAV)
6399 MD = MAV->getMetadata();
6400
6401 Check(MD != nullptr, "missing rounding mode argument", Call);
6402
6403 Check(isa<MDString>(MD),
6404 ("invalid value for llvm.fptrunc.round metadata operand"
6405 " (the operand should be a string)"),
6406 MD);
6407
6408 std::optional<RoundingMode> RoundMode =
6409 convertStrToRoundingMode(cast<MDString>(MD)->getString());
6410 Check(RoundMode && *RoundMode != RoundingMode::Dynamic,
6411 "unsupported rounding mode argument", Call);
6412 break;
6413 }
6414 case Intrinsic::convert_to_arbitrary_fp: {
6415 // Check that vector element counts are consistent.
6416 Type *ValueTy = Call.getArgOperand(0)->getType();
6417 Type *IntTy = Call.getType();
6418
6419 if (auto *ValueVecTy = dyn_cast<VectorType>(ValueTy)) {
6420 auto *IntVecTy = dyn_cast<VectorType>(IntTy);
6421 Check(IntVecTy,
6422 "if floating-point operand is a vector, integer operand must also "
6423 "be a vector",
6424 Call);
6425 Check(ValueVecTy->getElementCount() == IntVecTy->getElementCount(),
6426 "floating-point and integer vector operands must have the same "
6427 "element count",
6428 Call);
6429 }
6430
6431 // Check interpretation metadata (argoperand 1).
6432 auto *InterpMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(1));
6433 Check(InterpMAV, "missing interpretation metadata operand", Call);
6434 auto *InterpStr = dyn_cast<MDString>(InterpMAV->getMetadata());
6435 Check(InterpStr, "interpretation metadata operand must be a string", Call);
6436 StringRef Interp = InterpStr->getString();
6437
6438 Check(!Interp.empty(), "interpretation metadata string must not be empty",
6439 Call);
6440
6441 // Valid interpretation strings: mini-float format names.
6443 "unsupported interpretation metadata string", Call);
6444
6445 // The integer type width must equal the arbitrary FP format width.
6446 if (unsigned FormatBits =
6448 Check(IntTy->getScalarSizeInBits() == FormatBits,
6449 "integer type bit width must equal the arbitrary FP format width",
6450 Call);
6451
6452 // Check rounding mode metadata (argoperand 2).
6453 auto *RoundingMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(2));
6454 Check(RoundingMAV, "missing rounding mode metadata operand", Call);
6455 auto *RoundingStr = dyn_cast<MDString>(RoundingMAV->getMetadata());
6456 Check(RoundingStr, "rounding mode metadata operand must be a string", Call);
6457
6458 std::optional<RoundingMode> RM =
6459 convertStrToRoundingMode(RoundingStr->getString());
6460 Check(RM && *RM != RoundingMode::Dynamic,
6461 "unsupported rounding mode argument", Call);
6462 break;
6463 }
6464 case Intrinsic::convert_from_arbitrary_fp: {
6465 // Check that vector element counts are consistent.
6466 Type *IntTy = Call.getArgOperand(0)->getType();
6467 Type *ValueTy = Call.getType();
6468
6469 if (auto *ValueVecTy = dyn_cast<VectorType>(ValueTy)) {
6470 auto *IntVecTy = dyn_cast<VectorType>(IntTy);
6471 Check(IntVecTy,
6472 "if floating-point operand is a vector, integer operand must also "
6473 "be a vector",
6474 Call);
6475 Check(ValueVecTy->getElementCount() == IntVecTy->getElementCount(),
6476 "floating-point and integer vector operands must have the same "
6477 "element count",
6478 Call);
6479 }
6480
6481 // Check interpretation metadata (argoperand 1).
6482 auto *InterpMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(1));
6483 Check(InterpMAV, "missing interpretation metadata operand", Call);
6484 auto *InterpStr = dyn_cast<MDString>(InterpMAV->getMetadata());
6485 Check(InterpStr, "interpretation metadata operand must be a string", Call);
6486 StringRef Interp = InterpStr->getString();
6487
6488 Check(!Interp.empty(), "interpretation metadata string must not be empty",
6489 Call);
6490
6491 // Valid interpretation strings: mini-float format names.
6493 "unsupported interpretation metadata string", Call);
6494
6495 // The integer type width must equal the arbitrary FP format width.
6496 if (unsigned FormatBits =
6498 Check(IntTy->getScalarSizeInBits() == FormatBits,
6499 "integer type bit width must equal the arbitrary FP format width",
6500 Call);
6501 break;
6502 }
6503#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
6504#include "llvm/IR/VPIntrinsics.def"
6505#undef BEGIN_REGISTER_VP_INTRINSIC
6506 visitVPIntrinsic(cast<VPIntrinsic>(Call));
6507 break;
6508#define INSTRUCTION(NAME, NARGS, ROUND_MODE, INTRINSIC) \
6509 case Intrinsic::INTRINSIC:
6510#include "llvm/IR/ConstrainedOps.def"
6511#undef INSTRUCTION
6512 visitConstrainedFPIntrinsic(cast<ConstrainedFPIntrinsic>(Call));
6513 break;
6514 case Intrinsic::dbg_declare: // llvm.dbg.declare
6515 case Intrinsic::dbg_value: // llvm.dbg.value
6516 case Intrinsic::dbg_assign: // llvm.dbg.assign
6517 case Intrinsic::dbg_label: // llvm.dbg.label
6518 // We no longer interpret debug intrinsics (the old variable-location
6519 // design). They're meaningless as far as LLVM is concerned we could make
6520 // it an error for them to appear, but it's possible we'll have users
6521 // converting back to intrinsics for the forseeable future (such as DXIL),
6522 // so tolerate their existance.
6523 break;
6524 case Intrinsic::memcpy:
6525 case Intrinsic::memcpy_inline:
6526 case Intrinsic::memmove:
6527 case Intrinsic::memset:
6528 case Intrinsic::memset_inline:
6529 break;
6530 case Intrinsic::experimental_memset_pattern: {
6531 const auto Memset = cast<MemSetPatternInst>(&Call);
6532 Check(Memset->getValue()->getType()->isSized(),
6533 "unsized types cannot be used as memset patterns", Call);
6534 break;
6535 }
6536 case Intrinsic::memcpy_element_unordered_atomic:
6537 case Intrinsic::memmove_element_unordered_atomic:
6538 case Intrinsic::memset_element_unordered_atomic: {
6539 const auto *AMI = cast<AnyMemIntrinsic>(&Call);
6540
6541 ConstantInt *ElementSizeCI =
6542 cast<ConstantInt>(AMI->getRawElementSizeInBytes());
6543 const APInt &ElementSizeVal = ElementSizeCI->getValue();
6544 Check(ElementSizeVal.isPowerOf2(),
6545 "element size of the element-wise atomic memory intrinsic "
6546 "must be a power of 2",
6547 Call);
6548
6549 auto IsValidAlignment = [&](MaybeAlign Alignment) {
6550 return Alignment && ElementSizeVal.ule(Alignment->value());
6551 };
6552 Check(IsValidAlignment(AMI->getDestAlign()),
6553 "incorrect alignment of the destination argument", Call);
6554 if (const auto *AMT = dyn_cast<AnyMemTransferInst>(AMI)) {
6555 Check(IsValidAlignment(AMT->getSourceAlign()),
6556 "incorrect alignment of the source argument", Call);
6557 }
6558 break;
6559 }
6560 case Intrinsic::call_preallocated_setup: {
6561 auto *NumArgs = cast<ConstantInt>(Call.getArgOperand(0));
6562 bool FoundCall = false;
6563 for (User *U : Call.users()) {
6564 auto *UseCall = dyn_cast<CallBase>(U);
6565 Check(UseCall != nullptr,
6566 "Uses of llvm.call.preallocated.setup must be calls");
6567 Intrinsic::ID IID = UseCall->getIntrinsicID();
6568 if (IID == Intrinsic::call_preallocated_arg) {
6569 auto *AllocArgIndex = dyn_cast<ConstantInt>(UseCall->getArgOperand(1));
6570 Check(AllocArgIndex != nullptr,
6571 "llvm.call.preallocated.alloc arg index must be a constant");
6572 auto AllocArgIndexInt = AllocArgIndex->getValue();
6573 Check(AllocArgIndexInt.sge(0) &&
6574 AllocArgIndexInt.slt(NumArgs->getValue()),
6575 "llvm.call.preallocated.alloc arg index must be between 0 and "
6576 "corresponding "
6577 "llvm.call.preallocated.setup's argument count");
6578 } else if (IID == Intrinsic::call_preallocated_teardown) {
6579 // nothing to do
6580 } else {
6581 Check(!FoundCall, "Can have at most one call corresponding to a "
6582 "llvm.call.preallocated.setup");
6583 FoundCall = true;
6584 size_t NumPreallocatedArgs = 0;
6585 for (unsigned i = 0; i < UseCall->arg_size(); i++) {
6586 if (UseCall->paramHasAttr(i, Attribute::Preallocated)) {
6587 ++NumPreallocatedArgs;
6588 }
6589 }
6590 Check(NumPreallocatedArgs != 0,
6591 "cannot use preallocated intrinsics on a call without "
6592 "preallocated arguments");
6593 Check(NumArgs->equalsInt(NumPreallocatedArgs),
6594 "llvm.call.preallocated.setup arg size must be equal to number "
6595 "of preallocated arguments "
6596 "at call site",
6597 Call, *UseCall);
6598 // getOperandBundle() cannot be called if more than one of the operand
6599 // bundle exists. There is already a check elsewhere for this, so skip
6600 // here if we see more than one.
6601 if (UseCall->countOperandBundlesOfType(LLVMContext::OB_preallocated) >
6602 1) {
6603 return;
6604 }
6605 auto PreallocatedBundle =
6606 UseCall->getOperandBundle(LLVMContext::OB_preallocated);
6607 Check(PreallocatedBundle,
6608 "Use of llvm.call.preallocated.setup outside intrinsics "
6609 "must be in \"preallocated\" operand bundle");
6610 Check(PreallocatedBundle->Inputs.front().get() == &Call,
6611 "preallocated bundle must have token from corresponding "
6612 "llvm.call.preallocated.setup");
6613 }
6614 }
6615 break;
6616 }
6617 case Intrinsic::call_preallocated_arg: {
6618 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
6619 Check(Token &&
6620 Token->getIntrinsicID() == Intrinsic::call_preallocated_setup,
6621 "llvm.call.preallocated.arg token argument must be a "
6622 "llvm.call.preallocated.setup");
6623 Check(Call.hasFnAttr(Attribute::Preallocated),
6624 "llvm.call.preallocated.arg must be called with a \"preallocated\" "
6625 "call site attribute");
6626 break;
6627 }
6628 case Intrinsic::call_preallocated_teardown: {
6629 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
6630 Check(Token &&
6631 Token->getIntrinsicID() == Intrinsic::call_preallocated_setup,
6632 "llvm.call.preallocated.teardown token argument must be a "
6633 "llvm.call.preallocated.setup");
6634 break;
6635 }
6636 case Intrinsic::gcroot:
6637 case Intrinsic::gcwrite:
6638 case Intrinsic::gcread:
6639 if (ID == Intrinsic::gcroot) {
6640 auto *AI =
6642 Check(AI, "llvm.gcroot parameter #1 must be an alloca.", Call);
6644 "llvm.gcroot parameter #2 must be a constant.", Call);
6645 if (!AI->getAllocatedType()->isPointerTy()) {
6647 "llvm.gcroot parameter #1 must either be a pointer alloca, "
6648 "or argument #2 must be a non-null constant.",
6649 Call);
6650 }
6651 }
6652
6653 Check(Call.getParent()->getParent()->hasGC(),
6654 "Enclosing function does not use GC.", Call);
6655 break;
6656 case Intrinsic::init_trampoline:
6658 "llvm.init_trampoline parameter #2 must resolve to a function.",
6659 Call);
6660 break;
6661 case Intrinsic::reloc_none: {
6663 cast<MetadataAsValue>(Call.getArgOperand(0))->getMetadata()),
6664 "llvm.reloc.none argument must be a metadata string", &Call);
6665 break;
6666 }
6667 case Intrinsic::stackprotector:
6669 "llvm.stackprotector parameter #2 must resolve to an alloca.", Call);
6670 break;
6671 case Intrinsic::localescape: {
6672 BasicBlock *BB = Call.getParent();
6673 Check(BB->isEntryBlock(), "llvm.localescape used outside of entry block",
6674 Call);
6675 Check(!SawFrameEscape, "multiple calls to llvm.localescape in one function",
6676 Call);
6677 for (Value *Arg : Call.args()) {
6678 if (isa<ConstantPointerNull>(Arg))
6679 continue; // Null values are allowed as placeholders.
6680 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
6681 Check(AI && AI->isStaticAlloca(),
6682 "llvm.localescape only accepts static allocas", Call);
6683 }
6684 FrameEscapeInfo[BB->getParent()].first = Call.arg_size();
6685 SawFrameEscape = true;
6686 break;
6687 }
6688 case Intrinsic::localrecover: {
6690 auto *Fn = dyn_cast<Function>(FnArg);
6691 Check(Fn && !Fn->isDeclaration(),
6692 "llvm.localrecover first "
6693 "argument must be function defined in this module",
6694 Call);
6695 auto *IdxArg = cast<ConstantInt>(Call.getArgOperand(2));
6696 auto &Entry = FrameEscapeInfo[Fn];
6697 Entry.second = unsigned(
6698 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
6699 break;
6700 }
6701
6702 case Intrinsic::experimental_gc_statepoint:
6703 if (auto *CI = dyn_cast<CallInst>(&Call))
6704 Check(!CI->isInlineAsm(),
6705 "gc.statepoint support for inline assembly unimplemented", CI);
6706 Check(Call.getParent()->getParent()->hasGC(),
6707 "Enclosing function does not use GC.", Call);
6708
6709 verifyStatepoint(Call);
6710 break;
6711 case Intrinsic::experimental_gc_result: {
6712 Check(Call.getParent()->getParent()->hasGC(),
6713 "Enclosing function does not use GC.", Call);
6714
6715 auto *Statepoint = Call.getArgOperand(0);
6716 if (isa<UndefValue>(Statepoint))
6717 break;
6718
6719 // Are we tied to a statepoint properly?
6720 const auto *StatepointCall = dyn_cast<CallBase>(Statepoint);
6721 Check(StatepointCall && StatepointCall->getIntrinsicID() ==
6722 Intrinsic::experimental_gc_statepoint,
6723 "gc.result operand #1 must be from a statepoint", Call,
6724 Call.getArgOperand(0));
6725
6726 // Check that result type matches wrapped callee.
6727 auto *TargetFuncType =
6728 cast<FunctionType>(StatepointCall->getParamElementType(2));
6729 Check(Call.getType() == TargetFuncType->getReturnType(),
6730 "gc.result result type does not match wrapped callee", Call);
6731 break;
6732 }
6733 case Intrinsic::experimental_gc_relocate: {
6735 "gc.relocate must return a pointer or a vector of pointers", Call);
6736
6737 // Check that this relocate is correctly tied to the statepoint
6738
6739 // This is case for relocate on the unwinding path of an invoke statepoint
6740 if (auto *LandingPad = dyn_cast<LandingPadInst>(Call.getArgOperand(0))) {
6741
6742 const BasicBlock *InvokeBB =
6743 LandingPad->getParent()->getUniquePredecessor();
6744
6745 // Landingpad relocates should have only one predecessor with invoke
6746 // statepoint terminator
6747 Check(InvokeBB, "safepoints should have unique landingpads",
6748 LandingPad->getParent());
6750 "gc relocate should be linked to a statepoint", InvokeBB);
6751 } else {
6752 // In all other cases relocate should be tied to the statepoint directly.
6753 // This covers relocates on a normal return path of invoke statepoint and
6754 // relocates of a call statepoint.
6755 auto *Token = Call.getArgOperand(0);
6757 "gc relocate is incorrectly tied to the statepoint", Call, Token);
6758 }
6759
6760 // Verify rest of the relocate arguments.
6761 const Value &StatepointCall = *cast<GCRelocateInst>(Call).getStatepoint();
6762
6763 // Both the base and derived must be piped through the safepoint.
6766 "gc.relocate operand #2 must be integer offset", Call);
6767
6768 Value *Derived = Call.getArgOperand(2);
6769 Check(isa<ConstantInt>(Derived),
6770 "gc.relocate operand #3 must be integer offset", Call);
6771
6772 const uint64_t BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
6773 const uint64_t DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
6774
6775 // Check the bounds
6776 if (isa<UndefValue>(StatepointCall))
6777 break;
6778 if (auto Opt = cast<GCStatepointInst>(StatepointCall)
6779 .getOperandBundle(LLVMContext::OB_gc_live)) {
6780 Check(BaseIndex < Opt->Inputs.size(),
6781 "gc.relocate: statepoint base index out of bounds", Call);
6782 Check(DerivedIndex < Opt->Inputs.size(),
6783 "gc.relocate: statepoint derived index out of bounds", Call);
6784 }
6785
6786 // Relocated value must be either a pointer type or vector-of-pointer type,
6787 // but gc_relocate does not need to return the same pointer type as the
6788 // relocated pointer. It can be casted to the correct type later if it's
6789 // desired. However, they must have the same address space and 'vectorness'
6790 GCRelocateInst &Relocate = cast<GCRelocateInst>(Call);
6791 auto *ResultType = Call.getType();
6792 auto *DerivedType = Relocate.getDerivedPtr()->getType();
6793 auto *BaseType = Relocate.getBasePtr()->getType();
6794
6795 Check(BaseType->isPtrOrPtrVectorTy(),
6796 "gc.relocate: relocated value must be a pointer", Call);
6797 Check(DerivedType->isPtrOrPtrVectorTy(),
6798 "gc.relocate: relocated value must be a pointer", Call);
6799
6800 Check(ResultType->isVectorTy() == DerivedType->isVectorTy(),
6801 "gc.relocate: vector relocates to vector and pointer to pointer",
6802 Call);
6803 Check(
6804 ResultType->getPointerAddressSpace() ==
6805 DerivedType->getPointerAddressSpace(),
6806 "gc.relocate: relocating a pointer shouldn't change its address space",
6807 Call);
6808
6809 auto GC = llvm::getGCStrategy(Relocate.getFunction()->getGC());
6810 Check(GC, "gc.relocate: calling function must have GCStrategy",
6811 Call.getFunction());
6812 if (GC) {
6813 auto isGCPtr = [&GC](Type *PTy) {
6814 return GC->isGCManagedPointer(PTy->getScalarType()).value_or(true);
6815 };
6816 Check(isGCPtr(ResultType), "gc.relocate: must return gc pointer", Call);
6817 Check(isGCPtr(BaseType),
6818 "gc.relocate: relocated value must be a gc pointer", Call);
6819 Check(isGCPtr(DerivedType),
6820 "gc.relocate: relocated value must be a gc pointer", Call);
6821 }
6822 break;
6823 }
6824 case Intrinsic::experimental_patchpoint: {
6825 if (Call.getCallingConv() == CallingConv::AnyReg) {
6827 "patchpoint: invalid return type used with anyregcc", Call);
6828 }
6829 break;
6830 }
6831 case Intrinsic::eh_exceptioncode:
6832 case Intrinsic::eh_exceptionpointer: {
6834 "eh.exceptionpointer argument must be a catchpad", Call);
6835 break;
6836 }
6837 case Intrinsic::get_active_lane_mask: {
6838 Type *ElemTy = Call.getType()->getScalarType();
6839 Check(ElemTy->isIntegerTy(1),
6840 "get_active_lane_mask: element type is not i1", Call);
6841 break;
6842 }
6843 case Intrinsic::mask_beforefirst: {
6845 "mask.beforefirst element type must be i1", Call);
6846 break;
6847 }
6848 case Intrinsic::experimental_get_vector_length: {
6849 auto *VF = cast<ConstantInt>(Call.getArgOperand(1));
6850 Check(!VF->isNegative() && !VF->isZero(),
6851 "get_vector_length: VF must be positive", Call);
6852 break;
6853 }
6854 case Intrinsic::experimental_guard: {
6855 Check(isa<CallInst>(Call), "experimental_guard cannot be invoked", Call);
6857 "experimental_guard must have exactly one "
6858 "\"deopt\" operand bundle");
6859 break;
6860 }
6861
6862 case Intrinsic::experimental_deoptimize: {
6863 Check(isa<CallInst>(Call), "experimental_deoptimize cannot be invoked",
6864 Call);
6866 "experimental_deoptimize must have exactly one "
6867 "\"deopt\" operand bundle");
6869 "experimental_deoptimize return type must match caller return type");
6870
6871 if (isa<CallInst>(Call)) {
6873 Check(RI,
6874 "calls to experimental_deoptimize must be followed by a return");
6875
6876 if (!Call.getType()->isVoidTy() && RI)
6877 Check(RI->getReturnValue() == &Call,
6878 "calls to experimental_deoptimize must be followed by a return "
6879 "of the value computed by experimental_deoptimize");
6880 }
6881
6882 break;
6883 }
6884 case Intrinsic::vastart: {
6886 "va_start called in a non-varargs function");
6887 break;
6888 }
6889 case Intrinsic::get_dynamic_area_offset: {
6890 Check(DL.getPointerSizeInBits(DL.getAllocaAddrSpace()) ==
6892 "get_dynamic_area_offset result type must match alloca address "
6893 "space width",
6894 Call);
6895 break;
6896 }
6897 case Intrinsic::smul_fix:
6898 case Intrinsic::smul_fix_sat:
6899 case Intrinsic::umul_fix:
6900 case Intrinsic::umul_fix_sat:
6901 case Intrinsic::sdiv_fix:
6902 case Intrinsic::sdiv_fix_sat:
6903 case Intrinsic::udiv_fix:
6904 case Intrinsic::udiv_fix_sat: {
6905 Value *Op1 = Call.getArgOperand(0);
6906 auto *Op3 = cast<ConstantInt>(Call.getArgOperand(2));
6907
6908 if (ID == Intrinsic::smul_fix || ID == Intrinsic::smul_fix_sat ||
6909 ID == Intrinsic::sdiv_fix || ID == Intrinsic::sdiv_fix_sat) {
6910 Check(Op3->getZExtValue() < Op1->getType()->getScalarSizeInBits(),
6911 "the scale of s[mul|div]_fix[_sat] must be less than the width of "
6912 "the operands");
6913 } else {
6914 Check(Op3->getZExtValue() <= Op1->getType()->getScalarSizeInBits(),
6915 "the scale of u[mul|div]_fix[_sat] must be less than or equal "
6916 "to the width of the operands");
6917 }
6918 break;
6919 }
6920 case Intrinsic::lrint:
6921 case Intrinsic::llrint:
6922 case Intrinsic::lround:
6923 case Intrinsic::llround: {
6924 Type *ValTy = Call.getArgOperand(0)->getType();
6925 Type *ResultTy = Call.getType();
6926 Check(ValTy->isVectorTy() == ResultTy->isVectorTy(),
6927 IF->getName() + ": argument and result disagree on vector use",
6928 &Call);
6929 if (auto *VTy = dyn_cast<VectorType>(ValTy)) {
6930 auto *RTy = dyn_cast<VectorType>(ResultTy);
6931 Check(VTy->getElementCount() == RTy->getElementCount(),
6932 IF->getName() + ": argument must be same length as result", &Call);
6933 }
6934 break;
6935 }
6936 case Intrinsic::bswap: {
6937 Type *Ty = Call.getType();
6938 unsigned Size = Ty->getScalarSizeInBits();
6939 Check(Size % 16 == 0, "bswap must be an even number of bytes", &Call);
6940 break;
6941 }
6942 case Intrinsic::invariant_start: {
6943 auto *InvariantSize = dyn_cast<ConstantInt>(Call.getArgOperand(0));
6944 Check(InvariantSize &&
6945 (!InvariantSize->isNegative() || InvariantSize->isMinusOne()),
6946 "invariant_start parameter must be -1, 0 or a positive number",
6947 &Call);
6948 break;
6949 }
6950 case Intrinsic::matrix_multiply:
6951 case Intrinsic::matrix_transpose:
6952 case Intrinsic::matrix_column_major_load:
6953 case Intrinsic::matrix_column_major_store: {
6955 Value *Stride = nullptr;
6956 ConstantInt *NumRows;
6957 ConstantInt *NumColumns;
6958 FixedVectorType *ResultTy;
6959 Type *Op0ElemTy = nullptr;
6960 Type *Op1ElemTy = nullptr;
6961 switch (ID) {
6962 case Intrinsic::matrix_multiply: {
6963 NumRows = cast<ConstantInt>(Call.getArgOperand(2));
6964 ConstantInt *N = cast<ConstantInt>(Call.getArgOperand(3));
6965 NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
6968 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
6969 Check(Op0Ty && Op1Ty && RetTy,
6970 "Matrix operations require fixed-length vectors!", &Call);
6971 Check(Op0Ty->getNumElements() ==
6972 NumRows->getZExtValue() * N->getZExtValue(),
6973 "First argument of a matrix operation does not match specified "
6974 "shape!");
6975 Check(Op1Ty->getNumElements() ==
6976 N->getZExtValue() * NumColumns->getZExtValue(),
6977 "Second argument of a matrix operation does not match specified "
6978 "shape!");
6979
6980 ResultTy = RetTy;
6981 Op0ElemTy = Op0Ty->getElementType();
6982 Op1ElemTy = Op1Ty->getElementType();
6983 break;
6984 }
6985 case Intrinsic::matrix_transpose: {
6986 NumRows = cast<ConstantInt>(Call.getArgOperand(1));
6987 NumColumns = cast<ConstantInt>(Call.getArgOperand(2));
6989 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
6990 Check(Op0Ty && RetTy, "Matrix operations require fixed-length vectors!",
6991 &Call);
6992 ResultTy = RetTy;
6993 Op0ElemTy = Op0Ty->getElementType();
6994 break;
6995 }
6996 case Intrinsic::matrix_column_major_load: {
6997 Stride = Call.getArgOperand(1);
6998 NumRows = cast<ConstantInt>(Call.getArgOperand(3));
6999 NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
7000 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
7001 Check(RetTy, "Matrix operations require fixed-length vectors!", &Call);
7002 ResultTy = RetTy;
7003 break;
7004 }
7005 case Intrinsic::matrix_column_major_store: {
7006 Stride = Call.getArgOperand(2);
7007 NumRows = cast<ConstantInt>(Call.getArgOperand(4));
7008 NumColumns = cast<ConstantInt>(Call.getArgOperand(5));
7010 Check(Op0Ty, "Matrix operations require fixed-length vectors!", &Call);
7011 ResultTy = Op0Ty;
7012 Op0ElemTy = Op0Ty->getElementType();
7013 break;
7014 }
7015 default:
7016 llvm_unreachable("unexpected intrinsic");
7017 }
7018
7019 Check(ResultTy->getElementType()->isIntegerTy() ||
7020 ResultTy->getElementType()->isFloatingPointTy(),
7021 "Result type must be an integer or floating-point type!", IF);
7022
7023 if (Op0ElemTy)
7024 Check(ResultTy->getElementType() == Op0ElemTy,
7025 "Vector element type mismatch of the result and first operand "
7026 "vector!",
7027 IF);
7028
7029 if (Op1ElemTy)
7030 Check(ResultTy->getElementType() == Op1ElemTy,
7031 "Vector element type mismatch of the result and second operand "
7032 "vector!",
7033 IF);
7034
7035 Check(ResultTy->getNumElements() ==
7036 NumRows->getZExtValue() * NumColumns->getZExtValue(),
7037 "Result of a matrix operation does not fit in the returned vector!");
7038
7039 if (Stride)
7040 Check(Stride->getType()->getIntegerBitWidth() <= 64,
7041 "Stride bitwidth cannot exceed 64!", IF);
7042
7043 break;
7044 }
7045 case Intrinsic::stepvector: {
7046 auto *VecTy = cast<VectorType>(Call.getType());
7047 Check(VecTy->getScalarSizeInBits() >= 8,
7048 "stepvector only supported for vectors of integers "
7049 "with a bitwidth of at least 8.",
7050 &Call);
7051 break;
7052 }
7053 case Intrinsic::experimental_vector_match: {
7054 Value *Op1 = Call.getArgOperand(0);
7055 Value *Op2 = Call.getArgOperand(1);
7056
7057 auto *Op1Ty = cast<VectorType>(Op1->getType());
7058 auto *Op2Ty = cast<VectorType>(Op2->getType());
7059
7061 "Second operand must be a fixed length vector.", &Call);
7062 Check(Op1Ty->getElementType() == Op2Ty->getElementType(),
7063 "First two operands must have the same element type.", &Call);
7064 break;
7065 }
7066 case Intrinsic::speculative_load: {
7067 Type *LoadTy = Call.getType();
7068 Check(LoadTy->isByteTy() || LoadTy->isVectorTy(),
7069 "llvm.speculative.load return type must be a byte type or a "
7070 "vector type",
7071 &Call);
7072 if (LoadTy->isByteOrByteVectorTy()) {
7073 unsigned BitWidth = LoadTy->getScalarType()->getByteBitWidth();
7074 Check((BitWidth % 8) == 0,
7075 "llvm.speculative.load byte type must have a bit width that is "
7076 "a multiple of 8",
7077 &Call);
7078 }
7079
7080 uint64_t MinSizeInBits = DL.getTypeSizeInBits(LoadTy).getKnownMinValue();
7081 Check((MinSizeInBits % 8) == 0 && isPowerOf2_64(MinSizeInBits / 8),
7082 "llvm.speculative.load return type size in bytes must be a "
7083 "positive power of 2",
7084 &Call);
7085
7086 constexpr unsigned NumFixedArgs = 3;
7087 unsigned NumArgs = Call.arg_size();
7088 Check(NumArgs >= NumFixedArgs,
7089 "llvm.speculative.load requires at least 3 arguments", &Call);
7090
7091 Value *PayloadArg = Call.getArgOperand(NumFixedArgs - 1);
7092 if (PayloadArg->getType()->isIntegerTy(64)) {
7093 // Direct form: (ptr, i1 from_end, i64 num_accessible_bytes)
7094 Check(NumArgs == NumFixedArgs,
7095 "llvm.speculative.load direct form has too many arguments", &Call);
7096 } else {
7097 // Oracle form: (ptr, i1 from_end, oracle_fn_ptr, args...)
7098 auto *OracleFn = dyn_cast<Function>(PayloadArg);
7099 Check(OracleFn,
7100 "llvm.speculative.load third argument must be i64 or a direct "
7101 "reference to an oracle function",
7102 &Call);
7103
7104 Check(OracleFn->hasFnAttribute("oracle-function"),
7105 "llvm.speculative.load oracle function must have the "
7106 "\"oracle-function\" attribute",
7107 &Call);
7108
7109 // Make sure the called oracle matches the attributes of the intrinsic.
7110 Check(OracleFn->onlyReadsMemory() && OracleFn->onlyAccessesArgMemory() &&
7111 OracleFn->doesNotThrow() && OracleFn->hasNoSync() &&
7112 OracleFn->willReturn(),
7113 "llvm.speculative.load oracle function must be nounwind, nosync "
7114 "and willreturn, must not have side effects and may only read "
7115 "memory through its arguments",
7116 &Call);
7117
7118 FunctionType *FTy = OracleFn->getFunctionType();
7119 Check(FTy->getReturnType()->isIntegerTy(64),
7120 "llvm.speculative.load oracle function must return i64", &Call);
7121
7122 Check(!FTy->isVarArg(),
7123 "llvm.speculative.load oracle function must have a fixed argument "
7124 "list",
7125 &Call);
7126 Check(NumArgs - NumFixedArgs == FTy->getNumParams(),
7127 "llvm.speculative.load oracle function argument count mismatch",
7128 &Call);
7129 for (auto [ParamTy, Arg] :
7130 zip_equal(FTy->params(), drop_begin(Call.args(), NumFixedArgs)))
7131 Check(ParamTy == Arg->getType(),
7132 "llvm.speculative.load oracle function argument type mismatch",
7133 &Call);
7134 }
7135 break;
7136 }
7137 case Intrinsic::vector_repeat: {
7138 auto *ResultTy = dyn_cast<ScalableVectorType>(Call.getType());
7140
7141 Check(ArgTy, "vector_repeat argument must be a fixed-length vector.",
7142 &Call);
7143 Check(ResultTy, "vector_repeat result must be a scalable vector.", &Call);
7144 Check(ResultTy->getElementType() == ArgTy->getElementType(),
7145 "vector_repeat argument and result must have the same element "
7146 "type.",
7147 &Call);
7148 Check(ArgTy->getNumElements() == ResultTy->getMinNumElements(),
7149 "vector_repeat argument and result must have the same minimum "
7150 "element count.",
7151 &Call);
7152 break;
7153 }
7154 case Intrinsic::vector_insert: {
7155 Value *Vec = Call.getArgOperand(0);
7156 Value *SubVec = Call.getArgOperand(1);
7158 unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue();
7159
7160 VectorType *VecTy = cast<VectorType>(Vec->getType());
7161 VectorType *SubVecTy = cast<VectorType>(SubVec->getType());
7162
7163 ElementCount VecEC = VecTy->getElementCount();
7164 ElementCount SubVecEC = SubVecTy->getElementCount();
7165 Check(VecTy->getElementType() == SubVecTy->getElementType(),
7166 "vector_insert parameters must have the same element "
7167 "type.",
7168 &Call);
7169 Check(IdxN % SubVecEC.getKnownMinValue() == 0,
7170 "vector_insert index must be a constant multiple of "
7171 "the subvector's known minimum vector length.");
7172
7173 // The only allowed 'mixed' case is inserting a fixed vector into a
7174 // scalable vector.
7175 if (SubVecEC.isScalable()) {
7176 Check(VecEC.isScalable(), "cannot vector_insert a scalable vector into "
7177 "a fixed vector.");
7178 }
7179
7180 // If this insertion is not the 'mixed' case where a fixed vector is
7181 // inserted into a scalable vector, ensure that the insertion of the
7182 // subvector does not overrun the parent vector.
7183 if (VecEC.isScalable() == SubVecEC.isScalable()) {
7184 Check(IdxN < VecEC.getKnownMinValue() &&
7185 IdxN + SubVecEC.getKnownMinValue() <= VecEC.getKnownMinValue(),
7186 "subvector operand of vector_insert would overrun the "
7187 "vector being inserted into.");
7188 }
7189 break;
7190 }
7191 case Intrinsic::vector_extract: {
7192 Value *Vec = Call.getArgOperand(0);
7194 unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue();
7195
7196 VectorType *ResultTy = cast<VectorType>(Call.getType());
7197 VectorType *VecTy = cast<VectorType>(Vec->getType());
7198
7199 ElementCount VecEC = VecTy->getElementCount();
7200 ElementCount ResultEC = ResultTy->getElementCount();
7201
7202 Check(ResultTy->getElementType() == VecTy->getElementType(),
7203 "vector_extract result must have the same element "
7204 "type as the input vector.",
7205 &Call);
7206 Check(IdxN % ResultEC.getKnownMinValue() == 0,
7207 "vector_extract index must be a constant multiple of "
7208 "the result type's known minimum vector length.");
7209
7210 // The only allowed 'mixed' case is extracting a fixed vector from a
7211 // scalable vector.
7212 if (ResultEC.isScalable()) {
7213 Check(VecEC.isScalable(), "cannot vector_extract a scalable vector from "
7214 "a fixed vector.");
7215 }
7216
7217 // If this extraction is not the 'mixed' case where a fixed vector is
7218 // extracted from a scalable vector, ensure that the extraction does not
7219 // overrun the parent vector.
7220 if (VecEC.isScalable() == ResultEC.isScalable()) {
7221 Check(IdxN < VecEC.getKnownMinValue() &&
7222 IdxN + ResultEC.getKnownMinValue() <= VecEC.getKnownMinValue(),
7223 "vector_extract would overrun.");
7224 }
7225 break;
7226 }
7227 case Intrinsic::vector_partial_reduce_fadd:
7228 case Intrinsic::vector_partial_reduce_add: {
7231
7232 unsigned VecWidth = VecTy->getElementCount().getKnownMinValue();
7233 unsigned AccWidth = AccTy->getElementCount().getKnownMinValue();
7234
7235 Check((VecWidth % AccWidth) == 0,
7236 "Invalid vector widths for partial "
7237 "reduction. The width of the input vector "
7238 "must be a positive integer multiple of "
7239 "the width of the accumulator vector.");
7240
7241 Check(AccTy->getElementType() == VecTy->getElementType(),
7242 "The element type of the input vector must match the element type "
7243 "of the accumulator vector.",
7244 &Call);
7245 break;
7246 }
7247 case Intrinsic::experimental_noalias_scope_decl: {
7248 NoAliasScopeDecls.push_back(cast<IntrinsicInst>(&Call));
7249 break;
7250 }
7251 case Intrinsic::preserve_array_access_index:
7252 case Intrinsic::preserve_struct_access_index:
7253 case Intrinsic::aarch64_ldaxr:
7254 case Intrinsic::aarch64_ldxr:
7255 case Intrinsic::arm_ldaex:
7256 case Intrinsic::arm_ldrex: {
7257 Type *ElemTy = Call.getParamElementType(0);
7258 Check(ElemTy, "Intrinsic requires elementtype attribute on first argument.",
7259 &Call);
7260 break;
7261 }
7262 case Intrinsic::aarch64_stlxr:
7263 case Intrinsic::aarch64_stxr:
7264 case Intrinsic::arm_stlex:
7265 case Intrinsic::arm_strex: {
7266 Type *ElemTy = Call.getAttributes().getParamElementType(1);
7267 Check(ElemTy,
7268 "Intrinsic requires elementtype attribute on second argument.",
7269 &Call);
7270 break;
7271 }
7272 case Intrinsic::aarch64_prefetch: {
7273 Check(cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue() < 2,
7274 "write argument to llvm.aarch64.prefetch must be 0 or 1", Call);
7275 Check(cast<ConstantInt>(Call.getArgOperand(2))->getZExtValue() < 4,
7276 "target argument to llvm.aarch64.prefetch must be 0-3", Call);
7277 Check(cast<ConstantInt>(Call.getArgOperand(3))->getZExtValue() < 2,
7278 "stream argument to llvm.aarch64.prefetch must be 0 or 1", Call);
7279 Check(cast<ConstantInt>(Call.getArgOperand(4))->getZExtValue() < 2,
7280 "isdata argument to llvm.aarch64.prefetch must be 0 or 1", Call);
7281 break;
7282 }
7283 case Intrinsic::aarch64_range_prefetch: {
7284 Check(cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue() < 2,
7285 "write argument to llvm.aarch64.range.prefetch must be 0 or 1", Call);
7286 Check(cast<ConstantInt>(Call.getArgOperand(2))->getZExtValue() < 2,
7287 "stream argument to llvm.aarch64.range.prefetch must be 0 or 1",
7288 Call);
7289 break;
7290 }
7291 case Intrinsic::riscv_vsetvli:
7292 case Intrinsic::riscv_vsetvlimax: {
7293 // The result models VLMAX (or a VL bounded by it) and is only defined for
7294 // XLen (i32/i64). Narrower types cannot represent the architectural VLMAX
7295 // range of [1, 65536], which value analyses rely on.
7297 "llvm.riscv.vsetvli/vsetvlimax result must be i32 or i64", &Call);
7298
7299 // VSEW and VLMUL select the vtype and must encode a valid SEW/LMUL pair.
7300 bool HasAVL = ID == Intrinsic::riscv_vsetvli;
7301 unsigned Offset = HasAVL ? 1 : 0;
7302 uint64_t VSEW =
7303 cast<ConstantInt>(Call.getArgOperand(Offset))->getZExtValue();
7304 uint64_t VLMUL =
7305 cast<ConstantInt>(Call.getArgOperand(Offset + 1))->getZExtValue();
7306 Check(VSEW <= 3, "llvm.riscv.vsetvli/vsetvlimax VSEW must be 0-3", &Call);
7307 Check(VLMUL <= 7 && VLMUL != RISCVVType::LMUL_RESERVED,
7308 "llvm.riscv.vsetvli/vsetvlimax VLMUL is reserved", &Call);
7309 break;
7310 }
7311 case Intrinsic::callbr_landingpad: {
7312 const auto *CBR = dyn_cast<CallBrInst>(Call.getOperand(0));
7313 Check(CBR, "intrinstic requires callbr operand", &Call);
7314 if (!CBR)
7315 break;
7316
7317 const BasicBlock *LandingPadBB = Call.getParent();
7318 const BasicBlock *PredBB = LandingPadBB->getUniquePredecessor();
7319 if (!PredBB) {
7320 CheckFailed("Intrinsic in block must have 1 unique predecessor", &Call);
7321 break;
7322 }
7323 if (!isa<CallBrInst>(PredBB->getTerminator())) {
7324 CheckFailed("Intrinsic must have corresponding callbr in predecessor",
7325 &Call);
7326 break;
7327 }
7328 Check(llvm::is_contained(CBR->getIndirectDests(), LandingPadBB),
7329 "Intrinsic's corresponding callbr must have intrinsic's parent basic "
7330 "block in indirect destination list",
7331 &Call);
7332 const Instruction &First = *LandingPadBB->begin();
7333 Check(&First == &Call, "No other instructions may proceed intrinsic",
7334 &Call);
7335 break;
7336 }
7337 case Intrinsic::structured_gep: {
7338 // Parser should refuse those 2 cases.
7339 assert(Call.arg_size() >= 1);
7341
7342 Check(Call.paramHasAttr(0, Attribute::ElementType),
7343 "Intrinsic first parameter is missing an ElementType attribute",
7344 &Call);
7345
7346 Type *T = Call.getParamAttr(0, Attribute::ElementType).getValueAsType();
7347 for (unsigned I = 1; I < Call.arg_size(); ++I) {
7349 auto *CI = dyn_cast<ConstantInt>(Index);
7350 Check(Index->getType()->isIntegerTy(),
7351 "Index operand type must be an integer", &Call);
7352
7353 if (auto *AT = dyn_cast<ArrayType>(T)) {
7354 T = AT->getElementType();
7355 } else if (auto *ST = dyn_cast<StructType>(T)) {
7356 Check(CI, "Indexing into a struct requires a constant int", &Call);
7357 Check(CI->getZExtValue() < ST->getNumElements(),
7358 "Indexing in a struct should be inbounds", &Call);
7359 T = ST->getElementType(CI->getZExtValue());
7360 } else if (auto *VT = dyn_cast<VectorType>(T)) {
7361 T = VT->getElementType();
7362 } else {
7363 CheckFailed("Reached a non-composite type with more indices to process",
7364 &Call);
7365 }
7366 }
7367 break;
7368 }
7369 case Intrinsic::structured_alloca:
7370 Check(Call.hasRetAttr(Attribute::ElementType),
7371 "@llvm.structured.alloca calls require elementtype attribute.",
7372 &Call);
7373 break;
7374 case Intrinsic::nvvm_setmaxnreg_inc_sync_aligned_u32:
7375 case Intrinsic::nvvm_setmaxnreg_dec_sync_aligned_u32: {
7376 Value *V = Call.getArgOperand(0);
7377 unsigned RegCount = cast<ConstantInt>(V)->getZExtValue();
7378 Check(RegCount % 8 == 0,
7379 "reg_count argument to nvvm.setmaxnreg must be in multiples of 8");
7380 break;
7381 }
7382 case Intrinsic::nvvm_cp_async_bulk_global_to_shared_cta:
7383 case Intrinsic::nvvm_cp_async_bulk_global_to_shared_cta_relaxed: {
7384 const unsigned ArgSize = Call.arg_size();
7385 const unsigned FlagValidPatternIndex = ArgSize - 1;
7386 const unsigned IgnoreOOBFlagIndex = 8;
7387 bool IgnoreOOB =
7388 cast<ConstantInt>(Call.getArgOperand(IgnoreOOBFlagIndex))->isOne();
7389 const auto *FlagValidPattern =
7390 cast<ConstantInt>(Call.getArgOperand(FlagValidPatternIndex));
7391 Check(!IgnoreOOB || FlagValidPattern->isZero(),
7392 "flag_valid_pattern must be 0 (disabled) when ignore_oob is enabled",
7393 &Call);
7394 break;
7395 }
7396 case Intrinsic::experimental_convergence_entry:
7397 case Intrinsic::experimental_convergence_anchor:
7398 break;
7399 case Intrinsic::experimental_convergence_loop:
7400 break;
7401 case Intrinsic::ptrmask: {
7402 Type *Ty0 = Call.getArgOperand(0)->getType();
7403 Type *Ty1 = Call.getArgOperand(1)->getType();
7405 "llvm.ptrmask intrinsic first argument must be pointer or vector "
7406 "of pointers",
7407 &Call);
7408 Check(
7409 Ty0->isVectorTy() == Ty1->isVectorTy(),
7410 "llvm.ptrmask intrinsic arguments must be both scalars or both vectors",
7411 &Call);
7412 if (Ty0->isVectorTy())
7413 Check(cast<VectorType>(Ty0)->getElementCount() ==
7414 cast<VectorType>(Ty1)->getElementCount(),
7415 "llvm.ptrmask intrinsic arguments must have the same number of "
7416 "elements",
7417 &Call);
7418 Check(DL.getIndexTypeSizeInBits(Ty0) == Ty1->getScalarSizeInBits(),
7419 "llvm.ptrmask intrinsic second argument bitwidth must match "
7420 "pointer index type size of first argument",
7421 &Call);
7422 break;
7423 }
7424 case Intrinsic::thread_pointer: {
7426 DL.getDefaultGlobalsAddressSpace(),
7427 "llvm.thread.pointer intrinsic return type must be for the globals "
7428 "address space",
7429 &Call);
7430 break;
7431 }
7432 case Intrinsic::threadlocal_address: {
7433 const Value &Arg0 = *Call.getArgOperand(0);
7434 Check(isa<GlobalValue>(Arg0),
7435 "llvm.threadlocal.address first argument must be a GlobalValue");
7436 Check(cast<GlobalValue>(Arg0).isThreadLocal(),
7437 "llvm.threadlocal.address operand isThreadLocal() must be true");
7438 break;
7439 }
7440 case Intrinsic::lifetime_start:
7441 case Intrinsic::lifetime_end: {
7442 Value *Ptr = Call.getArgOperand(0);
7443 auto *II = dyn_cast<IntrinsicInst>(Ptr);
7444 Check(isa<AllocaInst>(Ptr) || isa<PoisonValue>(Ptr) ||
7445 (II && II->getIntrinsicID() == Intrinsic::structured_alloca),
7446 "llvm.lifetime.start/end can only be used on alloca or poison",
7447 &Call);
7448 break;
7449 }
7450 case Intrinsic::sponentry: {
7451 const unsigned StackAS = DL.getAllocaAddrSpace();
7452 const Type *RetTy = Call.getFunctionType()->getReturnType();
7453 Check(RetTy->getPointerAddressSpace() == StackAS,
7454 "llvm.sponentry must return a pointer to the stack", &Call);
7455 break;
7456 }
7457 case Intrinsic::write_volatile_register: {
7458 auto *MD = cast<MDNode>(
7459 cast<MetadataAsValue>(Call.getArgOperand(0))->getMetadata());
7460 Check(MD->getNumOperands() == 1 && isa<MDString>(MD->getOperand(0)),
7461 "llvm.write_volatile_register metadata must be a single MDString",
7462 &Call);
7463 break;
7464 }
7465 case Intrinsic::ptrauth_auth_with_pc_and_resign: {
7466 // Verify that the auth key is IA (0) or IB (1), not DA (2) or DB (3)
7467 auto *AuthKey = cast<ConstantInt>(Call.getArgOperand(1));
7468 uint64_t Key = AuthKey->getZExtValue();
7469 Check(Key == 0 || Key == 1,
7470 "ptrauth.auth.with.pc.and.resign key must be IA (0) or IB (1)",
7471 &Call);
7472 break;
7473 }
7474 };
7475
7476 // Verify that there aren't any unmediated control transfers between funclets.
7478 Function *F = Call.getParent()->getParent();
7479 if (F->hasPersonalityFn() &&
7480 isScopedEHPersonality(classifyEHPersonality(F->getPersonalityFn()))) {
7481 // Run EH funclet coloring on-demand and cache results for other intrinsic
7482 // calls in this function
7483 if (BlockEHFuncletColors.empty())
7484 BlockEHFuncletColors = colorEHFunclets(*F);
7485
7486 // colorEHFunclets() leaves unreachable blocks colorless. Such a call
7487 // is in no funclet and WinEHPrepare will not see it, so there is
7488 // nothing to check.
7489 BasicBlock *CallBB = Call.getParent();
7490 auto ColorsIt = BlockEHFuncletColors.find(CallBB);
7491 if (ColorsIt != BlockEHFuncletColors.end()) {
7492 // Check for catch-/cleanup-pad in first funclet block
7493 bool InEHFunclet = false;
7494 const ColorVector &CV = ColorsIt->second;
7495 assert(CV.size() > 0 && "Uncolored block");
7496 for (BasicBlock *ColorFirstBB : CV)
7497 if (auto It = ColorFirstBB->getFirstNonPHIIt();
7498 It != ColorFirstBB->end())
7500 InEHFunclet = true;
7501
7502 // Check for funclet operand bundle
7503 bool HasToken = false;
7504 for (unsigned I = 0, E = Call.getNumOperandBundles(); I != E; ++I)
7506 HasToken = true;
7507
7508 // This would cause silent code truncation in WinEHPrepare
7509 if (InEHFunclet)
7510 Check(HasToken, "Missing funclet token on intrinsic call", &Call);
7511 }
7512 }
7513 }
7514
7515 // Target-specific intrinsic call checks.
7516 verifyAMDGPUIntrinsicCall(*this, ID, Call);
7517 verifyNVVMIntrinsicCall(*this, ID, Call);
7518}
7519
7520/// Carefully grab the subprogram from a local scope.
7521///
7522/// This carefully grabs the subprogram from a local scope, avoiding the
7523/// built-in assertions that would typically fire.
7524DISubprogram *Verifier::getSubprogram(Metadata *LocalScope) {
7525 if (hasDIScopeCycle(LocalScope))
7526 return nullptr;
7527
7528 if (!LocalScope)
7529 return nullptr;
7530
7531 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
7532 return SP;
7533
7534 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
7535 return getSubprogram(LB->getRawScope());
7536
7537 // Just return null; broken scope chains are checked elsewhere.
7538 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
7539 return nullptr;
7540}
7541
7542void Verifier::visit(DbgLabelRecord &DLR) {
7544 "invalid #dbg_label intrinsic variable", &DLR, DLR.getRawLabel());
7545
7546 // Ignore broken !dbg attachments; they're checked elsewhere.
7547 if (MDNode *N = DLR.getDebugLoc().getAsMDNode())
7548 if (!isa<DILocation>(N))
7549 return;
7550
7551 BasicBlock *BB = DLR.getParent();
7552 Function *F = BB ? BB->getParent() : nullptr;
7553
7554 // The scopes for variables and !dbg attachments must agree.
7555 DILabel *Label = DLR.getLabel();
7556 DILocation *Loc = DLR.getDebugLoc();
7557 CheckDI(Loc, "#dbg_label record requires a !dbg attachment", &DLR, BB, F);
7558
7559 DISubprogram *LabelSP = getSubprogram(Label->getRawScope());
7560 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
7561 if (!LabelSP || !LocSP)
7562 return;
7563
7564 CheckDI(LabelSP == LocSP,
7565 "mismatched subprogram between #dbg_label label and !dbg attachment",
7566 &DLR, BB, F, Label, Label->getScope()->getSubprogram(), Loc,
7567 Loc->getScope()->getSubprogram());
7568}
7569
7570void Verifier::visit(DbgVariableRecord &DVR) {
7571 BasicBlock *BB = DVR.getParent();
7572 Function *F = BB->getParent();
7573
7574 CheckDI(DVR.getType() == DbgVariableRecord::LocationType::Value ||
7575 DVR.getType() == DbgVariableRecord::LocationType::Declare ||
7576 DVR.getType() == DbgVariableRecord::LocationType::DeclareValue ||
7577 DVR.getType() == DbgVariableRecord::LocationType::Assign,
7578 "invalid #dbg record type", &DVR, DVR.getType(), BB, F);
7579
7580 // The location for a DbgVariableRecord must be either a ValueAsMetadata,
7581 // DIArgList, or an empty MDNode (which is a legacy representation for an
7582 // "undef" location).
7583 auto *MD = DVR.getRawLocation();
7584 CheckDI(MD && (isa<ValueAsMetadata>(MD) || isa<DIArgList>(MD) ||
7585 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands())),
7586 "invalid #dbg record address/value", &DVR, MD, BB, F);
7587 CheckDI(DVR.isDbgAssign() || !isa<DIAssignID>(MD),
7588 "!DIAssignID should only be used by Assign DVRs.", MD, &DVR);
7589 if (auto *VAM = dyn_cast<ValueAsMetadata>(MD)) {
7590 visitValueAsMetadata(*VAM, F);
7591 if (DVR.isDbgDeclare()) {
7592 // Allow integers here to support inttoptr salvage.
7593 Type *Ty = VAM->getValue()->getType();
7594 CheckDI(Ty->isPointerTy() || Ty->isIntegerTy(),
7595 "location of #dbg_declare must be a pointer or int", &DVR, MD, BB,
7596 F);
7597 }
7598 } else if (auto *AL = dyn_cast<DIArgList>(MD)) {
7599 visitDIArgList(*AL, F);
7600 }
7601
7603 "invalid #dbg record variable", &DVR, DVR.getRawVariable(), BB, F);
7604 visitMDNode(*DVR.getRawVariable(), AreDebugLocsAllowed::No);
7605
7607 "invalid #dbg record expression", &DVR, DVR.getRawExpression(), BB,
7608 F);
7609 visitMDNode(*DVR.getExpression(), AreDebugLocsAllowed::No);
7610
7611 const DIExpression *Expr = DVR.getExpression();
7612 if (Expr->isValid() && !DVR.isKillLocation() &&
7613 (isa<ValueAsMetadata>(MD) || isa<DIArgList>(MD))) {
7614 unsigned NumLocationOps = DVR.getNumVariableLocationOps();
7615 for (DIExpression::ExprOperand Op : Expr->expr_ops()) {
7616 if (Op.getOp() != dwarf::DW_OP_LLVM_arg)
7617 continue;
7618 CheckDI(Op.getArg(0) < NumLocationOps,
7619 "#dbg record expression references nonexistent location operand",
7620 &DVR, Expr, BB, F);
7621 }
7622 }
7623
7624 if (DVR.isDbgAssign()) {
7626 "invalid #dbg_assign DIAssignID", &DVR, DVR.getRawAssignID(), BB,
7627 F);
7628 visitMDNode(*cast<DIAssignID>(DVR.getRawAssignID()),
7629 AreDebugLocsAllowed::No);
7630
7631 const auto *RawAddr = DVR.getRawAddress();
7632 // Similarly to the location above, the address for an assign
7633 // DbgVariableRecord must be a ValueAsMetadata or an empty MDNode, which
7634 // represents an undef address.
7635 CheckDI(
7636 isa<ValueAsMetadata>(RawAddr) ||
7637 (isa<MDNode>(RawAddr) && !cast<MDNode>(RawAddr)->getNumOperands()),
7638 "invalid #dbg_assign address", &DVR, DVR.getRawAddress(), BB, F);
7639 if (auto *VAM = dyn_cast<ValueAsMetadata>(RawAddr))
7640 visitValueAsMetadata(*VAM, F);
7641
7643 "invalid #dbg_assign address expression", &DVR,
7644 DVR.getRawAddressExpression(), BB, F);
7645 visitMDNode(*DVR.getAddressExpression(), AreDebugLocsAllowed::No);
7646
7647 // All of the linked instructions should be in the same function as DVR.
7648 for (Instruction *I : at::getAssignmentInsts(&DVR))
7649 CheckDI(DVR.getFunction() == I->getFunction(),
7650 "inst not in same function as #dbg_assign", I, &DVR, BB, F);
7651 }
7652
7653 // This check is redundant with one in visitLocalVariable().
7654 DILocalVariable *Var = DVR.getVariable();
7655 CheckDI(isType(Var->getRawType()), "invalid type ref", Var, Var->getRawType(),
7656 BB, F);
7657
7658 auto *DLNode = DVR.getDebugLoc().getAsMDNode();
7659 CheckDI(isa_and_nonnull<DILocation>(DLNode), "invalid #dbg record DILocation",
7660 &DVR, DLNode, BB, F);
7661 DILocation *Loc = DVR.getDebugLoc();
7662
7663 // The scopes for variables and !dbg attachments must agree.
7664 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
7665 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
7666 if (!VarSP || !LocSP)
7667 return; // Broken scope chains are checked elsewhere.
7668
7669 CheckDI(VarSP == LocSP,
7670 "mismatched subprogram between #dbg record variable and DILocation",
7671 &DVR, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
7672 Loc->getScope()->getSubprogram(), BB, F);
7673
7674 verifyFnArgs(DVR);
7675}
7676
7677void Verifier::visitVPIntrinsic(VPIntrinsic &VPI) {
7678 switch (VPI.getIntrinsicID()) {
7679 case Intrinsic::experimental_vp_splice: {
7680 VectorType *VecTy = cast<VectorType>(VPI.getType());
7681 int64_t Idx = cast<ConstantInt>(VPI.getArgOperand(2))->getSExtValue();
7682 int64_t KnownMinNumElements = VecTy->getElementCount().getKnownMinValue();
7683 if (VPI.getParent() && VPI.getParent()->getParent()) {
7684 AttributeList Attrs = VPI.getParent()->getParent()->getAttributes();
7685 if (Attrs.hasFnAttr(Attribute::VScaleRange))
7686 KnownMinNumElements *= Attrs.getFnAttrs().getVScaleRangeMin();
7687 }
7688 Check((Idx < 0 && std::abs(Idx) <= KnownMinNumElements) ||
7689 (Idx >= 0 && Idx < KnownMinNumElements),
7690 "The splice index exceeds the range [-VL, VL-1] where VL is the "
7691 "known minimum number of elements in the vector. For scalable "
7692 "vectors the minimum number of elements is determined from "
7693 "vscale_range.",
7694 &VPI);
7695 break;
7696 }
7697 }
7698}
7699
7700void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
7701 switch (FPI.getIntrinsicID()) {
7702 case Intrinsic::experimental_constrained_fcmp:
7703 case Intrinsic::experimental_constrained_fcmps: {
7704 auto Pred = cast<ConstrainedFPCmpIntrinsic>(&FPI)->getPredicate();
7706 "invalid predicate for constrained FP comparison intrinsic", &FPI);
7707 break;
7708 }
7709
7710 case Intrinsic::experimental_constrained_fptosi:
7711 case Intrinsic::experimental_constrained_fptoui: {
7712 Value *Operand = FPI.getArgOperand(0);
7713 ElementCount SrcEC;
7714 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7715 SrcEC = cast<VectorType>(OperandT)->getElementCount();
7716 }
7717
7718 Operand = &FPI;
7719 Check(SrcEC.isNonZero() == Operand->getType()->isVectorTy(),
7720 "Intrinsic first argument and result disagree on vector use", &FPI);
7721 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7722 Check(SrcEC == cast<VectorType>(OperandT)->getElementCount(),
7723 "Intrinsic first argument and result vector lengths must be equal",
7724 &FPI);
7725 }
7726 break;
7727 }
7728
7729 case Intrinsic::experimental_constrained_sitofp:
7730 case Intrinsic::experimental_constrained_uitofp: {
7731 Value *Operand = FPI.getArgOperand(0);
7732 ElementCount SrcEC;
7733 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7734 SrcEC = cast<VectorType>(OperandT)->getElementCount();
7735 }
7736
7737 Operand = &FPI;
7738 Check(SrcEC.isNonZero() == Operand->getType()->isVectorTy(),
7739 "Intrinsic first argument and result disagree on vector use", &FPI);
7740 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) {
7741 Check(SrcEC == cast<VectorType>(OperandT)->getElementCount(),
7742 "Intrinsic first argument and result vector lengths must be equal",
7743 &FPI);
7744 }
7745 break;
7746 }
7747
7748 case Intrinsic::experimental_constrained_fptrunc:
7749 case Intrinsic::experimental_constrained_fpext: {
7750 Value *Operand = FPI.getArgOperand(0);
7751 Type *OperandTy = Operand->getType();
7752 Value *Result = &FPI;
7753 Type *ResultTy = Result->getType();
7754 Check(OperandTy->isVectorTy() == ResultTy->isVectorTy(),
7755 "Intrinsic first argument and result disagree on vector use", &FPI);
7756 if (OperandTy->isVectorTy()) {
7757 Check(cast<VectorType>(OperandTy)->getElementCount() ==
7758 cast<VectorType>(ResultTy)->getElementCount(),
7759 "Intrinsic first argument and result vector lengths must be equal",
7760 &FPI);
7761 }
7762 if (FPI.getIntrinsicID() == Intrinsic::experimental_constrained_fptrunc) {
7763 Check(OperandTy->getScalarSizeInBits() > ResultTy->getScalarSizeInBits(),
7764 "Intrinsic first argument's type must be larger than result type",
7765 &FPI);
7766 } else {
7767 Check(OperandTy->getScalarSizeInBits() < ResultTy->getScalarSizeInBits(),
7768 "Intrinsic first argument's type must be smaller than result type",
7769 &FPI);
7770 }
7771 break;
7772 }
7773
7774 default:
7775 break;
7776 }
7777
7778 // If a non-metadata argument is passed in a metadata slot then the
7779 // error will be caught earlier when the incorrect argument doesn't
7780 // match the specification in the intrinsic call table. Thus, no
7781 // argument type check is needed here.
7782
7783 Check(FPI.getExceptionBehavior().has_value(),
7784 "invalid exception behavior argument", &FPI);
7786 Check(FPI.getRoundingMode().has_value(), "invalid rounding mode argument",
7787 &FPI);
7788 }
7789}
7790
7791void Verifier::verifyFragmentExpression(const DbgVariableRecord &DVR) {
7792 DILocalVariable *V = dyn_cast_or_null<DILocalVariable>(DVR.getRawVariable());
7793 DIExpression *E = dyn_cast_or_null<DIExpression>(DVR.getRawExpression());
7794
7795 // We don't know whether this intrinsic verified correctly.
7796 if (!V || !E || !E->isValid())
7797 return;
7798
7799 // Nothing to do if this isn't a DW_OP_LLVM_fragment expression.
7800 auto Fragment = E->getFragmentInfo();
7801 if (!Fragment)
7802 return;
7803
7804 // The frontend helps out GDB by emitting the members of local anonymous
7805 // unions as artificial local variables with shared storage. When SROA splits
7806 // the storage for artificial local variables that are smaller than the entire
7807 // union, the overhang piece will be outside of the allotted space for the
7808 // variable and this check fails.
7809 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
7810 if (V->isArtificial())
7811 return;
7812
7813 verifyFragmentExpression(*V, *Fragment, &DVR);
7814}
7815
7816template <typename ValueOrMetadata>
7817void Verifier::verifyFragmentExpression(const DIVariable &V,
7819 ValueOrMetadata *Desc) {
7820 // If there's no size, the type is broken, but that should be checked
7821 // elsewhere.
7822 auto VarSize = V.getSizeInBits();
7823 if (!VarSize)
7824 return;
7825
7826 unsigned FragSize = Fragment.SizeInBits;
7827 unsigned FragOffset = Fragment.OffsetInBits;
7828 CheckDI(FragSize + FragOffset <= *VarSize,
7829 "fragment is larger than or outside of variable", Desc, &V);
7830 CheckDI(FragSize != *VarSize, "fragment covers entire variable", Desc, &V);
7831}
7832
7833void Verifier::verifyFnArgs(const DbgVariableRecord &DVR) {
7834 // This function does not take the scope of noninlined function arguments into
7835 // account. Don't run it if current function is nodebug, because it may
7836 // contain inlined debug intrinsics.
7837 if (!HasDebugInfo)
7838 return;
7839
7840 // For performance reasons only check non-inlined ones.
7841 if (DVR.getDebugLoc()->getInlinedAt())
7842 return;
7843
7844 DILocalVariable *Var = DVR.getVariable();
7845 CheckDI(Var, "#dbg record without variable");
7846
7847 unsigned ArgNo = Var->getArg();
7848 if (!ArgNo)
7849 return;
7850
7851 // Verify there are no duplicate function argument debug info entries.
7852 // These will cause hard-to-debug assertions in the DWARF backend.
7853 if (DebugFnArgs.size() < ArgNo)
7854 DebugFnArgs.resize(ArgNo, nullptr);
7855
7856 auto *Prev = DebugFnArgs[ArgNo - 1];
7857 DebugFnArgs[ArgNo - 1] = Var;
7858 CheckDI(!Prev || (Prev == Var), "conflicting debug info for argument", &DVR,
7859 Prev, Var);
7860}
7861
7862void Verifier::verifyNotEntryValue(const DbgVariableRecord &DVR) {
7863 DIExpression *E = dyn_cast_or_null<DIExpression>(DVR.getRawExpression());
7864
7865 // We don't know whether this intrinsic verified correctly.
7866 if (!E || !E->isValid())
7867 return;
7868
7870 Value *VarValue = DVR.getVariableLocationOp(0);
7871 if (isa<UndefValue>(VarValue) || isa<PoisonValue>(VarValue))
7872 return;
7873 // We allow EntryValues for swift async arguments, as they have an
7874 // ABI-guarantee to be turned into a specific register.
7875 if (auto *ArgLoc = dyn_cast_or_null<Argument>(VarValue);
7876 ArgLoc && ArgLoc->hasAttribute(Attribute::SwiftAsync))
7877 return;
7878 }
7879
7880 CheckDI(!E->isEntryValue(),
7881 "Entry values are only allowed in MIR unless they target a "
7882 "swiftasync Argument",
7883 &DVR);
7884}
7885
7886void Verifier::verifyCompileUnits() {
7887 // When more than one Module is imported into the same context, such as during
7888 // an LTO build before linking the modules, ODR type uniquing may cause types
7889 // to point to a different CU. This check does not make sense in this case.
7890 if (M.getContext().isODRUniquingDebugTypes())
7891 return;
7892 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
7893 SmallPtrSet<const Metadata *, 2> Listed;
7894 if (CUs)
7895 Listed.insert_range(CUs->operands());
7896 for (const auto *CU : CUVisited)
7897 CheckDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU);
7898 CUVisited.clear();
7899}
7900
7901void Verifier::verifyDeoptimizeCallingConvs() {
7902 if (DeoptimizeDeclarations.empty())
7903 return;
7904
7905 const Function *First = DeoptimizeDeclarations[0];
7906 for (const auto *F : ArrayRef(DeoptimizeDeclarations).slice(1)) {
7907 Check(First->getCallingConv() == F->getCallingConv(),
7908 "All llvm.experimental.deoptimize declarations must have the same "
7909 "calling convention",
7910 First, F);
7911 }
7912}
7913
7914void Verifier::verifyAttachedCallBundle(const CallBase &Call,
7915 const OperandBundleUse &BU) {
7916 FunctionType *FTy = Call.getFunctionType();
7917
7918 Check((FTy->getReturnType()->isPointerTy() ||
7919 (Call.doesNotReturn() && FTy->getReturnType()->isVoidTy())),
7920 "a call with operand bundle \"clang.arc.attachedcall\" must call a "
7921 "function returning a pointer or a non-returning function that has a "
7922 "void return type",
7923 Call);
7924
7925 Check(BU.Inputs.size() == 1 && isa<Function>(BU.Inputs.front()),
7926 "operand bundle \"clang.arc.attachedcall\" requires one function as "
7927 "an argument",
7928 Call);
7929
7930 auto *Fn = cast<Function>(BU.Inputs.front());
7931 Intrinsic::ID IID = Fn->getIntrinsicID();
7932
7933 if (IID) {
7934 Check((IID == Intrinsic::objc_retainAutoreleasedReturnValue ||
7935 IID == Intrinsic::objc_claimAutoreleasedReturnValue ||
7936 IID == Intrinsic::objc_unsafeClaimAutoreleasedReturnValue),
7937 "invalid function argument", Call);
7938 } else {
7939 StringRef FnName = Fn->getName();
7940 Check((FnName == "objc_retainAutoreleasedReturnValue" ||
7941 FnName == "objc_claimAutoreleasedReturnValue" ||
7942 FnName == "objc_unsafeClaimAutoreleasedReturnValue"),
7943 "invalid function argument", Call);
7944 }
7945}
7946
7947void Verifier::verifyNoAliasScopeDecl() {
7948 if (NoAliasScopeDecls.empty())
7949 return;
7950
7951 // only a single scope must be declared at a time.
7952 for (auto *II : NoAliasScopeDecls) {
7953 assert(II->getIntrinsicID() == Intrinsic::experimental_noalias_scope_decl &&
7954 "Not a llvm.experimental.noalias.scope.decl ?");
7955 const auto *ScopeListMV = dyn_cast<MetadataAsValue>(
7957 Check(ScopeListMV != nullptr,
7958 "llvm.experimental.noalias.scope.decl must have a MetadataAsValue "
7959 "argument",
7960 II);
7961
7962 const auto *ScopeListMD = dyn_cast<MDNode>(ScopeListMV->getMetadata());
7963 Check(ScopeListMD != nullptr, "!id.scope.list must point to an MDNode", II);
7964 Check(ScopeListMD->getNumOperands() == 1,
7965 "!id.scope.list must point to a list with a single scope", II);
7966 visitAliasScopeListMetadata(ScopeListMD);
7967 }
7968
7969 // Only check the domination rule when requested. Once all passes have been
7970 // adapted this option can go away.
7972 return;
7973
7974 // Now sort the intrinsics based on the scope MDNode so that declarations of
7975 // the same scopes are next to each other.
7976 auto GetScope = [](IntrinsicInst *II) {
7977 const auto *ScopeListMV = cast<MetadataAsValue>(
7979 return &cast<MDNode>(ScopeListMV->getMetadata())->getOperand(0);
7980 };
7981
7982 // We are sorting on MDNode pointers here. For valid input IR this is ok.
7983 // TODO: Sort on Metadata ID to avoid non-deterministic error messages.
7984 auto Compare = [GetScope](IntrinsicInst *Lhs, IntrinsicInst *Rhs) {
7985 return GetScope(Lhs) < GetScope(Rhs);
7986 };
7987
7988 llvm::sort(NoAliasScopeDecls, Compare);
7989
7990 // Go over the intrinsics and check that for the same scope, they are not
7991 // dominating each other.
7992 auto ItCurrent = NoAliasScopeDecls.begin();
7993 while (ItCurrent != NoAliasScopeDecls.end()) {
7994 auto CurScope = GetScope(*ItCurrent);
7995 auto ItNext = ItCurrent;
7996 do {
7997 ++ItNext;
7998 } while (ItNext != NoAliasScopeDecls.end() &&
7999 GetScope(*ItNext) == CurScope);
8000
8001 // [ItCurrent, ItNext) represents the declarations for the same scope.
8002 // Ensure they are not dominating each other.. but only if it is not too
8003 // expensive.
8004 if (ItNext - ItCurrent < 32)
8005 for (auto *I : llvm::make_range(ItCurrent, ItNext))
8006 for (auto *J : llvm::make_range(ItCurrent, ItNext))
8007 if (I != J)
8008 Check(!DT.dominates(I, J),
8009 "llvm.experimental.noalias.scope.decl dominates another one "
8010 "with the same scope",
8011 I);
8012 ItCurrent = ItNext;
8013 }
8014}
8015
8016//===----------------------------------------------------------------------===//
8017// Implement the public interfaces to this file...
8018//===----------------------------------------------------------------------===//
8019
8021 Function &F = const_cast<Function &>(f);
8022
8023 // Don't use a raw_null_ostream. Printing IR is expensive.
8024 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
8025
8026 // Note that this function's return value is inverted from what you would
8027 // expect of a function called "verify".
8028 return !V.verify(F);
8029}
8030
8032 bool *BrokenDebugInfo) {
8033 // Don't use a raw_null_ostream. Printing IR is expensive.
8034 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
8035
8036 bool Broken = false;
8037 for (const Function &F : M)
8038 Broken |= !V.verify(F);
8039
8040 Broken |= !V.verify();
8041 if (BrokenDebugInfo)
8042 *BrokenDebugInfo = V.hasBrokenDebugInfo();
8043 // Note that this function's return value is inverted from what you would
8044 // expect of a function called "verify".
8045 return Broken;
8046}
8047
8048namespace {
8049
8050struct VerifierLegacyPass : public FunctionPass {
8051 static char ID;
8052
8053 std::unique_ptr<Verifier> V;
8054 bool FatalErrors = true;
8055
8056 VerifierLegacyPass() : FunctionPass(ID) {}
8057 explicit VerifierLegacyPass(bool FatalErrors)
8058 : FunctionPass(ID), FatalErrors(FatalErrors) {}
8059
8060 bool doInitialization(Module &M) override {
8061 V = std::make_unique<Verifier>(
8062 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
8063 return false;
8064 }
8065
8066 bool runOnFunction(Function &F) override {
8067 if (!V->verify(F) && FatalErrors) {
8068 errs() << "in function " << F.getName() << '\n';
8069 report_fatal_error("Broken function found, compilation aborted!");
8070 }
8071 return false;
8072 }
8073
8074 bool doFinalization(Module &M) override {
8075 bool HasErrors = false;
8076 for (Function &F : M)
8077 if (F.isDeclaration())
8078 HasErrors |= !V->verify(F);
8079
8080 HasErrors |= !V->verify();
8081 if (FatalErrors && (HasErrors || V->hasBrokenDebugInfo()))
8082 report_fatal_error("Broken module found, compilation aborted!");
8083 return false;
8084 }
8085
8086 void getAnalysisUsage(AnalysisUsage &AU) const override {
8087 AU.setPreservesAll();
8088 }
8089};
8090
8091} // end anonymous namespace
8092
8093/// Helper to issue failure from the TBAA verification
8094template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
8095 if (Diagnostic)
8096 return Diagnostic->CheckFailed(Args...);
8097}
8098
8099#define CheckTBAA(C, ...) \
8100 do { \
8101 if (!(C)) { \
8102 CheckFailed(__VA_ARGS__); \
8103 return false; \
8104 } \
8105 } while (false)
8106
8107/// Verify that \p BaseNode can be used as the "base type" in the struct-path
8108/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
8109/// struct-type node describing an aggregate data structure (like a struct).
8110TBAAVerifier::TBAABaseNodeSummary
8111TBAAVerifier::verifyTBAABaseNode(const Instruction *I, const MDNode *BaseNode,
8112 bool IsNewFormat) {
8113 if (BaseNode->getNumOperands() < 2) {
8114 CheckFailed("Base nodes must have at least two operands", I, BaseNode);
8115 return {true, ~0u};
8116 }
8117
8118 auto Itr = TBAABaseNodes.find(BaseNode);
8119 if (Itr != TBAABaseNodes.end())
8120 return Itr->second;
8121
8122 auto Result = verifyTBAABaseNodeImpl(I, BaseNode, IsNewFormat);
8123 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
8124 (void)InsertResult;
8125 assert(InsertResult.second && "We just checked!");
8126 return Result;
8127}
8128
8129TBAAVerifier::TBAABaseNodeSummary
8130TBAAVerifier::verifyTBAABaseNodeImpl(const Instruction *I,
8131 const MDNode *BaseNode, bool IsNewFormat) {
8132 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
8133
8134 if (BaseNode->getNumOperands() == 2) {
8135 // Scalar nodes can only be accessed at offset 0.
8136 return isValidScalarTBAANode(BaseNode)
8137 ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
8138 : InvalidNode;
8139 }
8140
8141 if (IsNewFormat) {
8142 if (BaseNode->getNumOperands() % 3 != 0) {
8143 CheckFailed("Access tag nodes must have the number of operands that is a "
8144 "multiple of 3!", BaseNode);
8145 return InvalidNode;
8146 }
8147 } else {
8148 if (BaseNode->getNumOperands() % 2 != 1) {
8149 CheckFailed("Struct tag nodes must have an odd number of operands!",
8150 BaseNode);
8151 return InvalidNode;
8152 }
8153 }
8154
8155 // Check the type size field.
8156 if (IsNewFormat) {
8157 auto *TypeSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
8158 BaseNode->getOperand(1));
8159 if (!TypeSizeNode) {
8160 CheckFailed("Type size nodes must be constants!", I, BaseNode);
8161 return InvalidNode;
8162 }
8163 }
8164
8165 // Check the type name field. In the new format it can be anything.
8166 if (!IsNewFormat && !isa<MDString>(BaseNode->getOperand(0))) {
8167 CheckFailed("Struct tag nodes have a string as their first operand",
8168 BaseNode);
8169 return InvalidNode;
8170 }
8171
8172 bool Failed = false;
8173
8174 std::optional<APInt> PrevOffset;
8175 unsigned BitWidth = ~0u;
8176
8177 // We've already checked that BaseNode is not a degenerate root node with one
8178 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
8179 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
8180 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
8181 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
8182 Idx += NumOpsPerField) {
8183 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
8184 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
8185 if (!isa<MDNode>(FieldTy)) {
8186 CheckFailed("Incorrect field entry in struct type node!", I, BaseNode);
8187 Failed = true;
8188 continue;
8189 }
8190
8191 auto *OffsetEntryCI =
8193 if (!OffsetEntryCI) {
8194 CheckFailed("Offset entries must be constants!", I, BaseNode);
8195 Failed = true;
8196 continue;
8197 }
8198
8199 if (BitWidth == ~0u)
8200 BitWidth = OffsetEntryCI->getBitWidth();
8201
8202 if (OffsetEntryCI->getBitWidth() != BitWidth) {
8203 CheckFailed(
8204 "Bitwidth between the offsets and struct type entries must match", I,
8205 BaseNode);
8206 Failed = true;
8207 continue;
8208 }
8209
8210 // NB! As far as I can tell, we generate a non-strictly increasing offset
8211 // sequence only from structs that have zero size bit fields. When
8212 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
8213 // pick the field lexically the latest in struct type metadata node. This
8214 // mirrors the actual behavior of the alias analysis implementation.
8215 bool IsAscending =
8216 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
8217
8218 if (!IsAscending) {
8219 CheckFailed("Offsets must be increasing!", I, BaseNode);
8220 Failed = true;
8221 }
8222
8223 PrevOffset = OffsetEntryCI->getValue();
8224
8225 if (IsNewFormat) {
8226 auto *MemberSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
8227 BaseNode->getOperand(Idx + 2));
8228 if (!MemberSizeNode) {
8229 CheckFailed("Member size entries must be constants!", I, BaseNode);
8230 Failed = true;
8231 continue;
8232 }
8233 }
8234 }
8235
8236 return Failed ? InvalidNode
8237 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
8238}
8239
8240static bool IsRootTBAANode(const MDNode *MD) {
8241 return MD->getNumOperands() < 2;
8242}
8243
8244static bool IsScalarTBAANodeImpl(const MDNode *MD,
8246 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
8247 return false;
8248
8249 if (!isa<MDString>(MD->getOperand(0)))
8250 return false;
8251
8252 if (MD->getNumOperands() == 3) {
8254 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
8255 return false;
8256 }
8257
8258 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
8259 return Parent && Visited.insert(Parent).second &&
8260 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
8261}
8262
8263bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
8264 auto ResultIt = TBAAScalarNodes.find(MD);
8265 if (ResultIt != TBAAScalarNodes.end())
8266 return ResultIt->second;
8267
8268 SmallPtrSet<const MDNode *, 4> Visited;
8269 bool Result = IsScalarTBAANodeImpl(MD, Visited);
8270 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
8271 (void)InsertResult;
8272 assert(InsertResult.second && "Just checked!");
8273
8274 return Result;
8275}
8276
8277/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
8278/// Offset in place to be the offset within the field node returned.
8279///
8280/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
8281MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(const Instruction *I,
8282 const MDNode *BaseNode,
8283 APInt &Offset,
8284 bool IsNewFormat) {
8285 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
8286
8287 // Scalar nodes have only one possible "field" -- their parent in the access
8288 // hierarchy. Offset must be zero at this point, but our caller is supposed
8289 // to check that.
8290 if (BaseNode->getNumOperands() == 2)
8291 return cast<MDNode>(BaseNode->getOperand(1));
8292
8293 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
8294 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
8295 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
8296 Idx += NumOpsPerField) {
8297 auto *OffsetEntryCI =
8298 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
8299 if (OffsetEntryCI->getValue().ugt(Offset)) {
8300 if (Idx == FirstFieldOpNo) {
8301 CheckFailed("Could not find TBAA parent in struct type node", I,
8302 BaseNode, &Offset);
8303 return nullptr;
8304 }
8305
8306 unsigned PrevIdx = Idx - NumOpsPerField;
8307 auto *PrevOffsetEntryCI =
8308 mdconst::extract<ConstantInt>(BaseNode->getOperand(PrevIdx + 1));
8309 Offset -= PrevOffsetEntryCI->getValue();
8310 return cast<MDNode>(BaseNode->getOperand(PrevIdx));
8311 }
8312 }
8313
8314 unsigned LastIdx = BaseNode->getNumOperands() - NumOpsPerField;
8315 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
8316 BaseNode->getOperand(LastIdx + 1));
8317 Offset -= LastOffsetEntryCI->getValue();
8318 return cast<MDNode>(BaseNode->getOperand(LastIdx));
8319}
8320
8322 if (!Type || Type->getNumOperands() < 3)
8323 return false;
8324
8325 // In the new format type nodes shall have a reference to the parent type as
8326 // its first operand.
8327 return isa_and_nonnull<MDNode>(Type->getOperand(0));
8328}
8329
8331 CheckTBAA(MD->getNumOperands() > 0, "TBAA metadata cannot have 0 operands", I,
8332 MD);
8333
8334 if (I)
8338 "This instruction shall not have a TBAA access tag!", I);
8339
8340 bool IsStructPathTBAA =
8341 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
8342
8343 CheckTBAA(IsStructPathTBAA,
8344 "Old-style TBAA is no longer allowed, use struct-path TBAA instead",
8345 I);
8346
8347 auto *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
8348 auto *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
8349
8350 bool IsNewFormat = isNewFormatTBAATypeNode(AccessType);
8351
8352 if (IsNewFormat) {
8353 CheckTBAA(MD->getNumOperands() == 4 || MD->getNumOperands() == 5,
8354 "Access tag metadata must have either 4 or 5 operands", I, MD);
8355 } else {
8356 CheckTBAA(MD->getNumOperands() < 5,
8357 "Struct tag metadata must have either 3 or 4 operands", I, MD);
8358 }
8359
8360 // Check the access size field.
8361 if (IsNewFormat) {
8362 auto *AccessSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
8363 MD->getOperand(3));
8364 CheckTBAA(AccessSizeNode, "Access size field must be a constant", I, MD);
8365 }
8366
8367 // Check the immutability flag.
8368 unsigned ImmutabilityFlagOpNo = IsNewFormat ? 4 : 3;
8369 if (MD->getNumOperands() == ImmutabilityFlagOpNo + 1) {
8370 auto *IsImmutableCI = mdconst::dyn_extract_or_null<ConstantInt>(
8371 MD->getOperand(ImmutabilityFlagOpNo));
8372 CheckTBAA(IsImmutableCI,
8373 "Immutability tag on struct tag metadata must be a constant", I,
8374 MD);
8375 CheckTBAA(
8376 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
8377 "Immutability part of the struct tag metadata must be either 0 or 1", I,
8378 MD);
8379 }
8380
8381 CheckTBAA(BaseNode && AccessType,
8382 "Malformed struct tag metadata: base and access-type "
8383 "should be non-null and point to Metadata nodes",
8384 I, MD, BaseNode, AccessType);
8385
8386 if (!IsNewFormat) {
8387 CheckTBAA(isValidScalarTBAANode(AccessType),
8388 "Access type node must be a valid scalar type", I, MD,
8389 AccessType);
8390 }
8391
8393 CheckTBAA(OffsetCI, "Offset must be constant integer", I, MD);
8394
8395 APInt Offset = OffsetCI->getValue();
8396 bool SeenAccessTypeInPath = false;
8397
8398 SmallPtrSet<MDNode *, 4> StructPath;
8399
8400 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
8401 BaseNode =
8402 getFieldNodeFromTBAABaseNode(I, BaseNode, Offset, IsNewFormat)) {
8403 if (!StructPath.insert(BaseNode).second) {
8404 CheckFailed("Cycle detected in struct path", I, MD);
8405 return false;
8406 }
8407
8408 bool Invalid;
8409 unsigned BaseNodeBitWidth;
8410 std::tie(Invalid, BaseNodeBitWidth) =
8411 verifyTBAABaseNode(I, BaseNode, IsNewFormat);
8412
8413 // If the base node is invalid in itself, then we've already printed all the
8414 // errors we wanted to print.
8415 if (Invalid)
8416 return false;
8417
8418 SeenAccessTypeInPath |= BaseNode == AccessType;
8419
8420 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
8421 CheckTBAA(Offset == 0, "Offset not zero at the point of scalar access", I,
8422 MD, &Offset);
8423
8424 CheckTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
8425 (BaseNodeBitWidth == 0 && Offset == 0) ||
8426 (IsNewFormat && BaseNodeBitWidth == ~0u),
8427 "Access bit-width not the same as description bit-width", I, MD,
8428 BaseNodeBitWidth, Offset.getBitWidth());
8429
8430 if (IsNewFormat && SeenAccessTypeInPath)
8431 break;
8432 }
8433
8434 CheckTBAA(SeenAccessTypeInPath, "Did not see access type in access path!", I,
8435 MD);
8436 return true;
8437}
8438
8440 const MDNode *MD) {
8441 // !tbaa.struct is a list of (offset, size, tag) triples with ascending
8442 // offsets. Offset and size must be constants; a tag must be null or a valid
8443 // access tag.
8444 CheckTBAA(MD->getNumOperands() % 3 == 0,
8445 "!tbaa.struct operands must come in groups of three", I, MD);
8446
8447 std::optional<APInt> PrevOffset;
8448 for (unsigned Idx = 0, E = MD->getNumOperands(); Idx != E; Idx += 3) {
8449 auto *OffsetCI =
8451 CheckTBAA(OffsetCI, "!tbaa.struct field offset must be a constant integer",
8452 I, MD);
8453 CheckTBAA(
8455 "!tbaa.struct field size must be a constant integer", I, MD);
8456 if (const Metadata *TagMD = MD->getOperand(Idx + 2)) {
8457 auto *Tag = dyn_cast<MDNode>(TagMD);
8458 CheckTBAA(Tag, "!tbaa.struct field tag must be null or an MDNode", I, MD);
8459 if (!visitTBAAMetadata(I, Tag))
8460 return false;
8461 }
8462
8463 const APInt &Offset = OffsetCI->getValue();
8464 if (PrevOffset) {
8465 unsigned Width =
8466 std::max(PrevOffset->getBitWidth(), Offset.getBitWidth());
8467 CheckTBAA(PrevOffset->zext(Width).ule(Offset.zext(Width)),
8468 "!tbaa.struct field offsets must be non-decreasing", I, MD);
8469 }
8470 PrevOffset = Offset;
8471 }
8472 return true;
8473}
8474
8475char VerifierLegacyPass::ID = 0;
8476INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
8477
8479 return new VerifierLegacyPass(FatalErrors);
8480}
8481
8482AnalysisKey VerifierAnalysis::Key;
8489
8494
8496 auto Res = AM.getResult<VerifierAnalysis>(M);
8497 if (FatalErrors && (Res.IRBroken || Res.DebugInfoBroken))
8498 report_fatal_error("Broken module found, compilation aborted!");
8499
8500 return PreservedAnalyses::all();
8501}
8502
8504 auto res = AM.getResult<VerifierAnalysis>(F);
8505 if (res.IRBroken && FatalErrors)
8506 report_fatal_error("Broken function found, compilation aborted!");
8507
8508 return PreservedAnalyses::all();
8509}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
unsigned uint64_t
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
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.
const SmallVectorImpl< MachineOperand > & 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)
static bool isNewFormatTBAATypeNode(llvm::MDNode *Type)
#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 cl::opt< bool > VerifyNoAliasScopeDomination("verify-noalias-scope-decl-dom", cl::Hidden, cl::init(false), cl::desc("Ensure that llvm.experimental.noalias.scope.decl for identical " "scopes are not dominating"))
#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 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:6162
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:6145
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:266
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).
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
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:64
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:717
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:767
iterator end()
Definition DenseMap.h:687
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:794
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition DenseMap.h:828
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
Definition Dominators.h:122
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:314
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:824
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
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.
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.
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:71
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.
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:615
static LLVM_ABI bool isTagMD(const Metadata *MD)
This class implements a map that also provides access to all stored values in a deterministic order.
Definition MapVector.h:38
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.
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.
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.
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:39
Verify that the TBAA Metadatas are valid.
Definition Verifier.h:40
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
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:716
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:828
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:712
bool hasName() const
Definition Value.h:263
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
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:209
constexpr bool isNonZero() const
Definition TypeSize.h:155
constexpr bool isScalable() const
Returns whether the quantity is scaled by a runtime quantity (vscale).
Definition TypeSize.h:168
constexpr ScalarTy getKnownMinValue() const
Returns the minimum value this quantity can represent.
Definition TypeSize.h:165
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
@ System
Synchronized with respect to all concurrently executing threads.
Definition LLVMContext.h:61
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
initializer< Ty > init(const Ty &Val)
@ 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:916
@ DW_MACINFO_start_file
Definition Dwarf.h:917
@ DW_MACINFO_define
Definition Dwarf.h:915
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:381
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 >
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 * SyntheticFunctionEntryCount
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