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