blob: d62a7d9a3f231d26566ccbaad06c14a170c401fb [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
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000220 // Verify that this GlobalValue is only used in this module.
221 // This map is used to avoid visiting uses twice. We can arrive at a user
222 // twice, if they have multiple operands. In particular for very large
223 // constant expressions, we can arrive at a particular user many times.
224 SmallPtrSet<const Value *, 32> GlobalValueVisited;
225
JF Bastiend1fb5852015-12-17 22:09:19 +0000226 void checkAtomicMemAccessSize(const Module *M, Type *Ty,
227 const Instruction *I);
Chandler Carruth043949d2014-01-19 02:22:18 +0000228public:
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +0000229 explicit Verifier(raw_ostream &OS)
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +0000230 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
David Majnemer654e1302015-07-31 17:58:14 +0000231 SawFrameEscape(false) {}
Chris Lattner0e851da2002-04-18 20:37:37 +0000232
Chandler Carruth043949d2014-01-19 02:22:18 +0000233 bool verify(const Function &F) {
234 M = F.getParent();
235 Context = &M->getContext();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000236
237 // First ensure the function is well-enough formed to compute dominance
238 // information.
Chandler Carruth043949d2014-01-19 02:22:18 +0000239 if (F.empty()) {
240 OS << "Function '" << F.getName()
241 << "' does not contain an entry block!\n";
242 return false;
243 }
244 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000245 if (I->empty() || !I->back().isTerminator()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000246 OS << "Basic Block in function '" << F.getName()
247 << "' does not have terminator!\n";
248 I->printAsOperand(OS, true);
249 OS << "\n";
250 return false;
Chandler Carruth76777602014-01-17 10:56:02 +0000251 }
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000252 }
Chandler Carruth76777602014-01-17 10:56:02 +0000253
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000254 // Now directly compute a dominance tree. We don't rely on the pass
255 // manager to provide this as it isolates us from a potentially
256 // out-of-date dominator tree and makes it significantly more complex to
257 // run this code outside of a pass manager.
Chandler Carruth043949d2014-01-19 02:22:18 +0000258 // FIXME: It's really gross that we have to cast away constness here.
259 DT.recalculate(const_cast<Function &>(F));
Chris Lattneraf332ee2007-04-20 23:59:29 +0000260
Chandler Carruth043949d2014-01-19 02:22:18 +0000261 Broken = false;
262 // FIXME: We strip const here because the inst visitor strips const.
263 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000264 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000265 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000266 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000267 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000268 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000269
Chandler Carruth043949d2014-01-19 02:22:18 +0000270 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000271 }
272
Chandler Carruth043949d2014-01-19 02:22:18 +0000273 bool verify(const Module &M) {
274 this->M = &M;
275 Context = &M.getContext();
Chandler Carruth043949d2014-01-19 02:22:18 +0000276 Broken = false;
277
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000278 // Scan through, checking all of the external function's linkage now...
Chandler Carruth043949d2014-01-19 02:22:18 +0000279 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000280 visitGlobalValue(*I);
281
282 // Check to make sure function prototypes are okay.
283 if (I->isDeclaration())
284 visitFunction(*I);
285 }
286
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000287 // Now that we've visited every function, verify that we never asked to
288 // recover a frame index that wasn't escaped.
289 verifyFrameRecoverIndices();
290
Chandler Carruth043949d2014-01-19 02:22:18 +0000291 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000292 I != E; ++I)
293 visitGlobalVariable(*I);
294
Chandler Carruth043949d2014-01-19 02:22:18 +0000295 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
296 I != E; ++I)
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000297 visitGlobalAlias(*I);
298
Chandler Carruth043949d2014-01-19 02:22:18 +0000299 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
300 E = M.named_metadata_end();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000301 I != E; ++I)
302 visitNamedMDNode(*I);
303
David Majnemerdad0a642014-06-27 18:19:56 +0000304 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
305 visitComdat(SMEC.getValue());
306
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000307 visitModuleFlags(M);
308 visitModuleIdents(M);
309
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000310 // Verify type referneces last.
311 verifyTypeRefs();
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000312
Chandler Carruth043949d2014-01-19 02:22:18 +0000313 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000314 }
Chris Lattner9713b842002-04-28 16:04:26 +0000315
Chandler Carruth043949d2014-01-19 02:22:18 +0000316private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000317 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000318 void visitGlobalValue(const GlobalValue &GV);
319 void visitGlobalVariable(const GlobalVariable &GV);
320 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000321 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000322 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000323 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000324 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000325 void visitMDNode(const MDNode &MD);
326 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
327 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000328 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000329 void visitModuleIdents(const Module &M);
330 void visitModuleFlags(const Module &M);
331 void visitModuleFlag(const MDNode *Op,
332 DenseMap<const MDString *, const MDNode *> &SeenIDs,
333 SmallVectorImpl<const MDNode *> &Requirements);
334 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000335 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000336 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000337 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000338
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000339 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000340#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
341#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000342 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000343 void visitDIVariable(const DIVariable &N);
344 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
345 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000346
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000347 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
348
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000349 /// \brief Check for a valid string-based type reference.
350 ///
351 /// Checks if \c MD is a string-based type reference. If it is, keeps track
352 /// of it (and its user, \c N) for error messages later.
353 bool isValidUUID(const MDNode &N, const Metadata *MD);
354
355 /// \brief Check for a valid type reference.
356 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000357 /// Checks for subclasses of \a DIType, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000358 bool isTypeRef(const MDNode &N, const Metadata *MD);
359
360 /// \brief Check for a valid scope reference.
361 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000362 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000363 bool isScopeRef(const MDNode &N, const Metadata *MD);
364
365 /// \brief Check for a valid debug info reference.
366 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000367 /// Checks for subclasses of \a DINode, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000368 bool isDIRef(const MDNode &N, const Metadata *MD);
369
Chandler Carruth043949d2014-01-19 02:22:18 +0000370 // InstVisitor overrides...
371 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000372 void visit(Instruction &I);
373
374 void visitTruncInst(TruncInst &I);
375 void visitZExtInst(ZExtInst &I);
376 void visitSExtInst(SExtInst &I);
377 void visitFPTruncInst(FPTruncInst &I);
378 void visitFPExtInst(FPExtInst &I);
379 void visitFPToUIInst(FPToUIInst &I);
380 void visitFPToSIInst(FPToSIInst &I);
381 void visitUIToFPInst(UIToFPInst &I);
382 void visitSIToFPInst(SIToFPInst &I);
383 void visitIntToPtrInst(IntToPtrInst &I);
384 void visitPtrToIntInst(PtrToIntInst &I);
385 void visitBitCastInst(BitCastInst &I);
386 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
387 void visitPHINode(PHINode &PN);
388 void visitBinaryOperator(BinaryOperator &B);
389 void visitICmpInst(ICmpInst &IC);
390 void visitFCmpInst(FCmpInst &FC);
391 void visitExtractElementInst(ExtractElementInst &EI);
392 void visitInsertElementInst(InsertElementInst &EI);
393 void visitShuffleVectorInst(ShuffleVectorInst &EI);
394 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
395 void visitCallInst(CallInst &CI);
396 void visitInvokeInst(InvokeInst &II);
397 void visitGetElementPtrInst(GetElementPtrInst &GEP);
398 void visitLoadInst(LoadInst &LI);
399 void visitStoreInst(StoreInst &SI);
400 void verifyDominatesUse(Instruction &I, unsigned i);
401 void visitInstruction(Instruction &I);
402 void visitTerminatorInst(TerminatorInst &I);
403 void visitBranchInst(BranchInst &BI);
404 void visitReturnInst(ReturnInst &RI);
405 void visitSwitchInst(SwitchInst &SI);
406 void visitIndirectBrInst(IndirectBrInst &BI);
407 void visitSelectInst(SelectInst &SI);
408 void visitUserOp1(Instruction &I);
409 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000410 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000411 template <class DbgIntrinsicTy>
412 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000413 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
414 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
415 void visitFenceInst(FenceInst &FI);
416 void visitAllocaInst(AllocaInst &AI);
417 void visitExtractValueInst(ExtractValueInst &EVI);
418 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000419 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000420 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemer654e1302015-07-31 17:58:14 +0000421 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000422 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000423 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000424 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000425 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000426 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000427
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000428 void verifyCallSite(CallSite CS);
Reid Kleckner5772b772014-04-24 20:14:34 +0000429 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000430 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000431 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000432 bool verifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000433 SmallVectorImpl<Type *> &ArgTys);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000434 bool verifyIntrinsicIsVarArg(bool isVarArg,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000435 ArrayRef<Intrinsic::IITDescriptor> &Infos);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000436 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
437 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000438 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000439 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000440 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000441 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000442 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000443 void verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +0000444 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000445
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000446 void visitConstantExprsRecursively(const Constant *EntryC);
447 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000448 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000449 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000450 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000451
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000452 // Module-level debug info verification...
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000453 void verifyTypeRefs();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000454 template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +0000455 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
456 const MapTy &TypeRefs);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000457 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000458};
Chris Lattner189d19f2003-11-21 20:23:48 +0000459} // End anonymous namespace
460
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000461// Assert - We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000462#define Assert(C, ...) \
463 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000464
Chris Lattnere5a22c02008-08-28 04:02:44 +0000465void Verifier::visit(Instruction &I) {
466 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000467 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000468 InstVisitor<Verifier>::visit(I);
469}
470
Keno Fischer60f82a22016-01-14 22:20:56 +0000471// Helper to recursively iterate over indirect users. By
472// returning false, the callback can ask to stop recursing
473// further.
474static void forEachUser(const Value *User,
475 SmallPtrSet<const Value *, 32> &Visited,
476 llvm::function_ref<bool(const Value *)> Callback) {
477 if (!Visited.insert(User).second)
478 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000479 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000480 if (Callback(TheNextUser))
481 forEachUser(TheNextUser, Visited, Callback);
482}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000483
Chandler Carruth043949d2014-01-19 02:22:18 +0000484void Verifier::visitGlobalValue(const GlobalValue &GV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000485 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
486 GV.hasExternalWeakLinkage(),
487 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000488
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000489 Assert(GV.getAlignment() <= Value::MaximumAlignment,
490 "huge alignment values are unsupported", &GV);
491 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
492 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000493
494 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000495 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000496 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000497 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000498 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000499
500 if (GV.isDeclarationForLinker())
501 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000502
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000503 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000504 if (const Instruction *I = dyn_cast<Instruction>(V)) {
505 if (!I->getParent() || !I->getParent()->getParent())
506 CheckFailed("Global is referenced by parentless instruction!", &GV,
507 M, I);
508 else if (I->getParent()->getParent()->getParent() != M)
509 CheckFailed("Global is referenced in a different module!", &GV,
510 M, I, I->getParent()->getParent(),
511 I->getParent()->getParent()->getParent());
512 return false;
513 } else if (const Function *F = dyn_cast<Function>(V)) {
514 if (F->getParent() != M)
515 CheckFailed("Global is used by function in a different module", &GV,
516 M, F, F->getParent());
517 return false;
518 }
519 return true;
520 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000521}
522
Chandler Carruth043949d2014-01-19 02:22:18 +0000523void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000524 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000525 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000526 "Global variable initializer type does not match global "
527 "variable type!",
528 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000529
Chris Lattner0aff0b22009-08-05 05:41:44 +0000530 // If the global has common linkage, it must have a zero initializer and
531 // cannot be constant.
532 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000533 Assert(GV.getInitializer()->isNullValue(),
534 "'common' global must have a zero initializer!", &GV);
535 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
536 &GV);
537 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000538 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000539 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000540 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
541 "invalid linkage type for global declaration", &GV);
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000542 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000543
Nick Lewycky466d0c12011-04-08 07:30:21 +0000544 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
545 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000546 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
547 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000548 // Don't worry about emitting an error for it not being an array,
549 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000550 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000551 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
552 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000553 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000554 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000555 Assert(STy &&
556 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
557 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
558 STy->getTypeAtIndex(1) == FuncPtrTy,
559 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000560 if (STy->getNumElements() == 3) {
561 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000562 Assert(ETy->isPointerTy() &&
563 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
564 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000565 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000566 }
567 }
568
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000569 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000570 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000571 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
572 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000573 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000574 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
575 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000576 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000577 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000578 const Constant *Init = GV.getInitializer();
579 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000580 Assert(InitArray, "wrong initalizer for intrinsic global variable",
581 Init);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000582 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
Rafael Espindolaeaf53272013-05-27 22:47:09 +0000583 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000584 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
585 isa<GlobalAlias>(V),
586 "invalid llvm.used member", V);
587 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000588 }
589 }
590 }
591 }
592
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000593 Assert(!GV.hasDLLImportStorageClass() ||
594 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
595 GV.hasAvailableExternallyLinkage(),
596 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000597
Matt Arsenault24b49c42013-07-31 17:49:08 +0000598 if (!GV.hasInitializer()) {
599 visitGlobalValue(GV);
600 return;
601 }
602
603 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000604 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000605
Chris Lattnere3400652004-12-15 20:23:49 +0000606 visitGlobalValue(GV);
607}
608
Rafael Espindola64c1e182014-06-03 02:41:57 +0000609void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
610 SmallPtrSet<const GlobalAlias*, 4> Visited;
611 Visited.insert(&GA);
612 visitAliaseeSubExpr(Visited, GA, C);
613}
614
Craig Topper71b7b682014-08-21 05:55:13 +0000615void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000616 const GlobalAlias &GA, const Constant &C) {
617 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000618 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
619 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000620
621 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000622 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000623
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000624 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
625 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000626 } else {
627 // Only continue verifying subexpressions of GlobalAliases.
628 // Do not recurse into global initializers.
629 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000630 }
631 }
632
633 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000634 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000635
636 for (const Use &U : C.operands()) {
637 Value *V = &*U;
638 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
639 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
640 else if (const auto *C2 = dyn_cast<Constant>(V))
641 visitAliaseeSubExpr(Visited, GA, *C2);
642 }
643}
644
Chandler Carruth043949d2014-01-19 02:22:18 +0000645void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000646 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
647 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
648 "weak_odr, or external linkage!",
649 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000650 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000651 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
652 Assert(GA.getType() == Aliasee->getType(),
653 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000654
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000655 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
656 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000657
Rafael Espindola64c1e182014-06-03 02:41:57 +0000658 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000659
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000660 visitGlobalValue(GA);
661}
662
Chandler Carruth043949d2014-01-19 02:22:18 +0000663void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000664 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000665 MDNode *MD = NMD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000666
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000667 if (NMD.getName() == "llvm.dbg.cu") {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000668 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000669 }
670
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000671 if (!MD)
672 continue;
673
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000674 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000675 }
676}
677
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000678void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000679 // Only visit each node once. Metadata can be mutually recursive, so this
680 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000681 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000682 return;
683
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000684 switch (MD.getMetadataID()) {
685 default:
686 llvm_unreachable("Invalid MDNode subclass");
687 case Metadata::MDTupleKind:
688 break;
689#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
690 case Metadata::CLASS##Kind: \
691 visit##CLASS(cast<CLASS>(MD)); \
692 break;
693#include "llvm/IR/Metadata.def"
694 }
695
Duncan Sands76d62172010-04-29 16:10:30 +0000696 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000697 Metadata *Op = MD.getOperand(i);
Duncan Sands76d62172010-04-29 16:10:30 +0000698 if (!Op)
699 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000700 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
701 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000702 if (auto *N = dyn_cast<MDNode>(Op)) {
703 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000704 continue;
705 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000706 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
707 visitValueAsMetadata(*V, nullptr);
708 continue;
709 }
Duncan Sands76d62172010-04-29 16:10:30 +0000710 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000711
712 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000713 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
714 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000715}
716
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000717void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000718 Assert(MD.getValue(), "Expected valid value", &MD);
719 Assert(!MD.getValue()->getType()->isMetadataTy(),
720 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000721
722 auto *L = dyn_cast<LocalAsMetadata>(&MD);
723 if (!L)
724 return;
725
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000726 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000727
728 // If this was an instruction, bb, or argument, verify that it is in the
729 // function that we expect.
730 Function *ActualF = nullptr;
731 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000732 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000733 ActualF = I->getParent()->getParent();
734 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
735 ActualF = BB->getParent();
736 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
737 ActualF = A->getParent();
738 assert(ActualF && "Unimplemented function local metadata case!");
739
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000740 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000741}
742
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000743void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000744 Metadata *MD = MDV.getMetadata();
745 if (auto *N = dyn_cast<MDNode>(MD)) {
746 visitMDNode(*N);
747 return;
748 }
749
750 // Only visit each node once. Metadata can be mutually recursive, so this
751 // avoids infinite recursion here, as well as being an optimization.
752 if (!MDNodes.insert(MD).second)
753 return;
754
755 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
756 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000757}
758
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000759bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
760 auto *S = dyn_cast<MDString>(MD);
761 if (!S)
762 return false;
763 if (S->getString().empty())
764 return false;
765
766 // Keep track of names of types referenced via UUID so we can check that they
767 // actually exist.
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000768 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000769 return true;
770}
771
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000772/// \brief Check if a value can be a reference to a type.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000773bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000774 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000775}
776
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000777/// \brief Check if a value can be a ScopeRef.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000778bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000779 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000780}
781
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000782/// \brief Check if a value can be a debug info ref.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000783bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000784 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000785}
786
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000787template <class Ty>
788bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
789 for (Metadata *MD : N.operands()) {
790 if (MD) {
791 if (!isa<Ty>(MD))
792 return false;
793 } else {
794 if (!AllowNull)
795 return false;
796 }
797 }
798 return true;
799}
800
801template <class Ty>
802bool isValidMetadataArray(const MDTuple &N) {
803 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
804}
805
806template <class Ty>
807bool isValidMetadataNullArray(const MDTuple &N) {
808 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
809}
810
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000811void Verifier::visitDILocation(const DILocation &N) {
812 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000813 "location requires a valid scope", &N, N.getRawScope());
814 if (auto *IA = N.getRawInlinedAt())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000815 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000816}
817
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000818void Verifier::visitGenericDINode(const GenericDINode &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000819 Assert(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000820}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000821
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000822void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000823 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000824 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000825}
826
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000827void Verifier::visitDISubrange(const DISubrange &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000828 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000829 Assert(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000830}
831
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000832void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000833 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000834}
835
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000836void Verifier::visitDIBasicType(const DIBasicType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000837 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
838 N.getTag() == dwarf::DW_TAG_unspecified_type,
839 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000840}
841
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000842void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000843 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000844 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000845
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000846 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
847 N.getTag() == dwarf::DW_TAG_pointer_type ||
848 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
849 N.getTag() == dwarf::DW_TAG_reference_type ||
850 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
851 N.getTag() == dwarf::DW_TAG_const_type ||
852 N.getTag() == dwarf::DW_TAG_volatile_type ||
853 N.getTag() == dwarf::DW_TAG_restrict_type ||
854 N.getTag() == dwarf::DW_TAG_member ||
855 N.getTag() == dwarf::DW_TAG_inheritance ||
856 N.getTag() == dwarf::DW_TAG_friend,
857 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000858 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000859 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
860 N.getExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000861 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000862
863 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
864 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
865 N.getBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000866}
867
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000868static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000869 return (Flags & DINode::FlagLValueReference) &&
870 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000871}
872
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000873void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
874 auto *Params = dyn_cast<MDTuple>(&RawParams);
875 Assert(Params, "invalid template params", &N, &RawParams);
876 for (Metadata *Op : Params->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000877 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000878 Params, Op);
879 }
880}
881
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000882void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000883 // Common scope checks.
884 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000885
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000886 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
887 N.getTag() == dwarf::DW_TAG_structure_type ||
888 N.getTag() == dwarf::DW_TAG_union_type ||
889 N.getTag() == dwarf::DW_TAG_enumeration_type ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000890 N.getTag() == dwarf::DW_TAG_class_type,
891 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000892
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000893 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
894 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
895 N.getBaseType());
896
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000897 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
898 "invalid composite elements", &N, N.getRawElements());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000899 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000900 N.getRawVTableHolder());
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000901 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
902 &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000903 if (auto *Params = N.getRawTemplateParams())
904 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000905
906 if (N.getTag() == dwarf::DW_TAG_class_type ||
907 N.getTag() == dwarf::DW_TAG_union_type) {
908 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
909 "class/union requires a filename", &N, N.getFile());
910 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000911}
912
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000913void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000914 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000915 if (auto *Types = N.getRawTypeArray()) {
916 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
917 for (Metadata *Ty : N.getTypeArray()->operands()) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000918 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000919 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000920 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000921 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
922 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000923}
924
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000925void Verifier::visitDIFile(const DIFile &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000926 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000927}
928
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000929void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000930 Assert(N.isDistinct(), "compile units must be distinct", &N);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000931 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000932
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000933 // Don't bother verifying the compilation directory or producer string
934 // as those could be empty.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000935 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
936 N.getRawFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000937 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
938 N.getFile());
939
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000940 if (auto *Array = N.getRawEnumTypes()) {
941 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
942 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000943 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000944 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
945 "invalid enum type", &N, N.getEnumTypes(), Op);
946 }
947 }
948 if (auto *Array = N.getRawRetainedTypes()) {
949 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
950 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000951 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000952 }
953 }
954 if (auto *Array = N.getRawSubprograms()) {
955 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
956 for (Metadata *Op : N.getSubprograms()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000957 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000958 }
959 }
960 if (auto *Array = N.getRawGlobalVariables()) {
961 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
962 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000963 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000964 Op);
965 }
966 }
967 if (auto *Array = N.getRawImportedEntities()) {
968 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
969 for (Metadata *Op : N.getImportedEntities()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000970 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000971 Op);
972 }
973 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000974 if (auto *Array = N.getRawMacros()) {
975 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
976 for (Metadata *Op : N.getMacros()->operands()) {
977 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
978 }
979 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000980}
981
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000982void Verifier::visitDISubprogram(const DISubprogram &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000983 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000984 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000985 if (auto *T = N.getRawType())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000986 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000987 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000988 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000989 if (auto *Params = N.getRawTemplateParams())
990 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000991 if (auto *S = N.getRawDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000992 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000993 "invalid subprogram declaration", &N, S);
994 }
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000995 if (auto *RawVars = N.getRawVariables()) {
996 auto *Vars = dyn_cast<MDTuple>(RawVars);
997 Assert(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000998 for (Metadata *Op : Vars->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000999 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001000 Op);
1001 }
1002 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +00001003 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
1004 &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001005
Duncan P. N. Exon Smith814b8e92015-08-28 20:26:49 +00001006 if (N.isDefinition())
1007 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001008}
1009
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001010void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001011 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001012 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001013 "invalid local scope", &N, N.getRawScope());
1014}
1015
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001016void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1017 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001018
1019 Assert(N.getLine() || !N.getColumn(),
1020 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001021}
1022
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001023void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1024 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001025}
1026
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001027void Verifier::visitDINamespace(const DINamespace &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001028 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001029 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001030 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001031}
1032
Amjad Abouda9bcf162015-12-10 12:56:35 +00001033void Verifier::visitDIMacro(const DIMacro &N) {
1034 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1035 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1036 "invalid macinfo type", &N);
1037 Assert(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001038 if (!N.getValue().empty()) {
1039 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1040 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001041}
1042
1043void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1044 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1045 "invalid macinfo type", &N);
1046 if (auto *F = N.getRawFile())
1047 Assert(isa<DIFile>(F), "invalid file", &N, F);
1048
1049 if (auto *Array = N.getRawElements()) {
1050 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1051 for (Metadata *Op : N.getElements()->operands()) {
1052 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1053 }
1054 }
1055}
1056
Adrian Prantlab1243f2015-06-29 23:03:47 +00001057void Verifier::visitDIModule(const DIModule &N) {
1058 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1059 Assert(!N.getName().empty(), "anonymous module", &N);
1060}
1061
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001062void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001063 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001064}
1065
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001066void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1067 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001068
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001069 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1070 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001071}
1072
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001073void Verifier::visitDITemplateValueParameter(
1074 const DITemplateValueParameter &N) {
1075 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001076
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001077 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1078 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1079 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1080 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001081}
1082
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001083void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001084 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001085 Assert(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001086 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001087 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001088 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001089}
1090
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001091void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001092 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001093 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001094
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001095 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smith94d58f82015-03-31 01:28:22 +00001096 Assert(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001097 if (auto *V = N.getRawVariable()) {
1098 Assert(isa<ConstantAsMetadata>(V) &&
1099 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1100 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001101 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001102 }
1103 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001104 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001105 &N, Member);
1106 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001107}
1108
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001109void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001110 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001111 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001112
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +00001113 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001114 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001115 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001116}
1117
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001118void Verifier::visitDIExpression(const DIExpression &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001119 Assert(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001120}
1121
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001122void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001123 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001124 if (auto *T = N.getRawType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001125 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001126 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001127 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001128}
1129
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001130void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001131 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1132 N.getTag() == dwarf::DW_TAG_imported_declaration,
1133 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001134 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001135 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001136 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1137 N.getEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001138}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001139
David Majnemerdad0a642014-06-27 18:19:56 +00001140void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001141 // The Module is invalid if the GlobalValue has private linkage. Entities
1142 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001143 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001144 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1145 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001146}
1147
Chandler Carruth043949d2014-01-19 02:22:18 +00001148void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001149 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1150 if (!Idents)
1151 return;
1152
1153 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1154 // Scan each llvm.ident entry and make sure that this requirement is met.
1155 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001156 const MDNode *N = Idents->getOperand(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001157 Assert(N->getNumOperands() == 1,
1158 "incorrect number of operands in llvm.ident metadata", N);
1159 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1160 ("invalid value for llvm.ident metadata entry operand"
1161 "(the operand should be a string)"),
1162 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001163 }
1164}
1165
Chandler Carruth043949d2014-01-19 02:22:18 +00001166void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001167 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1168 if (!Flags) return;
1169
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001170 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001171 DenseMap<const MDString*, const MDNode*> SeenIDs;
1172 SmallVector<const MDNode*, 16> Requirements;
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001173 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001174 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001175 }
1176
1177 // Validate that the requirements in the module are valid.
1178 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001179 const MDNode *Requirement = Requirements[I];
1180 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001181 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001182
Chandler Carruth043949d2014-01-19 02:22:18 +00001183 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001184 if (!Op) {
1185 CheckFailed("invalid requirement on flag, flag is not present in module",
1186 Flag);
1187 continue;
1188 }
1189
1190 if (Op->getOperand(2) != ReqValue) {
1191 CheckFailed(("invalid requirement on flag, "
1192 "flag does not have the required value"),
1193 Flag);
1194 continue;
1195 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001196 }
1197}
1198
Chandler Carruth043949d2014-01-19 02:22:18 +00001199void
1200Verifier::visitModuleFlag(const MDNode *Op,
1201 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1202 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001203 // Each module flag should have three arguments, the merge behavior (a
1204 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001205 Assert(Op->getNumOperands() == 3,
1206 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001207 Module::ModFlagBehavior MFB;
1208 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001209 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001210 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001211 "invalid behavior operand in module flag (expected constant integer)",
1212 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001213 Assert(false,
1214 "invalid behavior operand in module flag (unexpected constant)",
1215 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001216 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001217 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001218 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1219 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001220
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001221 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001222 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001223 case Module::Error:
1224 case Module::Warning:
1225 case Module::Override:
1226 // These behavior types accept any value.
1227 break;
1228
1229 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001230 // The value should itself be an MDNode with two operands, a flag ID (an
1231 // MDString), and a value.
1232 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001233 Assert(Value && Value->getNumOperands() == 2,
1234 "invalid value for 'require' module flag (expected metadata pair)",
1235 Op->getOperand(2));
1236 Assert(isa<MDString>(Value->getOperand(0)),
1237 ("invalid value for 'require' module flag "
1238 "(first value operand should be a string)"),
1239 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001240
1241 // Append it to the list of requirements, to check once all module flags are
1242 // scanned.
1243 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001244 break;
1245 }
1246
1247 case Module::Append:
1248 case Module::AppendUnique: {
1249 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001250 Assert(isa<MDNode>(Op->getOperand(2)),
1251 "invalid value for 'append'-type module flag "
1252 "(expected a metadata node)",
1253 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001254 break;
1255 }
1256 }
1257
1258 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001259 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001260 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001261 Assert(Inserted,
1262 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001263 }
1264}
1265
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001266void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001267 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001268 unsigned Slot = ~0U;
1269 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1270 if (Attrs.getSlotIndex(I) == Idx) {
1271 Slot = I;
1272 break;
1273 }
1274
1275 assert(Slot != ~0U && "Attribute set inconsistency!");
1276
1277 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1278 I != E; ++I) {
1279 if (I->isStringAttribute())
1280 continue;
1281
1282 if (I->getKindAsEnum() == Attribute::NoReturn ||
1283 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001284 I->getKindAsEnum() == Attribute::NoInline ||
1285 I->getKindAsEnum() == Attribute::AlwaysInline ||
1286 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1287 I->getKindAsEnum() == Attribute::StackProtect ||
1288 I->getKindAsEnum() == Attribute::StackProtectReq ||
1289 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001290 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001291 I->getKindAsEnum() == Attribute::NoRedZone ||
1292 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1293 I->getKindAsEnum() == Attribute::Naked ||
1294 I->getKindAsEnum() == Attribute::InlineHint ||
1295 I->getKindAsEnum() == Attribute::StackAlignment ||
1296 I->getKindAsEnum() == Attribute::UWTable ||
1297 I->getKindAsEnum() == Attribute::NonLazyBind ||
1298 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1299 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1300 I->getKindAsEnum() == Attribute::SanitizeThread ||
1301 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1302 I->getKindAsEnum() == Attribute::MinSize ||
1303 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001304 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001305 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001306 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001307 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001308 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001309 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001310 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001311 I->getKindAsEnum() == Attribute::NoRecurse ||
1312 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1313 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001314 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001315 CheckFailed("Attribute '" + I->getAsString() +
1316 "' only applies to functions!", V);
1317 return;
1318 }
1319 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1320 I->getKindAsEnum() == Attribute::ReadNone) {
1321 if (Idx == 0) {
1322 CheckFailed("Attribute '" + I->getAsString() +
1323 "' does not apply to function returns");
1324 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001325 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001326 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001327 CheckFailed("Attribute '" + I->getAsString() +
1328 "' does not apply to functions!", V);
1329 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001330 }
1331 }
1332}
1333
Duncan Sandsc3a79922009-06-11 08:11:03 +00001334// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001335// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001336void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001337 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001338 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001339 return;
1340
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001341 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001342
Bill Wendling908126a2012-10-09 09:51:10 +00001343 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001344 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1345 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1346 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1347 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1348 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1349 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1350 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1351 "'returned' do not apply to return values!",
1352 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001353
Reid Klecknera534a382013-12-19 02:14:12 +00001354 // Check for mutually incompatible attributes. Only inreg is compatible with
1355 // sret.
1356 unsigned AttrCount = 0;
1357 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1358 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1359 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1360 Attrs.hasAttribute(Idx, Attribute::InReg);
1361 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001362 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1363 "and 'sret' are incompatible!",
1364 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001365
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001366 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1367 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1368 "Attributes "
1369 "'inalloca and readonly' are incompatible!",
1370 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001371
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001372 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1373 Attrs.hasAttribute(Idx, Attribute::Returned)),
1374 "Attributes "
1375 "'sret and returned' are incompatible!",
1376 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001377
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001378 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1379 Attrs.hasAttribute(Idx, Attribute::SExt)),
1380 "Attributes "
1381 "'zeroext and signext' are incompatible!",
1382 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001383
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001384 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1385 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1386 "Attributes "
1387 "'readnone and readonly' are incompatible!",
1388 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001389
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001390 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1391 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1392 "Attributes "
1393 "'noinline and alwaysinline' are incompatible!",
1394 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001395
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001396 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001397 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001398 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001399 AttributeSet::get(*Context, Idx,
1400 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001401 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001402
Reid Klecknera534a382013-12-19 02:14:12 +00001403 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001404 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001405 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001406 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1407 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1408 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1409 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001410 }
1411 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001412 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1413 "Attribute 'byval' only applies to parameters with pointer type!",
1414 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001415 }
Duncan Sands0009c442008-01-12 16:42:01 +00001416}
1417
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001418// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001419// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001420void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001421 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001422 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001423 return;
1424
Duncan Sands8c582282007-12-21 19:19:01 +00001425 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001426 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001427 bool SawSRet = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001428
Chris Lattner8a923e72008-03-12 17:45:29 +00001429 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001430 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001431
Chris Lattner229907c2011-07-18 04:54:35 +00001432 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001433 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001434 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001435 else if (Idx-1 < FT->getNumParams())
1436 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001437 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001438 break; // VarArgs attributes, verified elsewhere.
1439
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001440 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001441
Stephen Linb8bd2322013-04-20 05:14:40 +00001442 if (Idx == 0)
1443 continue;
1444
1445 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001446 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001447 SawNest = true;
1448 }
1449
Stephen Linb8bd2322013-04-20 05:14:40 +00001450 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001451 Assert(!SawReturned, "More than one parameter has attribute returned!",
1452 V);
1453 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1454 "Incompatible "
1455 "argument and return types for 'returned' attribute",
1456 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001457 SawReturned = true;
1458 }
1459
Reid Kleckner79418562014-05-09 22:32:13 +00001460 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001461 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1462 Assert(Idx == 1 || Idx == 2,
1463 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001464 SawSRet = true;
1465 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001466
1467 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001468 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1469 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001470 }
Duncan Sands8c582282007-12-21 19:19:01 +00001471 }
Devang Patel9cc98122008-10-01 23:41:25 +00001472
Bill Wendling77543892013-01-18 21:11:39 +00001473 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1474 return;
1475
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001476 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001477
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001478 Assert(
1479 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1480 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1481 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001482
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001483 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001484 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1485 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1486 Attribute::InaccessibleMemOrArgMemOnly)),
1487 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1488
1489 Assert(
1490 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1491 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1492 Attribute::InaccessibleMemOnly)),
1493 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1494
1495 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001496 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1497 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1498 Attribute::AlwaysInline)),
1499 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001500
1501 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1502 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001503 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1504 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001505
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001506 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1507 Attribute::OptimizeForSize),
1508 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001509
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001510 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1511 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001512 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001513
1514 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1515 Attribute::JumpTable)) {
1516 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001517 Assert(GV->hasUnnamedAddr(),
1518 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001519 }
Duncan Sands8c582282007-12-21 19:19:01 +00001520}
1521
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001522void Verifier::verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +00001523 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1524 if (MDs.empty())
1525 return;
1526
1527 for (unsigned i = 0; i < MDs.size(); i++) {
1528 if (MDs[i].first == LLVMContext::MD_prof) {
1529 MDNode *MD = MDs[i].second;
1530 Assert(MD->getNumOperands() == 2,
1531 "!prof annotations should have exactly 2 operands", MD);
1532
1533 // Check first operand.
1534 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1535 MD);
1536 Assert(isa<MDString>(MD->getOperand(0)),
1537 "expected string with name of the !prof annotation", MD);
1538 MDString *MDS = cast<MDString>(MD->getOperand(0));
1539 StringRef ProfName = MDS->getString();
1540 Assert(ProfName.equals("function_entry_count"),
1541 "first operand should be 'function_entry_count'", MD);
1542
1543 // Check second operand.
1544 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1545 MD);
1546 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1547 "expected integer argument to function_entry_count", MD);
1548 }
1549 }
1550}
1551
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001552void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1553 if (!ConstantExprVisited.insert(EntryC).second)
1554 return;
1555
1556 SmallVector<const Constant *, 16> Stack;
1557 Stack.push_back(EntryC);
1558
1559 while (!Stack.empty()) {
1560 const Constant *C = Stack.pop_back_val();
1561
1562 // Check this constant expression.
1563 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1564 visitConstantExpr(CE);
1565
Keno Fischerf6d17b92016-01-14 22:42:02 +00001566 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1567 // Global Values get visited separately, but we do need to make sure
1568 // that the global value is in the correct module
1569 Assert(GV->getParent() == M, "Referencing global in another module!",
1570 EntryC, M, GV, GV->getParent());
1571 continue;
1572 }
1573
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001574 // Visit all sub-expressions.
1575 for (const Use &U : C->operands()) {
1576 const auto *OpC = dyn_cast<Constant>(U);
1577 if (!OpC)
1578 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001579 if (!ConstantExprVisited.insert(OpC).second)
1580 continue;
1581 Stack.push_back(OpC);
1582 }
1583 }
1584}
1585
1586void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001587 if (CE->getOpcode() != Instruction::BitCast)
1588 return;
1589
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001590 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1591 CE->getType()),
1592 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001593}
1594
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001595bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001596 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001597 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001598
Devang Patel82fed672008-09-23 22:35:17 +00001599 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001600 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001601 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001602 || (LastIndex == AttributeSet::FunctionIndex
1603 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001604 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001605
Devang Patel82fed672008-09-23 22:35:17 +00001606 return false;
1607}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001608
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001609/// Verify that statepoint intrinsic is well formed.
1610void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001611 assert(CS.getCalledFunction() &&
1612 CS.getCalledFunction()->getIntrinsicID() ==
1613 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001614
Philip Reames0285c742015-02-03 23:18:47 +00001615 const Instruction &CI = *CS.getInstruction();
1616
Igor Laevsky39d662f2015-07-11 10:30:36 +00001617 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1618 !CS.onlyAccessesArgMemory(),
1619 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001620 "reordering restrictions required by safepoint semantics",
1621 &CI);
1622
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001623 const Value *IDV = CS.getArgument(0);
1624 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1625 &CI);
1626
1627 const Value *NumPatchBytesV = CS.getArgument(1);
1628 Assert(isa<ConstantInt>(NumPatchBytesV),
1629 "gc.statepoint number of patchable bytes must be a constant integer",
1630 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001631 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001632 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1633 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1634 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1635 "positive",
1636 &CI);
1637
1638 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001639 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001640 Assert(PT && PT->getElementType()->isFunctionTy(),
1641 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001642 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001643
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001644 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001645 Assert(isa<ConstantInt>(NumCallArgsV),
1646 "gc.statepoint number of arguments to underlying call "
1647 "must be constant integer",
1648 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001649 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001650 Assert(NumCallArgs >= 0,
1651 "gc.statepoint number of arguments to underlying call "
1652 "must be positive",
1653 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001654 const int NumParams = (int)TargetFuncType->getNumParams();
1655 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001656 Assert(NumCallArgs >= NumParams,
1657 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001658
1659 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001660 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1661 "gc.statepoint doesn't support wrapping non-void "
1662 "vararg functions yet",
1663 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001664 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001665 Assert(NumCallArgs == NumParams,
1666 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001667
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001668 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001669 Assert(isa<ConstantInt>(FlagsV),
1670 "gc.statepoint flags must be constant integer", &CI);
1671 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1672 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1673 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001674
1675 // Verify that the types of the call parameter arguments match
1676 // the type of the wrapped callee.
1677 for (int i = 0; i < NumParams; i++) {
1678 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001679 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001680 Assert(ArgType == ParamType,
1681 "gc.statepoint call argument does not match wrapped "
1682 "function type",
1683 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001684 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001685
1686 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001687
1688 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1689 Assert(isa<ConstantInt>(NumTransitionArgsV),
1690 "gc.statepoint number of transition arguments "
1691 "must be constant integer",
1692 &CI);
1693 const int NumTransitionArgs =
1694 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1695 Assert(NumTransitionArgs >= 0,
1696 "gc.statepoint number of transition arguments must be positive", &CI);
1697 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1698
1699 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001700 Assert(isa<ConstantInt>(NumDeoptArgsV),
1701 "gc.statepoint number of deoptimization arguments "
1702 "must be constant integer",
1703 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001704 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001705 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1706 "must be positive",
1707 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001708
Pat Gavlincc0431d2015-05-08 18:07:42 +00001709 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001710 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001711 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001712 "gc.statepoint too few arguments according to length fields", &CI);
1713
Philip Reames1ffa9372015-01-30 23:28:05 +00001714 // Check that the only uses of this gc.statepoint are gc.result or
1715 // gc.relocate calls which are tied to this statepoint and thus part
1716 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001717 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001718 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001719 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001720 if (!Call) continue;
Manuel Jacob83eefa62016-01-05 04:03:00 +00001721 Assert(isa<GCRelocateInst>(Call) || isGCResult(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001722 "gc.result or gc.relocate are the only value uses"
1723 "of a gc.statepoint",
1724 &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001725 if (isGCResult(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001726 Assert(Call->getArgOperand(0) == &CI,
1727 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001728 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001729 Assert(Call->getArgOperand(0) == &CI,
1730 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001731 }
1732 }
1733
1734 // Note: It is legal for a single derived pointer to be listed multiple
1735 // times. It's non-optimal, but it is legal. It can also happen after
1736 // insertion if we strip a bitcast away.
1737 // Note: It is really tempting to check that each base is relocated and
1738 // that a derived pointer is never reused as a base pointer. This turns
1739 // out to be problematic since optimizations run after safepoint insertion
1740 // can recognize equality properties that the insertion logic doesn't know
1741 // about. See example statepoint.ll in the verifier subdirectory
1742}
1743
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001744void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001745 for (auto &Counts : FrameEscapeInfo) {
1746 Function *F = Counts.first;
1747 unsigned EscapedObjectCount = Counts.second.first;
1748 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001749 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001750 "all indices passed to llvm.localrecover must be less than the "
1751 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001752 "function",
1753 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001754 }
1755}
1756
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001757static Instruction *getSuccPad(TerminatorInst *Terminator) {
1758 BasicBlock *UnwindDest;
1759 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1760 UnwindDest = II->getUnwindDest();
1761 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1762 UnwindDest = CSI->getUnwindDest();
1763 else
1764 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1765 return UnwindDest->getFirstNonPHI();
1766}
1767
1768void Verifier::verifySiblingFuncletUnwinds() {
1769 SmallPtrSet<Instruction *, 8> Visited;
1770 SmallPtrSet<Instruction *, 8> Active;
1771 for (const auto &Pair : SiblingFuncletInfo) {
1772 Instruction *PredPad = Pair.first;
1773 if (Visited.count(PredPad))
1774 continue;
1775 Active.insert(PredPad);
1776 TerminatorInst *Terminator = Pair.second;
1777 do {
1778 Instruction *SuccPad = getSuccPad(Terminator);
1779 if (Active.count(SuccPad)) {
1780 // Found a cycle; report error
1781 Instruction *CyclePad = SuccPad;
1782 SmallVector<Instruction *, 8> CycleNodes;
1783 do {
1784 CycleNodes.push_back(CyclePad);
1785 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1786 if (CycleTerminator != CyclePad)
1787 CycleNodes.push_back(CycleTerminator);
1788 CyclePad = getSuccPad(CycleTerminator);
1789 } while (CyclePad != SuccPad);
1790 Assert(false, "EH pads can't handle each other's exceptions",
1791 ArrayRef<Instruction *>(CycleNodes));
1792 }
1793 // Don't re-walk a node we've already checked
1794 if (!Visited.insert(SuccPad).second)
1795 break;
1796 // Walk to this successor if it has a map entry.
1797 PredPad = SuccPad;
1798 auto TermI = SiblingFuncletInfo.find(PredPad);
1799 if (TermI == SiblingFuncletInfo.end())
1800 break;
1801 Terminator = TermI->second;
1802 Active.insert(PredPad);
1803 } while (true);
1804 // Each node only has one successor, so we've walked all the active
1805 // nodes' successors.
1806 Active.clear();
1807 }
1808}
1809
Chris Lattner0e851da2002-04-18 20:37:37 +00001810// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001811//
Chandler Carruth043949d2014-01-19 02:22:18 +00001812void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001813 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001814 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001815 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001816
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001817 Assert(Context == &F.getContext(),
1818 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001819
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001820 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1821 Assert(FT->getNumParams() == NumArgs,
1822 "# formal arguments must match # of arguments for function type!", &F,
1823 FT);
1824 Assert(F.getReturnType()->isFirstClassType() ||
1825 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1826 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001827
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001828 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1829 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001830
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001831 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001832
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001833 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001834 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001835
Duncan Sands8c582282007-12-21 19:19:01 +00001836 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001837 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001838
Michael Gottesman41748d72013-06-27 00:25:01 +00001839 // On function declarations/definitions, we do not support the builtin
1840 // attribute. We do not check this in VerifyFunctionAttrs since that is
1841 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001842 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1843 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001844
Chris Lattneref13ee32006-05-19 21:25:17 +00001845 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001846 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1847 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001848 switch (F.getCallingConv()) {
1849 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001850 case CallingConv::C:
1851 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001852 case CallingConv::Fast:
1853 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001854 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001855 case CallingConv::PTX_Kernel:
1856 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001857 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1858 "perfect forwarding!",
1859 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001860 break;
1861 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001862
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001863 bool isLLVMdotName = F.getName().size() >= 5 &&
1864 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001865
Chris Lattneraf95e582002-04-13 22:48:46 +00001866 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001867 unsigned i = 0;
Chandler Carruth043949d2014-01-19 02:22:18 +00001868 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1869 ++I, ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001870 Assert(I->getType() == FT->getParamType(i),
1871 "Argument value does not match function argument type!", I,
1872 FT->getParamType(i));
1873 Assert(I->getType()->isFirstClassType(),
1874 "Function arguments must have first-class types!", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00001875 if (!isLLVMdotName) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001876 Assert(!I->getType()->isMetadataTy(),
1877 "Function takes metadata but isn't an intrinsic", I, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001878 Assert(!I->getType()->isTokenTy(),
1879 "Function takes token but isn't an intrinsic", I, &F);
1880 }
Dan Gohman4051bf42008-08-27 14:44:57 +00001881 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001882
David Majnemerb611e3f2015-08-14 05:09:07 +00001883 if (!isLLVMdotName)
1884 Assert(!F.getReturnType()->isTokenTy(),
1885 "Functions returns a token but isn't an intrinsic", &F);
1886
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001887 // Get the function metadata attachments.
1888 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1889 F.getAllMetadata(MDs);
1890 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001891 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001892
Keno Fischer2ac0c272015-11-16 05:13:30 +00001893 // Check validity of the personality function
1894 if (F.hasPersonalityFn()) {
1895 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1896 if (Per)
1897 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001898 "Referencing personality function in another module!",
1899 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001900 }
1901
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001902 if (F.isMaterializable()) {
1903 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001904 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1905 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001906 } else if (F.isDeclaration()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001907 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1908 "invalid linkage type for function declaration", &F);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001909 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1910 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001911 Assert(!F.hasPersonalityFn(),
1912 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001913 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001914 // Verify that this function (which has a body) is not named "llvm.*". It
1915 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001916 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001917
Chris Lattner149376d2002-10-13 20:57:00 +00001918 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001919 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001920 Assert(pred_empty(Entry),
1921 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001922
Chris Lattner27471742009-11-01 04:08:01 +00001923 // The address of the entry block cannot be taken, unless it is dead.
1924 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001925 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1926 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001927 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001928
1929 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001930 for (const auto &I : MDs) {
1931 // Verify that the attachment is legal.
1932 switch (I.first) {
1933 default:
1934 break;
1935 case LLVMContext::MD_dbg:
1936 Assert(isa<DISubprogram>(I.second),
1937 "function !dbg attachment must be a subprogram", &F, I.second);
1938 break;
1939 }
1940
1941 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001942 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001943 }
Chris Lattner149376d2002-10-13 20:57:00 +00001944 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001945
Chris Lattner7730dcc2009-09-11 17:05:29 +00001946 // If this function is actually an intrinsic, verify that it is only used in
1947 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00001948 // Only do this if the module is materialized, otherwise we don't have all the
1949 // uses.
1950 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001951 const User *U;
1952 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001953 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00001954 }
Nico Rieck7157bb72014-01-14 15:22:47 +00001955
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001956 Assert(!F.hasDLLImportStorageClass() ||
1957 (F.isDeclaration() && F.hasExternalLinkage()) ||
1958 F.hasAvailableExternallyLinkage(),
1959 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00001960
1961 auto *N = F.getSubprogram();
1962 if (!N)
1963 return;
1964
1965 // Check that all !dbg attachments lead to back to N (or, at least, another
1966 // subprogram that describes the same function).
1967 //
1968 // FIXME: Check this incrementally while visiting !dbg attachments.
1969 // FIXME: Only check when N is the canonical subprogram for F.
1970 SmallPtrSet<const MDNode *, 32> Seen;
1971 for (auto &BB : F)
1972 for (auto &I : BB) {
1973 // Be careful about using DILocation here since we might be dealing with
1974 // broken code (this is the Verifier after all).
1975 DILocation *DL =
1976 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1977 if (!DL)
1978 continue;
1979 if (!Seen.insert(DL).second)
1980 continue;
1981
1982 DILocalScope *Scope = DL->getInlinedAtScope();
1983 if (Scope && !Seen.insert(Scope).second)
1984 continue;
1985
1986 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00001987
1988 // Scope and SP could be the same MDNode and we don't want to skip
1989 // validation in that case
1990 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00001991 continue;
1992
1993 // FIXME: Once N is canonical, check "SP == &N".
1994 Assert(SP->describes(&F),
1995 "!dbg attachment points at wrong subprogram for function", N, &F,
1996 &I, DL, Scope, SP);
1997 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001998}
1999
Chris Lattner0e851da2002-04-18 20:37:37 +00002000// verifyBasicBlock - Verify that a basic block is well formed...
2001//
Chris Lattner069a7952002-06-25 15:56:27 +00002002void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002003 InstsInThisBlock.clear();
2004
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002005 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002006 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002007
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002008 // Check constraints that this basic block imposes on all of the PHI nodes in
2009 // it.
2010 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002011 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2012 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002013 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002014 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002015 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002016 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002017 Assert(PN->getNumIncomingValues() != 0,
2018 "PHI nodes must have at least one entry. If the block is dead, "
2019 "the PHI should be removed!",
2020 PN);
2021 Assert(PN->getNumIncomingValues() == Preds.size(),
2022 "PHINode should have one entry for each predecessor of its "
2023 "parent basic block!",
2024 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002025
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002026 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002027 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002028 Values.reserve(PN->getNumIncomingValues());
2029 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2030 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2031 PN->getIncomingValue(i)));
2032 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002033
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002034 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2035 // Check to make sure that if there is more than one entry for a
2036 // particular basic block in this PHI node, that the incoming values are
2037 // all identical.
2038 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002039 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2040 Values[i].second == Values[i - 1].second,
2041 "PHI node has multiple entries for the same basic block with "
2042 "different incoming values!",
2043 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002044
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002045 // Check to make sure that the predecessors and PHI node entries are
2046 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002047 Assert(Values[i].first == Preds[i],
2048 "PHI node entries do not match predecessors!", PN,
2049 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002050 }
2051 }
2052 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002053
2054 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002055 for (auto &I : BB)
2056 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002057 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002058 }
Chris Lattner069a7952002-06-25 15:56:27 +00002059}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002060
Chris Lattner069a7952002-06-25 15:56:27 +00002061void Verifier::visitTerminatorInst(TerminatorInst &I) {
2062 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002063 Assert(&I == I.getParent()->getTerminator(),
2064 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002065 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002066}
2067
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002068void Verifier::visitBranchInst(BranchInst &BI) {
2069 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002070 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2071 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002072 }
2073 visitTerminatorInst(BI);
2074}
2075
Chris Lattner069a7952002-06-25 15:56:27 +00002076void Verifier::visitReturnInst(ReturnInst &RI) {
2077 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002078 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002079 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002080 Assert(N == 0,
2081 "Found return instr that returns non-void in Function of void "
2082 "return type!",
2083 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002084 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002085 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2086 "Function return type does not match operand "
2087 "type of return inst!",
2088 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002089
Misha Brukman7eb05a12003-08-18 14:43:39 +00002090 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002091 // terminators...
2092 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002093}
2094
Chris Lattnerab5aa142004-05-21 16:47:21 +00002095void Verifier::visitSwitchInst(SwitchInst &SI) {
2096 // Check to make sure that all of the constants in the switch instruction
2097 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002098 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002099 SmallPtrSet<ConstantInt*, 32> Constants;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00002100 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002101 Assert(i.getCaseValue()->getType() == SwitchTy,
2102 "Switch constants must all be same type as switch value!", &SI);
2103 Assert(Constants.insert(i.getCaseValue()).second,
2104 "Duplicate integer as switch case", &SI, i.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002105 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002106
Chris Lattnerab5aa142004-05-21 16:47:21 +00002107 visitTerminatorInst(SI);
2108}
2109
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002110void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002111 Assert(BI.getAddress()->getType()->isPointerTy(),
2112 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002113 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002114 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2115 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002116
2117 visitTerminatorInst(BI);
2118}
2119
Chris Lattner75648e72004-03-12 05:54:31 +00002120void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002121 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2122 SI.getOperand(2)),
2123 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002124
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002125 Assert(SI.getTrueValue()->getType() == SI.getType(),
2126 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002127 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002128}
2129
Misha Brukmanc566ca362004-03-02 00:22:19 +00002130/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2131/// a pass, if any exist, it's an error.
2132///
Chris Lattner903a25d2002-11-21 16:54:22 +00002133void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002134 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002135}
Chris Lattner0e851da2002-04-18 20:37:37 +00002136
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002137void Verifier::visitTruncInst(TruncInst &I) {
2138 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002139 Type *SrcTy = I.getOperand(0)->getType();
2140 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002141
2142 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002143 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2144 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002145
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002146 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2147 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2148 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2149 "trunc source and destination must both be a vector or neither", &I);
2150 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002151
2152 visitInstruction(I);
2153}
2154
2155void Verifier::visitZExtInst(ZExtInst &I) {
2156 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002157 Type *SrcTy = I.getOperand(0)->getType();
2158 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002159
2160 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002161 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2162 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2163 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2164 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002165 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2166 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002167
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002168 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002169
2170 visitInstruction(I);
2171}
2172
2173void Verifier::visitSExtInst(SExtInst &I) {
2174 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002175 Type *SrcTy = I.getOperand(0)->getType();
2176 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002177
2178 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002179 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2180 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002181
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002182 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2183 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2184 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2185 "sext source and destination must both be a vector or neither", &I);
2186 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002187
2188 visitInstruction(I);
2189}
2190
2191void Verifier::visitFPTruncInst(FPTruncInst &I) {
2192 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002193 Type *SrcTy = I.getOperand(0)->getType();
2194 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002195 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002196 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2197 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002198
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002199 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2200 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2201 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2202 "fptrunc source and destination must both be a vector or neither", &I);
2203 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002204
2205 visitInstruction(I);
2206}
2207
2208void Verifier::visitFPExtInst(FPExtInst &I) {
2209 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002210 Type *SrcTy = I.getOperand(0)->getType();
2211 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002212
2213 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002214 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2215 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002216
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002217 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2218 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2219 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2220 "fpext source and destination must both be a vector or neither", &I);
2221 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002222
2223 visitInstruction(I);
2224}
2225
2226void Verifier::visitUIToFPInst(UIToFPInst &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 "UIToFP source and dest must both be vector or scalar", &I);
2236 Assert(SrcTy->isIntOrIntVectorTy(),
2237 "UIToFP source must be integer or integer vector", &I);
2238 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2239 &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 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002245
2246 visitInstruction(I);
2247}
2248
2249void Verifier::visitSIToFPInst(SIToFPInst &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 "SIToFP source and dest must both be vector or scalar", &I);
2259 Assert(SrcTy->isIntOrIntVectorTy(),
2260 "SIToFP source must be integer or integer vector", &I);
2261 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2262 &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 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002268
2269 visitInstruction(I);
2270}
2271
2272void Verifier::visitFPToUIInst(FPToUIInst &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
Duncan Sands19d0b472010-02-16 11:11:14 +00002277 bool SrcVec = SrcTy->isVectorTy();
2278 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002279
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002280 Assert(SrcVec == DstVec,
2281 "FPToUI source and dest must both be vector or scalar", &I);
2282 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2283 &I);
2284 Assert(DestTy->isIntOrIntVectorTy(),
2285 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002286
2287 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002288 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2289 cast<VectorType>(DestTy)->getNumElements(),
2290 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002291
2292 visitInstruction(I);
2293}
2294
2295void Verifier::visitFPToSIInst(FPToSIInst &I) {
2296 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002297 Type *SrcTy = I.getOperand(0)->getType();
2298 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002299
Duncan Sands19d0b472010-02-16 11:11:14 +00002300 bool SrcVec = SrcTy->isVectorTy();
2301 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002302
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002303 Assert(SrcVec == DstVec,
2304 "FPToSI source and dest must both be vector or scalar", &I);
2305 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2306 &I);
2307 Assert(DestTy->isIntOrIntVectorTy(),
2308 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002309
2310 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002311 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2312 cast<VectorType>(DestTy)->getNumElements(),
2313 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002314
2315 visitInstruction(I);
2316}
2317
2318void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2319 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002320 Type *SrcTy = I.getOperand(0)->getType();
2321 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002322
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002323 Assert(SrcTy->getScalarType()->isPointerTy(),
2324 "PtrToInt source must be pointer", &I);
2325 Assert(DestTy->getScalarType()->isIntegerTy(),
2326 "PtrToInt result must be integral", &I);
2327 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2328 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002329
2330 if (SrcTy->isVectorTy()) {
2331 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2332 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002333 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2334 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002335 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002336
2337 visitInstruction(I);
2338}
2339
2340void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2341 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002342 Type *SrcTy = I.getOperand(0)->getType();
2343 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002344
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002345 Assert(SrcTy->getScalarType()->isIntegerTy(),
2346 "IntToPtr source must be an integral", &I);
2347 Assert(DestTy->getScalarType()->isPointerTy(),
2348 "IntToPtr result must be a pointer", &I);
2349 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2350 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002351 if (SrcTy->isVectorTy()) {
2352 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2353 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002354 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2355 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002356 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002357 visitInstruction(I);
2358}
2359
2360void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002361 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002362 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2363 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002364 visitInstruction(I);
2365}
2366
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002367void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2368 Type *SrcTy = I.getOperand(0)->getType();
2369 Type *DestTy = I.getType();
2370
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002371 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2372 &I);
2373 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2374 &I);
2375 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2376 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002377 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002378 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2379 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002380 visitInstruction(I);
2381}
2382
Misha Brukmanc566ca362004-03-02 00:22:19 +00002383/// visitPHINode - Ensure that a PHI node is well formed.
2384///
Chris Lattner069a7952002-06-25 15:56:27 +00002385void Verifier::visitPHINode(PHINode &PN) {
2386 // Ensure that the PHI nodes are all grouped together at the top of the block.
2387 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002388 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002389 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002390 Assert(&PN == &PN.getParent()->front() ||
2391 isa<PHINode>(--BasicBlock::iterator(&PN)),
2392 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002393
David Majnemerb611e3f2015-08-14 05:09:07 +00002394 // Check that a PHI doesn't yield a Token.
2395 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2396
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002397 // Check that all of the values of the PHI node have the same type as the
2398 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002399 for (Value *IncValue : PN.incoming_values()) {
2400 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002401 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002402 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002403
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002404 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002405
2406 visitInstruction(PN);
2407}
2408
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002409void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002410 Instruction *I = CS.getInstruction();
2411
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002412 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2413 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002414 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002415
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002416 Assert(FPTy->getElementType()->isFunctionTy(),
2417 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002418
2419 Assert(FPTy->getElementType() == CS.getFunctionType(),
2420 "Called function is not the same type as the call!", I);
2421
2422 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002423
2424 // Verify that the correct number of arguments are being passed
2425 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002426 Assert(CS.arg_size() >= FTy->getNumParams(),
2427 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002428 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002429 Assert(CS.arg_size() == FTy->getNumParams(),
2430 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002431
Chris Lattner609de002010-05-10 20:58:42 +00002432 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002433 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002434 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2435 "Call parameter type does not match function signature!",
2436 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002437
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002438 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002439
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002440 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002441 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002442
Duncan Sands8c582282007-12-21 19:19:01 +00002443 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002444 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002445
David Majnemer91db08b2014-04-30 17:22:00 +00002446 // Conservatively check the inalloca argument.
2447 // We have a bug if we can find that there is an underlying alloca without
2448 // inalloca.
2449 if (CS.hasInAllocaArgument()) {
2450 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2451 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002452 Assert(AI->isUsedWithInAlloca(),
2453 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002454 }
2455
Stephen Linb8bd2322013-04-20 05:14:40 +00002456 if (FTy->isVarArg()) {
2457 // FIXME? is 'nest' even legal here?
2458 bool SawNest = false;
2459 bool SawReturned = false;
2460
2461 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2462 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2463 SawNest = true;
2464 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2465 SawReturned = true;
2466 }
2467
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002468 // Check attributes on the varargs part.
2469 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002470 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002471 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002472
Stephen Linb8bd2322013-04-20 05:14:40 +00002473 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002474 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002475 SawNest = true;
2476 }
2477
2478 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002479 Assert(!SawReturned, "More than one parameter has attribute returned!",
2480 I);
2481 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2482 "Incompatible argument and return types for 'returned' "
2483 "attribute",
2484 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002485 SawReturned = true;
2486 }
Duncan Sands0009c442008-01-12 16:42:01 +00002487
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002488 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2489 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002490
2491 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002492 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002493 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002494 }
Duncan Sands8c582282007-12-21 19:19:01 +00002495
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002496 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002497 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002498 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002499 for (Type *ParamTy : FTy->params()) {
2500 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002501 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002502 Assert(!ParamTy->isTokenTy(),
2503 "Function has token parameter but isn't an intrinsic", I);
2504 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002505 }
2506
David Majnemerb611e3f2015-08-14 05:09:07 +00002507 // Verify that indirect calls don't return tokens.
2508 if (CS.getCalledFunction() == nullptr)
2509 Assert(!FTy->getReturnType()->isTokenTy(),
2510 "Return type cannot be token for indirect call!");
2511
Philip Reamesa3c6f002015-06-26 21:39:44 +00002512 if (Function *F = CS.getCalledFunction())
2513 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002514 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002515
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002516 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2517 // at most one "gc-transition" operand bundle.
2518 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2519 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002520 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002521 OperandBundleUse BU = CS.getOperandBundleAt(i);
2522 uint32_t Tag = BU.getTagID();
2523 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002524 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2525 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002526 } else if (Tag == LLVMContext::OB_gc_transition) {
2527 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2528 I);
2529 FoundGCTransitionBundle = true;
2530 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002531 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2532 FoundFuncletBundle = true;
2533 Assert(BU.Inputs.size() == 1,
2534 "Expected exactly one funclet bundle operand", I);
2535 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2536 "Funclet bundle operands should correspond to a FuncletPadInst",
2537 I);
2538 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002539 }
2540
Duncan Sands8c582282007-12-21 19:19:01 +00002541 visitInstruction(*I);
2542}
2543
Reid Kleckner5772b772014-04-24 20:14:34 +00002544/// Two types are "congruent" if they are identical, or if they are both pointer
2545/// types with different pointee types and the same address space.
2546static bool isTypeCongruent(Type *L, Type *R) {
2547 if (L == R)
2548 return true;
2549 PointerType *PL = dyn_cast<PointerType>(L);
2550 PointerType *PR = dyn_cast<PointerType>(R);
2551 if (!PL || !PR)
2552 return false;
2553 return PL->getAddressSpace() == PR->getAddressSpace();
2554}
2555
Reid Klecknerd20c9702014-05-15 23:58:57 +00002556static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2557 static const Attribute::AttrKind ABIAttrs[] = {
2558 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2559 Attribute::InReg, Attribute::Returned};
2560 AttrBuilder Copy;
2561 for (auto AK : ABIAttrs) {
2562 if (Attrs.hasAttribute(I + 1, AK))
2563 Copy.addAttribute(AK);
2564 }
2565 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2566 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2567 return Copy;
2568}
2569
Reid Kleckner5772b772014-04-24 20:14:34 +00002570void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002571 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002572
2573 // - The caller and callee prototypes must match. Pointer types of
2574 // parameters or return types may differ in pointee type, but not
2575 // address space.
2576 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002577 FunctionType *CallerTy = F->getFunctionType();
2578 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002579 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2580 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2581 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2582 "cannot guarantee tail call due to mismatched varargs", &CI);
2583 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2584 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002585 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002586 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002587 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2588 "cannot guarantee tail call due to mismatched parameter types", &CI);
2589 }
2590
2591 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002592 Assert(F->getCallingConv() == CI.getCallingConv(),
2593 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002594
2595 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2596 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002597 AttributeSet CallerAttrs = F->getAttributes();
2598 AttributeSet CalleeAttrs = CI.getAttributes();
2599 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002600 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2601 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002602 Assert(CallerABIAttrs == CalleeABIAttrs,
2603 "cannot guarantee tail call due to mismatched ABI impacting "
2604 "function attributes",
2605 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002606 }
2607
2608 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2609 // or a pointer bitcast followed by a ret instruction.
2610 // - The ret instruction must return the (possibly bitcasted) value
2611 // produced by the call or void.
2612 Value *RetVal = &CI;
2613 Instruction *Next = CI.getNextNode();
2614
2615 // Handle the optional bitcast.
2616 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002617 Assert(BI->getOperand(0) == RetVal,
2618 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002619 RetVal = BI;
2620 Next = BI->getNextNode();
2621 }
2622
2623 // Check the return.
2624 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002625 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2626 &CI);
2627 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2628 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002629}
2630
Duncan Sands8c582282007-12-21 19:19:01 +00002631void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002632 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002633
Reid Kleckner5772b772014-04-24 20:14:34 +00002634 if (CI.isMustTailCall())
2635 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002636}
2637
2638void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002639 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002640
David Majnemer654e1302015-07-31 17:58:14 +00002641 // Verify that the first non-PHI instruction of the unwind destination is an
2642 // exception handling instruction.
2643 Assert(
2644 II.getUnwindDest()->isEHPad(),
2645 "The unwind destination does not have an exception handling instruction!",
2646 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002647
Dan Gohman9c6e1882010-08-02 23:09:14 +00002648 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002649}
Chris Lattner0e851da2002-04-18 20:37:37 +00002650
Misha Brukmanc566ca362004-03-02 00:22:19 +00002651/// visitBinaryOperator - Check that both arguments to the binary operator are
2652/// of the same type!
2653///
Chris Lattner069a7952002-06-25 15:56:27 +00002654void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002655 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2656 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002657
Reid Spencer2341c222007-02-02 02:16:23 +00002658 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002659 // Check that integer arithmetic operators are only used with
2660 // integral operands.
2661 case Instruction::Add:
2662 case Instruction::Sub:
2663 case Instruction::Mul:
2664 case Instruction::SDiv:
2665 case Instruction::UDiv:
2666 case Instruction::SRem:
2667 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002668 Assert(B.getType()->isIntOrIntVectorTy(),
2669 "Integer arithmetic operators only work with integral types!", &B);
2670 Assert(B.getType() == B.getOperand(0)->getType(),
2671 "Integer arithmetic operators must have same type "
2672 "for operands and result!",
2673 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002674 break;
2675 // Check that floating-point arithmetic operators are only used with
2676 // floating-point operands.
2677 case Instruction::FAdd:
2678 case Instruction::FSub:
2679 case Instruction::FMul:
2680 case Instruction::FDiv:
2681 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002682 Assert(B.getType()->isFPOrFPVectorTy(),
2683 "Floating-point arithmetic operators only work with "
2684 "floating-point types!",
2685 &B);
2686 Assert(B.getType() == B.getOperand(0)->getType(),
2687 "Floating-point arithmetic operators must have same type "
2688 "for operands and result!",
2689 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002690 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002691 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002692 case Instruction::And:
2693 case Instruction::Or:
2694 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002695 Assert(B.getType()->isIntOrIntVectorTy(),
2696 "Logical operators only work with integral types!", &B);
2697 Assert(B.getType() == B.getOperand(0)->getType(),
2698 "Logical operators must have same type for operands and result!",
2699 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002700 break;
2701 case Instruction::Shl:
2702 case Instruction::LShr:
2703 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002704 Assert(B.getType()->isIntOrIntVectorTy(),
2705 "Shifts only work with integral types!", &B);
2706 Assert(B.getType() == B.getOperand(0)->getType(),
2707 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002708 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002709 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002710 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002711 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002712
Chris Lattner0e851da2002-04-18 20:37:37 +00002713 visitInstruction(B);
2714}
2715
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002716void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002717 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002718 Type *Op0Ty = IC.getOperand(0)->getType();
2719 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002720 Assert(Op0Ty == Op1Ty,
2721 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002722 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002723 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2724 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002725 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002726 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2727 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2728 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002729
Reid Spencerd9436b62006-11-20 01:22:35 +00002730 visitInstruction(IC);
2731}
2732
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002733void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002734 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002735 Type *Op0Ty = FC.getOperand(0)->getType();
2736 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002737 Assert(Op0Ty == Op1Ty,
2738 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002739 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002740 Assert(Op0Ty->isFPOrFPVectorTy(),
2741 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002742 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002743 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2744 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2745 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002746
Reid Spencerd9436b62006-11-20 01:22:35 +00002747 visitInstruction(FC);
2748}
2749
Robert Bocchino23004482006-01-10 19:05:34 +00002750void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002751 Assert(
2752 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2753 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002754 visitInstruction(EI);
2755}
2756
Robert Bocchinoca27f032006-01-17 20:07:22 +00002757void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002758 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2759 IE.getOperand(2)),
2760 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002761 visitInstruction(IE);
2762}
2763
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002764void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002765 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2766 SV.getOperand(2)),
2767 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002768 visitInstruction(SV);
2769}
2770
Chris Lattner069a7952002-06-25 15:56:27 +00002771void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002772 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002773
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002774 Assert(isa<PointerType>(TargetTy),
2775 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002776 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002777 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002778 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002779 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002780 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002781
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002782 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002783 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002784 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002785
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002786 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002787 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002788 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2789 if (GEP.getPointerOperandType()->isVectorTy())
2790 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2791 "Vector GEP result width doesn't match operand's", &GEP);
Duncan Sandse6beec62012-11-13 12:59:33 +00002792 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2793 Type *IndexTy = Idxs[i]->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002794 if (IndexTy->isVectorTy()) {
2795 unsigned IndexWidth = IndexTy->getVectorNumElements();
2796 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2797 }
2798 Assert(IndexTy->getScalarType()->isIntegerTy(),
2799 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002800 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002801 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002802 visitInstruction(GEP);
2803}
2804
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002805static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2806 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2807}
2808
Philip Reamesbf9676f2014-10-20 23:52:07 +00002809void Verifier::visitRangeMetadata(Instruction& I,
2810 MDNode* Range, Type* Ty) {
2811 assert(Range &&
2812 Range == I.getMetadata(LLVMContext::MD_range) &&
2813 "precondition violation");
2814
2815 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002816 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002817 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002818 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2819
Philip Reamesbf9676f2014-10-20 23:52:07 +00002820 ConstantRange LastRange(1); // Dummy initial value
2821 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002822 ConstantInt *Low =
2823 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002824 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002825 ConstantInt *High =
2826 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002827 Assert(High, "The upper limit must be an integer!", High);
2828 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2829 "Range types must match instruction type!", &I);
2830
Philip Reamesbf9676f2014-10-20 23:52:07 +00002831 APInt HighV = High->getValue();
2832 APInt LowV = Low->getValue();
2833 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002834 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2835 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002836 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002837 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2838 "Intervals are overlapping", Range);
2839 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2840 Range);
2841 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2842 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002843 }
2844 LastRange = ConstantRange(LowV, HighV);
2845 }
2846 if (NumRanges > 2) {
2847 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002848 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002849 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002850 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002851 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002852 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2853 "Intervals are overlapping", Range);
2854 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2855 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002856 }
2857}
2858
JF Bastiend1fb5852015-12-17 22:09:19 +00002859void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2860 const Instruction *I) {
2861 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2862 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2863 Assert(!(Size & (Size - 1)),
2864 "atomic memory access' operand must have a power-of-two size", Ty, I);
2865}
2866
Chris Lattner069a7952002-06-25 15:56:27 +00002867void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002868 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002869 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002870 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002871 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2872 "huge alignment values are unsupported", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002873 if (LI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002874 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2875 "Load cannot have Release ordering", &LI);
2876 Assert(LI.getAlignment() != 0,
2877 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002878 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2879 ElTy->isFloatingPointTy(),
2880 "atomic load operand must have integer, pointer, or floating point "
2881 "type!",
2882 ElTy, &LI);
2883 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002884 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002885 Assert(LI.getSynchScope() == CrossThread,
2886 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002887 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002888
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002889 visitInstruction(LI);
2890}
2891
Chris Lattner069a7952002-06-25 15:56:27 +00002892void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002893 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002894 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002895 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002896 Assert(ElTy == SI.getOperand(0)->getType(),
2897 "Stored value type does not match pointer operand type!", &SI, ElTy);
2898 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2899 "huge alignment values are unsupported", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002900 if (SI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002901 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2902 "Store cannot have Acquire ordering", &SI);
2903 Assert(SI.getAlignment() != 0,
2904 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002905 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2906 ElTy->isFloatingPointTy(),
2907 "atomic store operand must have integer, pointer, or floating point "
2908 "type!",
2909 ElTy, &SI);
2910 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002911 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002912 Assert(SI.getSynchScope() == CrossThread,
2913 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002914 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002915 visitInstruction(SI);
2916}
2917
Victor Hernandez8acf2952009-10-23 21:09:37 +00002918void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00002919 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00002920 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002921 Assert(PTy->getAddressSpace() == 0,
2922 "Allocation instruction pointer not in the generic address space!",
2923 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00002924 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002925 "Cannot allocate unsized type", &AI);
2926 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2927 "Alloca array size must have integer type", &AI);
2928 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2929 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00002930
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00002931 visitInstruction(AI);
2932}
2933
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002934void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00002935
2936 // FIXME: more conditions???
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002937 Assert(CXI.getSuccessOrdering() != NotAtomic,
2938 "cmpxchg instructions must be atomic.", &CXI);
2939 Assert(CXI.getFailureOrdering() != NotAtomic,
2940 "cmpxchg instructions must be atomic.", &CXI);
2941 Assert(CXI.getSuccessOrdering() != Unordered,
2942 "cmpxchg instructions cannot be unordered.", &CXI);
2943 Assert(CXI.getFailureOrdering() != Unordered,
2944 "cmpxchg instructions cannot be unordered.", &CXI);
2945 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2946 "cmpxchg instructions be at least as constrained on success as fail",
2947 &CXI);
2948 Assert(CXI.getFailureOrdering() != Release &&
2949 CXI.getFailureOrdering() != AcquireRelease,
2950 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00002951
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002952 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002953 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002954 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002955 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2956 ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002957 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002958 Assert(ElTy == CXI.getOperand(1)->getType(),
2959 "Expected value type does not match pointer operand type!", &CXI,
2960 ElTy);
2961 Assert(ElTy == CXI.getOperand(2)->getType(),
2962 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002963 visitInstruction(CXI);
2964}
2965
2966void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002967 Assert(RMWI.getOrdering() != NotAtomic,
2968 "atomicrmw instructions must be atomic.", &RMWI);
2969 Assert(RMWI.getOrdering() != Unordered,
2970 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002971 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002972 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002973 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002974 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2975 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002976 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002977 Assert(ElTy == RMWI.getOperand(1)->getType(),
2978 "Argument value type does not match pointer operand type!", &RMWI,
2979 ElTy);
2980 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2981 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2982 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002983 visitInstruction(RMWI);
2984}
2985
Eli Friedmanfee02c62011-07-25 23:16:38 +00002986void Verifier::visitFenceInst(FenceInst &FI) {
2987 const AtomicOrdering Ordering = FI.getOrdering();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002988 Assert(Ordering == Acquire || Ordering == Release ||
2989 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2990 "fence instructions may only have "
2991 "acquire, release, acq_rel, or seq_cst ordering.",
2992 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00002993 visitInstruction(FI);
2994}
2995
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002996void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002997 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2998 EVI.getIndices()) == EVI.getType(),
2999 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003000
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003001 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003002}
3003
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003004void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003005 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3006 IVI.getIndices()) ==
3007 IVI.getOperand(1)->getType(),
3008 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003009
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003010 visitInstruction(IVI);
3011}
Chris Lattner0e851da2002-04-18 20:37:37 +00003012
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003013static Value *getParentPad(Value *EHPad) {
3014 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3015 return FPI->getParentPad();
3016
3017 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3018}
3019
David Majnemer85a549d2015-08-11 02:48:30 +00003020void Verifier::visitEHPadPredecessors(Instruction &I) {
3021 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003022
David Majnemer85a549d2015-08-11 02:48:30 +00003023 BasicBlock *BB = I.getParent();
3024 Function *F = BB->getParent();
3025
3026 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3027
3028 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3029 // The landingpad instruction defines its parent as a landing pad block. The
3030 // landing pad block may be branched to only by the unwind edge of an
3031 // invoke.
3032 for (BasicBlock *PredBB : predecessors(BB)) {
3033 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3034 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3035 "Block containing LandingPadInst must be jumped to "
3036 "only by the unwind edge of an invoke.",
3037 LPI);
3038 }
3039 return;
3040 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003041 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3042 if (!pred_empty(BB))
3043 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3044 "Block containg CatchPadInst must be jumped to "
3045 "only by its catchswitch.",
3046 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003047 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3048 "Catchswitch cannot unwind to one of its catchpads",
3049 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003050 return;
3051 }
David Majnemer85a549d2015-08-11 02:48:30 +00003052
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003053 // Verify that each pred has a legal terminator with a legal to/from EH
3054 // pad relationship.
3055 Instruction *ToPad = &I;
3056 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003057 for (BasicBlock *PredBB : predecessors(BB)) {
3058 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003059 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003060 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003061 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003062 "EH pad must be jumped to via an unwind edge", ToPad, II);
3063 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3064 FromPad = Bundle->Inputs[0];
3065 else
3066 FromPad = ConstantTokenNone::get(II->getContext());
3067 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
3068 FromPad = CRI->getCleanupPad();
3069 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3070 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3071 FromPad = CSI;
3072 } else {
3073 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3074 }
3075
3076 // The edge may exit from zero or more nested pads.
3077 for (;; FromPad = getParentPad(FromPad)) {
3078 Assert(FromPad != ToPad,
3079 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3080 if (FromPad == ToPadParent) {
3081 // This is a legal unwind edge.
3082 break;
3083 }
3084 Assert(!isa<ConstantTokenNone>(FromPad),
3085 "A single unwind edge may only enter one EH pad", TI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003086 }
David Majnemer85a549d2015-08-11 02:48:30 +00003087 }
3088}
3089
3090void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003091 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3092 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003093 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3094 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003095
David Majnemer85a549d2015-08-11 02:48:30 +00003096 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003097
David Majnemer654e1302015-07-31 17:58:14 +00003098 if (!LandingPadResultTy)
3099 LandingPadResultTy = LPI.getType();
3100 else
3101 Assert(LandingPadResultTy == LPI.getType(),
3102 "The landingpad instruction should have a consistent result type "
3103 "inside a function.",
3104 &LPI);
3105
David Majnemer7fddecc2015-06-17 20:52:32 +00003106 Function *F = LPI.getParent()->getParent();
3107 Assert(F->hasPersonalityFn(),
3108 "LandingPadInst needs to be in a function with a personality.", &LPI);
3109
Bill Wendlingfae14752011-08-12 20:24:12 +00003110 // The landingpad instruction must be the first non-PHI instruction in the
3111 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003112 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3113 "LandingPadInst not the first non-PHI instruction in the block.",
3114 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003115
Duncan Sands86de1a62011-09-27 16:43:19 +00003116 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003117 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003118 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003119 Assert(isa<PointerType>(Clause->getType()),
3120 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003121 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003122 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3123 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3124 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003125 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003126 }
3127
Bill Wendlingfae14752011-08-12 20:24:12 +00003128 visitInstruction(LPI);
3129}
3130
David Majnemer654e1302015-07-31 17:58:14 +00003131void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003132 visitEHPadPredecessors(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003133
David Majnemer85a549d2015-08-11 02:48:30 +00003134 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003135
David Majnemer654e1302015-07-31 17:58:14 +00003136 Function *F = BB->getParent();
3137 Assert(F->hasPersonalityFn(),
3138 "CatchPadInst needs to be in a function with a personality.", &CPI);
3139
David Majnemer8a1c45d2015-12-12 05:38:55 +00003140 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3141 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3142 CPI.getParentPad());
3143
David Majnemer654e1302015-07-31 17:58:14 +00003144 // The catchpad instruction must be the first non-PHI instruction in the
3145 // block.
3146 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003147 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003148
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003149 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003150}
3151
David Majnemer8a1c45d2015-12-12 05:38:55 +00003152void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3153 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3154 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3155 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003156
David Majnemer8a1c45d2015-12-12 05:38:55 +00003157 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003158}
3159
3160void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003161 visitEHPadPredecessors(CPI);
3162
David Majnemer654e1302015-07-31 17:58:14 +00003163 BasicBlock *BB = CPI.getParent();
3164
David Majnemer654e1302015-07-31 17:58:14 +00003165 Function *F = BB->getParent();
3166 Assert(F->hasPersonalityFn(),
3167 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3168
3169 // The cleanuppad instruction must be the first non-PHI instruction in the
3170 // block.
3171 Assert(BB->getFirstNonPHI() == &CPI,
3172 "CleanupPadInst not the first non-PHI instruction in the block.",
3173 &CPI);
3174
David Majnemer8a1c45d2015-12-12 05:38:55 +00003175 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003176 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003177 "CleanupPadInst has an invalid parent.", &CPI);
3178
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003179 visitFuncletPadInst(CPI);
3180}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003181
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003182void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3183 User *FirstUser = nullptr;
3184 Value *FirstUnwindPad = nullptr;
3185 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
3186 while (!Worklist.empty()) {
3187 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
3188 Value *UnresolvedAncestorPad = nullptr;
3189 for (User *U : CurrentPad->users()) {
3190 BasicBlock *UnwindDest;
3191 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3192 UnwindDest = CRI->getUnwindDest();
3193 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3194 // We allow catchswitch unwind to caller to nest
3195 // within an outer pad that unwinds somewhere else,
3196 // because catchswitch doesn't have a nounwind variant.
3197 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3198 if (CSI->unwindsToCaller())
3199 continue;
3200 UnwindDest = CSI->getUnwindDest();
3201 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3202 UnwindDest = II->getUnwindDest();
3203 } else if (isa<CallInst>(U)) {
3204 // Calls which don't unwind may be found inside funclet
3205 // pads that unwind somewhere else. We don't *require*
3206 // such calls to be annotated nounwind.
3207 continue;
3208 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3209 // The unwind dest for a cleanup can only be found by
3210 // recursive search. Add it to the worklist, and we'll
3211 // search for its first use that determines where it unwinds.
3212 Worklist.push_back(CPI);
3213 continue;
3214 } else {
3215 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3216 continue;
3217 }
3218
3219 Value *UnwindPad;
3220 bool ExitsFPI;
3221 if (UnwindDest) {
3222 UnwindPad = UnwindDest->getFirstNonPHI();
3223 Value *UnwindParent = getParentPad(UnwindPad);
3224 // Ignore unwind edges that don't exit CurrentPad.
3225 if (UnwindParent == CurrentPad)
3226 continue;
3227 // Determine whether the original funclet pad is exited,
3228 // and if we are scanning nested pads determine how many
3229 // of them are exited so we can stop searching their
3230 // children.
3231 Value *ExitedPad = CurrentPad;
3232 ExitsFPI = false;
3233 do {
3234 if (ExitedPad == &FPI) {
3235 ExitsFPI = true;
3236 // Now we can resolve any ancestors of CurrentPad up to
3237 // FPI, but not including FPI since we need to make sure
3238 // to check all direct users of FPI for consistency.
3239 UnresolvedAncestorPad = &FPI;
3240 break;
3241 }
3242 Value *ExitedParent = getParentPad(ExitedPad);
3243 if (ExitedParent == UnwindParent) {
3244 // ExitedPad is the ancestor-most pad which this unwind
3245 // edge exits, so we can resolve up to it, meaning that
3246 // ExitedParent is the first ancestor still unresolved.
3247 UnresolvedAncestorPad = ExitedParent;
3248 break;
3249 }
3250 ExitedPad = ExitedParent;
3251 } while (!isa<ConstantTokenNone>(ExitedPad));
3252 } else {
3253 // Unwinding to caller exits all pads.
3254 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3255 ExitsFPI = true;
3256 UnresolvedAncestorPad = &FPI;
3257 }
3258
3259 if (ExitsFPI) {
3260 // This unwind edge exits FPI. Make sure it agrees with other
3261 // such edges.
3262 if (FirstUser) {
3263 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3264 "pad must have the same unwind "
3265 "dest",
3266 &FPI, U, FirstUser);
3267 } else {
3268 FirstUser = U;
3269 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003270 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3271 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3272 getParentPad(UnwindPad) == getParentPad(&FPI))
3273 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003274 }
3275 }
3276 // Make sure we visit all uses of FPI, but for nested pads stop as
3277 // soon as we know where they unwind to.
3278 if (CurrentPad != &FPI)
3279 break;
3280 }
3281 if (UnresolvedAncestorPad) {
3282 if (CurrentPad == UnresolvedAncestorPad) {
3283 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3284 // we've found an unwind edge that exits it, because we need to verify
3285 // all direct uses of FPI.
3286 assert(CurrentPad == &FPI);
3287 continue;
3288 }
3289 // Pop off the worklist any nested pads that we've found an unwind
3290 // destination for. The pads on the worklist are the uncles,
3291 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3292 // for all ancestors of CurrentPad up to but not including
3293 // UnresolvedAncestorPad.
3294 Value *ResolvedPad = CurrentPad;
3295 while (!Worklist.empty()) {
3296 Value *UnclePad = Worklist.back();
3297 Value *AncestorPad = getParentPad(UnclePad);
3298 // Walk ResolvedPad up the ancestor list until we either find the
3299 // uncle's parent or the last resolved ancestor.
3300 while (ResolvedPad != AncestorPad) {
3301 Value *ResolvedParent = getParentPad(ResolvedPad);
3302 if (ResolvedParent == UnresolvedAncestorPad) {
3303 break;
3304 }
3305 ResolvedPad = ResolvedParent;
3306 }
3307 // If the resolved ancestor search didn't find the uncle's parent,
3308 // then the uncle is not yet resolved.
3309 if (ResolvedPad != AncestorPad)
3310 break;
3311 // This uncle is resolved, so pop it from the worklist.
3312 Worklist.pop_back();
3313 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003314 }
3315 }
3316
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003317 if (FirstUnwindPad) {
3318 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3319 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3320 Value *SwitchUnwindPad;
3321 if (SwitchUnwindDest)
3322 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3323 else
3324 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3325 Assert(SwitchUnwindPad == FirstUnwindPad,
3326 "Unwind edges out of a catch must have the same unwind dest as "
3327 "the parent catchswitch",
3328 &FPI, FirstUser, CatchSwitch);
3329 }
3330 }
3331
3332 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003333}
3334
David Majnemer8a1c45d2015-12-12 05:38:55 +00003335void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
3336 visitEHPadPredecessors(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003337
David Majnemer8a1c45d2015-12-12 05:38:55 +00003338 BasicBlock *BB = CatchSwitch.getParent();
3339
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003340 Function *F = BB->getParent();
3341 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003342 "CatchSwitchInst needs to be in a function with a personality.",
3343 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003344
David Majnemer8a1c45d2015-12-12 05:38:55 +00003345 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003346 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003347 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3348 "CatchSwitchInst not the first non-PHI instruction in the block.",
3349 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003350
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003351 auto *ParentPad = CatchSwitch.getParentPad();
3352 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3353 "CatchSwitchInst has an invalid parent.", ParentPad);
3354
David Majnemer8a1c45d2015-12-12 05:38:55 +00003355 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003356 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003357 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3358 "CatchSwitchInst must unwind to an EH block which is not a "
3359 "landingpad.",
3360 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003361
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003362 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3363 if (getParentPad(I) == ParentPad)
3364 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3365 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003366
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003367 Assert(CatchSwitch.getNumHandlers() != 0,
3368 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3369
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003370 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003371 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3372 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003373 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003374
David Majnemer8a1c45d2015-12-12 05:38:55 +00003375 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003376}
3377
David Majnemer654e1302015-07-31 17:58:14 +00003378void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003379 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3380 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3381 CRI.getOperand(0));
3382
David Majnemer654e1302015-07-31 17:58:14 +00003383 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3384 Instruction *I = UnwindDest->getFirstNonPHI();
3385 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3386 "CleanupReturnInst must unwind to an EH block which is not a "
3387 "landingpad.",
3388 &CRI);
3389 }
3390
3391 visitTerminatorInst(CRI);
3392}
3393
Rafael Espindola654320a2012-02-26 02:23:37 +00003394void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3395 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003396 // If the we have an invalid invoke, don't try to compute the dominance.
3397 // We already reject it in the invoke specific checks and the dominance
3398 // computation doesn't handle multiple edges.
3399 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3400 if (II->getNormalDest() == II->getUnwindDest())
3401 return;
3402 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003403
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003404 const Use &U = I.getOperandUse(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003405 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3406 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003407}
3408
Artur Pilipenkocca80022015-10-09 17:41:29 +00003409void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3410 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3411 "apply only to pointer types", &I);
3412 Assert(isa<LoadInst>(I),
3413 "dereferenceable, dereferenceable_or_null apply only to load"
3414 " instructions, use attributes for calls or invokes", &I);
3415 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3416 "take one operand!", &I);
3417 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3418 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3419 "dereferenceable_or_null metadata value must be an i64!", &I);
3420}
3421
Misha Brukmanc566ca362004-03-02 00:22:19 +00003422/// verifyInstruction - Verify that an instruction is well formed.
3423///
Chris Lattner069a7952002-06-25 15:56:27 +00003424void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003425 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003426 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003427
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003428 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003429 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003430 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3431 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003432 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003433 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003434
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003435 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003436 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3437 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003438
Chris Lattner5f126b72004-03-29 00:29:36 +00003439 // Check that the return value of the instruction is either void or a legal
3440 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003441 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3442 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003443
Nick Lewycky93e06a52009-09-27 23:27:42 +00003444 // Check that the instruction doesn't produce metadata. Calls are already
3445 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003446 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3447 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003448
Chris Lattner0e851da2002-04-18 20:37:37 +00003449 // Check that all uses of the instruction, if they are instructions
3450 // themselves, actually have parent basic blocks. If the use is not an
3451 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003452 for (Use &U : I.uses()) {
3453 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003454 Assert(Used->getParent() != nullptr,
3455 "Instruction referencing"
3456 " instruction not embedded in a basic block!",
3457 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003458 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003459 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003460 return;
3461 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003462 }
3463
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003464 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003465 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003466
3467 // Check to make sure that only first-class-values are operands to
3468 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003469 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003470 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003471 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003472
Chris Lattner9ece94b2004-03-14 03:23:54 +00003473 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003474 // Check to make sure that the "address of" an intrinsic function is never
3475 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003476 Assert(
3477 !F->isIntrinsic() ||
3478 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3479 "Cannot take the address of an intrinsic!", &I);
3480 Assert(
3481 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003482 F->getIntrinsicID() == Intrinsic::donothing ||
3483 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003484 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3485 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003486 "Cannot invoke an intrinsinc other than"
3487 " donothing or patchpoint",
3488 &I);
3489 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003490 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003491 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003492 Assert(OpBB->getParent() == BB->getParent(),
3493 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003494 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003495 Assert(OpArg->getParent() == BB->getParent(),
3496 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003497 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003498 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003499 } else if (isa<Instruction>(I.getOperand(i))) {
3500 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003501 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003502 Assert((i + 1 == e && isa<CallInst>(I)) ||
3503 (i + 3 == e && isa<InvokeInst>(I)),
3504 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003505 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3506 if (CE->getType()->isPtrOrPtrVectorTy()) {
3507 // If we have a ConstantExpr pointer, we need to see if it came from an
3508 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003509 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003510 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003511 }
3512 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003513
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003514 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003515 Assert(I.getType()->isFPOrFPVectorTy(),
3516 "fpmath requires a floating point result!", &I);
3517 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003518 if (ConstantFP *CFP0 =
3519 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003520 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003521 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3522 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003523 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003524 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003525 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003526 }
3527
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003528 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003529 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3530 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003531 visitRangeMetadata(I, Range, I.getType());
3532 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003533
Philip Reames0ca58b32014-10-21 20:56:29 +00003534 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003535 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3536 &I);
3537 Assert(isa<LoadInst>(I),
3538 "nonnull applies only to load instructions, use attributes"
3539 " for calls or invokes",
3540 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003541 }
3542
Artur Pilipenkocca80022015-10-09 17:41:29 +00003543 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3544 visitDereferenceableMetadata(I, MD);
3545
3546 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3547 visitDereferenceableMetadata(I, MD);
3548
3549 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3550 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3551 &I);
3552 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3553 "use attributes for calls or invokes", &I);
3554 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3555 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3556 Assert(CI && CI->getType()->isIntegerTy(64),
3557 "align metadata value must be an i64!", &I);
3558 uint64_t Align = CI->getZExtValue();
3559 Assert(isPowerOf2_64(Align),
3560 "align metadata value must be a power of 2!", &I);
3561 Assert(Align <= Value::MaximumAlignment,
3562 "alignment is larger that implementation defined limit", &I);
3563 }
3564
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003565 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003566 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003567 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003568 }
3569
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003570 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003571}
3572
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003573/// Verify that the specified type (which comes from an intrinsic argument or
3574/// return value) matches the type constraints specified by the .td file (e.g.
3575/// an "any integer" argument really is an integer).
Chris Lattner144b6192012-05-27 19:37:05 +00003576///
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003577/// This returns true on error but does not print a message.
3578bool Verifier::verifyIntrinsicType(Type *Ty,
Chris Lattner144b6192012-05-27 19:37:05 +00003579 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3580 SmallVectorImpl<Type*> &ArgTys) {
3581 using namespace Intrinsic;
3582
3583 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003584 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003585 IITDescriptor D = Infos.front();
3586 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003587
Chris Lattner144b6192012-05-27 19:37:05 +00003588 switch (D.Kind) {
3589 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003590 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003591 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003592 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003593 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003594 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003595 case IITDescriptor::Float: return !Ty->isFloatTy();
3596 case IITDescriptor::Double: return !Ty->isDoubleTy();
3597 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3598 case IITDescriptor::Vector: {
3599 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003600 return !VT || VT->getNumElements() != D.Vector_Width ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003601 verifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003602 }
3603 case IITDescriptor::Pointer: {
3604 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003605 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003606 verifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003607 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003608
Chris Lattner144b6192012-05-27 19:37:05 +00003609 case IITDescriptor::Struct: {
3610 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003611 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003612 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003613
Chris Lattner144b6192012-05-27 19:37:05 +00003614 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003615 if (verifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
Chris Lattner144b6192012-05-27 19:37:05 +00003616 return true;
3617 return false;
3618 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003619
Chris Lattner144b6192012-05-27 19:37:05 +00003620 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003621 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003622 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003623 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003624 return Ty != ArgTys[D.getArgumentNumber()];
3625
Chris Lattner144b6192012-05-27 19:37:05 +00003626 // Otherwise, if this is the first instance of an argument, record it and
3627 // verify the "Any" kind.
3628 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3629 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003630
Chris Lattner144b6192012-05-27 19:37:05 +00003631 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003632 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003633 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3634 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3635 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3636 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3637 }
3638 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003639
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003640 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003641 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003642 if (D.getArgumentNumber() >= ArgTys.size())
3643 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003644
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003645 Type *NewTy = ArgTys[D.getArgumentNumber()];
3646 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3647 NewTy = VectorType::getExtendedElementVectorType(VTy);
3648 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3649 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3650 else
3651 return true;
3652
3653 return Ty != NewTy;
3654 }
3655 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003656 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003657 if (D.getArgumentNumber() >= ArgTys.size())
3658 return true;
3659
3660 Type *NewTy = ArgTys[D.getArgumentNumber()];
3661 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3662 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3663 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3664 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3665 else
3666 return true;
3667
3668 return Ty != NewTy;
3669 }
Tim Northover4516de32014-03-29 07:04:54 +00003670 case IITDescriptor::HalfVecArgument:
3671 // This may only be used when referring to a previous vector argument.
3672 return D.getArgumentNumber() >= ArgTys.size() ||
3673 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3674 VectorType::getHalfElementsVectorType(
3675 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003676 case IITDescriptor::SameVecWidthArgument: {
3677 if (D.getArgumentNumber() >= ArgTys.size())
3678 return true;
3679 VectorType * ReferenceType =
3680 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3681 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3682 if (!ThisArgType || !ReferenceType ||
3683 (ReferenceType->getVectorNumElements() !=
3684 ThisArgType->getVectorNumElements()))
3685 return true;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003686 return verifyIntrinsicType(ThisArgType->getVectorElementType(),
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003687 Infos, ArgTys);
3688 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003689 case IITDescriptor::PtrToArgument: {
3690 if (D.getArgumentNumber() >= ArgTys.size())
3691 return true;
3692 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3693 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3694 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3695 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003696 case IITDescriptor::VecOfPtrsToElt: {
3697 if (D.getArgumentNumber() >= ArgTys.size())
3698 return true;
3699 VectorType * ReferenceType =
3700 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3701 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3702 if (!ThisArgVecTy || !ReferenceType ||
3703 (ReferenceType->getVectorNumElements() !=
3704 ThisArgVecTy->getVectorNumElements()))
3705 return true;
3706 PointerType *ThisArgEltTy =
3707 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3708 if (!ThisArgEltTy)
3709 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003710 return ThisArgEltTy->getElementType() !=
3711 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003712 }
Chris Lattner144b6192012-05-27 19:37:05 +00003713 }
3714 llvm_unreachable("unhandled");
3715}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003716
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003717/// Verify if the intrinsic has variable arguments. This method is intended to
3718/// be called after all the fixed arguments have been verified first.
Andrew Tricka2efd992013-10-31 17:18:11 +00003719///
3720/// This method returns true on error and does not print an error message.
3721bool
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003722Verifier::verifyIntrinsicIsVarArg(bool isVarArg,
Andrew Tricka2efd992013-10-31 17:18:11 +00003723 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3724 using namespace Intrinsic;
3725
3726 // If there are no descriptors left, then it can't be a vararg.
3727 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003728 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003729
3730 // There should be only one descriptor remaining at this point.
3731 if (Infos.size() != 1)
3732 return true;
3733
3734 // Check and verify the descriptor.
3735 IITDescriptor D = Infos.front();
3736 Infos = Infos.slice(1);
3737 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003738 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003739
3740 return true;
3741}
3742
Philip Reames007561a2015-06-26 22:21:52 +00003743/// Allow intrinsics to be verified in different ways.
3744void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003745 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003746 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3747 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003748
Chris Lattner144b6192012-05-27 19:37:05 +00003749 // Verify that the intrinsic prototype lines up with what the .td files
3750 // describe.
3751 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003752 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003753
Chris Lattner144b6192012-05-27 19:37:05 +00003754 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3755 getIntrinsicInfoTableEntries(ID, Table);
3756 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003757
Chris Lattner144b6192012-05-27 19:37:05 +00003758 SmallVector<Type *, 4> ArgTys;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003759 Assert(!verifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003760 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003761 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003762 Assert(!verifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003763 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003764
3765 // Verify if the intrinsic call matches the vararg property.
3766 if (IsVarArg)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003767 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003768 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003769 else
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003770 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003771 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003772
3773 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003774 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003775
3776 // Now that we have the intrinsic ID and the actual argument types (and we
3777 // know they are legal for the intrinsic!) get the intrinsic name through the
3778 // usual means. This allows us to verify the mangling of argument types into
3779 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003780 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003781 Assert(ExpectedName == IF->getName(),
3782 "Intrinsic name not mangled correctly for type arguments! "
3783 "Should be: " +
3784 ExpectedName,
3785 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003786
Chris Lattner588096e2009-12-28 09:07:21 +00003787 // If the intrinsic takes MDNode arguments, verify that they are either global
3788 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003789 for (Value *V : CS.args())
3790 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3791 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003792
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003793 switch (ID) {
3794 default:
3795 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003796 case Intrinsic::ctlz: // llvm.ctlz
3797 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003798 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003799 "is_zero_undef argument of bit counting intrinsics must be a "
3800 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003801 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003802 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003803 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003804 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3805 "invalid llvm.dbg.declare intrinsic call 1", CS);
3806 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003807 break;
3808 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003809 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003810 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003811 case Intrinsic::memcpy:
3812 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003813 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003814 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003815 Assert(AlignCI,
3816 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003817 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003818 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003819 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003820 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003821 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003822 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003823 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003824 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003825 }
Bill Wendling05604e02008-08-23 09:46:46 +00003826 case Intrinsic::gcroot:
3827 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003828 case Intrinsic::gcread:
3829 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003830 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003831 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3832 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3833 Assert(isa<Constant>(CS.getArgOperand(1)),
3834 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003835 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003836 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003837 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3838 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003839 CS);
Talin2e59f142010-09-30 20:23:47 +00003840 }
Chris Lattner25852062008-08-24 20:46:13 +00003841 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003842
Philip Reames9818dd72015-06-26 22:04:34 +00003843 Assert(CS.getParent()->getParent()->hasGC(),
3844 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003845 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003846 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003847 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003848 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003849 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003850 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003851 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003852 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3853 isa<ConstantInt>(CS.getArgOperand(2)) &&
3854 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3855 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3856 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003857 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003858 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003859 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3860 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003861 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003862 case Intrinsic::lifetime_start:
3863 case Intrinsic::lifetime_end:
3864 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003865 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003866 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003867 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003868 break;
3869 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003870 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3871 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003872 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003873
Reid Kleckner60381792015-07-07 22:25:32 +00003874 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003875 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003876 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003877 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003878 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003879 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003880 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003881 if (isa<ConstantPointerNull>(Arg))
3882 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003883 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003884 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003885 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003886 }
Philip Reames9818dd72015-06-26 22:04:34 +00003887 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003888 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003889 break;
3890 }
Reid Kleckner60381792015-07-07 22:25:32 +00003891 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003892 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003893 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003894 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003895 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003896 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003897 CS);
3898 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003899 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003900 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003901 auto &Entry = FrameEscapeInfo[Fn];
3902 Entry.second = unsigned(
3903 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003904 break;
3905 }
3906
Philip Reames1ffa9372015-01-30 23:28:05 +00003907 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00003908 Assert(!CS.isInlineAsm(),
3909 "gc.statepoint support for inline assembly unimplemented", CS);
3910 Assert(CS.getParent()->getParent()->hasGC(),
3911 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00003912
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003913 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003914 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003915 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00003916 Assert(CS.getParent()->getParent()->hasGC(),
3917 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003918 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00003919 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00003920 const Function *StatepointFn =
3921 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003922 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3923 StatepointFn->getIntrinsicID() ==
3924 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00003925 "gc.result operand #1 must be from a statepoint", CS,
3926 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00003927
Philip Reamesb23713a2014-12-03 22:23:24 +00003928 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003929 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00003930 auto *PT = cast<PointerType>(Target->getType());
3931 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00003932 Assert(CS.getType() == TargetFuncType->getReturnType(),
3933 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003934 break;
3935 }
3936 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00003937 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003938
Philip Reames3e2cf532016-01-07 03:32:11 +00003939 Assert(isa<PointerType>(CS.getType()->getScalarType()),
3940 "gc.relocate must return a pointer or a vector of pointers", CS);
3941
Igor Laevsky9570ff92015-02-19 11:28:47 +00003942 // Check that this relocate is correctly tied to the statepoint
3943
3944 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00003945 if (LandingPadInst *LandingPad =
3946 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00003947
Sanjoy Das5665c992015-05-11 23:47:27 +00003948 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00003949 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00003950
3951 // Landingpad relocates should have only one predecessor with invoke
3952 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00003953 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00003954 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00003955 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3956 InvokeBB);
3957 Assert(isStatepoint(InvokeBB->getTerminator()),
3958 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003959 }
3960 else {
3961 // In all other cases relocate should be tied to the statepoint directly.
3962 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003963 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00003964 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003965 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00003966 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003967 }
3968
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003969 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00003970
Manuel Jacob83eefa62016-01-05 04:03:00 +00003971 ImmutableCallSite StatepointCS(
3972 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00003973
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003974 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00003975 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003976 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00003977 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003978
Philip Reames9818dd72015-06-26 22:04:34 +00003979 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003980 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00003981 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003982
3983 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3984 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3985 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003986 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003987 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003988 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003989 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00003990
3991 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003992 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003993 Assert(StatepointCS.arg_size() > 0,
3994 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003995 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00003996 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003997 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003998 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3999 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004000 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004001 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004002 "gc.statepoint: number of transition arguments must be "
4003 "a constant integer");
4004 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004005 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4006 ->getZExtValue();
4007 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004008 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004009 "gc.statepoint: number of deoptimization arguments must be "
4010 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004011 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004012 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4013 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004014 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004015 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004016 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4017 "gc.relocate: statepoint base index doesn't fall within the "
4018 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004019 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004020 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4021 "gc.relocate: statepoint derived index doesn't fall within the "
4022 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004023 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004024
Philip Reames3e2cf532016-01-07 03:32:11 +00004025 // Relocated value must be either a pointer type or vector-of-pointer type,
4026 // but gc_relocate does not need to return the same pointer type as the
4027 // relocated pointer. It can be casted to the correct type later if it's
4028 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004029 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004030 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004031 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004032
Philip Reames3e2cf532016-01-07 03:32:11 +00004033 auto ResultType = CS.getType();
4034 auto DerivedType = Relocate.getDerivedPtr()->getType();
4035 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004036 "gc.relocate: vector relocates to vector and pointer to pointer",
4037 CS);
4038 Assert(
4039 ResultType->getPointerAddressSpace() ==
4040 DerivedType->getPointerAddressSpace(),
4041 "gc.relocate: relocating a pointer shouldn't change its address space",
4042 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004043 break;
4044 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004045 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004046 case Intrinsic::eh_exceptionpointer: {
4047 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4048 "eh.exceptionpointer argument must be a catchpad", CS);
4049 break;
4050 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004051 case Intrinsic::masked_load: {
4052 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4053
4054 Value *Ptr = CS.getArgOperand(0);
4055 //Value *Alignment = CS.getArgOperand(1);
4056 Value *Mask = CS.getArgOperand(2);
4057 Value *PassThru = CS.getArgOperand(3);
4058 Assert(Mask->getType()->isVectorTy(),
4059 "masked_load: mask must be vector", CS);
4060
4061 // DataTy is the overloaded type
4062 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4063 Assert(DataTy == CS.getType(),
4064 "masked_load: return must match pointer type", CS);
4065 Assert(PassThru->getType() == DataTy,
4066 "masked_load: pass through and data type must match", CS);
4067 Assert(Mask->getType()->getVectorNumElements() ==
4068 DataTy->getVectorNumElements(),
4069 "masked_load: vector mask must be same length as data", CS);
4070 break;
4071 }
4072 case Intrinsic::masked_store: {
4073 Value *Val = CS.getArgOperand(0);
4074 Value *Ptr = CS.getArgOperand(1);
4075 //Value *Alignment = CS.getArgOperand(2);
4076 Value *Mask = CS.getArgOperand(3);
4077 Assert(Mask->getType()->isVectorTy(),
4078 "masked_store: mask must be vector", CS);
4079
4080 // DataTy is the overloaded type
4081 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4082 Assert(DataTy == Val->getType(),
4083 "masked_store: storee must match pointer type", CS);
4084 Assert(Mask->getType()->getVectorNumElements() ==
4085 DataTy->getVectorNumElements(),
4086 "masked_store: vector mask must be same length as data", CS);
4087 break;
4088 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004089 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004090}
4091
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004092/// \brief Carefully grab the subprogram from a local scope.
4093///
4094/// This carefully grabs the subprogram from a local scope, avoiding the
4095/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004096static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004097 if (!LocalScope)
4098 return nullptr;
4099
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004100 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004101 return SP;
4102
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004103 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004104 return getSubprogram(LB->getRawScope());
4105
4106 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004107 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004108 return nullptr;
4109}
4110
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004111template <class DbgIntrinsicTy>
4112void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4113 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
4114 Assert(isa<ValueAsMetadata>(MD) ||
4115 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4116 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004117 Assert(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004118 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4119 DII.getRawVariable());
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004120 Assert(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004121 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4122 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004123
4124 // Ignore broken !dbg attachments; they're checked elsewhere.
4125 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004126 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004127 return;
4128
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004129 BasicBlock *BB = DII.getParent();
4130 Function *F = BB ? BB->getParent() : nullptr;
4131
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004132 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004133 DILocalVariable *Var = DII.getVariable();
4134 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004135 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4136 &DII, BB, F);
4137
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004138 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4139 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004140 if (!VarSP || !LocSP)
4141 return; // Broken scope chains are checked elsewhere.
4142
4143 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4144 " variable and !dbg attachment",
4145 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4146 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004147}
4148
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004149template <class MapTy>
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004150static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004151 // Be careful of broken types (checked elsewhere).
4152 const Metadata *RawType = V.getRawType();
4153 while (RawType) {
4154 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004155 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004156 if (uint64_t Size = T->getSizeInBits())
4157 return Size;
4158
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004159 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004160 // Look at the base type.
4161 RawType = DT->getRawBaseType();
4162 continue;
4163 }
4164
4165 if (auto *S = dyn_cast<MDString>(RawType)) {
4166 // Don't error on missing types (checked elsewhere).
4167 RawType = Map.lookup(S);
4168 continue;
4169 }
4170
4171 // Missing type or size.
4172 break;
4173 }
4174
4175 // Fail gracefully.
4176 return 0;
4177}
4178
4179template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +00004180void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
4181 const MapTy &TypeRefs) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004182 DILocalVariable *V;
4183 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004184 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004185 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4186 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004187 } else {
4188 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004189 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4190 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004191 }
4192
4193 // We don't know whether this intrinsic verified correctly.
4194 if (!V || !E || !E->isValid())
4195 return;
4196
Keno Fischer253a7bd2016-01-15 02:12:38 +00004197 // Nothing to do if this isn't a bit piece expression.
4198 if (!E->isBitPiece())
4199 return;
4200
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004201 // The frontend helps out GDB by emitting the members of local anonymous
4202 // unions as artificial local variables with shared storage. When SROA splits
4203 // the storage for artificial local variables that are smaller than the entire
4204 // union, the overhang piece will be outside of the allotted space for the
4205 // variable and this check fails.
4206 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4207 if (V->isArtificial())
4208 return;
4209
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004210 // If there's no size, the type is broken, but that should be checked
4211 // elsewhere.
4212 uint64_t VarSize = getVariableSize(*V, TypeRefs);
4213 if (!VarSize)
4214 return;
4215
Keno Fischer253a7bd2016-01-15 02:12:38 +00004216 unsigned PieceSize = E->getBitPieceSize();
4217 unsigned PieceOffset = E->getBitPieceOffset();
4218 Assert(PieceSize + PieceOffset <= VarSize,
4219 "piece is larger than or outside of variable", &I, V, E);
4220 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004221}
4222
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004223void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
4224 // This is in its own function so we get an error for each bad type ref (not
4225 // just the first).
4226 Assert(false, "unresolved type ref", S, N);
4227}
4228
4229void Verifier::verifyTypeRefs() {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004230 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4231 if (!CUs)
4232 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004233
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004234 // Visit all the compile units again to map the type references.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004235 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004236 for (auto *CU : CUs->operands())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004237 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
4238 for (DIType *Op : Ts)
David Blaikie3c338f32015-08-22 22:36:40 +00004239 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004240 if (auto *S = T->getRawIdentifier()) {
4241 UnresolvedTypeRefs.erase(S);
4242 TypeRefs.insert(std::make_pair(S, T));
4243 }
4244
4245 // Verify debug info intrinsic bit piece expressions. This needs a second
4246 // pass through the intructions, since we haven't built TypeRefs yet when
4247 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
4248 // later/now would queue up some that could be later deleted.
4249 for (const Function &F : *M)
4250 for (const BasicBlock &BB : F)
4251 for (const Instruction &I : BB)
4252 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Keno Fischer253a7bd2016-01-15 02:12:38 +00004253 verifyBitPieceExpression(*DII, TypeRefs);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004254
4255 // Return early if all typerefs were resolved.
4256 if (UnresolvedTypeRefs.empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004257 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004258
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004259 // Sort the unresolved references by name so the output is deterministic.
4260 typedef std::pair<const MDString *, const MDNode *> TypeRef;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004261 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
4262 UnresolvedTypeRefs.end());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004263 std::sort(Unresolved.begin(), Unresolved.end(),
4264 [](const TypeRef &LHS, const TypeRef &RHS) {
4265 return LHS.first->getString() < RHS.first->getString();
4266 });
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004267
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004268 // Visit the unresolved refs (printing out the errors).
4269 for (const TypeRef &TR : Unresolved)
4270 visitUnresolvedTypeRef(TR.first, TR.second);
Manman Ren74c61b92013-07-19 00:31:03 +00004271}
4272
Chris Lattner0e851da2002-04-18 20:37:37 +00004273//===----------------------------------------------------------------------===//
4274// Implement the public interfaces to this file...
4275//===----------------------------------------------------------------------===//
4276
Chandler Carruth043949d2014-01-19 02:22:18 +00004277bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004278 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00004279 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00004280
Chandler Carruth043949d2014-01-19 02:22:18 +00004281 raw_null_ostream NullStr;
4282 Verifier V(OS ? *OS : NullStr);
4283
4284 // Note that this function's return value is inverted from what you would
4285 // expect of a function called "verify".
4286 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004287}
4288
Chandler Carruth043949d2014-01-19 02:22:18 +00004289bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
4290 raw_null_ostream NullStr;
4291 Verifier V(OS ? *OS : NullStr);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004292
Chandler Carruth043949d2014-01-19 02:22:18 +00004293 bool Broken = false;
4294 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
Rafael Espindolad4bcefc2014-10-24 18:13:04 +00004295 if (!I->isDeclaration() && !I->isMaterializable())
Chandler Carruth043949d2014-01-19 02:22:18 +00004296 Broken |= !V.verify(*I);
4297
4298 // Note that this function's return value is inverted from what you would
4299 // expect of a function called "verify".
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +00004300 return !V.verify(M) || Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004301}
Chandler Carruth043949d2014-01-19 02:22:18 +00004302
4303namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004304struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004305 static char ID;
4306
4307 Verifier V;
4308 bool FatalErrors;
4309
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +00004310 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004311 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004312 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004313 explicit VerifierLegacyPass(bool FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004314 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004315 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004316 }
4317
Craig Topperf398d7c2014-03-05 06:35:38 +00004318 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004319 if (!V.verify(F) && FatalErrors)
4320 report_fatal_error("Broken function found, compilation aborted!");
4321
4322 return false;
4323 }
4324
Craig Topperf398d7c2014-03-05 06:35:38 +00004325 bool doFinalization(Module &M) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004326 if (!V.verify(M) && FatalErrors)
4327 report_fatal_error("Broken module found, compilation aborted!");
4328
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004329 return false;
4330 }
4331
4332 void getAnalysisUsage(AnalysisUsage &AU) const override {
4333 AU.setPreservesAll();
4334 }
4335};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004336}
Chandler Carruth043949d2014-01-19 02:22:18 +00004337
Chandler Carruth4d356312014-01-20 11:34:08 +00004338char VerifierLegacyPass::ID = 0;
4339INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004340
4341FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004342 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004343}
4344
Chandler Carruthd174ce42015-01-05 02:47:05 +00004345PreservedAnalyses VerifierPass::run(Module &M) {
4346 if (verifyModule(M, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004347 report_fatal_error("Broken module found, compilation aborted!");
4348
4349 return PreservedAnalyses::all();
4350}
4351
Chandler Carruthd174ce42015-01-05 02:47:05 +00004352PreservedAnalyses VerifierPass::run(Function &F) {
4353 if (verifyFunction(F, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004354 report_fatal_error("Broken function found, compilation aborted!");
4355
4356 return PreservedAnalyses::all();
4357}