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