blob: c4519c48ab572e7b3386d5f4d133aa6cc82c8f7b [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
465
Chandler Carruth043949d2014-01-19 02:22:18 +0000466void Verifier::visitGlobalValue(const GlobalValue &GV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000467 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
468 GV.hasExternalWeakLinkage(),
469 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000470
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000471 Assert(GV.getAlignment() <= Value::MaximumAlignment,
472 "huge alignment values are unsupported", &GV);
473 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
474 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000475
476 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000477 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000478 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000479 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000480 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000481
482 if (GV.isDeclarationForLinker())
483 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000484}
485
Chandler Carruth043949d2014-01-19 02:22:18 +0000486void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000487 if (GV.hasInitializer()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000488 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
489 "Global variable initializer type does not match global "
490 "variable type!",
491 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000492
Chris Lattner0aff0b22009-08-05 05:41:44 +0000493 // If the global has common linkage, it must have a zero initializer and
494 // cannot be constant.
495 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000496 Assert(GV.getInitializer()->isNullValue(),
497 "'common' global must have a zero initializer!", &GV);
498 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
499 &GV);
500 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000501 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000502 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000503 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
504 "invalid linkage type for global declaration", &GV);
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000505 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000506
Nick Lewycky466d0c12011-04-08 07:30:21 +0000507 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
508 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000509 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
510 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000511 // Don't worry about emitting an error for it not being an array,
512 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000513 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000514 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
515 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000516 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000517 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000518 Assert(STy &&
519 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
520 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
521 STy->getTypeAtIndex(1) == FuncPtrTy,
522 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000523 if (STy->getNumElements() == 3) {
524 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000525 Assert(ETy->isPointerTy() &&
526 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
527 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000528 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000529 }
530 }
531
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000532 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000533 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000534 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
535 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000536 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000537 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
538 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000539 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000540 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000541 const Constant *Init = GV.getInitializer();
542 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000543 Assert(InitArray, "wrong initalizer for intrinsic global variable",
544 Init);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000545 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
Rafael Espindolaeaf53272013-05-27 22:47:09 +0000546 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000547 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
548 isa<GlobalAlias>(V),
549 "invalid llvm.used member", V);
550 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000551 }
552 }
553 }
554 }
555
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000556 Assert(!GV.hasDLLImportStorageClass() ||
557 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
558 GV.hasAvailableExternallyLinkage(),
559 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000560
Matt Arsenault24b49c42013-07-31 17:49:08 +0000561 if (!GV.hasInitializer()) {
562 visitGlobalValue(GV);
563 return;
564 }
565
566 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000567 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000568
Chris Lattnere3400652004-12-15 20:23:49 +0000569 visitGlobalValue(GV);
570}
571
Rafael Espindola64c1e182014-06-03 02:41:57 +0000572void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
573 SmallPtrSet<const GlobalAlias*, 4> Visited;
574 Visited.insert(&GA);
575 visitAliaseeSubExpr(Visited, GA, C);
576}
577
Craig Topper71b7b682014-08-21 05:55:13 +0000578void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000579 const GlobalAlias &GA, const Constant &C) {
580 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000581 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
582 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000583
584 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000585 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000586
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000587 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
588 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000589 } else {
590 // Only continue verifying subexpressions of GlobalAliases.
591 // Do not recurse into global initializers.
592 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000593 }
594 }
595
596 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000597 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000598
599 for (const Use &U : C.operands()) {
600 Value *V = &*U;
601 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
602 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
603 else if (const auto *C2 = dyn_cast<Constant>(V))
604 visitAliaseeSubExpr(Visited, GA, *C2);
605 }
606}
607
Chandler Carruth043949d2014-01-19 02:22:18 +0000608void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000609 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
610 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
611 "weak_odr, or external linkage!",
612 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000613 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000614 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
615 Assert(GA.getType() == Aliasee->getType(),
616 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000617
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000618 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
619 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000620
Rafael Espindola64c1e182014-06-03 02:41:57 +0000621 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000622
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000623 visitGlobalValue(GA);
624}
625
Chandler Carruth043949d2014-01-19 02:22:18 +0000626void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000627 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000628 MDNode *MD = NMD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000629
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000630 if (NMD.getName() == "llvm.dbg.cu") {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000631 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000632 }
633
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000634 if (!MD)
635 continue;
636
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000637 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000638 }
639}
640
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000641void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000642 // Only visit each node once. Metadata can be mutually recursive, so this
643 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000644 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000645 return;
646
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000647 switch (MD.getMetadataID()) {
648 default:
649 llvm_unreachable("Invalid MDNode subclass");
650 case Metadata::MDTupleKind:
651 break;
652#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
653 case Metadata::CLASS##Kind: \
654 visit##CLASS(cast<CLASS>(MD)); \
655 break;
656#include "llvm/IR/Metadata.def"
657 }
658
Duncan Sands76d62172010-04-29 16:10:30 +0000659 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000660 Metadata *Op = MD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000661 if (!Op)
662 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000663 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
664 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000665 if (auto *N = dyn_cast<MDNode>(Op)) {
666 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000667 continue;
668 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000669 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
670 visitValueAsMetadata(*V, nullptr);
671 continue;
672 }
Duncan Sands76d62172010-04-29 16:10:30 +0000673 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000674
675 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000676 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
677 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000678}
679
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000680void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000681 Assert(MD.getValue(), "Expected valid value", &MD);
682 Assert(!MD.getValue()->getType()->isMetadataTy(),
683 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000684
685 auto *L = dyn_cast<LocalAsMetadata>(&MD);
686 if (!L)
687 return;
688
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000689 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000690
691 // If this was an instruction, bb, or argument, verify that it is in the
692 // function that we expect.
693 Function *ActualF = nullptr;
694 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000695 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000696 ActualF = I->getParent()->getParent();
697 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
698 ActualF = BB->getParent();
699 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
700 ActualF = A->getParent();
701 assert(ActualF && "Unimplemented function local metadata case!");
702
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000703 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000704}
705
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000706void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000707 Metadata *MD = MDV.getMetadata();
708 if (auto *N = dyn_cast<MDNode>(MD)) {
709 visitMDNode(*N);
710 return;
711 }
712
713 // Only visit each node once. Metadata can be mutually recursive, so this
714 // avoids infinite recursion here, as well as being an optimization.
715 if (!MDNodes.insert(MD).second)
716 return;
717
718 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
719 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000720}
721
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000722bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
723 auto *S = dyn_cast<MDString>(MD);
724 if (!S)
725 return false;
726 if (S->getString().empty())
727 return false;
728
729 // Keep track of names of types referenced via UUID so we can check that they
730 // actually exist.
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000731 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000732 return true;
733}
734
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000735/// \brief Check if a value can be a reference to a type.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000736bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000737 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000738}
739
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000740/// \brief Check if a value can be a ScopeRef.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000741bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000742 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000743}
744
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000745/// \brief Check if a value can be a debug info ref.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000746bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000747 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000748}
749
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000750template <class Ty>
751bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
752 for (Metadata *MD : N.operands()) {
753 if (MD) {
754 if (!isa<Ty>(MD))
755 return false;
756 } else {
757 if (!AllowNull)
758 return false;
759 }
760 }
761 return true;
762}
763
764template <class Ty>
765bool isValidMetadataArray(const MDTuple &N) {
766 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
767}
768
769template <class Ty>
770bool isValidMetadataNullArray(const MDTuple &N) {
771 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
772}
773
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000774void Verifier::visitDILocation(const DILocation &N) {
775 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000776 "location requires a valid scope", &N, N.getRawScope());
777 if (auto *IA = N.getRawInlinedAt())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000778 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000779}
780
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000781void Verifier::visitGenericDINode(const GenericDINode &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000782 Assert(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000783}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000784
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000785void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000786 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000787 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000788}
789
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000790void Verifier::visitDISubrange(const DISubrange &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000791 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000792 Assert(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000793}
794
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000795void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000796 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000797}
798
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000799void Verifier::visitDIBasicType(const DIBasicType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000800 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
801 N.getTag() == dwarf::DW_TAG_unspecified_type,
802 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000803}
804
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000805void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000806 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000807 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000808
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000809 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
810 N.getTag() == dwarf::DW_TAG_pointer_type ||
811 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
812 N.getTag() == dwarf::DW_TAG_reference_type ||
813 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
814 N.getTag() == dwarf::DW_TAG_const_type ||
815 N.getTag() == dwarf::DW_TAG_volatile_type ||
816 N.getTag() == dwarf::DW_TAG_restrict_type ||
817 N.getTag() == dwarf::DW_TAG_member ||
818 N.getTag() == dwarf::DW_TAG_inheritance ||
819 N.getTag() == dwarf::DW_TAG_friend,
820 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000821 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000822 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
823 N.getExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000824 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000825
826 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
827 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
828 N.getBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000829}
830
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000831static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000832 return (Flags & DINode::FlagLValueReference) &&
833 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000834}
835
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000836void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
837 auto *Params = dyn_cast<MDTuple>(&RawParams);
838 Assert(Params, "invalid template params", &N, &RawParams);
839 for (Metadata *Op : Params->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000840 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000841 Params, Op);
842 }
843}
844
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000845void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000846 // Common scope checks.
847 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000848
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000849 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
850 N.getTag() == dwarf::DW_TAG_structure_type ||
851 N.getTag() == dwarf::DW_TAG_union_type ||
852 N.getTag() == dwarf::DW_TAG_enumeration_type ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000853 N.getTag() == dwarf::DW_TAG_class_type,
854 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000855
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000856 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
857 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
858 N.getBaseType());
859
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000860 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
861 "invalid composite elements", &N, N.getRawElements());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000862 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000863 N.getRawVTableHolder());
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000864 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
865 &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000866 if (auto *Params = N.getRawTemplateParams())
867 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000868
869 if (N.getTag() == dwarf::DW_TAG_class_type ||
870 N.getTag() == dwarf::DW_TAG_union_type) {
871 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
872 "class/union requires a filename", &N, N.getFile());
873 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000874}
875
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000876void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000877 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000878 if (auto *Types = N.getRawTypeArray()) {
879 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
880 for (Metadata *Ty : N.getTypeArray()->operands()) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000881 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000882 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000883 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000884 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
885 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000886}
887
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000888void Verifier::visitDIFile(const DIFile &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000889 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000890}
891
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000892void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000893 Assert(N.isDistinct(), "compile units must be distinct", &N);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000894 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000895
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000896 // Don't bother verifying the compilation directory or producer string
897 // as those could be empty.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000898 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
899 N.getRawFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000900 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
901 N.getFile());
902
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000903 if (auto *Array = N.getRawEnumTypes()) {
904 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
905 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000906 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000907 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
908 "invalid enum type", &N, N.getEnumTypes(), Op);
909 }
910 }
911 if (auto *Array = N.getRawRetainedTypes()) {
912 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
913 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000914 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000915 }
916 }
917 if (auto *Array = N.getRawSubprograms()) {
918 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
919 for (Metadata *Op : N.getSubprograms()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000920 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000921 }
922 }
923 if (auto *Array = N.getRawGlobalVariables()) {
924 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
925 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000926 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000927 Op);
928 }
929 }
930 if (auto *Array = N.getRawImportedEntities()) {
931 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
932 for (Metadata *Op : N.getImportedEntities()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000933 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000934 Op);
935 }
936 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000937 if (auto *Array = N.getRawMacros()) {
938 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
939 for (Metadata *Op : N.getMacros()->operands()) {
940 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
941 }
942 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000943}
944
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000945void Verifier::visitDISubprogram(const DISubprogram &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000946 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000947 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000948 if (auto *T = N.getRawType())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000949 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000950 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000951 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000952 if (auto *Params = N.getRawTemplateParams())
953 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000954 if (auto *S = N.getRawDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000955 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000956 "invalid subprogram declaration", &N, S);
957 }
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000958 if (auto *RawVars = N.getRawVariables()) {
959 auto *Vars = dyn_cast<MDTuple>(RawVars);
960 Assert(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000961 for (Metadata *Op : Vars->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000962 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000963 Op);
964 }
965 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000966 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
967 &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +0000968
Duncan P. N. Exon Smith814b8e92015-08-28 20:26:49 +0000969 if (N.isDefinition())
970 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000971}
972
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000973void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000974 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000975 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +0000976 "invalid local scope", &N, N.getRawScope());
977}
978
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000979void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
980 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +0000981
982 Assert(N.getLine() || !N.getColumn(),
983 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000984}
985
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000986void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
987 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000988}
989
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000990void Verifier::visitDINamespace(const DINamespace &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000991 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000992 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000993 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000994}
995
Amjad Abouda9bcf162015-12-10 12:56:35 +0000996void Verifier::visitDIMacro(const DIMacro &N) {
997 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
998 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
999 "invalid macinfo type", &N);
1000 Assert(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001001 if (!N.getValue().empty()) {
1002 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1003 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001004}
1005
1006void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1007 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1008 "invalid macinfo type", &N);
1009 if (auto *F = N.getRawFile())
1010 Assert(isa<DIFile>(F), "invalid file", &N, F);
1011
1012 if (auto *Array = N.getRawElements()) {
1013 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1014 for (Metadata *Op : N.getElements()->operands()) {
1015 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1016 }
1017 }
1018}
1019
Adrian Prantlab1243f2015-06-29 23:03:47 +00001020void Verifier::visitDIModule(const DIModule &N) {
1021 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1022 Assert(!N.getName().empty(), "anonymous module", &N);
1023}
1024
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001025void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001026 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001027}
1028
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001029void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1030 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001031
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001032 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1033 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001034}
1035
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001036void Verifier::visitDITemplateValueParameter(
1037 const DITemplateValueParameter &N) {
1038 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001039
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001040 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1041 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1042 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1043 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001044}
1045
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001046void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001047 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001048 Assert(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001049 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001050 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001051 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001052}
1053
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001054void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001055 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001056 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001057
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001058 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smith94d58f82015-03-31 01:28:22 +00001059 Assert(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001060 if (auto *V = N.getRawVariable()) {
1061 Assert(isa<ConstantAsMetadata>(V) &&
1062 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1063 "invalid global varaible ref", &N, V);
1064 }
1065 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001066 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001067 &N, Member);
1068 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001069}
1070
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001071void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001072 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001073 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001074
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +00001075 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001076 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001077 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001078}
1079
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001080void Verifier::visitDIExpression(const DIExpression &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001081 Assert(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001082}
1083
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001084void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001085 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001086 if (auto *T = N.getRawType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001087 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001088 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001089 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001090}
1091
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001092void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001093 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1094 N.getTag() == dwarf::DW_TAG_imported_declaration,
1095 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001096 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001097 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001098 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1099 N.getEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001100}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001101
David Majnemerdad0a642014-06-27 18:19:56 +00001102void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001103 // The Module is invalid if the GlobalValue has private linkage. Entities
1104 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001105 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001106 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1107 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001108}
1109
Chandler Carruth043949d2014-01-19 02:22:18 +00001110void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001111 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1112 if (!Idents)
1113 return;
1114
1115 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1116 // Scan each llvm.ident entry and make sure that this requirement is met.
1117 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001118 const MDNode *N = Idents->getOperand(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001119 Assert(N->getNumOperands() == 1,
1120 "incorrect number of operands in llvm.ident metadata", N);
1121 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1122 ("invalid value for llvm.ident metadata entry operand"
1123 "(the operand should be a string)"),
1124 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001125 }
1126}
1127
Chandler Carruth043949d2014-01-19 02:22:18 +00001128void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001129 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1130 if (!Flags) return;
1131
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001132 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001133 DenseMap<const MDString*, const MDNode*> SeenIDs;
1134 SmallVector<const MDNode*, 16> Requirements;
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001135 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001136 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001137 }
1138
1139 // Validate that the requirements in the module are valid.
1140 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001141 const MDNode *Requirement = Requirements[I];
1142 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001143 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001144
Chandler Carruth043949d2014-01-19 02:22:18 +00001145 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001146 if (!Op) {
1147 CheckFailed("invalid requirement on flag, flag is not present in module",
1148 Flag);
1149 continue;
1150 }
1151
1152 if (Op->getOperand(2) != ReqValue) {
1153 CheckFailed(("invalid requirement on flag, "
1154 "flag does not have the required value"),
1155 Flag);
1156 continue;
1157 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001158 }
1159}
1160
Chandler Carruth043949d2014-01-19 02:22:18 +00001161void
1162Verifier::visitModuleFlag(const MDNode *Op,
1163 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1164 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001165 // Each module flag should have three arguments, the merge behavior (a
1166 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001167 Assert(Op->getNumOperands() == 3,
1168 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001169 Module::ModFlagBehavior MFB;
1170 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001171 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001172 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001173 "invalid behavior operand in module flag (expected constant integer)",
1174 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001175 Assert(false,
1176 "invalid behavior operand in module flag (unexpected constant)",
1177 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001178 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001179 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001180 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1181 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001182
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001183 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001184 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001185 case Module::Error:
1186 case Module::Warning:
1187 case Module::Override:
1188 // These behavior types accept any value.
1189 break;
1190
1191 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001192 // The value should itself be an MDNode with two operands, a flag ID (an
1193 // MDString), and a value.
1194 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001195 Assert(Value && Value->getNumOperands() == 2,
1196 "invalid value for 'require' module flag (expected metadata pair)",
1197 Op->getOperand(2));
1198 Assert(isa<MDString>(Value->getOperand(0)),
1199 ("invalid value for 'require' module flag "
1200 "(first value operand should be a string)"),
1201 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001202
1203 // Append it to the list of requirements, to check once all module flags are
1204 // scanned.
1205 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001206 break;
1207 }
1208
1209 case Module::Append:
1210 case Module::AppendUnique: {
1211 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001212 Assert(isa<MDNode>(Op->getOperand(2)),
1213 "invalid value for 'append'-type module flag "
1214 "(expected a metadata node)",
1215 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001216 break;
1217 }
1218 }
1219
1220 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001221 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001222 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001223 Assert(Inserted,
1224 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001225 }
1226}
1227
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001228void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001229 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001230 unsigned Slot = ~0U;
1231 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1232 if (Attrs.getSlotIndex(I) == Idx) {
1233 Slot = I;
1234 break;
1235 }
1236
1237 assert(Slot != ~0U && "Attribute set inconsistency!");
1238
1239 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1240 I != E; ++I) {
1241 if (I->isStringAttribute())
1242 continue;
1243
1244 if (I->getKindAsEnum() == Attribute::NoReturn ||
1245 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001246 I->getKindAsEnum() == Attribute::NoInline ||
1247 I->getKindAsEnum() == Attribute::AlwaysInline ||
1248 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1249 I->getKindAsEnum() == Attribute::StackProtect ||
1250 I->getKindAsEnum() == Attribute::StackProtectReq ||
1251 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001252 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001253 I->getKindAsEnum() == Attribute::NoRedZone ||
1254 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1255 I->getKindAsEnum() == Attribute::Naked ||
1256 I->getKindAsEnum() == Attribute::InlineHint ||
1257 I->getKindAsEnum() == Attribute::StackAlignment ||
1258 I->getKindAsEnum() == Attribute::UWTable ||
1259 I->getKindAsEnum() == Attribute::NonLazyBind ||
1260 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1261 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1262 I->getKindAsEnum() == Attribute::SanitizeThread ||
1263 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1264 I->getKindAsEnum() == Attribute::MinSize ||
1265 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001266 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001267 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001268 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001269 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001270 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001271 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001272 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001273 I->getKindAsEnum() == Attribute::NoRecurse ||
1274 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1275 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001276 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001277 CheckFailed("Attribute '" + I->getAsString() +
1278 "' only applies to functions!", V);
1279 return;
1280 }
1281 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1282 I->getKindAsEnum() == Attribute::ReadNone) {
1283 if (Idx == 0) {
1284 CheckFailed("Attribute '" + I->getAsString() +
1285 "' does not apply to function returns");
1286 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001287 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001288 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001289 CheckFailed("Attribute '" + I->getAsString() +
1290 "' does not apply to functions!", V);
1291 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001292 }
1293 }
1294}
1295
Duncan Sandsc3a79922009-06-11 08:11:03 +00001296// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001297// value of the specified type. The value V is printed in error messages.
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001298void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001299 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001300 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001301 return;
1302
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001303 VerifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001304
Bill Wendling908126a2012-10-09 09:51:10 +00001305 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001306 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1307 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1308 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1309 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1310 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1311 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1312 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1313 "'returned' do not apply to return values!",
1314 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001315
Reid Klecknera534a382013-12-19 02:14:12 +00001316 // Check for mutually incompatible attributes. Only inreg is compatible with
1317 // sret.
1318 unsigned AttrCount = 0;
1319 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1320 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1321 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1322 Attrs.hasAttribute(Idx, Attribute::InReg);
1323 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001324 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1325 "and 'sret' are incompatible!",
1326 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001327
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001328 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1329 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1330 "Attributes "
1331 "'inalloca and readonly' are incompatible!",
1332 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001333
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001334 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1335 Attrs.hasAttribute(Idx, Attribute::Returned)),
1336 "Attributes "
1337 "'sret and returned' are incompatible!",
1338 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001339
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001340 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1341 Attrs.hasAttribute(Idx, Attribute::SExt)),
1342 "Attributes "
1343 "'zeroext and signext' are incompatible!",
1344 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001345
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001346 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1347 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1348 "Attributes "
1349 "'readnone and readonly' are incompatible!",
1350 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001351
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001352 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1353 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1354 "Attributes "
1355 "'noinline and alwaysinline' are incompatible!",
1356 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001357
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001358 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001359 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001360 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001361 AttributeSet::get(*Context, Idx,
1362 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001363 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001364
Reid Klecknera534a382013-12-19 02:14:12 +00001365 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001366 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001367 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001368 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1369 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1370 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1371 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001372 }
1373 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001374 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1375 "Attribute 'byval' only applies to parameters with pointer type!",
1376 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001377 }
Duncan Sands0009c442008-01-12 16:42:01 +00001378}
1379
1380// VerifyFunctionAttrs - Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001381// The value V is printed in error messages.
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001382void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001383 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001384 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001385 return;
1386
Duncan Sands8c582282007-12-21 19:19:01 +00001387 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001388 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001389 bool SawSRet = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001390
Chris Lattner8a923e72008-03-12 17:45:29 +00001391 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001392 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001393
Chris Lattner229907c2011-07-18 04:54:35 +00001394 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001395 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001396 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001397 else if (Idx-1 < FT->getNumParams())
1398 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001399 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001400 break; // VarArgs attributes, verified elsewhere.
1401
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001402 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001403
Stephen Linb8bd2322013-04-20 05:14:40 +00001404 if (Idx == 0)
1405 continue;
1406
1407 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001408 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001409 SawNest = true;
1410 }
1411
Stephen Linb8bd2322013-04-20 05:14:40 +00001412 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001413 Assert(!SawReturned, "More than one parameter has attribute returned!",
1414 V);
1415 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1416 "Incompatible "
1417 "argument and return types for 'returned' attribute",
1418 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001419 SawReturned = true;
1420 }
1421
Reid Kleckner79418562014-05-09 22:32:13 +00001422 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001423 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1424 Assert(Idx == 1 || Idx == 2,
1425 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001426 SawSRet = true;
1427 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001428
1429 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001430 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1431 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001432 }
Duncan Sands8c582282007-12-21 19:19:01 +00001433 }
Devang Patel9cc98122008-10-01 23:41:25 +00001434
Bill Wendling77543892013-01-18 21:11:39 +00001435 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1436 return;
1437
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001438 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001439
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001440 Assert(
1441 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1442 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1443 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001444
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001445 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001446 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1447 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1448 Attribute::InaccessibleMemOrArgMemOnly)),
1449 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1450
1451 Assert(
1452 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1453 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1454 Attribute::InaccessibleMemOnly)),
1455 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1456
1457 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001458 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1459 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1460 Attribute::AlwaysInline)),
1461 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001462
1463 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1464 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001465 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1466 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001467
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001468 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1469 Attribute::OptimizeForSize),
1470 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001471
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001472 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1473 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001474 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001475
1476 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1477 Attribute::JumpTable)) {
1478 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001479 Assert(GV->hasUnnamedAddr(),
1480 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001481 }
Duncan Sands8c582282007-12-21 19:19:01 +00001482}
1483
Diego Novillo2567f3d2015-05-13 15:13:45 +00001484void Verifier::VerifyFunctionMetadata(
1485 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1486 if (MDs.empty())
1487 return;
1488
1489 for (unsigned i = 0; i < MDs.size(); i++) {
1490 if (MDs[i].first == LLVMContext::MD_prof) {
1491 MDNode *MD = MDs[i].second;
1492 Assert(MD->getNumOperands() == 2,
1493 "!prof annotations should have exactly 2 operands", MD);
1494
1495 // Check first operand.
1496 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1497 MD);
1498 Assert(isa<MDString>(MD->getOperand(0)),
1499 "expected string with name of the !prof annotation", MD);
1500 MDString *MDS = cast<MDString>(MD->getOperand(0));
1501 StringRef ProfName = MDS->getString();
1502 Assert(ProfName.equals("function_entry_count"),
1503 "first operand should be 'function_entry_count'", MD);
1504
1505 // Check second operand.
1506 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1507 MD);
1508 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1509 "expected integer argument to function_entry_count", MD);
1510 }
1511 }
1512}
1513
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001514void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1515 if (!ConstantExprVisited.insert(EntryC).second)
1516 return;
1517
1518 SmallVector<const Constant *, 16> Stack;
1519 Stack.push_back(EntryC);
1520
1521 while (!Stack.empty()) {
1522 const Constant *C = Stack.pop_back_val();
1523
1524 // Check this constant expression.
1525 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1526 visitConstantExpr(CE);
1527
1528 // Visit all sub-expressions.
1529 for (const Use &U : C->operands()) {
1530 const auto *OpC = dyn_cast<Constant>(U);
1531 if (!OpC)
1532 continue;
1533 if (isa<GlobalValue>(OpC))
1534 continue; // Global values get visited separately.
1535 if (!ConstantExprVisited.insert(OpC).second)
1536 continue;
1537 Stack.push_back(OpC);
1538 }
1539 }
1540}
1541
1542void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001543 if (CE->getOpcode() != Instruction::BitCast)
1544 return;
1545
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001546 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1547 CE->getType()),
1548 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001549}
1550
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001551bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001552 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001553 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001554
Devang Patel82fed672008-09-23 22:35:17 +00001555 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001556 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001557 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001558 || (LastIndex == AttributeSet::FunctionIndex
1559 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001560 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001561
Devang Patel82fed672008-09-23 22:35:17 +00001562 return false;
1563}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001564
Philip Reames1ffa9372015-01-30 23:28:05 +00001565/// \brief Verify that statepoint intrinsic is well formed.
Philip Reames0285c742015-02-03 23:18:47 +00001566void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1567 assert(CS.getCalledFunction() &&
1568 CS.getCalledFunction()->getIntrinsicID() ==
1569 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001570
Philip Reames0285c742015-02-03 23:18:47 +00001571 const Instruction &CI = *CS.getInstruction();
1572
Igor Laevsky39d662f2015-07-11 10:30:36 +00001573 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1574 !CS.onlyAccessesArgMemory(),
1575 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001576 "reordering restrictions required by safepoint semantics",
1577 &CI);
1578
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001579 const Value *IDV = CS.getArgument(0);
1580 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1581 &CI);
1582
1583 const Value *NumPatchBytesV = CS.getArgument(1);
1584 Assert(isa<ConstantInt>(NumPatchBytesV),
1585 "gc.statepoint number of patchable bytes must be a constant integer",
1586 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001587 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001588 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1589 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1590 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1591 "positive",
1592 &CI);
1593
1594 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001595 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001596 Assert(PT && PT->getElementType()->isFunctionTy(),
1597 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001598 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001599
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001600 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001601 Assert(isa<ConstantInt>(NumCallArgsV),
1602 "gc.statepoint number of arguments to underlying call "
1603 "must be constant integer",
1604 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001605 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001606 Assert(NumCallArgs >= 0,
1607 "gc.statepoint number of arguments to underlying call "
1608 "must be positive",
1609 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001610 const int NumParams = (int)TargetFuncType->getNumParams();
1611 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001612 Assert(NumCallArgs >= NumParams,
1613 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001614
1615 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001616 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1617 "gc.statepoint doesn't support wrapping non-void "
1618 "vararg functions yet",
1619 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001620 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001621 Assert(NumCallArgs == NumParams,
1622 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001623
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001624 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001625 Assert(isa<ConstantInt>(FlagsV),
1626 "gc.statepoint flags must be constant integer", &CI);
1627 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1628 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1629 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001630
1631 // Verify that the types of the call parameter arguments match
1632 // the type of the wrapped callee.
1633 for (int i = 0; i < NumParams; i++) {
1634 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001635 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001636 Assert(ArgType == ParamType,
1637 "gc.statepoint call argument does not match wrapped "
1638 "function type",
1639 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001640 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001641
1642 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001643
1644 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1645 Assert(isa<ConstantInt>(NumTransitionArgsV),
1646 "gc.statepoint number of transition arguments "
1647 "must be constant integer",
1648 &CI);
1649 const int NumTransitionArgs =
1650 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1651 Assert(NumTransitionArgs >= 0,
1652 "gc.statepoint number of transition arguments must be positive", &CI);
1653 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1654
1655 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001656 Assert(isa<ConstantInt>(NumDeoptArgsV),
1657 "gc.statepoint number of deoptimization arguments "
1658 "must be constant integer",
1659 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001660 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001661 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1662 "must be positive",
1663 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001664
Pat Gavlincc0431d2015-05-08 18:07:42 +00001665 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001666 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001667 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001668 "gc.statepoint too few arguments according to length fields", &CI);
1669
Philip Reames1ffa9372015-01-30 23:28:05 +00001670 // Check that the only uses of this gc.statepoint are gc.result or
1671 // gc.relocate calls which are tied to this statepoint and thus part
1672 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001673 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001674 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001675 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001676 if (!Call) continue;
Manuel Jacob83eefa62016-01-05 04:03:00 +00001677 Assert(isa<GCRelocateInst>(Call) || isGCResult(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001678 "gc.result or gc.relocate are the only value uses"
1679 "of a gc.statepoint",
1680 &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001681 if (isGCResult(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001682 Assert(Call->getArgOperand(0) == &CI,
1683 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001684 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001685 Assert(Call->getArgOperand(0) == &CI,
1686 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001687 }
1688 }
1689
1690 // Note: It is legal for a single derived pointer to be listed multiple
1691 // times. It's non-optimal, but it is legal. It can also happen after
1692 // insertion if we strip a bitcast away.
1693 // Note: It is really tempting to check that each base is relocated and
1694 // that a derived pointer is never reused as a base pointer. This turns
1695 // out to be problematic since optimizations run after safepoint insertion
1696 // can recognize equality properties that the insertion logic doesn't know
1697 // about. See example statepoint.ll in the verifier subdirectory
1698}
1699
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001700void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001701 for (auto &Counts : FrameEscapeInfo) {
1702 Function *F = Counts.first;
1703 unsigned EscapedObjectCount = Counts.second.first;
1704 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001705 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001706 "all indices passed to llvm.localrecover must be less than the "
1707 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001708 "function",
1709 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001710 }
1711}
1712
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001713static Instruction *getSuccPad(TerminatorInst *Terminator) {
1714 BasicBlock *UnwindDest;
1715 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1716 UnwindDest = II->getUnwindDest();
1717 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1718 UnwindDest = CSI->getUnwindDest();
1719 else
1720 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1721 return UnwindDest->getFirstNonPHI();
1722}
1723
1724void Verifier::verifySiblingFuncletUnwinds() {
1725 SmallPtrSet<Instruction *, 8> Visited;
1726 SmallPtrSet<Instruction *, 8> Active;
1727 for (const auto &Pair : SiblingFuncletInfo) {
1728 Instruction *PredPad = Pair.first;
1729 if (Visited.count(PredPad))
1730 continue;
1731 Active.insert(PredPad);
1732 TerminatorInst *Terminator = Pair.second;
1733 do {
1734 Instruction *SuccPad = getSuccPad(Terminator);
1735 if (Active.count(SuccPad)) {
1736 // Found a cycle; report error
1737 Instruction *CyclePad = SuccPad;
1738 SmallVector<Instruction *, 8> CycleNodes;
1739 do {
1740 CycleNodes.push_back(CyclePad);
1741 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1742 if (CycleTerminator != CyclePad)
1743 CycleNodes.push_back(CycleTerminator);
1744 CyclePad = getSuccPad(CycleTerminator);
1745 } while (CyclePad != SuccPad);
1746 Assert(false, "EH pads can't handle each other's exceptions",
1747 ArrayRef<Instruction *>(CycleNodes));
1748 }
1749 // Don't re-walk a node we've already checked
1750 if (!Visited.insert(SuccPad).second)
1751 break;
1752 // Walk to this successor if it has a map entry.
1753 PredPad = SuccPad;
1754 auto TermI = SiblingFuncletInfo.find(PredPad);
1755 if (TermI == SiblingFuncletInfo.end())
1756 break;
1757 Terminator = TermI->second;
1758 Active.insert(PredPad);
1759 } while (true);
1760 // Each node only has one successor, so we've walked all the active
1761 // nodes' successors.
1762 Active.clear();
1763 }
1764}
1765
Chris Lattner0e851da2002-04-18 20:37:37 +00001766// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001767//
Chandler Carruth043949d2014-01-19 02:22:18 +00001768void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001769 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001770 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001771 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001772
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001773 Assert(Context == &F.getContext(),
1774 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001775
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001776 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1777 Assert(FT->getNumParams() == NumArgs,
1778 "# formal arguments must match # of arguments for function type!", &F,
1779 FT);
1780 Assert(F.getReturnType()->isFirstClassType() ||
1781 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1782 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001783
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001784 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1785 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001786
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001787 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001788
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001789 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1790 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001791
Duncan Sands8c582282007-12-21 19:19:01 +00001792 // Check function attributes.
Duncan Sands0009c442008-01-12 16:42:01 +00001793 VerifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001794
Michael Gottesman41748d72013-06-27 00:25:01 +00001795 // On function declarations/definitions, we do not support the builtin
1796 // attribute. We do not check this in VerifyFunctionAttrs since that is
1797 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001798 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1799 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001800
Chris Lattneref13ee32006-05-19 21:25:17 +00001801 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001802 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1803 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001804 switch (F.getCallingConv()) {
1805 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001806 case CallingConv::C:
1807 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001808 case CallingConv::Fast:
1809 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001810 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001811 case CallingConv::PTX_Kernel:
1812 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001813 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1814 "perfect forwarding!",
1815 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001816 break;
1817 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001818
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001819 bool isLLVMdotName = F.getName().size() >= 5 &&
1820 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001821
Chris Lattneraf95e582002-04-13 22:48:46 +00001822 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001823 unsigned i = 0;
Chandler Carruth043949d2014-01-19 02:22:18 +00001824 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1825 ++I, ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001826 Assert(I->getType() == FT->getParamType(i),
1827 "Argument value does not match function argument type!", I,
1828 FT->getParamType(i));
1829 Assert(I->getType()->isFirstClassType(),
1830 "Function arguments must have first-class types!", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00001831 if (!isLLVMdotName) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001832 Assert(!I->getType()->isMetadataTy(),
1833 "Function takes metadata but isn't an intrinsic", I, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001834 Assert(!I->getType()->isTokenTy(),
1835 "Function takes token but isn't an intrinsic", I, &F);
1836 }
Dan Gohman4051bf42008-08-27 14:44:57 +00001837 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001838
David Majnemerb611e3f2015-08-14 05:09:07 +00001839 if (!isLLVMdotName)
1840 Assert(!F.getReturnType()->isTokenTy(),
1841 "Functions returns a token but isn't an intrinsic", &F);
1842
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001843 // Get the function metadata attachments.
1844 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1845 F.getAllMetadata(MDs);
1846 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Diego Novillo2567f3d2015-05-13 15:13:45 +00001847 VerifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001848
Keno Fischer2ac0c272015-11-16 05:13:30 +00001849 // Check validity of the personality function
1850 if (F.hasPersonalityFn()) {
1851 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1852 if (Per)
1853 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001854 "Referencing personality function in another module!",
1855 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001856 }
1857
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001858 if (F.isMaterializable()) {
1859 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001860 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1861 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001862 } else if (F.isDeclaration()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001863 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1864 "invalid linkage type for function declaration", &F);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001865 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1866 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001867 Assert(!F.hasPersonalityFn(),
1868 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001869 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001870 // Verify that this function (which has a body) is not named "llvm.*". It
1871 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001872 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001873
Chris Lattner149376d2002-10-13 20:57:00 +00001874 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001875 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001876 Assert(pred_empty(Entry),
1877 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001878
Chris Lattner27471742009-11-01 04:08:01 +00001879 // The address of the entry block cannot be taken, unless it is dead.
1880 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001881 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1882 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001883 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001884
1885 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001886 for (const auto &I : MDs) {
1887 // Verify that the attachment is legal.
1888 switch (I.first) {
1889 default:
1890 break;
1891 case LLVMContext::MD_dbg:
1892 Assert(isa<DISubprogram>(I.second),
1893 "function !dbg attachment must be a subprogram", &F, I.second);
1894 break;
1895 }
1896
1897 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001898 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001899 }
Chris Lattner149376d2002-10-13 20:57:00 +00001900 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001901
Chris Lattner7730dcc2009-09-11 17:05:29 +00001902 // If this function is actually an intrinsic, verify that it is only used in
1903 // direct call/invokes, never having its "address taken".
Michael Zolotukhin65c01202016-01-14 09:02:45 +00001904 if (F.getIntrinsicID()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001905 const User *U;
1906 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001907 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00001908 }
Nico Rieck7157bb72014-01-14 15:22:47 +00001909
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001910 Assert(!F.hasDLLImportStorageClass() ||
1911 (F.isDeclaration() && F.hasExternalLinkage()) ||
1912 F.hasAvailableExternallyLinkage(),
1913 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00001914
1915 auto *N = F.getSubprogram();
1916 if (!N)
1917 return;
1918
1919 // Check that all !dbg attachments lead to back to N (or, at least, another
1920 // subprogram that describes the same function).
1921 //
1922 // FIXME: Check this incrementally while visiting !dbg attachments.
1923 // FIXME: Only check when N is the canonical subprogram for F.
1924 SmallPtrSet<const MDNode *, 32> Seen;
1925 for (auto &BB : F)
1926 for (auto &I : BB) {
1927 // Be careful about using DILocation here since we might be dealing with
1928 // broken code (this is the Verifier after all).
1929 DILocation *DL =
1930 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1931 if (!DL)
1932 continue;
1933 if (!Seen.insert(DL).second)
1934 continue;
1935
1936 DILocalScope *Scope = DL->getInlinedAtScope();
1937 if (Scope && !Seen.insert(Scope).second)
1938 continue;
1939
1940 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00001941
1942 // Scope and SP could be the same MDNode and we don't want to skip
1943 // validation in that case
1944 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00001945 continue;
1946
1947 // FIXME: Once N is canonical, check "SP == &N".
1948 Assert(SP->describes(&F),
1949 "!dbg attachment points at wrong subprogram for function", N, &F,
1950 &I, DL, Scope, SP);
1951 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001952}
1953
Chris Lattner0e851da2002-04-18 20:37:37 +00001954// verifyBasicBlock - Verify that a basic block is well formed...
1955//
Chris Lattner069a7952002-06-25 15:56:27 +00001956void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00001957 InstsInThisBlock.clear();
1958
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00001959 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001960 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00001961
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001962 // Check constraints that this basic block imposes on all of the PHI nodes in
1963 // it.
1964 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00001965 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1966 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001967 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001968 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00001969 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001970 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001971 Assert(PN->getNumIncomingValues() != 0,
1972 "PHI nodes must have at least one entry. If the block is dead, "
1973 "the PHI should be removed!",
1974 PN);
1975 Assert(PN->getNumIncomingValues() == Preds.size(),
1976 "PHINode should have one entry for each predecessor of its "
1977 "parent basic block!",
1978 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001979
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001980 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00001981 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001982 Values.reserve(PN->getNumIncomingValues());
1983 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1984 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1985 PN->getIncomingValue(i)));
1986 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001987
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001988 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1989 // Check to make sure that if there is more than one entry for a
1990 // particular basic block in this PHI node, that the incoming values are
1991 // all identical.
1992 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001993 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1994 Values[i].second == Values[i - 1].second,
1995 "PHI node has multiple entries for the same basic block with "
1996 "different incoming values!",
1997 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001998
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001999 // Check to make sure that the predecessors and PHI node entries are
2000 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002001 Assert(Values[i].first == Preds[i],
2002 "PHI node entries do not match predecessors!", PN,
2003 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002004 }
2005 }
2006 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002007
2008 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002009 for (auto &I : BB)
2010 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002011 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002012 }
Chris Lattner069a7952002-06-25 15:56:27 +00002013}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002014
Chris Lattner069a7952002-06-25 15:56:27 +00002015void Verifier::visitTerminatorInst(TerminatorInst &I) {
2016 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002017 Assert(&I == I.getParent()->getTerminator(),
2018 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002019 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002020}
2021
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002022void Verifier::visitBranchInst(BranchInst &BI) {
2023 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002024 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2025 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002026 }
2027 visitTerminatorInst(BI);
2028}
2029
Chris Lattner069a7952002-06-25 15:56:27 +00002030void Verifier::visitReturnInst(ReturnInst &RI) {
2031 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002032 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002033 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002034 Assert(N == 0,
2035 "Found return instr that returns non-void in Function of void "
2036 "return type!",
2037 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002038 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002039 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2040 "Function return type does not match operand "
2041 "type of return inst!",
2042 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002043
Misha Brukman7eb05a12003-08-18 14:43:39 +00002044 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002045 // terminators...
2046 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002047}
2048
Chris Lattnerab5aa142004-05-21 16:47:21 +00002049void Verifier::visitSwitchInst(SwitchInst &SI) {
2050 // Check to make sure that all of the constants in the switch instruction
2051 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002052 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002053 SmallPtrSet<ConstantInt*, 32> Constants;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00002054 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002055 Assert(i.getCaseValue()->getType() == SwitchTy,
2056 "Switch constants must all be same type as switch value!", &SI);
2057 Assert(Constants.insert(i.getCaseValue()).second,
2058 "Duplicate integer as switch case", &SI, i.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002059 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002060
Chris Lattnerab5aa142004-05-21 16:47:21 +00002061 visitTerminatorInst(SI);
2062}
2063
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002064void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002065 Assert(BI.getAddress()->getType()->isPointerTy(),
2066 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002067 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002068 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2069 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002070
2071 visitTerminatorInst(BI);
2072}
2073
Chris Lattner75648e72004-03-12 05:54:31 +00002074void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002075 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2076 SI.getOperand(2)),
2077 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002078
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002079 Assert(SI.getTrueValue()->getType() == SI.getType(),
2080 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002081 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002082}
2083
Misha Brukmanc566ca362004-03-02 00:22:19 +00002084/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2085/// a pass, if any exist, it's an error.
2086///
Chris Lattner903a25d2002-11-21 16:54:22 +00002087void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002088 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002089}
Chris Lattner0e851da2002-04-18 20:37:37 +00002090
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002091void Verifier::visitTruncInst(TruncInst &I) {
2092 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002093 Type *SrcTy = I.getOperand(0)->getType();
2094 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002095
2096 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002097 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2098 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002099
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002100 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2101 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2102 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2103 "trunc source and destination must both be a vector or neither", &I);
2104 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002105
2106 visitInstruction(I);
2107}
2108
2109void Verifier::visitZExtInst(ZExtInst &I) {
2110 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002111 Type *SrcTy = I.getOperand(0)->getType();
2112 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002113
2114 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002115 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2116 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2117 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2118 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002119 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2120 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002121
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002122 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002123
2124 visitInstruction(I);
2125}
2126
2127void Verifier::visitSExtInst(SExtInst &I) {
2128 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002129 Type *SrcTy = I.getOperand(0)->getType();
2130 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002131
2132 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002133 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2134 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002135
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002136 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2137 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2138 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2139 "sext source and destination must both be a vector or neither", &I);
2140 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002141
2142 visitInstruction(I);
2143}
2144
2145void Verifier::visitFPTruncInst(FPTruncInst &I) {
2146 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002147 Type *SrcTy = I.getOperand(0)->getType();
2148 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002149 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002150 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2151 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002152
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002153 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2154 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2155 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2156 "fptrunc source and destination must both be a vector or neither", &I);
2157 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002158
2159 visitInstruction(I);
2160}
2161
2162void Verifier::visitFPExtInst(FPExtInst &I) {
2163 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002164 Type *SrcTy = I.getOperand(0)->getType();
2165 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002166
2167 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002168 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2169 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002170
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002171 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2172 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2173 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2174 "fpext source and destination must both be a vector or neither", &I);
2175 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002176
2177 visitInstruction(I);
2178}
2179
2180void Verifier::visitUIToFPInst(UIToFPInst &I) {
2181 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002182 Type *SrcTy = I.getOperand(0)->getType();
2183 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002184
Duncan Sands19d0b472010-02-16 11:11:14 +00002185 bool SrcVec = SrcTy->isVectorTy();
2186 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002187
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002188 Assert(SrcVec == DstVec,
2189 "UIToFP source and dest must both be vector or scalar", &I);
2190 Assert(SrcTy->isIntOrIntVectorTy(),
2191 "UIToFP source must be integer or integer vector", &I);
2192 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2193 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002194
2195 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002196 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2197 cast<VectorType>(DestTy)->getNumElements(),
2198 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002199
2200 visitInstruction(I);
2201}
2202
2203void Verifier::visitSIToFPInst(SIToFPInst &I) {
2204 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002205 Type *SrcTy = I.getOperand(0)->getType();
2206 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002207
Duncan Sands19d0b472010-02-16 11:11:14 +00002208 bool SrcVec = SrcTy->isVectorTy();
2209 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002210
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002211 Assert(SrcVec == DstVec,
2212 "SIToFP source and dest must both be vector or scalar", &I);
2213 Assert(SrcTy->isIntOrIntVectorTy(),
2214 "SIToFP source must be integer or integer vector", &I);
2215 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2216 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002217
2218 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002219 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2220 cast<VectorType>(DestTy)->getNumElements(),
2221 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002222
2223 visitInstruction(I);
2224}
2225
2226void Verifier::visitFPToUIInst(FPToUIInst &I) {
2227 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002228 Type *SrcTy = I.getOperand(0)->getType();
2229 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002230
Duncan Sands19d0b472010-02-16 11:11:14 +00002231 bool SrcVec = SrcTy->isVectorTy();
2232 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002233
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002234 Assert(SrcVec == DstVec,
2235 "FPToUI source and dest must both be vector or scalar", &I);
2236 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2237 &I);
2238 Assert(DestTy->isIntOrIntVectorTy(),
2239 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002240
2241 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002242 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2243 cast<VectorType>(DestTy)->getNumElements(),
2244 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002245
2246 visitInstruction(I);
2247}
2248
2249void Verifier::visitFPToSIInst(FPToSIInst &I) {
2250 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002251 Type *SrcTy = I.getOperand(0)->getType();
2252 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002253
Duncan Sands19d0b472010-02-16 11:11:14 +00002254 bool SrcVec = SrcTy->isVectorTy();
2255 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002256
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002257 Assert(SrcVec == DstVec,
2258 "FPToSI source and dest must both be vector or scalar", &I);
2259 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2260 &I);
2261 Assert(DestTy->isIntOrIntVectorTy(),
2262 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002263
2264 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002265 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2266 cast<VectorType>(DestTy)->getNumElements(),
2267 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002268
2269 visitInstruction(I);
2270}
2271
2272void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2273 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002274 Type *SrcTy = I.getOperand(0)->getType();
2275 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002276
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002277 Assert(SrcTy->getScalarType()->isPointerTy(),
2278 "PtrToInt source must be pointer", &I);
2279 Assert(DestTy->getScalarType()->isIntegerTy(),
2280 "PtrToInt result must be integral", &I);
2281 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2282 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002283
2284 if (SrcTy->isVectorTy()) {
2285 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2286 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002287 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2288 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002289 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002290
2291 visitInstruction(I);
2292}
2293
2294void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2295 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002296 Type *SrcTy = I.getOperand(0)->getType();
2297 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002298
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002299 Assert(SrcTy->getScalarType()->isIntegerTy(),
2300 "IntToPtr source must be an integral", &I);
2301 Assert(DestTy->getScalarType()->isPointerTy(),
2302 "IntToPtr result must be a pointer", &I);
2303 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2304 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002305 if (SrcTy->isVectorTy()) {
2306 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2307 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002308 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2309 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002310 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002311 visitInstruction(I);
2312}
2313
2314void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002315 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002316 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2317 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002318 visitInstruction(I);
2319}
2320
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002321void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2322 Type *SrcTy = I.getOperand(0)->getType();
2323 Type *DestTy = I.getType();
2324
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002325 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2326 &I);
2327 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2328 &I);
2329 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2330 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002331 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002332 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2333 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002334 visitInstruction(I);
2335}
2336
Misha Brukmanc566ca362004-03-02 00:22:19 +00002337/// visitPHINode - Ensure that a PHI node is well formed.
2338///
Chris Lattner069a7952002-06-25 15:56:27 +00002339void Verifier::visitPHINode(PHINode &PN) {
2340 // Ensure that the PHI nodes are all grouped together at the top of the block.
2341 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002342 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002343 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002344 Assert(&PN == &PN.getParent()->front() ||
2345 isa<PHINode>(--BasicBlock::iterator(&PN)),
2346 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002347
David Majnemerb611e3f2015-08-14 05:09:07 +00002348 // Check that a PHI doesn't yield a Token.
2349 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2350
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002351 // Check that all of the values of the PHI node have the same type as the
2352 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002353 for (Value *IncValue : PN.incoming_values()) {
2354 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002355 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002356 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002357
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002358 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002359
2360 visitInstruction(PN);
2361}
2362
Duncan Sands8c582282007-12-21 19:19:01 +00002363void Verifier::VerifyCallSite(CallSite CS) {
2364 Instruction *I = CS.getInstruction();
2365
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002366 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2367 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002368 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002369
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002370 Assert(FPTy->getElementType()->isFunctionTy(),
2371 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002372
2373 Assert(FPTy->getElementType() == CS.getFunctionType(),
2374 "Called function is not the same type as the call!", I);
2375
2376 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002377
2378 // Verify that the correct number of arguments are being passed
2379 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002380 Assert(CS.arg_size() >= FTy->getNumParams(),
2381 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002382 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002383 Assert(CS.arg_size() == FTy->getNumParams(),
2384 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002385
Chris Lattner609de002010-05-10 20:58:42 +00002386 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002387 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002388 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2389 "Call parameter type does not match function signature!",
2390 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002391
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002392 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002393
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002394 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2395 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002396
Duncan Sands8c582282007-12-21 19:19:01 +00002397 // Verify call attributes.
Duncan Sands0009c442008-01-12 16:42:01 +00002398 VerifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002399
David Majnemer91db08b2014-04-30 17:22:00 +00002400 // Conservatively check the inalloca argument.
2401 // We have a bug if we can find that there is an underlying alloca without
2402 // inalloca.
2403 if (CS.hasInAllocaArgument()) {
2404 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2405 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002406 Assert(AI->isUsedWithInAlloca(),
2407 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002408 }
2409
Stephen Linb8bd2322013-04-20 05:14:40 +00002410 if (FTy->isVarArg()) {
2411 // FIXME? is 'nest' even legal here?
2412 bool SawNest = false;
2413 bool SawReturned = false;
2414
2415 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2416 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2417 SawNest = true;
2418 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2419 SawReturned = true;
2420 }
2421
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002422 // Check attributes on the varargs part.
2423 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002424 Type *Ty = CS.getArgument(Idx-1)->getType();
Stephen Linb8bd2322013-04-20 05:14:40 +00002425 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002426
Stephen Linb8bd2322013-04-20 05:14:40 +00002427 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002428 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002429 SawNest = true;
2430 }
2431
2432 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002433 Assert(!SawReturned, "More than one parameter has attribute returned!",
2434 I);
2435 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2436 "Incompatible argument and return types for 'returned' "
2437 "attribute",
2438 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002439 SawReturned = true;
2440 }
Duncan Sands0009c442008-01-12 16:42:01 +00002441
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002442 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2443 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002444
2445 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002446 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002447 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002448 }
Duncan Sands8c582282007-12-21 19:19:01 +00002449
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002450 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002451 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002452 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002453 for (Type *ParamTy : FTy->params()) {
2454 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002455 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002456 Assert(!ParamTy->isTokenTy(),
2457 "Function has token parameter but isn't an intrinsic", I);
2458 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002459 }
2460
David Majnemerb611e3f2015-08-14 05:09:07 +00002461 // Verify that indirect calls don't return tokens.
2462 if (CS.getCalledFunction() == nullptr)
2463 Assert(!FTy->getReturnType()->isTokenTy(),
2464 "Return type cannot be token for indirect call!");
2465
Philip Reamesa3c6f002015-06-26 21:39:44 +00002466 if (Function *F = CS.getCalledFunction())
2467 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002468 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002469
David Majnemer3bb88c02015-12-15 21:27:27 +00002470 // Verify that a callsite has at most one "deopt" and one "funclet" operand
2471 // bundle.
2472 bool FoundDeoptBundle = false, FoundFuncletBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002473 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002474 OperandBundleUse BU = CS.getOperandBundleAt(i);
2475 uint32_t Tag = BU.getTagID();
2476 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002477 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2478 FoundDeoptBundle = true;
2479 }
David Majnemer3bb88c02015-12-15 21:27:27 +00002480 if (Tag == LLVMContext::OB_funclet) {
2481 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2482 FoundFuncletBundle = true;
2483 Assert(BU.Inputs.size() == 1,
2484 "Expected exactly one funclet bundle operand", I);
2485 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2486 "Funclet bundle operands should correspond to a FuncletPadInst",
2487 I);
2488 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002489 }
2490
Duncan Sands8c582282007-12-21 19:19:01 +00002491 visitInstruction(*I);
2492}
2493
Reid Kleckner5772b772014-04-24 20:14:34 +00002494/// Two types are "congruent" if they are identical, or if they are both pointer
2495/// types with different pointee types and the same address space.
2496static bool isTypeCongruent(Type *L, Type *R) {
2497 if (L == R)
2498 return true;
2499 PointerType *PL = dyn_cast<PointerType>(L);
2500 PointerType *PR = dyn_cast<PointerType>(R);
2501 if (!PL || !PR)
2502 return false;
2503 return PL->getAddressSpace() == PR->getAddressSpace();
2504}
2505
Reid Klecknerd20c9702014-05-15 23:58:57 +00002506static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2507 static const Attribute::AttrKind ABIAttrs[] = {
2508 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2509 Attribute::InReg, Attribute::Returned};
2510 AttrBuilder Copy;
2511 for (auto AK : ABIAttrs) {
2512 if (Attrs.hasAttribute(I + 1, AK))
2513 Copy.addAttribute(AK);
2514 }
2515 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2516 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2517 return Copy;
2518}
2519
Reid Kleckner5772b772014-04-24 20:14:34 +00002520void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002521 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002522
2523 // - The caller and callee prototypes must match. Pointer types of
2524 // parameters or return types may differ in pointee type, but not
2525 // address space.
2526 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002527 FunctionType *CallerTy = F->getFunctionType();
2528 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002529 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2530 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2531 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2532 "cannot guarantee tail call due to mismatched varargs", &CI);
2533 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2534 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002535 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002536 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002537 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2538 "cannot guarantee tail call due to mismatched parameter types", &CI);
2539 }
2540
2541 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002542 Assert(F->getCallingConv() == CI.getCallingConv(),
2543 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002544
2545 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2546 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002547 AttributeSet CallerAttrs = F->getAttributes();
2548 AttributeSet CalleeAttrs = CI.getAttributes();
2549 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002550 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2551 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002552 Assert(CallerABIAttrs == CalleeABIAttrs,
2553 "cannot guarantee tail call due to mismatched ABI impacting "
2554 "function attributes",
2555 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002556 }
2557
2558 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2559 // or a pointer bitcast followed by a ret instruction.
2560 // - The ret instruction must return the (possibly bitcasted) value
2561 // produced by the call or void.
2562 Value *RetVal = &CI;
2563 Instruction *Next = CI.getNextNode();
2564
2565 // Handle the optional bitcast.
2566 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002567 Assert(BI->getOperand(0) == RetVal,
2568 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002569 RetVal = BI;
2570 Next = BI->getNextNode();
2571 }
2572
2573 // Check the return.
2574 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002575 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2576 &CI);
2577 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2578 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002579}
2580
Duncan Sands8c582282007-12-21 19:19:01 +00002581void Verifier::visitCallInst(CallInst &CI) {
2582 VerifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002583
Reid Kleckner5772b772014-04-24 20:14:34 +00002584 if (CI.isMustTailCall())
2585 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002586}
2587
2588void Verifier::visitInvokeInst(InvokeInst &II) {
2589 VerifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002590
David Majnemer654e1302015-07-31 17:58:14 +00002591 // Verify that the first non-PHI instruction of the unwind destination is an
2592 // exception handling instruction.
2593 Assert(
2594 II.getUnwindDest()->isEHPad(),
2595 "The unwind destination does not have an exception handling instruction!",
2596 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002597
Dan Gohman9c6e1882010-08-02 23:09:14 +00002598 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002599}
Chris Lattner0e851da2002-04-18 20:37:37 +00002600
Misha Brukmanc566ca362004-03-02 00:22:19 +00002601/// visitBinaryOperator - Check that both arguments to the binary operator are
2602/// of the same type!
2603///
Chris Lattner069a7952002-06-25 15:56:27 +00002604void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002605 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2606 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002607
Reid Spencer2341c222007-02-02 02:16:23 +00002608 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002609 // Check that integer arithmetic operators are only used with
2610 // integral operands.
2611 case Instruction::Add:
2612 case Instruction::Sub:
2613 case Instruction::Mul:
2614 case Instruction::SDiv:
2615 case Instruction::UDiv:
2616 case Instruction::SRem:
2617 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002618 Assert(B.getType()->isIntOrIntVectorTy(),
2619 "Integer arithmetic operators only work with integral types!", &B);
2620 Assert(B.getType() == B.getOperand(0)->getType(),
2621 "Integer arithmetic operators must have same type "
2622 "for operands and result!",
2623 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002624 break;
2625 // Check that floating-point arithmetic operators are only used with
2626 // floating-point operands.
2627 case Instruction::FAdd:
2628 case Instruction::FSub:
2629 case Instruction::FMul:
2630 case Instruction::FDiv:
2631 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002632 Assert(B.getType()->isFPOrFPVectorTy(),
2633 "Floating-point arithmetic operators only work with "
2634 "floating-point types!",
2635 &B);
2636 Assert(B.getType() == B.getOperand(0)->getType(),
2637 "Floating-point arithmetic operators must have same type "
2638 "for operands and result!",
2639 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002640 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002641 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002642 case Instruction::And:
2643 case Instruction::Or:
2644 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002645 Assert(B.getType()->isIntOrIntVectorTy(),
2646 "Logical operators only work with integral types!", &B);
2647 Assert(B.getType() == B.getOperand(0)->getType(),
2648 "Logical operators must have same type for operands and result!",
2649 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002650 break;
2651 case Instruction::Shl:
2652 case Instruction::LShr:
2653 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002654 Assert(B.getType()->isIntOrIntVectorTy(),
2655 "Shifts only work with integral types!", &B);
2656 Assert(B.getType() == B.getOperand(0)->getType(),
2657 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002658 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002659 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002660 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002661 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002662
Chris Lattner0e851da2002-04-18 20:37:37 +00002663 visitInstruction(B);
2664}
2665
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002666void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002667 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002668 Type *Op0Ty = IC.getOperand(0)->getType();
2669 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002670 Assert(Op0Ty == Op1Ty,
2671 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002672 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002673 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2674 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002675 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002676 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2677 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2678 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002679
Reid Spencerd9436b62006-11-20 01:22:35 +00002680 visitInstruction(IC);
2681}
2682
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002683void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002684 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002685 Type *Op0Ty = FC.getOperand(0)->getType();
2686 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002687 Assert(Op0Ty == Op1Ty,
2688 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002689 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002690 Assert(Op0Ty->isFPOrFPVectorTy(),
2691 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002692 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002693 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2694 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2695 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002696
Reid Spencerd9436b62006-11-20 01:22:35 +00002697 visitInstruction(FC);
2698}
2699
Robert Bocchino23004482006-01-10 19:05:34 +00002700void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002701 Assert(
2702 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2703 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002704 visitInstruction(EI);
2705}
2706
Robert Bocchinoca27f032006-01-17 20:07:22 +00002707void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002708 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2709 IE.getOperand(2)),
2710 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002711 visitInstruction(IE);
2712}
2713
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002714void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002715 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2716 SV.getOperand(2)),
2717 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002718 visitInstruction(SV);
2719}
2720
Chris Lattner069a7952002-06-25 15:56:27 +00002721void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002722 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002723
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002724 Assert(isa<PointerType>(TargetTy),
2725 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002726 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002727 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002728 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002729 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002730 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002731
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002732 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002733 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002734 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002735
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002736 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002737 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002738 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2739 if (GEP.getPointerOperandType()->isVectorTy())
2740 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2741 "Vector GEP result width doesn't match operand's", &GEP);
Duncan Sandse6beec62012-11-13 12:59:33 +00002742 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2743 Type *IndexTy = Idxs[i]->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002744 if (IndexTy->isVectorTy()) {
2745 unsigned IndexWidth = IndexTy->getVectorNumElements();
2746 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2747 }
2748 Assert(IndexTy->getScalarType()->isIntegerTy(),
2749 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002750 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002751 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002752 visitInstruction(GEP);
2753}
2754
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002755static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2756 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2757}
2758
Philip Reamesbf9676f2014-10-20 23:52:07 +00002759void Verifier::visitRangeMetadata(Instruction& I,
2760 MDNode* Range, Type* Ty) {
2761 assert(Range &&
2762 Range == I.getMetadata(LLVMContext::MD_range) &&
2763 "precondition violation");
2764
2765 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002766 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002767 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002768 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2769
Philip Reamesbf9676f2014-10-20 23:52:07 +00002770 ConstantRange LastRange(1); // Dummy initial value
2771 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002772 ConstantInt *Low =
2773 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002774 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002775 ConstantInt *High =
2776 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002777 Assert(High, "The upper limit must be an integer!", High);
2778 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2779 "Range types must match instruction type!", &I);
2780
Philip Reamesbf9676f2014-10-20 23:52:07 +00002781 APInt HighV = High->getValue();
2782 APInt LowV = Low->getValue();
2783 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002784 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2785 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002786 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002787 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2788 "Intervals are overlapping", Range);
2789 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2790 Range);
2791 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2792 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002793 }
2794 LastRange = ConstantRange(LowV, HighV);
2795 }
2796 if (NumRanges > 2) {
2797 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002798 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002799 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002800 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002801 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002802 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2803 "Intervals are overlapping", Range);
2804 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2805 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002806 }
2807}
2808
JF Bastiend1fb5852015-12-17 22:09:19 +00002809void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2810 const Instruction *I) {
2811 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2812 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2813 Assert(!(Size & (Size - 1)),
2814 "atomic memory access' operand must have a power-of-two size", Ty, I);
2815}
2816
Chris Lattner069a7952002-06-25 15:56:27 +00002817void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002818 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002819 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002820 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002821 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2822 "huge alignment values are unsupported", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002823 if (LI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002824 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2825 "Load cannot have Release ordering", &LI);
2826 Assert(LI.getAlignment() != 0,
2827 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002828 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2829 ElTy->isFloatingPointTy(),
2830 "atomic load operand must have integer, pointer, or floating point "
2831 "type!",
2832 ElTy, &LI);
2833 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002834 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002835 Assert(LI.getSynchScope() == CrossThread,
2836 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002837 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002838
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002839 visitInstruction(LI);
2840}
2841
Chris Lattner069a7952002-06-25 15:56:27 +00002842void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002843 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002844 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002845 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002846 Assert(ElTy == SI.getOperand(0)->getType(),
2847 "Stored value type does not match pointer operand type!", &SI, ElTy);
2848 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2849 "huge alignment values are unsupported", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002850 if (SI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002851 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2852 "Store cannot have Acquire ordering", &SI);
2853 Assert(SI.getAlignment() != 0,
2854 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002855 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2856 ElTy->isFloatingPointTy(),
2857 "atomic store operand must have integer, pointer, or floating point "
2858 "type!",
2859 ElTy, &SI);
2860 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002861 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002862 Assert(SI.getSynchScope() == CrossThread,
2863 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002864 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002865 visitInstruction(SI);
2866}
2867
Victor Hernandez8acf2952009-10-23 21:09:37 +00002868void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00002869 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00002870 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002871 Assert(PTy->getAddressSpace() == 0,
2872 "Allocation instruction pointer not in the generic address space!",
2873 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00002874 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002875 "Cannot allocate unsized type", &AI);
2876 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2877 "Alloca array size must have integer type", &AI);
2878 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2879 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00002880
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00002881 visitInstruction(AI);
2882}
2883
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002884void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00002885
2886 // FIXME: more conditions???
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002887 Assert(CXI.getSuccessOrdering() != NotAtomic,
2888 "cmpxchg instructions must be atomic.", &CXI);
2889 Assert(CXI.getFailureOrdering() != NotAtomic,
2890 "cmpxchg instructions must be atomic.", &CXI);
2891 Assert(CXI.getSuccessOrdering() != Unordered,
2892 "cmpxchg instructions cannot be unordered.", &CXI);
2893 Assert(CXI.getFailureOrdering() != Unordered,
2894 "cmpxchg instructions cannot be unordered.", &CXI);
2895 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2896 "cmpxchg instructions be at least as constrained on success as fail",
2897 &CXI);
2898 Assert(CXI.getFailureOrdering() != Release &&
2899 CXI.getFailureOrdering() != AcquireRelease,
2900 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00002901
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002902 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002903 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002904 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002905 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2906 ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002907 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002908 Assert(ElTy == CXI.getOperand(1)->getType(),
2909 "Expected value type does not match pointer operand type!", &CXI,
2910 ElTy);
2911 Assert(ElTy == CXI.getOperand(2)->getType(),
2912 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002913 visitInstruction(CXI);
2914}
2915
2916void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002917 Assert(RMWI.getOrdering() != NotAtomic,
2918 "atomicrmw instructions must be atomic.", &RMWI);
2919 Assert(RMWI.getOrdering() != Unordered,
2920 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002921 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002922 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002923 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002924 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2925 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002926 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002927 Assert(ElTy == RMWI.getOperand(1)->getType(),
2928 "Argument value type does not match pointer operand type!", &RMWI,
2929 ElTy);
2930 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2931 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2932 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002933 visitInstruction(RMWI);
2934}
2935
Eli Friedmanfee02c62011-07-25 23:16:38 +00002936void Verifier::visitFenceInst(FenceInst &FI) {
2937 const AtomicOrdering Ordering = FI.getOrdering();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002938 Assert(Ordering == Acquire || Ordering == Release ||
2939 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2940 "fence instructions may only have "
2941 "acquire, release, acq_rel, or seq_cst ordering.",
2942 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00002943 visitInstruction(FI);
2944}
2945
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002946void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002947 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2948 EVI.getIndices()) == EVI.getType(),
2949 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002950
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002951 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00002952}
2953
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002954void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002955 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2956 IVI.getIndices()) ==
2957 IVI.getOperand(1)->getType(),
2958 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002959
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002960 visitInstruction(IVI);
2961}
Chris Lattner0e851da2002-04-18 20:37:37 +00002962
Joseph Tremoulete28885e2016-01-10 04:28:38 +00002963static Value *getParentPad(Value *EHPad) {
2964 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
2965 return FPI->getParentPad();
2966
2967 return cast<CatchSwitchInst>(EHPad)->getParentPad();
2968}
2969
David Majnemer85a549d2015-08-11 02:48:30 +00002970void Verifier::visitEHPadPredecessors(Instruction &I) {
2971 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00002972
David Majnemer85a549d2015-08-11 02:48:30 +00002973 BasicBlock *BB = I.getParent();
2974 Function *F = BB->getParent();
2975
2976 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
2977
2978 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
2979 // The landingpad instruction defines its parent as a landing pad block. The
2980 // landing pad block may be branched to only by the unwind edge of an
2981 // invoke.
2982 for (BasicBlock *PredBB : predecessors(BB)) {
2983 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
2984 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2985 "Block containing LandingPadInst must be jumped to "
2986 "only by the unwind edge of an invoke.",
2987 LPI);
2988 }
2989 return;
2990 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00002991 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
2992 if (!pred_empty(BB))
2993 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
2994 "Block containg CatchPadInst must be jumped to "
2995 "only by its catchswitch.",
2996 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00002997 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
2998 "Catchswitch cannot unwind to one of its catchpads",
2999 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003000 return;
3001 }
David Majnemer85a549d2015-08-11 02:48:30 +00003002
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003003 // Verify that each pred has a legal terminator with a legal to/from EH
3004 // pad relationship.
3005 Instruction *ToPad = &I;
3006 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003007 for (BasicBlock *PredBB : predecessors(BB)) {
3008 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003009 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003010 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003011 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003012 "EH pad must be jumped to via an unwind edge", ToPad, II);
3013 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3014 FromPad = Bundle->Inputs[0];
3015 else
3016 FromPad = ConstantTokenNone::get(II->getContext());
3017 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
3018 FromPad = CRI->getCleanupPad();
3019 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3020 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3021 FromPad = CSI;
3022 } else {
3023 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3024 }
3025
3026 // The edge may exit from zero or more nested pads.
3027 for (;; FromPad = getParentPad(FromPad)) {
3028 Assert(FromPad != ToPad,
3029 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3030 if (FromPad == ToPadParent) {
3031 // This is a legal unwind edge.
3032 break;
3033 }
3034 Assert(!isa<ConstantTokenNone>(FromPad),
3035 "A single unwind edge may only enter one EH pad", TI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003036 }
David Majnemer85a549d2015-08-11 02:48:30 +00003037 }
3038}
3039
3040void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003041 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3042 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003043 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3044 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003045
David Majnemer85a549d2015-08-11 02:48:30 +00003046 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003047
David Majnemer654e1302015-07-31 17:58:14 +00003048 if (!LandingPadResultTy)
3049 LandingPadResultTy = LPI.getType();
3050 else
3051 Assert(LandingPadResultTy == LPI.getType(),
3052 "The landingpad instruction should have a consistent result type "
3053 "inside a function.",
3054 &LPI);
3055
David Majnemer7fddecc2015-06-17 20:52:32 +00003056 Function *F = LPI.getParent()->getParent();
3057 Assert(F->hasPersonalityFn(),
3058 "LandingPadInst needs to be in a function with a personality.", &LPI);
3059
Bill Wendlingfae14752011-08-12 20:24:12 +00003060 // The landingpad instruction must be the first non-PHI instruction in the
3061 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003062 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3063 "LandingPadInst not the first non-PHI instruction in the block.",
3064 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003065
Duncan Sands86de1a62011-09-27 16:43:19 +00003066 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003067 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003068 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003069 Assert(isa<PointerType>(Clause->getType()),
3070 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003071 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003072 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3073 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3074 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003075 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003076 }
3077
Bill Wendlingfae14752011-08-12 20:24:12 +00003078 visitInstruction(LPI);
3079}
3080
David Majnemer654e1302015-07-31 17:58:14 +00003081void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003082 visitEHPadPredecessors(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003083
David Majnemer85a549d2015-08-11 02:48:30 +00003084 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003085
David Majnemer654e1302015-07-31 17:58:14 +00003086 Function *F = BB->getParent();
3087 Assert(F->hasPersonalityFn(),
3088 "CatchPadInst needs to be in a function with a personality.", &CPI);
3089
David Majnemer8a1c45d2015-12-12 05:38:55 +00003090 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3091 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3092 CPI.getParentPad());
3093
David Majnemer654e1302015-07-31 17:58:14 +00003094 // The catchpad instruction must be the first non-PHI instruction in the
3095 // block.
3096 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003097 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003098
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003099 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003100}
3101
David Majnemer8a1c45d2015-12-12 05:38:55 +00003102void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3103 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3104 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3105 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003106
David Majnemer8a1c45d2015-12-12 05:38:55 +00003107 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003108}
3109
3110void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003111 visitEHPadPredecessors(CPI);
3112
David Majnemer654e1302015-07-31 17:58:14 +00003113 BasicBlock *BB = CPI.getParent();
3114
David Majnemer654e1302015-07-31 17:58:14 +00003115 Function *F = BB->getParent();
3116 Assert(F->hasPersonalityFn(),
3117 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3118
3119 // The cleanuppad instruction must be the first non-PHI instruction in the
3120 // block.
3121 Assert(BB->getFirstNonPHI() == &CPI,
3122 "CleanupPadInst not the first non-PHI instruction in the block.",
3123 &CPI);
3124
David Majnemer8a1c45d2015-12-12 05:38:55 +00003125 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003126 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003127 "CleanupPadInst has an invalid parent.", &CPI);
3128
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003129 visitFuncletPadInst(CPI);
3130}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003131
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003132void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3133 User *FirstUser = nullptr;
3134 Value *FirstUnwindPad = nullptr;
3135 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
3136 while (!Worklist.empty()) {
3137 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
3138 Value *UnresolvedAncestorPad = nullptr;
3139 for (User *U : CurrentPad->users()) {
3140 BasicBlock *UnwindDest;
3141 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3142 UnwindDest = CRI->getUnwindDest();
3143 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3144 // We allow catchswitch unwind to caller to nest
3145 // within an outer pad that unwinds somewhere else,
3146 // because catchswitch doesn't have a nounwind variant.
3147 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3148 if (CSI->unwindsToCaller())
3149 continue;
3150 UnwindDest = CSI->getUnwindDest();
3151 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3152 UnwindDest = II->getUnwindDest();
3153 } else if (isa<CallInst>(U)) {
3154 // Calls which don't unwind may be found inside funclet
3155 // pads that unwind somewhere else. We don't *require*
3156 // such calls to be annotated nounwind.
3157 continue;
3158 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3159 // The unwind dest for a cleanup can only be found by
3160 // recursive search. Add it to the worklist, and we'll
3161 // search for its first use that determines where it unwinds.
3162 Worklist.push_back(CPI);
3163 continue;
3164 } else {
3165 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3166 continue;
3167 }
3168
3169 Value *UnwindPad;
3170 bool ExitsFPI;
3171 if (UnwindDest) {
3172 UnwindPad = UnwindDest->getFirstNonPHI();
3173 Value *UnwindParent = getParentPad(UnwindPad);
3174 // Ignore unwind edges that don't exit CurrentPad.
3175 if (UnwindParent == CurrentPad)
3176 continue;
3177 // Determine whether the original funclet pad is exited,
3178 // and if we are scanning nested pads determine how many
3179 // of them are exited so we can stop searching their
3180 // children.
3181 Value *ExitedPad = CurrentPad;
3182 ExitsFPI = false;
3183 do {
3184 if (ExitedPad == &FPI) {
3185 ExitsFPI = true;
3186 // Now we can resolve any ancestors of CurrentPad up to
3187 // FPI, but not including FPI since we need to make sure
3188 // to check all direct users of FPI for consistency.
3189 UnresolvedAncestorPad = &FPI;
3190 break;
3191 }
3192 Value *ExitedParent = getParentPad(ExitedPad);
3193 if (ExitedParent == UnwindParent) {
3194 // ExitedPad is the ancestor-most pad which this unwind
3195 // edge exits, so we can resolve up to it, meaning that
3196 // ExitedParent is the first ancestor still unresolved.
3197 UnresolvedAncestorPad = ExitedParent;
3198 break;
3199 }
3200 ExitedPad = ExitedParent;
3201 } while (!isa<ConstantTokenNone>(ExitedPad));
3202 } else {
3203 // Unwinding to caller exits all pads.
3204 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3205 ExitsFPI = true;
3206 UnresolvedAncestorPad = &FPI;
3207 }
3208
3209 if (ExitsFPI) {
3210 // This unwind edge exits FPI. Make sure it agrees with other
3211 // such edges.
3212 if (FirstUser) {
3213 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3214 "pad must have the same unwind "
3215 "dest",
3216 &FPI, U, FirstUser);
3217 } else {
3218 FirstUser = U;
3219 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003220 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3221 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3222 getParentPad(UnwindPad) == getParentPad(&FPI))
3223 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003224 }
3225 }
3226 // Make sure we visit all uses of FPI, but for nested pads stop as
3227 // soon as we know where they unwind to.
3228 if (CurrentPad != &FPI)
3229 break;
3230 }
3231 if (UnresolvedAncestorPad) {
3232 if (CurrentPad == UnresolvedAncestorPad) {
3233 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3234 // we've found an unwind edge that exits it, because we need to verify
3235 // all direct uses of FPI.
3236 assert(CurrentPad == &FPI);
3237 continue;
3238 }
3239 // Pop off the worklist any nested pads that we've found an unwind
3240 // destination for. The pads on the worklist are the uncles,
3241 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3242 // for all ancestors of CurrentPad up to but not including
3243 // UnresolvedAncestorPad.
3244 Value *ResolvedPad = CurrentPad;
3245 while (!Worklist.empty()) {
3246 Value *UnclePad = Worklist.back();
3247 Value *AncestorPad = getParentPad(UnclePad);
3248 // Walk ResolvedPad up the ancestor list until we either find the
3249 // uncle's parent or the last resolved ancestor.
3250 while (ResolvedPad != AncestorPad) {
3251 Value *ResolvedParent = getParentPad(ResolvedPad);
3252 if (ResolvedParent == UnresolvedAncestorPad) {
3253 break;
3254 }
3255 ResolvedPad = ResolvedParent;
3256 }
3257 // If the resolved ancestor search didn't find the uncle's parent,
3258 // then the uncle is not yet resolved.
3259 if (ResolvedPad != AncestorPad)
3260 break;
3261 // This uncle is resolved, so pop it from the worklist.
3262 Worklist.pop_back();
3263 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003264 }
3265 }
3266
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003267 if (FirstUnwindPad) {
3268 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3269 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3270 Value *SwitchUnwindPad;
3271 if (SwitchUnwindDest)
3272 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3273 else
3274 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3275 Assert(SwitchUnwindPad == FirstUnwindPad,
3276 "Unwind edges out of a catch must have the same unwind dest as "
3277 "the parent catchswitch",
3278 &FPI, FirstUser, CatchSwitch);
3279 }
3280 }
3281
3282 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003283}
3284
David Majnemer8a1c45d2015-12-12 05:38:55 +00003285void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
3286 visitEHPadPredecessors(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003287
David Majnemer8a1c45d2015-12-12 05:38:55 +00003288 BasicBlock *BB = CatchSwitch.getParent();
3289
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003290 Function *F = BB->getParent();
3291 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003292 "CatchSwitchInst needs to be in a function with a personality.",
3293 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003294
David Majnemer8a1c45d2015-12-12 05:38:55 +00003295 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003296 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003297 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3298 "CatchSwitchInst not the first non-PHI instruction in the block.",
3299 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003300
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003301 auto *ParentPad = CatchSwitch.getParentPad();
3302 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3303 "CatchSwitchInst has an invalid parent.", ParentPad);
3304
David Majnemer8a1c45d2015-12-12 05:38:55 +00003305 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003306 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003307 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3308 "CatchSwitchInst must unwind to an EH block which is not a "
3309 "landingpad.",
3310 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003311
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003312 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3313 if (getParentPad(I) == ParentPad)
3314 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3315 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003316
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003317 Assert(CatchSwitch.getNumHandlers() != 0,
3318 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3319
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003320 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003321 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3322 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003323 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003324
David Majnemer8a1c45d2015-12-12 05:38:55 +00003325 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003326}
3327
David Majnemer654e1302015-07-31 17:58:14 +00003328void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003329 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3330 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3331 CRI.getOperand(0));
3332
David Majnemer654e1302015-07-31 17:58:14 +00003333 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3334 Instruction *I = UnwindDest->getFirstNonPHI();
3335 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3336 "CleanupReturnInst must unwind to an EH block which is not a "
3337 "landingpad.",
3338 &CRI);
3339 }
3340
3341 visitTerminatorInst(CRI);
3342}
3343
Rafael Espindola654320a2012-02-26 02:23:37 +00003344void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3345 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003346 // If the we have an invalid invoke, don't try to compute the dominance.
3347 // We already reject it in the invoke specific checks and the dominance
3348 // computation doesn't handle multiple edges.
3349 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3350 if (II->getNormalDest() == II->getUnwindDest())
3351 return;
3352 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003353
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003354 const Use &U = I.getOperandUse(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003355 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3356 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003357}
3358
Artur Pilipenkocca80022015-10-09 17:41:29 +00003359void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3360 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3361 "apply only to pointer types", &I);
3362 Assert(isa<LoadInst>(I),
3363 "dereferenceable, dereferenceable_or_null apply only to load"
3364 " instructions, use attributes for calls or invokes", &I);
3365 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3366 "take one operand!", &I);
3367 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3368 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3369 "dereferenceable_or_null metadata value must be an i64!", &I);
3370}
3371
Misha Brukmanc566ca362004-03-02 00:22:19 +00003372/// verifyInstruction - Verify that an instruction is well formed.
3373///
Chris Lattner069a7952002-06-25 15:56:27 +00003374void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003375 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003376 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003377
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003378 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003379 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003380 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3381 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003382 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003383 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003384
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003385 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003386 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3387 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003388
Chris Lattner5f126b72004-03-29 00:29:36 +00003389 // Check that the return value of the instruction is either void or a legal
3390 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003391 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3392 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003393
Nick Lewycky93e06a52009-09-27 23:27:42 +00003394 // Check that the instruction doesn't produce metadata. Calls are already
3395 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003396 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3397 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003398
Chris Lattner0e851da2002-04-18 20:37:37 +00003399 // Check that all uses of the instruction, if they are instructions
3400 // themselves, actually have parent basic blocks. If the use is not an
3401 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003402 for (Use &U : I.uses()) {
3403 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003404 Assert(Used->getParent() != nullptr,
3405 "Instruction referencing"
3406 " instruction not embedded in a basic block!",
3407 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003408 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003409 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003410 return;
3411 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003412 }
3413
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003414 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003415 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003416
3417 // Check to make sure that only first-class-values are operands to
3418 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003419 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003420 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003421 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003422
Chris Lattner9ece94b2004-03-14 03:23:54 +00003423 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003424 // Check to make sure that the "address of" an intrinsic function is never
3425 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003426 Assert(
3427 !F->isIntrinsic() ||
3428 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3429 "Cannot take the address of an intrinsic!", &I);
3430 Assert(
3431 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003432 F->getIntrinsicID() == Intrinsic::donothing ||
3433 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003434 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3435 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003436 "Cannot invoke an intrinsinc other than"
3437 " donothing or patchpoint",
3438 &I);
3439 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003440 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003441 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003442 Assert(OpBB->getParent() == BB->getParent(),
3443 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003444 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003445 Assert(OpArg->getParent() == BB->getParent(),
3446 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003447 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003448 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003449 } else if (isa<Instruction>(I.getOperand(i))) {
3450 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003451 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003452 Assert((i + 1 == e && isa<CallInst>(I)) ||
3453 (i + 3 == e && isa<InvokeInst>(I)),
3454 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003455 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3456 if (CE->getType()->isPtrOrPtrVectorTy()) {
3457 // If we have a ConstantExpr pointer, we need to see if it came from an
3458 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003459 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003460 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003461 }
3462 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003463
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003464 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003465 Assert(I.getType()->isFPOrFPVectorTy(),
3466 "fpmath requires a floating point result!", &I);
3467 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003468 if (ConstantFP *CFP0 =
3469 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003470 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003471 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3472 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003473 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003474 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003475 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003476 }
3477
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003478 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003479 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3480 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003481 visitRangeMetadata(I, Range, I.getType());
3482 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003483
Philip Reames0ca58b32014-10-21 20:56:29 +00003484 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003485 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3486 &I);
3487 Assert(isa<LoadInst>(I),
3488 "nonnull applies only to load instructions, use attributes"
3489 " for calls or invokes",
3490 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003491 }
3492
Artur Pilipenkocca80022015-10-09 17:41:29 +00003493 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3494 visitDereferenceableMetadata(I, MD);
3495
3496 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3497 visitDereferenceableMetadata(I, MD);
3498
3499 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3500 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3501 &I);
3502 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3503 "use attributes for calls or invokes", &I);
3504 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3505 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3506 Assert(CI && CI->getType()->isIntegerTy(64),
3507 "align metadata value must be an i64!", &I);
3508 uint64_t Align = CI->getZExtValue();
3509 Assert(isPowerOf2_64(Align),
3510 "align metadata value must be a power of 2!", &I);
3511 Assert(Align <= Value::MaximumAlignment,
3512 "alignment is larger that implementation defined limit", &I);
3513 }
3514
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003515 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003516 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003517 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003518 }
3519
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003520 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003521}
3522
Chris Lattner144b6192012-05-27 19:37:05 +00003523/// VerifyIntrinsicType - Verify that the specified type (which comes from an
3524/// intrinsic argument or return value) matches the type constraints specified
3525/// by the .td file (e.g. an "any integer" argument really is an integer).
3526///
3527/// This return true on error but does not print a message.
3528bool Verifier::VerifyIntrinsicType(Type *Ty,
3529 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3530 SmallVectorImpl<Type*> &ArgTys) {
3531 using namespace Intrinsic;
3532
3533 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003534 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003535 IITDescriptor D = Infos.front();
3536 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003537
Chris Lattner144b6192012-05-27 19:37:05 +00003538 switch (D.Kind) {
3539 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003540 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003541 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003542 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003543 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003544 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003545 case IITDescriptor::Float: return !Ty->isFloatTy();
3546 case IITDescriptor::Double: return !Ty->isDoubleTy();
3547 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3548 case IITDescriptor::Vector: {
3549 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003550 return !VT || VT->getNumElements() != D.Vector_Width ||
Chris Lattner144b6192012-05-27 19:37:05 +00003551 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3552 }
3553 case IITDescriptor::Pointer: {
3554 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003555 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Chris Lattner144b6192012-05-27 19:37:05 +00003556 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3557 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003558
Chris Lattner144b6192012-05-27 19:37:05 +00003559 case IITDescriptor::Struct: {
3560 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003561 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003562 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003563
Chris Lattner144b6192012-05-27 19:37:05 +00003564 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3565 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3566 return true;
3567 return false;
3568 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003569
Chris Lattner144b6192012-05-27 19:37:05 +00003570 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003571 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003572 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003573 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003574 return Ty != ArgTys[D.getArgumentNumber()];
3575
Chris Lattner144b6192012-05-27 19:37:05 +00003576 // Otherwise, if this is the first instance of an argument, record it and
3577 // verify the "Any" kind.
3578 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3579 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003580
Chris Lattner144b6192012-05-27 19:37:05 +00003581 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003582 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003583 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3584 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3585 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3586 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3587 }
3588 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003589
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003590 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003591 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003592 if (D.getArgumentNumber() >= ArgTys.size())
3593 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003594
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003595 Type *NewTy = ArgTys[D.getArgumentNumber()];
3596 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3597 NewTy = VectorType::getExtendedElementVectorType(VTy);
3598 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3599 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3600 else
3601 return true;
3602
3603 return Ty != NewTy;
3604 }
3605 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003606 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003607 if (D.getArgumentNumber() >= ArgTys.size())
3608 return true;
3609
3610 Type *NewTy = ArgTys[D.getArgumentNumber()];
3611 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3612 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3613 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3614 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3615 else
3616 return true;
3617
3618 return Ty != NewTy;
3619 }
Tim Northover4516de32014-03-29 07:04:54 +00003620 case IITDescriptor::HalfVecArgument:
3621 // This may only be used when referring to a previous vector argument.
3622 return D.getArgumentNumber() >= ArgTys.size() ||
3623 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3624 VectorType::getHalfElementsVectorType(
3625 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003626 case IITDescriptor::SameVecWidthArgument: {
3627 if (D.getArgumentNumber() >= ArgTys.size())
3628 return true;
3629 VectorType * ReferenceType =
3630 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3631 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3632 if (!ThisArgType || !ReferenceType ||
3633 (ReferenceType->getVectorNumElements() !=
3634 ThisArgType->getVectorNumElements()))
3635 return true;
3636 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3637 Infos, ArgTys);
3638 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003639 case IITDescriptor::PtrToArgument: {
3640 if (D.getArgumentNumber() >= ArgTys.size())
3641 return true;
3642 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3643 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3644 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3645 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003646 case IITDescriptor::VecOfPtrsToElt: {
3647 if (D.getArgumentNumber() >= ArgTys.size())
3648 return true;
3649 VectorType * ReferenceType =
3650 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3651 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3652 if (!ThisArgVecTy || !ReferenceType ||
3653 (ReferenceType->getVectorNumElements() !=
3654 ThisArgVecTy->getVectorNumElements()))
3655 return true;
3656 PointerType *ThisArgEltTy =
3657 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3658 if (!ThisArgEltTy)
3659 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003660 return ThisArgEltTy->getElementType() !=
3661 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003662 }
Chris Lattner144b6192012-05-27 19:37:05 +00003663 }
3664 llvm_unreachable("unhandled");
3665}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003666
Andrew Tricka2efd992013-10-31 17:18:11 +00003667/// \brief Verify if the intrinsic has variable arguments.
3668/// This method is intended to be called after all the fixed arguments have been
3669/// verified first.
3670///
3671/// This method returns true on error and does not print an error message.
3672bool
3673Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3674 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3675 using namespace Intrinsic;
3676
3677 // If there are no descriptors left, then it can't be a vararg.
3678 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003679 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003680
3681 // There should be only one descriptor remaining at this point.
3682 if (Infos.size() != 1)
3683 return true;
3684
3685 // Check and verify the descriptor.
3686 IITDescriptor D = Infos.front();
3687 Infos = Infos.slice(1);
3688 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003689 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003690
3691 return true;
3692}
3693
Philip Reames007561a2015-06-26 22:21:52 +00003694/// Allow intrinsics to be verified in different ways.
3695void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003696 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003697 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3698 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003699
Chris Lattner144b6192012-05-27 19:37:05 +00003700 // Verify that the intrinsic prototype lines up with what the .td files
3701 // describe.
3702 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003703 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003704
Chris Lattner144b6192012-05-27 19:37:05 +00003705 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3706 getIntrinsicInfoTableEntries(ID, Table);
3707 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003708
Chris Lattner144b6192012-05-27 19:37:05 +00003709 SmallVector<Type *, 4> ArgTys;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003710 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3711 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003712 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003713 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3714 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003715
3716 // Verify if the intrinsic call matches the vararg property.
3717 if (IsVarArg)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003718 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3719 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003720 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003721 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3722 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003723
3724 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003725 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003726
3727 // Now that we have the intrinsic ID and the actual argument types (and we
3728 // know they are legal for the intrinsic!) get the intrinsic name through the
3729 // usual means. This allows us to verify the mangling of argument types into
3730 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003731 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003732 Assert(ExpectedName == IF->getName(),
3733 "Intrinsic name not mangled correctly for type arguments! "
3734 "Should be: " +
3735 ExpectedName,
3736 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003737
Chris Lattner588096e2009-12-28 09:07:21 +00003738 // If the intrinsic takes MDNode arguments, verify that they are either global
3739 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003740 for (Value *V : CS.args())
3741 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3742 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003743
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003744 switch (ID) {
3745 default:
3746 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003747 case Intrinsic::ctlz: // llvm.ctlz
3748 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003749 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003750 "is_zero_undef argument of bit counting intrinsics must be a "
3751 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003752 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003753 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003754 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003755 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3756 "invalid llvm.dbg.declare intrinsic call 1", CS);
3757 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003758 break;
3759 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003760 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003761 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003762 case Intrinsic::memcpy:
3763 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003764 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003765 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003766 Assert(AlignCI,
3767 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003768 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003769 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003770 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003771 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003772 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003773 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003774 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003775 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003776 }
Bill Wendling05604e02008-08-23 09:46:46 +00003777 case Intrinsic::gcroot:
3778 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003779 case Intrinsic::gcread:
3780 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003781 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003782 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3783 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3784 Assert(isa<Constant>(CS.getArgOperand(1)),
3785 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003786 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003787 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003788 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3789 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003790 CS);
Talin2e59f142010-09-30 20:23:47 +00003791 }
Chris Lattner25852062008-08-24 20:46:13 +00003792 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003793
Philip Reames9818dd72015-06-26 22:04:34 +00003794 Assert(CS.getParent()->getParent()->hasGC(),
3795 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003796 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003797 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003798 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003799 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003800 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003801 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003802 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003803 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3804 isa<ConstantInt>(CS.getArgOperand(2)) &&
3805 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3806 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3807 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003808 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003809 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003810 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3811 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003812 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003813 case Intrinsic::lifetime_start:
3814 case Intrinsic::lifetime_end:
3815 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003816 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003817 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003818 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003819 break;
3820 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003821 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3822 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003823 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003824
Reid Kleckner60381792015-07-07 22:25:32 +00003825 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003826 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003827 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003828 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003829 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003830 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003831 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003832 if (isa<ConstantPointerNull>(Arg))
3833 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003834 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003835 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003836 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003837 }
Philip Reames9818dd72015-06-26 22:04:34 +00003838 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003839 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003840 break;
3841 }
Reid Kleckner60381792015-07-07 22:25:32 +00003842 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003843 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003844 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003845 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003846 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003847 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003848 CS);
3849 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003850 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003851 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003852 auto &Entry = FrameEscapeInfo[Fn];
3853 Entry.second = unsigned(
3854 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003855 break;
3856 }
3857
Philip Reames1ffa9372015-01-30 23:28:05 +00003858 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00003859 Assert(!CS.isInlineAsm(),
3860 "gc.statepoint support for inline assembly unimplemented", CS);
3861 Assert(CS.getParent()->getParent()->hasGC(),
3862 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00003863
Philip Reames9818dd72015-06-26 22:04:34 +00003864 VerifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003865 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003866 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00003867 Assert(CS.getParent()->getParent()->hasGC(),
3868 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003869 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00003870 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00003871 const Function *StatepointFn =
3872 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003873 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3874 StatepointFn->getIntrinsicID() ==
3875 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00003876 "gc.result operand #1 must be from a statepoint", CS,
3877 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00003878
Philip Reamesb23713a2014-12-03 22:23:24 +00003879 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003880 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00003881 auto *PT = cast<PointerType>(Target->getType());
3882 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00003883 Assert(CS.getType() == TargetFuncType->getReturnType(),
3884 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003885 break;
3886 }
3887 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00003888 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003889
Philip Reames3e2cf532016-01-07 03:32:11 +00003890 Assert(isa<PointerType>(CS.getType()->getScalarType()),
3891 "gc.relocate must return a pointer or a vector of pointers", CS);
3892
Igor Laevsky9570ff92015-02-19 11:28:47 +00003893 // Check that this relocate is correctly tied to the statepoint
3894
3895 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00003896 if (LandingPadInst *LandingPad =
3897 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00003898
Sanjoy Das5665c992015-05-11 23:47:27 +00003899 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00003900 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00003901
3902 // Landingpad relocates should have only one predecessor with invoke
3903 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00003904 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00003905 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00003906 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3907 InvokeBB);
3908 Assert(isStatepoint(InvokeBB->getTerminator()),
3909 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003910 }
3911 else {
3912 // In all other cases relocate should be tied to the statepoint directly.
3913 // This covers relocates on a normal return path of invoke statepoint and
3914 // relocates of a call statepoint
Philip Reames9818dd72015-06-26 22:04:34 +00003915 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003916 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00003917 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003918 }
3919
3920 // Verify rest of the relocate arguments
3921
Manuel Jacob83eefa62016-01-05 04:03:00 +00003922 ImmutableCallSite StatepointCS(
3923 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00003924
3925 // Both the base and derived must be piped through the safepoint
Philip Reames9818dd72015-06-26 22:04:34 +00003926 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003927 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00003928 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003929
Philip Reames9818dd72015-06-26 22:04:34 +00003930 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003931 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00003932 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003933
3934 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3935 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3936 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003937 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003938 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003939 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003940 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00003941
3942 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3943 // section of the statepoint's argument
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003944 Assert(StatepointCS.arg_size() > 0,
3945 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003946 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00003947 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003948 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003949 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3950 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003951 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003952 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00003953 "gc.statepoint: number of transition arguments must be "
3954 "a constant integer");
3955 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003956 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3957 ->getZExtValue();
3958 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00003959 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00003960 "gc.statepoint: number of deoptimization arguments must be "
3961 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00003962 const int NumDeoptArgs =
Pat Gavlincc0431d2015-05-08 18:07:42 +00003963 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3964 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00003965 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003966 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3967 "gc.relocate: statepoint base index doesn't fall within the "
3968 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00003969 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003970 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3971 "gc.relocate: statepoint derived index doesn't fall within the "
3972 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00003973 CS);
Philip Reames38303a32014-12-03 19:53:15 +00003974
Philip Reames3e2cf532016-01-07 03:32:11 +00003975 // Relocated value must be either a pointer type or vector-of-pointer type,
3976 // but gc_relocate does not need to return the same pointer type as the
3977 // relocated pointer. It can be casted to the correct type later if it's
3978 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00003979 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00003980 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00003981 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00003982
Philip Reames3e2cf532016-01-07 03:32:11 +00003983 auto ResultType = CS.getType();
3984 auto DerivedType = Relocate.getDerivedPtr()->getType();
3985 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
3986 "gc.relocate: vector relocates to vector and pointer to pointer", CS);
3987 Assert(ResultType->getPointerAddressSpace() ==
3988 DerivedType->getPointerAddressSpace(),
Philip Reames9818dd72015-06-26 22:04:34 +00003989 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003990 break;
3991 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00003992 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00003993 case Intrinsic::eh_exceptionpointer: {
3994 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
3995 "eh.exceptionpointer argument must be a catchpad", CS);
3996 break;
3997 }
Philip Reames337c4bd2014-12-01 21:18:12 +00003998 };
Chris Lattner0e851da2002-04-18 20:37:37 +00003999}
4000
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004001/// \brief Carefully grab the subprogram from a local scope.
4002///
4003/// This carefully grabs the subprogram from a local scope, avoiding the
4004/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004005static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004006 if (!LocalScope)
4007 return nullptr;
4008
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004009 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004010 return SP;
4011
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004012 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004013 return getSubprogram(LB->getRawScope());
4014
4015 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004016 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004017 return nullptr;
4018}
4019
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004020template <class DbgIntrinsicTy>
4021void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4022 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
4023 Assert(isa<ValueAsMetadata>(MD) ||
4024 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4025 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004026 Assert(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004027 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4028 DII.getRawVariable());
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004029 Assert(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004030 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4031 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004032
4033 // Ignore broken !dbg attachments; they're checked elsewhere.
4034 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004035 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004036 return;
4037
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004038 BasicBlock *BB = DII.getParent();
4039 Function *F = BB ? BB->getParent() : nullptr;
4040
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004041 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004042 DILocalVariable *Var = DII.getVariable();
4043 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004044 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4045 &DII, BB, F);
4046
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004047 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4048 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004049 if (!VarSP || !LocSP)
4050 return; // Broken scope chains are checked elsewhere.
4051
4052 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4053 " variable and !dbg attachment",
4054 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4055 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004056}
4057
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004058template <class MapTy>
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004059static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004060 // Be careful of broken types (checked elsewhere).
4061 const Metadata *RawType = V.getRawType();
4062 while (RawType) {
4063 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004064 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004065 if (uint64_t Size = T->getSizeInBits())
4066 return Size;
4067
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004068 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004069 // Look at the base type.
4070 RawType = DT->getRawBaseType();
4071 continue;
4072 }
4073
4074 if (auto *S = dyn_cast<MDString>(RawType)) {
4075 // Don't error on missing types (checked elsewhere).
4076 RawType = Map.lookup(S);
4077 continue;
4078 }
4079
4080 // Missing type or size.
4081 break;
4082 }
4083
4084 // Fail gracefully.
4085 return 0;
4086}
4087
4088template <class MapTy>
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004089void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
4090 const MapTy &TypeRefs) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004091 DILocalVariable *V;
4092 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004093 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004094 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4095 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004096 } else {
4097 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004098 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4099 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004100 }
4101
4102 // We don't know whether this intrinsic verified correctly.
4103 if (!V || !E || !E->isValid())
4104 return;
4105
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004106 // Nothing to do if this isn't a bit piece expression.
4107 if (!E->isBitPiece())
4108 return;
4109
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004110 // The frontend helps out GDB by emitting the members of local anonymous
4111 // unions as artificial local variables with shared storage. When SROA splits
4112 // the storage for artificial local variables that are smaller than the entire
4113 // union, the overhang piece will be outside of the allotted space for the
4114 // variable and this check fails.
4115 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4116 if (V->isArtificial())
4117 return;
4118
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004119 // If there's no size, the type is broken, but that should be checked
4120 // elsewhere.
4121 uint64_t VarSize = getVariableSize(*V, TypeRefs);
4122 if (!VarSize)
4123 return;
4124
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004125 unsigned PieceSize = E->getBitPieceSize();
4126 unsigned PieceOffset = E->getBitPieceOffset();
4127 Assert(PieceSize + PieceOffset <= VarSize,
4128 "piece is larger than or outside of variable", &I, V, E);
4129 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004130}
4131
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004132void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
4133 // This is in its own function so we get an error for each bad type ref (not
4134 // just the first).
4135 Assert(false, "unresolved type ref", S, N);
4136}
4137
4138void Verifier::verifyTypeRefs() {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004139 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4140 if (!CUs)
4141 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004142
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004143 // Visit all the compile units again to map the type references.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004144 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004145 for (auto *CU : CUs->operands())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004146 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
4147 for (DIType *Op : Ts)
David Blaikie3c338f32015-08-22 22:36:40 +00004148 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004149 if (auto *S = T->getRawIdentifier()) {
4150 UnresolvedTypeRefs.erase(S);
4151 TypeRefs.insert(std::make_pair(S, T));
4152 }
4153
4154 // Verify debug info intrinsic bit piece expressions. This needs a second
4155 // pass through the intructions, since we haven't built TypeRefs yet when
4156 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
4157 // later/now would queue up some that could be later deleted.
4158 for (const Function &F : *M)
4159 for (const BasicBlock &BB : F)
4160 for (const Instruction &I : BB)
4161 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Keno Fischer78e5c9e2016-01-13 02:31:14 +00004162 verifyBitPieceExpression(*DII, TypeRefs);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004163
4164 // Return early if all typerefs were resolved.
4165 if (UnresolvedTypeRefs.empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004166 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004167
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004168 // Sort the unresolved references by name so the output is deterministic.
4169 typedef std::pair<const MDString *, const MDNode *> TypeRef;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004170 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
4171 UnresolvedTypeRefs.end());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004172 std::sort(Unresolved.begin(), Unresolved.end(),
4173 [](const TypeRef &LHS, const TypeRef &RHS) {
4174 return LHS.first->getString() < RHS.first->getString();
4175 });
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004176
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004177 // Visit the unresolved refs (printing out the errors).
4178 for (const TypeRef &TR : Unresolved)
4179 visitUnresolvedTypeRef(TR.first, TR.second);
Manman Ren74c61b92013-07-19 00:31:03 +00004180}
4181
Chris Lattner0e851da2002-04-18 20:37:37 +00004182//===----------------------------------------------------------------------===//
4183// Implement the public interfaces to this file...
4184//===----------------------------------------------------------------------===//
4185
Chandler Carruth043949d2014-01-19 02:22:18 +00004186bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004187 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00004188 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00004189
Chandler Carruth043949d2014-01-19 02:22:18 +00004190 raw_null_ostream NullStr;
4191 Verifier V(OS ? *OS : NullStr);
4192
4193 // Note that this function's return value is inverted from what you would
4194 // expect of a function called "verify".
4195 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004196}
4197
Chandler Carruth043949d2014-01-19 02:22:18 +00004198bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
4199 raw_null_ostream NullStr;
4200 Verifier V(OS ? *OS : NullStr);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004201
Chandler Carruth043949d2014-01-19 02:22:18 +00004202 bool Broken = false;
4203 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindolad4bcefc2014-10-24 18:13:04 +00004204 if (!I->isDeclaration() && !I->isMaterializable())
Chandler Carruth043949d2014-01-19 02:22:18 +00004205 Broken |= !V.verify(*I);
4206
4207 // Note that this function's return value is inverted from what you would
4208 // expect of a function called "verify".
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +00004209 return !V.verify(M) || Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004210}
Chandler Carruth043949d2014-01-19 02:22:18 +00004211
4212namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004213struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004214 static char ID;
4215
4216 Verifier V;
4217 bool FatalErrors;
4218
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +00004219 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004220 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004221 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004222 explicit VerifierLegacyPass(bool FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004223 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004224 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004225 }
4226
Craig Topperf398d7c2014-03-05 06:35:38 +00004227 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004228 if (!V.verify(F) && FatalErrors)
4229 report_fatal_error("Broken function found, compilation aborted!");
4230
4231 return false;
4232 }
4233
Craig Topperf398d7c2014-03-05 06:35:38 +00004234 bool doFinalization(Module &M) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004235 if (!V.verify(M) && FatalErrors)
4236 report_fatal_error("Broken module found, compilation aborted!");
4237
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004238 return false;
4239 }
4240
4241 void getAnalysisUsage(AnalysisUsage &AU) const override {
4242 AU.setPreservesAll();
4243 }
4244};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004245}
Chandler Carruth043949d2014-01-19 02:22:18 +00004246
Chandler Carruth4d356312014-01-20 11:34:08 +00004247char VerifierLegacyPass::ID = 0;
4248INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004249
4250FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004251 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004252}
4253
Chandler Carruthd174ce42015-01-05 02:47:05 +00004254PreservedAnalyses VerifierPass::run(Module &M) {
4255 if (verifyModule(M, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004256 report_fatal_error("Broken module found, compilation aborted!");
4257
4258 return PreservedAnalyses::all();
4259}
4260
Chandler Carruthd174ce42015-01-05 02:47:05 +00004261PreservedAnalyses VerifierPass::run(Function &F) {
4262 if (verifyFunction(F, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004263 report_fatal_error("Broken function found, compilation aborted!");
4264
4265 return PreservedAnalyses::all();
4266}