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