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 visitDbgLabelIntrinsic(StringRef Kind, DbgLabelInst &DLI);
454 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
455 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
456 void visitFenceInst(FenceInst &FI);
457 void visitAllocaInst(AllocaInst &AI);
458 void visitExtractValueInst(ExtractValueInst &EVI);
459 void visitInsertValueInst(InsertValueInst &IVI);
460 void visitEHPadPredecessors(Instruction &I);
461 void visitLandingPadInst(LandingPadInst &LPI);
462 void visitResumeInst(ResumeInst &RI);
463 void visitCatchPadInst(CatchPadInst &CPI);
464 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
465 void visitCleanupPadInst(CleanupPadInst &CPI);
466 void visitFuncletPadInst(FuncletPadInst &FPI);
467 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
468 void visitCleanupReturnInst(CleanupReturnInst &CRI);
469
470 void verifySwiftErrorCall(CallBase &Call, const Value *SwiftErrorVal);
471 void verifySwiftErrorValue(const Value *SwiftErrorVal);
472 void verifyTailCCMustTailAttrs(const AttrBuilder &Attrs, StringRef Context);
473 void verifyMustTailCall(CallInst &CI);
474 bool verifyAttributeCount(AttributeList Attrs, unsigned Params);
475 void verifyAttributeTypes(AttributeSet Attrs, const Value *V);
476 void verifyParameterAttrs(AttributeSet Attrs, Type *Ty, const Value *V);
477 void checkUnsignedBaseTenFuncAttr(AttributeList Attrs, StringRef Attr,
478 const Value *V);
479 void verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
480 const Value *V, bool IsIntrinsic, bool IsInlineAsm);
481 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
482 void verifyUnknownProfileMetadata(MDNode *MD);
483 void visitConstantExprsRecursively(const Constant *EntryC);
484 void visitConstantExpr(const ConstantExpr *CE);
485 void visitConstantPtrAuth(const ConstantPtrAuth *CPA);
486 void verifyInlineAsmCall(const CallBase &Call);
487 void verifyStatepoint(const CallBase &Call);
488 void verifyFrameRecoverIndices();
489 void verifySiblingFuncletUnwinds();
490
491 void verifyFragmentExpression(const DbgVariableRecord &I);
492 template <typename ValueOrMetadata>
493 void verifyFragmentExpression(const DIVariable &V,
495 ValueOrMetadata *Desc);
496 void verifyFnArgs(const DbgVariableRecord &DVR);
497 void verifyNotEntryValue(const DbgVariableRecord &I);
498
499 /// Module-level debug info verification...
500 void verifyCompileUnits();
501
502 /// Module-level verification that all @llvm.experimental.deoptimize
503 /// declarations share the same calling convention.
504 void verifyDeoptimizeCallingConvs();
505
506 void verifyAttachedCallBundle(const CallBase &Call,
507 const OperandBundleUse &BU);
508
509 /// Verify the llvm.experimental.noalias.scope.decl declarations
510 void verifyNoAliasScopeDecl();
511};
512
513} // end anonymous namespace
514
515/// We know that cond should be true, if not print an error message.
516#define Check(C, ...) \
517 do { \
518 if (!(C)) { \
519 CheckFailed(__VA_ARGS__); \
520 return; \
521 } \
522 } while (false)
523
524/// We know that a debug info condition should be true, if not print
525/// an error message.
526#define CheckDI(C, ...) \
527 do { \
528 if (!(C)) { \
529 DebugInfoCheckFailed(__VA_ARGS__); \
530 return; \
531 } \
532 } while (false)
533
534void Verifier::visitDbgRecords(Instruction &I) {
535 if (!I.getDbgMarker())
536 return;
537 CheckDI(I.getDbgMarker()->MarkedInstr == &I,
538 "Instruction has invalid DebugMarker", &I);
539 CheckDI(!isa<PHINode>(&I) || !I.hasDbgRecords(),
540 "PHI Node must not have any attached DbgRecords", &I);
541 for (DbgRecord &DR : I.getDbgRecordRange()) {
542 CheckDI(DR.getMarker() == I.getDbgMarker(),
543 "DbgRecord had invalid DebugMarker", &I, &DR);
544 if (auto *Loc =
545 dyn_cast_or_null<DILocation>(DR.getDebugLoc().getAsMDNode()))
546 visitMDNode(*Loc, AreDebugLocsAllowed::Yes);
547 if (auto *DVR = dyn_cast<DbgVariableRecord>(&DR)) {
548 visit(*DVR);
549 // These have to appear after `visit` for consistency with existing
550 // intrinsic behaviour.
551 verifyFragmentExpression(*DVR);
552 verifyNotEntryValue(*DVR);
553 } else if (auto *DLR = dyn_cast<DbgLabelRecord>(&DR)) {
554 visit(*DLR);
555 }
556 }
557}
558
559void Verifier::visit(Instruction &I) {
560 visitDbgRecords(I);
561 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
562 Check(I.getOperand(i) != nullptr, "Operand is null", &I);
564}
565
566// Helper to iterate over indirect users. By returning false, the callback can ask to stop traversing further.
567static void forEachUser(const Value *User,
569 llvm::function_ref<bool(const Value *)> Callback) {
570 if (!Visited.insert(User).second)
571 return;
572
574 while (!WorkList.empty()) {
575 const Value *Cur = WorkList.pop_back_val();
576 if (!Visited.insert(Cur).second)
577 continue;
578 if (Callback(Cur))
579 append_range(WorkList, Cur->materialized_users());
580 }
581}
582
583void Verifier::visitGlobalValue(const GlobalValue &GV) {
585 "Global is external, but doesn't have external or weak linkage!", &GV);
586
587 if (const auto *GO = dyn_cast<GlobalObject>(&GV)) {
588 if (const MDNode *Associated =
589 GO->getMetadata(LLVMContext::MD_associated)) {
590 Check(Associated->getNumOperands() == 1,
591 "associated metadata must have one operand", &GV, Associated);
592 const Metadata *Op = Associated->getOperand(0).get();
593 Check(Op, "associated metadata must have a global value", GO, Associated);
594
595 const auto *VM = dyn_cast_or_null<ValueAsMetadata>(Op);
596 Check(VM, "associated metadata must be ValueAsMetadata", GO, Associated);
597 if (VM) {
598 Check(isa<PointerType>(VM->getValue()->getType()),
599 "associated value must be pointer typed", GV, Associated);
600
601 const Value *Stripped = VM->getValue()->stripPointerCastsAndAliases();
602 Check(isa<GlobalObject>(Stripped) || isa<Constant>(Stripped),
603 "associated metadata must point to a GlobalObject", GO, Stripped);
604 Check(Stripped != GO,
605 "global values should not associate to themselves", GO,
606 Associated);
607 }
608 }
609
610 // FIXME: Why is getMetadata on GlobalValue protected?
611 if (const MDNode *AbsoluteSymbol =
612 GO->getMetadata(LLVMContext::MD_absolute_symbol)) {
613 verifyRangeLikeMetadata(*GO, AbsoluteSymbol,
614 DL.getIntPtrType(GO->getType()),
615 RangeLikeMetadataKind::AbsoluteSymbol);
616 }
617
618 if (GO->hasMetadata(LLVMContext::MD_implicit_ref)) {
619 Check(!GO->isDeclaration(),
620 "ref metadata must not be placed on a declaration", GO);
621
623 GO->getMetadata(LLVMContext::MD_implicit_ref, MDs);
624 for (const MDNode *MD : MDs) {
625 Check(MD->getNumOperands() == 1, "ref metadata must have one operand",
626 &GV, MD);
627 const Metadata *Op = MD->getOperand(0).get();
628 const auto *VM = dyn_cast_or_null<ValueAsMetadata>(Op);
629 Check(VM, "ref metadata must be ValueAsMetadata", GO, MD);
630 if (VM) {
631 Check(isa<PointerType>(VM->getValue()->getType()),
632 "ref value must be pointer typed", GV, MD);
633
634 const Value *Stripped = VM->getValue()->stripPointerCastsAndAliases();
635 Check(isa<GlobalObject>(Stripped) || isa<Constant>(Stripped),
636 "ref metadata must point to a GlobalObject", GO, Stripped);
637 Check(Stripped != GO, "values should not reference themselves", GO,
638 MD);
639 }
640 }
641 }
642
643 if (auto *Props = GO->getMetadata(LLVMContext::MD_elf_section_properties)) {
644 Check(Props->getNumOperands() == 2,
645 "elf_section_properties metadata must have two operands", GO,
646 Props);
647 if (Props->getNumOperands() == 2) {
648 auto *Type = dyn_cast<ConstantAsMetadata>(Props->getOperand(0));
649 Check(Type, "type field must be ConstantAsMetadata", GO, Props);
650 auto *TypeInt = dyn_cast<ConstantInt>(Type->getValue());
651 Check(TypeInt, "type field must be ConstantInt", GO, Props);
652
653 auto *Entsize = dyn_cast<ConstantAsMetadata>(Props->getOperand(1));
654 Check(Entsize, "entsize field must be ConstantAsMetadata", GO, Props);
655 auto *EntsizeInt = dyn_cast<ConstantInt>(Entsize->getValue());
656 Check(EntsizeInt, "entsize field must be ConstantInt", GO, Props);
657 }
658 }
659 }
660
662 "Only global variables can have appending linkage!", &GV);
663
664 if (GV.hasAppendingLinkage()) {
665 const auto *GVar = dyn_cast<GlobalVariable>(&GV);
666 Check(GVar && GVar->getValueType()->isArrayTy(),
667 "Only global arrays can have appending linkage!", GVar);
668 }
669
670 if (GV.isDeclarationForLinker())
671 Check(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
672
673 if (GV.hasDLLExportStorageClass()) {
675 "dllexport GlobalValue must have default or protected visibility",
676 &GV);
677 }
678 if (GV.hasDLLImportStorageClass()) {
680 "dllimport GlobalValue must have default visibility", &GV);
681 Check(!GV.isDSOLocal(), "GlobalValue with DLLImport Storage is dso_local!",
682 &GV);
683
684 Check((GV.isDeclaration() &&
687 "Global is marked as dllimport, but not external", &GV);
688 }
689
690 if (GV.isImplicitDSOLocal())
691 Check(GV.isDSOLocal(),
692 "GlobalValue with local linkage or non-default "
693 "visibility must be dso_local!",
694 &GV);
695
696 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
697 if (const auto *I = dyn_cast<Instruction>(V)) {
698 if (!I->getParent() || !I->getParent()->getParent())
699 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
700 I);
701 else if (I->getParent()->getParent()->getParent() != &M)
702 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
703 I->getParent()->getParent(),
704 I->getParent()->getParent()->getParent());
705 return false;
706 } else if (const auto *F = dyn_cast<Function>(V)) {
707 if (F->getParent() != &M)
708 CheckFailed("Global is used by function in a different module", &GV, &M,
709 F, F->getParent());
710 return false;
711 }
712 return true;
713 });
714}
715
716void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
717 // Target-specific global variable checks. Done first because this function
718 // returns early for a global without an initializer.
720
721 Type *GVType = GV.getValueType();
722
723 if (MaybeAlign A = GV.getAlign()) {
724 Check(A->value() <= Value::MaximumAlignment,
725 "huge alignment values are unsupported", &GV);
726 }
727
728 if (GV.hasInitializer()) {
729 Check(GV.getInitializer()->getType() == GVType,
730 "Global variable initializer type does not match global "
731 "variable type!",
732 &GV);
734 "Global variable initializer must be sized", &GV);
735 visitConstantExprsRecursively(GV.getInitializer());
736 // If the global has common linkage, it must have a zero initializer and
737 // cannot be constant.
738 if (GV.hasCommonLinkage()) {
740 "'common' global must have a zero initializer!", &GV);
741 Check(!GV.isConstant(), "'common' global may not be marked constant!",
742 &GV);
743 Check(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
744 }
745 }
746
747 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
748 GV.getName() == "llvm.global_dtors")) {
750 "invalid linkage for intrinsic global variable", &GV);
752 "invalid uses of intrinsic global variable", &GV);
753
754 // Don't worry about emitting an error for it not being an array,
755 // visitGlobalValue will complain on appending non-array.
756 if (const auto *ATy = dyn_cast<ArrayType>(GVType)) {
757 const auto *STy = dyn_cast<StructType>(ATy->getElementType());
758 PointerType *FuncPtrTy =
759 PointerType::get(Context, DL.getProgramAddressSpace());
760 Check(STy && (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
761 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
762 STy->getTypeAtIndex(1) == FuncPtrTy,
763 "wrong type for intrinsic global variable", &GV);
764 Check(STy->getNumElements() == 3,
765 "the third field of the element type is mandatory, "
766 "specify ptr null to migrate from the obsoleted 2-field form");
767 Type *ETy = STy->getTypeAtIndex(2);
768 Check(ETy->isPointerTy(), "wrong type for intrinsic global variable",
769 &GV);
770 }
771
772 auto *Init = GV.hasInitializer()
774 : nullptr;
775 if (Init) {
776 for (const Use &U : Init->operands()) {
777 auto *Structor = dyn_cast<ConstantStruct>(U);
778 if (!Structor || Structor->getNumOperands() != 3)
779 continue;
780 Check(!isa<ConstantPtrAuth>(Structor->getOperand(1)),
781 "signing of ctors/dtors should be requested via module flags");
782 }
783 }
784 }
785
786 if (GV.hasName() && (GV.getName() == "llvm.used" ||
787 GV.getName() == "llvm.compiler.used")) {
789 "invalid linkage for intrinsic global variable", &GV);
791 "invalid uses of intrinsic global variable", &GV);
792
793 if (const auto *ATy = dyn_cast<ArrayType>(GVType)) {
794 const auto *PTy = dyn_cast<PointerType>(ATy->getElementType());
795 Check(PTy, "wrong type for intrinsic global variable", &GV);
796 if (GV.hasInitializer()) {
797 const Constant *Init = GV.getInitializer();
798 const auto *InitArray = dyn_cast<ConstantArray>(Init);
799 Check(InitArray, "wrong initializer for intrinsic global variable",
800 Init);
801 for (Value *Op : InitArray->operands()) {
802 Value *V = Op->stripPointerCasts();
805 Twine("invalid ") + GV.getName() + " member", V);
806 Check(V->hasName(),
807 Twine("members of ") + GV.getName() + " must be named", V);
808 }
809 }
810 }
811 }
812
813 // Visit any debug info attachments.
815 GV.getMetadata(LLVMContext::MD_dbg, MDs);
816 for (MDNode *MD : MDs) {
817 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
818 visitDIGlobalVariableExpression(*GVE);
819 else
820 CheckDI(false, "!dbg attachment of global variable must be a "
821 "DIGlobalVariableExpression");
822 }
823
824 // Scalable vectors cannot be global variables, since we don't know
825 // the runtime size.
826 Check(!GVType->isScalableTy(), "Globals cannot contain scalable types", &GV);
827
828 // Check if it is or contains a target extension type that disallows being
829 // used as a global.
831 "Global @" + GV.getName() + " has illegal target extension type",
832 GVType);
833
834 // Check that the the address space can hold all bits of the type, recognized
835 // by an access in the address space being able to reach all bytes of the
836 // type.
837 Check(!GVType->isSized() ||
838 isUIntN(DL.getAddressSizeInBits(GV.getAddressSpace()),
839 GV.getGlobalSize(DL)),
840 "Global variable is too large to fit into the address space", &GV,
841 GVType);
842
843 if (!GV.hasInitializer()) {
844 visitGlobalValue(GV);
845 return;
846 }
847
848 // Walk any aggregate initializers looking for bitcasts between address spaces
849 visitConstantExprsRecursively(GV.getInitializer());
850
851 visitGlobalValue(GV);
852}
853
854void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
855 SmallPtrSet<const GlobalAlias*, 4> Visited;
856 Visited.insert(&GA);
857 visitAliaseeSubExpr(Visited, GA, C);
858}
859
860void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
861 const GlobalAlias &GA, const Constant &C) {
864 cast<GlobalValue>(C).hasAvailableExternallyLinkage(),
865 "available_externally alias must point to available_externally "
866 "global value",
867 &GA);
868 }
869 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
871 Check(!GV->isDeclarationForLinker(), "Alias must point to a definition",
872 &GA);
873 }
874
875 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
876 Check(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
877
878 Check(!GA2->isInterposable(),
879 "Alias cannot point to an interposable alias", &GA);
880 } else {
881 // Only continue verifying subexpressions of GlobalAliases.
882 // Do not recurse into global initializers.
883 return;
884 }
885 }
886
887 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
888 visitConstantExprsRecursively(CE);
889
890 for (const Use &U : C.operands()) {
891 Value *V = &*U;
892 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
893 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
894 else if (const auto *C2 = dyn_cast<Constant>(V))
895 visitAliaseeSubExpr(Visited, GA, *C2);
896 }
897}
898
899void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
901 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
902 "weak_odr, external, or available_externally linkage!",
903 &GA);
904 const Constant *Aliasee = GA.getAliasee();
905 Check(Aliasee, "Aliasee cannot be NULL!", &GA);
906 Check(GA.getType() == Aliasee->getType(),
907 "Alias and aliasee types should match!", &GA);
908
909 Check(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
910 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
911
912 visitAliaseeSubExpr(GA, *Aliasee);
913
914 visitGlobalValue(GA);
915}
916
917void Verifier::visitGlobalIFunc(const GlobalIFunc &GI) {
918 visitGlobalValue(GI);
919
921 GI.getAllMetadata(MDs);
922 for (const auto &I : MDs) {
923 CheckDI(I.first != LLVMContext::MD_dbg,
924 "an ifunc may not have a !dbg attachment", &GI);
925 Check(I.first != LLVMContext::MD_prof,
926 "an ifunc may not have a !prof attachment", &GI);
927 visitMDNode(*I.second, AreDebugLocsAllowed::No);
928 }
929
931 "IFunc should have private, internal, linkonce, weak, linkonce_odr, "
932 "weak_odr, or external linkage!",
933 &GI);
934 // Pierce through ConstantExprs and GlobalAliases and check that the resolver
935 // is a Function definition.
936 const Function *Resolver = GI.getResolverFunction();
937 Check(Resolver, "IFunc must have a Function resolver", &GI);
938 Check(!Resolver->isDeclarationForLinker(),
939 "IFunc resolver must be a definition", &GI);
940
941 // Check that the immediate resolver operand (prior to any bitcasts) has the
942 // correct type.
943 const Type *ResolverTy = GI.getResolver()->getType();
944
946 "IFunc resolver must return a pointer", &GI);
947
948 Check(ResolverTy == PointerType::get(Context, GI.getAddressSpace()),
949 "IFunc resolver has incorrect type", &GI);
950}
951
952void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
953 // There used to be various other llvm.dbg.* nodes, but we don't support
954 // upgrading them and we want to reserve the namespace for future uses.
955 if (NMD.getName().starts_with("llvm.dbg."))
956 CheckDI(NMD.getName() == "llvm.dbg.cu",
957 "unrecognized named metadata node in the llvm.dbg namespace", &NMD);
958 for (const MDNode *MD : NMD.operands()) {
959 if (NMD.getName() == "llvm.dbg.cu")
960 CheckDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
961
962 if (!MD)
963 continue;
964
965 visitMDNode(*MD, AreDebugLocsAllowed::Yes);
966 }
967}
968
969/// Parent scope operand of \p S, or null if \p S has no parent (a \c DIFile,
970/// \c DICompileUnit, or non-scope). Mirrors \c DIScope::getScope() without
971/// asserting on unexpected metadata kinds.
972static const Metadata *getRawDIScopeParent(const Metadata *S) {
973 if (!S)
974 return nullptr;
975 if (auto *T = dyn_cast<DIType>(S))
976 return T->getRawScope();
977 if (auto *SP = dyn_cast<DISubprogram>(S))
978 return SP->getRawScope();
979 if (auto *LB = dyn_cast<DILexicalBlockBase>(S))
980 return LB->getRawScope();
981 if (auto *NS = dyn_cast<DINamespace>(S))
982 return NS->getRawScope();
983 if (auto *CB = dyn_cast<DICommonBlock>(S))
984 return CB->getRawScope();
985 if (auto *M = dyn_cast<DIModule>(S))
986 return M->getRawScope();
987 return nullptr;
988}
989
990/// True if following the scope operand from \p S repeats a node.
991bool Verifier::hasDIScopeCycle(const Metadata *S) {
992 SmallPtrSet<const Metadata *, 8> Seen;
993 auto CacheSeen = [&](bool HasCycle) {
994 for (const Metadata *M : Seen)
995 DIScopeChainReachesCycle[M] = HasCycle;
996 return HasCycle;
997 };
998
999 while (auto *Scope = dyn_cast_or_null<DIScope>(S)) {
1000 auto It = DIScopeChainReachesCycle.find(Scope);
1001 bool IsInCache = It != DIScopeChainReachesCycle.end();
1002 if (IsInCache)
1003 return CacheSeen(It->second);
1004 bool AlreadySeen = !Seen.insert(Scope).second;
1005 if (AlreadySeen) // New cycle detected
1006 return CacheSeen(true);
1007 // No new cycle detected
1008 S = getRawDIScopeParent(Scope);
1009 }
1010
1011 // Finished walking node chain without detecting any cycles
1012 return CacheSeen(false);
1013}
1014
1015void Verifier::visitDIScopeChain(const DIScope &N) {
1016 CheckDI(!hasDIScopeCycle(&N), "DIScope scope chain must not contain a cycle",
1017 &N);
1018}
1019
1020void Verifier::visitMDNode(const MDNode &BaseMD,
1021 AreDebugLocsAllowed AllowLocs) {
1022 // Only visit each node once. Metadata can be mutually recursive, so this
1023 // avoids infinite recursion here, as well as being an optimization.
1024 if (!MDNodes.insert(&BaseMD).second)
1025 return;
1026
1027 std::queue<const MDNode *> Worklist;
1028 Worklist.push(&BaseMD);
1029
1030 while (!Worklist.empty()) {
1031 const MDNode *CurrentMD = Worklist.front();
1032 Worklist.pop();
1033 Check(&CurrentMD->getContext() == &Context,
1034 "MDNode context does not match Module context!", CurrentMD);
1035
1036 switch (CurrentMD->getMetadataID()) {
1037 default:
1038 llvm_unreachable("Invalid MDNode subclass");
1039 case Metadata::MDTupleKind:
1040 break;
1041#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
1042 case Metadata::CLASS##Kind: \
1043 visit##CLASS(cast<CLASS>(*CurrentMD)); \
1044 break;
1045#include "llvm/IR/Metadata.def"
1046 }
1047
1048 // A scope chain must terminate.
1049 if (const auto *S = dyn_cast<DIScope>(CurrentMD))
1050 visitDIScopeChain(*S);
1051
1052 for (const Metadata *Op : CurrentMD->operands()) {
1053 if (!Op)
1054 continue;
1055 Check(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
1056 CurrentMD, Op);
1057 CheckDI(!isa<DILocation>(Op) || AllowLocs == AreDebugLocsAllowed::Yes,
1058 "DILocation not allowed within this metadata node", CurrentMD,
1059 Op);
1060 if (auto *N = dyn_cast<MDNode>(Op)) {
1061 if (MDNodes.insert(N).second)
1062 Worklist.push(N);
1063 continue;
1064 }
1065 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
1066 visitValueAsMetadata(*V, nullptr);
1067 continue;
1068 }
1069 }
1070
1071 // FIXME: The nested llvm.loop.* property tags (llvm.loop.align,
1072 // llvm.loop.estimated_trip_count, the boolean enable/disable tags below)
1073 // are only meaningful as operands of an llvm.loop node. Neither llvm.loop's
1074 // structure nor the requirement that these tags appear only within it is
1075 // validated here; the checks below fire on any matching tuple regardless of
1076 // where it appears.
1077
1078 // Check llvm.loop.estimated_trip_count.
1079 if (CurrentMD->getNumOperands() > 0 &&
1081 Check(CurrentMD->getNumOperands() == 2, "Expected two operands",
1082 CurrentMD);
1083 auto *Count =
1085 Check(Count && Count->getType()->isIntegerTy() &&
1086 cast<IntegerType>(Count->getType())->getBitWidth() <= 32,
1087 "Expected second operand to be an integer constant of type i32 or "
1088 "smaller",
1089 CurrentMD);
1090 }
1091
1092 // Check llvm.loop.align.
1093 if (CurrentMD->getNumOperands() > 0 &&
1094 CurrentMD->getOperand(0).equalsStr("llvm.loop.align")) {
1095 Check(CurrentMD->getNumOperands() == 2, "Expected two operands",
1096 CurrentMD);
1097 auto *AlignMD =
1099 Check(AlignMD && AlignMD->getType()->isIntegerTy(32),
1100 "Expected the alignment to be an integer constant of type i32",
1101 CurrentMD);
1102 if (AlignMD) {
1103 uint64_t Align = AlignMD->getValue().getZExtValue();
1104 Check(isPowerOf2_64(Align),
1105 "Expected the alignment to be a power of two", CurrentMD);
1106 Check(Align <= Value::MaximumAlignment,
1107 "Alignment is larger than the implementation defined limit",
1108 CurrentMD);
1109 }
1110 }
1111
1112 // Enforce the single-operand form of the loop enable/disable pairs.
1113 if (CurrentMD->getNumOperands() > 0 &&
1114 any_of(OldBooleanLoopTags, [CurrentMD](const BooleanLoopTags &Tags) {
1115 return CurrentMD->getOperand(0).equalsStr(Tags.Enable) ||
1116 CurrentMD->getOperand(0).equalsStr(Tags.Disable);
1117 }))
1118 Check(CurrentMD->getNumOperands() == 1,
1119 "Expecting only the metadata name", CurrentMD);
1120
1121 // Check these last, so we diagnose problems in operands first.
1122 Check(!CurrentMD->isTemporary(), "Expected no forward declarations!",
1123 CurrentMD);
1124 Check(CurrentMD->isResolved(), "All nodes should be resolved!", CurrentMD);
1125 }
1126}
1127
1128void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
1129 Check(MD.getValue(), "Expected valid value", &MD);
1130 Check(!MD.getValue()->getType()->isMetadataTy(),
1131 "Unexpected metadata round-trip through values", &MD, MD.getValue());
1132
1133 auto *L = dyn_cast<LocalAsMetadata>(&MD);
1134 if (!L)
1135 return;
1136
1137 Check(F, "function-local metadata used outside a function", L);
1138
1139 // If this was an instruction, bb, or argument, verify that it is in the
1140 // function that we expect.
1141 Function *ActualF = nullptr;
1142 if (auto *I = dyn_cast<Instruction>(L->getValue())) {
1143 Check(I->getParent(), "function-local metadata not in basic block", L, I);
1144 ActualF = I->getParent()->getParent();
1145 } else if (auto *BB = dyn_cast<BasicBlock>(L->getValue())) {
1146 ActualF = BB->getParent();
1147 } else if (auto *A = dyn_cast<Argument>(L->getValue())) {
1148 ActualF = A->getParent();
1149 }
1150 assert(ActualF && "Unimplemented function local metadata case!");
1151
1152 Check(ActualF == F, "function-local metadata used in wrong function", L);
1153}
1154
1155void Verifier::visitDIArgList(const DIArgList &AL, Function *F) {
1156 for (const ValueAsMetadata *VAM : AL.getArgs())
1157 visitValueAsMetadata(*VAM, F);
1158}
1159
1160void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
1161 Metadata *MD = MDV.getMetadata();
1162 if (auto *N = dyn_cast<MDNode>(MD)) {
1163 visitMDNode(*N, AreDebugLocsAllowed::No);
1164 return;
1165 }
1166
1167 // Only visit each node once. Metadata can be mutually recursive, so this
1168 // avoids infinite recursion here, as well as being an optimization.
1169 if (!MDNodes.insert(MD).second)
1170 return;
1171
1172 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
1173 visitValueAsMetadata(*V, F);
1174
1175 if (auto *AL = dyn_cast<DIArgList>(MD))
1176 visitDIArgList(*AL, F);
1177}
1178
1179static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
1180static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
1181static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
1182static bool isMDTuple(const Metadata *MD) { return !MD || isa<MDTuple>(MD); }
1183
1184void Verifier::visitDILocation(const DILocation &N) {
1185 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1186 "location requires a valid scope", &N, N.getRawScope());
1187 if (auto *IA = N.getRawInlinedAt())
1188 CheckDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
1189 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
1190 CheckDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
1191 if (auto *L = N.getRawIRLayers())
1192 CheckDI(isa<DILayerLocList>(L), "irlayers must be a DILayerLocList", &N, L);
1193}
1194
1195void Verifier::visitDILayerLoc(const DILayerLoc &N) {
1196 CheckDI(isa_and_nonnull<MDString>(N.getRawKind()),
1197 "layer kind must be a non-null MDString", &N, N.getRawKind());
1198 CheckDI(isa_and_nonnull<DIFile>(N.getRawFile()),
1199 "layer file must be a non-null DIFile", &N, N.getRawFile());
1200}
1201
1202void Verifier::visitDILayerLocList(const DILayerLocList &N) {
1203 CheckDI(N.getNumLayers() > 0, "DILayerLocList must be non-empty", &N);
1204 for (const MDOperand &Op : N.layers())
1206 "DILayerLocList entry must be a DILayerLoc", &N, Op.get());
1207}
1208
1209void Verifier::visitGenericDINode(const GenericDINode &N) {
1210 CheckDI(N.getTag(), "invalid tag", &N);
1211}
1212
1213void Verifier::visitDIScope(const DIScope &N) {
1214 if (auto *F = N.getRawFile())
1215 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1216}
1217
1218void Verifier::visitDIType(const DIType &N) {
1219 CheckDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
1220 visitDIScope(N);
1221 CheckDI(N.getRawFile() || N.getLine() == 0, "line specified with no file", &N,
1222 N.getLine());
1223}
1224
1225void Verifier::visitDISubrangeType(const DISubrangeType &N) {
1226 visitDIType(N);
1227
1228 CheckDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
1229 auto *BaseType = N.getRawBaseType();
1230 CheckDI(!BaseType || isType(BaseType), "BaseType must be a type");
1231 auto *LBound = N.getRawLowerBound();
1232 CheckDI(!LBound || isa<ConstantAsMetadata>(LBound) ||
1233 isa<DIVariable>(LBound) || isa<DIExpression>(LBound) ||
1234 isa<DIDerivedType>(LBound),
1235 "LowerBound must be signed constant or DIVariable or DIExpression or "
1236 "DIDerivedType",
1237 &N);
1238 auto *UBound = N.getRawUpperBound();
1239 CheckDI(!UBound || isa<ConstantAsMetadata>(UBound) ||
1240 isa<DIVariable>(UBound) || isa<DIExpression>(UBound) ||
1241 isa<DIDerivedType>(UBound),
1242 "UpperBound must be signed constant or DIVariable or DIExpression or "
1243 "DIDerivedType",
1244 &N);
1245 auto *Stride = N.getRawStride();
1246 CheckDI(!Stride || isa<ConstantAsMetadata>(Stride) ||
1247 isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
1248 "Stride must be signed constant or DIVariable or DIExpression", &N);
1249 auto *Bias = N.getRawBias();
1250 CheckDI(!Bias || isa<ConstantAsMetadata>(Bias) || isa<DIVariable>(Bias) ||
1251 isa<DIExpression>(Bias),
1252 "Bias must be signed constant or DIVariable or DIExpression", &N);
1253 // Subrange types currently only support constant size.
1254 auto *Size = N.getRawSizeInBits();
1256 "SizeInBits must be a constant");
1257}
1258
1259void Verifier::visitDISubrange(const DISubrange &N) {
1260 CheckDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
1261 CheckDI(!N.getRawCountNode() || !N.getRawUpperBound(),
1262 "Subrange can have any one of count or upperBound", &N);
1263 auto *CBound = N.getRawCountNode();
1264 CheckDI(!CBound || isa<ConstantAsMetadata>(CBound) ||
1265 isa<DIVariable>(CBound) || isa<DIExpression>(CBound),
1266 "Count must be signed constant or DIVariable or DIExpression", &N);
1267 auto Count = N.getCount();
1269 cast<ConstantInt *>(Count)->getSExtValue() >= -1,
1270 "invalid subrange count", &N);
1271 auto *LBound = N.getRawLowerBound();
1272 CheckDI(!LBound || isa<ConstantAsMetadata>(LBound) ||
1273 isa<DIVariable>(LBound) || isa<DIExpression>(LBound),
1274 "LowerBound must be signed constant or DIVariable or DIExpression",
1275 &N);
1276 auto *UBound = N.getRawUpperBound();
1277 CheckDI(!UBound || isa<ConstantAsMetadata>(UBound) ||
1278 isa<DIVariable>(UBound) || isa<DIExpression>(UBound),
1279 "UpperBound must be signed constant or DIVariable or DIExpression",
1280 &N);
1281 auto *Stride = N.getRawStride();
1282 CheckDI(!Stride || isa<ConstantAsMetadata>(Stride) ||
1283 isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
1284 "Stride must be signed constant or DIVariable or DIExpression", &N);
1285}
1286
1287void Verifier::visitDIGenericSubrange(const DIGenericSubrange &N) {
1288 CheckDI(N.getTag() == dwarf::DW_TAG_generic_subrange, "invalid tag", &N);
1289 CheckDI(!N.getRawCountNode() || !N.getRawUpperBound(),
1290 "GenericSubrange can have any one of count or upperBound", &N);
1291 auto *CBound = N.getRawCountNode();
1292 CheckDI(!CBound || isa<DIVariable>(CBound) || isa<DIExpression>(CBound),
1293 "Count must be signed constant or DIVariable or DIExpression", &N);
1294 auto *LBound = N.getRawLowerBound();
1295 CheckDI(LBound, "GenericSubrange must contain lowerBound", &N);
1296 CheckDI(isa<DIVariable>(LBound) || isa<DIExpression>(LBound),
1297 "LowerBound must be signed constant or DIVariable or DIExpression",
1298 &N);
1299 auto *UBound = N.getRawUpperBound();
1300 CheckDI(!UBound || isa<DIVariable>(UBound) || isa<DIExpression>(UBound),
1301 "UpperBound must be signed constant or DIVariable or DIExpression",
1302 &N);
1303 auto *Stride = N.getRawStride();
1304 CheckDI(Stride, "GenericSubrange must contain stride", &N);
1305 CheckDI(isa<DIVariable>(Stride) || isa<DIExpression>(Stride),
1306 "Stride must be signed constant or DIVariable or DIExpression", &N);
1307}
1308
1309void Verifier::visitDIEnumerator(const DIEnumerator &N) {
1310 CheckDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
1311}
1312
1313void Verifier::visitDIBasicType(const DIBasicType &N) {
1314 visitDIType(N);
1315
1316 CheckDI(N.getTag() == dwarf::DW_TAG_base_type ||
1317 N.getTag() == dwarf::DW_TAG_unspecified_type ||
1318 N.getTag() == dwarf::DW_TAG_string_type,
1319 "invalid tag", &N);
1320 // Basic types currently only support constant size.
1321 auto *Size = N.getRawSizeInBits();
1323 "SizeInBits must be a constant");
1324}
1325
1326void Verifier::visitDIFixedPointType(const DIFixedPointType &N) {
1327 visitDIBasicType(N);
1328
1329 CheckDI(N.getTag() == dwarf::DW_TAG_base_type, "invalid tag", &N);
1330 CheckDI(N.getEncoding() == dwarf::DW_ATE_signed_fixed ||
1331 N.getEncoding() == dwarf::DW_ATE_unsigned_fixed,
1332 "invalid encoding", &N);
1336 "invalid kind", &N);
1338 N.getFactorRaw() == 0,
1339 "factor should be 0 for rationals", &N);
1341 (N.getNumeratorRaw() == 0 && N.getDenominatorRaw() == 0),
1342 "numerator and denominator should be 0 for non-rationals", &N);
1343}
1344
1345void Verifier::visitDIStringType(const DIStringType &N) {
1346 visitDIType(N);
1347
1348 CheckDI(N.getTag() == dwarf::DW_TAG_string_type, "invalid tag", &N);
1349 CheckDI(!(N.isBigEndian() && N.isLittleEndian()), "has conflicting flags",
1350 &N);
1351 if (N.getRawCharType())
1352 CheckDI(isa<DIType>(N.getRawCharType()), "invalid character type", &N,
1353 N.getRawCharType());
1354}
1355
1356void Verifier::visitDIDerivedType(const DIDerivedType &N) {
1357 // Common type checks.
1358 visitDIType(N);
1359
1360 CheckDI(N.getTag() == dwarf::DW_TAG_typedef ||
1361 N.getTag() == dwarf::DW_TAG_pointer_type ||
1362 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
1363 N.getTag() == dwarf::DW_TAG_reference_type ||
1364 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
1365 N.getTag() == dwarf::DW_TAG_const_type ||
1366 N.getTag() == dwarf::DW_TAG_immutable_type ||
1367 N.getTag() == dwarf::DW_TAG_volatile_type ||
1368 N.getTag() == dwarf::DW_TAG_restrict_type ||
1369 N.getTag() == dwarf::DW_TAG_atomic_type ||
1370 N.getTag() == dwarf::DW_TAG_LLVM_ptrauth_type ||
1371 N.getTag() == dwarf::DW_TAG_member ||
1372 (N.getTag() == dwarf::DW_TAG_variable && N.isStaticMember()) ||
1373 N.getTag() == dwarf::DW_TAG_inheritance ||
1374 N.getTag() == dwarf::DW_TAG_friend ||
1375 N.getTag() == dwarf::DW_TAG_set_type ||
1376 N.getTag() == dwarf::DW_TAG_template_alias,
1377 "invalid tag", &N);
1378 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
1379 CheckDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
1380 N.getRawExtraData());
1381 } else if (N.getTag() == dwarf::DW_TAG_template_alias) {
1382 CheckDI(isMDTuple(N.getRawExtraData()), "invalid template parameters", &N,
1383 N.getRawExtraData());
1384 } else if (N.getTag() == dwarf::DW_TAG_inheritance ||
1385 N.getTag() == dwarf::DW_TAG_member ||
1386 N.getTag() == dwarf::DW_TAG_variable) {
1387 auto *ExtraData = N.getRawExtraData();
1388 auto IsValidExtraData = [&]() {
1389 if (ExtraData == nullptr)
1390 return true;
1391 if (isa<ConstantAsMetadata>(ExtraData) || isa<MDString>(ExtraData) ||
1392 isa<DIObjCProperty>(ExtraData))
1393 return true;
1394 if (auto *Tuple = dyn_cast<MDTuple>(ExtraData)) {
1395 if (Tuple->getNumOperands() != 1)
1396 return false;
1397 return isa_and_nonnull<ConstantAsMetadata>(Tuple->getOperand(0).get());
1398 }
1399 return false;
1400 };
1401 CheckDI(IsValidExtraData(),
1402 "extraData must be ConstantAsMetadata, MDString, DIObjCProperty, "
1403 "or MDTuple with single ConstantAsMetadata operand",
1404 &N, ExtraData);
1405 }
1406
1407 if (N.getTag() == dwarf::DW_TAG_set_type) {
1408 if (auto *T = N.getRawBaseType()) {
1412 CheckDI(
1413 (Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type) ||
1414 (Subrange && Subrange->getTag() == dwarf::DW_TAG_subrange_type) ||
1415 (Basic && (Basic->getEncoding() == dwarf::DW_ATE_unsigned ||
1416 Basic->getEncoding() == dwarf::DW_ATE_signed ||
1417 Basic->getEncoding() == dwarf::DW_ATE_unsigned_char ||
1418 Basic->getEncoding() == dwarf::DW_ATE_signed_char ||
1419 Basic->getEncoding() == dwarf::DW_ATE_boolean)),
1420 "invalid set base type", &N, T);
1421 }
1422 }
1423
1424 CheckDI(isType(N.getRawBaseType()), "invalid base type", &N,
1425 N.getRawBaseType());
1426
1427 if (N.getDWARFAddressSpace()) {
1428 CheckDI(N.getTag() == dwarf::DW_TAG_pointer_type ||
1429 N.getTag() == dwarf::DW_TAG_reference_type ||
1430 N.getTag() == dwarf::DW_TAG_rvalue_reference_type,
1431 "DWARF address space only applies to pointer or reference types",
1432 &N);
1433 }
1434
1435 auto *Size = N.getRawSizeInBits();
1438 "SizeInBits must be a constant or DIVariable or DIExpression");
1439}
1440
1441/// Detect mutually exclusive flags.
1442static bool hasConflictingReferenceFlags(unsigned Flags) {
1443 return ((Flags & DINode::FlagLValueReference) &&
1444 (Flags & DINode::FlagRValueReference)) ||
1445 ((Flags & DINode::FlagTypePassByValue) &&
1446 (Flags & DINode::FlagTypePassByReference));
1447}
1448
1449void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
1450 auto *Params = dyn_cast<MDTuple>(&RawParams);
1451 CheckDI(Params, "invalid template params", &N, &RawParams);
1452 for (Metadata *Op : Params->operands()) {
1453 CheckDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
1454 &N, Params, Op);
1455 }
1456}
1457
1458void Verifier::visitDICompositeType(const DICompositeType &N) {
1459 // Common type checks.
1460 visitDIType(N);
1461
1462 CheckDI(N.getTag() == dwarf::DW_TAG_array_type ||
1463 N.getTag() == dwarf::DW_TAG_structure_type ||
1464 N.getTag() == dwarf::DW_TAG_union_type ||
1465 N.getTag() == dwarf::DW_TAG_enumeration_type ||
1466 N.getTag() == dwarf::DW_TAG_class_type ||
1467 N.getTag() == dwarf::DW_TAG_variant_part ||
1468 N.getTag() == dwarf::DW_TAG_variant ||
1469 N.getTag() == dwarf::DW_TAG_namelist,
1470 "invalid tag", &N);
1471
1472 CheckDI(isType(N.getRawBaseType()), "invalid base type", &N,
1473 N.getRawBaseType());
1474
1475 CheckDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
1476 "invalid composite elements", &N, N.getRawElements());
1477 CheckDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
1478 N.getRawVTableHolder());
1480 "invalid reference flags", &N);
1481 unsigned DIBlockByRefStruct = 1 << 4;
1482 CheckDI((N.getFlags() & DIBlockByRefStruct) == 0,
1483 "DIBlockByRefStruct on DICompositeType is no longer supported", &N);
1484 CheckDI(llvm::all_of(N.getElements(), [](const DINode *N) { return N; }),
1485 "DISubprogram contains null entry in `elements` field", &N);
1486
1487 if (N.isVector()) {
1488 const DINodeArray Elements = N.getElements();
1489 CheckDI(Elements.size() == 1 &&
1490 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type,
1491 "invalid vector, expected one element of type subrange", &N);
1492 }
1493
1494 if (auto *Params = N.getRawTemplateParams())
1495 visitTemplateParams(N, *Params);
1496
1497 if (auto *D = N.getRawDiscriminator()) {
1498 CheckDI(isa<DIDerivedType>(D) && N.getTag() == dwarf::DW_TAG_variant_part,
1499 "discriminator can only appear on variant part");
1500 }
1501
1502 if (N.getRawDataLocation()) {
1503 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1504 "dataLocation can only appear in array type");
1505 }
1506
1507 if (N.getRawAssociated()) {
1508 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1509 "associated can only appear in array type");
1510 }
1511
1512 if (N.getRawAllocated()) {
1513 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1514 "allocated can only appear in array type");
1515 }
1516
1517 if (N.getRawRank()) {
1518 CheckDI(N.getTag() == dwarf::DW_TAG_array_type,
1519 "rank can only appear in array type");
1520 }
1521
1522 if (N.getTag() == dwarf::DW_TAG_array_type) {
1523 CheckDI(N.getRawBaseType(), "array types must have a base type", &N);
1524 }
1525
1526 auto *Size = N.getRawSizeInBits();
1529 "SizeInBits must be a constant or DIVariable or DIExpression");
1530}
1531
1532void Verifier::visitDISubroutineType(const DISubroutineType &N) {
1533 visitDIType(N);
1534 CheckDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
1535 if (auto *Types = N.getRawTypeArray()) {
1536 CheckDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
1537 for (Metadata *Ty : N.getTypeArray()->operands()) {
1538 CheckDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
1539 }
1540 }
1542 "invalid reference flags", &N);
1543}
1544
1545void Verifier::visitDIFile(const DIFile &N) {
1546 CheckDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
1547 std::optional<DIFile::ChecksumInfo<StringRef>> Checksum = N.getChecksum();
1548 if (Checksum) {
1549 CheckDI(Checksum->Kind <= DIFile::ChecksumKind::CSK_Last,
1550 "invalid checksum kind", &N);
1551 size_t Size;
1552 switch (Checksum->Kind) {
1553 case DIFile::CSK_MD5:
1554 Size = 32;
1555 break;
1556 case DIFile::CSK_SHA1:
1557 Size = 40;
1558 break;
1559 case DIFile::CSK_SHA256:
1560 Size = 64;
1561 break;
1562 }
1563 CheckDI(Checksum->Value.size() == Size, "invalid checksum length", &N);
1564 CheckDI(Checksum->Value.find_if_not(llvm::isHexDigit) == StringRef::npos,
1565 "invalid checksum", &N);
1566 }
1567}
1568
1569void Verifier::visitDICompileUnit(const DICompileUnit &N) {
1570 CheckDI(N.isDistinct(), "compile units must be distinct", &N);
1571 CheckDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
1572
1573 // Don't bother verifying the compilation directory or producer string
1574 // as those could be empty.
1575 CheckDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
1576 N.getRawFile());
1577 CheckDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
1578 N.getFile());
1579
1580 CheckDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
1581 "invalid emission kind", &N);
1582
1583 CheckDI(N.getSourceLanguage().getDialect() <= dwarf::DW_LLVM_LANG_DIALECT_max,
1584 "invalid language dialect", &N);
1585
1586 if (auto *Array = N.getRawEnumTypes()) {
1587 CheckDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
1588 for (Metadata *Op : N.getEnumTypes()->operands()) {
1590 CheckDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
1591 "invalid enum type", &N, N.getEnumTypes(), Op);
1592 CheckDI(!Enum->getScope() || !isa<DILocalScope>(Enum->getScope()),
1593 "function-local enum in a DICompileUnit's enum list", &N,
1594 N.getEnumTypes(), Op);
1595 }
1596 }
1597 if (auto *Array = N.getRawRetainedTypes()) {
1598 CheckDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
1599 for (Metadata *Op : N.getRetainedTypes()->operands()) {
1600 CheckDI(
1601 Op && (isa<DIType>(Op) || (isa<DISubprogram>(Op) &&
1602 !cast<DISubprogram>(Op)->isDefinition())),
1603 "invalid retained type", &N, Op);
1604 }
1605 }
1606 if (auto *Array = N.getRawGlobalVariables()) {
1607 CheckDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
1608 for (Metadata *Op : N.getGlobalVariables()->operands()) {
1610 CheckDI(GVE, "invalid global variable ref", &N, Op);
1611 CheckDI(!isa_and_nonnull<DILocalScope>(GVE->getVariable()->getScope()),
1612 "function-local variables are not allowed in a DICompileUnit's "
1613 "global variables list",
1614 &N, Op);
1615 }
1616 }
1617 if (auto *Array = N.getRawImportedEntities()) {
1618 CheckDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
1619 for (Metadata *Op : N.getImportedEntities()->operands()) {
1621 CheckDI(IE, "invalid imported entity ref", &N, Op);
1623 "function-local imports are not allowed in a DICompileUnit's "
1624 "imported entities list",
1625 &N, Op);
1626 }
1627 }
1628 if (auto *Array = N.getRawMacros()) {
1629 CheckDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1630 for (Metadata *Op : N.getMacros()->operands()) {
1631 CheckDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1632 }
1633 }
1634 CUVisited.insert(&N);
1635}
1636
1637void Verifier::visitDISubprogram(const DISubprogram &N) {
1638 CheckDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1639 CheckDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
1640 if (auto *F = N.getRawFile())
1641 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1642 else
1643 CheckDI(N.getLine() == 0, "line specified with no file", &N, N.getLine());
1644 auto *T = N.getRawType();
1645 CheckDI(T, "DISubprogram requires a non-null type", &N);
1646 CheckDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1647 CheckDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1648 N.getRawContainingType());
1649 if (auto *Params = N.getRawTemplateParams())
1650 visitTemplateParams(N, *Params);
1651 if (auto *S = N.getRawDeclaration())
1652 CheckDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1653 "invalid subprogram declaration", &N, S);
1654 if (auto *RawNode = N.getRawRetainedNodes()) {
1655 auto *Node = dyn_cast<MDTuple>(RawNode);
1656 CheckDI(Node, "invalid retained nodes list", &N, RawNode);
1657
1658 DenseMap<unsigned, DILocalVariable *> Args;
1659 for (Metadata *Op : Node->operands()) {
1660 CheckDI(Op, "nullptr in retained nodes", &N, Node);
1661
1662 auto True = [](const Metadata *) { return true; };
1663 auto False = [](const Metadata *) { return false; };
1664 bool IsTypeCorrect = DISubprogram::visitRetainedNode<bool>(
1665 Op, True, True, True, True, True, False);
1666 CheckDI(IsTypeCorrect,
1667 "invalid retained nodes, expected DILocalVariable, DILabel, "
1668 "DIImportedEntity, DIType or DIGlobalVariableExpression",
1669 &N, Node, Op);
1670
1671 auto *RetainedNode = cast<MDNode>(Op);
1672 auto *RetainedNodeScope = dyn_cast_or_null<DILocalScope>(
1674 CheckDI(RetainedNodeScope,
1675 "invalid retained nodes, retained node is not local", &N, Node,
1676 RetainedNode);
1677
1678 DISubprogram *RetainedNodeSP = getSubprogram(RetainedNodeScope);
1679 DICompileUnit *RetainedNodeUnit =
1680 RetainedNodeSP ? RetainedNodeSP->getUnit() : nullptr;
1681 CheckDI(
1682 RetainedNodeSP == &N,
1683 "invalid retained nodes, retained node does not belong to subprogram",
1684 &N, Node, RetainedNode, RetainedNodeScope, RetainedNodeSP,
1685 RetainedNodeUnit);
1686
1687 auto *DV = dyn_cast<DILocalVariable>(RetainedNode);
1688 if (!DV)
1689 continue;
1690 if (unsigned ArgNum = DV->getArg()) {
1691 auto [ArgI, Inserted] = Args.insert({ArgNum, DV});
1692 CheckDI(Inserted || DV == ArgI->second,
1693 "invalid retained nodes, more than one local variable with the "
1694 "same argument index",
1695 &N, N.getUnit(), Node, RetainedNode, Args[ArgNum]);
1696 }
1697 }
1698 }
1700 "invalid reference flags", &N);
1701
1702 auto *Unit = N.getRawUnit();
1703 if (N.isDefinition()) {
1704 // Subprogram definitions (not part of the type hierarchy).
1705 CheckDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1706 CheckDI(Unit, "subprogram definitions must have a compile unit", &N);
1707 CheckDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
1708 // There's no good way to cross the CU boundary to insert a nested
1709 // DISubprogram definition in one CU into a type defined in another CU.
1710 auto *CT = dyn_cast_or_null<DICompositeType>(N.getRawScope());
1711 if (CT && CT->getRawIdentifier() &&
1712 M.getContext().isODRUniquingDebugTypes())
1713 CheckDI(N.getDeclaration(),
1714 "definition subprograms cannot be nested within DICompositeType "
1715 "when enabling ODR",
1716 &N);
1717 } else {
1718 // Subprogram declarations (part of the type hierarchy).
1719 CheckDI(!Unit, "subprogram declarations must not have a compile unit", &N);
1720 CheckDI(!N.getRawDeclaration(),
1721 "subprogram declaration must not have a declaration field");
1722 }
1723
1724 if (auto *RawThrownTypes = N.getRawThrownTypes()) {
1725 auto *ThrownTypes = dyn_cast<MDTuple>(RawThrownTypes);
1726 CheckDI(ThrownTypes, "invalid thrown types list", &N, RawThrownTypes);
1727 for (Metadata *Op : ThrownTypes->operands())
1728 CheckDI(Op && isa<DIType>(Op), "invalid thrown type", &N, ThrownTypes,
1729 Op);
1730 }
1731
1732 if (N.areAllCallsDescribed())
1733 CheckDI(N.isDefinition(),
1734 "DIFlagAllCallsDescribed must be attached to a definition");
1735}
1736
1737void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1738 CheckDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1739 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1740 "invalid local scope", &N, N.getRawScope());
1741 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
1742 CheckDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
1743}
1744
1745void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1746 visitDILexicalBlockBase(N);
1747
1748 CheckDI(N.getLine() || !N.getColumn(),
1749 "cannot have column info without line info", &N);
1750}
1751
1752void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1753 visitDILexicalBlockBase(N);
1754}
1755
1756void Verifier::visitDICommonBlock(const DICommonBlock &N) {
1757 CheckDI(N.getTag() == dwarf::DW_TAG_common_block, "invalid tag", &N);
1758 if (auto *S = N.getRawScope())
1759 CheckDI(isa<DIScope>(S), "invalid scope ref", &N, S);
1760 if (auto *S = N.getRawDecl())
1761 CheckDI(isa<DIGlobalVariable>(S), "invalid declaration", &N, S);
1762}
1763
1764void Verifier::visitDINamespace(const DINamespace &N) {
1765 CheckDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1766 if (auto *S = N.getRawScope())
1767 CheckDI(isa<DIScope>(S), "invalid scope ref", &N, S);
1768}
1769
1770void Verifier::visitDIMacro(const DIMacro &N) {
1771 CheckDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1772 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1773 "invalid macinfo type", &N);
1774 CheckDI(!N.getName().empty(), "anonymous macro", &N);
1775 if (!N.getValue().empty()) {
1776 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1777 }
1778}
1779
1780void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1781 CheckDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1782 "invalid macinfo type", &N);
1783 if (auto *F = N.getRawFile())
1784 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1785
1786 if (auto *Array = N.getRawElements()) {
1787 CheckDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1788 for (Metadata *Op : N.getElements()->operands()) {
1789 CheckDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1790 }
1791 }
1792}
1793
1794void Verifier::visitDIModule(const DIModule &N) {
1795 CheckDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1796 CheckDI(!N.getName().empty(), "anonymous module", &N);
1797}
1798
1799void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1800 CheckDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1801}
1802
1803void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1804 visitDITemplateParameter(N);
1805
1806 CheckDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1807 &N);
1808}
1809
1810void Verifier::visitDITemplateValueParameter(
1811 const DITemplateValueParameter &N) {
1812 visitDITemplateParameter(N);
1813
1814 CheckDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1815 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1816 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1817 "invalid tag", &N);
1818}
1819
1820void Verifier::visitDIVariable(const DIVariable &N) {
1821 if (auto *S = N.getRawScope())
1822 CheckDI(isa<DIScope>(S), "invalid scope", &N, S);
1823 if (auto *F = N.getRawFile())
1824 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1825}
1826
1827void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1828 // Checks common to all variables.
1829 visitDIVariable(N);
1830
1831 CheckDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1832 CheckDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1833 // Check only if the global variable is not an extern
1834 if (N.isDefinition())
1835 CheckDI(N.getType(), "missing global variable type", &N);
1836 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1838 "invalid static data member declaration", &N, Member);
1839 }
1840}
1841
1842void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1843 // Checks common to all variables.
1844 visitDIVariable(N);
1845
1846 CheckDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
1847 CheckDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1848 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1849 "local variable requires a valid scope", &N, N.getRawScope());
1850 if (auto Ty = N.getType())
1851 CheckDI(!isa<DISubroutineType>(Ty), "invalid type", &N, N.getType());
1852}
1853
1854void Verifier::visitDIAssignID(const DIAssignID &N) {
1855 CheckDI(!N.getNumOperands(), "DIAssignID has no arguments", &N);
1856 CheckDI(N.isDistinct(), "DIAssignID must be distinct", &N);
1857}
1858
1859void Verifier::visitDILabel(const DILabel &N) {
1860 if (auto *S = N.getRawScope())
1861 CheckDI(isa<DIScope>(S), "invalid scope", &N, S);
1862 if (auto *F = N.getRawFile())
1863 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1864
1865 CheckDI(N.getTag() == dwarf::DW_TAG_label, "invalid tag", &N);
1866 CheckDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1867 "label requires a valid scope", &N, N.getRawScope());
1868}
1869
1870void Verifier::visitDIExpression(const DIExpression &N) {
1871 CheckDI(N.isValid(), "invalid expression", &N);
1872}
1873
1874void Verifier::visitDIGlobalVariableExpression(
1875 const DIGlobalVariableExpression &GVE) {
1876 CheckDI(GVE.getVariable(), "missing variable");
1877 if (auto *Var = GVE.getVariable())
1878 visitDIGlobalVariable(*Var);
1879 if (auto *Expr = GVE.getExpression()) {
1880 visitDIExpression(*Expr);
1881 if (auto Fragment = Expr->getFragmentInfo())
1882 verifyFragmentExpression(*GVE.getVariable(), *Fragment, &GVE);
1883 }
1884}
1885
1886void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1887 CheckDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1888 if (auto *T = N.getRawType())
1889 CheckDI(isType(T), "invalid type ref", &N, T);
1890 if (auto *F = N.getRawFile())
1891 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1892}
1893
1894void Verifier::visitDIProperty(const DIProperty &N) {
1895 CheckDI(N.getTag() == dwarf::DW_TAG_property, "invalid tag", &N);
1896 if (auto *T = N.getRawType())
1897 CheckDI(isType(T), "invalid type ref", &N, T);
1898 if (auto *F = N.getRawFile())
1899 CheckDI(isa<DIFile>(F), "invalid file", &N, F);
1900 // DWARF allows a property getter to forward to a subprogram, variable, or
1901 // constant too, but the backend only knows how to forward to a member.
1902 if (DINode *BackingStorage = N.getBackingStorage()) {
1903 auto *DT = dyn_cast<DIDerivedType>(BackingStorage);
1904 CheckDI(DT && DT->getTag() == dwarf::DW_TAG_member,
1905 "property backing storage must be a member", &N, BackingStorage);
1906 }
1907}
1908
1909void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1910 CheckDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1911 N.getTag() == dwarf::DW_TAG_imported_declaration,
1912 "invalid tag", &N);
1913 if (auto *S = N.getRawScope())
1914 CheckDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1915 CheckDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1916 N.getRawEntity());
1917}
1918
1919void Verifier::visitComdat(const Comdat &C) {
1920 // In COFF the Module is invalid if the GlobalValue has private linkage.
1921 // Entities with private linkage don't have entries in the symbol table.
1922 if (TT.isOSBinFormatCOFF())
1923 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
1924 Check(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1925 GV);
1926}
1927
1928void Verifier::visitModuleIdents() {
1929 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1930 if (!Idents)
1931 return;
1932
1933 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1934 // Scan each llvm.ident entry and make sure that this requirement is met.
1935 for (const MDNode *N : Idents->operands()) {
1936 Check(N->getNumOperands() == 1,
1937 "incorrect number of operands in llvm.ident metadata", N);
1938 Check(dyn_cast_or_null<MDString>(N->getOperand(0)),
1939 ("invalid value for llvm.ident metadata entry operand"
1940 "(the operand should be a string)"),
1941 N->getOperand(0));
1942 }
1943}
1944
1945void Verifier::visitModuleCommandLines() {
1946 const NamedMDNode *CommandLines = M.getNamedMetadata("llvm.commandline");
1947 if (!CommandLines)
1948 return;
1949
1950 // llvm.commandline takes a list of metadata entry. Each entry has only one
1951 // string. Scan each llvm.commandline entry and make sure that this
1952 // requirement is met.
1953 for (const MDNode *N : CommandLines->operands()) {
1954 Check(N->getNumOperands() == 1,
1955 "incorrect number of operands in llvm.commandline metadata", N);
1956 Check(dyn_cast_or_null<MDString>(N->getOperand(0)),
1957 ("invalid value for llvm.commandline metadata entry operand"
1958 "(the operand should be a string)"),
1959 N->getOperand(0));
1960 }
1961}
1962
1963void Verifier::visitModuleErrnoTBAA() {
1964 const NamedMDNode *ErrnoTBAA = M.getNamedMetadata("llvm.errno.tbaa");
1965 if (!ErrnoTBAA)
1966 return;
1967
1968 Check(ErrnoTBAA->getNumOperands() >= 1,
1969 "llvm.errno.tbaa must have at least one operand", ErrnoTBAA);
1970
1971 for (const MDNode *N : ErrnoTBAA->operands())
1972 TBAAVerifyHelper.visitTBAAMetadata(nullptr, N);
1973}
1974
1975void Verifier::visitModuleFlags() {
1976 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1977 if (!Flags) return;
1978
1979 // Scan each flag, and track the flags and requirements.
1980 DenseMap<const MDString*, const MDNode*> SeenIDs;
1981 SmallVector<const MDNode*, 16> Requirements;
1982
1983 // Either both aarch64-elf-pauthabi-* flags should be set or none at all.
1984 std::optional<uint64_t> PAuthABIPlatform;
1985 std::optional<uint64_t> PAuthABIVersion;
1986 // Signing of init/fini pointers: address diversity implies basic signing.
1987 uint64_t HasPtrauthInitFini = 0;
1988 uint64_t HasPtrauthInitFiniAddr = 0;
1989
1990 for (const MDNode *MDN : Flags->operands()) {
1991 visitModuleFlag(MDN, SeenIDs, Requirements);
1992 if (MDN->getNumOperands() != 3)
1993 continue;
1994
1995 if (const auto *FlagName = dyn_cast_or_null<MDString>(MDN->getOperand(1))) {
1996 auto GetFlagNamed = [&](StringRef Name) -> std::optional<uint64_t> {
1997 if (FlagName->getString() != Name)
1998 return std::nullopt;
1999 if (const auto *FlagValue =
2001 return FlagValue->getZExtValue();
2002
2003 CheckFailed(Name + ": module flag expects integer value");
2004 return std::nullopt;
2005 };
2006
2007 if (auto Value = GetFlagNamed("aarch64-elf-pauthabi-platform"))
2008 PAuthABIPlatform = *Value;
2009 else if (auto Value = GetFlagNamed("aarch64-elf-pauthabi-version"))
2010 PAuthABIVersion = *Value;
2011 else if (auto Value = GetFlagNamed("ptrauth-init-fini"))
2012 HasPtrauthInitFini = *Value;
2013 else if (auto Value =
2014 GetFlagNamed("ptrauth-init-fini-address-discrimination"))
2015 HasPtrauthInitFiniAddr = *Value;
2016 }
2017 }
2018
2019 Check(llvm::is_contained({0u, 1u}, HasPtrauthInitFini),
2020 "ptrauth-init-fini must be 0 or 1");
2021 Check(llvm::is_contained({0u, 1u}, HasPtrauthInitFiniAddr),
2022 "ptrauth-init-fini-address-discrimination must be 0 or 1, if set");
2023 if (HasPtrauthInitFiniAddr)
2024 Check(HasPtrauthInitFini, "ptrauth-init-fini-address-discrimination module "
2025 "flag requires ptrauth-init-fini");
2026
2027 if (PAuthABIPlatform.has_value() != PAuthABIVersion.has_value())
2028 CheckFailed("either both or no 'aarch64-elf-pauthabi-platform' and "
2029 "'aarch64-elf-pauthabi-version' module flags must be present");
2030
2031 // Validate that the requirements in the module are valid.
2032 for (const MDNode *Requirement : Requirements) {
2033 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
2034 const Metadata *ReqValue = Requirement->getOperand(1);
2035
2036 const MDNode *Op = SeenIDs.lookup(Flag);
2037 if (!Op) {
2038 CheckFailed("invalid requirement on flag, flag is not present in module",
2039 Flag);
2040 continue;
2041 }
2042
2043 if (Op->getOperand(2) != ReqValue) {
2044 CheckFailed(("invalid requirement on flag, "
2045 "flag does not have the required value"),
2046 Flag);
2047 continue;
2048 }
2049 }
2050}
2051
2052void
2053Verifier::visitModuleFlag(const MDNode *Op,
2054 DenseMap<const MDString *, const MDNode *> &SeenIDs,
2055 SmallVectorImpl<const MDNode *> &Requirements) {
2056 // Each module flag should have three arguments, the merge behavior (a
2057 // constant int), the flag ID (an MDString), and the value.
2058 Check(Op->getNumOperands() == 3,
2059 "incorrect number of operands in module flag", Op);
2060 Module::ModFlagBehavior MFB;
2061 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
2063 "invalid behavior operand in module flag (expected constant integer)",
2064 Op->getOperand(0));
2065 Check(false,
2066 "invalid behavior operand in module flag (unexpected constant)",
2067 Op->getOperand(0));
2068 }
2069 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
2070 Check(ID, "invalid ID operand in module flag (expected metadata string)",
2071 Op->getOperand(1));
2072
2073 // Check the values for behaviors with additional requirements.
2074 switch (MFB) {
2075 case Module::Error:
2076 case Module::Warning:
2077 case Module::Override:
2078 // These behavior types accept any value.
2079 break;
2080
2081 case Module::Min: {
2082 auto *V = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
2083 Check(V && V->getValue().isNonNegative(),
2084 "invalid value for 'min' module flag (expected constant non-negative "
2085 "integer)",
2086 Op->getOperand(2));
2087 break;
2088 }
2089
2090 case Module::Max: {
2092 "invalid value for 'max' module flag (expected constant integer)",
2093 Op->getOperand(2));
2094 break;
2095 }
2096
2097 case Module::Require: {
2098 // The value should itself be an MDNode with two operands, a flag ID (an
2099 // MDString), and a value.
2100 auto *Value = dyn_cast<MDNode>(Op->getOperand(2));
2101 Check(Value && Value->getNumOperands() == 2,
2102 "invalid value for 'require' module flag (expected metadata pair)",
2103 Op->getOperand(2));
2104 Check(isa<MDString>(Value->getOperand(0)),
2105 ("invalid value for 'require' module flag "
2106 "(first value operand should be a string)"),
2107 Value->getOperand(0));
2108
2109 // Append it to the list of requirements, to check once all module flags are
2110 // scanned.
2111 Requirements.push_back(Value);
2112 break;
2113 }
2114
2115 case Module::Append:
2116 case Module::AppendUnique: {
2117 // These behavior types require the operand be an MDNode.
2118 Check(isa<MDNode>(Op->getOperand(2)),
2119 "invalid value for 'append'-type module flag "
2120 "(expected a metadata node)",
2121 Op->getOperand(2));
2122 break;
2123 }
2124 }
2125
2126 // Unless this is a "requires" flag, check the ID is unique.
2127 if (MFB != Module::Require) {
2128 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
2129 Check(Inserted,
2130 "module flag identifiers must be unique (or of 'require' type)", ID);
2131 }
2132
2133 StringRef Name = ID->getString();
2134 if (Name == "wchar_size") {
2135 ConstantInt *Value
2137 Check(Value, "wchar_size metadata requires constant integer argument");
2138 return;
2139 }
2140
2141 if (Name == "long-double-type") {
2142 Check(MFB == Module::Error,
2143 "long-double-type module flag must use 'error' merge behavior", Op);
2144 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2145 Check(Value, "long-double-type metadata requires a string argument");
2146 if (Value)
2147 Check(parseLongDoubleFormat(Value->getString()).has_value(),
2148 "invalid long-double-type metadata value", Op);
2149 return;
2150 }
2151
2152 if (Name == "float-abi") {
2153 Check(MFB == Module::Error,
2154 "float-abi module flag must use 'error' merge behavior", Op);
2155 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2156 Check(Value, "float-abi metadata requires a string argument");
2157 if (Value)
2158 Check(FloatABI::parseABIType(Value->getString()).has_value(),
2159 "invalid float-abi metadata value", Op);
2160 return;
2161 }
2162
2163 if (Name == "thread-model") {
2164 Check(MFB == Module::Error,
2165 "thread-model module flag must use 'error' merge behavior", Op);
2166 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2167 Check(Value, "thread-model metadata requires a string argument");
2168 if (Value)
2169 Check(parseThreadModel(Value->getString()).has_value(),
2170 "invalid thread-model metadata value", Op);
2171 return;
2172 }
2173
2174 if (Name == "target-abi") {
2175 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2176 Check(Value && !Value->getString().empty(),
2177 "target-abi metadata requires a non-empty string argument", Op);
2178 return;
2179 }
2180
2181 if (ID->getString() == "exception-model") {
2182 Check(MFB == Module::Error,
2183 "exception-model module flag must use 'error' merge behavior", Op);
2184 const MDString *Value = dyn_cast_or_null<MDString>(Op->getOperand(2));
2185 Check(Value, "exception-model metadata requires a string argument");
2186 if (Value)
2187 Check(parseExceptionModel(Value->getString()).has_value(),
2188 "invalid exception-model metadata value", Op);
2189 return;
2190 }
2191
2192 if (Name == "Linker Options") {
2193 // If the llvm.linker.options named metadata exists, we assume that the
2194 // bitcode reader has upgraded the module flag. Otherwise the flag might
2195 // have been created by a client directly.
2196 Check(M.getNamedMetadata("llvm.linker.options"),
2197 "'Linker Options' named metadata no longer supported");
2198 return;
2199 }
2200
2201 if (Name == "SemanticInterposition") {
2202 ConstantInt *Value =
2204 Check(Value,
2205 "SemanticInterposition metadata requires constant integer argument");
2206 return;
2207 }
2208
2209 if (Name == "CG Profile") {
2210 for (const MDOperand &MDO : cast<MDNode>(Op->getOperand(2))->operands())
2211 visitModuleFlagCGProfileEntry(MDO);
2212 return;
2213 }
2214
2215 // Target-specific module flag checks.
2216 verifyAMDGPUModuleFlag(*this, ID, MFB, Op);
2217}
2218
2219void Verifier::visitModuleFlagCGProfileEntry(const MDOperand &MDO) {
2220 auto CheckFunction = [&](const MDOperand &FuncMDO) {
2221 if (!FuncMDO)
2222 return;
2223 auto F = dyn_cast<ValueAsMetadata>(FuncMDO);
2224 Check(F && isa<Function>(F->getValue()->stripPointerCasts()),
2225 "expected a Function or null", FuncMDO);
2226 };
2227 auto Node = dyn_cast_or_null<MDNode>(MDO);
2228 Check(Node && Node->getNumOperands() == 3, "expected a MDNode triple", MDO);
2229 CheckFunction(Node->getOperand(0));
2230 CheckFunction(Node->getOperand(1));
2231 auto Count = dyn_cast_or_null<ConstantAsMetadata>(Node->getOperand(2));
2232 Check(Count && Count->getType()->isIntegerTy(),
2233 "expected an integer constant", Node->getOperand(2));
2234}
2235
2236void Verifier::verifyAttributeTypes(AttributeSet Attrs, const Value *V) {
2237 for (Attribute A : Attrs) {
2238
2239 if (A.isStringAttribute()) {
2240#define GET_ATTR_NAMES
2241#define ATTRIBUTE_ENUM(ENUM_NAME, DISPLAY_NAME)
2242#define ATTRIBUTE_STRBOOL(ENUM_NAME, DISPLAY_NAME) \
2243 if (A.getKindAsString() == #DISPLAY_NAME) { \
2244 auto V = A.getValueAsString(); \
2245 if (!(V.empty() || V == "true" || V == "false")) \
2246 CheckFailed("invalid value for '" #DISPLAY_NAME "' attribute: " + V + \
2247 ""); \
2248 }
2249
2250#include "llvm/IR/Attributes.inc"
2251 continue;
2252 }
2253
2254 if (A.isIntAttribute() != Attribute::isIntAttrKind(A.getKindAsEnum())) {
2255 CheckFailed("Attribute '" + A.getAsString() + "' should have an Argument",
2256 V);
2257 return;
2258 }
2259 }
2260}
2261
2262// VerifyParameterAttrs - Check the given attributes for an argument or return
2263// value of the specified type. The value V is printed in error messages.
2264void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty,
2265 const Value *V) {
2266 if (!Attrs.hasAttributes())
2267 return;
2268
2269 verifyAttributeTypes(Attrs, V);
2270
2271 for (Attribute Attr : Attrs)
2272 Check(Attr.isStringAttribute() ||
2273 Attribute::canUseAsParamAttr(Attr.getKindAsEnum()),
2274 "Attribute '" + Attr.getAsString() + "' does not apply to parameters",
2275 V);
2276
2277 if (Attrs.hasAttribute(Attribute::ImmArg)) {
2278 unsigned AttrCount =
2279 Attrs.getNumAttributes() - Attrs.hasAttribute(Attribute::Range);
2280 Check(AttrCount == 1,
2281 "Attribute 'immarg' is incompatible with other attributes except the "
2282 "'range' attribute",
2283 V);
2284 }
2285
2286 // Check for mutually incompatible attributes. Only inreg is compatible with
2287 // sret.
2288 unsigned AttrCount = 0;
2289 AttrCount += Attrs.hasAttribute(Attribute::ByVal);
2290 AttrCount += Attrs.hasAttribute(Attribute::InAlloca);
2291 AttrCount += Attrs.hasAttribute(Attribute::Preallocated);
2292 AttrCount += Attrs.hasAttribute(Attribute::StructRet) ||
2293 Attrs.hasAttribute(Attribute::InReg);
2294 AttrCount += Attrs.hasAttribute(Attribute::Nest);
2295 AttrCount += Attrs.hasAttribute(Attribute::ByRef);
2296 Check(AttrCount <= 1,
2297 "Attributes 'byval', 'inalloca', 'preallocated', 'inreg', 'nest', "
2298 "'byref', and 'sret' are incompatible!",
2299 V);
2300
2301 Check(!(Attrs.hasAttribute(Attribute::InAlloca) &&
2302 Attrs.hasAttribute(Attribute::ReadOnly)),
2303 "Attributes "
2304 "'inalloca and readonly' are incompatible!",
2305 V);
2306
2307 Check(!(Attrs.hasAttribute(Attribute::StructRet) &&
2308 Attrs.hasAttribute(Attribute::Returned)),
2309 "Attributes "
2310 "'sret and returned' are incompatible!",
2311 V);
2312
2313 Check(!(Attrs.hasAttribute(Attribute::ZExt) &&
2314 Attrs.hasAttribute(Attribute::SExt)),
2315 "Attributes "
2316 "'zeroext and signext' are incompatible!",
2317 V);
2318
2319 Check(!(Attrs.hasAttribute(Attribute::ReadNone) &&
2320 Attrs.hasAttribute(Attribute::ReadOnly)),
2321 "Attributes "
2322 "'readnone and readonly' are incompatible!",
2323 V);
2324
2325 Check(!(Attrs.hasAttribute(Attribute::ReadNone) &&
2326 Attrs.hasAttribute(Attribute::WriteOnly)),
2327 "Attributes "
2328 "'readnone and writeonly' are incompatible!",
2329 V);
2330
2331 Check(!(Attrs.hasAttribute(Attribute::ReadOnly) &&
2332 Attrs.hasAttribute(Attribute::WriteOnly)),
2333 "Attributes "
2334 "'readonly and writeonly' are incompatible!",
2335 V);
2336
2337 Check(!(Attrs.hasAttribute(Attribute::NoInline) &&
2338 Attrs.hasAttribute(Attribute::AlwaysInline)),
2339 "Attributes "
2340 "'noinline and alwaysinline' are incompatible!",
2341 V);
2342
2343 Check(!(Attrs.hasAttribute(Attribute::Writable) &&
2344 Attrs.hasAttribute(Attribute::ReadNone)),
2345 "Attributes writable and readnone are incompatible!", V);
2346
2347 Check(!(Attrs.hasAttribute(Attribute::Writable) &&
2348 Attrs.hasAttribute(Attribute::ReadOnly)),
2349 "Attributes writable and readonly are incompatible!", V);
2350
2351 AttributeMask IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty, Attrs);
2352 for (Attribute Attr : Attrs) {
2353 if (!Attr.isStringAttribute() &&
2354 IncompatibleAttrs.contains(Attr.getKindAsEnum())) {
2355 CheckFailed("Attribute '" + Attr.getAsString() +
2356 "' applied to incompatible type!", V);
2357 return;
2358 }
2359 }
2360
2361 if (isa<PointerType>(Ty)) {
2362 if (Attrs.hasAttribute(Attribute::Alignment)) {
2363 Align AttrAlign = Attrs.getAlignment().valueOrOne();
2364 Check(AttrAlign.value() <= Value::MaximumAlignment,
2365 "huge alignment values are unsupported", V);
2366 }
2367 if (Attrs.hasAttribute(Attribute::ByVal)) {
2368 Type *ByValTy = Attrs.getByValType();
2369 Check(ByValTy->isSized(),
2370 "Attribute 'byval' does not support unsized types!", V);
2371 // Check if it is or contains a target extension type that disallows being
2372 // used on the stack.
2374 "'byval' argument has illegal target extension type", V);
2375 // The copy is placed in the caller's frame, which needs its size at
2376 // compile time.
2377 Check(!ByValTy->isScalableTy(),
2378 "scalable 'byval' arguments are unsupported", V);
2379 Check(DL.getTypeAllocSize(ByValTy).getKnownMinValue() < (1ULL << 32),
2380 "huge 'byval' arguments are unsupported", V);
2381 }
2382 if (Attrs.hasAttribute(Attribute::ByRef)) {
2383 Check(Attrs.getByRefType()->isSized(),
2384 "Attribute 'byref' does not support unsized types!", V);
2385 Check(DL.getTypeAllocSize(Attrs.getByRefType()).getKnownMinValue() <
2386 (1ULL << 32),
2387 "huge 'byref' arguments are unsupported", V);
2388 }
2389 if (Attrs.hasAttribute(Attribute::InAlloca)) {
2390 Check(Attrs.getInAllocaType()->isSized(),
2391 "Attribute 'inalloca' does not support unsized types!", V);
2392 Check(DL.getTypeAllocSize(Attrs.getInAllocaType()).getKnownMinValue() <
2393 (1ULL << 32),
2394 "huge 'inalloca' arguments are unsupported", V);
2395 }
2396 if (Attrs.hasAttribute(Attribute::Preallocated)) {
2397 Check(Attrs.getPreallocatedType()->isSized(),
2398 "Attribute 'preallocated' does not support unsized types!", V);
2399 Check(
2400 DL.getTypeAllocSize(Attrs.getPreallocatedType()).getKnownMinValue() <
2401 (1ULL << 32),
2402 "huge 'preallocated' arguments are unsupported", V);
2403 }
2404 }
2405
2406 if (Attrs.hasAttribute(Attribute::Initializes)) {
2407 auto Inits = Attrs.getAttribute(Attribute::Initializes).getInitializes();
2408 Check(!Inits.empty(), "Attribute 'initializes' does not support empty list",
2409 V);
2411 "Attribute 'initializes' does not support unordered ranges", V);
2412 }
2413
2414 if (Attrs.hasAttribute(Attribute::NoFPClass)) {
2415 uint64_t Val = Attrs.getAttribute(Attribute::NoFPClass).getValueAsInt();
2416 Check(Val != 0, "Attribute 'nofpclass' must have at least one test bit set",
2417 V);
2418 Check((Val & ~static_cast<unsigned>(fcAllFlags)) == 0,
2419 "Invalid value for 'nofpclass' test mask", V);
2420 }
2421 if (Attrs.hasAttribute(Attribute::Range)) {
2422 const ConstantRange &CR =
2423 Attrs.getAttribute(Attribute::Range).getValueAsConstantRange();
2425 "Range bit width must match type bit width!", V);
2426 }
2427}
2428
2429void Verifier::checkUnsignedBaseTenFuncAttr(AttributeList Attrs, StringRef Attr,
2430 const Value *V) {
2431 if (Attrs.hasFnAttr(Attr)) {
2432 StringRef S = Attrs.getFnAttr(Attr).getValueAsString();
2433 unsigned N;
2434 if (S.getAsInteger(10, N))
2435 CheckFailed("\"" + Attr + "\" takes an unsigned integer: " + S, V);
2436 }
2437}
2438
2439// Check parameter attributes against a function type.
2440// The value V is printed in error messages.
2441void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
2442 const Value *V, bool IsIntrinsic,
2443 bool IsInlineAsm) {
2444 if (Attrs.isEmpty())
2445 return;
2446
2447 if (AttributeListsVisited.insert(Attrs.getRawPointer()).second) {
2448 Check(Attrs.hasParentContext(Context),
2449 "Attribute list does not match Module context!", &Attrs, V);
2450 for (const auto &AttrSet : Attrs) {
2451 Check(!AttrSet.hasAttributes() || AttrSet.hasParentContext(Context),
2452 "Attribute set does not match Module context!", &AttrSet, V);
2453 for (const auto &A : AttrSet) {
2454 Check(A.hasParentContext(Context),
2455 "Attribute does not match Module context!", &A, V);
2456 }
2457 }
2458 }
2459
2460 bool SawNest = false;
2461 bool SawReturned = false;
2462 bool SawSRet = false;
2463 bool SawSwiftSelf = false;
2464 bool SawSwiftAsync = false;
2465 bool SawSwiftError = false;
2466
2467 // Verify return value attributes.
2468 AttributeSet RetAttrs = Attrs.getRetAttrs();
2469 for (Attribute RetAttr : RetAttrs)
2470 Check(RetAttr.isStringAttribute() ||
2471 Attribute::canUseAsRetAttr(RetAttr.getKindAsEnum()),
2472 "Attribute '" + RetAttr.getAsString() +
2473 "' does not apply to function return values",
2474 V);
2475
2476 unsigned MaxParameterWidth = 0;
2477 auto GetMaxParameterWidth = [&MaxParameterWidth](Type *Ty) {
2478 if (Ty->isVectorTy()) {
2479 if (auto *VT = dyn_cast<FixedVectorType>(Ty)) {
2480 unsigned Size = VT->getPrimitiveSizeInBits().getFixedValue();
2481 if (Size > MaxParameterWidth)
2482 MaxParameterWidth = Size;
2483 }
2484 }
2485 };
2486 GetMaxParameterWidth(FT->getReturnType());
2487 verifyParameterAttrs(RetAttrs, FT->getReturnType(), V);
2488
2489 // Verify parameter attributes.
2490 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
2491 Type *Ty = FT->getParamType(i);
2492 AttributeSet ArgAttrs = Attrs.getParamAttrs(i);
2493
2494 if (!IsIntrinsic) {
2495 Check(!ArgAttrs.hasAttribute(Attribute::ImmArg),
2496 "immarg attribute only applies to intrinsics", V);
2497 if (!IsInlineAsm)
2498 Check(!ArgAttrs.hasAttribute(Attribute::ElementType),
2499 "Attribute 'elementtype' can only be applied to intrinsics"
2500 " and inline asm.",
2501 V);
2502 }
2503
2504 verifyParameterAttrs(ArgAttrs, Ty, V);
2505 GetMaxParameterWidth(Ty);
2506
2507 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
2508 Check(!SawNest, "More than one parameter has attribute nest!", V);
2509 SawNest = true;
2510 }
2511
2512 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
2513 Check(!SawReturned, "More than one parameter has attribute returned!", V);
2514 Check(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
2515 "Incompatible argument and return types for 'returned' attribute",
2516 V);
2517 SawReturned = true;
2518 }
2519
2520 if (ArgAttrs.hasAttribute(Attribute::StructRet)) {
2521 Check(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
2522 Check(i == 0 || i == 1,
2523 "Attribute 'sret' is not on first or second parameter!", V);
2524 SawSRet = true;
2525 }
2526
2527 if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) {
2528 Check(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
2529 SawSwiftSelf = true;
2530 }
2531
2532 if (ArgAttrs.hasAttribute(Attribute::SwiftAsync)) {
2533 Check(!SawSwiftAsync, "Cannot have multiple 'swiftasync' parameters!", V);
2534 SawSwiftAsync = true;
2535 }
2536
2537 if (ArgAttrs.hasAttribute(Attribute::SwiftError)) {
2538 Check(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!", V);
2539 SawSwiftError = true;
2540 }
2541
2542 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) {
2543 Check(i == FT->getNumParams() - 1,
2544 "inalloca isn't on the last parameter!", V);
2545 }
2546 }
2547
2548 if (!Attrs.hasFnAttrs())
2549 return;
2550
2551 verifyAttributeTypes(Attrs.getFnAttrs(), V);
2552 for (Attribute FnAttr : Attrs.getFnAttrs())
2553 Check(FnAttr.isStringAttribute() ||
2554 Attribute::canUseAsFnAttr(FnAttr.getKindAsEnum()),
2555 "Attribute '" + FnAttr.getAsString() +
2556 "' does not apply to functions!",
2557 V);
2558
2559 Check(!(Attrs.hasFnAttr(Attribute::NoInline) &&
2560 Attrs.hasFnAttr(Attribute::AlwaysInline)),
2561 "Attributes 'noinline and alwaysinline' are incompatible!", V);
2562
2563 if (Attrs.hasFnAttr(Attribute::OptimizeNone)) {
2564 Check(Attrs.hasFnAttr(Attribute::NoInline),
2565 "Attribute 'optnone' requires 'noinline'!", V);
2566
2567 Check(!Attrs.hasFnAttr(Attribute::OptimizeForSize),
2568 "Attributes 'optsize and optnone' are incompatible!", V);
2569
2570 Check(!Attrs.hasFnAttr(Attribute::MinSize),
2571 "Attributes 'minsize and optnone' are incompatible!", V);
2572
2573 Check(!Attrs.hasFnAttr(Attribute::OptimizeForDebugging),
2574 "Attributes 'optdebug and optnone' are incompatible!", V);
2575 }
2576
2577 Check(!(Attrs.hasFnAttr(Attribute::SanitizeRealtime) &&
2578 Attrs.hasFnAttr(Attribute::SanitizeRealtimeBlocking)),
2579 "Attributes "
2580 "'sanitize_realtime and sanitize_realtime_blocking' are incompatible!",
2581 V);
2582
2583 if (Attrs.hasFnAttr(Attribute::OptimizeForDebugging)) {
2584 Check(!Attrs.hasFnAttr(Attribute::OptimizeForSize),
2585 "Attributes 'optsize and optdebug' are incompatible!", V);
2586
2587 Check(!Attrs.hasFnAttr(Attribute::MinSize),
2588 "Attributes 'minsize and optdebug' are incompatible!", V);
2589 }
2590
2591 Check(!Attrs.hasAttrSomewhere(Attribute::Writable) ||
2592 isModSet(Attrs.getMemoryEffects().getModRef(IRMemLocation::ArgMem)),
2593 "Attribute writable and memory without argmem: write are incompatible!",
2594 V);
2595
2596 if (Attrs.hasFnAttr("aarch64_pstate_sm_enabled")) {
2597 Check(!Attrs.hasFnAttr("aarch64_pstate_sm_compatible"),
2598 "Attributes 'aarch64_pstate_sm_enabled and "
2599 "aarch64_pstate_sm_compatible' are incompatible!",
2600 V);
2601 }
2602
2603 Check((Attrs.hasFnAttr("aarch64_new_za") + Attrs.hasFnAttr("aarch64_in_za") +
2604 Attrs.hasFnAttr("aarch64_inout_za") +
2605 Attrs.hasFnAttr("aarch64_out_za") +
2606 Attrs.hasFnAttr("aarch64_preserves_za") +
2607 Attrs.hasFnAttr("aarch64_za_state_agnostic")) <= 1,
2608 "Attributes 'aarch64_new_za', 'aarch64_in_za', 'aarch64_out_za', "
2609 "'aarch64_inout_za', 'aarch64_preserves_za' and "
2610 "'aarch64_za_state_agnostic' are mutually exclusive",
2611 V);
2612
2613 Check((Attrs.hasFnAttr("aarch64_new_zt0") +
2614 Attrs.hasFnAttr("aarch64_in_zt0") +
2615 Attrs.hasFnAttr("aarch64_inout_zt0") +
2616 Attrs.hasFnAttr("aarch64_out_zt0") +
2617 Attrs.hasFnAttr("aarch64_preserves_zt0") +
2618 Attrs.hasFnAttr("aarch64_za_state_agnostic")) <= 1,
2619 "Attributes 'aarch64_new_zt0', 'aarch64_in_zt0', 'aarch64_out_zt0', "
2620 "'aarch64_inout_zt0', 'aarch64_preserves_zt0' and "
2621 "'aarch64_za_state_agnostic' are mutually exclusive",
2622 V);
2623
2624 if (Attrs.hasFnAttr(Attribute::JumpTable)) {
2625 const GlobalValue *GV = cast<GlobalValue>(V);
2627 "Attribute 'jumptable' requires 'unnamed_addr'", V);
2628 }
2629
2630 if (auto Args = Attrs.getFnAttrs().getAllocSizeArgs()) {
2631 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
2632 if (ParamNo >= FT->getNumParams()) {
2633 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
2634 return false;
2635 }
2636
2637 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
2638 CheckFailed("'allocsize' " + Name +
2639 " argument must refer to an integer parameter",
2640 V);
2641 return false;
2642 }
2643
2644 return true;
2645 };
2646
2647 if (!CheckParam("element size", Args->first))
2648 return;
2649
2650 if (Args->second && !CheckParam("number of elements", *Args->second))
2651 return;
2652 }
2653
2654 if (Attrs.hasFnAttr(Attribute::AllocKind)) {
2655 AllocFnKind K = Attrs.getAllocKind();
2657 K & (AllocFnKind::Alloc | AllocFnKind::Realloc | AllocFnKind::Free);
2658 if (!is_contained(
2659 {AllocFnKind::Alloc, AllocFnKind::Realloc, AllocFnKind::Free},
2660 Type))
2661 CheckFailed(
2662 "'allockind()' requires exactly one of alloc, realloc, and free");
2663 if ((Type == AllocFnKind::Free) &&
2664 ((K & (AllocFnKind::Uninitialized | AllocFnKind::Zeroed |
2665 AllocFnKind::Aligned)) != AllocFnKind::Unknown))
2666 CheckFailed("'allockind(\"free\")' doesn't allow uninitialized, zeroed, "
2667 "or aligned modifiers.");
2668 AllocFnKind ZeroedUninit = AllocFnKind::Uninitialized | AllocFnKind::Zeroed;
2669 if ((K & ZeroedUninit) == ZeroedUninit)
2670 CheckFailed("'allockind()' can't be both zeroed and uninitialized");
2671 }
2672
2673 if (Attribute A = Attrs.getFnAttr("alloc-variant-zeroed"); A.isValid()) {
2674 StringRef S = A.getValueAsString();
2675 Check(!S.empty(), "'alloc-variant-zeroed' must not be empty");
2676 Function *Variant = M.getFunction(S);
2677 if (Variant) {
2678 Attribute Family = Attrs.getFnAttr("alloc-family");
2679 Attribute VariantFamily = Variant->getFnAttribute("alloc-family");
2680 if (Family.isValid())
2681 Check(VariantFamily.isValid() &&
2682 VariantFamily.getValueAsString() == Family.getValueAsString(),
2683 "'alloc-variant-zeroed' must name a function belonging to the "
2684 "same 'alloc-family'");
2685
2686 Check(Variant->hasFnAttribute(Attribute::AllocKind) &&
2687 (Variant->getFnAttribute(Attribute::AllocKind).getAllocKind() &
2688 AllocFnKind::Zeroed) != AllocFnKind::Unknown,
2689 "'alloc-variant-zeroed' must name a function with "
2690 "'allockind(\"zeroed\")'");
2691
2692 Check(FT == Variant->getFunctionType(),
2693 "'alloc-variant-zeroed' must name a function with the same "
2694 "signature");
2695
2696 if (const auto *F = dyn_cast<Function>(V))
2697 Check(F->getCallingConv() == Variant->getCallingConv(),
2698 "'alloc-variant-zeroed' must name a function with the same "
2699 "calling convention");
2700 }
2701 }
2702
2703 if (Attrs.hasFnAttr(Attribute::VScaleRange)) {
2704 unsigned VScaleMin = Attrs.getFnAttrs().getVScaleRangeMin();
2705 if (VScaleMin == 0)
2706 CheckFailed("'vscale_range' minimum must be greater than 0", V);
2707 else if (!isPowerOf2_32(VScaleMin))
2708 CheckFailed("'vscale_range' minimum must be power-of-two value", V);
2709 std::optional<unsigned> VScaleMax = Attrs.getFnAttrs().getVScaleRangeMax();
2710 if (VScaleMax && VScaleMin > VScaleMax)
2711 CheckFailed("'vscale_range' minimum cannot be greater than maximum", V);
2712 else if (VScaleMax && !isPowerOf2_32(*VScaleMax))
2713 CheckFailed("'vscale_range' maximum must be power-of-two value", V);
2714 }
2715
2716 if (Attribute FPAttr = Attrs.getFnAttr("frame-pointer"); FPAttr.isValid()) {
2717 StringRef FP = FPAttr.getValueAsString();
2718 if (FP != "all" && FP != "non-leaf" && FP != "none" && FP != "reserved" &&
2719 FP != "non-leaf-no-reserve")
2720 CheckFailed("invalid value for 'frame-pointer' attribute: " + FP, V);
2721 }
2722
2723 checkUnsignedBaseTenFuncAttr(Attrs, "tail-pad-to-size", V);
2724 checkUnsignedBaseTenFuncAttr(Attrs, "tail-pad-value", V);
2725 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-prefix", V);
2726 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-entry", V);
2727 if (Attrs.hasFnAttr("patchable-function-entry-section"))
2728 Check(!Attrs.getFnAttr("patchable-function-entry-section")
2729 .getValueAsString()
2730 .empty(),
2731 "\"patchable-function-entry-section\" must not be empty");
2732 checkUnsignedBaseTenFuncAttr(Attrs, "warn-stack-size", V);
2733
2734 if (auto A = Attrs.getFnAttr("sign-return-address"); A.isValid()) {
2735 StringRef S = A.getValueAsString();
2736 if (S != "none" && S != "all" && S != "non-leaf")
2737 CheckFailed("invalid value for 'sign-return-address' attribute: " + S, V);
2738 }
2739
2740 if (auto A = Attrs.getFnAttr("sign-return-address-key"); A.isValid()) {
2741 StringRef S = A.getValueAsString();
2742 if (S != "a_key" && S != "b_key")
2743 CheckFailed("invalid value for 'sign-return-address-key' attribute: " + S,
2744 V);
2745 if (auto AA = Attrs.getFnAttr("sign-return-address"); !AA.isValid()) {
2746 CheckFailed(
2747 "'sign-return-address-key' present without `sign-return-address`");
2748 }
2749 }
2750
2751 if (auto A = Attrs.getFnAttr("sign-return-address-harden"); A.isValid()) {
2752 StringRef S = A.getValueAsString();
2753 if (S != "load-return-address" && S != "none")
2754 CheckFailed(
2755 "invalid value for 'sign-return-address-harden' attribute: " + S, V);
2756 auto SignRetA = Attrs.getFnAttr("sign-return-address");
2757 auto PAuthRetA = Attrs.getFnAttr("ptrauth-returns");
2758 if (!SignRetA.isValid() && !PAuthRetA.isValid())
2759 CheckFailed("'sign-return-address-harden' present without "
2760 "'sign-return-address' or 'ptrauth-returns'");
2761 }
2762
2763 if (auto A = Attrs.getFnAttr("branch-target-enforcement"); A.isValid()) {
2764 StringRef S = A.getValueAsString();
2765 if (S != "" && S != "true" && S != "false")
2766 CheckFailed(
2767 "invalid value for 'branch-target-enforcement' attribute: " + S, V);
2768 }
2769
2770 if (auto A = Attrs.getFnAttr("branch-protection-pauth-lr"); A.isValid()) {
2771 StringRef S = A.getValueAsString();
2772 if (S != "" && S != "true" && S != "false")
2773 CheckFailed(
2774 "invalid value for 'branch-protection-pauth-lr' attribute: " + S, V);
2775 }
2776
2777 if (auto A = Attrs.getFnAttr("guarded-control-stack"); A.isValid()) {
2778 StringRef S = A.getValueAsString();
2779 if (S != "" && S != "true" && S != "false")
2780 CheckFailed("invalid value for 'guarded-control-stack' attribute: " + S,
2781 V);
2782 }
2783
2784 if (auto A = Attrs.getFnAttr("vector-function-abi-variant"); A.isValid()) {
2785 StringRef S = A.getValueAsString();
2786 const std::optional<VFInfo> Info = VFABI::tryDemangleForVFABI(S, FT);
2787 if (!Info)
2788 CheckFailed("invalid name for a VFABI variant: " + S, V);
2789 }
2790
2791 if (auto A = Attrs.getFnAttr("modular-format"); A.isValid()) {
2792 StringRef S = A.getValueAsString();
2794 S.split(Args, ',');
2795 Check(Args.size() >= 5,
2796 "modular-format attribute requires at least 5 arguments", V);
2797 unsigned UpperBound = FT->getNumParams() + (FT->isVarArg() ? 1 : 0);
2798 unsigned FormatIdx;
2799 Check(!Args[1].getAsInteger(10, FormatIdx),
2800 "modular-format attribute format string index is not an integer", V);
2801 Check(FormatIdx > 0,
2802 "modular-format attribute format string index must be greater than 0",
2803 V);
2804 Check(FormatIdx <= UpperBound,
2805 "modular-format attribute format string index is out of bounds", V);
2806 unsigned FirstArgIdx;
2807 Check(!Args[2].getAsInteger(10, FirstArgIdx),
2808 "modular-format attribute first arg index is not an integer", V);
2809 Check(FirstArgIdx <= UpperBound,
2810 "modular-format attribute first arg index is out of bounds", V);
2811 Check(!Args[3].empty(),
2812 "modular-format attribute modular implementation function name "
2813 "cannot be empty",
2814 V);
2815 Check(!Args[4].empty(),
2816 "modular-format attribute implementation name cannot be empty", V);
2817 }
2818
2819 if (auto A = Attrs.getFnAttr("target-features"); A.isValid()) {
2820 StringRef S = A.getValueAsString();
2821 if (!S.empty()) {
2822 for (auto FeatureFlag : split(S, ',')) {
2823 if (FeatureFlag.empty())
2824 CheckFailed(
2825 "target-features attribute should not contain an empty string");
2826 else
2827 Check(FeatureFlag[0] == '+' || FeatureFlag[0] == '-',
2828 "target feature '" + FeatureFlag +
2829 "' must start with a '+' or '-'",
2830 V);
2831 }
2832 }
2833 }
2834}
2835void Verifier::verifyUnknownProfileMetadata(MDNode *MD) {
2836 Check(MD->getNumOperands() == 2,
2837 "'unknown' !prof should have a single additional operand", MD);
2838 auto *PassName = dyn_cast<MDString>(MD->getOperand(1));
2839 Check(PassName != nullptr,
2840 "'unknown' !prof should have an additional operand of type "
2841 "string");
2842 Check(!PassName->getString().empty(),
2843 "the 'unknown' !prof operand should not be an empty string");
2844}
2845
2846void Verifier::verifyFunctionMetadata(
2847 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
2848 for (const auto &Pair : MDs) {
2849 if (Pair.first == LLVMContext::MD_prof) {
2850 MDNode *MD = Pair.second;
2851 Check(MD->getNumOperands() >= 2,
2852 "!prof annotations should have no less than 2 operands", MD);
2853 // We may have functions that are synthesized by the compiler, e.g. in
2854 // WPD, that we can't currently determine the entry count.
2855 if (MD->getOperand(0).equalsStr(
2857 verifyUnknownProfileMetadata(MD);
2858 continue;
2859 }
2860
2861 // Check first operand.
2862 Check(MD->getOperand(0) != nullptr, "first operand should not be null",
2863 MD);
2865 "expected string with name of the !prof annotation", MD);
2866 MDString *MDS = cast<MDString>(MD->getOperand(0));
2867 StringRef ProfName = MDS->getString();
2870 "first operand should be 'function_entry_count'"
2871 " or 'synthetic_function_entry_count'",
2872 MD);
2873
2874 // Check second operand.
2875 Check(MD->getOperand(1) != nullptr, "second operand should not be null",
2876 MD);
2878 "expected integer argument to function_entry_count", MD);
2879 } else if (Pair.first == LLVMContext::MD_kcfi_type) {
2880 MDNode *MD = Pair.second;
2881 Check(MD->getNumOperands() == 1,
2882 "!kcfi_type must have exactly one operand", MD);
2883 Check(MD->getOperand(0) != nullptr, "!kcfi_type operand must not be null",
2884 MD);
2886 "expected a constant operand for !kcfi_type", MD);
2887 Constant *C = cast<ConstantAsMetadata>(MD->getOperand(0))->getValue();
2888 Check(isa<ConstantInt>(C) && isa<IntegerType>(C->getType()),
2889 "expected a constant integer operand for !kcfi_type", MD);
2891 "expected a 32-bit integer constant operand for !kcfi_type", MD);
2892 } else if (Pair.first == Context.getMDKindID("reqd_work_group_size")) {
2893 MDNode *MD = Pair.second;
2894 Check(MD->getNumOperands() == 3,
2895 "reqd_work_group_size must have exactly three operands", MD);
2896 if (MD->getNumOperands() != 3)
2897 continue;
2898
2899 uint64_t Product = 1;
2900 for (unsigned I = 0; I != 3; ++I) {
2901 ConstantInt *C = mdconst::dyn_extract<ConstantInt>(MD->getOperand(I));
2902 Check(C, "reqd_work_group_size operands must be integer constants", MD);
2903 if (!C)
2904 break;
2905
2906 const APInt &Value = C->getValue();
2907 Check(Value.getActiveBits() <= 64,
2908 "reqd_work_group_size operands must fit in 64 bits", MD);
2909 if (Value.getActiveBits() > 64)
2910 break;
2911
2912 uint64_t Dim = Value.getZExtValue();
2913 Check(Dim == 0 || Product <= std::numeric_limits<uint64_t>::max() / Dim,
2914 "reqd_work_group_size product must fit in 64 bits", MD);
2915 if (Dim != 0 && Product > std::numeric_limits<uint64_t>::max() / Dim)
2916 break;
2917 Product *= Dim;
2918 }
2919 }
2920 }
2921}
2922
2923void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
2924 if (EntryC->getNumOperands() == 0)
2925 return;
2926
2927 if (!ConstantExprVisited.insert(EntryC).second)
2928 return;
2929
2931 Stack.push_back(EntryC);
2932
2933 while (!Stack.empty()) {
2934 const Constant *C = Stack.pop_back_val();
2935
2936 // Check this constant expression.
2937 if (const auto *CE = dyn_cast<ConstantExpr>(C))
2938 visitConstantExpr(CE);
2939
2940 if (const auto *CPA = dyn_cast<ConstantPtrAuth>(C))
2941 visitConstantPtrAuth(CPA);
2942
2943 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
2944 // Global Values get visited separately, but we do need to make sure
2945 // that the global value is in the correct module
2946 Check(GV->getParent() == &M, "Referencing global in another module!",
2947 EntryC, &M, GV, GV->getParent());
2948 continue;
2949 }
2950
2951 // Visit all sub-expressions.
2952 for (const Use &U : C->operands()) {
2953 const auto *OpC = dyn_cast<Constant>(U);
2954 if (!OpC)
2955 continue;
2956 if (!ConstantExprVisited.insert(OpC).second)
2957 continue;
2958 Stack.push_back(OpC);
2959 }
2960 }
2961}
2962
2963void Verifier::visitConstantExpr(const ConstantExpr *CE) {
2964 if (CE->getOpcode() == Instruction::BitCast) {
2965 Check(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
2966 CE->getType()),
2967 "Invalid bitcast", CE);
2968 Check(DL.getTypeSizeInBits(CE->getOperand(0)->getType()) ==
2969 DL.getTypeSizeInBits(CE->getType()),
2970 "Invalid bitcast", CE);
2971 } else if (CE->getOpcode() == Instruction::PtrToAddr)
2972 checkPtrToAddr(CE->getOperand(0)->getType(), CE->getType(), *CE);
2973}
2974
2975void Verifier::visitConstantPtrAuth(const ConstantPtrAuth *CPA) {
2976 Check(CPA->getPointer()->getType()->isPointerTy(),
2977 "signed ptrauth constant base pointer must have pointer type");
2978
2979 Check(CPA->getType() == CPA->getPointer()->getType(),
2980 "signed ptrauth constant must have same type as its base pointer");
2981
2982 Check(CPA->getKey()->getBitWidth() == 32,
2983 "signed ptrauth constant key must be i32 constant integer");
2984
2986 "signed ptrauth constant address discriminator must be a pointer");
2987
2988 Check(CPA->getDiscriminator()->getBitWidth() == 64,
2989 "signed ptrauth constant discriminator must be i64 constant integer");
2990
2992 "signed ptrauth constant deactivation symbol must be a pointer");
2993
2996 "signed ptrauth constant deactivation symbol must be a global value "
2997 "or null");
2998}
2999
3000bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) {
3001 // There shouldn't be more attribute sets than there are parameters plus the
3002 // function and return value.
3003 return Attrs.getNumAttrSets() <= Params + 2;
3004}
3005
3006void Verifier::verifyInlineAsmCall(const CallBase &Call) {
3007 const InlineAsm *IA = cast<InlineAsm>(Call.getCalledOperand());
3008 unsigned ArgNo = 0;
3009 unsigned LabelNo = 0;
3010 for (const InlineAsm::ConstraintInfo &CI : IA->ParseConstraints()) {
3011 if (CI.Type == InlineAsm::isLabel) {
3012 ++LabelNo;
3013 continue;
3014 }
3015
3016 // Only deal with constraints that correspond to call arguments.
3017 if (!CI.hasArg())
3018 continue;
3019
3020 if (CI.isIndirect) {
3021 const Value *Arg = Call.getArgOperand(ArgNo);
3022 Check(Arg->getType()->isPointerTy(),
3023 "Operand for indirect constraint must have pointer type", &Call);
3024
3026 "Operand for indirect constraint must have elementtype attribute",
3027 &Call);
3028 } else {
3029 Check(!Call.paramHasAttr(ArgNo, Attribute::ElementType),
3030 "Elementtype attribute can only be applied for indirect "
3031 "constraints",
3032 &Call);
3033 }
3034
3035 ArgNo++;
3036 }
3037
3038 if (auto *CallBr = dyn_cast<CallBrInst>(&Call)) {
3039 Check(LabelNo == CallBr->getNumIndirectDests(),
3040 "Number of label constraints does not match number of callbr dests",
3041 &Call);
3042 } else {
3043 Check(LabelNo == 0, "Label constraints can only be used with callbr",
3044 &Call);
3045 }
3046}
3047
3048/// Verify that statepoint intrinsic is well formed.
3049void Verifier::verifyStatepoint(const CallBase &Call) {
3050 assert(Call.getIntrinsicID() == Intrinsic::experimental_gc_statepoint);
3051
3054 "gc.statepoint must read and write all memory to preserve "
3055 "reordering restrictions required by safepoint semantics",
3056 Call);
3057
3058 const int64_t NumPatchBytes =
3059 cast<ConstantInt>(Call.getArgOperand(1))->getSExtValue();
3060 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
3061 Check(NumPatchBytes >= 0,
3062 "gc.statepoint number of patchable bytes must be "
3063 "positive",
3064 Call);
3065
3066 Type *TargetElemType = Call.getParamElementType(2);
3067 Check(TargetElemType,
3068 "gc.statepoint callee argument must have elementtype attribute", Call);
3069 auto *TargetFuncType = dyn_cast<FunctionType>(TargetElemType);
3070 Check(TargetFuncType,
3071 "gc.statepoint callee elementtype must be function type", Call);
3072
3073 const int NumCallArgs = cast<ConstantInt>(Call.getArgOperand(3))->getZExtValue();
3074 Check(NumCallArgs >= 0,
3075 "gc.statepoint number of arguments to underlying call "
3076 "must be positive",
3077 Call);
3078 const int NumParams = (int)TargetFuncType->getNumParams();
3079 if (TargetFuncType->isVarArg()) {
3080 Check(NumCallArgs >= NumParams,
3081 "gc.statepoint mismatch in number of vararg call args", Call);
3082
3083 // TODO: Remove this limitation
3084 Check(TargetFuncType->getReturnType()->isVoidTy(),
3085 "gc.statepoint doesn't support wrapping non-void "
3086 "vararg functions yet",
3087 Call);
3088 } else
3089 Check(NumCallArgs == NumParams,
3090 "gc.statepoint mismatch in number of call args", Call);
3091
3092 const uint64_t Flags
3093 = cast<ConstantInt>(Call.getArgOperand(4))->getZExtValue();
3094 Check((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
3095 "unknown flag used in gc.statepoint flags argument", Call);
3096
3097 // Verify that the types of the call parameter arguments match
3098 // the type of the wrapped callee.
3099 AttributeList Attrs = Call.getAttributes();
3100 for (int i = 0; i < NumParams; i++) {
3101 Type *ParamType = TargetFuncType->getParamType(i);
3102 Type *ArgType = Call.getArgOperand(5 + i)->getType();
3103 Check(ArgType == ParamType,
3104 "gc.statepoint call argument does not match wrapped "
3105 "function type",
3106 Call);
3107
3108 if (TargetFuncType->isVarArg()) {
3109 AttributeSet ArgAttrs = Attrs.getParamAttrs(5 + i);
3110 Check(!ArgAttrs.hasAttribute(Attribute::StructRet),
3111 "Attribute 'sret' cannot be used for vararg call arguments!", Call);
3112 }
3113 }
3114
3115 const int EndCallArgsInx = 4 + NumCallArgs;
3116
3117 const Value *NumTransitionArgsV = Call.getArgOperand(EndCallArgsInx + 1);
3118 Check(isa<ConstantInt>(NumTransitionArgsV),
3119 "gc.statepoint number of transition arguments "
3120 "must be constant integer",
3121 Call);
3122 const int NumTransitionArgs =
3123 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
3124 Check(NumTransitionArgs == 0,
3125 "gc.statepoint w/inline transition bundle is deprecated", Call);
3126 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
3127
3128 const Value *NumDeoptArgsV = Call.getArgOperand(EndTransitionArgsInx + 1);
3129 Check(isa<ConstantInt>(NumDeoptArgsV),
3130 "gc.statepoint number of deoptimization arguments "
3131 "must be constant integer",
3132 Call);
3133 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
3134 Check(NumDeoptArgs == 0,
3135 "gc.statepoint w/inline deopt operands is deprecated", Call);
3136
3137 const int ExpectedNumArgs = 7 + NumCallArgs;
3138 Check(ExpectedNumArgs == (int)Call.arg_size(),
3139 "gc.statepoint too many arguments", Call);
3140
3141 // Check that the only uses of this gc.statepoint are gc.result or
3142 // gc.relocate calls which are tied to this statepoint and thus part
3143 // of the same statepoint sequence
3144 for (const User *U : Call.users()) {
3145 const auto *UserCall = dyn_cast<const CallInst>(U);
3146 Check(UserCall, "illegal use of statepoint token", Call, U);
3147 if (!UserCall)
3148 continue;
3149 Check(isa<GCRelocateInst>(UserCall) || isa<GCResultInst>(UserCall),
3150 "gc.result or gc.relocate are the only value uses "
3151 "of a gc.statepoint",
3152 Call, U);
3153 if (isa<GCResultInst>(UserCall)) {
3154 Check(UserCall->getArgOperand(0) == &Call,
3155 "gc.result connected to wrong gc.statepoint", Call, UserCall);
3156 } else if (isa<GCRelocateInst>(Call)) {
3157 Check(UserCall->getArgOperand(0) == &Call,
3158 "gc.relocate connected to wrong gc.statepoint", Call, UserCall);
3159 }
3160 }
3161
3162 // Note: It is legal for a single derived pointer to be listed multiple
3163 // times. It's non-optimal, but it is legal. It can also happen after
3164 // insertion if we strip a bitcast away.
3165 // Note: It is really tempting to check that each base is relocated and
3166 // that a derived pointer is never reused as a base pointer. This turns
3167 // out to be problematic since optimizations run after safepoint insertion
3168 // can recognize equality properties that the insertion logic doesn't know
3169 // about. See example statepoint.ll in the verifier subdirectory
3170}
3171
3172void Verifier::verifyFrameRecoverIndices() {
3173 for (auto &Counts : FrameEscapeInfo) {
3174 Function *F = Counts.first;
3175 unsigned EscapedObjectCount = Counts.second.first;
3176 unsigned MaxRecoveredIndex = Counts.second.second;
3177 Check(MaxRecoveredIndex <= EscapedObjectCount,
3178 "all indices passed to llvm.localrecover must be less than the "
3179 "number of arguments passed to llvm.localescape in the parent "
3180 "function",
3181 F);
3182 }
3183}
3184
3185static Instruction *getSuccPad(Instruction *Terminator) {
3186 BasicBlock *UnwindDest;
3187 if (auto *II = dyn_cast<InvokeInst>(Terminator))
3188 UnwindDest = II->getUnwindDest();
3189 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
3190 UnwindDest = CSI->getUnwindDest();
3191 else
3192 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
3193 return &*UnwindDest->getFirstNonPHIIt();
3194}
3195
3196void Verifier::verifySiblingFuncletUnwinds() {
3197 llvm::TimeTraceScope timeScope("Verifier verify sibling funclet unwinds");
3198 SmallPtrSet<Instruction *, 8> Visited;
3199 SmallPtrSet<Instruction *, 8> Active;
3200 for (const auto &Pair : SiblingFuncletInfo) {
3201 Instruction *PredPad = Pair.first;
3202 if (Visited.count(PredPad))
3203 continue;
3204 Active.insert(PredPad);
3205 Instruction *Terminator = Pair.second;
3206 do {
3207 Instruction *SuccPad = getSuccPad(Terminator);
3208 if (Active.count(SuccPad)) {
3209 // Found a cycle; report error
3210 Instruction *CyclePad = SuccPad;
3211 SmallVector<Instruction *, 8> CycleNodes;
3212 do {
3213 CycleNodes.push_back(CyclePad);
3214 Instruction *CycleTerminator = SiblingFuncletInfo[CyclePad];
3215 if (CycleTerminator != CyclePad)
3216 CycleNodes.push_back(CycleTerminator);
3217 CyclePad = getSuccPad(CycleTerminator);
3218 } while (CyclePad != SuccPad);
3219 Check(false, "EH pads can't handle each other's exceptions",
3220 ArrayRef<Instruction *>(CycleNodes));
3221 }
3222 // Don't re-walk a node we've already checked
3223 if (!Visited.insert(SuccPad).second)
3224 break;
3225 // Walk to this successor if it has a map entry.
3226 PredPad = SuccPad;
3227 auto TermI = SiblingFuncletInfo.find(PredPad);
3228 if (TermI == SiblingFuncletInfo.end())
3229 break;
3230 Terminator = TermI->second;
3231 Active.insert(PredPad);
3232 } while (true);
3233 // Each node only has one successor, so we've walked all the active
3234 // nodes' successors.
3235 Active.clear();
3236 }
3237}
3238
3239// visitFunction - Verify that a function is ok.
3240//
3241void Verifier::visitFunction(const Function &F) {
3242 visitGlobalValue(F);
3243
3244 // Check function arguments.
3245 FunctionType *FT = F.getFunctionType();
3246 unsigned NumArgs = F.arg_size();
3247
3248 Check(&Context == &F.getContext(),
3249 "Function context does not match Module context!", &F);
3250
3251 Check(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
3252 Check(FT->getNumParams() == NumArgs,
3253 "# formal arguments must match # of arguments for function type!", &F,
3254 FT);
3255 Check(F.getReturnType()->isFirstClassType() ||
3256 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
3257 "Functions cannot return aggregate values!", &F);
3258
3259 Check(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
3260 "Invalid struct return type!", &F);
3261
3262 if (MaybeAlign A = F.getAlign()) {
3263 Check(A->value() <= Value::MaximumAlignment,
3264 "huge alignment values are unsupported", &F);
3265 }
3266
3267 AttributeList Attrs = F.getAttributes();
3268
3269 Check(verifyAttributeCount(Attrs, FT->getNumParams()),
3270 "Attribute after last parameter!", &F);
3271
3272 bool IsIntrinsic = F.isIntrinsic();
3273
3274 // Check function attributes.
3275 verifyFunctionAttrs(FT, Attrs, &F, IsIntrinsic, /* IsInlineAsm */ false);
3276
3277 // On function declarations/definitions, we do not support the builtin
3278 // attribute. We do not check this in VerifyFunctionAttrs since that is
3279 // checking for Attributes that can/can not ever be on functions.
3280 Check(!Attrs.hasFnAttr(Attribute::Builtin),
3281 "Attribute 'builtin' can only be applied to a callsite.", &F);
3282
3283 Check(!Attrs.hasAttrSomewhere(Attribute::ElementType),
3284 "Attribute 'elementtype' can only be applied to a callsite.", &F);
3285
3286 if (Attrs.hasFnAttr(Attribute::Naked))
3287 for (const Argument &Arg : F.args())
3288 Check(Arg.use_empty(), "cannot use argument of naked function", &Arg);
3289
3290 // Check that this function meets the restrictions on this calling convention.
3291 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
3292 // restrictions can be lifted.
3293 switch (F.getCallingConv()) {
3294 default:
3295 case CallingConv::C:
3296 break;
3297 case CallingConv::X86_INTR: {
3298 Check(F.arg_empty() || Attrs.hasParamAttr(0, Attribute::ByVal),
3299 "Calling convention parameter requires byval", &F);
3300 break;
3301 }
3302 case CallingConv::AMDGPU_KERNEL:
3303 case CallingConv::SPIR_KERNEL:
3304 case CallingConv::AMDGPU_CS_Chain:
3305 case CallingConv::AMDGPU_CS_ChainPreserve:
3306 Check(F.getReturnType()->isVoidTy(),
3307 "Calling convention requires void return type", &F);
3308 [[fallthrough]];
3309 case CallingConv::AMDGPU_VS:
3310 case CallingConv::AMDGPU_HS:
3311 case CallingConv::AMDGPU_GS:
3312 case CallingConv::AMDGPU_PS:
3313 case CallingConv::AMDGPU_CS:
3314 Check(!F.hasStructRetAttr(), "Calling convention does not allow sret", &F);
3315 if (F.getCallingConv() != CallingConv::SPIR_KERNEL) {
3316 const unsigned StackAS = DL.getAllocaAddrSpace();
3317 unsigned i = 0;
3318 for (const Argument &Arg : F.args()) {
3319 Check(!Attrs.hasParamAttr(i, Attribute::ByVal),
3320 "Calling convention disallows byval", &F);
3321 Check(!Attrs.hasParamAttr(i, Attribute::Preallocated),
3322 "Calling convention disallows preallocated", &F);
3323 Check(!Attrs.hasParamAttr(i, Attribute::InAlloca),
3324 "Calling convention disallows inalloca", &F);
3325
3326 if (Attrs.hasParamAttr(i, Attribute::ByRef)) {
3327 // FIXME: Should also disallow LDS and GDS, but we don't have the enum
3328 // value here.
3329 Check(Arg.getType()->getPointerAddressSpace() != StackAS,
3330 "Calling convention disallows stack byref", &F);
3331 }
3332
3333 ++i;
3334 }
3335 }
3336
3337 [[fallthrough]];
3338 case CallingConv::Fast:
3339 case CallingConv::Cold:
3340 case CallingConv::Intel_OCL_BI:
3341 case CallingConv::PTX_Kernel:
3342 case CallingConv::PTX_Device:
3343 Check(!F.isVarArg(),
3344 "Calling convention does not support varargs or "
3345 "perfect forwarding!",
3346 &F);
3347 break;
3348 case CallingConv::AMDGPU_Gfx_WholeWave:
3349 Check(!F.arg_empty() && F.arg_begin()->getType()->isIntegerTy(1),
3350 "Calling convention requires first argument to be i1", &F);
3351 Check(!F.arg_begin()->hasInRegAttr(),
3352 "Calling convention requires first argument to not be inreg", &F);
3353 Check(!F.isVarArg(),
3354 "Calling convention does not support varargs or "
3355 "perfect forwarding!",
3356 &F);
3357 break;
3358 }
3359
3360 // Check that the argument values match the function type for this function...
3361 unsigned i = 0;
3362 for (const Argument &Arg : F.args()) {
3363 Check(Arg.getType() == FT->getParamType(i),
3364 "Argument value does not match function argument type!", &Arg,
3365 FT->getParamType(i));
3366 Check(Arg.getType()->isFirstClassType(),
3367 "Function arguments must have first-class types!", &Arg);
3368 if (!IsIntrinsic) {
3369 Check(!Arg.getType()->isMetadataTy(),
3370 "Function takes metadata but isn't an intrinsic", &Arg, &F);
3371 Check(!Arg.getType()->isTokenLikeTy(),
3372 "Function takes token but isn't an intrinsic", &Arg, &F);
3373 Check(!Arg.getType()->isX86_AMXTy(),
3374 "Function takes x86_amx but isn't an intrinsic", &Arg, &F);
3375 }
3376
3377 // Check that swifterror argument is only used by loads and stores.
3378 if (Attrs.hasParamAttr(i, Attribute::SwiftError)) {
3379 verifySwiftErrorValue(&Arg);
3380 }
3381 ++i;
3382 }
3383
3384 if (!IsIntrinsic) {
3385 Check(!F.getReturnType()->isTokenLikeTy(),
3386 "Function returns a token but isn't an intrinsic", &F);
3387 Check(!F.getReturnType()->isX86_AMXTy(),
3388 "Function returns a x86_amx but isn't an intrinsic", &F);
3389 }
3390
3391 // Get the function metadata attachments.
3393 F.getAllMetadata(MDs);
3394 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
3395 verifyFunctionMetadata(MDs);
3396
3397 // Target-specific function metadata checks.
3399
3400 // Check validity of the personality function
3401 if (F.hasPersonalityFn()) {
3402 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
3403 if (Per)
3404 Check(Per->getParent() == F.getParent(),
3405 "Referencing personality function in another module!", &F,
3406 F.getParent(), Per, Per->getParent());
3407 }
3408
3409 // EH funclet coloring can be expensive, recompute on-demand
3410 BlockEHFuncletColors.clear();
3411
3412 if (F.isMaterializable()) {
3413 // Function has a body somewhere we can't see.
3414 Check(MDs.empty(), "unmaterialized function cannot have metadata", &F,
3415 MDs.empty() ? nullptr : MDs.front().second);
3416 } else if (F.isDeclaration()) {
3417 for (const auto &I : MDs) {
3418 // This is used for call site debug information.
3419 CheckDI(I.first != LLVMContext::MD_dbg ||
3420 !cast<DISubprogram>(I.second)->isDistinct(),
3421 "function declaration may only have a unique !dbg attachment",
3422 &F);
3423 Check(I.first != LLVMContext::MD_prof,
3424 "function declaration may not have a !prof attachment", &F);
3425
3426 // Verify the metadata itself.
3427 visitMDNode(*I.second, AreDebugLocsAllowed::Yes);
3428 }
3429 Check(!F.hasPersonalityFn(),
3430 "Function declaration shouldn't have a personality routine", &F);
3431 } else {
3432 // Verify that this function (which has a body) is not named "llvm.*". It
3433 // is not legal to define intrinsics.
3434 Check(!IsIntrinsic, "llvm intrinsics cannot be defined!", &F);
3435
3436 // Check the entry node
3437 const BasicBlock *Entry = &F.getEntryBlock();
3438 Check(pred_empty(Entry),
3439 "Entry block to function must not have predecessors!", Entry);
3440
3441 // The address of the entry block cannot be taken, unless it is dead.
3442 if (Entry->hasAddressTaken()) {
3443 Check(!BlockAddress::lookup(Entry)->isConstantUsed(),
3444 "blockaddress may not be used with the entry block!", Entry);
3445 }
3446
3447 unsigned NumDebugAttachments = 0, NumProfAttachments = 0,
3448 NumKCFIAttachments = 0;
3449 // Visit metadata attachments.
3450 for (const auto &I : MDs) {
3451 // Verify that the attachment is legal.
3452 auto AllowLocs = AreDebugLocsAllowed::No;
3453 switch (I.first) {
3454 default:
3455 break;
3456 case LLVMContext::MD_dbg: {
3457 ++NumDebugAttachments;
3458 CheckDI(NumDebugAttachments == 1,
3459 "function must have a single !dbg attachment", &F, I.second);
3460 CheckDI(isa<DISubprogram>(I.second),
3461 "function !dbg attachment must be a subprogram", &F, I.second);
3462 CheckDI(cast<DISubprogram>(I.second)->isDistinct(),
3463 "function definition may only have a distinct !dbg attachment",
3464 &F);
3465
3466 auto *SP = cast<DISubprogram>(I.second);
3467 const Function *&AttachedTo = DISubprogramAttachments[SP];
3468 CheckDI(!AttachedTo || AttachedTo == &F,
3469 "DISubprogram attached to more than one function", SP, &F);
3470 AttachedTo = &F;
3471 AllowLocs = AreDebugLocsAllowed::Yes;
3472 break;
3473 }
3474 case LLVMContext::MD_prof:
3475 ++NumProfAttachments;
3476 Check(NumProfAttachments == 1,
3477 "function must have a single !prof attachment", &F, I.second);
3478 break;
3479 case LLVMContext::MD_kcfi_type:
3480 ++NumKCFIAttachments;
3481 Check(NumKCFIAttachments == 1,
3482 "function must have a single !kcfi_type attachment", &F,
3483 I.second);
3484 break;
3485 }
3486
3487 // Verify the metadata itself.
3488 visitMDNode(*I.second, AllowLocs);
3489 }
3490 }
3491
3492 // If this function is actually an intrinsic, verify that it is only used in
3493 // direct call/invokes, never having its "address taken".
3494 // Only do this if the module is materialized, otherwise we don't have all the
3495 // uses.
3496 bool isMaterialized = F.getParent()->isMaterialized();
3497 if (F.isIntrinsic() && isMaterialized) {
3498 const User *U;
3499 if (F.hasAddressTaken(&U, false, true, false,
3500 /*IgnoreARCAttachedCall=*/true))
3501 Check(false, "Invalid user of intrinsic instruction!", U);
3502 }
3503
3504 // Verify if the intrinsic's signature and name are valid. We do this if
3505 // the intrinsic has at least one materialized use, or if the module is fully
3506 // materialized.
3507 Intrinsic::ID IID = F.getIntrinsicID();
3508 if (IID && (isMaterialized || !F.materialized_use_empty())) {
3509 // Verify that the intrinsic prototype lines up with what the .td files
3510 // describe.
3511 std::string ErrMsg;
3512 raw_string_ostream ErrOS(ErrMsg);
3513 SmallVector<Type *, 4> OverloadTys;
3514 bool IsValid = Intrinsic::isSignatureValid(IID, FT, OverloadTys, ErrOS);
3515 Printable PrintDecl([&F](raw_ostream &OS) { F.print(OS); });
3516 Check(IsValid, ErrMsg, PrintDecl);
3517
3518 // Now that we have the intrinsic ID and the actual argument types (and we
3519 // know they are legal for the intrinsic!) get the intrinsic name through
3520 // the usual means. This allows us to verify the mangling of argument types
3521 // into the name.
3522 const std::string ExpectedName = Intrinsic::getName(
3523 IID, OverloadTys, const_cast<Module *>(F.getParent()), FT);
3524 Check(ExpectedName == F.getName(),
3525 "Intrinsic name not mangled correctly for type arguments! "
3526 "Should be: " +
3527 ExpectedName,
3528 PrintDecl);
3529 }
3530
3531 auto *N = F.getSubprogram();
3532 HasDebugInfo = (N != nullptr);
3533 if (!HasDebugInfo)
3534 return;
3535
3536 // Check that all !dbg attachments lead to back to N.
3537 //
3538 // FIXME: Check this incrementally while visiting !dbg attachments.
3539 // FIXME: Only check when N is the canonical subprogram for F.
3540 SmallPtrSet<const MDNode *, 32> Seen;
3541 auto VisitDebugLoc = [&](const Instruction &I, const MDNode *Node) {
3542 // Be careful about using DILocation here since we might be dealing with
3543 // broken code (this is the Verifier after all).
3544 const DILocation *DL = dyn_cast_or_null<DILocation>(Node);
3545 if (!DL)
3546 return;
3547 if (!Seen.insert(DL).second)
3548 return;
3549
3550 Metadata *Parent = DL->getRawScope();
3551 CheckDI(Parent && isa<DILocalScope>(Parent),
3552 "DILocation's scope must be a DILocalScope", N, &F, &I, DL, Parent);
3553
3554 DILocalScope *Scope = DL->getInlinedAtScope();
3555 Check(Scope, "Failed to find DILocalScope", DL);
3556
3557 if (!Seen.insert(Scope).second)
3558 return;
3559
3560 // Cycles are diagnosed when the DIScope nodes themselves are visited.
3561 if (hasDIScopeCycle(Scope))
3562 return;
3563
3564 DISubprogram *SP = Scope->getSubprogram();
3565
3566 // Scope and SP could be the same MDNode and we don't want to skip
3567 // validation in that case
3568 if ((Scope != SP) && !Seen.insert(SP).second)
3569 return;
3570
3571 CheckDI(SP->describes(&F),
3572 "!dbg attachment points at wrong subprogram for function", N, &F,
3573 &I, DL, Scope, SP);
3574 };
3575 for (auto &BB : F)
3576 for (auto &I : BB) {
3577 VisitDebugLoc(I, I.getDebugLoc().getAsMDNode());
3578 // The llvm.loop annotations also contain two DILocations.
3579 if (auto MD = I.getMetadata(LLVMContext::MD_loop))
3580 for (unsigned i = 1; i < MD->getNumOperands(); ++i)
3581 VisitDebugLoc(I, dyn_cast_or_null<MDNode>(MD->getOperand(i)));
3582 if (BrokenDebugInfo)
3583 return;
3584 }
3585}
3586
3587// verifyBasicBlock - Verify that a basic block is well formed...
3588//
3589void Verifier::visitBasicBlock(BasicBlock &BB) {
3590 InstsInThisBlock.clear();
3591 ConvergenceVerifyHelper.visit(BB);
3592
3593 // Ensure that basic blocks have terminators!
3594 Check(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
3595
3596 // Check constraints that this basic block imposes on all of the PHI nodes in
3597 // it.
3598 if (isa<PHINode>(BB.front())) {
3599 SmallVector<BasicBlock *, 8> Preds(predecessors(&BB));
3601 llvm::sort(Preds);
3602 for (const PHINode &PN : BB.phis()) {
3603 Check(PN.getNumIncomingValues() == Preds.size(),
3604 "PHINode should have one entry for each predecessor of its "
3605 "parent basic block!",
3606 &PN);
3607
3608 // Get and sort all incoming values in the PHI node...
3609 Values.clear();
3610 Values.reserve(PN.getNumIncomingValues());
3611 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
3612 Values.push_back(
3613 std::make_pair(PN.getIncomingBlock(i), PN.getIncomingValue(i)));
3615
3616 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
3617 // Check to make sure that if there is more than one entry for a
3618 // particular basic block in this PHI node, that the incoming values are
3619 // all identical.
3620 //
3621 Check(i == 0 || Values[i].first != Values[i - 1].first ||
3622 Values[i].second == Values[i - 1].second,
3623 "PHI node has multiple entries for the same basic block with "
3624 "different incoming values!",
3625 &PN, Values[i].first, Values[i].second, Values[i - 1].second);
3626
3627 // Check to make sure that the predecessors and PHI node entries are
3628 // matched up.
3629 Check(Values[i].first == Preds[i],
3630 "PHI node entries do not match predecessors!", &PN,
3631 Values[i].first, Preds[i]);
3632 }
3633 }
3634 }
3635
3636 // Check that all instructions have their parent pointers set up correctly.
3637 for (auto &I : BB)
3638 {
3639 Check(I.getParent() == &BB, "Instruction has bogus parent pointer!");
3640 }
3641
3642 // Confirm that no issues arise from the debug program.
3643 CheckDI(!BB.getTrailingDbgRecords(), "Basic Block has trailing DbgRecords!",
3644 &BB);
3645}
3646
3647void Verifier::visitTerminator(Instruction &I) {
3648 // Ensure that terminators only exist at the end of the basic block.
3649 Check(&I == I.getParent()->getTerminator(),
3650 "Terminator found in the middle of a basic block!", I.getParent());
3651 visitInstruction(I);
3652}
3653
3654void Verifier::visitCondBrInst(CondBrInst &BI) {
3656 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
3657 visitTerminator(BI);
3658}
3659
3660void Verifier::visitReturnInst(ReturnInst &RI) {
3661 Function *F = RI.getParent()->getParent();
3662 unsigned N = RI.getNumOperands();
3663 if (F->getReturnType()->isVoidTy())
3664 Check(N == 0,
3665 "Found return instr that returns non-void in Function of void "
3666 "return type!",
3667 &RI, F->getReturnType());
3668 else
3669 Check(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
3670 "Function return type does not match operand "
3671 "type of return inst!",
3672 &RI, F->getReturnType());
3673
3674 // Check to make sure that the return value has necessary properties for
3675 // terminators...
3676 visitTerminator(RI);
3677}
3678
3679void Verifier::visitSwitchInst(SwitchInst &SI) {
3680 Check(SI.getType()->isVoidTy(), "Switch must have void result type!", &SI);
3681 // Check to make sure that all of the constants in the switch instruction
3682 // have the same type as the switched-on value.
3683 Type *SwitchTy = SI.getCondition()->getType();
3684 SmallPtrSet<ConstantInt*, 32> Constants;
3685 for (auto &Case : SI.cases()) {
3686 Check(isa<ConstantInt>(Case.getCaseValue()),
3687 "Case value is not a constant integer.", &SI);
3688 Check(Case.getCaseValue()->getType() == SwitchTy,
3689 "Switch constants must all be same type as switch value!", &SI);
3690 Check(Constants.insert(Case.getCaseValue()).second,
3691 "Duplicate integer as switch case", &SI, Case.getCaseValue());
3692 }
3693
3694 visitTerminator(SI);
3695}
3696
3697void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
3699 "Indirectbr operand must have pointer type!", &BI);
3700 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
3702 "Indirectbr destinations must all have pointer type!", &BI);
3703
3704 visitTerminator(BI);
3705}
3706
3708 // Currently we only support callbr for amdgcn.kill. Add more checks here as
3709 // needed.
3710 return isAMDGPUCallBrIntrinsic(ID);
3711}
3712
3713void Verifier::visitCallBrInst(CallBrInst &CBI) {
3714 if (!CBI.isInlineAsm()) {
3716 "callbr: indirect function / invalid signature");
3717 Check(!CBI.hasOperandBundles(),
3718 "callbr for intrinsics currently doesn't support operand bundles");
3719
3721 CheckFailed(
3722 "callbr currently only supports asm-goto and selected intrinsics");
3723 }
3724 visitIntrinsicCall(CBI.getIntrinsicID(), CBI);
3725 } else {
3726 const InlineAsm *IA = cast<InlineAsm>(CBI.getCalledOperand());
3727 Check(!IA->canThrow(), "Unwinding from Callbr is not allowed");
3728
3729 verifyInlineAsmCall(CBI);
3730 }
3731 visitTerminator(CBI);
3732}
3733
3734void Verifier::visitSelectInst(SelectInst &SI) {
3735 Check(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
3736 SI.getOperand(2)),
3737 "Invalid operands for select instruction!", &SI);
3738
3739 Check(SI.getTrueValue()->getType() == SI.getType(),
3740 "Select values must have same type as select instruction!", &SI);
3741 visitInstruction(SI);
3742}
3743
3744/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
3745/// a pass, if any exist, it's an error.
3746///
3747void Verifier::visitUserOp1(Instruction &I) {
3748 Check(false, "User-defined operators should not live outside of a pass!", &I);
3749}
3750
3751void Verifier::visitTruncInst(TruncInst &I) {
3752 // Get the source and destination types
3753 Type *SrcTy = I.getOperand(0)->getType();
3754 Type *DestTy = I.getType();
3755
3756 // Get the size of the types in bits, we'll need this later
3757 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3758 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3759
3760 Check(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
3761 Check(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
3762 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3763 "trunc source and destination must both be a vector or neither", &I);
3764 Check(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
3765
3766 visitInstruction(I);
3767}
3768
3769void Verifier::visitZExtInst(ZExtInst &I) {
3770 // Get the source and destination types
3771 Type *SrcTy = I.getOperand(0)->getType();
3772 Type *DestTy = I.getType();
3773
3774 // Get the size of the types in bits, we'll need this later
3775 Check(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
3776 Check(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
3777 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3778 "zext source and destination must both be a vector or neither", &I);
3779 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3780 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3781
3782 Check(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
3783
3784 visitInstruction(I);
3785}
3786
3787void Verifier::visitSExtInst(SExtInst &I) {
3788 // Get the source and destination types
3789 Type *SrcTy = I.getOperand(0)->getType();
3790 Type *DestTy = I.getType();
3791
3792 // Get the size of the types in bits, we'll need this later
3793 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3794 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3795
3796 Check(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
3797 Check(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
3798 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3799 "sext source and destination must both be a vector or neither", &I);
3800 Check(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
3801
3802 visitInstruction(I);
3803}
3804
3805void Verifier::visitFPTruncInst(FPTruncInst &I) {
3806 // Get the source and destination types
3807 Type *SrcTy = I.getOperand(0)->getType();
3808 Type *DestTy = I.getType();
3809 // Get the size of the types in bits, we'll need this later
3810 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3811 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3812
3813 Check(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
3814 Check(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
3815 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3816 "fptrunc source and destination must both be a vector or neither", &I);
3817 Check(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
3818
3819 visitInstruction(I);
3820}
3821
3822void Verifier::visitFPExtInst(FPExtInst &I) {
3823 // Get the source and destination types
3824 Type *SrcTy = I.getOperand(0)->getType();
3825 Type *DestTy = I.getType();
3826
3827 // Get the size of the types in bits, we'll need this later
3828 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
3829 unsigned DestBitSize = DestTy->getScalarSizeInBits();
3830
3831 Check(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
3832 Check(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
3833 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(),
3834 "fpext source and destination must both be a vector or neither", &I);
3835 Check(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
3836
3837 visitInstruction(I);
3838}
3839
3840void Verifier::visitUIToFPInst(UIToFPInst &I) {
3841 // Get the source and destination types
3842 Type *SrcTy = I.getOperand(0)->getType();
3843 Type *DestTy = I.getType();
3844
3845 bool SrcVec = SrcTy->isVectorTy();
3846 bool DstVec = DestTy->isVectorTy();
3847
3848 Check(SrcVec == DstVec,
3849 "UIToFP source and dest must both be vector or scalar", &I);
3850 Check(SrcTy->isIntOrIntVectorTy(),
3851 "UIToFP source must be integer or integer vector", &I);
3852 Check(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
3853 &I);
3854
3855 if (SrcVec && DstVec)
3856 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3857 cast<VectorType>(DestTy)->getElementCount(),
3858 "UIToFP source and dest vector length mismatch", &I);
3859
3860 visitInstruction(I);
3861}
3862
3863void Verifier::visitSIToFPInst(SIToFPInst &I) {
3864 // Get the source and destination types
3865 Type *SrcTy = I.getOperand(0)->getType();
3866 Type *DestTy = I.getType();
3867
3868 bool SrcVec = SrcTy->isVectorTy();
3869 bool DstVec = DestTy->isVectorTy();
3870
3871 Check(SrcVec == DstVec,
3872 "SIToFP source and dest must both be vector or scalar", &I);
3873 Check(SrcTy->isIntOrIntVectorTy(),
3874 "SIToFP source must be integer or integer vector", &I);
3875 Check(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
3876 &I);
3877
3878 if (SrcVec && DstVec)
3879 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3880 cast<VectorType>(DestTy)->getElementCount(),
3881 "SIToFP source and dest vector length mismatch", &I);
3882
3883 visitInstruction(I);
3884}
3885
3886void Verifier::visitFPToUIInst(FPToUIInst &I) {
3887 // Get the source and destination types
3888 Type *SrcTy = I.getOperand(0)->getType();
3889 Type *DestTy = I.getType();
3890
3891 bool SrcVec = SrcTy->isVectorTy();
3892 bool DstVec = DestTy->isVectorTy();
3893
3894 Check(SrcVec == DstVec,
3895 "FPToUI source and dest must both be vector or scalar", &I);
3896 Check(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector", &I);
3897 Check(DestTy->isIntOrIntVectorTy(),
3898 "FPToUI result must be integer or integer vector", &I);
3899
3900 if (SrcVec && DstVec)
3901 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3902 cast<VectorType>(DestTy)->getElementCount(),
3903 "FPToUI source and dest vector length mismatch", &I);
3904
3905 visitInstruction(I);
3906}
3907
3908void Verifier::visitFPToSIInst(FPToSIInst &I) {
3909 // Get the source and destination types
3910 Type *SrcTy = I.getOperand(0)->getType();
3911 Type *DestTy = I.getType();
3912
3913 bool SrcVec = SrcTy->isVectorTy();
3914 bool DstVec = DestTy->isVectorTy();
3915
3916 Check(SrcVec == DstVec,
3917 "FPToSI source and dest must both be vector or scalar", &I);
3918 Check(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector", &I);
3919 Check(DestTy->isIntOrIntVectorTy(),
3920 "FPToSI result must be integer or integer vector", &I);
3921
3922 if (SrcVec && DstVec)
3923 Check(cast<VectorType>(SrcTy)->getElementCount() ==
3924 cast<VectorType>(DestTy)->getElementCount(),
3925 "FPToSI source and dest vector length mismatch", &I);
3926
3927 visitInstruction(I);
3928}
3929
3930void Verifier::checkPtrToAddr(Type *SrcTy, Type *DestTy, const Value &V) {
3931 Check(SrcTy->isPtrOrPtrVectorTy(), "PtrToAddr source must be pointer", V);
3932 Check(DestTy->isIntOrIntVectorTy(), "PtrToAddr result must be integral", V);
3933 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToAddr type mismatch",
3934 V);
3935
3936 if (SrcTy->isVectorTy()) {
3937 auto *VSrc = cast<VectorType>(SrcTy);
3938 auto *VDest = cast<VectorType>(DestTy);
3939 Check(VSrc->getElementCount() == VDest->getElementCount(),
3940 "PtrToAddr vector length mismatch", V);
3941 }
3942
3943 Type *AddrTy = DL.getAddressType(SrcTy);
3944 Check(AddrTy == DestTy, "PtrToAddr result must be address width", V);
3945}
3946
3947void Verifier::visitPtrToAddrInst(PtrToAddrInst &I) {
3948 checkPtrToAddr(I.getOperand(0)->getType(), I.getType(), I);
3949 visitInstruction(I);
3950}
3951
3952void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
3953 // Get the source and destination types
3954 Type *SrcTy = I.getOperand(0)->getType();
3955 Type *DestTy = I.getType();
3956
3957 Check(SrcTy->isPtrOrPtrVectorTy(), "PtrToInt source must be pointer", &I);
3958
3959 Check(DestTy->isIntOrIntVectorTy(), "PtrToInt result must be integral", &I);
3960 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
3961 &I);
3962
3963 if (SrcTy->isVectorTy()) {
3964 auto *VSrc = cast<VectorType>(SrcTy);
3965 auto *VDest = cast<VectorType>(DestTy);
3966 Check(VSrc->getElementCount() == VDest->getElementCount(),
3967 "PtrToInt Vector length mismatch", &I);
3968 }
3969
3970 visitInstruction(I);
3971}
3972
3973void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
3974 // Get the source and destination types
3975 Type *SrcTy = I.getOperand(0)->getType();
3976 Type *DestTy = I.getType();
3977
3978 Check(SrcTy->isIntOrIntVectorTy(), "IntToPtr source must be an integral", &I);
3979 Check(DestTy->isPtrOrPtrVectorTy(), "IntToPtr result must be a pointer", &I);
3980
3981 Check(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
3982 &I);
3983 if (SrcTy->isVectorTy()) {
3984 auto *VSrc = cast<VectorType>(SrcTy);
3985 auto *VDest = cast<VectorType>(DestTy);
3986 Check(VSrc->getElementCount() == VDest->getElementCount(),
3987 "IntToPtr Vector length mismatch", &I);
3988 }
3989 visitInstruction(I);
3990}
3991
3992void Verifier::visitBitCastInst(BitCastInst &I) {
3993 Check(
3994 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
3995 "Invalid bitcast", &I);
3996 Check(DL.getTypeSizeInBits(I.getSrcTy()) ==
3997 DL.getTypeSizeInBits(I.getDestTy()),
3998 "Invalid bitcast", &I);
3999 visitInstruction(I);
4000}
4001
4002void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
4003 Type *SrcTy = I.getOperand(0)->getType();
4004 Type *DestTy = I.getType();
4005
4006 Check(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
4007 &I);
4008 Check(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
4009 &I);
4011 "AddrSpaceCast must be between different address spaces", &I);
4012 if (auto *SrcVTy = dyn_cast<VectorType>(SrcTy))
4013 Check(SrcVTy->getElementCount() ==
4014 cast<VectorType>(DestTy)->getElementCount(),
4015 "AddrSpaceCast vector pointer number of elements mismatch", &I);
4016 visitInstruction(I);
4017}
4018
4019/// visitPHINode - Ensure that a PHI node is well formed.
4020///
4021void Verifier::visitPHINode(PHINode &PN) {
4022 // Ensure that the PHI nodes are all grouped together at the top of the block.
4023 // This can be tested by checking whether the instruction before this is
4024 // either nonexistent (because this is begin()) or is a PHI node. If not,
4025 // then there is some other instruction before a PHI.
4026 Check(&PN == &PN.getParent()->front() ||
4028 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
4029
4030 // Check that a PHI doesn't yield a Token.
4031 Check(!PN.getType()->isTokenLikeTy(), "PHI nodes cannot have token type!");
4032
4033 // Check that all of the values of the PHI node have the same type as the
4034 // result.
4035 for (Value *IncValue : PN.incoming_values()) {
4036 Check(PN.getType() == IncValue->getType(),
4037 "PHI node operands are not the same type as the result!", &PN);
4038 }
4039
4040 // All other PHI node constraints are checked in the visitBasicBlock method.
4041
4042 visitInstruction(PN);
4043}
4044
4045void Verifier::visitCallBase(CallBase &Call) {
4047 "Called function must be a pointer!", Call);
4048 FunctionType *FTy = Call.getFunctionType();
4049
4050 // Verify that the correct number of arguments are being passed
4051 if (FTy->isVarArg())
4052 Check(Call.arg_size() >= FTy->getNumParams(),
4053 "Called function requires more parameters than were provided!", Call);
4054 else
4055 Check(Call.arg_size() == FTy->getNumParams(),
4056 "Incorrect number of arguments passed to called function!", Call);
4057
4058 // Verify that all arguments to the call match the function type.
4059 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
4060 Check(Call.getArgOperand(i)->getType() == FTy->getParamType(i),
4061 "Call parameter type does not match function signature!",
4062 Call.getArgOperand(i), FTy->getParamType(i), Call);
4063
4064 AttributeList Attrs = Call.getAttributes();
4065
4066 Check(verifyAttributeCount(Attrs, Call.arg_size()),
4067 "Attribute after last parameter!", Call);
4068
4069 auto *Callee =
4071 bool IsIntrinsic = Callee && Callee->isIntrinsic();
4072 if (IsIntrinsic)
4073 Check(Callee->getFunctionType() == FTy,
4074 "Intrinsic called with incompatible signature", Call);
4075
4076 // Verify if the calling convention of the callee is callable.
4078 "calling convention does not permit calls", Call);
4079
4080 // Disallow passing/returning values with alignment higher than we can
4081 // represent.
4082 // FIXME: Consider making DataLayout cap the alignment, so this isn't
4083 // necessary.
4084 auto VerifyTypeAlign = [&](Type *Ty, const Twine &Message) {
4085 if (!Ty->isSized())
4086 return;
4087 Align ABIAlign = DL.getABITypeAlign(Ty);
4088 Check(ABIAlign.value() <= Value::MaximumAlignment,
4089 "Incorrect alignment of " + Message + " to called function!", Call);
4090 };
4091
4092 if (!IsIntrinsic) {
4093 VerifyTypeAlign(FTy->getReturnType(), "return type");
4094 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
4095 Type *Ty = FTy->getParamType(i);
4096 VerifyTypeAlign(Ty, "argument passed");
4097 }
4098 }
4099
4100 if (Attrs.hasFnAttr(Attribute::Speculatable)) {
4101 // Don't allow speculatable on call sites, unless the underlying function
4102 // declaration is also speculatable.
4103 Check(Callee && Callee->isSpeculatable(),
4104 "speculatable attribute may not apply to call sites", Call);
4105 }
4106
4107 if (Attrs.hasFnAttr(Attribute::Preallocated)) {
4108 Check(Call.getIntrinsicID() == Intrinsic::call_preallocated_arg,
4109 "preallocated as a call site attribute can only be on "
4110 "llvm.call.preallocated.arg");
4111 }
4112
4113 Check(!Attrs.hasFnAttr(Attribute::DenormalFPEnv),
4114 "denormal_fpenv attribute may not apply to call sites", Call);
4115
4116 // Verify call attributes.
4117 verifyFunctionAttrs(FTy, Attrs, &Call, IsIntrinsic, Call.isInlineAsm());
4118
4119 // Conservatively check the inalloca argument.
4120 // We have a bug if we can find that there is an underlying alloca without
4121 // inalloca.
4122 if (Call.hasInAllocaArgument()) {
4123 Value *InAllocaArg = Call.getArgOperand(FTy->getNumParams() - 1);
4124 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
4125 Check(AI->isUsedWithInAlloca(),
4126 "inalloca argument for call has mismatched alloca", AI, Call);
4127 }
4128
4129 // For each argument of the callsite, if it has the swifterror argument,
4130 // make sure the underlying alloca/parameter it comes from has a swifterror as
4131 // well.
4132 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
4133 if (Call.paramHasAttr(i, Attribute::SwiftError)) {
4134 Value *SwiftErrorArg = Call.getArgOperand(i);
4135 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
4136 Check(AI->isSwiftError(),
4137 "swifterror argument for call has mismatched alloca", AI, Call);
4138 continue;
4139 }
4140 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
4141 Check(ArgI, "swifterror argument should come from an alloca or parameter",
4142 SwiftErrorArg, Call);
4143 Check(ArgI->hasSwiftErrorAttr(),
4144 "swifterror argument for call has mismatched parameter", ArgI,
4145 Call);
4146 }
4147
4148 if (Attrs.hasParamAttr(i, Attribute::ImmArg)) {
4149 // Don't allow immarg on call sites, unless the underlying declaration
4150 // also has the matching immarg.
4151 Check(Callee && Callee->hasParamAttribute(i, Attribute::ImmArg),
4152 "immarg may not apply only to call sites", Call.getArgOperand(i),
4153 Call);
4154 }
4155
4156 if (Call.paramHasAttr(i, Attribute::ImmArg)) {
4157 Value *ArgVal = Call.getArgOperand(i);
4158 Check((isa<ConstantInt>(ArgVal) || isa<ConstantFP>(ArgVal)) &&
4159 !isa<VectorType>(ArgVal->getType()),
4160 "immarg operand has non-immediate parameter", ArgVal, Call);
4161
4162 // If the imm-arg is an integer and also has a range attached,
4163 // check if the given value is within the range.
4164 if (Call.paramHasAttr(i, Attribute::Range)) {
4165 if (auto *CI = dyn_cast<ConstantInt>(ArgVal)) {
4166 const ConstantRange &CR =
4167 Call.getParamAttr(i, Attribute::Range).getValueAsConstantRange();
4168 Check(CR.contains(CI->getValue()),
4169 formatv("immarg value {} for arg {} out of range {}",
4170 CI->getValue(), i, CR),
4171 Call);
4172 }
4173 }
4174 if (auto *CI = dyn_cast<ConstantInt>(ArgVal))
4176 CI->getValue()),
4177 formatv("immarg value {} for arg {} out of range set",
4178 CI->getValue(), i),
4179 Call);
4180 }
4181
4182 if (Call.paramHasAttr(i, Attribute::Preallocated)) {
4183 Value *ArgVal = Call.getArgOperand(i);
4184 bool hasOB =
4186 bool isMustTail = Call.isMustTailCall();
4187 Check(hasOB != isMustTail,
4188 "preallocated operand either requires a preallocated bundle or "
4189 "the call to be musttail (but not both)",
4190 ArgVal, Call);
4191 }
4192 }
4193
4194 if (FTy->isVarArg()) {
4195 // FIXME? is 'nest' even legal here?
4196 bool SawNest = false;
4197 bool SawReturned = false;
4198
4199 for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) {
4200 if (Attrs.hasParamAttr(Idx, Attribute::Nest))
4201 SawNest = true;
4202 if (Attrs.hasParamAttr(Idx, Attribute::Returned))
4203 SawReturned = true;
4204 }
4205
4206 // Check attributes on the varargs part.
4207 for (unsigned Idx = FTy->getNumParams(); Idx < Call.arg_size(); ++Idx) {
4208 Type *Ty = Call.getArgOperand(Idx)->getType();
4209 AttributeSet ArgAttrs = Attrs.getParamAttrs(Idx);
4210 verifyParameterAttrs(ArgAttrs, Ty, &Call);
4211
4212 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
4213 Check(!SawNest, "More than one parameter has attribute nest!", Call);
4214 SawNest = true;
4215 }
4216
4217 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
4218 Check(!SawReturned, "More than one parameter has attribute returned!",
4219 Call);
4220 Check(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
4221 "Incompatible argument and return types for 'returned' "
4222 "attribute",
4223 Call);
4224 SawReturned = true;
4225 }
4226
4227 // Statepoint intrinsic is vararg but the wrapped function may be not.
4228 // Allow sret here and check the wrapped function in verifyStatepoint.
4229 if (Call.getIntrinsicID() != Intrinsic::experimental_gc_statepoint)
4230 Check(!ArgAttrs.hasAttribute(Attribute::StructRet),
4231 "Attribute 'sret' cannot be used for vararg call arguments!",
4232 Call);
4233
4234 if (ArgAttrs.hasAttribute(Attribute::InAlloca))
4235 Check(Idx == Call.arg_size() - 1,
4236 "inalloca isn't on the last argument!", Call);
4237 }
4238 }
4239
4240 // Verify that there's no metadata unless it's a direct call to an intrinsic.
4241 if (!IsIntrinsic) {
4242 for (Type *ParamTy : FTy->params()) {
4243 Check(!ParamTy->isMetadataTy(),
4244 "Function has metadata parameter but isn't an intrinsic", Call);
4245 Check(!ParamTy->isTokenLikeTy(),
4246 "Function has token parameter but isn't an intrinsic", Call);
4247 }
4248 }
4249
4250 // Verify that indirect calls don't return tokens.
4251 if (!Call.getCalledFunction()) {
4252 Check(!FTy->getReturnType()->isTokenLikeTy(),
4253 "Return type cannot be token for indirect call!");
4254 Check(!FTy->getReturnType()->isX86_AMXTy(),
4255 "Return type cannot be x86_amx for indirect call!");
4256 }
4257
4259 visitIntrinsicCall(ID, Call);
4260
4261 // Verify that a callsite has at most one "deopt", at most one "funclet", at
4262 // most one "gc-transition", at most one "cfguardtarget", at most one
4263 // "preallocated" operand bundle, and at most one "ptrauth" operand bundle.
4264 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
4265 FoundGCTransitionBundle = false, FoundCFGuardTargetBundle = false,
4266 FoundPreallocatedBundle = false, FoundGCLiveBundle = false,
4267 FoundPtrauthBundle = false, FoundKCFIBundle = false,
4268 FoundAttachedCallBundle = false;
4269 for (unsigned i = 0, e = Call.getNumOperandBundles(); i < e; ++i) {
4270 OperandBundleUse BU = Call.getOperandBundleAt(i);
4271 for (const Value *Input : BU.Inputs)
4272 Check(!Input->getType()->isLabelTy(),
4273 "Operand bundle operands cannot be labels", Call);
4274 uint32_t Tag = BU.getTagID();
4275 if (Tag == LLVMContext::OB_deopt) {
4276 Check(!FoundDeoptBundle, "Multiple deopt operand bundles", Call);
4277 FoundDeoptBundle = true;
4278 } else if (Tag == LLVMContext::OB_gc_transition) {
4279 Check(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
4280 Call);
4281 FoundGCTransitionBundle = true;
4282 } else if (Tag == LLVMContext::OB_funclet) {
4283 Check(!FoundFuncletBundle, "Multiple funclet operand bundles", Call);
4284 FoundFuncletBundle = true;
4285 Check(BU.Inputs.size() == 1,
4286 "Expected exactly one funclet bundle operand", Call);
4287 Check(isa<FuncletPadInst>(BU.Inputs.front()),
4288 "Funclet bundle operands should correspond to a FuncletPadInst",
4289 Call);
4290 } else if (Tag == LLVMContext::OB_cfguardtarget) {
4291 Check(!FoundCFGuardTargetBundle, "Multiple CFGuardTarget operand bundles",
4292 Call);
4293 FoundCFGuardTargetBundle = true;
4294 Check(BU.Inputs.size() == 1,
4295 "Expected exactly one cfguardtarget bundle operand", Call);
4296 } else if (Tag == LLVMContext::OB_ptrauth) {
4297 Check(!FoundPtrauthBundle, "Multiple ptrauth operand bundles", Call);
4298 FoundPtrauthBundle = true;
4299 Check(BU.Inputs.size() == 2,
4300 "Expected exactly two ptrauth bundle operands", Call);
4301 Check(isa<ConstantInt>(BU.Inputs[0]) &&
4302 BU.Inputs[0]->getType()->isIntegerTy(32),
4303 "Ptrauth bundle key operand must be an i32 constant", Call);
4304 Check(BU.Inputs[1]->getType()->isIntegerTy(64),
4305 "Ptrauth bundle discriminator operand must be an i64", Call);
4306 } else if (Tag == LLVMContext::OB_kcfi) {
4307 Check(!FoundKCFIBundle, "Multiple kcfi operand bundles", Call);
4308 FoundKCFIBundle = true;
4309 Check(BU.Inputs.size() == 1, "Expected exactly one kcfi bundle operand",
4310 Call);
4311 Check(isa<ConstantInt>(BU.Inputs[0]) &&
4312 BU.Inputs[0]->getType()->isIntegerTy(32),
4313 "Kcfi bundle operand must be an i32 constant", Call);
4314 } else if (Tag == LLVMContext::OB_preallocated) {
4315 Check(!FoundPreallocatedBundle, "Multiple preallocated operand bundles",
4316 Call);
4317 FoundPreallocatedBundle = true;
4318 Check(BU.Inputs.size() == 1,
4319 "Expected exactly one preallocated bundle operand", Call);
4320 auto Input = dyn_cast<IntrinsicInst>(BU.Inputs.front());
4321 Check(Input &&
4322 Input->getIntrinsicID() == Intrinsic::call_preallocated_setup,
4323 "\"preallocated\" argument must be a token from "
4324 "llvm.call.preallocated.setup",
4325 Call);
4326 } else if (Tag == LLVMContext::OB_gc_live) {
4327 Check(!FoundGCLiveBundle, "Multiple gc-live operand bundles", Call);
4328 FoundGCLiveBundle = true;
4330 Check(!FoundAttachedCallBundle,
4331 "Multiple \"clang.arc.attachedcall\" operand bundles", Call);
4332 FoundAttachedCallBundle = true;
4333 verifyAttachedCallBundle(Call, BU);
4334 }
4335 }
4336
4337 // Verify that callee and callsite agree on whether to use pointer auth.
4338 Check(!(Call.getCalledFunction() && FoundPtrauthBundle),
4339 "Direct call cannot have a ptrauth bundle", Call);
4340
4341 // Verify that each inlinable callsite of a debug-info-bearing function in a
4342 // debug-info-bearing function has a debug location attached to it. Failure to
4343 // do so causes assertion failures when the inliner sets up inline scope info
4344 // (Interposable functions are not inlinable, neither are functions without
4345 // definitions. noipa does not prevent inlining, so it is ignored here.)
4347 !Call.getCalledFunction()->isInterposable(/*CheckNoIPA=*/false) &&
4351 "inlinable function call in a function with "
4352 "debug info must have a !dbg location",
4353 Call);
4354
4355 if (Call.isInlineAsm())
4356 verifyInlineAsmCall(Call);
4357
4358 ConvergenceVerifyHelper.visit(Call);
4359
4360 visitInstruction(Call);
4361}
4362
4363void Verifier::verifyTailCCMustTailAttrs(const AttrBuilder &Attrs,
4364 StringRef Context) {
4365 Check(!Attrs.contains(Attribute::InAlloca),
4366 Twine("inalloca attribute not allowed in ") + Context);
4367 Check(!Attrs.contains(Attribute::InReg),
4368 Twine("inreg attribute not allowed in ") + Context);
4369 Check(!Attrs.contains(Attribute::SwiftError),
4370 Twine("swifterror attribute not allowed in ") + Context);
4371 Check(!Attrs.contains(Attribute::Preallocated),
4372 Twine("preallocated attribute not allowed in ") + Context);
4373 Check(!Attrs.contains(Attribute::ByRef),
4374 Twine("byref attribute not allowed in ") + Context);
4375}
4376
4377static AttrBuilder getParameterABIAttributes(LLVMContext& C, unsigned I, AttributeList Attrs) {
4378 static const Attribute::AttrKind ABIAttrs[] = {
4379 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
4380 Attribute::InReg, Attribute::StackAlignment, Attribute::SwiftSelf,
4381 Attribute::SwiftAsync, Attribute::SwiftError, Attribute::Preallocated,
4382 Attribute::ByRef};
4383 AttrBuilder Copy(C);
4384 for (auto AK : ABIAttrs) {
4385 Attribute Attr = Attrs.getParamAttrs(I).getAttribute(AK);
4386 if (Attr.isValid())
4387 Copy.addAttribute(Attr);
4388 }
4389
4390 // `align` is ABI-affecting only in combination with `byval` or `byref`.
4391 if (Attrs.hasParamAttr(I, Attribute::Alignment) &&
4392 (Attrs.hasParamAttr(I, Attribute::ByVal) ||
4393 Attrs.hasParamAttr(I, Attribute::ByRef)))
4394 Copy.addAlignmentAttr(Attrs.getParamAlignment(I));
4395 return Copy;
4396}
4397
4398void Verifier::verifyMustTailCall(CallInst &CI) {
4399 Check(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
4400
4401 Function *F = CI.getParent()->getParent();
4402 FunctionType *CallerTy = F->getFunctionType();
4403 FunctionType *CalleeTy = CI.getFunctionType();
4404 Check(CallerTy->isVarArg() == CalleeTy->isVarArg(),
4405 "cannot guarantee tail call due to mismatched varargs", &CI);
4406 Check(CallerTy->getReturnType() == CalleeTy->getReturnType(),
4407 "cannot guarantee tail call due to mismatched return types", &CI);
4408
4409 // - The calling conventions of the caller and callee must match.
4410 Check(F->getCallingConv() == CI.getCallingConv(),
4411 "cannot guarantee tail call due to mismatched calling conv", &CI);
4412
4413 // - The call must immediately precede a :ref:`ret <i_ret>` instruction.
4414 // - The ret instruction must return the value produced by the call or void.
4416
4417 // Check the return.
4418 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
4419 Check(Ret, "musttail call must precede a ret", &CI);
4420 Check(!Ret->getReturnValue() || Ret->getReturnValue() == &CI ||
4422 "musttail call result must be returned", Ret);
4423
4424 AttributeList CallerAttrs = F->getAttributes();
4425 AttributeList CalleeAttrs = CI.getAttributes();
4426 if (CI.getCallingConv() == CallingConv::SwiftTail ||
4427 CI.getCallingConv() == CallingConv::Tail) {
4428 StringRef CCName =
4429 CI.getCallingConv() == CallingConv::Tail ? "tailcc" : "swifttailcc";
4430
4431 // - Only sret, byval, swiftself, and swiftasync ABI-impacting attributes
4432 // are allowed in swifttailcc call
4433 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4434 AttrBuilder ABIAttrs = getParameterABIAttributes(F->getContext(), I, CallerAttrs);
4435 SmallString<32> Context{CCName, StringRef(" musttail caller")};
4436 verifyTailCCMustTailAttrs(ABIAttrs, Context);
4437 }
4438 for (unsigned I = 0, E = CalleeTy->getNumParams(); I != E; ++I) {
4439 AttrBuilder ABIAttrs = getParameterABIAttributes(F->getContext(), I, CalleeAttrs);
4440 SmallString<32> Context{CCName, StringRef(" musttail callee")};
4441 verifyTailCCMustTailAttrs(ABIAttrs, Context);
4442 }
4443 // - Varargs functions are not allowed
4444 Check(!CallerTy->isVarArg(), Twine("cannot guarantee ") + CCName +
4445 " tail call for varargs function");
4446 return;
4447 }
4448
4449 // - The caller and callee prototypes must match.
4450 if (!CI.getIntrinsicID()) {
4451 Check(CallerTy->getNumParams() == CalleeTy->getNumParams(),
4452 "cannot guarantee tail call due to mismatched parameter counts", &CI);
4453 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4454 Check(CallerTy->getParamType(I) == CalleeTy->getParamType(I),
4455 "cannot guarantee tail call due to mismatched parameter types",
4456 &CI);
4457 }
4458 }
4459
4460 // - All ABI-impacting function attributes, such as sret, byval, inreg,
4461 // returned, preallocated, and inalloca, must match.
4462 for (unsigned I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
4463 AttrBuilder CallerABIAttrs = getParameterABIAttributes(F->getContext(), I, CallerAttrs);
4464 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(F->getContext(), I, CalleeAttrs);
4465 Check(CallerABIAttrs == CalleeABIAttrs,
4466 "cannot guarantee tail call due to mismatched ABI impacting "
4467 "function attributes",
4468 &CI, CI.getOperand(I));
4469 }
4470}
4471
4472void Verifier::visitCallInst(CallInst &CI) {
4473 visitCallBase(CI);
4474
4475 if (CI.isMustTailCall())
4476 verifyMustTailCall(CI);
4477}
4478
4479void Verifier::visitInvokeInst(InvokeInst &II) {
4480 visitCallBase(II);
4481
4482 // Verify that the first non-PHI instruction of the unwind destination is an
4483 // exception handling instruction.
4484 Check(
4485 II.getUnwindDest()->isEHPad(),
4486 "The unwind destination does not have an exception handling instruction!",
4487 &II);
4488
4489 visitTerminator(II);
4490}
4491
4492/// visitUnaryOperator - Check the argument to the unary operator.
4493///
4494void Verifier::visitUnaryOperator(UnaryOperator &U) {
4495 Check(U.getType() == U.getOperand(0)->getType(),
4496 "Unary operators must have same type for"
4497 "operands and result!",
4498 &U);
4499
4500 switch (U.getOpcode()) {
4501 // Check that floating-point arithmetic operators are only used with
4502 // floating-point operands.
4503 case Instruction::FNeg:
4504 Check(U.getType()->isFPOrFPVectorTy(),
4505 "FNeg operator only works with float types!", &U);
4506 break;
4507 default:
4508 llvm_unreachable("Unknown UnaryOperator opcode!");
4509 }
4510
4511 visitInstruction(U);
4512}
4513
4514/// visitBinaryOperator - Check that both arguments to the binary operator are
4515/// of the same type!
4516///
4517void Verifier::visitBinaryOperator(BinaryOperator &B) {
4518 Check(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
4519 "Both operands to a binary operator are not of the same type!", &B);
4520
4521 switch (B.getOpcode()) {
4522 // Check that integer arithmetic operators are only used with
4523 // integral operands.
4524 case Instruction::Add:
4525 case Instruction::Sub:
4526 case Instruction::Mul:
4527 case Instruction::SDiv:
4528 case Instruction::UDiv:
4529 case Instruction::SRem:
4530 case Instruction::URem:
4531 Check(B.getType()->isIntOrIntVectorTy(),
4532 "Integer arithmetic operators only work with integral types!", &B);
4533 Check(B.getType() == B.getOperand(0)->getType(),
4534 "Integer arithmetic operators must have same type "
4535 "for operands and result!",
4536 &B);
4537 break;
4538 // Check that floating-point arithmetic operators are only used with
4539 // floating-point operands.
4540 case Instruction::FAdd:
4541 case Instruction::FSub:
4542 case Instruction::FMul:
4543 case Instruction::FDiv:
4544 case Instruction::FRem:
4545 Check(B.getType()->isFPOrFPVectorTy(),
4546 "Floating-point arithmetic operators only work with "
4547 "floating-point types!",
4548 &B);
4549 Check(B.getType() == B.getOperand(0)->getType(),
4550 "Floating-point arithmetic operators must have same type "
4551 "for operands and result!",
4552 &B);
4553 break;
4554 // Check that logical operators are only used with integral operands.
4555 case Instruction::And:
4556 case Instruction::Or:
4557 case Instruction::Xor:
4558 Check(B.getType()->isIntOrIntVectorTy(),
4559 "Logical operators only work with integral types!", &B);
4560 Check(B.getType() == B.getOperand(0)->getType(),
4561 "Logical operators must have same type for operands and result!", &B);
4562 break;
4563 case Instruction::Shl:
4564 case Instruction::LShr:
4565 case Instruction::AShr:
4566 Check(B.getType()->isIntOrIntVectorTy(),
4567 "Shifts only work with integral types!", &B);
4568 Check(B.getType() == B.getOperand(0)->getType(),
4569 "Shift return type must be same as operands!", &B);
4570 break;
4571 default:
4572 llvm_unreachable("Unknown BinaryOperator opcode!");
4573 }
4574
4575 visitInstruction(B);
4576}
4577
4578void Verifier::visitICmpInst(ICmpInst &IC) {
4579 // Check that the operands are the same type
4580 Type *Op0Ty = IC.getOperand(0)->getType();
4581 Type *Op1Ty = IC.getOperand(1)->getType();
4582 Check(Op0Ty == Op1Ty,
4583 "Both operands to ICmp instruction are not of the same type!", &IC);
4584 // Check that the operands are the right type
4585 Check(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPtrOrPtrVectorTy(),
4586 "Invalid operand types for ICmp instruction", &IC);
4587 // Check that the predicate is valid.
4588 Check(IC.isIntPredicate(), "Invalid predicate in ICmp instruction!", &IC);
4589
4590 visitInstruction(IC);
4591}
4592
4593void Verifier::visitFCmpInst(FCmpInst &FC) {
4594 // Check that the operands are the same type
4595 Type *Op0Ty = FC.getOperand(0)->getType();
4596 Type *Op1Ty = FC.getOperand(1)->getType();
4597 Check(Op0Ty == Op1Ty,
4598 "Both operands to FCmp instruction are not of the same type!", &FC);
4599 // Check that the operands are the right type
4600 Check(Op0Ty->isFPOrFPVectorTy(), "Invalid operand types for FCmp instruction",
4601 &FC);
4602 // Check that the predicate is valid.
4603 Check(FC.isFPPredicate(), "Invalid predicate in FCmp instruction!", &FC);
4604
4605 visitInstruction(FC);
4606}
4607
4608void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
4610 "Invalid extractelement operands!", &EI);
4611 visitInstruction(EI);
4612}
4613
4614void Verifier::visitInsertElementInst(InsertElementInst &IE) {
4615 Check(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
4616 IE.getOperand(2)),
4617 "Invalid insertelement operands!", &IE);
4618 visitInstruction(IE);
4619}
4620
4621void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
4622 Check(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
4623 SV.getShuffleMask()),
4624 "Invalid shufflevector operands!", &SV);
4625 visitInstruction(SV);
4626}
4627
4628void Verifier::visitBitInsertInst(BitInsertInst &BII) {
4629 if (const char *Reason = BitInsertInst::areInvalidOperands(
4630 BII.getOperand(0), BII.getOperand(1), BII.getOperand(2)))
4631 Check(false, Reason, &BII);
4632 Check(DL.getTypeSizeInBits(BII.getOperand(0)->getType()) >=
4633 DL.getTypeSizeInBits(BII.getOperand(1)->getType()),
4634 "bitinsert val type cannot be wider than base type!", &BII);
4635 visitInstruction(BII);
4636}
4637
4638void Verifier::visitBitExtractInst(BitExtractInst &BEI) {
4639 if (const char *Reason = BitExtractInst::areInvalidOperands(
4640 BEI.getType(), BEI.getOperand(0), BEI.getOperand(1)))
4641 Check(false, Reason, &BEI);
4642 Check(DL.getTypeSizeInBits(BEI.getType()) <=
4643 DL.getTypeSizeInBits(BEI.getOperand(0)->getType()),
4644 "bitextract result type cannot be wider than source type!", &BEI);
4645 visitInstruction(BEI);
4646}
4647
4648void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
4650 GEP.getModule()->getModuleFlag("require-logical-pointer")))
4651 Check(!MD->getZExtValue(),
4652 "Non-logical getelementptr disallowed for this module.");
4653
4654 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
4655
4656 Check(isa<PointerType>(TargetTy),
4657 "GEP base pointer is not a vector or a vector of pointers", &GEP);
4658 Check(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
4659
4660 if (auto *STy = dyn_cast<StructType>(GEP.getSourceElementType())) {
4661 Check(!STy->isScalableTy(),
4662 "getelementptr cannot target structure that contains scalable vector"
4663 "type",
4664 &GEP);
4665 }
4666
4667 SmallVector<Value *, 16> Idxs(GEP.indices());
4668 Check(
4669 all_of(Idxs, [](Value *V) { return V->getType()->isIntOrIntVectorTy(); }),
4670 "GEP indexes must be integers", &GEP);
4671 Type *ElTy =
4672 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
4673 Check(ElTy, "Invalid indices for GEP pointer type!", &GEP);
4674
4675 auto *PtrTy = dyn_cast<PointerType>(GEP.getType()->getScalarType());
4676
4677 Check(PtrTy && GEP.getResultElementType() == ElTy,
4678 "GEP is not of right type for indices!", &GEP, ElTy);
4679
4680 if (auto *GEPVTy = dyn_cast<VectorType>(GEP.getType())) {
4681 // Additional checks for vector GEPs.
4682 ElementCount GEPWidth = GEPVTy->getElementCount();
4683 if (GEP.getPointerOperandType()->isVectorTy())
4684 Check(
4685 GEPWidth ==
4686 cast<VectorType>(GEP.getPointerOperandType())->getElementCount(),
4687 "Vector GEP result width doesn't match operand's", &GEP);
4688 for (Value *Idx : Idxs) {
4689 Type *IndexTy = Idx->getType();
4690 if (auto *IndexVTy = dyn_cast<VectorType>(IndexTy)) {
4691 ElementCount IndexWidth = IndexVTy->getElementCount();
4692 Check(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
4693 }
4694 Check(IndexTy->isIntOrIntVectorTy(),
4695 "All GEP indices should be of integer type");
4696 }
4697 }
4698
4699 // Check that GEP does not index into a vector with non-byte-addressable
4700 // elements.
4702 GTI != GTE; ++GTI) {
4703 if (GTI.isVector()) {
4704 Type *ElemTy = GTI.getIndexedType();
4705 Check(DL.typeSizeEqualsStoreSize(ElemTy),
4706 "GEP into vector with non-byte-addressable element type", &GEP);
4707 }
4708 }
4709
4710 Check(GEP.getAddressSpace() == PtrTy->getAddressSpace(),
4711 "GEP address space doesn't match type", &GEP);
4712
4713 visitInstruction(GEP);
4714}
4715
4716static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
4717 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
4718}
4719
4720/// Verify !range and !absolute_symbol metadata. These have the same
4721/// restrictions, except !absolute_symbol allows the full set.
4722void Verifier::verifyRangeLikeMetadata(const Value &I, const MDNode *Range,
4723 Type *Ty, RangeLikeMetadataKind Kind) {
4724 unsigned NumOperands = Range->getNumOperands();
4725 Check(NumOperands % 2 == 0, "Unfinished range!", Range);
4726 unsigned NumRanges = NumOperands / 2;
4727 Check(NumRanges >= 1, "It should have at least one range!", Range);
4728
4729 ConstantRange LastRange(1, true); // Dummy initial value
4730 for (unsigned i = 0; i < NumRanges; ++i) {
4731 ConstantInt *Low =
4732 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
4733 Check(Low, "The lower limit must be an integer!", Low);
4734 ConstantInt *High =
4735 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
4736 Check(High, "The upper limit must be an integer!", High);
4737
4738 Check(High->getType() == Low->getType(), "Range pair types must match!",
4739 &I);
4740
4741 if (Kind == RangeLikeMetadataKind::NoaliasAddrspace) {
4742 Check(High->getType()->isIntegerTy(32),
4743 "noalias.addrspace type must be i32!", &I);
4744 } else {
4745 Check(High->getType() == Ty->getScalarType(),
4746 "Range types must match instruction type!", &I);
4747 }
4748
4749 APInt HighV = High->getValue();
4750 APInt LowV = Low->getValue();
4751
4752 // ConstantRange asserts if the ranges are the same except for the min/max
4753 // value. Leave the cases it tolerates for the empty range error below.
4754 Check(LowV != HighV || LowV.isMaxValue() || LowV.isMinValue(),
4755 "The upper and lower limits cannot be the same value", &I);
4756
4757 ConstantRange CurRange(LowV, HighV);
4758 Check(!CurRange.isEmptySet() &&
4759 (Kind == RangeLikeMetadataKind::AbsoluteSymbol ||
4760 !CurRange.isFullSet()),
4761 "Range must not be empty!", Range);
4762 if (i != 0) {
4763 Check(CurRange.intersectWith(LastRange).isEmptySet(),
4764 "Intervals are overlapping", Range);
4765 Check(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
4766 Range);
4767 Check(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
4768 Range);
4769 }
4770 LastRange = ConstantRange(LowV, HighV);
4771 }
4772 if (NumRanges > 2) {
4773 APInt FirstLow =
4774 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
4775 APInt FirstHigh =
4776 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
4777 ConstantRange FirstRange(FirstLow, FirstHigh);
4778 Check(FirstRange.intersectWith(LastRange).isEmptySet(),
4779 "Intervals are overlapping", Range);
4780 Check(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
4781 Range);
4782 }
4783}
4784
4785void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
4786 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
4787 "precondition violation");
4788 verifyRangeLikeMetadata(I, Range, Ty, RangeLikeMetadataKind::Range);
4789}
4790
4791void Verifier::visitNoFPClassMetadata(Instruction &I, MDNode *NoFPClass,
4792 Type *Ty) {
4793 Check(AttributeFuncs::isNoFPClassCompatibleType(Ty),
4794 "nofpclass only applies to floating-point typed loads", I);
4795
4796 Check(NoFPClass->getNumOperands() == 1,
4797 "nofpclass must have exactly one entry", NoFPClass);
4798 ConstantInt *MaskVal =
4800 Check(MaskVal && MaskVal->getType()->isIntegerTy(32),
4801 "nofpclass entry must be a constant i32", NoFPClass);
4802 uint32_t Val = MaskVal->getZExtValue();
4803 Check(Val != 0, "'nofpclass' must have at least one test bit set", NoFPClass,
4804 I);
4805
4806 Check((Val & ~static_cast<unsigned>(fcAllFlags)) == 0,
4807 "Invalid value for 'nofpclass' test mask", NoFPClass, I);
4808}
4809
4810void Verifier::visitNoaliasAddrspaceMetadata(Instruction &I, MDNode *Range,
4811 Type *Ty) {
4812 assert(Range && Range == I.getMetadata(LLVMContext::MD_noalias_addrspace) &&
4813 "precondition violation");
4814 verifyRangeLikeMetadata(I, Range, Ty,
4815 RangeLikeMetadataKind::NoaliasAddrspace);
4816}
4817
4818void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
4819 unsigned Size = DL.getTypeSizeInBits(Ty).getFixedValue();
4820 Check(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
4821 Check(!(Size & (Size - 1)),
4822 "atomic memory access' operand must have a power-of-two size", Ty, I);
4823}
4824
4825void Verifier::visitLoadInst(LoadInst &LI) {
4826 auto *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
4827 Check(PTy, "Load operand must be a pointer.", &LI);
4828 Type *ElTy = LI.getType();
4829 if (MaybeAlign A = LI.getAlign()) {
4830 Check(A->value() <= Value::MaximumAlignment,
4831 "huge alignment values are unsupported", &LI);
4832 }
4833 Check(ElTy->isSized(), "loading unsized types is not allowed", &LI);
4834 if (LI.isAtomic()) {
4835 Check(LI.getOrdering() != AtomicOrdering::Release &&
4836 LI.getOrdering() != AtomicOrdering::AcquireRelease,
4837 "Load cannot have Release ordering", &LI);
4838
4839 if (LI.isElementwise()) {
4840 Check(LI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4841 "atomic elementwise load cannot be sequentially consistent.", &LI);
4842 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
4843 Check(VecTy,
4844 "atomic elementwise load operand must have fixed vector type!", &LI,
4845 ElTy);
4846 if (VecTy)
4847 checkAtomicMemAccessSize(VecTy->getElementType(), &LI);
4848 }
4849
4850 Check(ElTy->getScalarType()->isIntOrPtrTy() ||
4851 ElTy->getScalarType()->isByteTy() ||
4853 "atomic load operand must have integer, byte, pointer, floating "
4854 "point, or vector type!",
4855 ElTy, &LI);
4856
4857 checkAtomicMemAccessSize(ElTy, &LI);
4858 } else {
4859 Check(!LI.isElementwise(), "non-atomic load cannot be elementwise", &LI);
4861 "Non-atomic load cannot have SynchronizationScope specified", &LI);
4862 }
4863
4864 visitInstruction(LI);
4865}
4866
4867void Verifier::visitStoreInst(StoreInst &SI) {
4868 auto *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
4869 Check(PTy, "Store operand must be a pointer.", &SI);
4870 Type *ElTy = SI.getOperand(0)->getType();
4871 if (MaybeAlign A = SI.getAlign()) {
4872 Check(A->value() <= Value::MaximumAlignment,
4873 "huge alignment values are unsupported", &SI);
4874 }
4875 Check(ElTy->isSized(), "storing unsized types is not allowed", &SI);
4876 if (SI.isAtomic()) {
4877 Check(SI.getOrdering() != AtomicOrdering::Acquire &&
4878 SI.getOrdering() != AtomicOrdering::AcquireRelease,
4879 "Store cannot have Acquire ordering", &SI);
4880
4881 if (SI.isElementwise()) {
4882 Check(SI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4883 "atomic elementwise store cannot be sequentially consistent.", &SI);
4884
4885 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
4886 Check(VecTy,
4887 "atomic elementwise store operand must have fixed vector type!",
4888 &SI, ElTy);
4889 if (VecTy)
4890 checkAtomicMemAccessSize(VecTy->getElementType(), &SI);
4891 }
4892
4893 Check(ElTy->getScalarType()->isIntOrPtrTy() ||
4894 ElTy->getScalarType()->isByteTy() ||
4896 "atomic store operand must have integer, byte, pointer, floating "
4897 "point, or vector type!",
4898 ElTy, &SI);
4899 checkAtomicMemAccessSize(ElTy, &SI);
4900 } else {
4901 Check(!SI.isElementwise(), "non-atomic store cannot be elementwise", &SI);
4902 Check(SI.getSyncScopeID() == SyncScope::System,
4903 "Non-atomic store cannot have SynchronizationScope specified", &SI);
4904 }
4905 visitInstruction(SI);
4906}
4907
4908/// Check that SwiftErrorVal is used as a swifterror argument in CS.
4909void Verifier::verifySwiftErrorCall(CallBase &Call,
4910 const Value *SwiftErrorVal) {
4911 for (const auto &I : llvm::enumerate(Call.args())) {
4912 if (I.value() == SwiftErrorVal) {
4913 Check(Call.paramHasAttr(I.index(), Attribute::SwiftError),
4914 "swifterror value when used in a callsite should be marked "
4915 "with swifterror attribute",
4916 SwiftErrorVal, Call);
4917 }
4918 }
4919}
4920
4921void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
4922 // Check that swifterror value is only used by loads, stores, or as
4923 // a swifterror argument.
4924 for (const User *U : SwiftErrorVal->users()) {
4926 isa<InvokeInst>(U),
4927 "swifterror value can only be loaded and stored from, or "
4928 "as a swifterror argument!",
4929 SwiftErrorVal, U);
4930 // If it is used by a store, check it is the second operand.
4931 if (auto StoreI = dyn_cast<StoreInst>(U))
4932 Check(StoreI->getOperand(1) == SwiftErrorVal,
4933 "swifterror value should be the second operand when used "
4934 "by stores",
4935 SwiftErrorVal, U);
4936 if (auto *Call = dyn_cast<CallBase>(U))
4937 verifySwiftErrorCall(*const_cast<CallBase *>(Call), SwiftErrorVal);
4938 }
4939}
4940
4941void Verifier::visitAllocaInst(AllocaInst &AI) {
4943 AI.getModule()->getModuleFlag("require-logical-pointer")))
4944 Check(!MD->getZExtValue(),
4945 "Non-logical alloca disallowed for this module.");
4946
4947 Type *Ty = AI.getAllocatedType();
4948 Check(Ty->isSized(), "Cannot allocate unsized type", &AI);
4949 // Check if it's a target extension type that disallows being used on the
4950 // stack.
4952 "Alloca has illegal target extension type", &AI);
4954 "Alloca array size must have integer type", &AI);
4955 if (MaybeAlign A = AI.getAlign()) {
4956 Check(A->value() <= Value::MaximumAlignment,
4957 "huge alignment values are unsupported", &AI);
4958 }
4959
4960 if (AI.isSwiftError()) {
4961 Check(Ty->isPointerTy(), "swifterror alloca must have pointer type", &AI);
4963 "swifterror alloca must not be array allocation", &AI);
4964 verifySwiftErrorValue(&AI);
4965 }
4966
4967 visitInstruction(AI);
4968
4969 // Target-specific alloca checks.
4970 verifyAMDGPUAlloca(*this, AI);
4971}
4972
4973void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
4974 Type *ElTy = CXI.getOperand(1)->getType();
4975 Check(ElTy->isIntOrPtrTy(),
4976 "cmpxchg operand must have integer or pointer type", ElTy, &CXI);
4977 checkAtomicMemAccessSize(ElTy, &CXI);
4978 visitInstruction(CXI);
4979}
4980
4981void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
4982 Check(RMWI.getOrdering() != AtomicOrdering::Unordered,
4983 "atomicrmw instructions cannot be unordered.", &RMWI);
4984 auto Op = RMWI.getOperation();
4985 Type *ElTy = RMWI.getOperand(1)->getType();
4986 Check(!ElTy->isScalableTy(), "atomicrmw operand may not be scalable", &RMWI);
4987 if (RMWI.isElementwise()) {
4988 Check(RMWI.getOrdering() != AtomicOrdering::SequentiallyConsistent,
4989 "atomicrmw elementwise cannot be sequentially consistent.", &RMWI);
4990 auto *VecTy = dyn_cast<FixedVectorType>(ElTy);
4991 Check(VecTy, "atomicrmw elementwise operand must have fixed vector type!",
4992 &RMWI, ElTy);
4993 if (VecTy)
4994 checkAtomicMemAccessSize(VecTy->getElementType(), &RMWI);
4995 }
4996
4997 if (Op == AtomicRMWInst::Xchg) {
4998 Check((ElTy->isIntOrIntVectorTy() || ElTy->isFPOrFPVectorTy() ||
4999 ElTy->isPtrOrPtrVectorTy()),
5000 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5001 " operand must be an integer type, a floating-point type, a "
5002 "pointer type, or a fixed vector of any of these types!",
5003 &RMWI, ElTy);
5004 } else if (AtomicRMWInst::isFPOperation(Op)) {
5005 Check(ElTy->isFPOrFPVectorTy(),
5006 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5007 " operand must have floating-point or fixed vector of "
5008 "floating-point "
5009 "type!",
5010 &RMWI, ElTy);
5011 } else {
5012 Check(ElTy->isIntOrIntVectorTy(),
5013 "atomicrmw " + AtomicRMWInst::getOperationName(Op) +
5014 " operand must have integer or fixed vector of integer type!",
5015 &RMWI, ElTy);
5016 }
5017 checkAtomicMemAccessSize(ElTy, &RMWI);
5019 "Invalid binary operation!", &RMWI);
5020 visitInstruction(RMWI);
5021}
5022
5023void Verifier::visitFenceInst(FenceInst &FI) {
5024 const AtomicOrdering Ordering = FI.getOrdering();
5025 Check(Ordering == AtomicOrdering::Acquire ||
5026 Ordering == AtomicOrdering::Release ||
5027 Ordering == AtomicOrdering::AcquireRelease ||
5028 Ordering == AtomicOrdering::SequentiallyConsistent,
5029 "fence instructions may only have acquire, release, acq_rel, or "
5030 "seq_cst ordering.",
5031 &FI);
5032 visitInstruction(FI);
5033}
5034
5035void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
5037 EVI.getIndices()) == EVI.getType(),
5038 "Invalid ExtractValueInst operands!", &EVI);
5039
5040 visitInstruction(EVI);
5041}
5042
5043void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
5045 IVI.getIndices()) ==
5046 IVI.getOperand(1)->getType(),
5047 "Invalid InsertValueInst operands!", &IVI);
5048
5049 visitInstruction(IVI);
5050}
5051
5052static Value *getParentPad(Value *EHPad) {
5053 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
5054 return FPI->getParentPad();
5055
5056 return cast<CatchSwitchInst>(EHPad)->getParentPad();
5057}
5058
5059void Verifier::visitEHPadPredecessors(Instruction &I) {
5060 assert(I.isEHPad());
5061
5062 BasicBlock *BB = I.getParent();
5063 Function *F = BB->getParent();
5064
5065 Check(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
5066
5067 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
5068 // The landingpad instruction defines its parent as a landing pad block. The
5069 // landing pad block may be branched to only by the unwind edge of an
5070 // invoke.
5071 for (BasicBlock *PredBB : predecessors(BB)) {
5072 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
5073 Check(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
5074 "Block containing LandingPadInst must be jumped to "
5075 "only by the unwind edge of an invoke.",
5076 LPI);
5077 }
5078 return;
5079 }
5080 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
5081 if (!pred_empty(BB))
5082 Check(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
5083 "Block containg CatchPadInst must be jumped to "
5084 "only by its catchswitch.",
5085 CPI);
5086 Check(BB != CPI->getCatchSwitch()->getUnwindDest(),
5087 "Catchswitch cannot unwind to one of its catchpads",
5088 CPI->getCatchSwitch(), CPI);
5089 return;
5090 }
5091
5092 // Verify that each pred has a legal terminator with a legal to/from EH
5093 // pad relationship.
5094 Instruction *ToPad = &I;
5095 Value *ToPadParent = getParentPad(ToPad);
5096 for (BasicBlock *PredBB : predecessors(BB)) {
5097 Instruction *TI = PredBB->getTerminator();
5098 Value *FromPad;
5099 if (auto *II = dyn_cast<InvokeInst>(TI)) {
5100 Check(II->getUnwindDest() == BB && II->getNormalDest() != BB,
5101 "EH pad must be jumped to via an unwind edge", ToPad, II);
5102 auto *CalledFn =
5103 dyn_cast<Function>(II->getCalledOperand()->stripPointerCasts());
5104 if (CalledFn && CalledFn->isIntrinsic() && II->doesNotThrow() &&
5105 !IntrinsicInst::mayLowerToFunctionCall(CalledFn->getIntrinsicID()))
5106 continue;
5107 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
5108 FromPad = Bundle->Inputs[0];
5109 else
5110 FromPad = ConstantTokenNone::get(II->getContext());
5111 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
5112 FromPad = CRI->getOperand(0);
5113 Check(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
5114 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
5115 FromPad = CSI;
5116 } else {
5117 Check(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
5118 }
5119
5120 // The edge may exit from zero or more nested pads.
5121 SmallPtrSet<Value *, 8> Seen;
5122 for (;; FromPad = getParentPad(FromPad)) {
5123 Check(FromPad != ToPad,
5124 "EH pad cannot handle exceptions raised within it", FromPad, TI);
5125 if (FromPad == ToPadParent) {
5126 // This is a legal unwind edge.
5127 break;
5128 }
5129 Check(!isa<ConstantTokenNone>(FromPad),
5130 "A single unwind edge may only enter one EH pad", TI);
5131 Check(Seen.insert(FromPad).second, "EH pad jumps through a cycle of pads",
5132 FromPad);
5133
5134 // This will be diagnosed on the corresponding instruction already. We
5135 // need the extra check here to make sure getParentPad() works.
5136 Check(isa<FuncletPadInst>(FromPad) || isa<CatchSwitchInst>(FromPad),
5137 "Parent pad must be catchpad/cleanuppad/catchswitch", TI);
5138 }
5139 }
5140}
5141
5142void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
5143 // The landingpad instruction is ill-formed if it doesn't have any clauses and
5144 // isn't a cleanup.
5145 Check(LPI.getNumClauses() > 0 || LPI.isCleanup(),
5146 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
5147
5148 visitEHPadPredecessors(LPI);
5149
5150 if (!LandingPadResultTy)
5151 LandingPadResultTy = LPI.getType();
5152 else
5153 Check(LandingPadResultTy == LPI.getType(),
5154 "The landingpad instruction should have a consistent result type "
5155 "inside a function.",
5156 &LPI);
5157
5158 Function *F = LPI.getParent()->getParent();
5159 Check(F->hasPersonalityFn(),
5160 "LandingPadInst needs to be in a function with a personality.", &LPI);
5161
5162 // The landingpad instruction must be the first non-PHI instruction in the
5163 // block.
5164 Check(LPI.getParent()->getLandingPadInst() == &LPI,
5165 "LandingPadInst not the first non-PHI instruction in the block.", &LPI);
5166
5167 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
5168 Constant *Clause = LPI.getClause(i);
5169 if (LPI.isCatch(i)) {
5170 Check(isa<PointerType>(Clause->getType()),
5171 "Catch operand does not have pointer type!", &LPI);
5172 } else {
5173 Check(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
5175 "Filter operand is not an array of constants!", &LPI);
5176 }
5177 }
5178
5179 visitInstruction(LPI);
5180}
5181
5182void Verifier::visitResumeInst(ResumeInst &RI) {
5184 "ResumeInst needs to be in a function with a personality.", &RI);
5185
5186 if (!LandingPadResultTy)
5187 LandingPadResultTy = RI.getValue()->getType();
5188 else
5189 Check(LandingPadResultTy == RI.getValue()->getType(),
5190 "The resume instruction should have a consistent result type "
5191 "inside a function.",
5192 &RI);
5193
5194 visitTerminator(RI);
5195}
5196
5197void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
5198 BasicBlock *BB = CPI.getParent();
5199
5200 Function *F = BB->getParent();
5201 Check(F->hasPersonalityFn(),
5202 "CatchPadInst needs to be in a function with a personality.", &CPI);
5203
5205 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
5206 CPI.getParentPad());
5207
5208 // The catchpad instruction must be the first non-PHI instruction in the
5209 // block.
5210 Check(&*BB->getFirstNonPHIIt() == &CPI,
5211 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
5212
5214 [](Use &U) {
5215 auto *V = U.get();
5216 return isa<Constant>(V) || isa<AllocaInst>(V);
5217 }),
5218 "Argument operand must be alloca or constant.", &CPI);
5219
5220 visitEHPadPredecessors(CPI);
5221 visitFuncletPadInst(CPI);
5222}
5223
5224void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
5225 Check(isa<CatchPadInst>(CatchReturn.getOperand(0)),
5226 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
5227 CatchReturn.getOperand(0));
5228
5229 visitTerminator(CatchReturn);
5230}
5231
5232void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
5233 BasicBlock *BB = CPI.getParent();
5234
5235 Function *F = BB->getParent();
5236 Check(F->hasPersonalityFn(),
5237 "CleanupPadInst needs to be in a function with a personality.", &CPI);
5238
5239 // The cleanuppad instruction must be the first non-PHI instruction in the
5240 // block.
5241 Check(&*BB->getFirstNonPHIIt() == &CPI,
5242 "CleanupPadInst not the first non-PHI instruction in the block.", &CPI);
5243
5244 auto *ParentPad = CPI.getParentPad();
5245 Check(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
5246 "CleanupPadInst has an invalid parent.", &CPI);
5247
5248 visitEHPadPredecessors(CPI);
5249 visitFuncletPadInst(CPI);
5250}
5251
5252void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
5253 User *FirstUser = nullptr;
5254 Value *FirstUnwindPad = nullptr;
5255 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
5256 SmallPtrSet<FuncletPadInst *, 8> Seen;
5257
5258 while (!Worklist.empty()) {
5259 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
5260 Check(Seen.insert(CurrentPad).second,
5261 "FuncletPadInst must not be nested within itself", CurrentPad);
5262 Value *UnresolvedAncestorPad = nullptr;
5263 for (User *U : CurrentPad->users()) {
5264 BasicBlock *UnwindDest;
5265 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
5266 UnwindDest = CRI->getUnwindDest();
5267 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
5268 // We allow catchswitch unwind to caller to nest
5269 // within an outer pad that unwinds somewhere else,
5270 // because catchswitch doesn't have a nounwind variant.
5271 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
5272 if (CSI->unwindsToCaller())
5273 continue;
5274 UnwindDest = CSI->getUnwindDest();
5275 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
5276 UnwindDest = II->getUnwindDest();
5277 } else if (isa<CallInst>(U)) {
5278 // Calls which don't unwind may be found inside funclet
5279 // pads that unwind somewhere else. We don't *require*
5280 // such calls to be annotated nounwind.
5281 continue;
5282 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
5283 // The unwind dest for a cleanup can only be found by
5284 // recursive search. Add it to the worklist, and we'll
5285 // search for its first use that determines where it unwinds.
5286 Worklist.push_back(CPI);
5287 continue;
5288 } else {
5289 Check(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
5290 continue;
5291 }
5292
5293 Value *UnwindPad;
5294 bool ExitsFPI;
5295 if (UnwindDest) {
5296 UnwindPad = &*UnwindDest->getFirstNonPHIIt();
5297 if (!cast<Instruction>(UnwindPad)->isEHPad())
5298 continue;
5299 Value *UnwindParent = getParentPad(UnwindPad);
5300 // Ignore unwind edges that don't exit CurrentPad.
5301 if (UnwindParent == CurrentPad)
5302 continue;
5303 // Determine whether the original funclet pad is exited,
5304 // and if we are scanning nested pads determine how many
5305 // of them are exited so we can stop searching their
5306 // children.
5307 Value *ExitedPad = CurrentPad;
5308 ExitsFPI = false;
5309 do {
5310 if (ExitedPad == &FPI) {
5311 ExitsFPI = true;
5312 // Now we can resolve any ancestors of CurrentPad up to
5313 // FPI, but not including FPI since we need to make sure
5314 // to check all direct users of FPI for consistency.
5315 UnresolvedAncestorPad = &FPI;
5316 break;
5317 }
5318 Value *ExitedParent = getParentPad(ExitedPad);
5319 if (ExitedParent == UnwindParent) {
5320 // ExitedPad is the ancestor-most pad which this unwind
5321 // edge exits, so we can resolve up to it, meaning that
5322 // ExitedParent is the first ancestor still unresolved.
5323 UnresolvedAncestorPad = ExitedParent;
5324 break;
5325 }
5326 ExitedPad = ExitedParent;
5327 } while (!isa<ConstantTokenNone>(ExitedPad));
5328 } else {
5329 // Unwinding to caller exits all pads.
5330 UnwindPad = ConstantTokenNone::get(FPI.getContext());
5331 ExitsFPI = true;
5332 UnresolvedAncestorPad = &FPI;
5333 }
5334
5335 if (ExitsFPI) {
5336 // This unwind edge exits FPI. Make sure it agrees with other
5337 // such edges.
5338 if (FirstUser) {
5339 Check(UnwindPad == FirstUnwindPad,
5340 "Unwind edges out of a funclet "
5341 "pad must have the same unwind "
5342 "dest",
5343 &FPI, U, FirstUser);
5344 } else {
5345 FirstUser = U;
5346 FirstUnwindPad = UnwindPad;
5347 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
5348 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
5349 getParentPad(UnwindPad) == getParentPad(&FPI))
5350 SiblingFuncletInfo[&FPI] = cast<Instruction>(U);
5351 }
5352 }
5353 // Make sure we visit all uses of FPI, but for nested pads stop as
5354 // soon as we know where they unwind to.
5355 if (CurrentPad != &FPI)
5356 break;
5357 }
5358 if (UnresolvedAncestorPad) {
5359 if (CurrentPad == UnresolvedAncestorPad) {
5360 // When CurrentPad is FPI itself, we don't mark it as resolved even if
5361 // we've found an unwind edge that exits it, because we need to verify
5362 // all direct uses of FPI.
5363 assert(CurrentPad == &FPI);
5364 continue;
5365 }
5366 // Pop off the worklist any nested pads that we've found an unwind
5367 // destination for. The pads on the worklist are the uncles,
5368 // great-uncles, etc. of CurrentPad. We've found an unwind destination
5369 // for all ancestors of CurrentPad up to but not including
5370 // UnresolvedAncestorPad.
5371 Value *ResolvedPad = CurrentPad;
5372 while (!Worklist.empty()) {
5373 Value *UnclePad = Worklist.back();
5374 Value *AncestorPad = getParentPad(UnclePad);
5375 // Walk ResolvedPad up the ancestor list until we either find the
5376 // uncle's parent or the last resolved ancestor.
5377 while (ResolvedPad != AncestorPad) {
5378 Value *ResolvedParent = getParentPad(ResolvedPad);
5379 if (ResolvedParent == UnresolvedAncestorPad) {
5380 break;
5381 }
5382 ResolvedPad = ResolvedParent;
5383 }
5384 // If the resolved ancestor search didn't find the uncle's parent,
5385 // then the uncle is not yet resolved.
5386 if (ResolvedPad != AncestorPad)
5387 break;
5388 // This uncle is resolved, so pop it from the worklist.
5389 Worklist.pop_back();
5390 }
5391 }
5392 }
5393
5394 if (FirstUnwindPad) {
5395 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
5396 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
5397 Value *SwitchUnwindPad;
5398 if (SwitchUnwindDest)
5399 SwitchUnwindPad = &*SwitchUnwindDest->getFirstNonPHIIt();
5400 else
5401 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
5402 Check(SwitchUnwindPad == FirstUnwindPad,
5403 "Unwind edges out of a catch must have the same unwind dest as "
5404 "the parent catchswitch",
5405 &FPI, FirstUser, CatchSwitch);
5406 }
5407 }
5408
5409 visitInstruction(FPI);
5410}
5411
5412void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
5413 BasicBlock *BB = CatchSwitch.getParent();
5414
5415 Function *F = BB->getParent();
5416 Check(F->hasPersonalityFn(),
5417 "CatchSwitchInst needs to be in a function with a personality.",
5418 &CatchSwitch);
5419
5420 // The catchswitch instruction must be the first non-PHI instruction in the
5421 // block.
5422 Check(&*BB->getFirstNonPHIIt() == &CatchSwitch,
5423 "CatchSwitchInst not the first non-PHI instruction in the block.",
5424 &CatchSwitch);
5425
5426 auto *ParentPad = CatchSwitch.getParentPad();
5427 Check(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
5428 "CatchSwitchInst has an invalid parent.", ParentPad);
5429
5430 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
5431 BasicBlock::iterator I = UnwindDest->getFirstNonPHIIt();
5432 Check(I->isEHPad() && !isa<LandingPadInst>(I),
5433 "CatchSwitchInst must unwind to an EH block which is not a "
5434 "landingpad.",
5435 &CatchSwitch);
5436
5437 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
5438 if (getParentPad(&*I) == ParentPad)
5439 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
5440 }
5441
5442 Check(CatchSwitch.getNumHandlers() != 0,
5443 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
5444
5445 for (BasicBlock *Handler : CatchSwitch.handlers()) {
5446 Check(isa<CatchPadInst>(Handler->getFirstNonPHIIt()),
5447 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
5448 }
5449
5450 visitEHPadPredecessors(CatchSwitch);
5451 visitTerminator(CatchSwitch);
5452}
5453
5454void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
5456 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
5457 CRI.getOperand(0));
5458
5459 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
5460 BasicBlock::iterator I = UnwindDest->getFirstNonPHIIt();
5461 Check(I->isEHPad() && !isa<LandingPadInst>(I),
5462 "CleanupReturnInst must unwind to an EH block which is not a "
5463 "landingpad.",
5464 &CRI);
5465 }
5466
5467 visitTerminator(CRI);
5468}
5469
5470void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
5471 Instruction *Op = cast<Instruction>(I.getOperand(i));
5472 // If the we have an invalid invoke, don't try to compute the dominance.
5473 // We already reject it in the invoke specific checks and the dominance
5474 // computation doesn't handle multiple edges.
5475 if (auto *II = dyn_cast<InvokeInst>(Op)) {
5476 if (II->getNormalDest() == II->getUnwindDest())
5477 return;
5478 }
5479
5480 // Quick check whether the def has already been encountered in the same block.
5481 // PHI nodes are not checked to prevent accepting preceding PHIs, because PHI
5482 // uses are defined to happen on the incoming edge, not at the instruction.
5483 //
5484 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
5485 // wrapping an SSA value, assert that we've already encountered it. See
5486 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
5487 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
5488 return;
5489
5490 const Use &U = I.getOperandUse(i);
5491 Check(DT.dominates(Op, U), "Instruction does not dominate all uses!", Op, &I);
5492}
5493
5494void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
5495 Check(I.getType()->isPointerTy(),
5496 "dereferenceable, dereferenceable_or_null "
5497 "apply only to pointer types",
5498 &I);
5500 "dereferenceable, dereferenceable_or_null apply only to load"
5501 " and inttoptr instructions, use attributes for calls or invokes",
5502 &I);
5503 Check(MD->getNumOperands() == 1,
5504 "dereferenceable, dereferenceable_or_null "
5505 "take one operand!",
5506 &I);
5507 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
5508 Check(CI && CI->getType()->isIntegerTy(64),
5509 "dereferenceable, "
5510 "dereferenceable_or_null metadata value must be an i64!",
5511 &I);
5512}
5513
5514void Verifier::visitNoFreeObjMetadata(Instruction &I, MDNode *MD) {
5515 Check(I.getType()->isPointerTy(), "nofreeobj applies only to pointer types",
5516 &I);
5518 "nofreeobj applies only to inttoptr instruction", &I);
5519 Check(MD->getNumOperands() == 0, "nofreeobj metadata must be empty", &I);
5520}
5521
5522void Verifier::visitProfMetadata(Instruction &I, MDNode *MD) {
5523 auto GetBranchingTerminatorNumOperands = [&]() {
5524 unsigned ExpectedNumOperands = 0;
5525 if (auto *BI = dyn_cast<CondBrInst>(&I))
5526 ExpectedNumOperands = BI->getNumSuccessors();
5527 else if (auto *SI = dyn_cast<SwitchInst>(&I))
5528 ExpectedNumOperands = SI->getNumSuccessors();
5529 else if (isa<CallInst>(&I))
5530 ExpectedNumOperands = 1;
5531 else if (auto *IBI = dyn_cast<IndirectBrInst>(&I))
5532 ExpectedNumOperands = IBI->getNumDestinations();
5533 else if (isa<SelectInst>(&I))
5534 ExpectedNumOperands = 2;
5535 else if (auto *CI = dyn_cast<CallBrInst>(&I))
5536 ExpectedNumOperands = CI->getNumSuccessors();
5537 return ExpectedNumOperands;
5538 };
5539 Check(MD->getNumOperands() >= 1,
5540 "!prof annotations should have at least 1 operand", MD);
5541 // Check first operand.
5542 Check(MD->getOperand(0) != nullptr, "first operand should not be null", MD);
5544 "expected string with name of the !prof annotation", MD);
5545 MDString *MDS = cast<MDString>(MD->getOperand(0));
5546 StringRef ProfName = MDS->getString();
5547
5549 Check(GetBranchingTerminatorNumOperands() != 0 || isa<InvokeInst>(I),
5550 "'unknown' !prof should only appear on instructions on which "
5551 "'branch_weights' would",
5552 MD);
5553 verifyUnknownProfileMetadata(MD);
5554 return;
5555 }
5556
5557 Check(MD->getNumOperands() >= 2,
5558 "!prof annotations should have no less than 2 operands", MD);
5559
5560 // Check consistency of !prof branch_weights metadata.
5561 if (ProfName == MDProfLabels::BranchWeights) {
5562 unsigned NumBranchWeights = getNumBranchWeights(*MD);
5563 if (isa<InvokeInst>(&I)) {
5564 Check(NumBranchWeights == 1 || NumBranchWeights == 2,
5565 "Wrong number of InvokeInst branch_weights operands", MD);
5566 } else {
5567 const unsigned ExpectedNumOperands = GetBranchingTerminatorNumOperands();
5568 if (ExpectedNumOperands == 0)
5569 CheckFailed("!prof branch_weights are not allowed for this instruction",
5570 MD);
5571
5572 Check(NumBranchWeights == ExpectedNumOperands, "Wrong number of operands",
5573 MD);
5574 }
5575 for (unsigned i = getBranchWeightOffset(MD); i < MD->getNumOperands();
5576 ++i) {
5577 auto &MDO = MD->getOperand(i);
5578 Check(MDO, "second operand should not be null", MD);
5580 "!prof brunch_weights operand is not a const int");
5581 }
5582 } else if (ProfName == MDProfLabels::ValueProfile) {
5583 Check(isValueProfileMD(MD), "invalid value profiling metadata", MD);
5584 ConstantInt *KindInt = mdconst::dyn_extract<ConstantInt>(MD->getOperand(1));
5585 Check(KindInt, "VP !prof missing kind argument", MD);
5586
5587 auto Kind = KindInt->getZExtValue();
5588 Check(Kind >= InstrProfValueKind::IPVK_First &&
5589 Kind <= InstrProfValueKind::IPVK_Last,
5590 "Invalid VP !prof kind", MD);
5591 Check(MD->getNumOperands() % 2 == 1,
5592 "VP !prof should have an even number "
5593 "of arguments after 'VP'",
5594 MD);
5595 if (Kind == InstrProfValueKind::IPVK_IndirectCallTarget ||
5596 Kind == InstrProfValueKind::IPVK_MemOPSize)
5598 "VP !prof indirect call or memop size expected to be applied to "
5599 "CallBase instructions only",
5600 MD);
5601
5602 DenseSet<uint64_t> ProfileValues;
5603 for (unsigned I = 3; I < MD->getNumOperands(); I += 2) {
5604 ConstantInt *ProfileValue =
5606 Check(ProfileValue, "VP !prof value operand is not a const int", MD);
5607 uint64_t ProfileValueInt = ProfileValue->getZExtValue();
5608 auto [ValueIt, Inserted] = ProfileValues.insert(ProfileValueInt);
5609 Check(Inserted, "VP !prof should not have duplicate profile values", MD);
5610 }
5611 } else {
5612 CheckFailed("expected either branch_weights or VP profile name", MD);
5613 }
5614}
5615
5616void Verifier::visitDIAssignIDMetadata(Instruction &I, MDNode *MD) {
5617 assert(I.hasMetadata(LLVMContext::MD_DIAssignID));
5618 // DIAssignID metadata must be attached to either an alloca or some form of
5619 // store/memory-writing instruction.
5620 // FIXME: We allow all intrinsic insts here to avoid trying to enumerate all
5621 // possible store intrinsics.
5622 bool ExpectedInstTy =
5624 CheckDI(ExpectedInstTy, "!DIAssignID attached to unexpected instruction kind",
5625 I, MD);
5626 // Iterate over the MetadataAsValue uses of the DIAssignID - these should
5627 // only be found as DbgAssignIntrinsic operands.
5628 if (auto *AsValue = MetadataAsValue::getIfExists(Context, MD)) {
5629 for (auto *User : AsValue->users()) {
5631 "!DIAssignID should only be used by llvm.dbg.assign intrinsics",
5632 MD, User);
5633 // All of the dbg.assign intrinsics should be in the same function as I.
5634 if (auto *DAI = dyn_cast<DbgAssignIntrinsic>(User))
5635 CheckDI(DAI->getFunction() == I.getFunction(),
5636 "dbg.assign not in same function as inst", DAI, &I);
5637 }
5638 }
5639 for (DbgVariableRecord *DVR : at::getAssignmentMarkers(cast<DIAssignID>(MD)))
5640 CheckDI(DVR->getFunction() == I.getFunction(),
5641 "DVRAssign not in same function as inst", DVR, &I);
5642}
5643
5644void Verifier::visitMMRAMetadata(Instruction &I, MDNode *MD) {
5646 "!mmra metadata attached to unexpected instruction kind", I, MD);
5647
5648 // MMRA Metadata should either be a tag, e.g. !{!"foo", !"bar"}, or a
5649 // list of tags such as !2 in the following example:
5650 // !0 = !{!"a", !"b"}
5651 // !1 = !{!"c", !"d"}
5652 // !2 = !{!0, !1}
5653 if (MMRAMetadata::isTagMD(MD))
5654 return;
5655
5656 Check(isa<MDTuple>(MD), "!mmra expected to be a metadata tuple", I, MD);
5657 for (const MDOperand &MDOp : MD->operands())
5658 Check(MMRAMetadata::isTagMD(MDOp.get()),
5659 "!mmra metadata tuple operand is not an MMRA tag", I, MDOp.get());
5660}
5661
5662void Verifier::visitCallStackMetadata(MDNode *MD) {
5663 // Call stack metadata should consist of a list of at least 1 constant int
5664 // (representing a hash of the location).
5665 Check(MD->getNumOperands() >= 1,
5666 "call stack metadata should have at least 1 operand", MD);
5667
5668 for (const auto &Op : MD->operands())
5670 "call stack metadata operand should be constant integer", Op);
5671}
5672
5673void Verifier::visitMemProfMetadata(Instruction &I, MDNode *MD) {
5674 Check(isa<CallBase>(I), "!memprof metadata should only exist on calls", &I);
5675 if (isa<CallBase>(I))
5676 Check(I.hasMetadata(LLVMContext::MD_callsite),
5677 "!memprof metadata requires !callsite metadata", &I, MD);
5678 Check(MD->getNumOperands() >= 1,
5679 "!memprof annotations should have at least 1 metadata operand "
5680 "(MemInfoBlock)",
5681 MD);
5682
5683 // Check each MIB
5684 for (auto &MIBOp : MD->operands()) {
5685 auto *MIB = dyn_cast<MDNode>(MIBOp);
5686 // The first operand of an MIB should be the call stack metadata.
5687 // There rest of the operands should be MDString tags, and there should be
5688 // at least one.
5689 Check(MIB->getNumOperands() >= 2,
5690 "Each !memprof MemInfoBlock should have at least 2 operands", MIB);
5691
5692 // Check call stack metadata (first operand).
5693 Check(MIB->getOperand(0) != nullptr,
5694 "!memprof MemInfoBlock first operand should not be null", MIB);
5695 Check(isa<MDNode>(MIB->getOperand(0)),
5696 "!memprof MemInfoBlock first operand should be an MDNode", MIB);
5697 auto *StackMD = dyn_cast<MDNode>(MIB->getOperand(0));
5698 visitCallStackMetadata(StackMD);
5699
5700 // The second MIB operand should be MDString.
5701 Check(isa<MDString>(MIB->getOperand(1)),
5702 "!memprof MemInfoBlock second operand should be an MDString", MIB);
5703
5704 // Any remaining should be MDNode that are pairs of integers
5705 for (unsigned I = 2; I < MIB->getNumOperands(); ++I) {
5706 auto *OpNode = dyn_cast<MDNode>(MIB->getOperand(I));
5707 Check(OpNode, "Not all !memprof MemInfoBlock operands 2 to N are MDNode",
5708 MIB);
5709 Check(OpNode->getNumOperands() == 2,
5710 "Not all !memprof MemInfoBlock operands 2 to N are MDNode with 2 "
5711 "operands",
5712 MIB);
5713 // Check that all of Op's operands are ConstantInt.
5714 Check(llvm::all_of(OpNode->operands(),
5715 [](const MDOperand &Op) {
5716 return mdconst::hasa<ConstantInt>(Op);
5717 }),
5718 "Not all !memprof MemInfoBlock operands 2 to N are MDNode with "
5719 "ConstantInt operands",
5720 MIB);
5721 }
5722 }
5723}
5724
5725void Verifier::visitCallsiteMetadata(Instruction &I, MDNode *MD) {
5726 Check(isa<CallBase>(I), "!callsite metadata should only exist on calls", &I);
5727 // Verify the partial callstack annotated from memprof profiles. This callsite
5728 // is a part of a profiled allocation callstack.
5729 visitCallStackMetadata(MD);
5730}
5731
5732void Verifier::visitCalleeTypeMetadata(Instruction &I, MDNode *MD) {
5733 Check(isa<CallBase>(I), "!callee_type metadata should only exist on calls",
5734 &I);
5735 for (Metadata *Op : MD->operands()) {
5737 "The callee_type metadata must be a list of callgraph metadata nodes",
5738 Op);
5739 auto *CallgraphMD = cast<MDNode>(Op);
5740 Check(CallgraphMD->getNumOperands() == 1,
5741 "Well-formed callgraph metadata must contain exactly one "
5742 "operand",
5743 Op);
5744 Check(isa<MDString>(CallgraphMD->getOperand(0)),
5745 "The operand of callgraph metadata for functions must be an MDString",
5746 Op);
5747 }
5748}
5749
5750void Verifier::visitAnnotationMetadata(MDNode *Annotation) {
5751 Check(isa<MDTuple>(Annotation), "annotation must be a tuple");
5752 Check(Annotation->getNumOperands() >= 1,
5753 "annotation must have at least one operand");
5754 for (const MDOperand &Op : Annotation->operands()) {
5755 bool TupleOfStrings =
5756 isa<MDTuple>(Op.get()) &&
5757 all_of(cast<MDTuple>(Op)->operands(), [](auto &Annotation) {
5758 return isa<MDString>(Annotation.get());
5759 });
5760 Check(isa<MDString>(Op.get()) || TupleOfStrings,
5761 "operands must be a string or a tuple of strings");
5762 }
5763}
5764
5765void Verifier::visitAliasScopeMetadata(const MDNode *MD) {
5766 unsigned NumOps = MD->getNumOperands();
5767 Check(NumOps >= 2 && NumOps <= 3, "scope must have two or three operands",
5768 MD);
5769 Check(MD->getOperand(0).get() == MD || isa<MDString>(MD->getOperand(0)),
5770 "first scope operand must be self-referential or string", MD);
5771 if (NumOps == 3)
5773 "third scope operand must be string (if used)", MD);
5774
5775 auto *Domain = dyn_cast<MDNode>(MD->getOperand(1));
5776 Check(Domain != nullptr, "second scope operand must be MDNode", MD);
5777
5778 unsigned NumDomainOps = Domain->getNumOperands();
5779 Check(NumDomainOps >= 2 && NumDomainOps <= 3,
5780 "domain must have two or three operands", Domain);
5781 Check(Domain->getOperand(0).get() == Domain ||
5782 isa<MDString>(Domain->getOperand(0)),
5783 "first domain operand must be self-referential or string", Domain);
5784 const auto *Disjoint =
5786 Check(Disjoint && Disjoint->getBitWidth() == 1,
5787 "second domain operand must be an i1 constant", Domain);
5788 if (NumDomainOps == 3)
5789 Check(isa<MDString>(Domain->getOperand(2)),
5790 "third domain operand must be string (if used)", Domain);
5791}
5792
5793void Verifier::visitAliasScopeListMetadata(const MDNode *MD) {
5794 for (const MDOperand &Op : MD->operands()) {
5795 const auto *OpMD = dyn_cast<MDNode>(Op);
5796 Check(OpMD != nullptr, "scope list must consist of MDNodes", MD);
5797 visitAliasScopeMetadata(OpMD);
5798 }
5799}
5800
5801void Verifier::visitAccessGroupMetadata(const MDNode *MD) {
5802 auto IsValidAccessScope = [](const MDNode *MD) {
5803 return MD->getNumOperands() == 0 && MD->isDistinct();
5804 };
5805
5806 // An empty node is an access scope, and it must be 'distinct'. It is never a
5807 // list, because an empty list is not allowed: it would look the same as an
5808 // access scope.
5809 if (MD->getNumOperands() == 0) {
5810 Check(MD->isDistinct(), "Access scope must be 'distinct'", MD);
5811 return;
5812 }
5813
5814 // A non-empty node is a list of access scopes.
5815 for (const MDOperand &Op : MD->operands()) {
5816 const auto *OpMD = dyn_cast<MDNode>(Op);
5817 Check(OpMD != nullptr, "Access scope list must consist of MDNodes", MD);
5818 Check(IsValidAccessScope(OpMD),
5819 "Access scope list contains invalid access scope", MD);
5820 }
5821}
5822
5823void Verifier::visitCapturesMetadata(Instruction &I, const MDNode *Captures) {
5824 static const char *ValidArgs[] = {"address_is_null", "address",
5825 "read_provenance", "provenance"};
5826
5827 auto *SI = dyn_cast<StoreInst>(&I);
5828 Check(SI, "!captures metadata can only be applied to store instructions", &I);
5829 Check(SI->getValueOperand()->getType()->isPointerTy(),
5830 "!captures metadata can only be applied to store with value operand of "
5831 "pointer type",
5832 &I);
5833 Check(Captures->getNumOperands() != 0, "!captures metadata cannot be empty",
5834 &I);
5835
5836 for (Metadata *Op : Captures->operands()) {
5837 auto *Str = dyn_cast<MDString>(Op);
5838 Check(Str, "!captures metadata must be a list of strings", &I);
5839 Check(is_contained(ValidArgs, Str->getString()),
5840 "invalid entry in !captures metadata", &I, Str);
5841 }
5842}
5843
5844void Verifier::visitAllocTokenMetadata(Instruction &I, MDNode *MD) {
5845 Check(isa<CallBase>(I), "!alloc_token should only exist on calls", &I);
5846 Check(MD->getNumOperands() == 2 || MD->getNumOperands() == 3,
5847 "!alloc_token must have 2 or 3 operands", MD);
5848 Check(isa_and_nonnull<MDString>(MD->getOperand(0)), "expected string", MD);
5850 "expected integer constant", MD);
5851 if (MD->getNumOperands() == 3)
5853 "expected function name string", MD);
5854}
5855
5856void Verifier::visitInlineHistoryMetadata(Instruction &I, MDNode *MD) {
5857 Check(isa<CallBase>(I), "!inline_history should only exist on calls", &I);
5858 for (Metadata *Op : MD->operands()) {
5859 // Can be null when a function is erased.
5860 if (!Op)
5861 continue;
5864 ->getValue()
5865 ->stripPointerCastsAndAliases()),
5866 "!inline_history operands must be functions or null", MD);
5867 }
5868}
5869
5870void Verifier::visitMemCacheHintMetadata(Instruction &I, MDNode *MD) {
5871 Check(I.mayReadOrWriteMemory(),
5872 "!mem.cache_hint is only valid on memory operations", &I);
5873
5874 Check(MD->getNumOperands() % 2 == 0,
5875 "!mem.cache_hint must have even number of operands "
5876 "(operand_no, hint_node pairs)",
5877 MD);
5878
5879 const auto *CB = dyn_cast<CallBase>(&I);
5880 if (CB)
5881 Check(CB->getIntrinsicID() != Intrinsic::not_intrinsic,
5882 "!mem.cache_hint is not supported on non-intrinsic calls", &I);
5883
5884 unsigned NumOperands = CB ? CB->arg_size() : I.getNumOperands();
5885
5886 SmallDenseSet<unsigned, 4> SeenOperandNos;
5887 std::optional<uint64_t> LastOperandNo;
5888
5889 // Top-level metadata alternates: i32 operand_no, MDNode hint_node.
5890 for (unsigned J = 0; J + 1 < MD->getNumOperands(); J += 2) {
5891 auto *OpNoCI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(J));
5892 Check(OpNoCI,
5893 "!mem.cache_hint must alternate between i32 operand numbers and "
5894 "metadata hint nodes",
5895 MD);
5896
5897 Check(OpNoCI->getValue().isNonNegative(),
5898 "!mem.cache_hint operand number must be non-negative", MD);
5899
5900 uint64_t OperandNo = OpNoCI->getZExtValue();
5901 Check(OperandNo < NumOperands,
5902 "!mem.cache_hint operand number is out of range", &I);
5903
5904 Value *Operand =
5905 CB ? CB->getArgOperand(OperandNo) : I.getOperand(OperandNo);
5906 Check(Operand->getType()->isPtrOrPtrVectorTy(),
5907 "!mem.cache_hint operand number must refer to a pointer operand", &I);
5908
5909 bool Inserted = SeenOperandNos.insert(OperandNo).second;
5910 Check(Inserted, "!mem.cache_hint contains duplicate operand number", MD);
5911
5912 Check(!Inserted || !LastOperandNo || OperandNo > *LastOperandNo,
5913 "!mem.cache_hint operand numbers must be in increasing order", MD);
5914 LastOperandNo = OperandNo;
5915
5916 const auto *Node = dyn_cast<MDNode>(MD->getOperand(J + 1));
5917 Check(Node,
5918 "!mem.cache_hint must alternate between i32 operand numbers and "
5919 "metadata hint nodes",
5920 MD);
5921
5922 Check(Node->getNumOperands() % 2 == 0,
5923 "!mem.cache_hint hint node must have even number of operands "
5924 "(key-value pairs)",
5925 Node);
5926
5927 StringSet<> SeenKeys;
5928 for (unsigned K = 0; K + 1 < Node->getNumOperands(); K += 2) {
5929 const auto *Key = dyn_cast<MDString>(Node->getOperand(K));
5930 Check(Key, "!mem.cache_hint key must be a string", Node);
5931
5932 StringRef KeyStr = Key->getString();
5933 Check(SeenKeys.insert(KeyStr).second,
5934 "!mem.cache_hint hint node contains duplicate key", Node);
5935
5936 const Metadata *Value = Node->getOperand(K + 1).get();
5939 "!mem.cache_hint value must be a string or integer", Node);
5940 }
5941 }
5942}
5943
5944/// verifyInstruction - Verify that an instruction is well formed.
5945///
5946void Verifier::visitInstruction(Instruction &I) {
5947 BasicBlock *BB = I.getParent();
5948 Check(BB, "Instruction not embedded in basic block!", &I);
5949
5950 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
5951 for (User *U : I.users()) {
5952 Check(U != (User *)&I || !DT.isReachableFromEntry(BB),
5953 "Only PHI nodes may reference their own value!", &I);
5954 }
5955 }
5956
5957 // Check that void typed values don't have names
5958 Check(!I.getType()->isVoidTy() || !I.hasName(),
5959 "Instruction has a name, but provides a void value!", &I);
5960
5961 // Check that the return value of the instruction is either void or a legal
5962 // value type.
5963 Check(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
5964 "Instruction returns a non-scalar type!", &I);
5965
5966 // Check that the instruction doesn't produce metadata. Calls are already
5967 // checked against the callee type.
5968 Check(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
5969 "Invalid use of metadata!", &I);
5970
5971 // Check that all uses of the instruction, if they are instructions
5972 // themselves, actually have parent basic blocks. If the use is not an
5973 // instruction, it is an error!
5974 for (Use &U : I.uses()) {
5975 if (auto *Used = dyn_cast<Instruction>(U.getUser()))
5976 Check(Used->getParent() != nullptr,
5977 "Instruction referencing"
5978 " instruction not embedded in a basic block!",
5979 &I, Used);
5980 else {
5981 CheckFailed("Use of instruction is not an instruction!", U);
5982 return;
5983 }
5984 }
5985
5986 // Get a pointer to the call base of the instruction if it is some form of
5987 // call.
5988 const auto *CBI = dyn_cast<CallBase>(&I);
5989
5990 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
5991 Check(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
5992
5993 // Check to make sure that only first-class-values are operands to
5994 // instructions.
5995 if (!I.getOperand(i)->getType()->isFirstClassType()) {
5996 Check(false, "Instruction operands must be first-class values!", &I);
5997 }
5998
5999 if (auto *F = dyn_cast<Function>(I.getOperand(i))) {
6000 // This code checks whether the function is used as the operand of a
6001 // clang_arc_attachedcall operand bundle.
6002 auto IsAttachedCallOperand = [](Function *F, const CallBase *CBI,
6003 int Idx) {
6004 return CBI && CBI->isOperandBundleOfType(
6006 };
6007
6008 // Check to make sure that the "address of" an intrinsic function is never
6009 // taken. Ignore cases where the address of the intrinsic function is used
6010 // as the argument of operand bundle "clang.arc.attachedcall" as those
6011 // cases are handled in verifyAttachedCallBundle.
6012 Check((!F->isIntrinsic() ||
6013 (CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i)) ||
6014 IsAttachedCallOperand(F, CBI, i)),
6015 "Cannot take the address of an intrinsic!", &I);
6016 Check(!F->isIntrinsic() || isa<CallInst>(I) || isa<CallBrInst>(I) ||
6017 F->getIntrinsicID() == Intrinsic::donothing ||
6018 F->getIntrinsicID() == Intrinsic::seh_try_begin ||
6019 F->getIntrinsicID() == Intrinsic::seh_try_end ||
6020 F->getIntrinsicID() == Intrinsic::seh_scope_begin ||
6021 F->getIntrinsicID() == Intrinsic::seh_scope_end ||
6022 F->getIntrinsicID() == Intrinsic::coro_resume ||
6023 F->getIntrinsicID() == Intrinsic::coro_destroy ||
6024 F->getIntrinsicID() == Intrinsic::coro_await_suspend_void ||
6025 F->getIntrinsicID() == Intrinsic::coro_await_suspend_bool ||
6026 F->getIntrinsicID() == Intrinsic::coro_await_suspend_handle ||
6027 F->getIntrinsicID() ==
6028 Intrinsic::experimental_patchpoint_void ||
6029 F->getIntrinsicID() == Intrinsic::experimental_patchpoint ||
6030 F->getIntrinsicID() == Intrinsic::fake_use ||
6031 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint ||
6032 F->getIntrinsicID() == Intrinsic::wasm_throw ||
6033 F->getIntrinsicID() == Intrinsic::wasm_rethrow ||
6034 IsAttachedCallOperand(F, CBI, i),
6035 "Cannot invoke an intrinsic other than donothing, patchpoint, "
6036 "statepoint, coro_resume, coro_destroy, clang.arc.attachedcall or "
6037 "wasm.(re)throw",
6038 &I);
6039 Check(F->getParent() == &M, "Referencing function in another module!", &I,
6040 &M, F, F->getParent());
6041 } else if (auto *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
6042 Check(OpBB->getParent() == BB->getParent(),
6043 "Referring to a basic block in another function!", &I);
6044 } else if (auto *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
6045 Check(OpArg->getParent() == BB->getParent(),
6046 "Referring to an argument in another function!", &I);
6047 } else if (auto *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
6048 Check(GV->getParent() == &M, "Referencing global in another module!", &I,
6049 &M, GV, GV->getParent());
6050 } else if (auto *OpInst = dyn_cast<Instruction>(I.getOperand(i))) {
6051 Check(OpInst->getFunction() == BB->getParent(),
6052 "Referring to an instruction in another function!", &I);
6053 verifyDominatesUse(I, i);
6054 } else if (isa<InlineAsm>(I.getOperand(i))) {
6055 Check(CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i),
6056 "Cannot take the address of an inline asm!", &I);
6057 } else if (auto *C = dyn_cast<Constant>(I.getOperand(i))) {
6058 visitConstantExprsRecursively(C);
6059 }
6060 }
6061
6062 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
6064 "fpmath requires a floating point result!", &I);
6065 Check(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
6066 if (ConstantFP *CFP0 =
6068 const APFloat &Accuracy = CFP0->getValueAPF();
6069 Check(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
6070 "fpmath accuracy must have float type", &I);
6071 Check(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
6072 "fpmath accuracy not a positive number!", &I);
6073 } else {
6074 Check(false, "invalid fpmath accuracy!", &I);
6075 }
6076 }
6077
6078 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
6080 "Ranges are only for loads, calls and invokes!", &I);
6081 visitRangeMetadata(I, Range, I.getType());
6082 }
6083
6084 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nofpclass)) {
6085 Check(isa<LoadInst>(I), "nofpclass is only for loads", &I);
6086 visitNoFPClassMetadata(I, MD, I.getType());
6087 }
6088
6089 if (MDNode *Range = I.getMetadata(LLVMContext::MD_noalias_addrspace)) {
6092 "noalias.addrspace are only for memory operations!", &I);
6093 visitNoaliasAddrspaceMetadata(I, Range, I.getType());
6094 }
6095
6096 if (I.hasMetadata(LLVMContext::MD_invariant_group)) {
6098 "invariant.group metadata is only for loads and stores", &I);
6099 }
6100
6101 if (I.hasMetadata(LLVMContext::MD_invariant_load)) {
6102 auto *II = dyn_cast<IntrinsicInst>(&I);
6103 Check(isa<LoadInst>(I) || (II && II->onlyReadsMemory()),
6104 "invariant.load metadata is only for loads and readonly "
6105 "intrinsic calls",
6106 &I);
6107 }
6108
6109 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nonnull)) {
6110 Check(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
6111 &I);
6113 "nonnull applies only to load instructions, use attributes"
6114 " for calls or invokes",
6115 &I);
6116 Check(MD->getNumOperands() == 0, "nonnull metadata must be empty", &I);
6117 }
6118
6119 if (MDNode *MD = I.getMetadata(LLVMContext::MD_noundef)) {
6120 Check(isa<LoadInst>(I), "noundef applies only to load instructions", &I);
6121 Check(MD->getNumOperands() == 0, "noundef metadata must be empty", &I);
6122 }
6123
6124 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
6125 visitDereferenceableMetadata(I, MD);
6126
6127 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
6128 visitDereferenceableMetadata(I, MD);
6129
6130 if (MDNode *MD = I.getMetadata(LLVMContext::MD_nofreeobj))
6131 visitNoFreeObjMetadata(I, MD);
6132
6133 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
6134 TBAAVerifyHelper.visitTBAAMetadata(&I, TBAA);
6135
6136 if (MDNode *TBAAStruct = I.getMetadata(LLVMContext::MD_tbaa_struct))
6137 TBAAVerifyHelper.visitTBAAStructMetadata(&I, TBAAStruct);
6138
6139 if (MDNode *MD = I.getMetadata(LLVMContext::MD_noalias))
6140 visitAliasScopeListMetadata(MD);
6141 if (MDNode *MD = I.getMetadata(LLVMContext::MD_alias_scope))
6142 visitAliasScopeListMetadata(MD);
6143
6144 if (MDNode *MD = I.getMetadata(LLVMContext::MD_access_group))
6145 visitAccessGroupMetadata(MD);
6146
6147 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
6148 Check(I.getType()->isPointerTy(), "align applies only to pointer types",
6149 &I);
6151 "align applies only to load instructions, "
6152 "use attributes for calls or invokes",
6153 &I);
6154 Check(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
6155 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
6156 Check(CI && CI->getType()->isIntegerTy(64),
6157 "align metadata value must be an i64!", &I);
6158 uint64_t Align = CI->getZExtValue();
6159 Check(isPowerOf2_64(Align), "align metadata value must be a power of 2!",
6160 &I);
6161 Check(Align <= Value::MaximumAlignment,
6162 "alignment is larger that implementation defined limit", &I);
6163 }
6164
6165 if (MDNode *MD = I.getMetadata(LLVMContext::MD_prof))
6166 visitProfMetadata(I, MD);
6167
6168 if (MDNode *MD = I.getMetadata(LLVMContext::MD_memprof))
6169 visitMemProfMetadata(I, MD);
6170
6171 if (MDNode *MD = I.getMetadata(LLVMContext::MD_callsite))
6172 visitCallsiteMetadata(I, MD);
6173
6174 if (MDNode *MD = I.getMetadata(LLVMContext::MD_callee_type))
6175 visitCalleeTypeMetadata(I, MD);
6176
6177 if (MDNode *MD = I.getMetadata(LLVMContext::MD_DIAssignID))
6178 visitDIAssignIDMetadata(I, MD);
6179
6180 if (MDNode *MMRA = I.getMetadata(LLVMContext::MD_mmra))
6181 visitMMRAMetadata(I, MMRA);
6182
6183 if (MDNode *Annotation = I.getMetadata(LLVMContext::MD_annotation))
6184 visitAnnotationMetadata(Annotation);
6185
6186 if (MDNode *Captures = I.getMetadata(LLVMContext::MD_captures))
6187 visitCapturesMetadata(I, Captures);
6188
6189 if (MDNode *MD = I.getMetadata(LLVMContext::MD_alloc_token))
6190 visitAllocTokenMetadata(I, MD);
6191
6192 if (MDNode *MD = I.getMetadata(LLVMContext::MD_inline_history))
6193 visitInlineHistoryMetadata(I, MD);
6194
6195 if (MDNode *MD = I.getMetadata(LLVMContext::MD_mem_cache_hint))
6196 visitMemCacheHintMetadata(I, MD);
6197
6198 if (MDNode *MD = I.getMetadata("amdgpu.expected.active.lanes")) {
6199 Check(MD->getNumOperands() == 1,
6200 "!amdgpu.expected.active.lanes must have exactly one operand", &I,
6201 MD);
6202 ConstantInt *CI =
6204 Check(CI && CI->getType()->isIntegerTy(32),
6205 "!amdgpu.expected.active.lanes operand must be an i32 constant", &I,
6206 MD);
6207 }
6208
6209 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
6210 CheckDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
6211 visitMDNode(*N, AreDebugLocsAllowed::Yes);
6212
6213 if (auto *DL = dyn_cast<DILocation>(N)) {
6214 if (DL->getAtomGroup()) {
6215 DISubprogram *SP = getSubprogram(DL->getRawScope());
6216 CheckDI(SP && SP->getKeyInstructionsEnabled(),
6217 "DbgLoc uses atomGroup but DISubprogram doesn't have Key "
6218 "Instructions enabled",
6219 DL, SP);
6220 }
6221 }
6222 }
6223
6225 I.getAllMetadata(MDs);
6226 for (auto Attachment : MDs) {
6227 unsigned Kind = Attachment.first;
6228 auto AllowLocs =
6229 (Kind == LLVMContext::MD_dbg || Kind == LLVMContext::MD_loop)
6230 ? AreDebugLocsAllowed::Yes
6231 : AreDebugLocsAllowed::No;
6232 visitMDNode(*Attachment.second, AllowLocs);
6233 }
6234
6235 InstsInThisBlock.insert(&I);
6236}
6237
6238/// Allow intrinsics to be verified in different ways.
6239void Verifier::visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call) {
6241
6242 // If the intrinsic takes MDNode arguments, verify that they are either global
6243 // or are local to *this* function.
6244 for (Value *V : Call.args()) {
6245 if (auto *MD = dyn_cast<MetadataAsValue>(V))
6246 visitMetadataAsValue(*MD, Call.getCaller());
6247 if (auto *Const = dyn_cast<Constant>(V))
6248 Check(!Const->getType()->isX86_AMXTy(),
6249 "const x86_amx is not allowed in argument!");
6250 }
6251
6252 // Verify intrinsic signature, so following checks can rely on it. The actual
6253 // error is reported at the intrinsic declaration.
6254 SmallVector<Type *, 4> OverloadTys;
6255 if (!Intrinsic::isSignatureValid(ID, Call.getFunctionType(), OverloadTys))
6256 return;
6257
6258 switch (ID) {
6259 default:
6260 break;
6261 case Intrinsic::assume: {
6262 if (Call.hasOperandBundles()) {
6264 Check(Cond && Cond->isOne(),
6265 "assume with operand bundles must have i1 true condition", Call);
6266 }
6267 for (auto OBU : Call.operand_bundles()) {
6268 // Separate storage assumptions are special insofar as they're the only
6269 // operand bundles allowed on assumes that aren't parameter attributes.
6270
6271 auto GetTypeAt = [&](unsigned Index) {
6272 return OBU.Inputs[Index]->getType();
6273 };
6274
6275 switch (getBundleAttrFromOBU(OBU)) {
6276 case BundleAttr::None:
6277 CheckFailed("tags must be valid attribute names", Call);
6278 break;
6279 case BundleAttr::Align:
6280 Check(OBU.Inputs.size() >= 2 && OBU.Inputs.size() <= 3,
6281 "alignment assumptions should have 2 or 3 arguments", Call);
6282 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6283 Call);
6284 Check(GetTypeAt(1)->isIntegerTy() &&
6285 GetTypeAt(1)->getIntegerBitWidth() <= 64,
6286 "second argument should be an integer with a maximum width of 64 "
6287 "bits",
6288 Call);
6289 Check(OBU.Inputs.size() < 3 ||
6290 (GetTypeAt(2)->isIntegerTy() &&
6291 GetTypeAt(2)->getIntegerBitWidth() <= 64),
6292 "third argument should be an integer with a maximum width of 64 "
6293 "bits if present",
6294 Call);
6295 break;
6296 case BundleAttr::Cold:
6297 Check(OBU.Inputs.size() == 0,
6298 "cold assumptions should have no arguments", Call);
6299 break;
6300 case BundleAttr::Dereferenceable:
6301 case BundleAttr::DereferenceableOrNull:
6302 Check(OBU.Inputs.size() == 2,
6303 "dereferenceable assumptions should have 2 arguments", Call);
6304 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6305 Call);
6306 Check(GetTypeAt(1)->isIntegerTy() &&
6307 GetTypeAt(1)->getIntegerBitWidth() <= 64,
6308 "second argument should be an integer with a maximum width of 64 "
6309 "bits",
6310 Call);
6311 break;
6312 case BundleAttr::Ignore:
6313 break;
6314 case BundleAttr::NonNull:
6315 Check(OBU.Inputs.size() == 1,
6316 "nonnull assumptions should have 1 argument", Call);
6317 Check(GetTypeAt(0)->isPointerTy(), "first argument should be a pointer",
6318 Call);
6319 break;
6320 case BundleAttr::NoUndef:
6321 Check(OBU.Inputs.size() == 1,
6322 "noundef assumptions should have 1 argument", Call);
6323 break;
6324 case BundleAttr::SeparateStorage:
6325 Check(OBU.Inputs.size() == 2,
6326 "separate_storage assumptions should have 2 arguments", Call);
6327 Check(GetTypeAt(0)->isPointerTy() && GetTypeAt(1)->isPointerTy(),
6328 "arguments to separate_storage assumptions should be pointers",
6329 Call);
6330 break;
6331 }
6332 }
6333 break;
6334 }
6335 case Intrinsic::ucmp:
6336 case Intrinsic::scmp: {
6337 Type *SrcTy = Call.getOperand(0)->getType();
6338 Type *DestTy = Call.getType();
6339
6340 Check(DestTy->getScalarSizeInBits() >= 2,
6341 "result type must be at least 2 bits wide", Call);
6342
6343 bool IsDestTypeVector = DestTy->isVectorTy();
6344 Check(SrcTy->isVectorTy() == IsDestTypeVector,
6345 "ucmp/scmp argument and result types must both be either vector or "
6346 "scalar types",
6347 Call);
6348 if (IsDestTypeVector) {
6349 auto SrcVecLen = cast<VectorType>(SrcTy)->getElementCount();
6350 auto DestVecLen = cast<VectorType>(DestTy)->getElementCount();
6351 Check(SrcVecLen == DestVecLen,
6352 "return type and arguments must have the same number of "
6353 "elements",
6354 Call);
6355 }
6356 break;
6357 }
6358 case Intrinsic::coro_begin:
6359 case Intrinsic::coro_begin_custom_abi:
6361 "id argument of llvm.coro.begin must refer to coro.id");
6362 break;
6363 case Intrinsic::coro_id: {
6365 "align argument only accepts constants");
6366 auto *Promise = Call.getArgOperand(1);
6367 Check(isa<ConstantPointerNull>(Promise) || isa<AllocaInst>(Promise),
6368 "promise argument must refer to an alloca");
6369
6370 auto *CoroAddr = Call.getArgOperand(2)->stripPointerCastsAndAliases();
6371 bool BeforeCoroEarly = isa<ConstantPointerNull>(CoroAddr);
6372 Check(BeforeCoroEarly || isa<Function>(CoroAddr),
6373 "coro argument must refer to a function");
6374
6375 auto *InfoArg = Call.getArgOperand(3);
6376 bool BeforeCoroSplit = isa<ConstantPointerNull>(InfoArg);
6377 if (BeforeCoroSplit)
6378 break;
6379
6380 Check(!BeforeCoroEarly, "cannot run CoroSplit before CoroEarly");
6381 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
6382 Check(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
6383 "info argument of llvm.coro.id must refer to an initialized "
6384 "constant");
6385 Constant *Init = GV->getInitializer();
6387 "info argument of llvm.coro.id must refer to either a struct or "
6388 "an array");
6389 break;
6390 }
6391 case Intrinsic::is_fpclass: {
6392 const ConstantInt *TestMask = cast<ConstantInt>(Call.getOperand(1));
6393 Check((TestMask->getZExtValue() & ~static_cast<unsigned>(fcAllFlags)) == 0,
6394 "unsupported bits for llvm.is.fpclass test mask");
6395 break;
6396 }
6397 case Intrinsic::fptrunc_round: {
6398 // Check the rounding mode
6399 Metadata *MD = nullptr;
6401 if (MAV)
6402 MD = MAV->getMetadata();
6403
6404 Check(MD != nullptr, "missing rounding mode argument", Call);
6405
6406 Check(isa<MDString>(MD),
6407 ("invalid value for llvm.fptrunc.round metadata operand"
6408 " (the operand should be a string)"),
6409 MD);
6410
6411 std::optional<RoundingMode> RoundMode =
6412 convertStrToRoundingMode(cast<MDString>(MD)->getString());
6413 Check(RoundMode && *RoundMode != RoundingMode::Dynamic,
6414 "unsupported rounding mode argument", Call);
6415 break;
6416 }
6417 case Intrinsic::convert_to_arbitrary_fp: {
6418 // Check that vector element counts are consistent.
6419 Type *ValueTy = Call.getArgOperand(0)->getType();
6420 Type *IntTy = Call.getType();
6421
6422 if (auto *ValueVecTy = dyn_cast<VectorType>(ValueTy)) {
6423 auto *IntVecTy = dyn_cast<VectorType>(IntTy);
6424 Check(IntVecTy,
6425 "if floating-point operand is a vector, integer operand must also "
6426 "be a vector",
6427 Call);
6428 Check(ValueVecTy->getElementCount() == IntVecTy->getElementCount(),
6429 "floating-point and integer vector operands must have the same "
6430 "element count",
6431 Call);
6432 }
6433
6434 // Check interpretation metadata (argoperand 1).
6435 auto *InterpMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(1));
6436 Check(InterpMAV, "missing interpretation metadata operand", Call);
6437 auto *InterpStr = dyn_cast<MDString>(InterpMAV->getMetadata());
6438 Check(InterpStr, "interpretation metadata operand must be a string", Call);
6439 StringRef Interp = InterpStr->getString();
6440
6441 Check(!Interp.empty(), "interpretation metadata string must not be empty",
6442 Call);
6443
6444 // Valid interpretation strings: mini-float format names.
6446 "unsupported interpretation metadata string", Call);
6447
6448 // The integer type width must equal the arbitrary FP format width.
6449 if (unsigned FormatBits =
6451 Check(IntTy->getScalarSizeInBits() == FormatBits,
6452 "integer type bit width must equal the arbitrary FP format width",
6453 Call);
6454
6455 // Check rounding mode metadata (argoperand 2).
6456 auto *RoundingMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(2));
6457 Check(RoundingMAV, "missing rounding mode metadata operand", Call);
6458 auto *RoundingStr = dyn_cast<MDString>(RoundingMAV->getMetadata());
6459 Check(RoundingStr, "rounding mode metadata operand must be a string", Call);
6460
6461 std::optional<RoundingMode> RM =
6462 convertStrToRoundingMode(RoundingStr->getString());
6463 Check(RM && *RM != RoundingMode::Dynamic,
6464 "unsupported rounding mode argument", Call);
6465 break;
6466 }
6467 case Intrinsic::convert_from_arbitrary_fp: {
6468 // Check that vector element counts are consistent.
6469 Type *IntTy = Call.getArgOperand(0)->getType();
6470 Type *ValueTy = Call.getType();
6471
6472 if (auto *ValueVecTy = dyn_cast<VectorType>(ValueTy)) {
6473 auto *IntVecTy = dyn_cast<VectorType>(IntTy);
6474 Check(IntVecTy,
6475 "if floating-point operand is a vector, integer operand must also "
6476 "be a vector",
6477 Call);
6478 Check(ValueVecTy->getElementCount() == IntVecTy->getElementCount(),
6479 "floating-point and integer vector operands must have the same "
6480 "element count",
6481 Call);
6482 }
6483
6484 // Check interpretation metadata (argoperand 1).
6485 auto *InterpMAV = dyn_cast<MetadataAsValue>(Call.getArgOperand(1));
6486 Check(InterpMAV, "missing interpretation metadata operand", Call);
6487 auto *InterpStr = dyn_cast<MDString>(InterpMAV->getMetadata());
6488 Check(InterpStr, "interpretation metadata operand must be a string", Call);
6489 StringRef Interp = InterpStr->getString();
6490
6491 Check(!Interp.empty(), "interpretation metadata string must not be empty",
6492 Call);
6493
6494 // Valid interpretation strings: mini-float format names.
6496 "unsupported interpretation metadata string", Call);
6497
6498 // The integer type width must equal the arbitrary FP format width.
6499 if (unsigned FormatBits =
6501 Check(IntTy->getScalarSizeInBits() == FormatBits,
6502 "integer type bit width must equal the arbitrary FP format width",
6503 Call);
6504 break;
6505 }
6506#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
6507#include "llvm/IR/VPIntrinsics.def"
6508#undef BEGIN_REGISTER_VP_INTRINSIC
6509 visitVPIntrinsic(cast<VPIntrinsic>(Call));
6510 break;
6511#define INSTRUCTION(NAME, NARGS, ROUND_MODE, INTRINSIC) \
6512 case Intrinsic::INTRINSIC:
6513#include "llvm/IR/ConstrainedOps.def"
6514#undef INSTRUCTION
6515 visitConstrainedFPIntrinsic(cast<ConstrainedFPIntrinsic>(Call));
6516 break;
6517 case Intrinsic::dbg_declare: // llvm.dbg.declare
6518 case Intrinsic::dbg_value: // llvm.dbg.value
6519 case Intrinsic::dbg_assign: // llvm.dbg.assign
6520 case Intrinsic::dbg_label: // llvm.dbg.label
6521 // We no longer interpret debug intrinsics (the old variable-location
6522 // design). They're meaningless as far as LLVM is concerned we could make
6523 // it an error for them to appear, but it's possible we'll have users
6524 // converting back to intrinsics for the forseeable future (such as DXIL),
6525 // so tolerate their existance.
6526 break;
6527 case Intrinsic::memcpy:
6528 case Intrinsic::memcpy_inline:
6529 case Intrinsic::memmove:
6530 case Intrinsic::memset:
6531 case Intrinsic::memset_inline:
6532 break;
6533 case Intrinsic::experimental_memset_pattern: {
6534 const auto Memset = cast<MemSetPatternInst>(&Call);
6535 Check(Memset->getValue()->getType()->isSized(),
6536 "unsized types cannot be used as memset patterns", Call);
6537 break;
6538 }
6539 case Intrinsic::memcpy_element_unordered_atomic:
6540 case Intrinsic::memmove_element_unordered_atomic:
6541 case Intrinsic::memset_element_unordered_atomic: {
6542 const auto *AMI = cast<AnyMemIntrinsic>(&Call);
6543
6544 ConstantInt *ElementSizeCI =
6545 cast<ConstantInt>(AMI->getRawElementSizeInBytes());
6546 const APInt &ElementSizeVal = ElementSizeCI->getValue();
6547 Check(ElementSizeVal.isPowerOf2(),
6548 "element size of the element-wise atomic memory intrinsic "
6549 "must be a power of 2",
6550 Call);
6551
6552 auto IsValidAlignment = [&](MaybeAlign Alignment) {
6553 return Alignment && ElementSizeVal.ule(Alignment->value());
6554 };
6555 Check(IsValidAlignment(AMI->getDestAlign()),
6556 "incorrect alignment of the destination argument", Call);
6557 if (const auto *AMT = dyn_cast<AnyMemTransferInst>(AMI)) {
6558 Check(IsValidAlignment(AMT->getSourceAlign()),
6559 "incorrect alignment of the source argument", Call);
6560 }
6561 break;
6562 }
6563 case Intrinsic::call_preallocated_setup: {
6564 auto *NumArgs = cast<ConstantInt>(Call.getArgOperand(0));
6565 bool FoundCall = false;
6566 for (User *U : Call.users()) {
6567 auto *UseCall = dyn_cast<CallBase>(U);
6568 Check(UseCall != nullptr,
6569 "Uses of llvm.call.preallocated.setup must be calls");
6570 Intrinsic::ID IID = UseCall->getIntrinsicID();
6571 if (IID == Intrinsic::call_preallocated_arg) {
6572 auto *AllocArgIndex = dyn_cast<ConstantInt>(UseCall->getArgOperand(1));
6573 Check(AllocArgIndex != nullptr,
6574 "llvm.call.preallocated.alloc arg index must be a constant");
6575 auto AllocArgIndexInt = AllocArgIndex->getValue();
6576 Check(AllocArgIndexInt.sge(0) &&
6577 AllocArgIndexInt.slt(NumArgs->getValue()),
6578 "llvm.call.preallocated.alloc arg index must be between 0 and "
6579 "corresponding "
6580 "llvm.call.preallocated.setup's argument count");
6581 } else if (IID == Intrinsic::call_preallocated_teardown) {
6582 // nothing to do
6583 } else {
6584 Check(!FoundCall, "Can have at most one call corresponding to a "
6585 "llvm.call.preallocated.setup");
6586 FoundCall = true;
6587 size_t NumPreallocatedArgs = 0;
6588 for (unsigned i = 0; i < UseCall->arg_size(); i++) {
6589 if (UseCall->paramHasAttr(i, Attribute::Preallocated)) {
6590 ++NumPreallocatedArgs;
6591 }
6592 }
6593 Check(NumPreallocatedArgs != 0,
6594 "cannot use preallocated intrinsics on a call without "
6595 "preallocated arguments");
6596 Check(NumArgs->equalsInt(NumPreallocatedArgs),
6597 "llvm.call.preallocated.setup arg size must be equal to number "
6598 "of preallocated arguments "
6599 "at call site",
6600 Call, *UseCall);
6601 // getOperandBundle() cannot be called if more than one of the operand
6602 // bundle exists. There is already a check elsewhere for this, so skip
6603 // here if we see more than one.
6604 if (UseCall->countOperandBundlesOfType(LLVMContext::OB_preallocated) >
6605 1) {
6606 return;
6607 }
6608 auto PreallocatedBundle =
6609 UseCall->getOperandBundle(LLVMContext::OB_preallocated);
6610 Check(PreallocatedBundle,
6611 "Use of llvm.call.preallocated.setup outside intrinsics "
6612 "must be in \"preallocated\" operand bundle");
6613 Check(PreallocatedBundle->Inputs.front().get() == &Call,
6614 "preallocated bundle must have token from corresponding "
6615 "llvm.call.preallocated.setup");
6616 }
6617 }
6618 break;
6619 }
6620 case Intrinsic::call_preallocated_arg: {
6621 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
6622 Check(Token &&
6623 Token->getIntrinsicID() == Intrinsic::call_preallocated_setup,
6624 "llvm.call.preallocated.arg token argument must be a "
6625 "llvm.call.preallocated.setup");
6626 Check(Call.hasFnAttr(Attribute::Preallocated),
6627 "llvm.call.preallocated.arg must be called with a \"preallocated\" "
6628 "call site attribute");
6629 break;
6630 }
6631 case Intrinsic::call_preallocated_teardown: {
6632 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0));
6633 Check(Token &&
6634 Token->getIntrinsicID() == Intrinsic::call_preallocated_setup,
6635 "llvm.call.preallocated.teardown token argument must be a "
6636 "llvm.call.preallocated.setup");
6637 break;
6638 }
6639 case Intrinsic::gcroot:
6640 case Intrinsic::gcwrite:
6641 case Intrinsic::gcread:
6642 if (ID == Intrinsic::gcroot) {
6643 auto *AI =
6645 Check(AI, "llvm.gcroot parameter #1 must be an alloca.", Call);
6647 "llvm.gcroot parameter #2 must be a constant.", Call);
6648 if (!AI->getAllocatedType()->isPointerTy()) {
6650 "llvm.gcroot parameter #1 must either be a pointer alloca, "
6651 "or argument #2 must be a non-null constant.",
6652 Call);
6653 }
6654 }
6655
6656 Check(Call.getParent()->getParent()->hasGC(),
6657 "Enclosing function does not use GC.", Call);
6658 break;
6659 case Intrinsic::init_trampoline:
6661 "llvm.init_trampoline parameter #2 must resolve to a function.",
6662 Call);
6663 break;
6664 case Intrinsic::reloc_none: {
6666 cast<MetadataAsValue>(Call.getArgOperand(0))->getMetadata()),
6667 "llvm.reloc.none argument must be a metadata string", &Call);
6668 break;
6669 }
6670 case Intrinsic::stackprotector:
6672 "llvm.stackprotector parameter #2 must resolve to an alloca.", Call);
6673 break;
6674 case Intrinsic::localescape: {
6675 BasicBlock *BB = Call.getParent();
6676 Check(BB->isEntryBlock(), "llvm.localescape used outside of entry block",
6677 Call);
6678 Check(!SawFrameEscape, "multiple calls to llvm.localescape in one function",
6679 Call);
6680 for (Value *Arg : Call.args()) {
6681 if (isa<ConstantPointerNull>(Arg))
6682 continue; // Null values are allowed as placeholders.
6683 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
6684 Check(AI && AI->isStaticAlloca(),
6685 "llvm.localescape only accepts static allocas", Call);
6686 }
6687 FrameEscapeInfo[BB->getParent()].first = Call.arg_size();
6688 SawFrameEscape = true;
6689 break;
6690 }
6691 case Intrinsic::localrecover: {
6693 auto *Fn = dyn_cast<Function>(FnArg);
6694 Check(Fn && !Fn->isDeclaration(),
6695 "llvm.localrecover first "
6696 "argument must be function defined in this module",
6697 Call);
6698 auto *IdxArg = cast<ConstantInt>(Call.getArgOperand(2));
6699 auto &Entry = FrameEscapeInfo[Fn];
6700 Entry.second = unsigned(
6701 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
6702 break;
6703 }
6704
6705 case Intrinsic::experimental_gc_statepoint:
6706 if (auto *CI = dyn_cast<CallInst>(&Call))
6707 Check(!CI->isInlineAsm(),
6708 "gc.statepoint support for inline assembly unimplemented", CI);
6709 Check(Call.getParent()->getParent()->hasGC(),
6710 "Enclosing function does not use GC.", Call);
6711
6712 verifyStatepoint(Call);
6713 break;
6714 case Intrinsic::experimental_gc_result: {
6715 Check(Call.getParent()->getParent()->hasGC(),
6716 "Enclosing function does not use GC.", Call);
6717
6718 auto *Statepoint = Call.getArgOperand(0);
6719 if (isa<UndefValue>(Statepoint))
6720 break;
6721
6722 // Are we tied to a statepoint properly?
6723 const auto *StatepointCall = dyn_cast<CallBase>(Statepoint);
6724 Check(StatepointCall && StatepointCall->getIntrinsicID() ==
6725 Intrinsic::experimental_gc_statepoint,
6726 "gc.result operand #1 must be from a statepoint", Call,
6727 Call.getArgOperand(0));
6728
6729 // Check that result type matches wrapped callee.
6730 auto *TargetFuncType =
6731 cast<FunctionType>(StatepointCall->getParamElementType(2));
6732 Check(Call.getType() == TargetFuncType->getReturnType(),
6733 "gc.result result type does not match wrapped callee", Call);
6734 break;
6735 }
6736 case Intrinsic::experimental_gc_relocate: {
6738 "gc.relocate must return a pointer or a vector of pointers", Call);
6739
6740 // Check that this relocate is correctly tied to the statepoint
6741
6742 // This is case for relocate on the unwinding path of an invoke statepoint
6743 if (auto *LandingPad = dyn_cast<LandingPadInst>(Call.getArgOperand(0))) {
6744
6745 const BasicBlock *InvokeBB =
6746 LandingPad->getParent()->getUniquePredecessor();
6747
6748 // Landingpad relocates should have only one predecessor with invoke
6749 // statepoint terminator
6750 Check(InvokeBB, "safepoints should have unique landingpads",
6751 LandingPad->getParent());
6752 Check(InvokeBB->getTerminator(), "safepoint block should be well formed",
6753 InvokeBB);
6755 "gc relocate should be linked to a statepoint", InvokeBB);
6756 } else {
6757 // In all other cases relocate should be tied to the statepoint directly.
6758 // This covers relocates on a normal return path of invoke statepoint and
6759 // relocates of a call statepoint.
6760 auto *Token = Call.getArgOperand(0);
6762 "gc relocate is incorrectly tied to the statepoint", Call, Token);
6763 }
6764
6765 // Verify rest of the relocate arguments.
6766 const Value &StatepointCall = *cast<GCRelocateInst>(Call).getStatepoint();
6767
6768 // Both the base and derived must be piped through the safepoint.
6771 "gc.relocate operand #2 must be integer offset", Call);
6772
6773 Value *Derived = Call.getArgOperand(2);
6774 Check(isa<ConstantInt>(Derived),
6775 "gc.relocate operand #3 must be integer offset", Call);
6776
6777 const uint64_t BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
6778 const uint64_t DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
6779
6780 // Check the bounds
6781 if (isa<UndefValue>(StatepointCall))
6782 break;
6783 if (auto Opt = cast<GCStatepointInst>(StatepointCall)
6784 .getOperandBundle(LLVMContext::OB_gc_live)) {
6785 Check(BaseIndex < Opt->Inputs.size(),
6786 "gc.relocate: statepoint base index out of bounds", Call);
6787 Check(DerivedIndex < Opt->Inputs.size(),
6788 "gc.relocate: statepoint derived index out of bounds", Call);
6789 }
6790
6791 // Relocated value must be either a pointer type or vector-of-pointer type,
6792 // but gc_relocate does not need to return the same pointer type as the
6793 // relocated pointer. It can be casted to the correct type later if it's
6794 // desired. However, they must have the same address space and 'vectorness'
6795 GCRelocateInst &Relocate = cast<GCRelocateInst>(Call);
6796 auto *ResultType = Call.getType();
6797 auto *DerivedType = Relocate.getDerivedPtr()->getType();
6798 auto *BaseType = Relocate.getBasePtr()->getType();
6799
6800 Check(BaseType->isPtrOrPtrVectorTy(),
6801 "gc.relocate: relocated value must be a pointer", Call);
6802 Check(DerivedType->isPtrOrPtrVectorTy(),
6803 "gc.relocate: relocated value must be a pointer", Call);
6804
6805 Check(ResultType->isVectorTy() == DerivedType->isVectorTy(),
6806 "gc.relocate: vector relocates to vector and pointer to pointer",
6807 Call);
6808 Check(
6809 ResultType->getPointerAddressSpace() ==
6810 DerivedType->getPointerAddressSpace(),
6811 "gc.relocate: relocating a pointer shouldn't change its address space",
6812 Call);
6813
6814 auto GC = llvm::getGCStrategy(Relocate.getFunction()->getGC());
6815 Check(GC, "gc.relocate: calling function must have GCStrategy",
6816 Call.getFunction());
6817 if (GC) {
6818 auto isGCPtr = [&GC](Type *PTy) {
6819 return GC->isGCManagedPointer(PTy->getScalarType()).value_or(true);
6820 };
6821 Check(isGCPtr(ResultType), "gc.relocate: must return gc pointer", Call);
6822 Check(isGCPtr(BaseType),
6823 "gc.relocate: relocated value must be a gc pointer", Call);
6824 Check(isGCPtr(DerivedType),
6825 "gc.relocate: relocated value must be a gc pointer", Call);
6826 }
6827 break;
6828 }
6829 case Intrinsic::experimental_patchpoint: {
6830 if (Call.getCallingConv() == CallingConv::AnyReg) {
6832 "patchpoint: invalid return type used with anyregcc", Call);
6833 }
6834 break;
6835 }
6836 case Intrinsic::eh_exceptioncode:
6837 case Intrinsic::eh_exceptionpointer: {
6839 "eh.exceptionpointer argument must be a catchpad", Call);
6840 break;
6841 }
6842 case Intrinsic::get_active_lane_mask: {
6843 Type *ElemTy = Call.getType()->getScalarType();
6844 Check(ElemTy->isIntegerTy(1),
6845 "get_active_lane_mask: element type is not i1", Call);
6846 break;
6847 }
6848 case Intrinsic::mask_beforefirst: {
6850 "mask.beforefirst element type must be i1", Call);
6851 break;
6852 }
6853 case Intrinsic::experimental_get_vector_length: {
6854 auto *VF = cast<ConstantInt>(Call.getArgOperand(1));
6855 Check(!VF->isNegative() && !VF->isZero(),
6856 "get_vector_length: VF must be positive", Call);
6857 break;
6858 }
6859 case Intrinsic::experimental_guard: {
6860 Check(isa<CallInst>(Call), "experimental_guard cannot be invoked", Call);
6862 "experimental_guard must have exactly one "
6863 "\"deopt\" operand bundle");
6864 break;
6865 }
6866
6867 case Intrinsic::experimental_deoptimize: {
6868 Check(isa<CallInst>(Call), "experimental_deoptimize cannot be invoked",
6869 Call);
6871 "experimental_deoptimize must have exactly one "
6872 "\"deopt\" operand bundle");
6874 "experimental_deoptimize return type must match caller return type");
6875
6876 if (isa<CallInst>(Call)) {
6878 Check(RI,
6879 "calls to experimental_deoptimize must be followed by a return");
6880
6881 if (!Call.getType()->isVoidTy() && RI)
6882 Check(RI->getReturnValue() == &Call,
6883 "calls to experimental_deoptimize must be followed by a return "
6884 "of the value computed by experimental_deoptimize");
6885 }
6886
6887 break;
6888 }
6889 case Intrinsic::vastart: {
6891 "va_start called in a non-varargs function");
6892 break;
6893 }
6894 case Intrinsic::get_dynamic_area_offset: {
6895 Check(DL.getPointerSizeInBits(DL.getAllocaAddrSpace()) ==
6897 "get_dynamic_area_offset result type must match alloca address "
6898 "space width",
6899 Call);
6900 break;
6901 }
6902 case Intrinsic::smul_fix:
6903 case Intrinsic::smul_fix_sat:
6904 case Intrinsic::umul_fix:
6905 case Intrinsic::umul_fix_sat:
6906 case Intrinsic::sdiv_fix:
6907 case Intrinsic::sdiv_fix_sat:
6908 case Intrinsic::udiv_fix:
6909 case Intrinsic::udiv_fix_sat: {
6910 Value *Op1 = Call.getArgOperand(0);
6911 auto *Op3 = cast<ConstantInt>(Call.getArgOperand(2));
6912
6913 if (ID == Intrinsic::smul_fix || ID == Intrinsic::smul_fix_sat ||
6914 ID == Intrinsic::sdiv_fix || ID == Intrinsic::sdiv_fix_sat) {
6915 Check(Op3->getZExtValue() < Op1->getType()->getScalarSizeInBits(),
6916 "the scale of s[mul|div]_fix[_sat] must be less than the width of "
6917 "the operands");
6918 } else {
6919 Check(Op3->getZExtValue() <= Op1->getType()->getScalarSizeInBits(),
6920 "the scale of u[mul|div]_fix[_sat] must be less than or equal "
6921 "to the width of the operands");
6922 }
6923 break;
6924 }
6925 case Intrinsic::lrint:
6926 case Intrinsic::llrint:
6927 case Intrinsic::lround:
6928 case Intrinsic::llround: {
6929 Type *ValTy = Call.getArgOperand(0)->getType();
6930 Type *ResultTy = Call.getType();
6931 Check(ValTy->isVectorTy() == ResultTy->isVectorTy(),
6932 IF->getName() + ": argument and result disagree on vector use",
6933 &Call);
6934 if (auto *VTy = dyn_cast<VectorType>(ValTy)) {
6935 auto *RTy = dyn_cast<VectorType>(ResultTy);
6936 Check(VTy->getElementCount() == RTy->getElementCount(),
6937 IF->getName() + ": argument must be same length as result", &Call);
6938 }
6939 break;
6940 }
6941 case Intrinsic::bswap: {
6942 Type *Ty = Call.getType();
6943 unsigned Size = Ty->getScalarSizeInBits();
6944 Check(Size % 16 == 0, "bswap must be an even number of bytes", &Call);
6945 break;
6946 }
6947 case Intrinsic::invariant_start: {
6948 auto *InvariantSize = dyn_cast<ConstantInt>(Call.getArgOperand(0));
6949 Check(InvariantSize &&
6950 (!InvariantSize->isNegative() || InvariantSize->isMinusOne()),
6951 "invariant_start parameter must be -1, 0 or a positive number",
6952 &Call);
6953 break;
6954 }
6955 case Intrinsic::matrix_multiply:
6956 case Intrinsic::matrix_transpose:
6957 case Intrinsic::matrix_column_major_load:
6958 case Intrinsic::matrix_column_major_store: {
6960 Value *Stride = nullptr;
6961 ConstantInt *NumRows;
6962 ConstantInt *NumColumns;
6963 FixedVectorType *ResultTy;
6964 Type *Op0ElemTy = nullptr;
6965 Type *Op1ElemTy = nullptr;
6966 switch (ID) {
6967 case Intrinsic::matrix_multiply: {
6968 NumRows = cast<ConstantInt>(Call.getArgOperand(2));
6969 ConstantInt *N = cast<ConstantInt>(Call.getArgOperand(3));
6970 NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
6973 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
6974 Check(Op0Ty && Op1Ty && RetTy,
6975 "Matrix operations require fixed-length vectors!", &Call);
6976 Check(Op0Ty->getNumElements() ==
6977 NumRows->getZExtValue() * N->getZExtValue(),
6978 "First argument of a matrix operation does not match specified "
6979 "shape!");
6980 Check(Op1Ty->getNumElements() ==
6981 N->getZExtValue() * NumColumns->getZExtValue(),
6982 "Second argument of a matrix operation does not match specified "
6983 "shape!");
6984
6985 ResultTy = RetTy;
6986 Op0ElemTy = Op0Ty->getElementType();
6987 Op1ElemTy = Op1Ty->getElementType();
6988 break;
6989 }
6990 case Intrinsic::matrix_transpose: {
6991 NumRows = cast<ConstantInt>(Call.getArgOperand(1));
6992 NumColumns = cast<ConstantInt>(Call.getArgOperand(2));
6994 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
6995 Check(Op0Ty && RetTy, "Matrix operations require fixed-length vectors!",
6996 &Call);
6997 ResultTy = RetTy;
6998 Op0ElemTy = Op0Ty->getElementType();
6999 break;
7000 }
7001 case Intrinsic::matrix_column_major_load: {
7002 Stride = Call.getArgOperand(1);
7003 NumRows = cast<ConstantInt>(Call.getArgOperand(3));
7004 NumColumns = cast<ConstantInt>(Call.getArgOperand(4));
7005 auto *RetTy = dyn_cast<FixedVectorType>(Call.getType());
7006 Check(RetTy, "Matrix operations require fixed-length vectors!", &Call);
7007 ResultTy = RetTy;
7008 break;
7009 }
7010 case Intrinsic::matrix_column_major_store: {
7011 Stride = Call.getArgOperand(2);
7012 NumRows = cast<ConstantInt>(Call.getArgOperand(4));
7013 NumColumns = cast<ConstantInt>(Call.getArgOperand(5));
7015 Check(Op0Ty, "Matrix operations require fixed-length vectors!", &Call);
7016 ResultTy = Op0Ty;
7017 Op0ElemTy = Op0Ty->getElementType();
7018 break;
7019 }
7020 default:
7021 llvm_unreachable("unexpected intrinsic");
7022 }
7023
7024 Check(ResultTy->getElementType()->isIntegerTy() ||
7025 ResultTy->getElementType()->isFloatingPointTy(),
7026 "Result type must be an integer or floating-point type!", IF);
7027
7028 if (Op0ElemTy)
7029 Check(ResultTy->getElementType() == Op0ElemTy,
7030 "Vector element type mismatch of the result and first operand "
7031 "vector!",
7032 IF);
7033
7034 if (Op1ElemTy)
7035 Check(ResultTy->getElementType() == Op1ElemTy,
7036 "Vector element type mismatch of the result and second operand "
7037 "vector!",
7038 IF);
7039
7040 Check(ResultTy->getNumElements() ==
7041 NumRows->getZExtValue() * NumColumns->getZExtValue(),
7042 "Result of a matrix operation does not fit in the returned vector!");
7043
7044 if (Stride)
7045 Check(Stride->getType()->getIntegerBitWidth() <= 64,
7046 "Stride bitwidth cannot exceed 64!", IF);
7047
7048 break;
7049 }
7050 case Intrinsic::stepvector: {
7051 auto *VecTy = cast<VectorType>(Call.getType());
7052 Check(VecTy->getScalarSizeInBits() >= 8,
7053 "stepvector only supported for vectors of integers "
7054 "with a bitwidth of at least 8.",
7055 &Call);
7056 break;
7057 }
7058 case Intrinsic::experimental_vector_match: {
7059 Value *Op1 = Call.getArgOperand(0);
7060 Value *Op2 = Call.getArgOperand(1);
7061
7062 auto *Op1Ty = cast<VectorType>(Op1->getType());
7063 auto *Op2Ty = cast<VectorType>(Op2->getType());
7064
7066 "Second operand must be a fixed length vector.", &Call);
7067 Check(Op1Ty->getElementType() == Op2Ty->getElementType(),
7068 "First two operands must have the same element type.", &Call);
7069 break;
7070 }
7071 case Intrinsic::speculative_load: {
7072 Type *LoadTy = Call.getType();
7073 Check(LoadTy->isByteTy() || LoadTy->isVectorTy(),
7074 "llvm.speculative.load return type must be a byte type or a "
7075 "vector type",
7076 &Call);
7077 if (LoadTy->isByteOrByteVectorTy()) {
7078 unsigned BitWidth = LoadTy->getScalarType()->getByteBitWidth();
7079 Check((BitWidth % 8) == 0,
7080 "llvm.speculative.load byte type must have a bit width that is "
7081 "a multiple of 8",
7082 &Call);
7083 }
7084
7085 uint64_t MinSizeInBits = DL.getTypeSizeInBits(LoadTy).getKnownMinValue();
7086 Check((MinSizeInBits % 8) == 0 && isPowerOf2_64(MinSizeInBits / 8),
7087 "llvm.speculative.load return type size in bytes must be a "
7088 "positive power of 2",
7089 &Call);
7090
7091 constexpr unsigned NumFixedArgs = 3;
7092 unsigned NumArgs = Call.arg_size();
7093 Check(NumArgs >= NumFixedArgs,
7094 "llvm.speculative.load requires at least 3 arguments", &Call);
7095
7096 Value *PayloadArg = Call.getArgOperand(NumFixedArgs - 1);
7097 if (PayloadArg->getType()->isIntegerTy(64)) {
7098 // Direct form: (ptr, i1 from_end, i64 num_accessible_bytes)
7099 Check(NumArgs == NumFixedArgs,
7100 "llvm.speculative.load direct form has too many arguments", &Call);
7101 } else {
7102 // Oracle form: (ptr, i1 from_end, oracle_fn_ptr, args...)
7103 auto *OracleFn = dyn_cast<Function>(PayloadArg);
7104 Check(OracleFn,
7105 "llvm.speculative.load third argument must be i64 or a direct "
7106 "reference to an oracle function",
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:526
static void forEachUser(const Value *User, SmallPtrSet< const Value *, 32 > &Visited, llvm::function_ref< bool(const Value *)> Callback)
Definition Verifier.cpp:567
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:972
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:6151
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:6134
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:446
iterator_range< const_phi_iterator > phis() const
Returns a range that iterates over the phis in the basic block.
Definition BasicBlock.h:515
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:469
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:68
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
static LLVM_ABI MetadataAsValue * getIfExists(LLVMContext &Context, Metadata *MD)
Definition Metadata.cpp:115
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.
@ System
Synchronized with respect to all concurrently executing threads.
Definition LLVMContext.h:58
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:193
SmallVector< DbgVariableRecord * > getAssignmentMarkers(DIAssignID *ID)
Definition DebugInfo.h:205
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:383
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