blob: 1a22d37ba8af94320761acffe28d53d520824649 [file] [log] [blame]
Nick Lewyckyd489edf2012-02-25 07:20:06 +00001//===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chris Lattner3e6e3e62002-03-29 19:06:18 +000010// This file defines the function verifier interface, that can be used for some
Chris Lattner2f7c9632001-06-06 20:29:01 +000011// sanity checking of input to the system.
12//
Misha Brukman1c9de462004-06-24 21:47:35 +000013// Note that this does not provide full `Java style' security and verifications,
14// instead it just tries to ensure that code is well-formed.
Chris Lattner2f7c9632001-06-06 20:29:01 +000015//
Misha Brukman1c9de462004-06-24 21:47:35 +000016// * Both of a binary operator's parameters are of the same type
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000017// * Verify that the indices of mem access instructions match other operands
Misha Brukman1c9de462004-06-24 21:47:35 +000018// * Verify that arithmetic and other things are only performed on first-class
Chris Lattner8e72d6f2002-08-02 17:37:08 +000019// types. Verify that shifts & logicals only happen on integrals f.e.
Misha Brukman1c9de462004-06-24 21:47:35 +000020// * All of the constants in a switch statement are of the correct type
Chris Lattner8e72d6f2002-08-02 17:37:08 +000021// * The code is in valid SSA form
Misha Brukman1c9de462004-06-24 21:47:35 +000022// * It should be illegal to put a label into any other type (like a structure)
Chris Lattner2f7c9632001-06-06 20:29:01 +000023// or to return one. [except constant arrays!]
Nick Lewyckyf88c84f2008-03-28 06:46:51 +000024// * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
Chris Lattnerd02f08d2002-02-20 17:55:43 +000025// * PHI nodes must have an entry for each predecessor, with no extras.
Chris Lattner069a7952002-06-25 15:56:27 +000026// * PHI nodes must be the first thing in a basic block, all grouped together
Chris Lattner4cd9df82002-10-06 21:00:31 +000027// * PHI nodes must have at least one entry
Chris Lattner069a7952002-06-25 15:56:27 +000028// * All basic blocks should only end with terminator insts, not contain them
Chris Lattner3e6e3e62002-03-29 19:06:18 +000029// * The entry node to a function must not have predecessors
Misha Brukmanfa100532003-10-10 17:54:14 +000030// * All Instructions must be embedded into a basic block
Misha Brukman1c9de462004-06-24 21:47:35 +000031// * Functions cannot take a void-typed parameter
Chris Lattneraf95e582002-04-13 22:48:46 +000032// * Verify that a function's argument list agrees with it's declared type.
Chris Lattnerfbf5be52002-03-15 20:25:09 +000033// * It is illegal to specify a name for a void value.
Misha Brukmanfa100532003-10-10 17:54:14 +000034// * It is illegal to have a internal global value with no initializer
Chris Lattner486302a2002-04-12 18:20:49 +000035// * It is illegal to have a ret instruction that returns a value that does not
36// agree with the function return value type.
Chris Lattner338a4622002-05-08 19:49:50 +000037// * Function call argument types match the function prototype
Bill Wendlingfae14752011-08-12 20:24:12 +000038// * A landing pad is defined by a landingpad instruction, and can be jumped to
39// only by the unwind edge of an invoke instruction.
40// * A landingpad instruction must be the first non-PHI instruction in the
41// block.
Vedant Kumar029c3512015-10-21 20:33:31 +000042// * Landingpad instructions must be in a function with a personality function.
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000043// * All other things that are tested by asserts spread about the code...
Chris Lattner2f7c9632001-06-06 20:29:01 +000044//
45//===----------------------------------------------------------------------===//
46
Chandler Carruth5ad5f152014-01-13 09:26:24 +000047#include "llvm/IR/Verifier.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000048#include "llvm/ADT/STLExtras.h"
49#include "llvm/ADT/SetVector.h"
50#include "llvm/ADT/SmallPtrSet.h"
51#include "llvm/ADT/SmallVector.h"
52#include "llvm/ADT/StringExtras.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000053#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000054#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000055#include "llvm/IR/CallingConv.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000056#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000057#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000058#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000059#include "llvm/IR/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000060#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000061#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000062#include "llvm/IR/InlineAsm.h"
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +000063#include "llvm/IR/InstIterator.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000064#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000065#include "llvm/IR/IntrinsicInst.h"
66#include "llvm/IR/LLVMContext.h"
67#include "llvm/IR/Metadata.h"
68#include "llvm/IR/Module.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000069#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000070#include "llvm/IR/Statepoint.h"
Chris Lattner8a923e72008-03-12 17:45:29 +000071#include "llvm/Pass.h"
Manman Ren74c61b92013-07-19 00:31:03 +000072#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000073#include "llvm/Support/Debug.h"
Torok Edwin6dd27302009-07-08 18:01:40 +000074#include "llvm/Support/ErrorHandling.h"
Chris Lattner24025262009-02-28 21:05:51 +000075#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000076#include <algorithm>
Jeff Cohene4535522006-03-31 07:22:05 +000077#include <cstdarg>
Chris Lattner189d19f2003-11-21 20:23:48 +000078using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000079
Duncan P. N. Exon Smith0633fd72015-03-17 17:28:41 +000080static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
Manman Ren74c61b92013-07-19 00:31:03 +000081
Dan Gohmand78c4002008-05-13 00:00:25 +000082namespace {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000083struct VerifierSupport {
Chandler Carruth043949d2014-01-19 02:22:18 +000084 raw_ostream &OS;
85 const Module *M;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000086
87 /// \brief Track the brokenness of the module while recursively visiting.
88 bool Broken;
89
90 explicit VerifierSupport(raw_ostream &OS)
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +000091 : OS(OS), M(nullptr), Broken(false) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000092
Benjamin Kramerf027ad72015-03-07 21:15:40 +000093private:
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +000094 template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
95 Write(&*I);
96 }
97
Keno Fischera6c4ce42015-12-01 19:06:36 +000098 void Write(const Module *M) {
99 if (!M)
100 return;
101 OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
102 }
103
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000104 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000105 if (!V)
106 return;
107 if (isa<Instruction>(V)) {
108 OS << *V << '\n';
109 } else {
110 V->printAsOperand(OS, true, M);
111 OS << '\n';
112 }
113 }
Philip Reames9818dd72015-06-26 22:04:34 +0000114 void Write(ImmutableCallSite CS) {
115 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000116 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000117
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000118 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000119 if (!MD)
120 return;
Duncan P. N. Exon Smithd6d70e72015-03-14 20:19:36 +0000121 MD->print(OS, M);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000122 OS << '\n';
123 }
124
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000125 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
126 Write(MD.get());
127 }
128
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000129 void Write(const NamedMDNode *NMD) {
130 if (!NMD)
131 return;
132 NMD->print(OS);
133 OS << '\n';
134 }
135
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000136 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000137 if (!T)
138 return;
139 OS << ' ' << *T;
140 }
141
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000142 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000143 if (!C)
144 return;
145 OS << *C;
146 }
147
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000148 template <typename T1, typename... Ts>
149 void WriteTs(const T1 &V1, const Ts &... Vs) {
150 Write(V1);
151 WriteTs(Vs...);
152 }
153
154 template <typename... Ts> void WriteTs() {}
155
156public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000157 /// \brief A check failed, so printout out the condition and the message.
158 ///
159 /// This provides a nice place to put a breakpoint if you want to see why
160 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000161 void CheckFailed(const Twine &Message) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000162 OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000163 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000164 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000165
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000166 /// \brief A check failed (with values to print).
167 ///
168 /// This calls the Message-only version so that the above is easier to set a
169 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000170 template <typename T1, typename... Ts>
171 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
172 CheckFailed(Message);
173 WriteTs(V1, Vs...);
174 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000175};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000176
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000177class Verifier : public InstVisitor<Verifier>, VerifierSupport {
178 friend class InstVisitor<Verifier>;
179
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000180 LLVMContext *Context;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000181 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000182
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000183 /// \brief When verifying a basic block, keep track of all of the
184 /// instructions we have seen so far.
185 ///
186 /// This allows us to do efficient dominance checks for the case when an
187 /// instruction has an operand that is an instruction in the same block.
188 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000189
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000190 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000191 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000192
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000193 /// \brief Track unresolved string-based type references.
194 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000195
David Majnemer654e1302015-07-31 17:58:14 +0000196 /// \brief The result type for a landingpad.
197 Type *LandingPadResultTy;
198
Reid Kleckner60381792015-07-07 22:25:32 +0000199 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000200 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000201 bool SawFrameEscape;
202
Reid Kleckner60381792015-07-07 22:25:32 +0000203 /// Stores the count of how many objects were passed to llvm.localescape for a
204 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000205 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000206
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000207 /// Cache of constants visited in search of ConstantExprs.
208 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
209
JF Bastiend1fb5852015-12-17 22:09:19 +0000210 void checkAtomicMemAccessSize(const Module *M, Type *Ty,
211 const Instruction *I);
Chandler Carruth043949d2014-01-19 02:22:18 +0000212public:
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +0000213 explicit Verifier(raw_ostream &OS)
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +0000214 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
David Majnemer654e1302015-07-31 17:58:14 +0000215 SawFrameEscape(false) {}
Chris Lattner0e851da2002-04-18 20:37:37 +0000216
Chandler Carruth043949d2014-01-19 02:22:18 +0000217 bool verify(const Function &F) {
218 M = F.getParent();
219 Context = &M->getContext();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000220
221 // First ensure the function is well-enough formed to compute dominance
222 // information.
Chandler Carruth043949d2014-01-19 02:22:18 +0000223 if (F.empty()) {
224 OS << "Function '" << F.getName()
225 << "' does not contain an entry block!\n";
226 return false;
227 }
228 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000229 if (I->empty() || !I->back().isTerminator()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000230 OS << "Basic Block in function '" << F.getName()
231 << "' does not have terminator!\n";
232 I->printAsOperand(OS, true);
233 OS << "\n";
234 return false;
Chandler Carruth76777602014-01-17 10:56:02 +0000235 }
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000236 }
Chandler Carruth76777602014-01-17 10:56:02 +0000237
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000238 // Now directly compute a dominance tree. We don't rely on the pass
239 // manager to provide this as it isolates us from a potentially
240 // out-of-date dominator tree and makes it significantly more complex to
241 // run this code outside of a pass manager.
Chandler Carruth043949d2014-01-19 02:22:18 +0000242 // FIXME: It's really gross that we have to cast away constness here.
243 DT.recalculate(const_cast<Function &>(F));
Chris Lattneraf332ee2007-04-20 23:59:29 +0000244
Chandler Carruth043949d2014-01-19 02:22:18 +0000245 Broken = false;
246 // FIXME: We strip const here because the inst visitor strips const.
247 visit(const_cast<Function &>(F));
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000248 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000249 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000250 SawFrameEscape = false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000251
Chandler Carruth043949d2014-01-19 02:22:18 +0000252 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000253 }
254
Chandler Carruth043949d2014-01-19 02:22:18 +0000255 bool verify(const Module &M) {
256 this->M = &M;
257 Context = &M.getContext();
Chandler Carruth043949d2014-01-19 02:22:18 +0000258 Broken = false;
259
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000260 // Scan through, checking all of the external function's linkage now...
Chandler Carruth043949d2014-01-19 02:22:18 +0000261 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000262 visitGlobalValue(*I);
263
264 // Check to make sure function prototypes are okay.
265 if (I->isDeclaration())
266 visitFunction(*I);
267 }
268
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000269 // Now that we've visited every function, verify that we never asked to
270 // recover a frame index that wasn't escaped.
271 verifyFrameRecoverIndices();
272
Chandler Carruth043949d2014-01-19 02:22:18 +0000273 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000274 I != E; ++I)
275 visitGlobalVariable(*I);
276
Chandler Carruth043949d2014-01-19 02:22:18 +0000277 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
278 I != E; ++I)
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000279 visitGlobalAlias(*I);
280
Chandler Carruth043949d2014-01-19 02:22:18 +0000281 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
282 E = M.named_metadata_end();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000283 I != E; ++I)
284 visitNamedMDNode(*I);
285
David Majnemerdad0a642014-06-27 18:19:56 +0000286 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
287 visitComdat(SMEC.getValue());
288
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000289 visitModuleFlags(M);
290 visitModuleIdents(M);
291
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000292 // Verify type referneces last.
293 verifyTypeRefs();
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000294
Chandler Carruth043949d2014-01-19 02:22:18 +0000295 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000296 }
Chris Lattner9713b842002-04-28 16:04:26 +0000297
Chandler Carruth043949d2014-01-19 02:22:18 +0000298private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000299 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000300 void visitGlobalValue(const GlobalValue &GV);
301 void visitGlobalVariable(const GlobalVariable &GV);
302 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000303 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000304 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000305 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000306 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000307 void visitMDNode(const MDNode &MD);
308 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
309 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000310 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000311 void visitModuleIdents(const Module &M);
312 void visitModuleFlags(const Module &M);
313 void visitModuleFlag(const MDNode *Op,
314 DenseMap<const MDString *, const MDNode *> &SeenIDs,
315 SmallVectorImpl<const MDNode *> &Requirements);
316 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000317 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000318 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000319 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000320
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000321 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000322#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
323#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000324 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000325 void visitDIVariable(const DIVariable &N);
326 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
327 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000328
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000329 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
330
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000331 /// \brief Check for a valid string-based type reference.
332 ///
333 /// Checks if \c MD is a string-based type reference. If it is, keeps track
334 /// of it (and its user, \c N) for error messages later.
335 bool isValidUUID(const MDNode &N, const Metadata *MD);
336
337 /// \brief Check for a valid type reference.
338 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000339 /// Checks for subclasses of \a DIType, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000340 bool isTypeRef(const MDNode &N, const Metadata *MD);
341
342 /// \brief Check for a valid scope reference.
343 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000344 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000345 bool isScopeRef(const MDNode &N, const Metadata *MD);
346
347 /// \brief Check for a valid debug info reference.
348 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000349 /// Checks for subclasses of \a DINode, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000350 bool isDIRef(const MDNode &N, const Metadata *MD);
351
Chandler Carruth043949d2014-01-19 02:22:18 +0000352 // InstVisitor overrides...
353 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000354 void visit(Instruction &I);
355
356 void visitTruncInst(TruncInst &I);
357 void visitZExtInst(ZExtInst &I);
358 void visitSExtInst(SExtInst &I);
359 void visitFPTruncInst(FPTruncInst &I);
360 void visitFPExtInst(FPExtInst &I);
361 void visitFPToUIInst(FPToUIInst &I);
362 void visitFPToSIInst(FPToSIInst &I);
363 void visitUIToFPInst(UIToFPInst &I);
364 void visitSIToFPInst(SIToFPInst &I);
365 void visitIntToPtrInst(IntToPtrInst &I);
366 void visitPtrToIntInst(PtrToIntInst &I);
367 void visitBitCastInst(BitCastInst &I);
368 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
369 void visitPHINode(PHINode &PN);
370 void visitBinaryOperator(BinaryOperator &B);
371 void visitICmpInst(ICmpInst &IC);
372 void visitFCmpInst(FCmpInst &FC);
373 void visitExtractElementInst(ExtractElementInst &EI);
374 void visitInsertElementInst(InsertElementInst &EI);
375 void visitShuffleVectorInst(ShuffleVectorInst &EI);
376 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
377 void visitCallInst(CallInst &CI);
378 void visitInvokeInst(InvokeInst &II);
379 void visitGetElementPtrInst(GetElementPtrInst &GEP);
380 void visitLoadInst(LoadInst &LI);
381 void visitStoreInst(StoreInst &SI);
382 void verifyDominatesUse(Instruction &I, unsigned i);
383 void visitInstruction(Instruction &I);
384 void visitTerminatorInst(TerminatorInst &I);
385 void visitBranchInst(BranchInst &BI);
386 void visitReturnInst(ReturnInst &RI);
387 void visitSwitchInst(SwitchInst &SI);
388 void visitIndirectBrInst(IndirectBrInst &BI);
389 void visitSelectInst(SelectInst &SI);
390 void visitUserOp1(Instruction &I);
391 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000392 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000393 template <class DbgIntrinsicTy>
394 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000395 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
396 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
397 void visitFenceInst(FenceInst &FI);
398 void visitAllocaInst(AllocaInst &AI);
399 void visitExtractValueInst(ExtractValueInst &EVI);
400 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000401 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000402 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemer654e1302015-07-31 17:58:14 +0000403 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000404 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000405 void visitCleanupPadInst(CleanupPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000406 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000407 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000408
409 void VerifyCallSite(CallSite CS);
Reid Kleckner5772b772014-04-24 20:14:34 +0000410 void verifyMustTailCall(CallInst &CI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000411 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
412 unsigned ArgNo, std::string &Suffix);
413 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
414 SmallVectorImpl<Type *> &ArgTys);
415 bool VerifyIntrinsicIsVarArg(bool isVarArg,
416 ArrayRef<Intrinsic::IITDescriptor> &Infos);
417 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
418 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
419 const Value *V);
420 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
421 bool isReturnValue, const Value *V);
422 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
423 const Value *V);
Diego Novillo2567f3d2015-05-13 15:13:45 +0000424 void VerifyFunctionMetadata(
425 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000426
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000427 void visitConstantExprsRecursively(const Constant *EntryC);
428 void visitConstantExpr(const ConstantExpr *CE);
Philip Reames0285c742015-02-03 23:18:47 +0000429 void VerifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000430 void verifyFrameRecoverIndices();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000431
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000432 // Module-level debug info verification...
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000433 void verifyTypeRefs();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000434 template <class MapTy>
435 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
436 const MapTy &TypeRefs);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000437 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000438};
Chris Lattner189d19f2003-11-21 20:23:48 +0000439} // End anonymous namespace
440
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000441// Assert - We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000442#define Assert(C, ...) \
443 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000444
Chris Lattnere5a22c02008-08-28 04:02:44 +0000445void Verifier::visit(Instruction &I) {
446 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000447 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000448 InstVisitor<Verifier>::visit(I);
449}
450
451
Chandler Carruth043949d2014-01-19 02:22:18 +0000452void Verifier::visitGlobalValue(const GlobalValue &GV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000453 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
454 GV.hasExternalWeakLinkage(),
455 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000456
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000457 Assert(GV.getAlignment() <= Value::MaximumAlignment,
458 "huge alignment values are unsupported", &GV);
459 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
460 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000461
462 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000463 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000464 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000465 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000466 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000467
468 if (GV.isDeclarationForLinker())
469 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000470}
471
Chandler Carruth043949d2014-01-19 02:22:18 +0000472void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000473 if (GV.hasInitializer()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000474 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
475 "Global variable initializer type does not match global "
476 "variable type!",
477 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000478
Chris Lattner0aff0b22009-08-05 05:41:44 +0000479 // If the global has common linkage, it must have a zero initializer and
480 // cannot be constant.
481 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000482 Assert(GV.getInitializer()->isNullValue(),
483 "'common' global must have a zero initializer!", &GV);
484 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
485 &GV);
486 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000487 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000488 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000489 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
490 "invalid linkage type for global declaration", &GV);
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000491 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000492
Nick Lewycky466d0c12011-04-08 07:30:21 +0000493 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
494 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000495 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
496 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000497 // Don't worry about emitting an error for it not being an array,
498 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000499 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000500 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
501 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000502 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000503 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000504 Assert(STy &&
505 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
506 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
507 STy->getTypeAtIndex(1) == FuncPtrTy,
508 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000509 if (STy->getNumElements() == 3) {
510 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000511 Assert(ETy->isPointerTy() &&
512 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
513 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000514 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000515 }
516 }
517
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000518 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000519 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000520 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
521 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000522 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000523 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
524 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000525 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000526 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000527 const Constant *Init = GV.getInitializer();
528 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000529 Assert(InitArray, "wrong initalizer for intrinsic global variable",
530 Init);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000531 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
Rafael Espindolaeaf53272013-05-27 22:47:09 +0000532 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000533 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
534 isa<GlobalAlias>(V),
535 "invalid llvm.used member", V);
536 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000537 }
538 }
539 }
540 }
541
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000542 Assert(!GV.hasDLLImportStorageClass() ||
543 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
544 GV.hasAvailableExternallyLinkage(),
545 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000546
Matt Arsenault24b49c42013-07-31 17:49:08 +0000547 if (!GV.hasInitializer()) {
548 visitGlobalValue(GV);
549 return;
550 }
551
552 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000553 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000554
Chris Lattnere3400652004-12-15 20:23:49 +0000555 visitGlobalValue(GV);
556}
557
Rafael Espindola64c1e182014-06-03 02:41:57 +0000558void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
559 SmallPtrSet<const GlobalAlias*, 4> Visited;
560 Visited.insert(&GA);
561 visitAliaseeSubExpr(Visited, GA, C);
562}
563
Craig Topper71b7b682014-08-21 05:55:13 +0000564void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000565 const GlobalAlias &GA, const Constant &C) {
566 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000567 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
568 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000569
570 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000571 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000572
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000573 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
574 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000575 } else {
576 // Only continue verifying subexpressions of GlobalAliases.
577 // Do not recurse into global initializers.
578 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000579 }
580 }
581
582 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000583 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000584
585 for (const Use &U : C.operands()) {
586 Value *V = &*U;
587 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
588 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
589 else if (const auto *C2 = dyn_cast<Constant>(V))
590 visitAliaseeSubExpr(Visited, GA, *C2);
591 }
592}
593
Chandler Carruth043949d2014-01-19 02:22:18 +0000594void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000595 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
596 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
597 "weak_odr, or external linkage!",
598 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000599 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000600 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
601 Assert(GA.getType() == Aliasee->getType(),
602 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000603
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000604 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
605 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000606
Rafael Espindola64c1e182014-06-03 02:41:57 +0000607 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000608
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000609 visitGlobalValue(GA);
610}
611
Chandler Carruth043949d2014-01-19 02:22:18 +0000612void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000613 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000614 MDNode *MD = NMD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000615
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000616 if (NMD.getName() == "llvm.dbg.cu") {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000617 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000618 }
619
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000620 if (!MD)
621 continue;
622
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000623 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000624 }
625}
626
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000627void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000628 // Only visit each node once. Metadata can be mutually recursive, so this
629 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000630 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000631 return;
632
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000633 switch (MD.getMetadataID()) {
634 default:
635 llvm_unreachable("Invalid MDNode subclass");
636 case Metadata::MDTupleKind:
637 break;
638#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
639 case Metadata::CLASS##Kind: \
640 visit##CLASS(cast<CLASS>(MD)); \
641 break;
642#include "llvm/IR/Metadata.def"
643 }
644
Duncan Sands76d62172010-04-29 16:10:30 +0000645 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000646 Metadata *Op = MD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000647 if (!Op)
648 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000649 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
650 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000651 if (auto *N = dyn_cast<MDNode>(Op)) {
652 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000653 continue;
654 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000655 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
656 visitValueAsMetadata(*V, nullptr);
657 continue;
658 }
Duncan Sands76d62172010-04-29 16:10:30 +0000659 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000660
661 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000662 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
663 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000664}
665
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000666void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000667 Assert(MD.getValue(), "Expected valid value", &MD);
668 Assert(!MD.getValue()->getType()->isMetadataTy(),
669 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000670
671 auto *L = dyn_cast<LocalAsMetadata>(&MD);
672 if (!L)
673 return;
674
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000675 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000676
677 // If this was an instruction, bb, or argument, verify that it is in the
678 // function that we expect.
679 Function *ActualF = nullptr;
680 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000681 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000682 ActualF = I->getParent()->getParent();
683 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
684 ActualF = BB->getParent();
685 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
686 ActualF = A->getParent();
687 assert(ActualF && "Unimplemented function local metadata case!");
688
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000689 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000690}
691
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000692void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000693 Metadata *MD = MDV.getMetadata();
694 if (auto *N = dyn_cast<MDNode>(MD)) {
695 visitMDNode(*N);
696 return;
697 }
698
699 // Only visit each node once. Metadata can be mutually recursive, so this
700 // avoids infinite recursion here, as well as being an optimization.
701 if (!MDNodes.insert(MD).second)
702 return;
703
704 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
705 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000706}
707
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000708bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
709 auto *S = dyn_cast<MDString>(MD);
710 if (!S)
711 return false;
712 if (S->getString().empty())
713 return false;
714
715 // Keep track of names of types referenced via UUID so we can check that they
716 // actually exist.
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000717 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000718 return true;
719}
720
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000721/// \brief Check if a value can be a reference to a type.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000722bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000723 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000724}
725
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000726/// \brief Check if a value can be a ScopeRef.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000727bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000728 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000729}
730
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000731/// \brief Check if a value can be a debug info ref.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000732bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000733 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000734}
735
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000736template <class Ty>
737bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
738 for (Metadata *MD : N.operands()) {
739 if (MD) {
740 if (!isa<Ty>(MD))
741 return false;
742 } else {
743 if (!AllowNull)
744 return false;
745 }
746 }
747 return true;
748}
749
750template <class Ty>
751bool isValidMetadataArray(const MDTuple &N) {
752 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
753}
754
755template <class Ty>
756bool isValidMetadataNullArray(const MDTuple &N) {
757 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
758}
759
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000760void Verifier::visitDILocation(const DILocation &N) {
761 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000762 "location requires a valid scope", &N, N.getRawScope());
763 if (auto *IA = N.getRawInlinedAt())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000764 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000765}
766
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000767void Verifier::visitGenericDINode(const GenericDINode &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000768 Assert(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000769}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000770
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000771void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000772 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000773 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000774}
775
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000776void Verifier::visitDISubrange(const DISubrange &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000777 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000778 Assert(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000779}
780
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000781void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000782 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000783}
784
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000785void Verifier::visitDIBasicType(const DIBasicType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000786 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
787 N.getTag() == dwarf::DW_TAG_unspecified_type,
788 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000789}
790
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000791void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000792 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000793 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000794
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000795 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
796 N.getTag() == dwarf::DW_TAG_pointer_type ||
797 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
798 N.getTag() == dwarf::DW_TAG_reference_type ||
799 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
800 N.getTag() == dwarf::DW_TAG_const_type ||
801 N.getTag() == dwarf::DW_TAG_volatile_type ||
802 N.getTag() == dwarf::DW_TAG_restrict_type ||
803 N.getTag() == dwarf::DW_TAG_member ||
804 N.getTag() == dwarf::DW_TAG_inheritance ||
805 N.getTag() == dwarf::DW_TAG_friend,
806 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000807 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000808 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
809 N.getExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000810 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000811
812 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
813 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
814 N.getBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000815}
816
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000817static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000818 return (Flags & DINode::FlagLValueReference) &&
819 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000820}
821
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000822void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
823 auto *Params = dyn_cast<MDTuple>(&RawParams);
824 Assert(Params, "invalid template params", &N, &RawParams);
825 for (Metadata *Op : Params->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000826 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000827 Params, Op);
828 }
829}
830
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000831void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000832 // Common scope checks.
833 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000834
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000835 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
836 N.getTag() == dwarf::DW_TAG_structure_type ||
837 N.getTag() == dwarf::DW_TAG_union_type ||
838 N.getTag() == dwarf::DW_TAG_enumeration_type ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000839 N.getTag() == dwarf::DW_TAG_class_type,
840 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000841
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000842 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
843 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
844 N.getBaseType());
845
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000846 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
847 "invalid composite elements", &N, N.getRawElements());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000848 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000849 N.getRawVTableHolder());
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000850 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
851 &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000852 if (auto *Params = N.getRawTemplateParams())
853 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000854
855 if (N.getTag() == dwarf::DW_TAG_class_type ||
856 N.getTag() == dwarf::DW_TAG_union_type) {
857 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
858 "class/union requires a filename", &N, N.getFile());
859 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000860}
861
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000862void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000863 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000864 if (auto *Types = N.getRawTypeArray()) {
865 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
866 for (Metadata *Ty : N.getTypeArray()->operands()) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000867 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000868 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000869 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000870 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
871 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000872}
873
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000874void Verifier::visitDIFile(const DIFile &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000875 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000876}
877
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000878void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000879 Assert(N.isDistinct(), "compile units must be distinct", &N);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000880 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000881
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000882 // Don't bother verifying the compilation directory or producer string
883 // as those could be empty.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000884 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
885 N.getRawFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000886 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
887 N.getFile());
888
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000889 if (auto *Array = N.getRawEnumTypes()) {
890 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
891 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000892 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000893 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
894 "invalid enum type", &N, N.getEnumTypes(), Op);
895 }
896 }
897 if (auto *Array = N.getRawRetainedTypes()) {
898 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
899 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000900 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000901 }
902 }
903 if (auto *Array = N.getRawSubprograms()) {
904 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
905 for (Metadata *Op : N.getSubprograms()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000906 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000907 }
908 }
909 if (auto *Array = N.getRawGlobalVariables()) {
910 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
911 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000912 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000913 Op);
914 }
915 }
916 if (auto *Array = N.getRawImportedEntities()) {
917 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
918 for (Metadata *Op : N.getImportedEntities()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000919 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000920 Op);
921 }
922 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000923 if (auto *Array = N.getRawMacros()) {
924 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
925 for (Metadata *Op : N.getMacros()->operands()) {
926 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
927 }
928 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000929}
930
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000931void Verifier::visitDISubprogram(const DISubprogram &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000932 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000933 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000934 if (auto *T = N.getRawType())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000935 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000936 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000937 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000938 if (auto *Params = N.getRawTemplateParams())
939 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000940 if (auto *S = N.getRawDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000941 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000942 "invalid subprogram declaration", &N, S);
943 }
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000944 if (auto *RawVars = N.getRawVariables()) {
945 auto *Vars = dyn_cast<MDTuple>(RawVars);
946 Assert(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000947 for (Metadata *Op : Vars->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000948 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000949 Op);
950 }
951 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000952 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
953 &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +0000954
Duncan P. N. Exon Smith814b8e92015-08-28 20:26:49 +0000955 if (N.isDefinition())
956 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000957}
958
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000959void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000960 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000961 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +0000962 "invalid local scope", &N, N.getRawScope());
963}
964
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000965void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
966 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +0000967
968 Assert(N.getLine() || !N.getColumn(),
969 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000970}
971
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000972void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
973 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000974}
975
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000976void Verifier::visitDINamespace(const DINamespace &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000977 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000978 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000979 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000980}
981
Amjad Abouda9bcf162015-12-10 12:56:35 +0000982void Verifier::visitDIMacro(const DIMacro &N) {
983 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
984 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
985 "invalid macinfo type", &N);
986 Assert(!N.getName().empty(), "anonymous macro", &N);
987}
988
989void Verifier::visitDIMacroFile(const DIMacroFile &N) {
990 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
991 "invalid macinfo type", &N);
992 if (auto *F = N.getRawFile())
993 Assert(isa<DIFile>(F), "invalid file", &N, F);
994
995 if (auto *Array = N.getRawElements()) {
996 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
997 for (Metadata *Op : N.getElements()->operands()) {
998 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
999 }
1000 }
1001}
1002
Adrian Prantlab1243f2015-06-29 23:03:47 +00001003void Verifier::visitDIModule(const DIModule &N) {
1004 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1005 Assert(!N.getName().empty(), "anonymous module", &N);
1006}
1007
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001008void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001009 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001010}
1011
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001012void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1013 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001014
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001015 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1016 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001017}
1018
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001019void Verifier::visitDITemplateValueParameter(
1020 const DITemplateValueParameter &N) {
1021 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001022
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001023 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1024 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1025 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1026 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001027}
1028
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001029void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001030 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001031 Assert(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001032 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001033 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001034 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001035}
1036
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001037void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001038 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001039 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001040
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001041 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smith94d58f82015-03-31 01:28:22 +00001042 Assert(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001043 if (auto *V = N.getRawVariable()) {
1044 Assert(isa<ConstantAsMetadata>(V) &&
1045 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1046 "invalid global varaible ref", &N, V);
1047 }
1048 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001049 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001050 &N, Member);
1051 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001052}
1053
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001054void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001055 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001056 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001057
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +00001058 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001059 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001060 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001061}
1062
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001063void Verifier::visitDIExpression(const DIExpression &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001064 Assert(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001065}
1066
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001067void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001068 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001069 if (auto *T = N.getRawType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001070 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001071 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001072 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001073}
1074
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001075void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001076 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1077 N.getTag() == dwarf::DW_TAG_imported_declaration,
1078 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001079 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001080 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001081 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1082 N.getEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001083}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001084
David Majnemerdad0a642014-06-27 18:19:56 +00001085void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001086 // The Module is invalid if the GlobalValue has private linkage. Entities
1087 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001088 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001089 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1090 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001091}
1092
Chandler Carruth043949d2014-01-19 02:22:18 +00001093void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001094 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1095 if (!Idents)
1096 return;
1097
1098 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1099 // Scan each llvm.ident entry and make sure that this requirement is met.
1100 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001101 const MDNode *N = Idents->getOperand(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001102 Assert(N->getNumOperands() == 1,
1103 "incorrect number of operands in llvm.ident metadata", N);
1104 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1105 ("invalid value for llvm.ident metadata entry operand"
1106 "(the operand should be a string)"),
1107 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001108 }
1109}
1110
Chandler Carruth043949d2014-01-19 02:22:18 +00001111void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001112 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1113 if (!Flags) return;
1114
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001115 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001116 DenseMap<const MDString*, const MDNode*> SeenIDs;
1117 SmallVector<const MDNode*, 16> Requirements;
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001118 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001119 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001120 }
1121
1122 // Validate that the requirements in the module are valid.
1123 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001124 const MDNode *Requirement = Requirements[I];
1125 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001126 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001127
Chandler Carruth043949d2014-01-19 02:22:18 +00001128 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001129 if (!Op) {
1130 CheckFailed("invalid requirement on flag, flag is not present in module",
1131 Flag);
1132 continue;
1133 }
1134
1135 if (Op->getOperand(2) != ReqValue) {
1136 CheckFailed(("invalid requirement on flag, "
1137 "flag does not have the required value"),
1138 Flag);
1139 continue;
1140 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001141 }
1142}
1143
Chandler Carruth043949d2014-01-19 02:22:18 +00001144void
1145Verifier::visitModuleFlag(const MDNode *Op,
1146 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1147 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001148 // Each module flag should have three arguments, the merge behavior (a
1149 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001150 Assert(Op->getNumOperands() == 3,
1151 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001152 Module::ModFlagBehavior MFB;
1153 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001154 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001155 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001156 "invalid behavior operand in module flag (expected constant integer)",
1157 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001158 Assert(false,
1159 "invalid behavior operand in module flag (unexpected constant)",
1160 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001161 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001162 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001163 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1164 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001165
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001166 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001167 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001168 case Module::Error:
1169 case Module::Warning:
1170 case Module::Override:
1171 // These behavior types accept any value.
1172 break;
1173
1174 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001175 // The value should itself be an MDNode with two operands, a flag ID (an
1176 // MDString), and a value.
1177 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001178 Assert(Value && Value->getNumOperands() == 2,
1179 "invalid value for 'require' module flag (expected metadata pair)",
1180 Op->getOperand(2));
1181 Assert(isa<MDString>(Value->getOperand(0)),
1182 ("invalid value for 'require' module flag "
1183 "(first value operand should be a string)"),
1184 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001185
1186 // Append it to the list of requirements, to check once all module flags are
1187 // scanned.
1188 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001189 break;
1190 }
1191
1192 case Module::Append:
1193 case Module::AppendUnique: {
1194 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001195 Assert(isa<MDNode>(Op->getOperand(2)),
1196 "invalid value for 'append'-type module flag "
1197 "(expected a metadata node)",
1198 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001199 break;
1200 }
1201 }
1202
1203 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001204 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001205 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001206 Assert(Inserted,
1207 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001208 }
1209}
1210
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001211void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001212 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001213 unsigned Slot = ~0U;
1214 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1215 if (Attrs.getSlotIndex(I) == Idx) {
1216 Slot = I;
1217 break;
1218 }
1219
1220 assert(Slot != ~0U && "Attribute set inconsistency!");
1221
1222 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1223 I != E; ++I) {
1224 if (I->isStringAttribute())
1225 continue;
1226
1227 if (I->getKindAsEnum() == Attribute::NoReturn ||
1228 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001229 I->getKindAsEnum() == Attribute::NoInline ||
1230 I->getKindAsEnum() == Attribute::AlwaysInline ||
1231 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1232 I->getKindAsEnum() == Attribute::StackProtect ||
1233 I->getKindAsEnum() == Attribute::StackProtectReq ||
1234 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001235 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001236 I->getKindAsEnum() == Attribute::NoRedZone ||
1237 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1238 I->getKindAsEnum() == Attribute::Naked ||
1239 I->getKindAsEnum() == Attribute::InlineHint ||
1240 I->getKindAsEnum() == Attribute::StackAlignment ||
1241 I->getKindAsEnum() == Attribute::UWTable ||
1242 I->getKindAsEnum() == Attribute::NonLazyBind ||
1243 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1244 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1245 I->getKindAsEnum() == Attribute::SanitizeThread ||
1246 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1247 I->getKindAsEnum() == Attribute::MinSize ||
1248 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001249 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001250 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001251 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001252 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001253 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001254 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001255 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001256 I->getKindAsEnum() == Attribute::NoRecurse ||
1257 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1258 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001259 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001260 CheckFailed("Attribute '" + I->getAsString() +
1261 "' only applies to functions!", V);
1262 return;
1263 }
1264 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1265 I->getKindAsEnum() == Attribute::ReadNone) {
1266 if (Idx == 0) {
1267 CheckFailed("Attribute '" + I->getAsString() +
1268 "' does not apply to function returns");
1269 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001270 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001271 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001272 CheckFailed("Attribute '" + I->getAsString() +
1273 "' does not apply to functions!", V);
1274 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001275 }
1276 }
1277}
1278
Duncan Sandsc3a79922009-06-11 08:11:03 +00001279// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001280// value of the specified type. The value V is printed in error messages.
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001281void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001282 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001283 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001284 return;
1285
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001286 VerifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001287
Bill Wendling908126a2012-10-09 09:51:10 +00001288 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001289 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1290 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1291 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1292 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1293 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1294 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1295 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1296 "'returned' do not apply to return values!",
1297 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001298
Reid Klecknera534a382013-12-19 02:14:12 +00001299 // Check for mutually incompatible attributes. Only inreg is compatible with
1300 // sret.
1301 unsigned AttrCount = 0;
1302 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1303 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1304 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1305 Attrs.hasAttribute(Idx, Attribute::InReg);
1306 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001307 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1308 "and 'sret' are incompatible!",
1309 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001310
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001311 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1312 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1313 "Attributes "
1314 "'inalloca and readonly' are incompatible!",
1315 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001316
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001317 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1318 Attrs.hasAttribute(Idx, Attribute::Returned)),
1319 "Attributes "
1320 "'sret and returned' are incompatible!",
1321 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001322
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001323 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1324 Attrs.hasAttribute(Idx, Attribute::SExt)),
1325 "Attributes "
1326 "'zeroext and signext' are incompatible!",
1327 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001328
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001329 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1330 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1331 "Attributes "
1332 "'readnone and readonly' are incompatible!",
1333 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001334
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001335 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1336 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1337 "Attributes "
1338 "'noinline and alwaysinline' are incompatible!",
1339 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001340
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001341 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001342 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001343 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001344 AttributeSet::get(*Context, Idx,
1345 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001346 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001347
Reid Klecknera534a382013-12-19 02:14:12 +00001348 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001349 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001350 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001351 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1352 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1353 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1354 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001355 }
1356 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001357 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1358 "Attribute 'byval' only applies to parameters with pointer type!",
1359 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001360 }
Duncan Sands0009c442008-01-12 16:42:01 +00001361}
1362
1363// VerifyFunctionAttrs - Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001364// The value V is printed in error messages.
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001365void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001366 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001367 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001368 return;
1369
Duncan Sands8c582282007-12-21 19:19:01 +00001370 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001371 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001372 bool SawSRet = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001373
Chris Lattner8a923e72008-03-12 17:45:29 +00001374 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001375 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001376
Chris Lattner229907c2011-07-18 04:54:35 +00001377 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001378 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001379 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001380 else if (Idx-1 < FT->getNumParams())
1381 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001382 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001383 break; // VarArgs attributes, verified elsewhere.
1384
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001385 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001386
Stephen Linb8bd2322013-04-20 05:14:40 +00001387 if (Idx == 0)
1388 continue;
1389
1390 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001391 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001392 SawNest = true;
1393 }
1394
Stephen Linb8bd2322013-04-20 05:14:40 +00001395 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001396 Assert(!SawReturned, "More than one parameter has attribute returned!",
1397 V);
1398 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1399 "Incompatible "
1400 "argument and return types for 'returned' attribute",
1401 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001402 SawReturned = true;
1403 }
1404
Reid Kleckner79418562014-05-09 22:32:13 +00001405 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001406 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1407 Assert(Idx == 1 || Idx == 2,
1408 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001409 SawSRet = true;
1410 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001411
1412 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001413 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1414 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001415 }
Duncan Sands8c582282007-12-21 19:19:01 +00001416 }
Devang Patel9cc98122008-10-01 23:41:25 +00001417
Bill Wendling77543892013-01-18 21:11:39 +00001418 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1419 return;
1420
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001421 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001422
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001423 Assert(
1424 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1425 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1426 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001427
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001428 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001429 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1430 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1431 Attribute::InaccessibleMemOrArgMemOnly)),
1432 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1433
1434 Assert(
1435 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1436 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1437 Attribute::InaccessibleMemOnly)),
1438 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1439
1440 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001441 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1442 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1443 Attribute::AlwaysInline)),
1444 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001445
1446 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1447 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001448 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1449 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001450
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001451 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1452 Attribute::OptimizeForSize),
1453 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001454
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001455 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1456 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001457 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001458
1459 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1460 Attribute::JumpTable)) {
1461 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001462 Assert(GV->hasUnnamedAddr(),
1463 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001464 }
Duncan Sands8c582282007-12-21 19:19:01 +00001465}
1466
Diego Novillo2567f3d2015-05-13 15:13:45 +00001467void Verifier::VerifyFunctionMetadata(
1468 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1469 if (MDs.empty())
1470 return;
1471
1472 for (unsigned i = 0; i < MDs.size(); i++) {
1473 if (MDs[i].first == LLVMContext::MD_prof) {
1474 MDNode *MD = MDs[i].second;
1475 Assert(MD->getNumOperands() == 2,
1476 "!prof annotations should have exactly 2 operands", MD);
1477
1478 // Check first operand.
1479 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1480 MD);
1481 Assert(isa<MDString>(MD->getOperand(0)),
1482 "expected string with name of the !prof annotation", MD);
1483 MDString *MDS = cast<MDString>(MD->getOperand(0));
1484 StringRef ProfName = MDS->getString();
1485 Assert(ProfName.equals("function_entry_count"),
1486 "first operand should be 'function_entry_count'", MD);
1487
1488 // Check second operand.
1489 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1490 MD);
1491 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1492 "expected integer argument to function_entry_count", MD);
1493 }
1494 }
1495}
1496
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001497void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1498 if (!ConstantExprVisited.insert(EntryC).second)
1499 return;
1500
1501 SmallVector<const Constant *, 16> Stack;
1502 Stack.push_back(EntryC);
1503
1504 while (!Stack.empty()) {
1505 const Constant *C = Stack.pop_back_val();
1506
1507 // Check this constant expression.
1508 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1509 visitConstantExpr(CE);
1510
1511 // Visit all sub-expressions.
1512 for (const Use &U : C->operands()) {
1513 const auto *OpC = dyn_cast<Constant>(U);
1514 if (!OpC)
1515 continue;
1516 if (isa<GlobalValue>(OpC))
1517 continue; // Global values get visited separately.
1518 if (!ConstantExprVisited.insert(OpC).second)
1519 continue;
1520 Stack.push_back(OpC);
1521 }
1522 }
1523}
1524
1525void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001526 if (CE->getOpcode() != Instruction::BitCast)
1527 return;
1528
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001529 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1530 CE->getType()),
1531 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001532}
1533
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001534bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001535 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001536 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001537
Devang Patel82fed672008-09-23 22:35:17 +00001538 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001539 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001540 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001541 || (LastIndex == AttributeSet::FunctionIndex
1542 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001543 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001544
Devang Patel82fed672008-09-23 22:35:17 +00001545 return false;
1546}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001547
Philip Reames1ffa9372015-01-30 23:28:05 +00001548/// \brief Verify that statepoint intrinsic is well formed.
Philip Reames0285c742015-02-03 23:18:47 +00001549void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1550 assert(CS.getCalledFunction() &&
1551 CS.getCalledFunction()->getIntrinsicID() ==
1552 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001553
Philip Reames0285c742015-02-03 23:18:47 +00001554 const Instruction &CI = *CS.getInstruction();
1555
Igor Laevsky39d662f2015-07-11 10:30:36 +00001556 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1557 !CS.onlyAccessesArgMemory(),
1558 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001559 "reordering restrictions required by safepoint semantics",
1560 &CI);
1561
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001562 const Value *IDV = CS.getArgument(0);
1563 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1564 &CI);
1565
1566 const Value *NumPatchBytesV = CS.getArgument(1);
1567 Assert(isa<ConstantInt>(NumPatchBytesV),
1568 "gc.statepoint number of patchable bytes must be a constant integer",
1569 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001570 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001571 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1572 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1573 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1574 "positive",
1575 &CI);
1576
1577 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001578 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001579 Assert(PT && PT->getElementType()->isFunctionTy(),
1580 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001581 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001582
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001583 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001584 Assert(isa<ConstantInt>(NumCallArgsV),
1585 "gc.statepoint number of arguments to underlying call "
1586 "must be constant integer",
1587 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001588 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001589 Assert(NumCallArgs >= 0,
1590 "gc.statepoint number of arguments to underlying call "
1591 "must be positive",
1592 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001593 const int NumParams = (int)TargetFuncType->getNumParams();
1594 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001595 Assert(NumCallArgs >= NumParams,
1596 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001597
1598 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001599 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1600 "gc.statepoint doesn't support wrapping non-void "
1601 "vararg functions yet",
1602 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001603 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001604 Assert(NumCallArgs == NumParams,
1605 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001606
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001607 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001608 Assert(isa<ConstantInt>(FlagsV),
1609 "gc.statepoint flags must be constant integer", &CI);
1610 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1611 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1612 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001613
1614 // Verify that the types of the call parameter arguments match
1615 // the type of the wrapped callee.
1616 for (int i = 0; i < NumParams; i++) {
1617 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001618 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001619 Assert(ArgType == ParamType,
1620 "gc.statepoint call argument does not match wrapped "
1621 "function type",
1622 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001623 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001624
1625 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001626
1627 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1628 Assert(isa<ConstantInt>(NumTransitionArgsV),
1629 "gc.statepoint number of transition arguments "
1630 "must be constant integer",
1631 &CI);
1632 const int NumTransitionArgs =
1633 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1634 Assert(NumTransitionArgs >= 0,
1635 "gc.statepoint number of transition arguments must be positive", &CI);
1636 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1637
1638 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001639 Assert(isa<ConstantInt>(NumDeoptArgsV),
1640 "gc.statepoint number of deoptimization arguments "
1641 "must be constant integer",
1642 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001643 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001644 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1645 "must be positive",
1646 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001647
Pat Gavlincc0431d2015-05-08 18:07:42 +00001648 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001649 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001650 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001651 "gc.statepoint too few arguments according to length fields", &CI);
1652
Philip Reames1ffa9372015-01-30 23:28:05 +00001653 // Check that the only uses of this gc.statepoint are gc.result or
1654 // gc.relocate calls which are tied to this statepoint and thus part
1655 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001656 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001657 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001658 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001659 if (!Call) continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001660 Assert(isGCRelocate(Call) || isGCResult(Call),
1661 "gc.result or gc.relocate are the only value uses"
1662 "of a gc.statepoint",
1663 &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001664 if (isGCResult(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001665 Assert(Call->getArgOperand(0) == &CI,
1666 "gc.result connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001667 } else if (isGCRelocate(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001668 Assert(Call->getArgOperand(0) == &CI,
1669 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001670 }
1671 }
1672
1673 // Note: It is legal for a single derived pointer to be listed multiple
1674 // times. It's non-optimal, but it is legal. It can also happen after
1675 // insertion if we strip a bitcast away.
1676 // Note: It is really tempting to check that each base is relocated and
1677 // that a derived pointer is never reused as a base pointer. This turns
1678 // out to be problematic since optimizations run after safepoint insertion
1679 // can recognize equality properties that the insertion logic doesn't know
1680 // about. See example statepoint.ll in the verifier subdirectory
1681}
1682
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001683void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001684 for (auto &Counts : FrameEscapeInfo) {
1685 Function *F = Counts.first;
1686 unsigned EscapedObjectCount = Counts.second.first;
1687 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001688 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001689 "all indices passed to llvm.localrecover must be less than the "
1690 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001691 "function",
1692 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001693 }
1694}
1695
Chris Lattner0e851da2002-04-18 20:37:37 +00001696// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001697//
Chandler Carruth043949d2014-01-19 02:22:18 +00001698void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001699 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001700 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001701 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001702
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001703 Assert(Context == &F.getContext(),
1704 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001705
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001706 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1707 Assert(FT->getNumParams() == NumArgs,
1708 "# formal arguments must match # of arguments for function type!", &F,
1709 FT);
1710 Assert(F.getReturnType()->isFirstClassType() ||
1711 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1712 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001713
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001714 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1715 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001716
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001717 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001718
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001719 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1720 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001721
Duncan Sands8c582282007-12-21 19:19:01 +00001722 // Check function attributes.
Duncan Sands0009c442008-01-12 16:42:01 +00001723 VerifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001724
Michael Gottesman41748d72013-06-27 00:25:01 +00001725 // On function declarations/definitions, we do not support the builtin
1726 // attribute. We do not check this in VerifyFunctionAttrs since that is
1727 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001728 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1729 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001730
Chris Lattneref13ee32006-05-19 21:25:17 +00001731 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001732 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1733 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001734 switch (F.getCallingConv()) {
1735 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001736 case CallingConv::C:
1737 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001738 case CallingConv::Fast:
1739 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001740 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001741 case CallingConv::PTX_Kernel:
1742 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001743 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1744 "perfect forwarding!",
1745 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001746 break;
1747 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001748
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001749 bool isLLVMdotName = F.getName().size() >= 5 &&
1750 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001751
Chris Lattneraf95e582002-04-13 22:48:46 +00001752 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001753 unsigned i = 0;
Chandler Carruth043949d2014-01-19 02:22:18 +00001754 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1755 ++I, ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001756 Assert(I->getType() == FT->getParamType(i),
1757 "Argument value does not match function argument type!", I,
1758 FT->getParamType(i));
1759 Assert(I->getType()->isFirstClassType(),
1760 "Function arguments must have first-class types!", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00001761 if (!isLLVMdotName) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001762 Assert(!I->getType()->isMetadataTy(),
1763 "Function takes metadata but isn't an intrinsic", I, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001764 Assert(!I->getType()->isTokenTy(),
1765 "Function takes token but isn't an intrinsic", I, &F);
1766 }
Dan Gohman4051bf42008-08-27 14:44:57 +00001767 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001768
David Majnemerb611e3f2015-08-14 05:09:07 +00001769 if (!isLLVMdotName)
1770 Assert(!F.getReturnType()->isTokenTy(),
1771 "Functions returns a token but isn't an intrinsic", &F);
1772
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001773 // Get the function metadata attachments.
1774 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1775 F.getAllMetadata(MDs);
1776 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Diego Novillo2567f3d2015-05-13 15:13:45 +00001777 VerifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001778
Keno Fischer2ac0c272015-11-16 05:13:30 +00001779 // Check validity of the personality function
1780 if (F.hasPersonalityFn()) {
1781 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1782 if (Per)
1783 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001784 "Referencing personality function in another module!",
1785 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001786 }
1787
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001788 if (F.isMaterializable()) {
1789 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001790 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1791 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001792 } else if (F.isDeclaration()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001793 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1794 "invalid linkage type for function declaration", &F);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001795 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1796 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001797 Assert(!F.hasPersonalityFn(),
1798 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001799 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001800 // Verify that this function (which has a body) is not named "llvm.*". It
1801 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001802 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001803
Chris Lattner149376d2002-10-13 20:57:00 +00001804 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001805 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001806 Assert(pred_empty(Entry),
1807 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001808
Chris Lattner27471742009-11-01 04:08:01 +00001809 // The address of the entry block cannot be taken, unless it is dead.
1810 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001811 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1812 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001813 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001814
1815 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001816 for (const auto &I : MDs) {
1817 // Verify that the attachment is legal.
1818 switch (I.first) {
1819 default:
1820 break;
1821 case LLVMContext::MD_dbg:
1822 Assert(isa<DISubprogram>(I.second),
1823 "function !dbg attachment must be a subprogram", &F, I.second);
1824 break;
1825 }
1826
1827 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001828 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001829 }
Chris Lattner149376d2002-10-13 20:57:00 +00001830 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001831
Chris Lattner7730dcc2009-09-11 17:05:29 +00001832 // If this function is actually an intrinsic, verify that it is only used in
1833 // direct call/invokes, never having its "address taken".
1834 if (F.getIntrinsicID()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001835 const User *U;
1836 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001837 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00001838 }
Nico Rieck7157bb72014-01-14 15:22:47 +00001839
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001840 Assert(!F.hasDLLImportStorageClass() ||
1841 (F.isDeclaration() && F.hasExternalLinkage()) ||
1842 F.hasAvailableExternallyLinkage(),
1843 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00001844
1845 auto *N = F.getSubprogram();
1846 if (!N)
1847 return;
1848
1849 // Check that all !dbg attachments lead to back to N (or, at least, another
1850 // subprogram that describes the same function).
1851 //
1852 // FIXME: Check this incrementally while visiting !dbg attachments.
1853 // FIXME: Only check when N is the canonical subprogram for F.
1854 SmallPtrSet<const MDNode *, 32> Seen;
1855 for (auto &BB : F)
1856 for (auto &I : BB) {
1857 // Be careful about using DILocation here since we might be dealing with
1858 // broken code (this is the Verifier after all).
1859 DILocation *DL =
1860 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1861 if (!DL)
1862 continue;
1863 if (!Seen.insert(DL).second)
1864 continue;
1865
1866 DILocalScope *Scope = DL->getInlinedAtScope();
1867 if (Scope && !Seen.insert(Scope).second)
1868 continue;
1869
1870 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00001871
1872 // Scope and SP could be the same MDNode and we don't want to skip
1873 // validation in that case
1874 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00001875 continue;
1876
1877 // FIXME: Once N is canonical, check "SP == &N".
1878 Assert(SP->describes(&F),
1879 "!dbg attachment points at wrong subprogram for function", N, &F,
1880 &I, DL, Scope, SP);
1881 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001882}
1883
Chris Lattner0e851da2002-04-18 20:37:37 +00001884// verifyBasicBlock - Verify that a basic block is well formed...
1885//
Chris Lattner069a7952002-06-25 15:56:27 +00001886void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00001887 InstsInThisBlock.clear();
1888
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00001889 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001890 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00001891
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001892 // Check constraints that this basic block imposes on all of the PHI nodes in
1893 // it.
1894 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00001895 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1896 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001897 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001898 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00001899 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001900 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001901 Assert(PN->getNumIncomingValues() != 0,
1902 "PHI nodes must have at least one entry. If the block is dead, "
1903 "the PHI should be removed!",
1904 PN);
1905 Assert(PN->getNumIncomingValues() == Preds.size(),
1906 "PHINode should have one entry for each predecessor of its "
1907 "parent basic block!",
1908 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001909
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001910 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00001911 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001912 Values.reserve(PN->getNumIncomingValues());
1913 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1914 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1915 PN->getIncomingValue(i)));
1916 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001917
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001918 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1919 // Check to make sure that if there is more than one entry for a
1920 // particular basic block in this PHI node, that the incoming values are
1921 // all identical.
1922 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001923 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1924 Values[i].second == Values[i - 1].second,
1925 "PHI node has multiple entries for the same basic block with "
1926 "different incoming values!",
1927 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001928
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001929 // Check to make sure that the predecessors and PHI node entries are
1930 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001931 Assert(Values[i].first == Preds[i],
1932 "PHI node entries do not match predecessors!", PN,
1933 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001934 }
1935 }
1936 }
Adrian Prantl940257f2014-11-21 00:39:43 +00001937
1938 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00001939 for (auto &I : BB)
1940 {
Adrian Prantl940257f2014-11-21 00:39:43 +00001941 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00001942 }
Chris Lattner069a7952002-06-25 15:56:27 +00001943}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00001944
Chris Lattner069a7952002-06-25 15:56:27 +00001945void Verifier::visitTerminatorInst(TerminatorInst &I) {
1946 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001947 Assert(&I == I.getParent()->getTerminator(),
1948 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00001949 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00001950}
1951
Nick Lewycky1d9a8152010-02-15 22:09:09 +00001952void Verifier::visitBranchInst(BranchInst &BI) {
1953 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001954 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1955 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00001956 }
1957 visitTerminatorInst(BI);
1958}
1959
Chris Lattner069a7952002-06-25 15:56:27 +00001960void Verifier::visitReturnInst(ReturnInst &RI) {
1961 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00001962 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001963 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001964 Assert(N == 0,
1965 "Found return instr that returns non-void in Function of void "
1966 "return type!",
1967 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00001968 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001969 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1970 "Function return type does not match operand "
1971 "type of return inst!",
1972 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00001973
Misha Brukman7eb05a12003-08-18 14:43:39 +00001974 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00001975 // terminators...
1976 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001977}
1978
Chris Lattnerab5aa142004-05-21 16:47:21 +00001979void Verifier::visitSwitchInst(SwitchInst &SI) {
1980 // Check to make sure that all of the constants in the switch instruction
1981 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00001982 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00001983 SmallPtrSet<ConstantInt*, 32> Constants;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00001984 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001985 Assert(i.getCaseValue()->getType() == SwitchTy,
1986 "Switch constants must all be same type as switch value!", &SI);
1987 Assert(Constants.insert(i.getCaseValue()).second,
1988 "Duplicate integer as switch case", &SI, i.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00001989 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001990
Chris Lattnerab5aa142004-05-21 16:47:21 +00001991 visitTerminatorInst(SI);
1992}
1993
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00001994void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001995 Assert(BI.getAddress()->getType()->isPointerTy(),
1996 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00001997 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001998 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1999 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002000
2001 visitTerminatorInst(BI);
2002}
2003
Chris Lattner75648e72004-03-12 05:54:31 +00002004void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002005 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2006 SI.getOperand(2)),
2007 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002008
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002009 Assert(SI.getTrueValue()->getType() == SI.getType(),
2010 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002011 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002012}
2013
Misha Brukmanc566ca362004-03-02 00:22:19 +00002014/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2015/// a pass, if any exist, it's an error.
2016///
Chris Lattner903a25d2002-11-21 16:54:22 +00002017void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002018 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002019}
Chris Lattner0e851da2002-04-18 20:37:37 +00002020
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002021void Verifier::visitTruncInst(TruncInst &I) {
2022 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002023 Type *SrcTy = I.getOperand(0)->getType();
2024 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002025
2026 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002027 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2028 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002029
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002030 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2031 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2032 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2033 "trunc source and destination must both be a vector or neither", &I);
2034 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002035
2036 visitInstruction(I);
2037}
2038
2039void Verifier::visitZExtInst(ZExtInst &I) {
2040 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002041 Type *SrcTy = I.getOperand(0)->getType();
2042 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002043
2044 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002045 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2046 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2047 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2048 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002049 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2050 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002051
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002052 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002053
2054 visitInstruction(I);
2055}
2056
2057void Verifier::visitSExtInst(SExtInst &I) {
2058 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002059 Type *SrcTy = I.getOperand(0)->getType();
2060 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002061
2062 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002063 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2064 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002065
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002066 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2067 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2068 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2069 "sext source and destination must both be a vector or neither", &I);
2070 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002071
2072 visitInstruction(I);
2073}
2074
2075void Verifier::visitFPTruncInst(FPTruncInst &I) {
2076 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002077 Type *SrcTy = I.getOperand(0)->getType();
2078 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002079 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002080 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2081 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002082
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002083 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2084 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2085 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2086 "fptrunc source and destination must both be a vector or neither", &I);
2087 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002088
2089 visitInstruction(I);
2090}
2091
2092void Verifier::visitFPExtInst(FPExtInst &I) {
2093 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002094 Type *SrcTy = I.getOperand(0)->getType();
2095 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002096
2097 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002098 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2099 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002100
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002101 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2102 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2103 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2104 "fpext source and destination must both be a vector or neither", &I);
2105 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002106
2107 visitInstruction(I);
2108}
2109
2110void Verifier::visitUIToFPInst(UIToFPInst &I) {
2111 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002112 Type *SrcTy = I.getOperand(0)->getType();
2113 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002114
Duncan Sands19d0b472010-02-16 11:11:14 +00002115 bool SrcVec = SrcTy->isVectorTy();
2116 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002117
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002118 Assert(SrcVec == DstVec,
2119 "UIToFP source and dest must both be vector or scalar", &I);
2120 Assert(SrcTy->isIntOrIntVectorTy(),
2121 "UIToFP source must be integer or integer vector", &I);
2122 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2123 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002124
2125 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002126 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2127 cast<VectorType>(DestTy)->getNumElements(),
2128 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002129
2130 visitInstruction(I);
2131}
2132
2133void Verifier::visitSIToFPInst(SIToFPInst &I) {
2134 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002135 Type *SrcTy = I.getOperand(0)->getType();
2136 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002137
Duncan Sands19d0b472010-02-16 11:11:14 +00002138 bool SrcVec = SrcTy->isVectorTy();
2139 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002140
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002141 Assert(SrcVec == DstVec,
2142 "SIToFP source and dest must both be vector or scalar", &I);
2143 Assert(SrcTy->isIntOrIntVectorTy(),
2144 "SIToFP source must be integer or integer vector", &I);
2145 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2146 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002147
2148 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002149 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2150 cast<VectorType>(DestTy)->getNumElements(),
2151 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002152
2153 visitInstruction(I);
2154}
2155
2156void Verifier::visitFPToUIInst(FPToUIInst &I) {
2157 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002158 Type *SrcTy = I.getOperand(0)->getType();
2159 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002160
Duncan Sands19d0b472010-02-16 11:11:14 +00002161 bool SrcVec = SrcTy->isVectorTy();
2162 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002163
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002164 Assert(SrcVec == DstVec,
2165 "FPToUI source and dest must both be vector or scalar", &I);
2166 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2167 &I);
2168 Assert(DestTy->isIntOrIntVectorTy(),
2169 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002170
2171 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002172 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2173 cast<VectorType>(DestTy)->getNumElements(),
2174 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002175
2176 visitInstruction(I);
2177}
2178
2179void Verifier::visitFPToSIInst(FPToSIInst &I) {
2180 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002181 Type *SrcTy = I.getOperand(0)->getType();
2182 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002183
Duncan Sands19d0b472010-02-16 11:11:14 +00002184 bool SrcVec = SrcTy->isVectorTy();
2185 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002186
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002187 Assert(SrcVec == DstVec,
2188 "FPToSI source and dest must both be vector or scalar", &I);
2189 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2190 &I);
2191 Assert(DestTy->isIntOrIntVectorTy(),
2192 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002193
2194 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002195 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2196 cast<VectorType>(DestTy)->getNumElements(),
2197 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002198
2199 visitInstruction(I);
2200}
2201
2202void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2203 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002204 Type *SrcTy = I.getOperand(0)->getType();
2205 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002206
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002207 Assert(SrcTy->getScalarType()->isPointerTy(),
2208 "PtrToInt source must be pointer", &I);
2209 Assert(DestTy->getScalarType()->isIntegerTy(),
2210 "PtrToInt result must be integral", &I);
2211 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2212 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002213
2214 if (SrcTy->isVectorTy()) {
2215 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2216 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002217 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2218 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002219 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002220
2221 visitInstruction(I);
2222}
2223
2224void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2225 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002226 Type *SrcTy = I.getOperand(0)->getType();
2227 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002228
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002229 Assert(SrcTy->getScalarType()->isIntegerTy(),
2230 "IntToPtr source must be an integral", &I);
2231 Assert(DestTy->getScalarType()->isPointerTy(),
2232 "IntToPtr result must be a pointer", &I);
2233 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2234 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002235 if (SrcTy->isVectorTy()) {
2236 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2237 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002238 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2239 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002240 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002241 visitInstruction(I);
2242}
2243
2244void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002245 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002246 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2247 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002248 visitInstruction(I);
2249}
2250
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002251void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2252 Type *SrcTy = I.getOperand(0)->getType();
2253 Type *DestTy = I.getType();
2254
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002255 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2256 &I);
2257 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2258 &I);
2259 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2260 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002261 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002262 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2263 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002264 visitInstruction(I);
2265}
2266
Misha Brukmanc566ca362004-03-02 00:22:19 +00002267/// visitPHINode - Ensure that a PHI node is well formed.
2268///
Chris Lattner069a7952002-06-25 15:56:27 +00002269void Verifier::visitPHINode(PHINode &PN) {
2270 // Ensure that the PHI nodes are all grouped together at the top of the block.
2271 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002272 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002273 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002274 Assert(&PN == &PN.getParent()->front() ||
2275 isa<PHINode>(--BasicBlock::iterator(&PN)),
2276 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002277
David Majnemerb611e3f2015-08-14 05:09:07 +00002278 // Check that a PHI doesn't yield a Token.
2279 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2280
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002281 // Check that all of the values of the PHI node have the same type as the
2282 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002283 for (Value *IncValue : PN.incoming_values()) {
2284 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002285 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002286 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002287
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002288 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002289
2290 visitInstruction(PN);
2291}
2292
Duncan Sands8c582282007-12-21 19:19:01 +00002293void Verifier::VerifyCallSite(CallSite CS) {
2294 Instruction *I = CS.getInstruction();
2295
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002296 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2297 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002298 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002299
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002300 Assert(FPTy->getElementType()->isFunctionTy(),
2301 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002302
2303 Assert(FPTy->getElementType() == CS.getFunctionType(),
2304 "Called function is not the same type as the call!", I);
2305
2306 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002307
2308 // Verify that the correct number of arguments are being passed
2309 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002310 Assert(CS.arg_size() >= FTy->getNumParams(),
2311 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002312 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002313 Assert(CS.arg_size() == FTy->getNumParams(),
2314 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002315
Chris Lattner609de002010-05-10 20:58:42 +00002316 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002317 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002318 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2319 "Call parameter type does not match function signature!",
2320 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002321
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002322 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002323
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002324 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2325 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002326
Duncan Sands8c582282007-12-21 19:19:01 +00002327 // Verify call attributes.
Duncan Sands0009c442008-01-12 16:42:01 +00002328 VerifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002329
David Majnemer91db08b2014-04-30 17:22:00 +00002330 // Conservatively check the inalloca argument.
2331 // We have a bug if we can find that there is an underlying alloca without
2332 // inalloca.
2333 if (CS.hasInAllocaArgument()) {
2334 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2335 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002336 Assert(AI->isUsedWithInAlloca(),
2337 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002338 }
2339
Stephen Linb8bd2322013-04-20 05:14:40 +00002340 if (FTy->isVarArg()) {
2341 // FIXME? is 'nest' even legal here?
2342 bool SawNest = false;
2343 bool SawReturned = false;
2344
2345 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2346 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2347 SawNest = true;
2348 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2349 SawReturned = true;
2350 }
2351
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002352 // Check attributes on the varargs part.
2353 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002354 Type *Ty = CS.getArgument(Idx-1)->getType();
Stephen Linb8bd2322013-04-20 05:14:40 +00002355 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002356
Stephen Linb8bd2322013-04-20 05:14:40 +00002357 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002358 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002359 SawNest = true;
2360 }
2361
2362 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002363 Assert(!SawReturned, "More than one parameter has attribute returned!",
2364 I);
2365 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2366 "Incompatible argument and return types for 'returned' "
2367 "attribute",
2368 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002369 SawReturned = true;
2370 }
Duncan Sands0009c442008-01-12 16:42:01 +00002371
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002372 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2373 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002374
2375 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002376 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002377 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002378 }
Duncan Sands8c582282007-12-21 19:19:01 +00002379
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002380 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002381 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002382 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002383 for (Type *ParamTy : FTy->params()) {
2384 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002385 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002386 Assert(!ParamTy->isTokenTy(),
2387 "Function has token parameter but isn't an intrinsic", I);
2388 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002389 }
2390
David Majnemerb611e3f2015-08-14 05:09:07 +00002391 // Verify that indirect calls don't return tokens.
2392 if (CS.getCalledFunction() == nullptr)
2393 Assert(!FTy->getReturnType()->isTokenTy(),
2394 "Return type cannot be token for indirect call!");
2395
Philip Reamesa3c6f002015-06-26 21:39:44 +00002396 if (Function *F = CS.getCalledFunction())
2397 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002398 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002399
David Majnemer3bb88c02015-12-15 21:27:27 +00002400 // Verify that a callsite has at most one "deopt" and one "funclet" operand
2401 // bundle.
2402 bool FoundDeoptBundle = false, FoundFuncletBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002403 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002404 OperandBundleUse BU = CS.getOperandBundleAt(i);
2405 uint32_t Tag = BU.getTagID();
2406 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002407 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2408 FoundDeoptBundle = true;
2409 }
David Majnemer3bb88c02015-12-15 21:27:27 +00002410 if (Tag == LLVMContext::OB_funclet) {
2411 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2412 FoundFuncletBundle = true;
2413 Assert(BU.Inputs.size() == 1,
2414 "Expected exactly one funclet bundle operand", I);
2415 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2416 "Funclet bundle operands should correspond to a FuncletPadInst",
2417 I);
2418 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002419 }
2420
Duncan Sands8c582282007-12-21 19:19:01 +00002421 visitInstruction(*I);
2422}
2423
Reid Kleckner5772b772014-04-24 20:14:34 +00002424/// Two types are "congruent" if they are identical, or if they are both pointer
2425/// types with different pointee types and the same address space.
2426static bool isTypeCongruent(Type *L, Type *R) {
2427 if (L == R)
2428 return true;
2429 PointerType *PL = dyn_cast<PointerType>(L);
2430 PointerType *PR = dyn_cast<PointerType>(R);
2431 if (!PL || !PR)
2432 return false;
2433 return PL->getAddressSpace() == PR->getAddressSpace();
2434}
2435
Reid Klecknerd20c9702014-05-15 23:58:57 +00002436static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2437 static const Attribute::AttrKind ABIAttrs[] = {
2438 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2439 Attribute::InReg, Attribute::Returned};
2440 AttrBuilder Copy;
2441 for (auto AK : ABIAttrs) {
2442 if (Attrs.hasAttribute(I + 1, AK))
2443 Copy.addAttribute(AK);
2444 }
2445 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2446 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2447 return Copy;
2448}
2449
Reid Kleckner5772b772014-04-24 20:14:34 +00002450void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002451 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002452
2453 // - The caller and callee prototypes must match. Pointer types of
2454 // parameters or return types may differ in pointee type, but not
2455 // address space.
2456 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002457 FunctionType *CallerTy = F->getFunctionType();
2458 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002459 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2460 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2461 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2462 "cannot guarantee tail call due to mismatched varargs", &CI);
2463 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2464 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002465 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002466 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002467 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2468 "cannot guarantee tail call due to mismatched parameter types", &CI);
2469 }
2470
2471 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002472 Assert(F->getCallingConv() == CI.getCallingConv(),
2473 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002474
2475 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2476 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002477 AttributeSet CallerAttrs = F->getAttributes();
2478 AttributeSet CalleeAttrs = CI.getAttributes();
2479 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002480 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2481 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002482 Assert(CallerABIAttrs == CalleeABIAttrs,
2483 "cannot guarantee tail call due to mismatched ABI impacting "
2484 "function attributes",
2485 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002486 }
2487
2488 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2489 // or a pointer bitcast followed by a ret instruction.
2490 // - The ret instruction must return the (possibly bitcasted) value
2491 // produced by the call or void.
2492 Value *RetVal = &CI;
2493 Instruction *Next = CI.getNextNode();
2494
2495 // Handle the optional bitcast.
2496 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002497 Assert(BI->getOperand(0) == RetVal,
2498 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002499 RetVal = BI;
2500 Next = BI->getNextNode();
2501 }
2502
2503 // Check the return.
2504 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002505 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2506 &CI);
2507 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2508 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002509}
2510
Duncan Sands8c582282007-12-21 19:19:01 +00002511void Verifier::visitCallInst(CallInst &CI) {
2512 VerifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002513
Reid Kleckner5772b772014-04-24 20:14:34 +00002514 if (CI.isMustTailCall())
2515 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002516}
2517
2518void Verifier::visitInvokeInst(InvokeInst &II) {
2519 VerifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002520
David Majnemer654e1302015-07-31 17:58:14 +00002521 // Verify that the first non-PHI instruction of the unwind destination is an
2522 // exception handling instruction.
2523 Assert(
2524 II.getUnwindDest()->isEHPad(),
2525 "The unwind destination does not have an exception handling instruction!",
2526 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002527
Dan Gohman9c6e1882010-08-02 23:09:14 +00002528 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002529}
Chris Lattner0e851da2002-04-18 20:37:37 +00002530
Misha Brukmanc566ca362004-03-02 00:22:19 +00002531/// visitBinaryOperator - Check that both arguments to the binary operator are
2532/// of the same type!
2533///
Chris Lattner069a7952002-06-25 15:56:27 +00002534void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002535 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2536 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002537
Reid Spencer2341c222007-02-02 02:16:23 +00002538 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002539 // Check that integer arithmetic operators are only used with
2540 // integral operands.
2541 case Instruction::Add:
2542 case Instruction::Sub:
2543 case Instruction::Mul:
2544 case Instruction::SDiv:
2545 case Instruction::UDiv:
2546 case Instruction::SRem:
2547 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002548 Assert(B.getType()->isIntOrIntVectorTy(),
2549 "Integer arithmetic operators only work with integral types!", &B);
2550 Assert(B.getType() == B.getOperand(0)->getType(),
2551 "Integer arithmetic operators must have same type "
2552 "for operands and result!",
2553 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002554 break;
2555 // Check that floating-point arithmetic operators are only used with
2556 // floating-point operands.
2557 case Instruction::FAdd:
2558 case Instruction::FSub:
2559 case Instruction::FMul:
2560 case Instruction::FDiv:
2561 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002562 Assert(B.getType()->isFPOrFPVectorTy(),
2563 "Floating-point arithmetic operators only work with "
2564 "floating-point types!",
2565 &B);
2566 Assert(B.getType() == B.getOperand(0)->getType(),
2567 "Floating-point arithmetic operators must have same type "
2568 "for operands and result!",
2569 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002570 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002571 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002572 case Instruction::And:
2573 case Instruction::Or:
2574 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002575 Assert(B.getType()->isIntOrIntVectorTy(),
2576 "Logical operators only work with integral types!", &B);
2577 Assert(B.getType() == B.getOperand(0)->getType(),
2578 "Logical operators must have same type for operands and result!",
2579 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002580 break;
2581 case Instruction::Shl:
2582 case Instruction::LShr:
2583 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002584 Assert(B.getType()->isIntOrIntVectorTy(),
2585 "Shifts only work with integral types!", &B);
2586 Assert(B.getType() == B.getOperand(0)->getType(),
2587 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002588 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002589 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002590 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002591 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002592
Chris Lattner0e851da2002-04-18 20:37:37 +00002593 visitInstruction(B);
2594}
2595
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002596void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002597 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002598 Type *Op0Ty = IC.getOperand(0)->getType();
2599 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002600 Assert(Op0Ty == Op1Ty,
2601 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002602 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002603 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2604 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002605 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002606 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2607 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2608 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002609
Reid Spencerd9436b62006-11-20 01:22:35 +00002610 visitInstruction(IC);
2611}
2612
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002613void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002614 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002615 Type *Op0Ty = FC.getOperand(0)->getType();
2616 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002617 Assert(Op0Ty == Op1Ty,
2618 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002619 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002620 Assert(Op0Ty->isFPOrFPVectorTy(),
2621 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002622 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002623 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2624 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2625 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002626
Reid Spencerd9436b62006-11-20 01:22:35 +00002627 visitInstruction(FC);
2628}
2629
Robert Bocchino23004482006-01-10 19:05:34 +00002630void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002631 Assert(
2632 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2633 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002634 visitInstruction(EI);
2635}
2636
Robert Bocchinoca27f032006-01-17 20:07:22 +00002637void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002638 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2639 IE.getOperand(2)),
2640 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002641 visitInstruction(IE);
2642}
2643
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002644void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002645 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2646 SV.getOperand(2)),
2647 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002648 visitInstruction(SV);
2649}
2650
Chris Lattner069a7952002-06-25 15:56:27 +00002651void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002652 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002653
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002654 Assert(isa<PointerType>(TargetTy),
2655 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002656 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002657 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002658 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002659 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002660 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002661
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002662 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002663 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002664 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002665
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002666 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002667 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002668 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2669 if (GEP.getPointerOperandType()->isVectorTy())
2670 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2671 "Vector GEP result width doesn't match operand's", &GEP);
Duncan Sandse6beec62012-11-13 12:59:33 +00002672 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2673 Type *IndexTy = Idxs[i]->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002674 if (IndexTy->isVectorTy()) {
2675 unsigned IndexWidth = IndexTy->getVectorNumElements();
2676 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2677 }
2678 Assert(IndexTy->getScalarType()->isIntegerTy(),
2679 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002680 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002681 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002682 visitInstruction(GEP);
2683}
2684
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002685static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2686 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2687}
2688
Philip Reamesbf9676f2014-10-20 23:52:07 +00002689void Verifier::visitRangeMetadata(Instruction& I,
2690 MDNode* Range, Type* Ty) {
2691 assert(Range &&
2692 Range == I.getMetadata(LLVMContext::MD_range) &&
2693 "precondition violation");
2694
2695 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002696 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002697 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002698 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2699
Philip Reamesbf9676f2014-10-20 23:52:07 +00002700 ConstantRange LastRange(1); // Dummy initial value
2701 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002702 ConstantInt *Low =
2703 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002704 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002705 ConstantInt *High =
2706 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002707 Assert(High, "The upper limit must be an integer!", High);
2708 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2709 "Range types must match instruction type!", &I);
2710
Philip Reamesbf9676f2014-10-20 23:52:07 +00002711 APInt HighV = High->getValue();
2712 APInt LowV = Low->getValue();
2713 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002714 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2715 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002716 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002717 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2718 "Intervals are overlapping", Range);
2719 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2720 Range);
2721 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2722 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002723 }
2724 LastRange = ConstantRange(LowV, HighV);
2725 }
2726 if (NumRanges > 2) {
2727 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002728 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002729 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002730 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002731 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002732 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2733 "Intervals are overlapping", Range);
2734 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2735 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002736 }
2737}
2738
JF Bastiend1fb5852015-12-17 22:09:19 +00002739void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2740 const Instruction *I) {
2741 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2742 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2743 Assert(!(Size & (Size - 1)),
2744 "atomic memory access' operand must have a power-of-two size", Ty, I);
2745}
2746
Chris Lattner069a7952002-06-25 15:56:27 +00002747void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002748 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002749 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002750 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002751 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2752 "huge alignment values are unsupported", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002753 if (LI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002754 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2755 "Load cannot have Release ordering", &LI);
2756 Assert(LI.getAlignment() != 0,
2757 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002758 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2759 ElTy->isFloatingPointTy(),
2760 "atomic load operand must have integer, pointer, or floating point "
2761 "type!",
2762 ElTy, &LI);
2763 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002764 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002765 Assert(LI.getSynchScope() == CrossThread,
2766 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002767 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002768
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002769 visitInstruction(LI);
2770}
2771
Chris Lattner069a7952002-06-25 15:56:27 +00002772void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002773 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002774 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002775 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002776 Assert(ElTy == SI.getOperand(0)->getType(),
2777 "Stored value type does not match pointer operand type!", &SI, ElTy);
2778 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2779 "huge alignment values are unsupported", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002780 if (SI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002781 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2782 "Store cannot have Acquire ordering", &SI);
2783 Assert(SI.getAlignment() != 0,
2784 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002785 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2786 ElTy->isFloatingPointTy(),
2787 "atomic store operand must have integer, pointer, or floating point "
2788 "type!",
2789 ElTy, &SI);
2790 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002791 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002792 Assert(SI.getSynchScope() == CrossThread,
2793 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002794 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002795 visitInstruction(SI);
2796}
2797
Victor Hernandez8acf2952009-10-23 21:09:37 +00002798void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00002799 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00002800 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002801 Assert(PTy->getAddressSpace() == 0,
2802 "Allocation instruction pointer not in the generic address space!",
2803 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00002804 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002805 "Cannot allocate unsized type", &AI);
2806 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2807 "Alloca array size must have integer type", &AI);
2808 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2809 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00002810
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00002811 visitInstruction(AI);
2812}
2813
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002814void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00002815
2816 // FIXME: more conditions???
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002817 Assert(CXI.getSuccessOrdering() != NotAtomic,
2818 "cmpxchg instructions must be atomic.", &CXI);
2819 Assert(CXI.getFailureOrdering() != NotAtomic,
2820 "cmpxchg instructions must be atomic.", &CXI);
2821 Assert(CXI.getSuccessOrdering() != Unordered,
2822 "cmpxchg instructions cannot be unordered.", &CXI);
2823 Assert(CXI.getFailureOrdering() != Unordered,
2824 "cmpxchg instructions cannot be unordered.", &CXI);
2825 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2826 "cmpxchg instructions be at least as constrained on success as fail",
2827 &CXI);
2828 Assert(CXI.getFailureOrdering() != Release &&
2829 CXI.getFailureOrdering() != AcquireRelease,
2830 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00002831
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002832 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002833 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002834 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002835 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2836 ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002837 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002838 Assert(ElTy == CXI.getOperand(1)->getType(),
2839 "Expected value type does not match pointer operand type!", &CXI,
2840 ElTy);
2841 Assert(ElTy == CXI.getOperand(2)->getType(),
2842 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002843 visitInstruction(CXI);
2844}
2845
2846void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002847 Assert(RMWI.getOrdering() != NotAtomic,
2848 "atomicrmw instructions must be atomic.", &RMWI);
2849 Assert(RMWI.getOrdering() != Unordered,
2850 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002851 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002852 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002853 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002854 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2855 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002856 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002857 Assert(ElTy == RMWI.getOperand(1)->getType(),
2858 "Argument value type does not match pointer operand type!", &RMWI,
2859 ElTy);
2860 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2861 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2862 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002863 visitInstruction(RMWI);
2864}
2865
Eli Friedmanfee02c62011-07-25 23:16:38 +00002866void Verifier::visitFenceInst(FenceInst &FI) {
2867 const AtomicOrdering Ordering = FI.getOrdering();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002868 Assert(Ordering == Acquire || Ordering == Release ||
2869 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2870 "fence instructions may only have "
2871 "acquire, release, acq_rel, or seq_cst ordering.",
2872 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00002873 visitInstruction(FI);
2874}
2875
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002876void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002877 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2878 EVI.getIndices()) == EVI.getType(),
2879 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002880
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002881 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00002882}
2883
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002884void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002885 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2886 IVI.getIndices()) ==
2887 IVI.getOperand(1)->getType(),
2888 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002889
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002890 visitInstruction(IVI);
2891}
Chris Lattner0e851da2002-04-18 20:37:37 +00002892
David Majnemer85a549d2015-08-11 02:48:30 +00002893void Verifier::visitEHPadPredecessors(Instruction &I) {
2894 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00002895
David Majnemer85a549d2015-08-11 02:48:30 +00002896 BasicBlock *BB = I.getParent();
2897 Function *F = BB->getParent();
2898
2899 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
2900
2901 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
2902 // The landingpad instruction defines its parent as a landing pad block. The
2903 // landing pad block may be branched to only by the unwind edge of an
2904 // invoke.
2905 for (BasicBlock *PredBB : predecessors(BB)) {
2906 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
2907 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2908 "Block containing LandingPadInst must be jumped to "
2909 "only by the unwind edge of an invoke.",
2910 LPI);
2911 }
2912 return;
2913 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00002914 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
2915 if (!pred_empty(BB))
2916 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
2917 "Block containg CatchPadInst must be jumped to "
2918 "only by its catchswitch.",
2919 CPI);
2920 return;
2921 }
David Majnemer85a549d2015-08-11 02:48:30 +00002922
2923 for (BasicBlock *PredBB : predecessors(BB)) {
2924 TerminatorInst *TI = PredBB->getTerminator();
David Majnemer8a1c45d2015-12-12 05:38:55 +00002925 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00002926 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
2927 "EH pad must be jumped to via an unwind edge", &I, II);
David Majnemerbbfc7212015-12-14 18:34:23 +00002928 } else if (!isa<CleanupReturnInst>(TI) && !isa<CatchSwitchInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00002929 Assert(false, "EH pad must be jumped to via an unwind edge", &I, TI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00002930 }
David Majnemer85a549d2015-08-11 02:48:30 +00002931 }
2932}
2933
2934void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00002935 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2936 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002937 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2938 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00002939
David Majnemer85a549d2015-08-11 02:48:30 +00002940 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00002941
David Majnemer654e1302015-07-31 17:58:14 +00002942 if (!LandingPadResultTy)
2943 LandingPadResultTy = LPI.getType();
2944 else
2945 Assert(LandingPadResultTy == LPI.getType(),
2946 "The landingpad instruction should have a consistent result type "
2947 "inside a function.",
2948 &LPI);
2949
David Majnemer7fddecc2015-06-17 20:52:32 +00002950 Function *F = LPI.getParent()->getParent();
2951 Assert(F->hasPersonalityFn(),
2952 "LandingPadInst needs to be in a function with a personality.", &LPI);
2953
Bill Wendlingfae14752011-08-12 20:24:12 +00002954 // The landingpad instruction must be the first non-PHI instruction in the
2955 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002956 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2957 "LandingPadInst not the first non-PHI instruction in the block.",
2958 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00002959
Duncan Sands86de1a62011-09-27 16:43:19 +00002960 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00002961 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00002962 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002963 Assert(isa<PointerType>(Clause->getType()),
2964 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00002965 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002966 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2967 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2968 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00002969 }
Duncan Sands86de1a62011-09-27 16:43:19 +00002970 }
2971
Bill Wendlingfae14752011-08-12 20:24:12 +00002972 visitInstruction(LPI);
2973}
2974
David Majnemer654e1302015-07-31 17:58:14 +00002975void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00002976 visitEHPadPredecessors(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00002977
David Majnemer85a549d2015-08-11 02:48:30 +00002978 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00002979
David Majnemer654e1302015-07-31 17:58:14 +00002980 Function *F = BB->getParent();
2981 Assert(F->hasPersonalityFn(),
2982 "CatchPadInst needs to be in a function with a personality.", &CPI);
2983
David Majnemer8a1c45d2015-12-12 05:38:55 +00002984 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
2985 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
2986 CPI.getParentPad());
2987
David Majnemer654e1302015-07-31 17:58:14 +00002988 // The catchpad instruction must be the first non-PHI instruction in the
2989 // block.
2990 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00002991 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00002992
David Majnemer8a1c45d2015-12-12 05:38:55 +00002993 visitInstruction(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00002994}
2995
David Majnemer8a1c45d2015-12-12 05:38:55 +00002996void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
2997 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
2998 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
2999 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003000
David Majnemer8a1c45d2015-12-12 05:38:55 +00003001 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003002}
3003
3004void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003005 visitEHPadPredecessors(CPI);
3006
David Majnemer654e1302015-07-31 17:58:14 +00003007 BasicBlock *BB = CPI.getParent();
3008
David Majnemer654e1302015-07-31 17:58:14 +00003009 Function *F = BB->getParent();
3010 Assert(F->hasPersonalityFn(),
3011 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3012
3013 // The cleanuppad instruction must be the first non-PHI instruction in the
3014 // block.
3015 Assert(BB->getFirstNonPHI() == &CPI,
3016 "CleanupPadInst not the first non-PHI instruction in the block.",
3017 &CPI);
3018
David Majnemer8a1c45d2015-12-12 05:38:55 +00003019 auto *ParentPad = CPI.getParentPad();
3020 Assert(isa<CatchSwitchInst>(ParentPad) || isa<ConstantTokenNone>(ParentPad) ||
3021 isa<CleanupPadInst>(ParentPad) || isa<CatchPadInst>(ParentPad),
3022 "CleanupPadInst has an invalid parent.", &CPI);
3023
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003024 User *FirstUser = nullptr;
3025 BasicBlock *FirstUnwindDest = nullptr;
3026 for (User *U : CPI.users()) {
3027 BasicBlock *UnwindDest;
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003028 if (CleanupReturnInst *CRI = dyn_cast<CleanupReturnInst>(U)) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003029 UnwindDest = CRI->getUnwindDest();
David Majnemerbbfc7212015-12-14 18:34:23 +00003030 } else if (isa<CleanupPadInst>(U) || isa<CatchSwitchInst>(U)) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003031 continue;
David Majnemer3bb88c02015-12-15 21:27:27 +00003032 } else if (CallSite(U)) {
3033 continue;
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003034 } else {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003035 Assert(false, "bogus cleanuppad use", &CPI);
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003036 }
3037
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003038 if (!FirstUser) {
3039 FirstUser = U;
3040 FirstUnwindDest = UnwindDest;
3041 } else {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003042 Assert(
3043 UnwindDest == FirstUnwindDest,
3044 "cleanupret instructions from the same cleanuppad must have the same "
3045 "unwind destination",
3046 FirstUser, U);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003047 }
3048 }
3049
David Majnemer654e1302015-07-31 17:58:14 +00003050 visitInstruction(CPI);
3051}
3052
David Majnemer8a1c45d2015-12-12 05:38:55 +00003053void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
3054 visitEHPadPredecessors(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003055
David Majnemer8a1c45d2015-12-12 05:38:55 +00003056 BasicBlock *BB = CatchSwitch.getParent();
3057
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003058 Function *F = BB->getParent();
3059 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003060 "CatchSwitchInst needs to be in a function with a personality.",
3061 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003062
David Majnemer8a1c45d2015-12-12 05:38:55 +00003063 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003064 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003065 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3066 "CatchSwitchInst not the first non-PHI instruction in the block.",
3067 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003068
David Majnemer8a1c45d2015-12-12 05:38:55 +00003069 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003070 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003071 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3072 "CatchSwitchInst must unwind to an EH block which is not a "
3073 "landingpad.",
3074 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003075 }
3076
David Majnemer8a1c45d2015-12-12 05:38:55 +00003077 auto *ParentPad = CatchSwitch.getParentPad();
3078 Assert(isa<CatchSwitchInst>(ParentPad) || isa<ConstantTokenNone>(ParentPad) ||
3079 isa<CleanupPadInst>(ParentPad) || isa<CatchPadInst>(ParentPad),
3080 "CatchSwitchInst has an invalid parent.", ParentPad);
3081
3082 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003083}
3084
David Majnemer654e1302015-07-31 17:58:14 +00003085void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003086 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3087 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3088 CRI.getOperand(0));
3089
David Majnemer654e1302015-07-31 17:58:14 +00003090 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3091 Instruction *I = UnwindDest->getFirstNonPHI();
3092 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3093 "CleanupReturnInst must unwind to an EH block which is not a "
3094 "landingpad.",
3095 &CRI);
3096 }
3097
3098 visitTerminatorInst(CRI);
3099}
3100
Rafael Espindola654320a2012-02-26 02:23:37 +00003101void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3102 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003103 // If the we have an invalid invoke, don't try to compute the dominance.
3104 // We already reject it in the invoke specific checks and the dominance
3105 // computation doesn't handle multiple edges.
3106 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3107 if (II->getNormalDest() == II->getUnwindDest())
3108 return;
3109 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003110
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003111 const Use &U = I.getOperandUse(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003112 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3113 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003114}
3115
Artur Pilipenkocca80022015-10-09 17:41:29 +00003116void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3117 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3118 "apply only to pointer types", &I);
3119 Assert(isa<LoadInst>(I),
3120 "dereferenceable, dereferenceable_or_null apply only to load"
3121 " instructions, use attributes for calls or invokes", &I);
3122 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3123 "take one operand!", &I);
3124 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3125 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3126 "dereferenceable_or_null metadata value must be an i64!", &I);
3127}
3128
Misha Brukmanc566ca362004-03-02 00:22:19 +00003129/// verifyInstruction - Verify that an instruction is well formed.
3130///
Chris Lattner069a7952002-06-25 15:56:27 +00003131void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003132 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003133 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003134
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003135 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003136 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003137 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3138 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003139 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003140 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003141
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003142 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003143 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3144 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003145
Chris Lattner5f126b72004-03-29 00:29:36 +00003146 // Check that the return value of the instruction is either void or a legal
3147 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003148 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3149 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003150
Nick Lewycky93e06a52009-09-27 23:27:42 +00003151 // Check that the instruction doesn't produce metadata. Calls are already
3152 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003153 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3154 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003155
Chris Lattner0e851da2002-04-18 20:37:37 +00003156 // Check that all uses of the instruction, if they are instructions
3157 // themselves, actually have parent basic blocks. If the use is not an
3158 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003159 for (Use &U : I.uses()) {
3160 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003161 Assert(Used->getParent() != nullptr,
3162 "Instruction referencing"
3163 " instruction not embedded in a basic block!",
3164 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003165 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003166 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003167 return;
3168 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003169 }
3170
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003171 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003172 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003173
3174 // Check to make sure that only first-class-values are operands to
3175 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003176 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003177 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003178 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003179
Chris Lattner9ece94b2004-03-14 03:23:54 +00003180 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003181 // Check to make sure that the "address of" an intrinsic function is never
3182 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003183 Assert(
3184 !F->isIntrinsic() ||
3185 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3186 "Cannot take the address of an intrinsic!", &I);
3187 Assert(
3188 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003189 F->getIntrinsicID() == Intrinsic::donothing ||
3190 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003191 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3192 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003193 "Cannot invoke an intrinsinc other than"
3194 " donothing or patchpoint",
3195 &I);
3196 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003197 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003198 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003199 Assert(OpBB->getParent() == BB->getParent(),
3200 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003201 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003202 Assert(OpArg->getParent() == BB->getParent(),
3203 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003204 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003205 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003206 } else if (isa<Instruction>(I.getOperand(i))) {
3207 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003208 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003209 Assert((i + 1 == e && isa<CallInst>(I)) ||
3210 (i + 3 == e && isa<InvokeInst>(I)),
3211 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003212 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3213 if (CE->getType()->isPtrOrPtrVectorTy()) {
3214 // If we have a ConstantExpr pointer, we need to see if it came from an
3215 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003216 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003217 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003218 }
3219 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003220
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003221 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003222 Assert(I.getType()->isFPOrFPVectorTy(),
3223 "fpmath requires a floating point result!", &I);
3224 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003225 if (ConstantFP *CFP0 =
3226 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003227 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003228 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3229 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003230 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003231 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003232 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003233 }
3234
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003235 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003236 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3237 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003238 visitRangeMetadata(I, Range, I.getType());
3239 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003240
Philip Reames0ca58b32014-10-21 20:56:29 +00003241 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003242 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3243 &I);
3244 Assert(isa<LoadInst>(I),
3245 "nonnull applies only to load instructions, use attributes"
3246 " for calls or invokes",
3247 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003248 }
3249
Artur Pilipenkocca80022015-10-09 17:41:29 +00003250 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3251 visitDereferenceableMetadata(I, MD);
3252
3253 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3254 visitDereferenceableMetadata(I, MD);
3255
3256 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3257 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3258 &I);
3259 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3260 "use attributes for calls or invokes", &I);
3261 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3262 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3263 Assert(CI && CI->getType()->isIntegerTy(64),
3264 "align metadata value must be an i64!", &I);
3265 uint64_t Align = CI->getZExtValue();
3266 Assert(isPowerOf2_64(Align),
3267 "align metadata value must be a power of 2!", &I);
3268 Assert(Align <= Value::MaximumAlignment,
3269 "alignment is larger that implementation defined limit", &I);
3270 }
3271
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003272 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003273 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003274 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003275 }
3276
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003277 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003278}
3279
Chris Lattner144b6192012-05-27 19:37:05 +00003280/// VerifyIntrinsicType - Verify that the specified type (which comes from an
3281/// intrinsic argument or return value) matches the type constraints specified
3282/// by the .td file (e.g. an "any integer" argument really is an integer).
3283///
3284/// This return true on error but does not print a message.
3285bool Verifier::VerifyIntrinsicType(Type *Ty,
3286 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3287 SmallVectorImpl<Type*> &ArgTys) {
3288 using namespace Intrinsic;
3289
3290 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003291 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003292 IITDescriptor D = Infos.front();
3293 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003294
Chris Lattner144b6192012-05-27 19:37:05 +00003295 switch (D.Kind) {
3296 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003297 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003298 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003299 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003300 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003301 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003302 case IITDescriptor::Float: return !Ty->isFloatTy();
3303 case IITDescriptor::Double: return !Ty->isDoubleTy();
3304 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3305 case IITDescriptor::Vector: {
3306 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003307 return !VT || VT->getNumElements() != D.Vector_Width ||
Chris Lattner144b6192012-05-27 19:37:05 +00003308 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3309 }
3310 case IITDescriptor::Pointer: {
3311 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003312 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Chris Lattner144b6192012-05-27 19:37:05 +00003313 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3314 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003315
Chris Lattner144b6192012-05-27 19:37:05 +00003316 case IITDescriptor::Struct: {
3317 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003318 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003319 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003320
Chris Lattner144b6192012-05-27 19:37:05 +00003321 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3322 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3323 return true;
3324 return false;
3325 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003326
Chris Lattner144b6192012-05-27 19:37:05 +00003327 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003328 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003329 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003330 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003331 return Ty != ArgTys[D.getArgumentNumber()];
3332
Chris Lattner144b6192012-05-27 19:37:05 +00003333 // Otherwise, if this is the first instance of an argument, record it and
3334 // verify the "Any" kind.
3335 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3336 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003337
Chris Lattner144b6192012-05-27 19:37:05 +00003338 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003339 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003340 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3341 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3342 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3343 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3344 }
3345 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003346
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003347 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003348 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003349 if (D.getArgumentNumber() >= ArgTys.size())
3350 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003351
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003352 Type *NewTy = ArgTys[D.getArgumentNumber()];
3353 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3354 NewTy = VectorType::getExtendedElementVectorType(VTy);
3355 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3356 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3357 else
3358 return true;
3359
3360 return Ty != NewTy;
3361 }
3362 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003363 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003364 if (D.getArgumentNumber() >= ArgTys.size())
3365 return true;
3366
3367 Type *NewTy = ArgTys[D.getArgumentNumber()];
3368 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3369 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3370 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3371 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3372 else
3373 return true;
3374
3375 return Ty != NewTy;
3376 }
Tim Northover4516de32014-03-29 07:04:54 +00003377 case IITDescriptor::HalfVecArgument:
3378 // This may only be used when referring to a previous vector argument.
3379 return D.getArgumentNumber() >= ArgTys.size() ||
3380 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3381 VectorType::getHalfElementsVectorType(
3382 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003383 case IITDescriptor::SameVecWidthArgument: {
3384 if (D.getArgumentNumber() >= ArgTys.size())
3385 return true;
3386 VectorType * ReferenceType =
3387 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3388 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3389 if (!ThisArgType || !ReferenceType ||
3390 (ReferenceType->getVectorNumElements() !=
3391 ThisArgType->getVectorNumElements()))
3392 return true;
3393 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3394 Infos, ArgTys);
3395 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003396 case IITDescriptor::PtrToArgument: {
3397 if (D.getArgumentNumber() >= ArgTys.size())
3398 return true;
3399 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3400 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3401 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3402 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003403 case IITDescriptor::VecOfPtrsToElt: {
3404 if (D.getArgumentNumber() >= ArgTys.size())
3405 return true;
3406 VectorType * ReferenceType =
3407 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3408 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3409 if (!ThisArgVecTy || !ReferenceType ||
3410 (ReferenceType->getVectorNumElements() !=
3411 ThisArgVecTy->getVectorNumElements()))
3412 return true;
3413 PointerType *ThisArgEltTy =
3414 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3415 if (!ThisArgEltTy)
3416 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003417 return ThisArgEltTy->getElementType() !=
3418 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003419 }
Chris Lattner144b6192012-05-27 19:37:05 +00003420 }
3421 llvm_unreachable("unhandled");
3422}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003423
Andrew Tricka2efd992013-10-31 17:18:11 +00003424/// \brief Verify if the intrinsic has variable arguments.
3425/// This method is intended to be called after all the fixed arguments have been
3426/// verified first.
3427///
3428/// This method returns true on error and does not print an error message.
3429bool
3430Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3431 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3432 using namespace Intrinsic;
3433
3434 // If there are no descriptors left, then it can't be a vararg.
3435 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003436 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003437
3438 // There should be only one descriptor remaining at this point.
3439 if (Infos.size() != 1)
3440 return true;
3441
3442 // Check and verify the descriptor.
3443 IITDescriptor D = Infos.front();
3444 Infos = Infos.slice(1);
3445 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003446 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003447
3448 return true;
3449}
3450
Philip Reames007561a2015-06-26 22:21:52 +00003451/// Allow intrinsics to be verified in different ways.
3452void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003453 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003454 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3455 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003456
Chris Lattner144b6192012-05-27 19:37:05 +00003457 // Verify that the intrinsic prototype lines up with what the .td files
3458 // describe.
3459 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003460 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003461
Chris Lattner144b6192012-05-27 19:37:05 +00003462 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3463 getIntrinsicInfoTableEntries(ID, Table);
3464 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003465
Chris Lattner144b6192012-05-27 19:37:05 +00003466 SmallVector<Type *, 4> ArgTys;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003467 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3468 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003469 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003470 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3471 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003472
3473 // Verify if the intrinsic call matches the vararg property.
3474 if (IsVarArg)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003475 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3476 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003477 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003478 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3479 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003480
3481 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003482 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003483
3484 // Now that we have the intrinsic ID and the actual argument types (and we
3485 // know they are legal for the intrinsic!) get the intrinsic name through the
3486 // usual means. This allows us to verify the mangling of argument types into
3487 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003488 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003489 Assert(ExpectedName == IF->getName(),
3490 "Intrinsic name not mangled correctly for type arguments! "
3491 "Should be: " +
3492 ExpectedName,
3493 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003494
Chris Lattner588096e2009-12-28 09:07:21 +00003495 // If the intrinsic takes MDNode arguments, verify that they are either global
3496 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003497 for (Value *V : CS.args())
3498 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3499 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003500
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003501 switch (ID) {
3502 default:
3503 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003504 case Intrinsic::ctlz: // llvm.ctlz
3505 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003506 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003507 "is_zero_undef argument of bit counting intrinsics must be a "
3508 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003509 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003510 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003511 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003512 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3513 "invalid llvm.dbg.declare intrinsic call 1", CS);
3514 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003515 break;
3516 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003517 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003518 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003519 case Intrinsic::memcpy:
3520 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003521 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003522 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003523 Assert(AlignCI,
3524 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003525 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003526 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003527 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003528 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003529 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003530 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003531 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003532 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003533 }
Bill Wendling05604e02008-08-23 09:46:46 +00003534 case Intrinsic::gcroot:
3535 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003536 case Intrinsic::gcread:
3537 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003538 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003539 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3540 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3541 Assert(isa<Constant>(CS.getArgOperand(1)),
3542 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003543 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003544 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003545 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3546 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003547 CS);
Talin2e59f142010-09-30 20:23:47 +00003548 }
Chris Lattner25852062008-08-24 20:46:13 +00003549 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003550
Philip Reames9818dd72015-06-26 22:04:34 +00003551 Assert(CS.getParent()->getParent()->hasGC(),
3552 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003553 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003554 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003555 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003556 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003557 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003558 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003559 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003560 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3561 isa<ConstantInt>(CS.getArgOperand(2)) &&
3562 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3563 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3564 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003565 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003566 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003567 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3568 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003569 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003570 case Intrinsic::lifetime_start:
3571 case Intrinsic::lifetime_end:
3572 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003573 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003574 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003575 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003576 break;
3577 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003578 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3579 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003580 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003581
Reid Kleckner60381792015-07-07 22:25:32 +00003582 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003583 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003584 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003585 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003586 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003587 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003588 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003589 if (isa<ConstantPointerNull>(Arg))
3590 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003591 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003592 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003593 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003594 }
Philip Reames9818dd72015-06-26 22:04:34 +00003595 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003596 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003597 break;
3598 }
Reid Kleckner60381792015-07-07 22:25:32 +00003599 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003600 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003601 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003602 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003603 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003604 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003605 CS);
3606 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003607 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003608 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003609 auto &Entry = FrameEscapeInfo[Fn];
3610 Entry.second = unsigned(
3611 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003612 break;
3613 }
3614
Philip Reames1ffa9372015-01-30 23:28:05 +00003615 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00003616 Assert(!CS.isInlineAsm(),
3617 "gc.statepoint support for inline assembly unimplemented", CS);
3618 Assert(CS.getParent()->getParent()->hasGC(),
3619 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00003620
Philip Reames9818dd72015-06-26 22:04:34 +00003621 VerifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003622 break;
Philip Reames337c4bd2014-12-01 21:18:12 +00003623 case Intrinsic::experimental_gc_result_int:
3624 case Intrinsic::experimental_gc_result_float:
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003625 case Intrinsic::experimental_gc_result_ptr:
3626 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00003627 Assert(CS.getParent()->getParent()->hasGC(),
3628 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003629 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00003630 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00003631 const Function *StatepointFn =
3632 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003633 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3634 StatepointFn->getIntrinsicID() ==
3635 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00003636 "gc.result operand #1 must be from a statepoint", CS,
3637 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00003638
Philip Reamesb23713a2014-12-03 22:23:24 +00003639 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003640 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00003641 auto *PT = cast<PointerType>(Target->getType());
3642 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00003643 Assert(CS.getType() == TargetFuncType->getReturnType(),
3644 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003645 break;
3646 }
3647 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00003648 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003649
3650 // Check that this relocate is correctly tied to the statepoint
3651
3652 // This is case for relocate on the unwinding path of an invoke statepoint
3653 if (ExtractValueInst *ExtractValue =
Philip Reames9818dd72015-06-26 22:04:34 +00003654 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003655 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3656 "gc relocate on unwind path incorrectly linked to the statepoint",
Philip Reames9818dd72015-06-26 22:04:34 +00003657 CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003658
Sanjoy Das5665c992015-05-11 23:47:27 +00003659 const BasicBlock *InvokeBB =
Igor Laevsky9570ff92015-02-19 11:28:47 +00003660 ExtractValue->getParent()->getUniquePredecessor();
3661
3662 // Landingpad relocates should have only one predecessor with invoke
3663 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00003664 Assert(InvokeBB, "safepoints should have unique landingpads",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003665 ExtractValue->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00003666 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3667 InvokeBB);
3668 Assert(isStatepoint(InvokeBB->getTerminator()),
3669 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003670 }
3671 else {
3672 // In all other cases relocate should be tied to the statepoint directly.
3673 // This covers relocates on a normal return path of invoke statepoint and
3674 // relocates of a call statepoint
Philip Reames9818dd72015-06-26 22:04:34 +00003675 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003676 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00003677 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003678 }
3679
3680 // Verify rest of the relocate arguments
3681
Philip Reames9818dd72015-06-26 22:04:34 +00003682 GCRelocateOperands Ops(CS);
Sanjoy Das5665c992015-05-11 23:47:27 +00003683 ImmutableCallSite StatepointCS(Ops.getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00003684
3685 // Both the base and derived must be piped through the safepoint
Philip Reames9818dd72015-06-26 22:04:34 +00003686 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003687 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00003688 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003689
Philip Reames9818dd72015-06-26 22:04:34 +00003690 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003691 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00003692 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003693
3694 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3695 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3696 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003697 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003698 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003699 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003700 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00003701
3702 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3703 // section of the statepoint's argument
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003704 Assert(StatepointCS.arg_size() > 0,
3705 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003706 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00003707 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003708 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003709 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3710 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003711 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003712 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00003713 "gc.statepoint: number of transition arguments must be "
3714 "a constant integer");
3715 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003716 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3717 ->getZExtValue();
3718 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00003719 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00003720 "gc.statepoint: number of deoptimization arguments must be "
3721 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00003722 const int NumDeoptArgs =
Pat Gavlincc0431d2015-05-08 18:07:42 +00003723 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3724 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00003725 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003726 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3727 "gc.relocate: statepoint base index doesn't fall within the "
3728 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00003729 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003730 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3731 "gc.relocate: statepoint derived index doesn't fall within the "
3732 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00003733 CS);
Philip Reames38303a32014-12-03 19:53:15 +00003734
Chen Li6d8635a2015-05-18 19:50:14 +00003735 // Relocated value must be a pointer type, but gc_relocate does not need to return the
3736 // same pointer type as the relocated pointer. It can be casted to the correct type later
3737 // if it's desired. However, they must have the same address space.
Philip Reames9818dd72015-06-26 22:04:34 +00003738 GCRelocateOperands Operands(CS);
Chen Li6d8635a2015-05-18 19:50:14 +00003739 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00003740 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00003741
3742 // gc_relocate return type must be a pointer type, and is verified earlier in
3743 // VerifyIntrinsicType().
Philip Reames9818dd72015-06-26 22:04:34 +00003744 Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
Chen Li6d8635a2015-05-18 19:50:14 +00003745 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
Philip Reames9818dd72015-06-26 22:04:34 +00003746 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003747 break;
3748 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00003749 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00003750 case Intrinsic::eh_exceptionpointer: {
3751 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
3752 "eh.exceptionpointer argument must be a catchpad", CS);
3753 break;
3754 }
Philip Reames337c4bd2014-12-01 21:18:12 +00003755 };
Chris Lattner0e851da2002-04-18 20:37:37 +00003756}
3757
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003758/// \brief Carefully grab the subprogram from a local scope.
3759///
3760/// This carefully grabs the subprogram from a local scope, avoiding the
3761/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003762static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003763 if (!LocalScope)
3764 return nullptr;
3765
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003766 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003767 return SP;
3768
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003769 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003770 return getSubprogram(LB->getRawScope());
3771
3772 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003773 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003774 return nullptr;
3775}
3776
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003777template <class DbgIntrinsicTy>
3778void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3779 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3780 Assert(isa<ValueAsMetadata>(MD) ||
3781 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3782 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003783 Assert(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003784 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3785 DII.getRawVariable());
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003786 Assert(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003787 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3788 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00003789
3790 // Ignore broken !dbg attachments; they're checked elsewhere.
3791 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003792 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00003793 return;
3794
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003795 BasicBlock *BB = DII.getParent();
3796 Function *F = BB ? BB->getParent() : nullptr;
3797
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00003798 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003799 DILocalVariable *Var = DII.getVariable();
3800 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003801 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3802 &DII, BB, F);
3803
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003804 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3805 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00003806 if (!VarSP || !LocSP)
3807 return; // Broken scope chains are checked elsewhere.
3808
3809 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3810 " variable and !dbg attachment",
3811 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3812 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003813}
3814
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003815template <class MapTy>
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003816static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003817 // Be careful of broken types (checked elsewhere).
3818 const Metadata *RawType = V.getRawType();
3819 while (RawType) {
3820 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003821 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003822 if (uint64_t Size = T->getSizeInBits())
3823 return Size;
3824
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003825 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003826 // Look at the base type.
3827 RawType = DT->getRawBaseType();
3828 continue;
3829 }
3830
3831 if (auto *S = dyn_cast<MDString>(RawType)) {
3832 // Don't error on missing types (checked elsewhere).
3833 RawType = Map.lookup(S);
3834 continue;
3835 }
3836
3837 // Missing type or size.
3838 break;
3839 }
3840
3841 // Fail gracefully.
3842 return 0;
3843}
3844
3845template <class MapTy>
3846void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3847 const MapTy &TypeRefs) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003848 DILocalVariable *V;
3849 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003850 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003851 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3852 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003853 } else {
3854 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003855 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3856 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003857 }
3858
3859 // We don't know whether this intrinsic verified correctly.
3860 if (!V || !E || !E->isValid())
3861 return;
3862
3863 // Nothing to do if this isn't a bit piece expression.
3864 if (!E->isBitPiece())
3865 return;
3866
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00003867 // The frontend helps out GDB by emitting the members of local anonymous
3868 // unions as artificial local variables with shared storage. When SROA splits
3869 // the storage for artificial local variables that are smaller than the entire
3870 // union, the overhang piece will be outside of the allotted space for the
3871 // variable and this check fails.
3872 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3873 if (V->isArtificial())
3874 return;
3875
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003876 // If there's no size, the type is broken, but that should be checked
3877 // elsewhere.
3878 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3879 if (!VarSize)
3880 return;
3881
3882 unsigned PieceSize = E->getBitPieceSize();
3883 unsigned PieceOffset = E->getBitPieceOffset();
3884 Assert(PieceSize + PieceOffset <= VarSize,
3885 "piece is larger than or outside of variable", &I, V, E);
3886 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3887}
3888
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00003889void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3890 // This is in its own function so we get an error for each bad type ref (not
3891 // just the first).
3892 Assert(false, "unresolved type ref", S, N);
3893}
3894
3895void Verifier::verifyTypeRefs() {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00003896 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3897 if (!CUs)
3898 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00003899
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003900 // Visit all the compile units again to map the type references.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003901 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00003902 for (auto *CU : CUs->operands())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003903 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3904 for (DIType *Op : Ts)
David Blaikie3c338f32015-08-22 22:36:40 +00003905 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003906 if (auto *S = T->getRawIdentifier()) {
3907 UnresolvedTypeRefs.erase(S);
3908 TypeRefs.insert(std::make_pair(S, T));
3909 }
3910
3911 // Verify debug info intrinsic bit piece expressions. This needs a second
3912 // pass through the intructions, since we haven't built TypeRefs yet when
3913 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3914 // later/now would queue up some that could be later deleted.
3915 for (const Function &F : *M)
3916 for (const BasicBlock &BB : F)
3917 for (const Instruction &I : BB)
3918 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3919 verifyBitPieceExpression(*DII, TypeRefs);
3920
3921 // Return early if all typerefs were resolved.
3922 if (UnresolvedTypeRefs.empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00003923 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00003924
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00003925 // Sort the unresolved references by name so the output is deterministic.
3926 typedef std::pair<const MDString *, const MDNode *> TypeRef;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00003927 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3928 UnresolvedTypeRefs.end());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00003929 std::sort(Unresolved.begin(), Unresolved.end(),
3930 [](const TypeRef &LHS, const TypeRef &RHS) {
3931 return LHS.first->getString() < RHS.first->getString();
3932 });
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00003933
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00003934 // Visit the unresolved refs (printing out the errors).
3935 for (const TypeRef &TR : Unresolved)
3936 visitUnresolvedTypeRef(TR.first, TR.second);
Manman Ren74c61b92013-07-19 00:31:03 +00003937}
3938
Chris Lattner0e851da2002-04-18 20:37:37 +00003939//===----------------------------------------------------------------------===//
3940// Implement the public interfaces to this file...
3941//===----------------------------------------------------------------------===//
3942
Chandler Carruth043949d2014-01-19 02:22:18 +00003943bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00003944 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00003945 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00003946
Chandler Carruth043949d2014-01-19 02:22:18 +00003947 raw_null_ostream NullStr;
3948 Verifier V(OS ? *OS : NullStr);
3949
3950 // Note that this function's return value is inverted from what you would
3951 // expect of a function called "verify".
3952 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00003953}
3954
Chandler Carruth043949d2014-01-19 02:22:18 +00003955bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3956 raw_null_ostream NullStr;
3957 Verifier V(OS ? *OS : NullStr);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003958
Chandler Carruth043949d2014-01-19 02:22:18 +00003959 bool Broken = false;
3960 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindolad4bcefc2014-10-24 18:13:04 +00003961 if (!I->isDeclaration() && !I->isMaterializable())
Chandler Carruth043949d2014-01-19 02:22:18 +00003962 Broken |= !V.verify(*I);
3963
3964 // Note that this function's return value is inverted from what you would
3965 // expect of a function called "verify".
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +00003966 return !V.verify(M) || Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00003967}
Chandler Carruth043949d2014-01-19 02:22:18 +00003968
3969namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00003970struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00003971 static char ID;
3972
3973 Verifier V;
3974 bool FatalErrors;
3975
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +00003976 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
Chandler Carruth4d356312014-01-20 11:34:08 +00003977 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00003978 }
Chandler Carruth4d356312014-01-20 11:34:08 +00003979 explicit VerifierLegacyPass(bool FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00003980 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00003981 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00003982 }
3983
Craig Topperf398d7c2014-03-05 06:35:38 +00003984 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00003985 if (!V.verify(F) && FatalErrors)
3986 report_fatal_error("Broken function found, compilation aborted!");
3987
3988 return false;
3989 }
3990
Craig Topperf398d7c2014-03-05 06:35:38 +00003991 bool doFinalization(Module &M) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00003992 if (!V.verify(M) && FatalErrors)
3993 report_fatal_error("Broken module found, compilation aborted!");
3994
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00003995 return false;
3996 }
3997
3998 void getAnalysisUsage(AnalysisUsage &AU) const override {
3999 AU.setPreservesAll();
4000 }
4001};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004002}
Chandler Carruth043949d2014-01-19 02:22:18 +00004003
Chandler Carruth4d356312014-01-20 11:34:08 +00004004char VerifierLegacyPass::ID = 0;
4005INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004006
4007FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004008 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004009}
4010
Chandler Carruthd174ce42015-01-05 02:47:05 +00004011PreservedAnalyses VerifierPass::run(Module &M) {
4012 if (verifyModule(M, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004013 report_fatal_error("Broken module found, compilation aborted!");
4014
4015 return PreservedAnalyses::all();
4016}
4017
Chandler Carruthd174ce42015-01-05 02:47:05 +00004018PreservedAnalyses VerifierPass::run(Function &F) {
4019 if (verifyFunction(F, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004020 report_fatal_error("Broken function found, compilation aborted!");
4021
4022 return PreservedAnalyses::all();
4023}