blob: 1cfc4ef40013e5db00ca74221a26119a2cbb99ac [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"
Joseph Tremoulet8ea80862016-01-10 04:31:05 +000048#include "llvm/ADT/MapVector.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000049#include "llvm/ADT/STLExtras.h"
50#include "llvm/ADT/SetVector.h"
51#include "llvm/ADT/SmallPtrSet.h"
52#include "llvm/ADT/SmallVector.h"
53#include "llvm/ADT/StringExtras.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000054#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000055#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000056#include "llvm/IR/CallingConv.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000057#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000058#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000059#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000060#include "llvm/IR/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000061#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000062#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000063#include "llvm/IR/InlineAsm.h"
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +000064#include "llvm/IR/InstIterator.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000065#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000066#include "llvm/IR/IntrinsicInst.h"
67#include "llvm/IR/LLVMContext.h"
68#include "llvm/IR/Metadata.h"
69#include "llvm/IR/Module.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000070#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000071#include "llvm/IR/Statepoint.h"
Chris Lattner8a923e72008-03-12 17:45:29 +000072#include "llvm/Pass.h"
Manman Ren74c61b92013-07-19 00:31:03 +000073#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000074#include "llvm/Support/Debug.h"
Torok Edwin6dd27302009-07-08 18:01:40 +000075#include "llvm/Support/ErrorHandling.h"
Chris Lattner24025262009-02-28 21:05:51 +000076#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000077#include <algorithm>
Jeff Cohene4535522006-03-31 07:22:05 +000078#include <cstdarg>
Chris Lattner189d19f2003-11-21 20:23:48 +000079using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000080
Duncan P. N. Exon Smith0633fd72015-03-17 17:28:41 +000081static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
Manman Ren74c61b92013-07-19 00:31:03 +000082
Dan Gohmand78c4002008-05-13 00:00:25 +000083namespace {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000084struct VerifierSupport {
Chandler Carruth043949d2014-01-19 02:22:18 +000085 raw_ostream &OS;
86 const Module *M;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000087
88 /// \brief Track the brokenness of the module while recursively visiting.
89 bool Broken;
90
91 explicit VerifierSupport(raw_ostream &OS)
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +000092 : OS(OS), M(nullptr), Broken(false) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000093
Benjamin Kramerf027ad72015-03-07 21:15:40 +000094private:
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +000095 template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
96 Write(&*I);
97 }
98
Keno Fischera6c4ce42015-12-01 19:06:36 +000099 void Write(const Module *M) {
100 if (!M)
101 return;
102 OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
103 }
104
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000105 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000106 if (!V)
107 return;
108 if (isa<Instruction>(V)) {
109 OS << *V << '\n';
110 } else {
111 V->printAsOperand(OS, true, M);
112 OS << '\n';
113 }
114 }
Philip Reames9818dd72015-06-26 22:04:34 +0000115 void Write(ImmutableCallSite CS) {
116 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000117 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000118
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000119 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000120 if (!MD)
121 return;
Duncan P. N. Exon Smithd6d70e72015-03-14 20:19:36 +0000122 MD->print(OS, M);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000123 OS << '\n';
124 }
125
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000126 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
127 Write(MD.get());
128 }
129
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000130 void Write(const NamedMDNode *NMD) {
131 if (!NMD)
132 return;
133 NMD->print(OS);
134 OS << '\n';
135 }
136
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000137 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000138 if (!T)
139 return;
140 OS << ' ' << *T;
141 }
142
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000143 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000144 if (!C)
145 return;
146 OS << *C;
147 }
148
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000149 template <typename T> void Write(ArrayRef<T> Vs) {
150 for (const T &V : Vs)
151 Write(V);
152 }
153
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000154 template <typename T1, typename... Ts>
155 void WriteTs(const T1 &V1, const Ts &... Vs) {
156 Write(V1);
157 WriteTs(Vs...);
158 }
159
160 template <typename... Ts> void WriteTs() {}
161
162public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000163 /// \brief A check failed, so printout out the condition and the message.
164 ///
165 /// This provides a nice place to put a breakpoint if you want to see why
166 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000167 void CheckFailed(const Twine &Message) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000168 OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000169 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000170 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000171
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000172 /// \brief A check failed (with values to print).
173 ///
174 /// This calls the Message-only version so that the above is easier to set a
175 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000176 template <typename T1, typename... Ts>
177 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
178 CheckFailed(Message);
179 WriteTs(V1, Vs...);
180 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000181};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000182
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000183class Verifier : public InstVisitor<Verifier>, VerifierSupport {
184 friend class InstVisitor<Verifier>;
185
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000186 LLVMContext *Context;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000187 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000188
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000189 /// \brief When verifying a basic block, keep track of all of the
190 /// instructions we have seen so far.
191 ///
192 /// This allows us to do efficient dominance checks for the case when an
193 /// instruction has an operand that is an instruction in the same block.
194 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000195
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000196 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000197 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000198
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000199 /// \brief Track unresolved string-based type references.
200 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000201
David Majnemer654e1302015-07-31 17:58:14 +0000202 /// \brief The result type for a landingpad.
203 Type *LandingPadResultTy;
204
Reid Kleckner60381792015-07-07 22:25:32 +0000205 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000206 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000207 bool SawFrameEscape;
208
Reid Kleckner60381792015-07-07 22:25:32 +0000209 /// Stores the count of how many objects were passed to llvm.localescape for a
210 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000211 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000212
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000213 // Maps catchswitches and cleanuppads that unwind to siblings to the
214 // terminators that indicate the unwind, used to detect cycles therein.
215 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
216
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000217 /// Cache of constants visited in search of ConstantExprs.
218 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
219
JF Bastiend1fb5852015-12-17 22:09:19 +0000220 void checkAtomicMemAccessSize(const Module *M, Type *Ty,
221 const Instruction *I);
Chandler Carruth043949d2014-01-19 02:22:18 +0000222public:
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +0000223 explicit Verifier(raw_ostream &OS)
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +0000224 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
David Majnemer654e1302015-07-31 17:58:14 +0000225 SawFrameEscape(false) {}
Chris Lattner0e851da2002-04-18 20:37:37 +0000226
Chandler Carruth043949d2014-01-19 02:22:18 +0000227 bool verify(const Function &F) {
228 M = F.getParent();
229 Context = &M->getContext();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000230
231 // First ensure the function is well-enough formed to compute dominance
232 // information.
Chandler Carruth043949d2014-01-19 02:22:18 +0000233 if (F.empty()) {
234 OS << "Function '" << F.getName()
235 << "' does not contain an entry block!\n";
236 return false;
237 }
238 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000239 if (I->empty() || !I->back().isTerminator()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000240 OS << "Basic Block in function '" << F.getName()
241 << "' does not have terminator!\n";
242 I->printAsOperand(OS, true);
243 OS << "\n";
244 return false;
Chandler Carruth76777602014-01-17 10:56:02 +0000245 }
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000246 }
Chandler Carruth76777602014-01-17 10:56:02 +0000247
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000248 // Now directly compute a dominance tree. We don't rely on the pass
249 // manager to provide this as it isolates us from a potentially
250 // out-of-date dominator tree and makes it significantly more complex to
251 // run this code outside of a pass manager.
Chandler Carruth043949d2014-01-19 02:22:18 +0000252 // FIXME: It's really gross that we have to cast away constness here.
253 DT.recalculate(const_cast<Function &>(F));
Chris Lattneraf332ee2007-04-20 23:59:29 +0000254
Chandler Carruth043949d2014-01-19 02:22:18 +0000255 Broken = false;
256 // FIXME: We strip const here because the inst visitor strips const.
257 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000258 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000259 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000260 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000261 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000262 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000263
Chandler Carruth043949d2014-01-19 02:22:18 +0000264 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000265 }
266
Chandler Carruth043949d2014-01-19 02:22:18 +0000267 bool verify(const Module &M) {
268 this->M = &M;
269 Context = &M.getContext();
Chandler Carruth043949d2014-01-19 02:22:18 +0000270 Broken = false;
271
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000272 // Scan through, checking all of the external function's linkage now...
Chandler Carruth043949d2014-01-19 02:22:18 +0000273 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000274 visitGlobalValue(*I);
275
276 // Check to make sure function prototypes are okay.
277 if (I->isDeclaration())
278 visitFunction(*I);
279 }
280
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000281 // Now that we've visited every function, verify that we never asked to
282 // recover a frame index that wasn't escaped.
283 verifyFrameRecoverIndices();
284
Chandler Carruth043949d2014-01-19 02:22:18 +0000285 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000286 I != E; ++I)
287 visitGlobalVariable(*I);
288
Chandler Carruth043949d2014-01-19 02:22:18 +0000289 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
290 I != E; ++I)
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000291 visitGlobalAlias(*I);
292
Chandler Carruth043949d2014-01-19 02:22:18 +0000293 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
294 E = M.named_metadata_end();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000295 I != E; ++I)
296 visitNamedMDNode(*I);
297
David Majnemerdad0a642014-06-27 18:19:56 +0000298 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
299 visitComdat(SMEC.getValue());
300
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000301 visitModuleFlags(M);
302 visitModuleIdents(M);
303
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000304 // Verify type referneces last.
305 verifyTypeRefs();
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000306
Chandler Carruth043949d2014-01-19 02:22:18 +0000307 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000308 }
Chris Lattner9713b842002-04-28 16:04:26 +0000309
Chandler Carruth043949d2014-01-19 02:22:18 +0000310private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000311 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000312 void visitGlobalValue(const GlobalValue &GV);
313 void visitGlobalVariable(const GlobalVariable &GV);
314 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000315 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000316 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000317 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000318 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000319 void visitMDNode(const MDNode &MD);
320 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
321 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000322 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000323 void visitModuleIdents(const Module &M);
324 void visitModuleFlags(const Module &M);
325 void visitModuleFlag(const MDNode *Op,
326 DenseMap<const MDString *, const MDNode *> &SeenIDs,
327 SmallVectorImpl<const MDNode *> &Requirements);
328 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000329 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000330 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000331 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000332
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000333 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000334#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
335#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000336 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000337 void visitDIVariable(const DIVariable &N);
338 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
339 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000340
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000341 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
342
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000343 /// \brief Check for a valid string-based type reference.
344 ///
345 /// Checks if \c MD is a string-based type reference. If it is, keeps track
346 /// of it (and its user, \c N) for error messages later.
347 bool isValidUUID(const MDNode &N, const Metadata *MD);
348
349 /// \brief Check for a valid type reference.
350 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000351 /// Checks for subclasses of \a DIType, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000352 bool isTypeRef(const MDNode &N, const Metadata *MD);
353
354 /// \brief Check for a valid scope reference.
355 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000356 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000357 bool isScopeRef(const MDNode &N, const Metadata *MD);
358
359 /// \brief Check for a valid debug info reference.
360 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000361 /// Checks for subclasses of \a DINode, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000362 bool isDIRef(const MDNode &N, const Metadata *MD);
363
Chandler Carruth043949d2014-01-19 02:22:18 +0000364 // InstVisitor overrides...
365 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000366 void visit(Instruction &I);
367
368 void visitTruncInst(TruncInst &I);
369 void visitZExtInst(ZExtInst &I);
370 void visitSExtInst(SExtInst &I);
371 void visitFPTruncInst(FPTruncInst &I);
372 void visitFPExtInst(FPExtInst &I);
373 void visitFPToUIInst(FPToUIInst &I);
374 void visitFPToSIInst(FPToSIInst &I);
375 void visitUIToFPInst(UIToFPInst &I);
376 void visitSIToFPInst(SIToFPInst &I);
377 void visitIntToPtrInst(IntToPtrInst &I);
378 void visitPtrToIntInst(PtrToIntInst &I);
379 void visitBitCastInst(BitCastInst &I);
380 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
381 void visitPHINode(PHINode &PN);
382 void visitBinaryOperator(BinaryOperator &B);
383 void visitICmpInst(ICmpInst &IC);
384 void visitFCmpInst(FCmpInst &FC);
385 void visitExtractElementInst(ExtractElementInst &EI);
386 void visitInsertElementInst(InsertElementInst &EI);
387 void visitShuffleVectorInst(ShuffleVectorInst &EI);
388 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
389 void visitCallInst(CallInst &CI);
390 void visitInvokeInst(InvokeInst &II);
391 void visitGetElementPtrInst(GetElementPtrInst &GEP);
392 void visitLoadInst(LoadInst &LI);
393 void visitStoreInst(StoreInst &SI);
394 void verifyDominatesUse(Instruction &I, unsigned i);
395 void visitInstruction(Instruction &I);
396 void visitTerminatorInst(TerminatorInst &I);
397 void visitBranchInst(BranchInst &BI);
398 void visitReturnInst(ReturnInst &RI);
399 void visitSwitchInst(SwitchInst &SI);
400 void visitIndirectBrInst(IndirectBrInst &BI);
401 void visitSelectInst(SelectInst &SI);
402 void visitUserOp1(Instruction &I);
403 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000404 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000405 template <class DbgIntrinsicTy>
406 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000407 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
408 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
409 void visitFenceInst(FenceInst &FI);
410 void visitAllocaInst(AllocaInst &AI);
411 void visitExtractValueInst(ExtractValueInst &EVI);
412 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000413 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000414 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemer654e1302015-07-31 17:58:14 +0000415 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000416 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000417 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000418 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000419 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000420 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000421
422 void VerifyCallSite(CallSite CS);
Reid Kleckner5772b772014-04-24 20:14:34 +0000423 void verifyMustTailCall(CallInst &CI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000424 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
425 unsigned ArgNo, std::string &Suffix);
426 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
427 SmallVectorImpl<Type *> &ArgTys);
428 bool VerifyIntrinsicIsVarArg(bool isVarArg,
429 ArrayRef<Intrinsic::IITDescriptor> &Infos);
430 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
431 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
432 const Value *V);
433 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
434 bool isReturnValue, const Value *V);
435 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
436 const Value *V);
Diego Novillo2567f3d2015-05-13 15:13:45 +0000437 void VerifyFunctionMetadata(
438 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000439
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000440 void visitConstantExprsRecursively(const Constant *EntryC);
441 void visitConstantExpr(const ConstantExpr *CE);
Philip Reames0285c742015-02-03 23:18:47 +0000442 void VerifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000443 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000444 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000445
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000446 // Module-level debug info verification...
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000447 void verifyTypeRefs();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000448 template <class MapTy>
Keno Fischer78e5c9e2016-01-13 02:31:14 +0000449 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
450 const MapTy &TypeRefs);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000451 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000452};
Chris Lattner189d19f2003-11-21 20:23:48 +0000453} // End anonymous namespace
454
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000455// Assert - We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000456#define Assert(C, ...) \
457 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000458
Chris Lattnere5a22c02008-08-28 04:02:44 +0000459void Verifier::visit(Instruction &I) {
460 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000461 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000462 InstVisitor<Verifier>::visit(I);
463}
464
Keno Fischer60f82a22016-01-14 22:20:56 +0000465// Helper to recursively iterate over indirect users. By
466// returning false, the callback can ask to stop recursing
467// further.
468static void forEachUser(const Value *User,
469 SmallPtrSet<const Value *, 32> &Visited,
470 llvm::function_ref<bool(const Value *)> Callback) {
471 if (!Visited.insert(User).second)
472 return;
473 for (const Value *TheNextUser : User->users())
474 if (Callback(TheNextUser))
475 forEachUser(TheNextUser, Visited, Callback);
476}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000477
Chandler Carruth043949d2014-01-19 02:22:18 +0000478void Verifier::visitGlobalValue(const GlobalValue &GV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000479 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
480 GV.hasExternalWeakLinkage(),
481 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000482
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000483 Assert(GV.getAlignment() <= Value::MaximumAlignment,
484 "huge alignment values are unsupported", &GV);
485 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
486 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000487
488 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000489 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000490 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000491 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000492 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000493
494 if (GV.isDeclarationForLinker())
495 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000496
497 // Verify that this GlobalValue is only used in this module.
498 // This map is used to avoid visiting uses twice. We can arrive at a user
499 // twice, if they have multiple operands. In particular for very large
500 // constant expressions, we can arrive at a particular user many times.
501 SmallPtrSet<const Value *, 32> Visited;
502 forEachUser(&GV, Visited, [&](const Value *V) -> bool {
503 if (const Instruction *I = dyn_cast<Instruction>(V)) {
504 if (!I->getParent() || !I->getParent()->getParent())
505 CheckFailed("Global is referenced by parentless instruction!", &GV,
506 M, I);
507 else if (I->getParent()->getParent()->getParent() != M)
508 CheckFailed("Global is referenced in a different module!", &GV,
509 M, I, I->getParent()->getParent(),
510 I->getParent()->getParent()->getParent());
511 return false;
512 } else if (const Function *F = dyn_cast<Function>(V)) {
513 if (F->getParent() != M)
514 CheckFailed("Global is used by function in a different module", &GV,
515 M, F, F->getParent());
516 return false;
517 }
518 return true;
519 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000520}
521
Chandler Carruth043949d2014-01-19 02:22:18 +0000522void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000523 if (GV.hasInitializer()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000524 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
525 "Global variable initializer type does not match global "
526 "variable type!",
527 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000528
Chris Lattner0aff0b22009-08-05 05:41:44 +0000529 // If the global has common linkage, it must have a zero initializer and
530 // cannot be constant.
531 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000532 Assert(GV.getInitializer()->isNullValue(),
533 "'common' global must have a zero initializer!", &GV);
534 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
535 &GV);
536 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000537 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000538 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000539 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
540 "invalid linkage type for global declaration", &GV);
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000541 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000542
Nick Lewycky466d0c12011-04-08 07:30:21 +0000543 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
544 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000545 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
546 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000547 // Don't worry about emitting an error for it not being an array,
548 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000549 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000550 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
551 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000552 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000553 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000554 Assert(STy &&
555 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
556 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
557 STy->getTypeAtIndex(1) == FuncPtrTy,
558 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000559 if (STy->getNumElements() == 3) {
560 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000561 Assert(ETy->isPointerTy() &&
562 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
563 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000564 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000565 }
566 }
567
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000568 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000569 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000570 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
571 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000572 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000573 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
574 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000575 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000576 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000577 const Constant *Init = GV.getInitializer();
578 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000579 Assert(InitArray, "wrong initalizer for intrinsic global variable",
580 Init);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000581 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
Rafael Espindolaeaf53272013-05-27 22:47:09 +0000582 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000583 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
584 isa<GlobalAlias>(V),
585 "invalid llvm.used member", V);
586 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000587 }
588 }
589 }
590 }
591
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000592 Assert(!GV.hasDLLImportStorageClass() ||
593 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
594 GV.hasAvailableExternallyLinkage(),
595 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000596
Matt Arsenault24b49c42013-07-31 17:49:08 +0000597 if (!GV.hasInitializer()) {
598 visitGlobalValue(GV);
599 return;
600 }
601
602 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000603 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000604
Chris Lattnere3400652004-12-15 20:23:49 +0000605 visitGlobalValue(GV);
606}
607
Rafael Espindola64c1e182014-06-03 02:41:57 +0000608void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
609 SmallPtrSet<const GlobalAlias*, 4> Visited;
610 Visited.insert(&GA);
611 visitAliaseeSubExpr(Visited, GA, C);
612}
613
Craig Topper71b7b682014-08-21 05:55:13 +0000614void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000615 const GlobalAlias &GA, const Constant &C) {
616 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000617 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
618 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000619
620 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000621 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000622
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000623 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
624 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000625 } else {
626 // Only continue verifying subexpressions of GlobalAliases.
627 // Do not recurse into global initializers.
628 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000629 }
630 }
631
632 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000633 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000634
635 for (const Use &U : C.operands()) {
636 Value *V = &*U;
637 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
638 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
639 else if (const auto *C2 = dyn_cast<Constant>(V))
640 visitAliaseeSubExpr(Visited, GA, *C2);
641 }
642}
643
Chandler Carruth043949d2014-01-19 02:22:18 +0000644void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000645 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
646 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
647 "weak_odr, or external linkage!",
648 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000649 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000650 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
651 Assert(GA.getType() == Aliasee->getType(),
652 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000653
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000654 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
655 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000656
Rafael Espindola64c1e182014-06-03 02:41:57 +0000657 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000658
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000659 visitGlobalValue(GA);
660}
661
Chandler Carruth043949d2014-01-19 02:22:18 +0000662void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000663 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000664 MDNode *MD = NMD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000665
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000666 if (NMD.getName() == "llvm.dbg.cu") {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000667 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000668 }
669
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000670 if (!MD)
671 continue;
672
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000673 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000674 }
675}
676
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000677void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000678 // Only visit each node once. Metadata can be mutually recursive, so this
679 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000680 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000681 return;
682
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000683 switch (MD.getMetadataID()) {
684 default:
685 llvm_unreachable("Invalid MDNode subclass");
686 case Metadata::MDTupleKind:
687 break;
688#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
689 case Metadata::CLASS##Kind: \
690 visit##CLASS(cast<CLASS>(MD)); \
691 break;
692#include "llvm/IR/Metadata.def"
693 }
694
Duncan Sands76d62172010-04-29 16:10:30 +0000695 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000696 Metadata *Op = MD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000697 if (!Op)
698 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000699 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
700 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000701 if (auto *N = dyn_cast<MDNode>(Op)) {
702 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000703 continue;
704 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000705 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
706 visitValueAsMetadata(*V, nullptr);
707 continue;
708 }
Duncan Sands76d62172010-04-29 16:10:30 +0000709 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000710
711 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000712 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
713 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000714}
715
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000716void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000717 Assert(MD.getValue(), "Expected valid value", &MD);
718 Assert(!MD.getValue()->getType()->isMetadataTy(),
719 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000720
721 auto *L = dyn_cast<LocalAsMetadata>(&MD);
722 if (!L)
723 return;
724
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000725 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000726
727 // If this was an instruction, bb, or argument, verify that it is in the
728 // function that we expect.
729 Function *ActualF = nullptr;
730 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000731 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000732 ActualF = I->getParent()->getParent();
733 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
734 ActualF = BB->getParent();
735 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
736 ActualF = A->getParent();
737 assert(ActualF && "Unimplemented function local metadata case!");
738
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000739 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000740}
741
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000742void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000743 Metadata *MD = MDV.getMetadata();
744 if (auto *N = dyn_cast<MDNode>(MD)) {
745 visitMDNode(*N);
746 return;
747 }
748
749 // Only visit each node once. Metadata can be mutually recursive, so this
750 // avoids infinite recursion here, as well as being an optimization.
751 if (!MDNodes.insert(MD).second)
752 return;
753
754 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
755 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000756}
757
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000758bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
759 auto *S = dyn_cast<MDString>(MD);
760 if (!S)
761 return false;
762 if (S->getString().empty())
763 return false;
764
765 // Keep track of names of types referenced via UUID so we can check that they
766 // actually exist.
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000767 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000768 return true;
769}
770
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000771/// \brief Check if a value can be a reference to a type.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000772bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000773 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000774}
775
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000776/// \brief Check if a value can be a ScopeRef.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000777bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000778 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000779}
780
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000781/// \brief Check if a value can be a debug info ref.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000782bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000783 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000784}
785
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000786template <class Ty>
787bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
788 for (Metadata *MD : N.operands()) {
789 if (MD) {
790 if (!isa<Ty>(MD))
791 return false;
792 } else {
793 if (!AllowNull)
794 return false;
795 }
796 }
797 return true;
798}
799
800template <class Ty>
801bool isValidMetadataArray(const MDTuple &N) {
802 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
803}
804
805template <class Ty>
806bool isValidMetadataNullArray(const MDTuple &N) {
807 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
808}
809
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000810void Verifier::visitDILocation(const DILocation &N) {
811 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000812 "location requires a valid scope", &N, N.getRawScope());
813 if (auto *IA = N.getRawInlinedAt())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000814 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000815}
816
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000817void Verifier::visitGenericDINode(const GenericDINode &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000818 Assert(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000819}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000820
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000821void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000822 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000823 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000824}
825
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000826void Verifier::visitDISubrange(const DISubrange &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000827 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000828 Assert(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000829}
830
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000831void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000832 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000833}
834
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000835void Verifier::visitDIBasicType(const DIBasicType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000836 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
837 N.getTag() == dwarf::DW_TAG_unspecified_type,
838 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000839}
840
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000841void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000842 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000843 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000844
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000845 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
846 N.getTag() == dwarf::DW_TAG_pointer_type ||
847 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
848 N.getTag() == dwarf::DW_TAG_reference_type ||
849 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
850 N.getTag() == dwarf::DW_TAG_const_type ||
851 N.getTag() == dwarf::DW_TAG_volatile_type ||
852 N.getTag() == dwarf::DW_TAG_restrict_type ||
853 N.getTag() == dwarf::DW_TAG_member ||
854 N.getTag() == dwarf::DW_TAG_inheritance ||
855 N.getTag() == dwarf::DW_TAG_friend,
856 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000857 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000858 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
859 N.getExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000860 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000861
862 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
863 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
864 N.getBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000865}
866
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000867static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000868 return (Flags & DINode::FlagLValueReference) &&
869 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000870}
871
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000872void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
873 auto *Params = dyn_cast<MDTuple>(&RawParams);
874 Assert(Params, "invalid template params", &N, &RawParams);
875 for (Metadata *Op : Params->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000876 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000877 Params, Op);
878 }
879}
880
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000881void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000882 // Common scope checks.
883 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000884
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000885 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
886 N.getTag() == dwarf::DW_TAG_structure_type ||
887 N.getTag() == dwarf::DW_TAG_union_type ||
888 N.getTag() == dwarf::DW_TAG_enumeration_type ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000889 N.getTag() == dwarf::DW_TAG_class_type,
890 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000891
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000892 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
893 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
894 N.getBaseType());
895
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000896 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
897 "invalid composite elements", &N, N.getRawElements());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000898 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000899 N.getRawVTableHolder());
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000900 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
901 &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000902 if (auto *Params = N.getRawTemplateParams())
903 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000904
905 if (N.getTag() == dwarf::DW_TAG_class_type ||
906 N.getTag() == dwarf::DW_TAG_union_type) {
907 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
908 "class/union requires a filename", &N, N.getFile());
909 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000910}
911
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000912void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000913 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000914 if (auto *Types = N.getRawTypeArray()) {
915 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
916 for (Metadata *Ty : N.getTypeArray()->operands()) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000917 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000918 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000919 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000920 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
921 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000922}
923
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000924void Verifier::visitDIFile(const DIFile &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000925 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000926}
927
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000928void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000929 Assert(N.isDistinct(), "compile units must be distinct", &N);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000930 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000931
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000932 // Don't bother verifying the compilation directory or producer string
933 // as those could be empty.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000934 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
935 N.getRawFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000936 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
937 N.getFile());
938
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000939 if (auto *Array = N.getRawEnumTypes()) {
940 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
941 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000942 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000943 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
944 "invalid enum type", &N, N.getEnumTypes(), Op);
945 }
946 }
947 if (auto *Array = N.getRawRetainedTypes()) {
948 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
949 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000950 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000951 }
952 }
953 if (auto *Array = N.getRawSubprograms()) {
954 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
955 for (Metadata *Op : N.getSubprograms()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000956 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 }
958 }
959 if (auto *Array = N.getRawGlobalVariables()) {
960 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
961 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000962 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000963 Op);
964 }
965 }
966 if (auto *Array = N.getRawImportedEntities()) {
967 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
968 for (Metadata *Op : N.getImportedEntities()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000969 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000970 Op);
971 }
972 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000973 if (auto *Array = N.getRawMacros()) {
974 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
975 for (Metadata *Op : N.getMacros()->operands()) {
976 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
977 }
978 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000979}
980
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000981void Verifier::visitDISubprogram(const DISubprogram &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000982 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000983 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000984 if (auto *T = N.getRawType())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000985 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000986 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000987 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000988 if (auto *Params = N.getRawTemplateParams())
989 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000990 if (auto *S = N.getRawDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000991 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000992 "invalid subprogram declaration", &N, S);
993 }
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000994 if (auto *RawVars = N.getRawVariables()) {
995 auto *Vars = dyn_cast<MDTuple>(RawVars);
996 Assert(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000997 for (Metadata *Op : Vars->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000998 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000999 Op);
1000 }
1001 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +00001002 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
1003 &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001004
Duncan P. N. Exon Smith814b8e92015-08-28 20:26:49 +00001005 if (N.isDefinition())
1006 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001007}
1008
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001009void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001010 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001011 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001012 "invalid local scope", &N, N.getRawScope());
1013}
1014
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001015void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1016 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001017
1018 Assert(N.getLine() || !N.getColumn(),
1019 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001020}
1021
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001022void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1023 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001024}
1025
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001026void Verifier::visitDINamespace(const DINamespace &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001027 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001028 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001029 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001030}
1031
Amjad Abouda9bcf162015-12-10 12:56:35 +00001032void Verifier::visitDIMacro(const DIMacro &N) {
1033 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1034 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1035 "invalid macinfo type", &N);
1036 Assert(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001037 if (!N.getValue().empty()) {
1038 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1039 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001040}
1041
1042void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1043 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1044 "invalid macinfo type", &N);
1045 if (auto *F = N.getRawFile())
1046 Assert(isa<DIFile>(F), "invalid file", &N, F);
1047
1048 if (auto *Array = N.getRawElements()) {
1049 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1050 for (Metadata *Op : N.getElements()->operands()) {
1051 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1052 }
1053 }
1054}
1055
Adrian Prantlab1243f2015-06-29 23:03:47 +00001056void Verifier::visitDIModule(const DIModule &N) {
1057 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1058 Assert(!N.getName().empty(), "anonymous module", &N);
1059}
1060
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001061void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001062 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001063}
1064
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001065void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1066 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001067
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001068 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1069 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001070}
1071
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001072void Verifier::visitDITemplateValueParameter(
1073 const DITemplateValueParameter &N) {
1074 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001075
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001076 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1077 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1078 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1079 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001080}
1081
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001082void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001083 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001084 Assert(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001085 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001086 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001087 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001088}
1089
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001090void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001091 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001092 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001093
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001094 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smith94d58f82015-03-31 01:28:22 +00001095 Assert(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001096 if (auto *V = N.getRawVariable()) {
1097 Assert(isa<ConstantAsMetadata>(V) &&
1098 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1099 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001100 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001101 }
1102 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001103 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001104 &N, Member);
1105 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001106}
1107
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001108void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001109 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001110 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001111
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +00001112 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001113 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001114 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001115}
1116
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001117void Verifier::visitDIExpression(const DIExpression &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001118 Assert(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001119}
1120
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001121void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001122 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001123 if (auto *T = N.getRawType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001124 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001125 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001126 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001127}
1128
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001129void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001130 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1131 N.getTag() == dwarf::DW_TAG_imported_declaration,
1132 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001133 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001134 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001135 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1136 N.getEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001137}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001138
David Majnemerdad0a642014-06-27 18:19:56 +00001139void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001140 // The Module is invalid if the GlobalValue has private linkage. Entities
1141 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001142 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001143 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1144 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001145}
1146
Chandler Carruth043949d2014-01-19 02:22:18 +00001147void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001148 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1149 if (!Idents)
1150 return;
1151
1152 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1153 // Scan each llvm.ident entry and make sure that this requirement is met.
1154 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001155 const MDNode *N = Idents->getOperand(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001156 Assert(N->getNumOperands() == 1,
1157 "incorrect number of operands in llvm.ident metadata", N);
1158 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1159 ("invalid value for llvm.ident metadata entry operand"
1160 "(the operand should be a string)"),
1161 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001162 }
1163}
1164
Chandler Carruth043949d2014-01-19 02:22:18 +00001165void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001166 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1167 if (!Flags) return;
1168
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001169 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001170 DenseMap<const MDString*, const MDNode*> SeenIDs;
1171 SmallVector<const MDNode*, 16> Requirements;
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001172 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001173 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001174 }
1175
1176 // Validate that the requirements in the module are valid.
1177 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001178 const MDNode *Requirement = Requirements[I];
1179 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001180 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001181
Chandler Carruth043949d2014-01-19 02:22:18 +00001182 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001183 if (!Op) {
1184 CheckFailed("invalid requirement on flag, flag is not present in module",
1185 Flag);
1186 continue;
1187 }
1188
1189 if (Op->getOperand(2) != ReqValue) {
1190 CheckFailed(("invalid requirement on flag, "
1191 "flag does not have the required value"),
1192 Flag);
1193 continue;
1194 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001195 }
1196}
1197
Chandler Carruth043949d2014-01-19 02:22:18 +00001198void
1199Verifier::visitModuleFlag(const MDNode *Op,
1200 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1201 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001202 // Each module flag should have three arguments, the merge behavior (a
1203 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001204 Assert(Op->getNumOperands() == 3,
1205 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001206 Module::ModFlagBehavior MFB;
1207 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001208 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001209 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001210 "invalid behavior operand in module flag (expected constant integer)",
1211 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001212 Assert(false,
1213 "invalid behavior operand in module flag (unexpected constant)",
1214 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001215 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001216 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001217 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1218 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001219
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001220 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001221 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001222 case Module::Error:
1223 case Module::Warning:
1224 case Module::Override:
1225 // These behavior types accept any value.
1226 break;
1227
1228 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001229 // The value should itself be an MDNode with two operands, a flag ID (an
1230 // MDString), and a value.
1231 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001232 Assert(Value && Value->getNumOperands() == 2,
1233 "invalid value for 'require' module flag (expected metadata pair)",
1234 Op->getOperand(2));
1235 Assert(isa<MDString>(Value->getOperand(0)),
1236 ("invalid value for 'require' module flag "
1237 "(first value operand should be a string)"),
1238 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001239
1240 // Append it to the list of requirements, to check once all module flags are
1241 // scanned.
1242 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001243 break;
1244 }
1245
1246 case Module::Append:
1247 case Module::AppendUnique: {
1248 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001249 Assert(isa<MDNode>(Op->getOperand(2)),
1250 "invalid value for 'append'-type module flag "
1251 "(expected a metadata node)",
1252 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001253 break;
1254 }
1255 }
1256
1257 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001258 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001259 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001260 Assert(Inserted,
1261 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001262 }
1263}
1264
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001265void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001266 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001267 unsigned Slot = ~0U;
1268 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1269 if (Attrs.getSlotIndex(I) == Idx) {
1270 Slot = I;
1271 break;
1272 }
1273
1274 assert(Slot != ~0U && "Attribute set inconsistency!");
1275
1276 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1277 I != E; ++I) {
1278 if (I->isStringAttribute())
1279 continue;
1280
1281 if (I->getKindAsEnum() == Attribute::NoReturn ||
1282 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001283 I->getKindAsEnum() == Attribute::NoInline ||
1284 I->getKindAsEnum() == Attribute::AlwaysInline ||
1285 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1286 I->getKindAsEnum() == Attribute::StackProtect ||
1287 I->getKindAsEnum() == Attribute::StackProtectReq ||
1288 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001289 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001290 I->getKindAsEnum() == Attribute::NoRedZone ||
1291 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1292 I->getKindAsEnum() == Attribute::Naked ||
1293 I->getKindAsEnum() == Attribute::InlineHint ||
1294 I->getKindAsEnum() == Attribute::StackAlignment ||
1295 I->getKindAsEnum() == Attribute::UWTable ||
1296 I->getKindAsEnum() == Attribute::NonLazyBind ||
1297 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1298 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1299 I->getKindAsEnum() == Attribute::SanitizeThread ||
1300 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1301 I->getKindAsEnum() == Attribute::MinSize ||
1302 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001303 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001304 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001305 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001306 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001307 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001308 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001309 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001310 I->getKindAsEnum() == Attribute::NoRecurse ||
1311 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1312 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001313 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001314 CheckFailed("Attribute '" + I->getAsString() +
1315 "' only applies to functions!", V);
1316 return;
1317 }
1318 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1319 I->getKindAsEnum() == Attribute::ReadNone) {
1320 if (Idx == 0) {
1321 CheckFailed("Attribute '" + I->getAsString() +
1322 "' does not apply to function returns");
1323 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001324 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001325 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001326 CheckFailed("Attribute '" + I->getAsString() +
1327 "' does not apply to functions!", V);
1328 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001329 }
1330 }
1331}
1332
Duncan Sandsc3a79922009-06-11 08:11:03 +00001333// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001334// value of the specified type. The value V is printed in error messages.
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001335void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001336 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001337 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001338 return;
1339
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001340 VerifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001341
Bill Wendling908126a2012-10-09 09:51:10 +00001342 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001343 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1344 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1345 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1346 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1347 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1348 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1349 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1350 "'returned' do not apply to return values!",
1351 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001352
Reid Klecknera534a382013-12-19 02:14:12 +00001353 // Check for mutually incompatible attributes. Only inreg is compatible with
1354 // sret.
1355 unsigned AttrCount = 0;
1356 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1357 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1358 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1359 Attrs.hasAttribute(Idx, Attribute::InReg);
1360 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001361 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1362 "and 'sret' are incompatible!",
1363 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001364
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001365 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1366 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1367 "Attributes "
1368 "'inalloca and readonly' are incompatible!",
1369 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001370
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001371 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1372 Attrs.hasAttribute(Idx, Attribute::Returned)),
1373 "Attributes "
1374 "'sret and returned' are incompatible!",
1375 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001376
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001377 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1378 Attrs.hasAttribute(Idx, Attribute::SExt)),
1379 "Attributes "
1380 "'zeroext and signext' are incompatible!",
1381 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001382
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001383 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1384 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1385 "Attributes "
1386 "'readnone and readonly' are incompatible!",
1387 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001388
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001389 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1390 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1391 "Attributes "
1392 "'noinline and alwaysinline' are incompatible!",
1393 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001394
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001395 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001396 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001397 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001398 AttributeSet::get(*Context, Idx,
1399 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001400 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001401
Reid Klecknera534a382013-12-19 02:14:12 +00001402 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001403 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001404 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001405 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1406 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1407 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1408 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001409 }
1410 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001411 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1412 "Attribute 'byval' only applies to parameters with pointer type!",
1413 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001414 }
Duncan Sands0009c442008-01-12 16:42:01 +00001415}
1416
1417// VerifyFunctionAttrs - Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001418// The value V is printed in error messages.
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001419void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001420 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001421 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001422 return;
1423
Duncan Sands8c582282007-12-21 19:19:01 +00001424 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001425 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001426 bool SawSRet = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001427
Chris Lattner8a923e72008-03-12 17:45:29 +00001428 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001429 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001430
Chris Lattner229907c2011-07-18 04:54:35 +00001431 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001432 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001433 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001434 else if (Idx-1 < FT->getNumParams())
1435 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001436 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001437 break; // VarArgs attributes, verified elsewhere.
1438
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001439 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001440
Stephen Linb8bd2322013-04-20 05:14:40 +00001441 if (Idx == 0)
1442 continue;
1443
1444 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001445 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001446 SawNest = true;
1447 }
1448
Stephen Linb8bd2322013-04-20 05:14:40 +00001449 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001450 Assert(!SawReturned, "More than one parameter has attribute returned!",
1451 V);
1452 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1453 "Incompatible "
1454 "argument and return types for 'returned' attribute",
1455 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001456 SawReturned = true;
1457 }
1458
Reid Kleckner79418562014-05-09 22:32:13 +00001459 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001460 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1461 Assert(Idx == 1 || Idx == 2,
1462 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001463 SawSRet = true;
1464 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001465
1466 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001467 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1468 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001469 }
Duncan Sands8c582282007-12-21 19:19:01 +00001470 }
Devang Patel9cc98122008-10-01 23:41:25 +00001471
Bill Wendling77543892013-01-18 21:11:39 +00001472 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1473 return;
1474
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001475 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001476
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001477 Assert(
1478 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1479 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1480 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001481
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001482 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001483 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1484 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1485 Attribute::InaccessibleMemOrArgMemOnly)),
1486 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1487
1488 Assert(
1489 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1490 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1491 Attribute::InaccessibleMemOnly)),
1492 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1493
1494 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001495 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1496 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1497 Attribute::AlwaysInline)),
1498 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001499
1500 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1501 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001502 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1503 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001504
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001505 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1506 Attribute::OptimizeForSize),
1507 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001508
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001509 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1510 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001511 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001512
1513 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1514 Attribute::JumpTable)) {
1515 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001516 Assert(GV->hasUnnamedAddr(),
1517 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001518 }
Duncan Sands8c582282007-12-21 19:19:01 +00001519}
1520
Diego Novillo2567f3d2015-05-13 15:13:45 +00001521void Verifier::VerifyFunctionMetadata(
1522 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1523 if (MDs.empty())
1524 return;
1525
1526 for (unsigned i = 0; i < MDs.size(); i++) {
1527 if (MDs[i].first == LLVMContext::MD_prof) {
1528 MDNode *MD = MDs[i].second;
1529 Assert(MD->getNumOperands() == 2,
1530 "!prof annotations should have exactly 2 operands", MD);
1531
1532 // Check first operand.
1533 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1534 MD);
1535 Assert(isa<MDString>(MD->getOperand(0)),
1536 "expected string with name of the !prof annotation", MD);
1537 MDString *MDS = cast<MDString>(MD->getOperand(0));
1538 StringRef ProfName = MDS->getString();
1539 Assert(ProfName.equals("function_entry_count"),
1540 "first operand should be 'function_entry_count'", MD);
1541
1542 // Check second operand.
1543 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1544 MD);
1545 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1546 "expected integer argument to function_entry_count", MD);
1547 }
1548 }
1549}
1550
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001551void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1552 if (!ConstantExprVisited.insert(EntryC).second)
1553 return;
1554
1555 SmallVector<const Constant *, 16> Stack;
1556 Stack.push_back(EntryC);
1557
1558 while (!Stack.empty()) {
1559 const Constant *C = Stack.pop_back_val();
1560
1561 // Check this constant expression.
1562 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1563 visitConstantExpr(CE);
1564
Keno Fischerf6d17b92016-01-14 22:42:02 +00001565 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1566 // Global Values get visited separately, but we do need to make sure
1567 // that the global value is in the correct module
1568 Assert(GV->getParent() == M, "Referencing global in another module!",
1569 EntryC, M, GV, GV->getParent());
1570 continue;
1571 }
1572
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001573 // Visit all sub-expressions.
1574 for (const Use &U : C->operands()) {
1575 const auto *OpC = dyn_cast<Constant>(U);
1576 if (!OpC)
1577 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001578 if (!ConstantExprVisited.insert(OpC).second)
1579 continue;
1580 Stack.push_back(OpC);
1581 }
1582 }
1583}
1584
1585void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001586 if (CE->getOpcode() != Instruction::BitCast)
1587 return;
1588
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001589 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1590 CE->getType()),
1591 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001592}
1593
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001594bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001595 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001596 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001597
Devang Patel82fed672008-09-23 22:35:17 +00001598 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001599 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001600 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001601 || (LastIndex == AttributeSet::FunctionIndex
1602 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001603 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001604
Devang Patel82fed672008-09-23 22:35:17 +00001605 return false;
1606}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001607
Philip Reames1ffa9372015-01-30 23:28:05 +00001608/// \brief Verify that statepoint intrinsic is well formed.
Philip Reames0285c742015-02-03 23:18:47 +00001609void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1610 assert(CS.getCalledFunction() &&
1611 CS.getCalledFunction()->getIntrinsicID() ==
1612 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001613
Philip Reames0285c742015-02-03 23:18:47 +00001614 const Instruction &CI = *CS.getInstruction();
1615
Igor Laevsky39d662f2015-07-11 10:30:36 +00001616 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1617 !CS.onlyAccessesArgMemory(),
1618 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001619 "reordering restrictions required by safepoint semantics",
1620 &CI);
1621
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001622 const Value *IDV = CS.getArgument(0);
1623 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1624 &CI);
1625
1626 const Value *NumPatchBytesV = CS.getArgument(1);
1627 Assert(isa<ConstantInt>(NumPatchBytesV),
1628 "gc.statepoint number of patchable bytes must be a constant integer",
1629 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001630 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001631 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1632 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1633 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1634 "positive",
1635 &CI);
1636
1637 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001638 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001639 Assert(PT && PT->getElementType()->isFunctionTy(),
1640 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001641 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001642
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001643 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001644 Assert(isa<ConstantInt>(NumCallArgsV),
1645 "gc.statepoint number of arguments to underlying call "
1646 "must be constant integer",
1647 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001648 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001649 Assert(NumCallArgs >= 0,
1650 "gc.statepoint number of arguments to underlying call "
1651 "must be positive",
1652 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001653 const int NumParams = (int)TargetFuncType->getNumParams();
1654 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001655 Assert(NumCallArgs >= NumParams,
1656 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001657
1658 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001659 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1660 "gc.statepoint doesn't support wrapping non-void "
1661 "vararg functions yet",
1662 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001663 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001664 Assert(NumCallArgs == NumParams,
1665 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001666
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001667 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001668 Assert(isa<ConstantInt>(FlagsV),
1669 "gc.statepoint flags must be constant integer", &CI);
1670 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1671 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1672 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001673
1674 // Verify that the types of the call parameter arguments match
1675 // the type of the wrapped callee.
1676 for (int i = 0; i < NumParams; i++) {
1677 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001678 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001679 Assert(ArgType == ParamType,
1680 "gc.statepoint call argument does not match wrapped "
1681 "function type",
1682 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001683 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001684
1685 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001686
1687 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1688 Assert(isa<ConstantInt>(NumTransitionArgsV),
1689 "gc.statepoint number of transition arguments "
1690 "must be constant integer",
1691 &CI);
1692 const int NumTransitionArgs =
1693 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1694 Assert(NumTransitionArgs >= 0,
1695 "gc.statepoint number of transition arguments must be positive", &CI);
1696 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1697
1698 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001699 Assert(isa<ConstantInt>(NumDeoptArgsV),
1700 "gc.statepoint number of deoptimization arguments "
1701 "must be constant integer",
1702 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001703 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001704 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1705 "must be positive",
1706 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001707
Pat Gavlincc0431d2015-05-08 18:07:42 +00001708 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001709 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001710 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001711 "gc.statepoint too few arguments according to length fields", &CI);
1712
Philip Reames1ffa9372015-01-30 23:28:05 +00001713 // Check that the only uses of this gc.statepoint are gc.result or
1714 // gc.relocate calls which are tied to this statepoint and thus part
1715 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001716 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001717 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001718 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001719 if (!Call) continue;
Manuel Jacob83eefa62016-01-05 04:03:00 +00001720 Assert(isa<GCRelocateInst>(Call) || isGCResult(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001721 "gc.result or gc.relocate are the only value uses"
1722 "of a gc.statepoint",
1723 &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001724 if (isGCResult(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001725 Assert(Call->getArgOperand(0) == &CI,
1726 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001727 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001728 Assert(Call->getArgOperand(0) == &CI,
1729 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001730 }
1731 }
1732
1733 // Note: It is legal for a single derived pointer to be listed multiple
1734 // times. It's non-optimal, but it is legal. It can also happen after
1735 // insertion if we strip a bitcast away.
1736 // Note: It is really tempting to check that each base is relocated and
1737 // that a derived pointer is never reused as a base pointer. This turns
1738 // out to be problematic since optimizations run after safepoint insertion
1739 // can recognize equality properties that the insertion logic doesn't know
1740 // about. See example statepoint.ll in the verifier subdirectory
1741}
1742
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001743void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001744 for (auto &Counts : FrameEscapeInfo) {
1745 Function *F = Counts.first;
1746 unsigned EscapedObjectCount = Counts.second.first;
1747 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001748 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001749 "all indices passed to llvm.localrecover must be less than the "
1750 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001751 "function",
1752 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001753 }
1754}
1755
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001756static Instruction *getSuccPad(TerminatorInst *Terminator) {
1757 BasicBlock *UnwindDest;
1758 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1759 UnwindDest = II->getUnwindDest();
1760 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1761 UnwindDest = CSI->getUnwindDest();
1762 else
1763 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1764 return UnwindDest->getFirstNonPHI();
1765}
1766
1767void Verifier::verifySiblingFuncletUnwinds() {
1768 SmallPtrSet<Instruction *, 8> Visited;
1769 SmallPtrSet<Instruction *, 8> Active;
1770 for (const auto &Pair : SiblingFuncletInfo) {
1771 Instruction *PredPad = Pair.first;
1772 if (Visited.count(PredPad))
1773 continue;
1774 Active.insert(PredPad);
1775 TerminatorInst *Terminator = Pair.second;
1776 do {
1777 Instruction *SuccPad = getSuccPad(Terminator);
1778 if (Active.count(SuccPad)) {
1779 // Found a cycle; report error
1780 Instruction *CyclePad = SuccPad;
1781 SmallVector<Instruction *, 8> CycleNodes;
1782 do {
1783 CycleNodes.push_back(CyclePad);
1784 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1785 if (CycleTerminator != CyclePad)
1786 CycleNodes.push_back(CycleTerminator);
1787 CyclePad = getSuccPad(CycleTerminator);
1788 } while (CyclePad != SuccPad);
1789 Assert(false, "EH pads can't handle each other's exceptions",
1790 ArrayRef<Instruction *>(CycleNodes));
1791 }
1792 // Don't re-walk a node we've already checked
1793 if (!Visited.insert(SuccPad).second)
1794 break;
1795 // Walk to this successor if it has a map entry.
1796 PredPad = SuccPad;
1797 auto TermI = SiblingFuncletInfo.find(PredPad);
1798 if (TermI == SiblingFuncletInfo.end())
1799 break;
1800 Terminator = TermI->second;
1801 Active.insert(PredPad);
1802 } while (true);
1803 // Each node only has one successor, so we've walked all the active
1804 // nodes' successors.
1805 Active.clear();
1806 }
1807}
1808
Chris Lattner0e851da2002-04-18 20:37:37 +00001809// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001810//
Chandler Carruth043949d2014-01-19 02:22:18 +00001811void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001812 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001813 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001814 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001815
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001816 Assert(Context == &F.getContext(),
1817 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001818
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001819 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1820 Assert(FT->getNumParams() == NumArgs,
1821 "# formal arguments must match # of arguments for function type!", &F,
1822 FT);
1823 Assert(F.getReturnType()->isFirstClassType() ||
1824 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1825 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001826
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001827 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1828 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001829
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001830 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001831
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001832 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1833 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001834
Duncan Sands8c582282007-12-21 19:19:01 +00001835 // Check function attributes.
Duncan Sands0009c442008-01-12 16:42:01 +00001836 VerifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001837
Michael Gottesman41748d72013-06-27 00:25:01 +00001838 // On function declarations/definitions, we do not support the builtin
1839 // attribute. We do not check this in VerifyFunctionAttrs since that is
1840 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001841 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1842 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001843
Chris Lattneref13ee32006-05-19 21:25:17 +00001844 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001845 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1846 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001847 switch (F.getCallingConv()) {
1848 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001849 case CallingConv::C:
1850 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001851 case CallingConv::Fast:
1852 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001853 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001854 case CallingConv::PTX_Kernel:
1855 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001856 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1857 "perfect forwarding!",
1858 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001859 break;
1860 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001861
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001862 bool isLLVMdotName = F.getName().size() >= 5 &&
1863 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001864
Chris Lattneraf95e582002-04-13 22:48:46 +00001865 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001866 unsigned i = 0;
Chandler Carruth043949d2014-01-19 02:22:18 +00001867 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1868 ++I, ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001869 Assert(I->getType() == FT->getParamType(i),
1870 "Argument value does not match function argument type!", I,
1871 FT->getParamType(i));
1872 Assert(I->getType()->isFirstClassType(),
1873 "Function arguments must have first-class types!", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00001874 if (!isLLVMdotName) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001875 Assert(!I->getType()->isMetadataTy(),
1876 "Function takes metadata but isn't an intrinsic", I, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001877 Assert(!I->getType()->isTokenTy(),
1878 "Function takes token but isn't an intrinsic", I, &F);
1879 }
Dan Gohman4051bf42008-08-27 14:44:57 +00001880 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001881
David Majnemerb611e3f2015-08-14 05:09:07 +00001882 if (!isLLVMdotName)
1883 Assert(!F.getReturnType()->isTokenTy(),
1884 "Functions returns a token but isn't an intrinsic", &F);
1885
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001886 // Get the function metadata attachments.
1887 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1888 F.getAllMetadata(MDs);
1889 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Diego Novillo2567f3d2015-05-13 15:13:45 +00001890 VerifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001891
Keno Fischer2ac0c272015-11-16 05:13:30 +00001892 // Check validity of the personality function
1893 if (F.hasPersonalityFn()) {
1894 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1895 if (Per)
1896 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001897 "Referencing personality function in another module!",
1898 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001899 }
1900
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001901 if (F.isMaterializable()) {
1902 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001903 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1904 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001905 } else if (F.isDeclaration()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001906 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1907 "invalid linkage type for function declaration", &F);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001908 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1909 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001910 Assert(!F.hasPersonalityFn(),
1911 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001912 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001913 // Verify that this function (which has a body) is not named "llvm.*". It
1914 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001915 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001916
Chris Lattner149376d2002-10-13 20:57:00 +00001917 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001918 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001919 Assert(pred_empty(Entry),
1920 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001921
Chris Lattner27471742009-11-01 04:08:01 +00001922 // The address of the entry block cannot be taken, unless it is dead.
1923 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001924 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1925 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001926 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001927
1928 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001929 for (const auto &I : MDs) {
1930 // Verify that the attachment is legal.
1931 switch (I.first) {
1932 default:
1933 break;
1934 case LLVMContext::MD_dbg:
1935 Assert(isa<DISubprogram>(I.second),
1936 "function !dbg attachment must be a subprogram", &F, I.second);
1937 break;
1938 }
1939
1940 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001941 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001942 }
Chris Lattner149376d2002-10-13 20:57:00 +00001943 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001944
Chris Lattner7730dcc2009-09-11 17:05:29 +00001945 // If this function is actually an intrinsic, verify that it is only used in
1946 // direct call/invokes, never having its "address taken".
Michael Zolotukhin65c01202016-01-14 09:02:45 +00001947 if (F.getIntrinsicID()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001948 const User *U;
1949 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001950 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00001951 }
Nico Rieck7157bb72014-01-14 15:22:47 +00001952
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001953 Assert(!F.hasDLLImportStorageClass() ||
1954 (F.isDeclaration() && F.hasExternalLinkage()) ||
1955 F.hasAvailableExternallyLinkage(),
1956 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00001957
1958 auto *N = F.getSubprogram();
1959 if (!N)
1960 return;
1961
1962 // Check that all !dbg attachments lead to back to N (or, at least, another
1963 // subprogram that describes the same function).
1964 //
1965 // FIXME: Check this incrementally while visiting !dbg attachments.
1966 // FIXME: Only check when N is the canonical subprogram for F.
1967 SmallPtrSet<const MDNode *, 32> Seen;
1968 for (auto &BB : F)
1969 for (auto &I : BB) {
1970 // Be careful about using DILocation here since we might be dealing with
1971 // broken code (this is the Verifier after all).
1972 DILocation *DL =
1973 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1974 if (!DL)
1975 continue;
1976 if (!Seen.insert(DL).second)
1977 continue;
1978
1979 DILocalScope *Scope = DL->getInlinedAtScope();
1980 if (Scope && !Seen.insert(Scope).second)
1981 continue;
1982
1983 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00001984
1985 // Scope and SP could be the same MDNode and we don't want to skip
1986 // validation in that case
1987 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00001988 continue;
1989
1990 // FIXME: Once N is canonical, check "SP == &N".
1991 Assert(SP->describes(&F),
1992 "!dbg attachment points at wrong subprogram for function", N, &F,
1993 &I, DL, Scope, SP);
1994 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001995}
1996
Chris Lattner0e851da2002-04-18 20:37:37 +00001997// verifyBasicBlock - Verify that a basic block is well formed...
1998//
Chris Lattner069a7952002-06-25 15:56:27 +00001999void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002000 InstsInThisBlock.clear();
2001
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002002 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002003 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002004
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002005 // Check constraints that this basic block imposes on all of the PHI nodes in
2006 // it.
2007 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002008 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2009 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002010 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002011 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002012 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002013 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002014 Assert(PN->getNumIncomingValues() != 0,
2015 "PHI nodes must have at least one entry. If the block is dead, "
2016 "the PHI should be removed!",
2017 PN);
2018 Assert(PN->getNumIncomingValues() == Preds.size(),
2019 "PHINode should have one entry for each predecessor of its "
2020 "parent basic block!",
2021 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002022
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002023 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002024 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002025 Values.reserve(PN->getNumIncomingValues());
2026 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2027 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2028 PN->getIncomingValue(i)));
2029 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002030
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002031 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2032 // Check to make sure that if there is more than one entry for a
2033 // particular basic block in this PHI node, that the incoming values are
2034 // all identical.
2035 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002036 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2037 Values[i].second == Values[i - 1].second,
2038 "PHI node has multiple entries for the same basic block with "
2039 "different incoming values!",
2040 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002041
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002042 // Check to make sure that the predecessors and PHI node entries are
2043 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002044 Assert(Values[i].first == Preds[i],
2045 "PHI node entries do not match predecessors!", PN,
2046 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002047 }
2048 }
2049 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002050
2051 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002052 for (auto &I : BB)
2053 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002054 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002055 }
Chris Lattner069a7952002-06-25 15:56:27 +00002056}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002057
Chris Lattner069a7952002-06-25 15:56:27 +00002058void Verifier::visitTerminatorInst(TerminatorInst &I) {
2059 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002060 Assert(&I == I.getParent()->getTerminator(),
2061 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002062 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002063}
2064
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002065void Verifier::visitBranchInst(BranchInst &BI) {
2066 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002067 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2068 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002069 }
2070 visitTerminatorInst(BI);
2071}
2072
Chris Lattner069a7952002-06-25 15:56:27 +00002073void Verifier::visitReturnInst(ReturnInst &RI) {
2074 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002075 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002076 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002077 Assert(N == 0,
2078 "Found return instr that returns non-void in Function of void "
2079 "return type!",
2080 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002081 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002082 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2083 "Function return type does not match operand "
2084 "type of return inst!",
2085 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002086
Misha Brukman7eb05a12003-08-18 14:43:39 +00002087 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002088 // terminators...
2089 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002090}
2091
Chris Lattnerab5aa142004-05-21 16:47:21 +00002092void Verifier::visitSwitchInst(SwitchInst &SI) {
2093 // Check to make sure that all of the constants in the switch instruction
2094 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002095 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002096 SmallPtrSet<ConstantInt*, 32> Constants;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00002097 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002098 Assert(i.getCaseValue()->getType() == SwitchTy,
2099 "Switch constants must all be same type as switch value!", &SI);
2100 Assert(Constants.insert(i.getCaseValue()).second,
2101 "Duplicate integer as switch case", &SI, i.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002102 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002103
Chris Lattnerab5aa142004-05-21 16:47:21 +00002104 visitTerminatorInst(SI);
2105}
2106
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002107void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002108 Assert(BI.getAddress()->getType()->isPointerTy(),
2109 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002110 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002111 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2112 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002113
2114 visitTerminatorInst(BI);
2115}
2116
Chris Lattner75648e72004-03-12 05:54:31 +00002117void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002118 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2119 SI.getOperand(2)),
2120 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002121
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002122 Assert(SI.getTrueValue()->getType() == SI.getType(),
2123 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002124 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002125}
2126
Misha Brukmanc566ca362004-03-02 00:22:19 +00002127/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2128/// a pass, if any exist, it's an error.
2129///
Chris Lattner903a25d2002-11-21 16:54:22 +00002130void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002131 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002132}
Chris Lattner0e851da2002-04-18 20:37:37 +00002133
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002134void Verifier::visitTruncInst(TruncInst &I) {
2135 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002136 Type *SrcTy = I.getOperand(0)->getType();
2137 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002138
2139 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002140 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2141 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002142
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002143 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2144 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2145 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2146 "trunc source and destination must both be a vector or neither", &I);
2147 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002148
2149 visitInstruction(I);
2150}
2151
2152void Verifier::visitZExtInst(ZExtInst &I) {
2153 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002154 Type *SrcTy = I.getOperand(0)->getType();
2155 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002156
2157 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002158 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2159 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2160 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2161 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002162 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2163 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002164
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002165 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002166
2167 visitInstruction(I);
2168}
2169
2170void Verifier::visitSExtInst(SExtInst &I) {
2171 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002172 Type *SrcTy = I.getOperand(0)->getType();
2173 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002174
2175 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002176 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2177 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002178
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002179 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2180 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2181 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2182 "sext source and destination must both be a vector or neither", &I);
2183 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002184
2185 visitInstruction(I);
2186}
2187
2188void Verifier::visitFPTruncInst(FPTruncInst &I) {
2189 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002190 Type *SrcTy = I.getOperand(0)->getType();
2191 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002192 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002193 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2194 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002195
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002196 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2197 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2198 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2199 "fptrunc source and destination must both be a vector or neither", &I);
2200 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002201
2202 visitInstruction(I);
2203}
2204
2205void Verifier::visitFPExtInst(FPExtInst &I) {
2206 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002207 Type *SrcTy = I.getOperand(0)->getType();
2208 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002209
2210 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002211 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2212 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002213
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002214 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2215 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2216 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2217 "fpext source and destination must both be a vector or neither", &I);
2218 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002219
2220 visitInstruction(I);
2221}
2222
2223void Verifier::visitUIToFPInst(UIToFPInst &I) {
2224 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002225 Type *SrcTy = I.getOperand(0)->getType();
2226 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002227
Duncan Sands19d0b472010-02-16 11:11:14 +00002228 bool SrcVec = SrcTy->isVectorTy();
2229 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002230
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002231 Assert(SrcVec == DstVec,
2232 "UIToFP source and dest must both be vector or scalar", &I);
2233 Assert(SrcTy->isIntOrIntVectorTy(),
2234 "UIToFP source must be integer or integer vector", &I);
2235 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2236 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002237
2238 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002239 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2240 cast<VectorType>(DestTy)->getNumElements(),
2241 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002242
2243 visitInstruction(I);
2244}
2245
2246void Verifier::visitSIToFPInst(SIToFPInst &I) {
2247 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002248 Type *SrcTy = I.getOperand(0)->getType();
2249 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002250
Duncan Sands19d0b472010-02-16 11:11:14 +00002251 bool SrcVec = SrcTy->isVectorTy();
2252 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002253
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002254 Assert(SrcVec == DstVec,
2255 "SIToFP source and dest must both be vector or scalar", &I);
2256 Assert(SrcTy->isIntOrIntVectorTy(),
2257 "SIToFP source must be integer or integer vector", &I);
2258 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2259 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002260
2261 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002262 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2263 cast<VectorType>(DestTy)->getNumElements(),
2264 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002265
2266 visitInstruction(I);
2267}
2268
2269void Verifier::visitFPToUIInst(FPToUIInst &I) {
2270 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002271 Type *SrcTy = I.getOperand(0)->getType();
2272 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002273
Duncan Sands19d0b472010-02-16 11:11:14 +00002274 bool SrcVec = SrcTy->isVectorTy();
2275 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002276
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002277 Assert(SrcVec == DstVec,
2278 "FPToUI source and dest must both be vector or scalar", &I);
2279 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2280 &I);
2281 Assert(DestTy->isIntOrIntVectorTy(),
2282 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002283
2284 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002285 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2286 cast<VectorType>(DestTy)->getNumElements(),
2287 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002288
2289 visitInstruction(I);
2290}
2291
2292void Verifier::visitFPToSIInst(FPToSIInst &I) {
2293 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002294 Type *SrcTy = I.getOperand(0)->getType();
2295 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002296
Duncan Sands19d0b472010-02-16 11:11:14 +00002297 bool SrcVec = SrcTy->isVectorTy();
2298 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002299
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002300 Assert(SrcVec == DstVec,
2301 "FPToSI source and dest must both be vector or scalar", &I);
2302 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2303 &I);
2304 Assert(DestTy->isIntOrIntVectorTy(),
2305 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002306
2307 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002308 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2309 cast<VectorType>(DestTy)->getNumElements(),
2310 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002311
2312 visitInstruction(I);
2313}
2314
2315void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2316 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002317 Type *SrcTy = I.getOperand(0)->getType();
2318 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002319
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002320 Assert(SrcTy->getScalarType()->isPointerTy(),
2321 "PtrToInt source must be pointer", &I);
2322 Assert(DestTy->getScalarType()->isIntegerTy(),
2323 "PtrToInt result must be integral", &I);
2324 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2325 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002326
2327 if (SrcTy->isVectorTy()) {
2328 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2329 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002330 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2331 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002332 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002333
2334 visitInstruction(I);
2335}
2336
2337void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2338 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002339 Type *SrcTy = I.getOperand(0)->getType();
2340 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002341
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002342 Assert(SrcTy->getScalarType()->isIntegerTy(),
2343 "IntToPtr source must be an integral", &I);
2344 Assert(DestTy->getScalarType()->isPointerTy(),
2345 "IntToPtr result must be a pointer", &I);
2346 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2347 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002348 if (SrcTy->isVectorTy()) {
2349 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2350 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002351 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2352 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002353 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002354 visitInstruction(I);
2355}
2356
2357void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002358 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002359 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2360 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002361 visitInstruction(I);
2362}
2363
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002364void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2365 Type *SrcTy = I.getOperand(0)->getType();
2366 Type *DestTy = I.getType();
2367
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002368 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2369 &I);
2370 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2371 &I);
2372 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2373 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002374 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002375 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2376 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002377 visitInstruction(I);
2378}
2379
Misha Brukmanc566ca362004-03-02 00:22:19 +00002380/// visitPHINode - Ensure that a PHI node is well formed.
2381///
Chris Lattner069a7952002-06-25 15:56:27 +00002382void Verifier::visitPHINode(PHINode &PN) {
2383 // Ensure that the PHI nodes are all grouped together at the top of the block.
2384 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002385 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002386 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002387 Assert(&PN == &PN.getParent()->front() ||
2388 isa<PHINode>(--BasicBlock::iterator(&PN)),
2389 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002390
David Majnemerb611e3f2015-08-14 05:09:07 +00002391 // Check that a PHI doesn't yield a Token.
2392 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2393
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002394 // Check that all of the values of the PHI node have the same type as the
2395 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002396 for (Value *IncValue : PN.incoming_values()) {
2397 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002398 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002399 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002400
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002401 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002402
2403 visitInstruction(PN);
2404}
2405
Duncan Sands8c582282007-12-21 19:19:01 +00002406void Verifier::VerifyCallSite(CallSite CS) {
2407 Instruction *I = CS.getInstruction();
2408
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002409 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2410 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002411 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002412
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002413 Assert(FPTy->getElementType()->isFunctionTy(),
2414 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002415
2416 Assert(FPTy->getElementType() == CS.getFunctionType(),
2417 "Called function is not the same type as the call!", I);
2418
2419 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002420
2421 // Verify that the correct number of arguments are being passed
2422 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002423 Assert(CS.arg_size() >= FTy->getNumParams(),
2424 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002425 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002426 Assert(CS.arg_size() == FTy->getNumParams(),
2427 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002428
Chris Lattner609de002010-05-10 20:58:42 +00002429 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002430 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002431 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2432 "Call parameter type does not match function signature!",
2433 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002434
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002435 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002436
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002437 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2438 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002439
Duncan Sands8c582282007-12-21 19:19:01 +00002440 // Verify call attributes.
Duncan Sands0009c442008-01-12 16:42:01 +00002441 VerifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002442
David Majnemer91db08b2014-04-30 17:22:00 +00002443 // Conservatively check the inalloca argument.
2444 // We have a bug if we can find that there is an underlying alloca without
2445 // inalloca.
2446 if (CS.hasInAllocaArgument()) {
2447 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2448 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002449 Assert(AI->isUsedWithInAlloca(),
2450 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002451 }
2452
Stephen Linb8bd2322013-04-20 05:14:40 +00002453 if (FTy->isVarArg()) {
2454 // FIXME? is 'nest' even legal here?
2455 bool SawNest = false;
2456 bool SawReturned = false;
2457
2458 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2459 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2460 SawNest = true;
2461 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2462 SawReturned = true;
2463 }
2464
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002465 // Check attributes on the varargs part.
2466 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002467 Type *Ty = CS.getArgument(Idx-1)->getType();
Stephen Linb8bd2322013-04-20 05:14:40 +00002468 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002469
Stephen Linb8bd2322013-04-20 05:14:40 +00002470 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002471 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002472 SawNest = true;
2473 }
2474
2475 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002476 Assert(!SawReturned, "More than one parameter has attribute returned!",
2477 I);
2478 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2479 "Incompatible argument and return types for 'returned' "
2480 "attribute",
2481 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002482 SawReturned = true;
2483 }
Duncan Sands0009c442008-01-12 16:42:01 +00002484
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002485 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2486 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002487
2488 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002489 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002490 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002491 }
Duncan Sands8c582282007-12-21 19:19:01 +00002492
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002493 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002494 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002495 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002496 for (Type *ParamTy : FTy->params()) {
2497 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002498 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002499 Assert(!ParamTy->isTokenTy(),
2500 "Function has token parameter but isn't an intrinsic", I);
2501 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002502 }
2503
David Majnemerb611e3f2015-08-14 05:09:07 +00002504 // Verify that indirect calls don't return tokens.
2505 if (CS.getCalledFunction() == nullptr)
2506 Assert(!FTy->getReturnType()->isTokenTy(),
2507 "Return type cannot be token for indirect call!");
2508
Philip Reamesa3c6f002015-06-26 21:39:44 +00002509 if (Function *F = CS.getCalledFunction())
2510 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002511 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002512
David Majnemer3bb88c02015-12-15 21:27:27 +00002513 // Verify that a callsite has at most one "deopt" and one "funclet" operand
2514 // bundle.
2515 bool FoundDeoptBundle = false, FoundFuncletBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002516 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002517 OperandBundleUse BU = CS.getOperandBundleAt(i);
2518 uint32_t Tag = BU.getTagID();
2519 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002520 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2521 FoundDeoptBundle = true;
2522 }
David Majnemer3bb88c02015-12-15 21:27:27 +00002523 if (Tag == LLVMContext::OB_funclet) {
2524 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2525 FoundFuncletBundle = true;
2526 Assert(BU.Inputs.size() == 1,
2527 "Expected exactly one funclet bundle operand", I);
2528 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2529 "Funclet bundle operands should correspond to a FuncletPadInst",
2530 I);
2531 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002532 }
2533
Duncan Sands8c582282007-12-21 19:19:01 +00002534 visitInstruction(*I);
2535}
2536
Reid Kleckner5772b772014-04-24 20:14:34 +00002537/// Two types are "congruent" if they are identical, or if they are both pointer
2538/// types with different pointee types and the same address space.
2539static bool isTypeCongruent(Type *L, Type *R) {
2540 if (L == R)
2541 return true;
2542 PointerType *PL = dyn_cast<PointerType>(L);
2543 PointerType *PR = dyn_cast<PointerType>(R);
2544 if (!PL || !PR)
2545 return false;
2546 return PL->getAddressSpace() == PR->getAddressSpace();
2547}
2548
Reid Klecknerd20c9702014-05-15 23:58:57 +00002549static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2550 static const Attribute::AttrKind ABIAttrs[] = {
2551 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2552 Attribute::InReg, Attribute::Returned};
2553 AttrBuilder Copy;
2554 for (auto AK : ABIAttrs) {
2555 if (Attrs.hasAttribute(I + 1, AK))
2556 Copy.addAttribute(AK);
2557 }
2558 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2559 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2560 return Copy;
2561}
2562
Reid Kleckner5772b772014-04-24 20:14:34 +00002563void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002564 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002565
2566 // - The caller and callee prototypes must match. Pointer types of
2567 // parameters or return types may differ in pointee type, but not
2568 // address space.
2569 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002570 FunctionType *CallerTy = F->getFunctionType();
2571 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002572 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2573 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2574 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2575 "cannot guarantee tail call due to mismatched varargs", &CI);
2576 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2577 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002578 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002579 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002580 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2581 "cannot guarantee tail call due to mismatched parameter types", &CI);
2582 }
2583
2584 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002585 Assert(F->getCallingConv() == CI.getCallingConv(),
2586 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002587
2588 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2589 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002590 AttributeSet CallerAttrs = F->getAttributes();
2591 AttributeSet CalleeAttrs = CI.getAttributes();
2592 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002593 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2594 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002595 Assert(CallerABIAttrs == CalleeABIAttrs,
2596 "cannot guarantee tail call due to mismatched ABI impacting "
2597 "function attributes",
2598 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002599 }
2600
2601 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2602 // or a pointer bitcast followed by a ret instruction.
2603 // - The ret instruction must return the (possibly bitcasted) value
2604 // produced by the call or void.
2605 Value *RetVal = &CI;
2606 Instruction *Next = CI.getNextNode();
2607
2608 // Handle the optional bitcast.
2609 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002610 Assert(BI->getOperand(0) == RetVal,
2611 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002612 RetVal = BI;
2613 Next = BI->getNextNode();
2614 }
2615
2616 // Check the return.
2617 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002618 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2619 &CI);
2620 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2621 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002622}
2623
Duncan Sands8c582282007-12-21 19:19:01 +00002624void Verifier::visitCallInst(CallInst &CI) {
2625 VerifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002626
Reid Kleckner5772b772014-04-24 20:14:34 +00002627 if (CI.isMustTailCall())
2628 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002629}
2630
2631void Verifier::visitInvokeInst(InvokeInst &II) {
2632 VerifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002633
David Majnemer654e1302015-07-31 17:58:14 +00002634 // Verify that the first non-PHI instruction of the unwind destination is an
2635 // exception handling instruction.
2636 Assert(
2637 II.getUnwindDest()->isEHPad(),
2638 "The unwind destination does not have an exception handling instruction!",
2639 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002640
Dan Gohman9c6e1882010-08-02 23:09:14 +00002641 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002642}
Chris Lattner0e851da2002-04-18 20:37:37 +00002643
Misha Brukmanc566ca362004-03-02 00:22:19 +00002644/// visitBinaryOperator - Check that both arguments to the binary operator are
2645/// of the same type!
2646///
Chris Lattner069a7952002-06-25 15:56:27 +00002647void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002648 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2649 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002650
Reid Spencer2341c222007-02-02 02:16:23 +00002651 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002652 // Check that integer arithmetic operators are only used with
2653 // integral operands.
2654 case Instruction::Add:
2655 case Instruction::Sub:
2656 case Instruction::Mul:
2657 case Instruction::SDiv:
2658 case Instruction::UDiv:
2659 case Instruction::SRem:
2660 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002661 Assert(B.getType()->isIntOrIntVectorTy(),
2662 "Integer arithmetic operators only work with integral types!", &B);
2663 Assert(B.getType() == B.getOperand(0)->getType(),
2664 "Integer arithmetic operators must have same type "
2665 "for operands and result!",
2666 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002667 break;
2668 // Check that floating-point arithmetic operators are only used with
2669 // floating-point operands.
2670 case Instruction::FAdd:
2671 case Instruction::FSub:
2672 case Instruction::FMul:
2673 case Instruction::FDiv:
2674 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002675 Assert(B.getType()->isFPOrFPVectorTy(),
2676 "Floating-point arithmetic operators only work with "
2677 "floating-point types!",
2678 &B);
2679 Assert(B.getType() == B.getOperand(0)->getType(),
2680 "Floating-point arithmetic operators must have same type "
2681 "for operands and result!",
2682 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002683 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002684 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002685 case Instruction::And:
2686 case Instruction::Or:
2687 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002688 Assert(B.getType()->isIntOrIntVectorTy(),
2689 "Logical operators only work with integral types!", &B);
2690 Assert(B.getType() == B.getOperand(0)->getType(),
2691 "Logical operators must have same type for operands and result!",
2692 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002693 break;
2694 case Instruction::Shl:
2695 case Instruction::LShr:
2696 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002697 Assert(B.getType()->isIntOrIntVectorTy(),
2698 "Shifts only work with integral types!", &B);
2699 Assert(B.getType() == B.getOperand(0)->getType(),
2700 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002701 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002702 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002703 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002704 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002705
Chris Lattner0e851da2002-04-18 20:37:37 +00002706 visitInstruction(B);
2707}
2708
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002709void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002710 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002711 Type *Op0Ty = IC.getOperand(0)->getType();
2712 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002713 Assert(Op0Ty == Op1Ty,
2714 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002715 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002716 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2717 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002718 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002719 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2720 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2721 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002722
Reid Spencerd9436b62006-11-20 01:22:35 +00002723 visitInstruction(IC);
2724}
2725
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002726void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002727 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002728 Type *Op0Ty = FC.getOperand(0)->getType();
2729 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002730 Assert(Op0Ty == Op1Ty,
2731 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002732 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002733 Assert(Op0Ty->isFPOrFPVectorTy(),
2734 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002735 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002736 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2737 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2738 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002739
Reid Spencerd9436b62006-11-20 01:22:35 +00002740 visitInstruction(FC);
2741}
2742
Robert Bocchino23004482006-01-10 19:05:34 +00002743void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002744 Assert(
2745 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2746 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002747 visitInstruction(EI);
2748}
2749
Robert Bocchinoca27f032006-01-17 20:07:22 +00002750void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002751 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2752 IE.getOperand(2)),
2753 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002754 visitInstruction(IE);
2755}
2756
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002757void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002758 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2759 SV.getOperand(2)),
2760 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002761 visitInstruction(SV);
2762}
2763
Chris Lattner069a7952002-06-25 15:56:27 +00002764void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002765 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002766
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002767 Assert(isa<PointerType>(TargetTy),
2768 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002769 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002770 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002771 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002772 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002773 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002774
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002775 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002776 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002777 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002778
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002779 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002780 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002781 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2782 if (GEP.getPointerOperandType()->isVectorTy())
2783 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2784 "Vector GEP result width doesn't match operand's", &GEP);
Duncan Sandse6beec62012-11-13 12:59:33 +00002785 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2786 Type *IndexTy = Idxs[i]->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002787 if (IndexTy->isVectorTy()) {
2788 unsigned IndexWidth = IndexTy->getVectorNumElements();
2789 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2790 }
2791 Assert(IndexTy->getScalarType()->isIntegerTy(),
2792 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002793 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002794 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002795 visitInstruction(GEP);
2796}
2797
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002798static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2799 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2800}
2801
Philip Reamesbf9676f2014-10-20 23:52:07 +00002802void Verifier::visitRangeMetadata(Instruction& I,
2803 MDNode* Range, Type* Ty) {
2804 assert(Range &&
2805 Range == I.getMetadata(LLVMContext::MD_range) &&
2806 "precondition violation");
2807
2808 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002809 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002810 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002811 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2812
Philip Reamesbf9676f2014-10-20 23:52:07 +00002813 ConstantRange LastRange(1); // Dummy initial value
2814 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002815 ConstantInt *Low =
2816 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002817 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002818 ConstantInt *High =
2819 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002820 Assert(High, "The upper limit must be an integer!", High);
2821 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2822 "Range types must match instruction type!", &I);
2823
Philip Reamesbf9676f2014-10-20 23:52:07 +00002824 APInt HighV = High->getValue();
2825 APInt LowV = Low->getValue();
2826 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002827 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2828 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002829 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002830 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2831 "Intervals are overlapping", Range);
2832 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2833 Range);
2834 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2835 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002836 }
2837 LastRange = ConstantRange(LowV, HighV);
2838 }
2839 if (NumRanges > 2) {
2840 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002841 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002842 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002843 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002844 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002845 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2846 "Intervals are overlapping", Range);
2847 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2848 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002849 }
2850}
2851
JF Bastiend1fb5852015-12-17 22:09:19 +00002852void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2853 const Instruction *I) {
2854 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2855 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2856 Assert(!(Size & (Size - 1)),
2857 "atomic memory access' operand must have a power-of-two size", Ty, I);
2858}
2859
Chris Lattner069a7952002-06-25 15:56:27 +00002860void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002861 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002862 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002863 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002864 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2865 "huge alignment values are unsupported", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002866 if (LI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002867 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2868 "Load cannot have Release ordering", &LI);
2869 Assert(LI.getAlignment() != 0,
2870 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002871 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2872 ElTy->isFloatingPointTy(),
2873 "atomic load operand must have integer, pointer, or floating point "
2874 "type!",
2875 ElTy, &LI);
2876 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002877 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002878 Assert(LI.getSynchScope() == CrossThread,
2879 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002880 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002881
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002882 visitInstruction(LI);
2883}
2884
Chris Lattner069a7952002-06-25 15:56:27 +00002885void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002886 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002887 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002888 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002889 Assert(ElTy == SI.getOperand(0)->getType(),
2890 "Stored value type does not match pointer operand type!", &SI, ElTy);
2891 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2892 "huge alignment values are unsupported", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002893 if (SI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002894 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2895 "Store cannot have Acquire ordering", &SI);
2896 Assert(SI.getAlignment() != 0,
2897 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002898 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2899 ElTy->isFloatingPointTy(),
2900 "atomic store operand must have integer, pointer, or floating point "
2901 "type!",
2902 ElTy, &SI);
2903 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002904 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002905 Assert(SI.getSynchScope() == CrossThread,
2906 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002907 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002908 visitInstruction(SI);
2909}
2910
Victor Hernandez8acf2952009-10-23 21:09:37 +00002911void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00002912 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00002913 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002914 Assert(PTy->getAddressSpace() == 0,
2915 "Allocation instruction pointer not in the generic address space!",
2916 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00002917 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002918 "Cannot allocate unsized type", &AI);
2919 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2920 "Alloca array size must have integer type", &AI);
2921 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2922 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00002923
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00002924 visitInstruction(AI);
2925}
2926
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002927void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00002928
2929 // FIXME: more conditions???
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002930 Assert(CXI.getSuccessOrdering() != NotAtomic,
2931 "cmpxchg instructions must be atomic.", &CXI);
2932 Assert(CXI.getFailureOrdering() != NotAtomic,
2933 "cmpxchg instructions must be atomic.", &CXI);
2934 Assert(CXI.getSuccessOrdering() != Unordered,
2935 "cmpxchg instructions cannot be unordered.", &CXI);
2936 Assert(CXI.getFailureOrdering() != Unordered,
2937 "cmpxchg instructions cannot be unordered.", &CXI);
2938 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2939 "cmpxchg instructions be at least as constrained on success as fail",
2940 &CXI);
2941 Assert(CXI.getFailureOrdering() != Release &&
2942 CXI.getFailureOrdering() != AcquireRelease,
2943 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00002944
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002945 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002946 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002947 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002948 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2949 ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002950 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002951 Assert(ElTy == CXI.getOperand(1)->getType(),
2952 "Expected value type does not match pointer operand type!", &CXI,
2953 ElTy);
2954 Assert(ElTy == CXI.getOperand(2)->getType(),
2955 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002956 visitInstruction(CXI);
2957}
2958
2959void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002960 Assert(RMWI.getOrdering() != NotAtomic,
2961 "atomicrmw instructions must be atomic.", &RMWI);
2962 Assert(RMWI.getOrdering() != Unordered,
2963 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002964 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002965 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002966 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002967 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2968 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002969 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002970 Assert(ElTy == RMWI.getOperand(1)->getType(),
2971 "Argument value type does not match pointer operand type!", &RMWI,
2972 ElTy);
2973 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2974 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2975 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002976 visitInstruction(RMWI);
2977}
2978
Eli Friedmanfee02c62011-07-25 23:16:38 +00002979void Verifier::visitFenceInst(FenceInst &FI) {
2980 const AtomicOrdering Ordering = FI.getOrdering();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002981 Assert(Ordering == Acquire || Ordering == Release ||
2982 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2983 "fence instructions may only have "
2984 "acquire, release, acq_rel, or seq_cst ordering.",
2985 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00002986 visitInstruction(FI);
2987}
2988
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002989void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002990 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2991 EVI.getIndices()) == EVI.getType(),
2992 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002993
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002994 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00002995}
2996
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002997void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002998 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2999 IVI.getIndices()) ==
3000 IVI.getOperand(1)->getType(),
3001 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003002
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003003 visitInstruction(IVI);
3004}
Chris Lattner0e851da2002-04-18 20:37:37 +00003005
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003006static Value *getParentPad(Value *EHPad) {
3007 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3008 return FPI->getParentPad();
3009
3010 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3011}
3012
David Majnemer85a549d2015-08-11 02:48:30 +00003013void Verifier::visitEHPadPredecessors(Instruction &I) {
3014 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003015
David Majnemer85a549d2015-08-11 02:48:30 +00003016 BasicBlock *BB = I.getParent();
3017 Function *F = BB->getParent();
3018
3019 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3020
3021 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3022 // The landingpad instruction defines its parent as a landing pad block. The
3023 // landing pad block may be branched to only by the unwind edge of an
3024 // invoke.
3025 for (BasicBlock *PredBB : predecessors(BB)) {
3026 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3027 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3028 "Block containing LandingPadInst must be jumped to "
3029 "only by the unwind edge of an invoke.",
3030 LPI);
3031 }
3032 return;
3033 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003034 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3035 if (!pred_empty(BB))
3036 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3037 "Block containg CatchPadInst must be jumped to "
3038 "only by its catchswitch.",
3039 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003040 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3041 "Catchswitch cannot unwind to one of its catchpads",
3042 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003043 return;
3044 }
David Majnemer85a549d2015-08-11 02:48:30 +00003045
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003046 // Verify that each pred has a legal terminator with a legal to/from EH
3047 // pad relationship.
3048 Instruction *ToPad = &I;
3049 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003050 for (BasicBlock *PredBB : predecessors(BB)) {
3051 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003052 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003053 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003054 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003055 "EH pad must be jumped to via an unwind edge", ToPad, II);
3056 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3057 FromPad = Bundle->Inputs[0];
3058 else
3059 FromPad = ConstantTokenNone::get(II->getContext());
3060 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
3061 FromPad = CRI->getCleanupPad();
3062 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3063 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3064 FromPad = CSI;
3065 } else {
3066 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3067 }
3068
3069 // The edge may exit from zero or more nested pads.
3070 for (;; FromPad = getParentPad(FromPad)) {
3071 Assert(FromPad != ToPad,
3072 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3073 if (FromPad == ToPadParent) {
3074 // This is a legal unwind edge.
3075 break;
3076 }
3077 Assert(!isa<ConstantTokenNone>(FromPad),
3078 "A single unwind edge may only enter one EH pad", TI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003079 }
David Majnemer85a549d2015-08-11 02:48:30 +00003080 }
3081}
3082
3083void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003084 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3085 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003086 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3087 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003088
David Majnemer85a549d2015-08-11 02:48:30 +00003089 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003090
David Majnemer654e1302015-07-31 17:58:14 +00003091 if (!LandingPadResultTy)
3092 LandingPadResultTy = LPI.getType();
3093 else
3094 Assert(LandingPadResultTy == LPI.getType(),
3095 "The landingpad instruction should have a consistent result type "
3096 "inside a function.",
3097 &LPI);
3098
David Majnemer7fddecc2015-06-17 20:52:32 +00003099 Function *F = LPI.getParent()->getParent();
3100 Assert(F->hasPersonalityFn(),
3101 "LandingPadInst needs to be in a function with a personality.", &LPI);
3102
Bill Wendlingfae14752011-08-12 20:24:12 +00003103 // The landingpad instruction must be the first non-PHI instruction in the
3104 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003105 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3106 "LandingPadInst not the first non-PHI instruction in the block.",
3107 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003108
Duncan Sands86de1a62011-09-27 16:43:19 +00003109 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003110 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003111 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003112 Assert(isa<PointerType>(Clause->getType()),
3113 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003114 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003115 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3116 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3117 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003118 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003119 }
3120
Bill Wendlingfae14752011-08-12 20:24:12 +00003121 visitInstruction(LPI);
3122}
3123
David Majnemer654e1302015-07-31 17:58:14 +00003124void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003125 visitEHPadPredecessors(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003126
David Majnemer85a549d2015-08-11 02:48:30 +00003127 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003128
David Majnemer654e1302015-07-31 17:58:14 +00003129 Function *F = BB->getParent();
3130 Assert(F->hasPersonalityFn(),
3131 "CatchPadInst needs to be in a function with a personality.", &CPI);
3132
David Majnemer8a1c45d2015-12-12 05:38:55 +00003133 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3134 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3135 CPI.getParentPad());
3136
David Majnemer654e1302015-07-31 17:58:14 +00003137 // The catchpad instruction must be the first non-PHI instruction in the
3138 // block.
3139 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003140 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003141
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003142 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003143}
3144
David Majnemer8a1c45d2015-12-12 05:38:55 +00003145void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3146 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3147 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3148 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003149
David Majnemer8a1c45d2015-12-12 05:38:55 +00003150 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003151}
3152
3153void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003154 visitEHPadPredecessors(CPI);
3155
David Majnemer654e1302015-07-31 17:58:14 +00003156 BasicBlock *BB = CPI.getParent();
3157
David Majnemer654e1302015-07-31 17:58:14 +00003158 Function *F = BB->getParent();
3159 Assert(F->hasPersonalityFn(),
3160 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3161
3162 // The cleanuppad instruction must be the first non-PHI instruction in the
3163 // block.
3164 Assert(BB->getFirstNonPHI() == &CPI,
3165 "CleanupPadInst not the first non-PHI instruction in the block.",
3166 &CPI);
3167
David Majnemer8a1c45d2015-12-12 05:38:55 +00003168 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003169 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003170 "CleanupPadInst has an invalid parent.", &CPI);
3171
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003172 visitFuncletPadInst(CPI);
3173}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003174
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003175void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3176 User *FirstUser = nullptr;
3177 Value *FirstUnwindPad = nullptr;
3178 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
3179 while (!Worklist.empty()) {
3180 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
3181 Value *UnresolvedAncestorPad = nullptr;
3182 for (User *U : CurrentPad->users()) {
3183 BasicBlock *UnwindDest;
3184 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3185 UnwindDest = CRI->getUnwindDest();
3186 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3187 // We allow catchswitch unwind to caller to nest
3188 // within an outer pad that unwinds somewhere else,
3189 // because catchswitch doesn't have a nounwind variant.
3190 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3191 if (CSI->unwindsToCaller())
3192 continue;
3193 UnwindDest = CSI->getUnwindDest();
3194 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3195 UnwindDest = II->getUnwindDest();
3196 } else if (isa<CallInst>(U)) {
3197 // Calls which don't unwind may be found inside funclet
3198 // pads that unwind somewhere else. We don't *require*
3199 // such calls to be annotated nounwind.
3200 continue;
3201 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3202 // The unwind dest for a cleanup can only be found by
3203 // recursive search. Add it to the worklist, and we'll
3204 // search for its first use that determines where it unwinds.
3205 Worklist.push_back(CPI);
3206 continue;
3207 } else {
3208 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3209 continue;
3210 }
3211
3212 Value *UnwindPad;
3213 bool ExitsFPI;
3214 if (UnwindDest) {
3215 UnwindPad = UnwindDest->getFirstNonPHI();
3216 Value *UnwindParent = getParentPad(UnwindPad);
3217 // Ignore unwind edges that don't exit CurrentPad.
3218 if (UnwindParent == CurrentPad)
3219 continue;
3220 // Determine whether the original funclet pad is exited,
3221 // and if we are scanning nested pads determine how many
3222 // of them are exited so we can stop searching their
3223 // children.
3224 Value *ExitedPad = CurrentPad;
3225 ExitsFPI = false;
3226 do {
3227 if (ExitedPad == &FPI) {
3228 ExitsFPI = true;
3229 // Now we can resolve any ancestors of CurrentPad up to
3230 // FPI, but not including FPI since we need to make sure
3231 // to check all direct users of FPI for consistency.
3232 UnresolvedAncestorPad = &FPI;
3233 break;
3234 }
3235 Value *ExitedParent = getParentPad(ExitedPad);
3236 if (ExitedParent == UnwindParent) {
3237 // ExitedPad is the ancestor-most pad which this unwind
3238 // edge exits, so we can resolve up to it, meaning that
3239 // ExitedParent is the first ancestor still unresolved.
3240 UnresolvedAncestorPad = ExitedParent;
3241 break;
3242 }
3243 ExitedPad = ExitedParent;
3244 } while (!isa<ConstantTokenNone>(ExitedPad));
3245 } else {
3246 // Unwinding to caller exits all pads.
3247 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3248 ExitsFPI = true;
3249 UnresolvedAncestorPad = &FPI;
3250 }
3251
3252 if (ExitsFPI) {
3253 // This unwind edge exits FPI. Make sure it agrees with other
3254 // such edges.
3255 if (FirstUser) {
3256 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3257 "pad must have the same unwind "
3258 "dest",
3259 &FPI, U, FirstUser);
3260 } else {
3261 FirstUser = U;
3262 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003263 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3264 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3265 getParentPad(UnwindPad) == getParentPad(&FPI))
3266 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003267 }
3268 }
3269 // Make sure we visit all uses of FPI, but for nested pads stop as
3270 // soon as we know where they unwind to.
3271 if (CurrentPad != &FPI)
3272 break;
3273 }
3274 if (UnresolvedAncestorPad) {
3275 if (CurrentPad == UnresolvedAncestorPad) {
3276 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3277 // we've found an unwind edge that exits it, because we need to verify
3278 // all direct uses of FPI.
3279 assert(CurrentPad == &FPI);
3280 continue;
3281 }
3282 // Pop off the worklist any nested pads that we've found an unwind
3283 // destination for. The pads on the worklist are the uncles,
3284 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3285 // for all ancestors of CurrentPad up to but not including
3286 // UnresolvedAncestorPad.
3287 Value *ResolvedPad = CurrentPad;
3288 while (!Worklist.empty()) {
3289 Value *UnclePad = Worklist.back();
3290 Value *AncestorPad = getParentPad(UnclePad);
3291 // Walk ResolvedPad up the ancestor list until we either find the
3292 // uncle's parent or the last resolved ancestor.
3293 while (ResolvedPad != AncestorPad) {
3294 Value *ResolvedParent = getParentPad(ResolvedPad);
3295 if (ResolvedParent == UnresolvedAncestorPad) {
3296 break;
3297 }
3298 ResolvedPad = ResolvedParent;
3299 }
3300 // If the resolved ancestor search didn't find the uncle's parent,
3301 // then the uncle is not yet resolved.
3302 if (ResolvedPad != AncestorPad)
3303 break;
3304 // This uncle is resolved, so pop it from the worklist.
3305 Worklist.pop_back();
3306 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003307 }
3308 }
3309
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003310 if (FirstUnwindPad) {
3311 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3312 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3313 Value *SwitchUnwindPad;
3314 if (SwitchUnwindDest)
3315 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3316 else
3317 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3318 Assert(SwitchUnwindPad == FirstUnwindPad,
3319 "Unwind edges out of a catch must have the same unwind dest as "
3320 "the parent catchswitch",
3321 &FPI, FirstUser, CatchSwitch);
3322 }
3323 }
3324
3325 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003326}
3327
David Majnemer8a1c45d2015-12-12 05:38:55 +00003328void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
3329 visitEHPadPredecessors(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003330
David Majnemer8a1c45d2015-12-12 05:38:55 +00003331 BasicBlock *BB = CatchSwitch.getParent();
3332
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003333 Function *F = BB->getParent();
3334 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003335 "CatchSwitchInst needs to be in a function with a personality.",
3336 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003337
David Majnemer8a1c45d2015-12-12 05:38:55 +00003338 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003339 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003340 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3341 "CatchSwitchInst not the first non-PHI instruction in the block.",
3342 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003343
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003344 auto *ParentPad = CatchSwitch.getParentPad();
3345 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3346 "CatchSwitchInst has an invalid parent.", ParentPad);
3347
David Majnemer8a1c45d2015-12-12 05:38:55 +00003348 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003349 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003350 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3351 "CatchSwitchInst must unwind to an EH block which is not a "
3352 "landingpad.",
3353 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003354
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003355 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3356 if (getParentPad(I) == ParentPad)
3357 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3358 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003359
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003360 Assert(CatchSwitch.getNumHandlers() != 0,
3361 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3362
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003363 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003364 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3365 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003366 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003367
David Majnemer8a1c45d2015-12-12 05:38:55 +00003368 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003369}
3370
David Majnemer654e1302015-07-31 17:58:14 +00003371void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003372 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3373 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3374 CRI.getOperand(0));
3375
David Majnemer654e1302015-07-31 17:58:14 +00003376 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3377 Instruction *I = UnwindDest->getFirstNonPHI();
3378 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3379 "CleanupReturnInst must unwind to an EH block which is not a "
3380 "landingpad.",
3381 &CRI);
3382 }
3383
3384 visitTerminatorInst(CRI);
3385}
3386
Rafael Espindola654320a2012-02-26 02:23:37 +00003387void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3388 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003389 // If the we have an invalid invoke, don't try to compute the dominance.
3390 // We already reject it in the invoke specific checks and the dominance
3391 // computation doesn't handle multiple edges.
3392 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3393 if (II->getNormalDest() == II->getUnwindDest())
3394 return;
3395 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003396
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003397 const Use &U = I.getOperandUse(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003398 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3399 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003400}
3401
Artur Pilipenkocca80022015-10-09 17:41:29 +00003402void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3403 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3404 "apply only to pointer types", &I);
3405 Assert(isa<LoadInst>(I),
3406 "dereferenceable, dereferenceable_or_null apply only to load"
3407 " instructions, use attributes for calls or invokes", &I);
3408 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3409 "take one operand!", &I);
3410 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3411 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3412 "dereferenceable_or_null metadata value must be an i64!", &I);
3413}
3414
Misha Brukmanc566ca362004-03-02 00:22:19 +00003415/// verifyInstruction - Verify that an instruction is well formed.
3416///
Chris Lattner069a7952002-06-25 15:56:27 +00003417void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003418 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003419 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003420
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003421 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003422 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003423 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3424 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003425 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003426 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003427
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003428 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003429 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3430 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003431
Chris Lattner5f126b72004-03-29 00:29:36 +00003432 // Check that the return value of the instruction is either void or a legal
3433 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003434 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3435 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003436
Nick Lewycky93e06a52009-09-27 23:27:42 +00003437 // Check that the instruction doesn't produce metadata. Calls are already
3438 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003439 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3440 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003441
Chris Lattner0e851da2002-04-18 20:37:37 +00003442 // Check that all uses of the instruction, if they are instructions
3443 // themselves, actually have parent basic blocks. If the use is not an
3444 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003445 for (Use &U : I.uses()) {
3446 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003447 Assert(Used->getParent() != nullptr,
3448 "Instruction referencing"
3449 " instruction not embedded in a basic block!",
3450 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003451 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003452 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003453 return;
3454 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003455 }
3456
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003457 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003458 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003459
3460 // Check to make sure that only first-class-values are operands to
3461 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003462 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003463 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003464 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003465
Chris Lattner9ece94b2004-03-14 03:23:54 +00003466 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003467 // Check to make sure that the "address of" an intrinsic function is never
3468 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003469 Assert(
3470 !F->isIntrinsic() ||
3471 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3472 "Cannot take the address of an intrinsic!", &I);
3473 Assert(
3474 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003475 F->getIntrinsicID() == Intrinsic::donothing ||
3476 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003477 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3478 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003479 "Cannot invoke an intrinsinc other than"
3480 " donothing or patchpoint",
3481 &I);
3482 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003483 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003484 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003485 Assert(OpBB->getParent() == BB->getParent(),
3486 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003487 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003488 Assert(OpArg->getParent() == BB->getParent(),
3489 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003490 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003491 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003492 } else if (isa<Instruction>(I.getOperand(i))) {
3493 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003494 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003495 Assert((i + 1 == e && isa<CallInst>(I)) ||
3496 (i + 3 == e && isa<InvokeInst>(I)),
3497 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003498 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3499 if (CE->getType()->isPtrOrPtrVectorTy()) {
3500 // If we have a ConstantExpr pointer, we need to see if it came from an
3501 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003502 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003503 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003504 }
3505 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003506
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003507 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003508 Assert(I.getType()->isFPOrFPVectorTy(),
3509 "fpmath requires a floating point result!", &I);
3510 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003511 if (ConstantFP *CFP0 =
3512 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003513 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003514 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3515 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003516 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003517 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003518 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003519 }
3520
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003521 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003522 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3523 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003524 visitRangeMetadata(I, Range, I.getType());
3525 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003526
Philip Reames0ca58b32014-10-21 20:56:29 +00003527 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003528 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3529 &I);
3530 Assert(isa<LoadInst>(I),
3531 "nonnull applies only to load instructions, use attributes"
3532 " for calls or invokes",
3533 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003534 }
3535
Artur Pilipenkocca80022015-10-09 17:41:29 +00003536 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3537 visitDereferenceableMetadata(I, MD);
3538
3539 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3540 visitDereferenceableMetadata(I, MD);
3541
3542 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3543 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3544 &I);
3545 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3546 "use attributes for calls or invokes", &I);
3547 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3548 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3549 Assert(CI && CI->getType()->isIntegerTy(64),
3550 "align metadata value must be an i64!", &I);
3551 uint64_t Align = CI->getZExtValue();
3552 Assert(isPowerOf2_64(Align),
3553 "align metadata value must be a power of 2!", &I);
3554 Assert(Align <= Value::MaximumAlignment,
3555 "alignment is larger that implementation defined limit", &I);
3556 }
3557
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003558 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003559 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003560 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003561 }
3562
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003563 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003564}
3565
Chris Lattner144b6192012-05-27 19:37:05 +00003566/// VerifyIntrinsicType - Verify that the specified type (which comes from an
3567/// intrinsic argument or return value) matches the type constraints specified
3568/// by the .td file (e.g. an "any integer" argument really is an integer).
3569///
3570/// This return true on error but does not print a message.
3571bool Verifier::VerifyIntrinsicType(Type *Ty,
3572 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3573 SmallVectorImpl<Type*> &ArgTys) {
3574 using namespace Intrinsic;
3575
3576 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003577 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003578 IITDescriptor D = Infos.front();
3579 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003580
Chris Lattner144b6192012-05-27 19:37:05 +00003581 switch (D.Kind) {
3582 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003583 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003584 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003585 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003586 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003587 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003588 case IITDescriptor::Float: return !Ty->isFloatTy();
3589 case IITDescriptor::Double: return !Ty->isDoubleTy();
3590 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3591 case IITDescriptor::Vector: {
3592 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003593 return !VT || VT->getNumElements() != D.Vector_Width ||
Chris Lattner144b6192012-05-27 19:37:05 +00003594 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3595 }
3596 case IITDescriptor::Pointer: {
3597 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003598 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Chris Lattner144b6192012-05-27 19:37:05 +00003599 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3600 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003601
Chris Lattner144b6192012-05-27 19:37:05 +00003602 case IITDescriptor::Struct: {
3603 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003604 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003605 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003606
Chris Lattner144b6192012-05-27 19:37:05 +00003607 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3608 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3609 return true;
3610 return false;
3611 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003612
Chris Lattner144b6192012-05-27 19:37:05 +00003613 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003614 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003615 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003616 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003617 return Ty != ArgTys[D.getArgumentNumber()];
3618
Chris Lattner144b6192012-05-27 19:37:05 +00003619 // Otherwise, if this is the first instance of an argument, record it and
3620 // verify the "Any" kind.
3621 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3622 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003623
Chris Lattner144b6192012-05-27 19:37:05 +00003624 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003625 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003626 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3627 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3628 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3629 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3630 }
3631 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003632
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003633 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003634 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003635 if (D.getArgumentNumber() >= ArgTys.size())
3636 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003637
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003638 Type *NewTy = ArgTys[D.getArgumentNumber()];
3639 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3640 NewTy = VectorType::getExtendedElementVectorType(VTy);
3641 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3642 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3643 else
3644 return true;
3645
3646 return Ty != NewTy;
3647 }
3648 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003649 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003650 if (D.getArgumentNumber() >= ArgTys.size())
3651 return true;
3652
3653 Type *NewTy = ArgTys[D.getArgumentNumber()];
3654 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3655 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3656 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3657 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3658 else
3659 return true;
3660
3661 return Ty != NewTy;
3662 }
Tim Northover4516de32014-03-29 07:04:54 +00003663 case IITDescriptor::HalfVecArgument:
3664 // This may only be used when referring to a previous vector argument.
3665 return D.getArgumentNumber() >= ArgTys.size() ||
3666 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3667 VectorType::getHalfElementsVectorType(
3668 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003669 case IITDescriptor::SameVecWidthArgument: {
3670 if (D.getArgumentNumber() >= ArgTys.size())
3671 return true;
3672 VectorType * ReferenceType =
3673 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3674 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3675 if (!ThisArgType || !ReferenceType ||
3676 (ReferenceType->getVectorNumElements() !=
3677 ThisArgType->getVectorNumElements()))
3678 return true;
3679 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3680 Infos, ArgTys);
3681 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003682 case IITDescriptor::PtrToArgument: {
3683 if (D.getArgumentNumber() >= ArgTys.size())
3684 return true;
3685 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3686 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3687 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3688 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003689 case IITDescriptor::VecOfPtrsToElt: {
3690 if (D.getArgumentNumber() >= ArgTys.size())
3691 return true;
3692 VectorType * ReferenceType =
3693 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3694 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3695 if (!ThisArgVecTy || !ReferenceType ||
3696 (ReferenceType->getVectorNumElements() !=
3697 ThisArgVecTy->getVectorNumElements()))
3698 return true;
3699 PointerType *ThisArgEltTy =
3700 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3701 if (!ThisArgEltTy)
3702 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003703 return ThisArgEltTy->getElementType() !=
3704 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003705 }
Chris Lattner144b6192012-05-27 19:37:05 +00003706 }
3707 llvm_unreachable("unhandled");
3708}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003709
Andrew Tricka2efd992013-10-31 17:18:11 +00003710/// \brief Verify if the intrinsic has variable arguments.
3711/// This method is intended to be called after all the fixed arguments have been
3712/// verified first.
3713///
3714/// This method returns true on error and does not print an error message.
3715bool
3716Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3717 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3718 using namespace Intrinsic;
3719
3720 // If there are no descriptors left, then it can't be a vararg.
3721 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003722 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003723
3724 // There should be only one descriptor remaining at this point.
3725 if (Infos.size() != 1)
3726 return true;
3727
3728 // Check and verify the descriptor.
3729 IITDescriptor D = Infos.front();
3730 Infos = Infos.slice(1);
3731 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003732 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003733
3734 return true;
3735}
3736
Philip Reames007561a2015-06-26 22:21:52 +00003737/// Allow intrinsics to be verified in different ways.
3738void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003739 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003740 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3741 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003742
Chris Lattner144b6192012-05-27 19:37:05 +00003743 // Verify that the intrinsic prototype lines up with what the .td files
3744 // describe.
3745 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003746 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003747
Chris Lattner144b6192012-05-27 19:37:05 +00003748 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3749 getIntrinsicInfoTableEntries(ID, Table);
3750 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003751
Chris Lattner144b6192012-05-27 19:37:05 +00003752 SmallVector<Type *, 4> ArgTys;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003753 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3754 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003755 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003756 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3757 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003758
3759 // Verify if the intrinsic call matches the vararg property.
3760 if (IsVarArg)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003761 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3762 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003763 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003764 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3765 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003766
3767 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003768 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003769
3770 // Now that we have the intrinsic ID and the actual argument types (and we
3771 // know they are legal for the intrinsic!) get the intrinsic name through the
3772 // usual means. This allows us to verify the mangling of argument types into
3773 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003774 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003775 Assert(ExpectedName == IF->getName(),
3776 "Intrinsic name not mangled correctly for type arguments! "
3777 "Should be: " +
3778 ExpectedName,
3779 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003780
Chris Lattner588096e2009-12-28 09:07:21 +00003781 // If the intrinsic takes MDNode arguments, verify that they are either global
3782 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003783 for (Value *V : CS.args())
3784 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3785 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003786
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003787 switch (ID) {
3788 default:
3789 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003790 case Intrinsic::ctlz: // llvm.ctlz
3791 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003792 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003793 "is_zero_undef argument of bit counting intrinsics must be a "
3794 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003795 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003796 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003797 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003798 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3799 "invalid llvm.dbg.declare intrinsic call 1", CS);
3800 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003801 break;
3802 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003803 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003804 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003805 case Intrinsic::memcpy:
3806 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003807 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003808 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003809 Assert(AlignCI,
3810 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003811 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003812 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003813 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003814 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003815 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003816 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003817 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003818 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003819 }
Bill Wendling05604e02008-08-23 09:46:46 +00003820 case Intrinsic::gcroot:
3821 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003822 case Intrinsic::gcread:
3823 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003824 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003825 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3826 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3827 Assert(isa<Constant>(CS.getArgOperand(1)),
3828 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003829 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003830 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003831 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3832 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003833 CS);
Talin2e59f142010-09-30 20:23:47 +00003834 }
Chris Lattner25852062008-08-24 20:46:13 +00003835 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003836
Philip Reames9818dd72015-06-26 22:04:34 +00003837 Assert(CS.getParent()->getParent()->hasGC(),
3838 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003839 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003840 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003841 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003842 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003843 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003844 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003845 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003846 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3847 isa<ConstantInt>(CS.getArgOperand(2)) &&
3848 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3849 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3850 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003851 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003852 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003853 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3854 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003855 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003856 case Intrinsic::lifetime_start:
3857 case Intrinsic::lifetime_end:
3858 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003859 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003860 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003861 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003862 break;
3863 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003864 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3865 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003866 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003867
Reid Kleckner60381792015-07-07 22:25:32 +00003868 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003869 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003870 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003871 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003872 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003873 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003874 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003875 if (isa<ConstantPointerNull>(Arg))
3876 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003877 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003878 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003879 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003880 }
Philip Reames9818dd72015-06-26 22:04:34 +00003881 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003882 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003883 break;
3884 }
Reid Kleckner60381792015-07-07 22:25:32 +00003885 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003886 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003887 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003888 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003889 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003890 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003891 CS);
3892 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003893 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003894 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003895 auto &Entry = FrameEscapeInfo[Fn];
3896 Entry.second = unsigned(
3897 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003898 break;
3899 }
3900
Philip Reames1ffa9372015-01-30 23:28:05 +00003901 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00003902 Assert(!CS.isInlineAsm(),
3903 "gc.statepoint support for inline assembly unimplemented", CS);
3904 Assert(CS.getParent()->getParent()->hasGC(),
3905 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00003906
Philip Reames9818dd72015-06-26 22:04:34 +00003907 VerifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003908 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003909 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00003910 Assert(CS.getParent()->getParent()->hasGC(),
3911 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003912 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00003913 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00003914 const Function *StatepointFn =
3915 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003916 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3917 StatepointFn->getIntrinsicID() ==
3918 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00003919 "gc.result operand #1 must be from a statepoint", CS,
3920 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00003921
Philip Reamesb23713a2014-12-03 22:23:24 +00003922 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003923 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00003924 auto *PT = cast<PointerType>(Target->getType());
3925 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00003926 Assert(CS.getType() == TargetFuncType->getReturnType(),
3927 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003928 break;
3929 }
3930 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00003931 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003932
Philip Reames3e2cf532016-01-07 03:32:11 +00003933 Assert(isa<PointerType>(CS.getType()->getScalarType()),
3934 "gc.relocate must return a pointer or a vector of pointers", CS);
3935
Igor Laevsky9570ff92015-02-19 11:28:47 +00003936 // Check that this relocate is correctly tied to the statepoint
3937
3938 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00003939 if (LandingPadInst *LandingPad =
3940 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00003941
Sanjoy Das5665c992015-05-11 23:47:27 +00003942 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00003943 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00003944
3945 // Landingpad relocates should have only one predecessor with invoke
3946 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00003947 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00003948 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00003949 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3950 InvokeBB);
3951 Assert(isStatepoint(InvokeBB->getTerminator()),
3952 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003953 }
3954 else {
3955 // In all other cases relocate should be tied to the statepoint directly.
3956 // This covers relocates on a normal return path of invoke statepoint and
3957 // relocates of a call statepoint
Philip Reames9818dd72015-06-26 22:04:34 +00003958 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003959 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00003960 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003961 }
3962
3963 // Verify rest of the relocate arguments
3964
Manuel Jacob83eefa62016-01-05 04:03:00 +00003965 ImmutableCallSite StatepointCS(
3966 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00003967
3968 // Both the base and derived must be piped through the safepoint
Philip Reames9818dd72015-06-26 22:04:34 +00003969 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003970 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00003971 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003972
Philip Reames9818dd72015-06-26 22:04:34 +00003973 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003974 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00003975 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003976
3977 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3978 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3979 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003980 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003981 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003982 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003983 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00003984
3985 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3986 // section of the statepoint's argument
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003987 Assert(StatepointCS.arg_size() > 0,
3988 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003989 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00003990 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003991 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003992 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3993 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003994 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003995 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00003996 "gc.statepoint: number of transition arguments must be "
3997 "a constant integer");
3998 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003999 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4000 ->getZExtValue();
4001 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004002 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004003 "gc.statepoint: number of deoptimization arguments must be "
4004 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004005 const int NumDeoptArgs =
Pat Gavlincc0431d2015-05-08 18:07:42 +00004006 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
4007 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004008 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004009 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4010 "gc.relocate: statepoint base index doesn't fall within the "
4011 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004012 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004013 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4014 "gc.relocate: statepoint derived index doesn't fall within the "
4015 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004016 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004017
Philip Reames3e2cf532016-01-07 03:32:11 +00004018 // Relocated value must be either a pointer type or vector-of-pointer type,
4019 // but gc_relocate does not need to return the same pointer type as the
4020 // relocated pointer. It can be casted to the correct type later if it's
4021 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004022 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004023 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004024 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004025
Philip Reames3e2cf532016-01-07 03:32:11 +00004026 auto ResultType = CS.getType();
4027 auto DerivedType = Relocate.getDerivedPtr()->getType();
4028 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
4029 "gc.relocate: vector relocates to vector and pointer to pointer", CS);
4030 Assert(ResultType->getPointerAddressSpace() ==
4031 DerivedType->getPointerAddressSpace(),
Philip Reames9818dd72015-06-26 22:04:34 +00004032 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004033 break;
4034 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004035 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004036 case Intrinsic::eh_exceptionpointer: {
4037 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4038 "eh.exceptionpointer argument must be a catchpad", CS);
4039 break;
4040 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004041 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004042}
4043
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004044/// \brief Carefully grab the subprogram from a local scope.
4045///
4046/// This carefully grabs the subprogram from a local scope, avoiding the
4047/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004048static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004049 if (!LocalScope)
4050 return nullptr;
4051
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004052 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004053 return SP;
4054
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004055 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004056 return getSubprogram(LB->getRawScope());
4057
4058 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004059 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004060 return nullptr;
4061}
4062
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004063template <class DbgIntrinsicTy>
4064void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4065 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
4066 Assert(isa<ValueAsMetadata>(MD) ||
4067 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4068 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004069 Assert(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004070 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4071 DII.getRawVariable());
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004072 Assert(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004073 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4074 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004075
4076 // Ignore broken !dbg attachments; they're checked elsewhere.
4077 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004078 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004079 return;
4080
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004081 BasicBlock *BB = DII.getParent();
4082 Function *F = BB ? BB->getParent() : nullptr;
4083
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004084 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004085 DILocalVariable *Var = DII.getVariable();
4086 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004087 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4088 &DII, BB, F);
4089
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004090 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4091 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004092 if (!VarSP || !LocSP)
4093 return; // Broken scope chains are checked elsewhere.
4094
4095 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4096 " variable and !dbg attachment",
4097 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4098 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004099}
4100
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004101template <class MapTy>
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004102static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004103 // Be careful of broken types (checked elsewhere).
4104 const Metadata *RawType = V.getRawType();
4105 while (RawType) {
4106 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004107 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004108 if (uint64_t Size = T->getSizeInBits())
4109 return Size;
4110
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004111 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004112 // Look at the base type.
4113 RawType = DT->getRawBaseType();
4114 continue;
4115 }
4116
4117 if (auto *S = dyn_cast<MDString>(RawType)) {
4118 // Don't error on missing types (checked elsewhere).
4119 RawType = Map.lookup(S);
4120 continue;
4121 }
4122
4123 // Missing type or size.
4124 break;
4125 }
4126
4127 // Fail gracefully.
4128 return 0;
4129}
4130
4131template <class MapTy>
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004132void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
4133 const MapTy &TypeRefs) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004134 DILocalVariable *V;
4135 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004136 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004137 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4138 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004139 } else {
4140 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004141 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4142 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004143 }
4144
4145 // We don't know whether this intrinsic verified correctly.
4146 if (!V || !E || !E->isValid())
4147 return;
4148
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004149 // Nothing to do if this isn't a bit piece expression.
4150 if (!E->isBitPiece())
4151 return;
4152
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004153 // The frontend helps out GDB by emitting the members of local anonymous
4154 // unions as artificial local variables with shared storage. When SROA splits
4155 // the storage for artificial local variables that are smaller than the entire
4156 // union, the overhang piece will be outside of the allotted space for the
4157 // variable and this check fails.
4158 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4159 if (V->isArtificial())
4160 return;
4161
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004162 // If there's no size, the type is broken, but that should be checked
4163 // elsewhere.
4164 uint64_t VarSize = getVariableSize(*V, TypeRefs);
4165 if (!VarSize)
4166 return;
4167
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004168 unsigned PieceSize = E->getBitPieceSize();
4169 unsigned PieceOffset = E->getBitPieceOffset();
4170 Assert(PieceSize + PieceOffset <= VarSize,
4171 "piece is larger than or outside of variable", &I, V, E);
4172 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004173}
4174
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004175void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
4176 // This is in its own function so we get an error for each bad type ref (not
4177 // just the first).
4178 Assert(false, "unresolved type ref", S, N);
4179}
4180
4181void Verifier::verifyTypeRefs() {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004182 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4183 if (!CUs)
4184 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004185
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004186 // Visit all the compile units again to map the type references.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004187 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004188 for (auto *CU : CUs->operands())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004189 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
4190 for (DIType *Op : Ts)
David Blaikie3c338f32015-08-22 22:36:40 +00004191 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004192 if (auto *S = T->getRawIdentifier()) {
4193 UnresolvedTypeRefs.erase(S);
4194 TypeRefs.insert(std::make_pair(S, T));
4195 }
4196
4197 // Verify debug info intrinsic bit piece expressions. This needs a second
4198 // pass through the intructions, since we haven't built TypeRefs yet when
4199 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
4200 // later/now would queue up some that could be later deleted.
4201 for (const Function &F : *M)
4202 for (const BasicBlock &BB : F)
4203 for (const Instruction &I : BB)
4204 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004205 verifyBitPieceExpression(*DII, TypeRefs);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004206
4207 // Return early if all typerefs were resolved.
4208 if (UnresolvedTypeRefs.empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004209 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004210
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004211 // Sort the unresolved references by name so the output is deterministic.
4212 typedef std::pair<const MDString *, const MDNode *> TypeRef;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004213 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
4214 UnresolvedTypeRefs.end());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004215 std::sort(Unresolved.begin(), Unresolved.end(),
4216 [](const TypeRef &LHS, const TypeRef &RHS) {
4217 return LHS.first->getString() < RHS.first->getString();
4218 });
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004219
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004220 // Visit the unresolved refs (printing out the errors).
4221 for (const TypeRef &TR : Unresolved)
4222 visitUnresolvedTypeRef(TR.first, TR.second);
Manman Ren74c61b92013-07-19 00:31:03 +00004223}
4224
Chris Lattner0e851da2002-04-18 20:37:37 +00004225//===----------------------------------------------------------------------===//
4226// Implement the public interfaces to this file...
4227//===----------------------------------------------------------------------===//
4228
Chandler Carruth043949d2014-01-19 02:22:18 +00004229bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004230 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00004231 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00004232
Chandler Carruth043949d2014-01-19 02:22:18 +00004233 raw_null_ostream NullStr;
4234 Verifier V(OS ? *OS : NullStr);
4235
4236 // Note that this function's return value is inverted from what you would
4237 // expect of a function called "verify".
4238 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004239}
4240
Chandler Carruth043949d2014-01-19 02:22:18 +00004241bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
4242 raw_null_ostream NullStr;
4243 Verifier V(OS ? *OS : NullStr);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004244
Chandler Carruth043949d2014-01-19 02:22:18 +00004245 bool Broken = false;
4246 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindolad4bcefc2014-10-24 18:13:04 +00004247 if (!I->isDeclaration() && !I->isMaterializable())
Chandler Carruth043949d2014-01-19 02:22:18 +00004248 Broken |= !V.verify(*I);
4249
4250 // Note that this function's return value is inverted from what you would
4251 // expect of a function called "verify".
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +00004252 return !V.verify(M) || Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004253}
Chandler Carruth043949d2014-01-19 02:22:18 +00004254
4255namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004256struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004257 static char ID;
4258
4259 Verifier V;
4260 bool FatalErrors;
4261
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +00004262 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004263 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004264 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004265 explicit VerifierLegacyPass(bool FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004266 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004267 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004268 }
4269
Craig Topperf398d7c2014-03-05 06:35:38 +00004270 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004271 if (!V.verify(F) && FatalErrors)
4272 report_fatal_error("Broken function found, compilation aborted!");
4273
4274 return false;
4275 }
4276
Craig Topperf398d7c2014-03-05 06:35:38 +00004277 bool doFinalization(Module &M) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004278 if (!V.verify(M) && FatalErrors)
4279 report_fatal_error("Broken module found, compilation aborted!");
4280
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004281 return false;
4282 }
4283
4284 void getAnalysisUsage(AnalysisUsage &AU) const override {
4285 AU.setPreservesAll();
4286 }
4287};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004288}
Chandler Carruth043949d2014-01-19 02:22:18 +00004289
Chandler Carruth4d356312014-01-20 11:34:08 +00004290char VerifierLegacyPass::ID = 0;
4291INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004292
4293FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004294 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004295}
4296
Chandler Carruthd174ce42015-01-05 02:47:05 +00004297PreservedAnalyses VerifierPass::run(Module &M) {
4298 if (verifyModule(M, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004299 report_fatal_error("Broken module found, compilation aborted!");
4300
4301 return PreservedAnalyses::all();
4302}
4303
Chandler Carruthd174ce42015-01-05 02:47:05 +00004304PreservedAnalyses VerifierPass::run(Function &F) {
4305 if (verifyFunction(F, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004306 report_fatal_error("Broken function found, compilation aborted!");
4307
4308 return PreservedAnalyses::all();
4309}