blob: 8367a2702ebc261b3eb893485af2dfea3bcd86fc [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 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000244 for (const BasicBlock &BB : F) {
245 if (BB.empty() || !BB.back().isTerminator()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000246 OS << "Basic Block in function '" << F.getName()
247 << "' does not have terminator!\n";
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000248 BB.printAsOperand(OS, true);
Chandler Carruth043949d2014-01-19 02:22:18 +0000249 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...
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000279 for (const Function &F : M) {
280 visitGlobalValue(F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000281
282 // Check to make sure function prototypes are okay.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000283 if (F.isDeclaration())
284 visitFunction(F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000285 }
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();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000290 for (const GlobalVariable &GV : M.globals())
291 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000292
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000293 for (const GlobalAlias &GA : M.aliases())
294 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000295
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000296 for (const NamedMDNode &NMD : M.named_metadata())
297 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000298
David Majnemerdad0a642014-06-27 18:19:56 +0000299 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
300 visitComdat(SMEC.getValue());
301
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000302 visitModuleFlags(M);
303 visitModuleIdents(M);
304
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000305 // Verify type referneces last.
306 verifyTypeRefs();
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000307
Chandler Carruth043949d2014-01-19 02:22:18 +0000308 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000309 }
Chris Lattner9713b842002-04-28 16:04:26 +0000310
Chandler Carruth043949d2014-01-19 02:22:18 +0000311private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000312 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000313 void visitGlobalValue(const GlobalValue &GV);
314 void visitGlobalVariable(const GlobalVariable &GV);
315 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000316 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000317 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000318 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000319 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000320 void visitMDNode(const MDNode &MD);
321 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
322 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000323 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000324 void visitModuleIdents(const Module &M);
325 void visitModuleFlags(const Module &M);
326 void visitModuleFlag(const MDNode *Op,
327 DenseMap<const MDString *, const MDNode *> &SeenIDs,
328 SmallVectorImpl<const MDNode *> &Requirements);
329 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000330 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000331 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000332 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000333
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000334 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000335#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
336#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000337 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000338 void visitDIVariable(const DIVariable &N);
339 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
340 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000341
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000342 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
343
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000344 /// \brief Check for a valid string-based type reference.
345 ///
346 /// Checks if \c MD is a string-based type reference. If it is, keeps track
347 /// of it (and its user, \c N) for error messages later.
348 bool isValidUUID(const MDNode &N, const Metadata *MD);
349
350 /// \brief Check for a valid type reference.
351 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000352 /// Checks for subclasses of \a DIType, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000353 bool isTypeRef(const MDNode &N, const Metadata *MD);
354
355 /// \brief Check for a valid scope reference.
356 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000357 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000358 bool isScopeRef(const MDNode &N, const Metadata *MD);
359
360 /// \brief Check for a valid debug info reference.
361 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000362 /// Checks for subclasses of \a DINode, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000363 bool isDIRef(const MDNode &N, const Metadata *MD);
364
Chandler Carruth043949d2014-01-19 02:22:18 +0000365 // InstVisitor overrides...
366 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000367 void visit(Instruction &I);
368
369 void visitTruncInst(TruncInst &I);
370 void visitZExtInst(ZExtInst &I);
371 void visitSExtInst(SExtInst &I);
372 void visitFPTruncInst(FPTruncInst &I);
373 void visitFPExtInst(FPExtInst &I);
374 void visitFPToUIInst(FPToUIInst &I);
375 void visitFPToSIInst(FPToSIInst &I);
376 void visitUIToFPInst(UIToFPInst &I);
377 void visitSIToFPInst(SIToFPInst &I);
378 void visitIntToPtrInst(IntToPtrInst &I);
379 void visitPtrToIntInst(PtrToIntInst &I);
380 void visitBitCastInst(BitCastInst &I);
381 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
382 void visitPHINode(PHINode &PN);
383 void visitBinaryOperator(BinaryOperator &B);
384 void visitICmpInst(ICmpInst &IC);
385 void visitFCmpInst(FCmpInst &FC);
386 void visitExtractElementInst(ExtractElementInst &EI);
387 void visitInsertElementInst(InsertElementInst &EI);
388 void visitShuffleVectorInst(ShuffleVectorInst &EI);
389 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
390 void visitCallInst(CallInst &CI);
391 void visitInvokeInst(InvokeInst &II);
392 void visitGetElementPtrInst(GetElementPtrInst &GEP);
393 void visitLoadInst(LoadInst &LI);
394 void visitStoreInst(StoreInst &SI);
395 void verifyDominatesUse(Instruction &I, unsigned i);
396 void visitInstruction(Instruction &I);
397 void visitTerminatorInst(TerminatorInst &I);
398 void visitBranchInst(BranchInst &BI);
399 void visitReturnInst(ReturnInst &RI);
400 void visitSwitchInst(SwitchInst &SI);
401 void visitIndirectBrInst(IndirectBrInst &BI);
402 void visitSelectInst(SelectInst &SI);
403 void visitUserOp1(Instruction &I);
404 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000405 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000406 template <class DbgIntrinsicTy>
407 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000408 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
409 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
410 void visitFenceInst(FenceInst &FI);
411 void visitAllocaInst(AllocaInst &AI);
412 void visitExtractValueInst(ExtractValueInst &EVI);
413 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000414 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000415 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemer654e1302015-07-31 17:58:14 +0000416 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000417 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000418 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000419 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000420 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000421 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000422
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000423 void verifyCallSite(CallSite CS);
Reid Kleckner5772b772014-04-24 20:14:34 +0000424 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000425 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000426 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000427 bool verifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000428 SmallVectorImpl<Type *> &ArgTys);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000429 bool verifyIntrinsicIsVarArg(bool isVarArg,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000430 ArrayRef<Intrinsic::IITDescriptor> &Infos);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000431 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
432 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000433 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000434 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000435 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000436 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000437 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000438 void verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +0000439 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000440
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000441 void visitConstantExprsRecursively(const Constant *EntryC);
442 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000443 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000444 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000445 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000446
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000447 // Module-level debug info verification...
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000448 void verifyTypeRefs();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000449 template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +0000450 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
451 const MapTy &TypeRefs);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000452 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000453};
Chris Lattner189d19f2003-11-21 20:23:48 +0000454} // End anonymous namespace
455
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000456// Assert - We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000457#define Assert(C, ...) \
458 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000459
Chris Lattnere5a22c02008-08-28 04:02:44 +0000460void Verifier::visit(Instruction &I) {
461 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000462 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000463 InstVisitor<Verifier>::visit(I);
464}
465
Keno Fischer60f82a22016-01-14 22:20:56 +0000466// Helper to recursively iterate over indirect users. By
467// returning false, the callback can ask to stop recursing
468// further.
469static void forEachUser(const Value *User,
470 SmallPtrSet<const Value *, 32> &Visited,
471 llvm::function_ref<bool(const Value *)> Callback) {
472 if (!Visited.insert(User).second)
473 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000474 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000475 if (Callback(TheNextUser))
476 forEachUser(TheNextUser, Visited, Callback);
477}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000478
Chandler Carruth043949d2014-01-19 02:22:18 +0000479void Verifier::visitGlobalValue(const GlobalValue &GV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000480 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
481 GV.hasExternalWeakLinkage(),
482 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000483
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000484 Assert(GV.getAlignment() <= Value::MaximumAlignment,
485 "huge alignment values are unsupported", &GV);
486 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
487 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000488
489 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000490 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000491 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000492 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000493 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000494
495 if (GV.isDeclarationForLinker())
496 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000497
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000498 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000499 if (const Instruction *I = dyn_cast<Instruction>(V)) {
500 if (!I->getParent() || !I->getParent()->getParent())
501 CheckFailed("Global is referenced by parentless instruction!", &GV,
502 M, I);
503 else if (I->getParent()->getParent()->getParent() != M)
504 CheckFailed("Global is referenced in a different module!", &GV,
505 M, I, I->getParent()->getParent(),
506 I->getParent()->getParent()->getParent());
507 return false;
508 } else if (const Function *F = dyn_cast<Function>(V)) {
509 if (F->getParent() != M)
510 CheckFailed("Global is used by function in a different module", &GV,
511 M, F, F->getParent());
512 return false;
513 }
514 return true;
515 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000516}
517
Chandler Carruth043949d2014-01-19 02:22:18 +0000518void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000519 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000520 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000521 "Global variable initializer type does not match global "
522 "variable type!",
523 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000524
Chris Lattner0aff0b22009-08-05 05:41:44 +0000525 // If the global has common linkage, it must have a zero initializer and
526 // cannot be constant.
527 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000528 Assert(GV.getInitializer()->isNullValue(),
529 "'common' global must have a zero initializer!", &GV);
530 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
531 &GV);
532 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000533 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000534 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000535 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
536 "invalid linkage type for global declaration", &GV);
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000537 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000538
Nick Lewycky466d0c12011-04-08 07:30:21 +0000539 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
540 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000541 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
542 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000543 // Don't worry about emitting an error for it not being an array,
544 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000545 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000546 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
547 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000548 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000549 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000550 Assert(STy &&
551 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
552 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
553 STy->getTypeAtIndex(1) == FuncPtrTy,
554 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000555 if (STy->getNumElements() == 3) {
556 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000557 Assert(ETy->isPointerTy() &&
558 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
559 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000560 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000561 }
562 }
563
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000564 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000565 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000566 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
567 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000568 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000569 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
570 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000571 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000572 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000573 const Constant *Init = GV.getInitializer();
574 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000575 Assert(InitArray, "wrong initalizer for intrinsic global variable",
576 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000577 for (Value *Op : InitArray->operands()) {
578 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000579 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
580 isa<GlobalAlias>(V),
581 "invalid llvm.used member", V);
582 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000583 }
584 }
585 }
586 }
587
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000588 Assert(!GV.hasDLLImportStorageClass() ||
589 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
590 GV.hasAvailableExternallyLinkage(),
591 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000592
Matt Arsenault24b49c42013-07-31 17:49:08 +0000593 if (!GV.hasInitializer()) {
594 visitGlobalValue(GV);
595 return;
596 }
597
598 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000599 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000600
Chris Lattnere3400652004-12-15 20:23:49 +0000601 visitGlobalValue(GV);
602}
603
Rafael Espindola64c1e182014-06-03 02:41:57 +0000604void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
605 SmallPtrSet<const GlobalAlias*, 4> Visited;
606 Visited.insert(&GA);
607 visitAliaseeSubExpr(Visited, GA, C);
608}
609
Craig Topper71b7b682014-08-21 05:55:13 +0000610void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000611 const GlobalAlias &GA, const Constant &C) {
612 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000613 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
614 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000615
616 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000617 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000618
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000619 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
620 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000621 } else {
622 // Only continue verifying subexpressions of GlobalAliases.
623 // Do not recurse into global initializers.
624 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000625 }
626 }
627
628 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000629 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000630
631 for (const Use &U : C.operands()) {
632 Value *V = &*U;
633 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
634 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
635 else if (const auto *C2 = dyn_cast<Constant>(V))
636 visitAliaseeSubExpr(Visited, GA, *C2);
637 }
638}
639
Chandler Carruth043949d2014-01-19 02:22:18 +0000640void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000641 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
642 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
643 "weak_odr, or external linkage!",
644 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000645 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000646 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
647 Assert(GA.getType() == Aliasee->getType(),
648 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000649
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000650 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
651 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000652
Rafael Espindola64c1e182014-06-03 02:41:57 +0000653 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000654
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000655 visitGlobalValue(GA);
656}
657
Chandler Carruth043949d2014-01-19 02:22:18 +0000658void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000659 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000660 if (NMD.getName() == "llvm.dbg.cu") {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000661 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000662 }
663
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000664 if (!MD)
665 continue;
666
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000667 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000668 }
669}
670
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000671void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000672 // Only visit each node once. Metadata can be mutually recursive, so this
673 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000674 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000675 return;
676
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000677 switch (MD.getMetadataID()) {
678 default:
679 llvm_unreachable("Invalid MDNode subclass");
680 case Metadata::MDTupleKind:
681 break;
682#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
683 case Metadata::CLASS##Kind: \
684 visit##CLASS(cast<CLASS>(MD)); \
685 break;
686#include "llvm/IR/Metadata.def"
687 }
688
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000689 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000690 if (!Op)
691 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000692 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
693 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000694 if (auto *N = dyn_cast<MDNode>(Op)) {
695 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000696 continue;
697 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000698 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
699 visitValueAsMetadata(*V, nullptr);
700 continue;
701 }
Duncan Sands76d62172010-04-29 16:10:30 +0000702 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000703
704 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000705 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
706 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000707}
708
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000709void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000710 Assert(MD.getValue(), "Expected valid value", &MD);
711 Assert(!MD.getValue()->getType()->isMetadataTy(),
712 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000713
714 auto *L = dyn_cast<LocalAsMetadata>(&MD);
715 if (!L)
716 return;
717
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000718 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000719
720 // If this was an instruction, bb, or argument, verify that it is in the
721 // function that we expect.
722 Function *ActualF = nullptr;
723 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000724 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000725 ActualF = I->getParent()->getParent();
726 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
727 ActualF = BB->getParent();
728 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
729 ActualF = A->getParent();
730 assert(ActualF && "Unimplemented function local metadata case!");
731
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000732 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000733}
734
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000735void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000736 Metadata *MD = MDV.getMetadata();
737 if (auto *N = dyn_cast<MDNode>(MD)) {
738 visitMDNode(*N);
739 return;
740 }
741
742 // Only visit each node once. Metadata can be mutually recursive, so this
743 // avoids infinite recursion here, as well as being an optimization.
744 if (!MDNodes.insert(MD).second)
745 return;
746
747 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
748 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000749}
750
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000751bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
752 auto *S = dyn_cast<MDString>(MD);
753 if (!S)
754 return false;
755 if (S->getString().empty())
756 return false;
757
758 // Keep track of names of types referenced via UUID so we can check that they
759 // actually exist.
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000760 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000761 return true;
762}
763
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000764/// \brief Check if a value can be a reference to a type.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000765bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000766 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000767}
768
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000769/// \brief Check if a value can be a ScopeRef.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000770bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000771 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000772}
773
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000774/// \brief Check if a value can be a debug info ref.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000775bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000776 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000777}
778
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000779template <class Ty>
780bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
781 for (Metadata *MD : N.operands()) {
782 if (MD) {
783 if (!isa<Ty>(MD))
784 return false;
785 } else {
786 if (!AllowNull)
787 return false;
788 }
789 }
790 return true;
791}
792
793template <class Ty>
794bool isValidMetadataArray(const MDTuple &N) {
795 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
796}
797
798template <class Ty>
799bool isValidMetadataNullArray(const MDTuple &N) {
800 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
801}
802
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000803void Verifier::visitDILocation(const DILocation &N) {
804 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000805 "location requires a valid scope", &N, N.getRawScope());
806 if (auto *IA = N.getRawInlinedAt())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000807 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000808}
809
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000810void Verifier::visitGenericDINode(const GenericDINode &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000811 Assert(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000812}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000813
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000814void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000815 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000816 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000817}
818
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000819void Verifier::visitDISubrange(const DISubrange &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000820 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000821 Assert(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000822}
823
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000824void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000825 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000826}
827
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000828void Verifier::visitDIBasicType(const DIBasicType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000829 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
830 N.getTag() == dwarf::DW_TAG_unspecified_type,
831 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000832}
833
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000834void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000835 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000836 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000837
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000838 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
839 N.getTag() == dwarf::DW_TAG_pointer_type ||
840 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
841 N.getTag() == dwarf::DW_TAG_reference_type ||
842 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
843 N.getTag() == dwarf::DW_TAG_const_type ||
844 N.getTag() == dwarf::DW_TAG_volatile_type ||
845 N.getTag() == dwarf::DW_TAG_restrict_type ||
846 N.getTag() == dwarf::DW_TAG_member ||
847 N.getTag() == dwarf::DW_TAG_inheritance ||
848 N.getTag() == dwarf::DW_TAG_friend,
849 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000850 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000851 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
852 N.getExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000853 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000854
855 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
856 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
857 N.getBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000858}
859
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000860static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000861 return (Flags & DINode::FlagLValueReference) &&
862 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000863}
864
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000865void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
866 auto *Params = dyn_cast<MDTuple>(&RawParams);
867 Assert(Params, "invalid template params", &N, &RawParams);
868 for (Metadata *Op : Params->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000869 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000870 Params, Op);
871 }
872}
873
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000874void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000875 // Common scope checks.
876 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000877
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000878 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
879 N.getTag() == dwarf::DW_TAG_structure_type ||
880 N.getTag() == dwarf::DW_TAG_union_type ||
881 N.getTag() == dwarf::DW_TAG_enumeration_type ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000882 N.getTag() == dwarf::DW_TAG_class_type,
883 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000884
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000885 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
886 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
887 N.getBaseType());
888
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000889 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
890 "invalid composite elements", &N, N.getRawElements());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000891 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000892 N.getRawVTableHolder());
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000893 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
894 &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000895 if (auto *Params = N.getRawTemplateParams())
896 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000897
898 if (N.getTag() == dwarf::DW_TAG_class_type ||
899 N.getTag() == dwarf::DW_TAG_union_type) {
900 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
901 "class/union requires a filename", &N, N.getFile());
902 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000903}
904
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000905void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000906 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000907 if (auto *Types = N.getRawTypeArray()) {
908 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
909 for (Metadata *Ty : N.getTypeArray()->operands()) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000910 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000911 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000912 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000913 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
914 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000915}
916
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000917void Verifier::visitDIFile(const DIFile &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000918 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000919}
920
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000921void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000922 Assert(N.isDistinct(), "compile units must be distinct", &N);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000923 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000924
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000925 // Don't bother verifying the compilation directory or producer string
926 // as those could be empty.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000927 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
928 N.getRawFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000929 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
930 N.getFile());
931
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000932 if (auto *Array = N.getRawEnumTypes()) {
933 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
934 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000935 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000936 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
937 "invalid enum type", &N, N.getEnumTypes(), Op);
938 }
939 }
940 if (auto *Array = N.getRawRetainedTypes()) {
941 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
942 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000943 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000944 }
945 }
946 if (auto *Array = N.getRawSubprograms()) {
947 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
948 for (Metadata *Op : N.getSubprograms()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000949 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000950 }
951 }
952 if (auto *Array = N.getRawGlobalVariables()) {
953 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
954 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000955 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000956 Op);
957 }
958 }
959 if (auto *Array = N.getRawImportedEntities()) {
960 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
961 for (Metadata *Op : N.getImportedEntities()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000962 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000963 Op);
964 }
965 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000966 if (auto *Array = N.getRawMacros()) {
967 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
968 for (Metadata *Op : N.getMacros()->operands()) {
969 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
970 }
971 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000972}
973
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000974void Verifier::visitDISubprogram(const DISubprogram &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000975 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000976 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000977 if (auto *T = N.getRawType())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000978 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000979 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000980 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000981 if (auto *Params = N.getRawTemplateParams())
982 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000983 if (auto *S = N.getRawDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000984 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000985 "invalid subprogram declaration", &N, S);
986 }
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000987 if (auto *RawVars = N.getRawVariables()) {
988 auto *Vars = dyn_cast<MDTuple>(RawVars);
989 Assert(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000990 for (Metadata *Op : Vars->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000991 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000992 Op);
993 }
994 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000995 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
996 &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +0000997
Duncan P. N. Exon Smith814b8e92015-08-28 20:26:49 +0000998 if (N.isDefinition())
999 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001000}
1001
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001002void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001003 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001004 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001005 "invalid local scope", &N, N.getRawScope());
1006}
1007
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001008void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1009 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001010
1011 Assert(N.getLine() || !N.getColumn(),
1012 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001013}
1014
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001015void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1016 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001017}
1018
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001019void Verifier::visitDINamespace(const DINamespace &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001020 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001021 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001022 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001023}
1024
Amjad Abouda9bcf162015-12-10 12:56:35 +00001025void Verifier::visitDIMacro(const DIMacro &N) {
1026 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1027 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1028 "invalid macinfo type", &N);
1029 Assert(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001030 if (!N.getValue().empty()) {
1031 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1032 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001033}
1034
1035void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1036 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1037 "invalid macinfo type", &N);
1038 if (auto *F = N.getRawFile())
1039 Assert(isa<DIFile>(F), "invalid file", &N, F);
1040
1041 if (auto *Array = N.getRawElements()) {
1042 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1043 for (Metadata *Op : N.getElements()->operands()) {
1044 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1045 }
1046 }
1047}
1048
Adrian Prantlab1243f2015-06-29 23:03:47 +00001049void Verifier::visitDIModule(const DIModule &N) {
1050 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1051 Assert(!N.getName().empty(), "anonymous module", &N);
1052}
1053
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001054void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001055 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001056}
1057
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001058void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1059 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001060
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001061 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1062 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001063}
1064
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001065void Verifier::visitDITemplateValueParameter(
1066 const DITemplateValueParameter &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_value_parameter ||
1070 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1071 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1072 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001073}
1074
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001075void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001076 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001077 Assert(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001078 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001079 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001080 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001081}
1082
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001083void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001084 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001085 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001086
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001087 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smith94d58f82015-03-31 01:28:22 +00001088 Assert(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001089 if (auto *V = N.getRawVariable()) {
1090 Assert(isa<ConstantAsMetadata>(V) &&
1091 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1092 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001093 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001094 }
1095 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001096 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001097 &N, Member);
1098 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001099}
1100
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001101void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001102 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001103 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001104
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +00001105 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001106 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001107 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001108}
1109
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001110void Verifier::visitDIExpression(const DIExpression &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001111 Assert(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001112}
1113
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001114void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001115 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001116 if (auto *T = N.getRawType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001117 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001118 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001119 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001120}
1121
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001122void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001123 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1124 N.getTag() == dwarf::DW_TAG_imported_declaration,
1125 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001126 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001127 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001128 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1129 N.getEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001130}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001131
David Majnemerdad0a642014-06-27 18:19:56 +00001132void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001133 // The Module is invalid if the GlobalValue has private linkage. Entities
1134 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001135 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001136 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1137 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001138}
1139
Chandler Carruth043949d2014-01-19 02:22:18 +00001140void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001141 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1142 if (!Idents)
1143 return;
1144
1145 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1146 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001147 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001148 Assert(N->getNumOperands() == 1,
1149 "incorrect number of operands in llvm.ident metadata", N);
1150 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1151 ("invalid value for llvm.ident metadata entry operand"
1152 "(the operand should be a string)"),
1153 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001154 }
1155}
1156
Chandler Carruth043949d2014-01-19 02:22:18 +00001157void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001158 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1159 if (!Flags) return;
1160
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001161 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001162 DenseMap<const MDString*, const MDNode*> SeenIDs;
1163 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001164 for (const MDNode *MDN : Flags->operands())
1165 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001166
1167 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001168 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001169 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001170 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001171
Chandler Carruth043949d2014-01-19 02:22:18 +00001172 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001173 if (!Op) {
1174 CheckFailed("invalid requirement on flag, flag is not present in module",
1175 Flag);
1176 continue;
1177 }
1178
1179 if (Op->getOperand(2) != ReqValue) {
1180 CheckFailed(("invalid requirement on flag, "
1181 "flag does not have the required value"),
1182 Flag);
1183 continue;
1184 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001185 }
1186}
1187
Chandler Carruth043949d2014-01-19 02:22:18 +00001188void
1189Verifier::visitModuleFlag(const MDNode *Op,
1190 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1191 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001192 // Each module flag should have three arguments, the merge behavior (a
1193 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001194 Assert(Op->getNumOperands() == 3,
1195 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001196 Module::ModFlagBehavior MFB;
1197 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001198 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001199 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001200 "invalid behavior operand in module flag (expected constant integer)",
1201 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001202 Assert(false,
1203 "invalid behavior operand in module flag (unexpected constant)",
1204 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001205 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001206 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001207 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1208 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001209
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001210 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001211 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001212 case Module::Error:
1213 case Module::Warning:
1214 case Module::Override:
1215 // These behavior types accept any value.
1216 break;
1217
1218 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001219 // The value should itself be an MDNode with two operands, a flag ID (an
1220 // MDString), and a value.
1221 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001222 Assert(Value && Value->getNumOperands() == 2,
1223 "invalid value for 'require' module flag (expected metadata pair)",
1224 Op->getOperand(2));
1225 Assert(isa<MDString>(Value->getOperand(0)),
1226 ("invalid value for 'require' module flag "
1227 "(first value operand should be a string)"),
1228 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001229
1230 // Append it to the list of requirements, to check once all module flags are
1231 // scanned.
1232 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001233 break;
1234 }
1235
1236 case Module::Append:
1237 case Module::AppendUnique: {
1238 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001239 Assert(isa<MDNode>(Op->getOperand(2)),
1240 "invalid value for 'append'-type module flag "
1241 "(expected a metadata node)",
1242 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001243 break;
1244 }
1245 }
1246
1247 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001248 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001249 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001250 Assert(Inserted,
1251 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001252 }
1253}
1254
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001255void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001256 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001257 unsigned Slot = ~0U;
1258 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1259 if (Attrs.getSlotIndex(I) == Idx) {
1260 Slot = I;
1261 break;
1262 }
1263
1264 assert(Slot != ~0U && "Attribute set inconsistency!");
1265
1266 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1267 I != E; ++I) {
1268 if (I->isStringAttribute())
1269 continue;
1270
1271 if (I->getKindAsEnum() == Attribute::NoReturn ||
1272 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001273 I->getKindAsEnum() == Attribute::NoInline ||
1274 I->getKindAsEnum() == Attribute::AlwaysInline ||
1275 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1276 I->getKindAsEnum() == Attribute::StackProtect ||
1277 I->getKindAsEnum() == Attribute::StackProtectReq ||
1278 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001279 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001280 I->getKindAsEnum() == Attribute::NoRedZone ||
1281 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1282 I->getKindAsEnum() == Attribute::Naked ||
1283 I->getKindAsEnum() == Attribute::InlineHint ||
1284 I->getKindAsEnum() == Attribute::StackAlignment ||
1285 I->getKindAsEnum() == Attribute::UWTable ||
1286 I->getKindAsEnum() == Attribute::NonLazyBind ||
1287 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1288 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1289 I->getKindAsEnum() == Attribute::SanitizeThread ||
1290 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1291 I->getKindAsEnum() == Attribute::MinSize ||
1292 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001293 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001294 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001295 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001296 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001297 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001298 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001299 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001300 I->getKindAsEnum() == Attribute::NoRecurse ||
1301 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1302 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001303 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001304 CheckFailed("Attribute '" + I->getAsString() +
1305 "' only applies to functions!", V);
1306 return;
1307 }
1308 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1309 I->getKindAsEnum() == Attribute::ReadNone) {
1310 if (Idx == 0) {
1311 CheckFailed("Attribute '" + I->getAsString() +
1312 "' does not apply to function returns");
1313 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001314 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001315 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001316 CheckFailed("Attribute '" + I->getAsString() +
1317 "' does not apply to functions!", V);
1318 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001319 }
1320 }
1321}
1322
Duncan Sandsc3a79922009-06-11 08:11:03 +00001323// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001324// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001325void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001326 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001327 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001328 return;
1329
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001330 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001331
Bill Wendling908126a2012-10-09 09:51:10 +00001332 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001333 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1334 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1335 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1336 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1337 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1338 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1339 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1340 "'returned' do not apply to return values!",
1341 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001342
Reid Klecknera534a382013-12-19 02:14:12 +00001343 // Check for mutually incompatible attributes. Only inreg is compatible with
1344 // sret.
1345 unsigned AttrCount = 0;
1346 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1347 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1348 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1349 Attrs.hasAttribute(Idx, Attribute::InReg);
1350 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001351 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1352 "and 'sret' are incompatible!",
1353 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001354
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001355 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1356 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1357 "Attributes "
1358 "'inalloca and readonly' are incompatible!",
1359 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001360
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001361 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1362 Attrs.hasAttribute(Idx, Attribute::Returned)),
1363 "Attributes "
1364 "'sret and returned' are incompatible!",
1365 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001366
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001367 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1368 Attrs.hasAttribute(Idx, Attribute::SExt)),
1369 "Attributes "
1370 "'zeroext and signext' are incompatible!",
1371 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001372
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001373 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1374 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1375 "Attributes "
1376 "'readnone and readonly' are incompatible!",
1377 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001378
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001379 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1380 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1381 "Attributes "
1382 "'noinline and alwaysinline' are incompatible!",
1383 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001384
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001385 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001386 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001387 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001388 AttributeSet::get(*Context, Idx,
1389 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001390 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001391
Reid Klecknera534a382013-12-19 02:14:12 +00001392 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001393 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001394 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001395 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1396 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1397 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1398 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001399 }
1400 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001401 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1402 "Attribute 'byval' only applies to parameters with pointer type!",
1403 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001404 }
Duncan Sands0009c442008-01-12 16:42:01 +00001405}
1406
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001407// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001408// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001409void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001410 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001411 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001412 return;
1413
Duncan Sands8c582282007-12-21 19:19:01 +00001414 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001415 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001416 bool SawSRet = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001417
Chris Lattner8a923e72008-03-12 17:45:29 +00001418 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001419 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001420
Chris Lattner229907c2011-07-18 04:54:35 +00001421 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001422 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001423 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001424 else if (Idx-1 < FT->getNumParams())
1425 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001426 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001427 break; // VarArgs attributes, verified elsewhere.
1428
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001429 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001430
Stephen Linb8bd2322013-04-20 05:14:40 +00001431 if (Idx == 0)
1432 continue;
1433
1434 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001435 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001436 SawNest = true;
1437 }
1438
Stephen Linb8bd2322013-04-20 05:14:40 +00001439 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001440 Assert(!SawReturned, "More than one parameter has attribute returned!",
1441 V);
1442 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1443 "Incompatible "
1444 "argument and return types for 'returned' attribute",
1445 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001446 SawReturned = true;
1447 }
1448
Reid Kleckner79418562014-05-09 22:32:13 +00001449 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001450 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1451 Assert(Idx == 1 || Idx == 2,
1452 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001453 SawSRet = true;
1454 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001455
1456 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001457 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1458 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001459 }
Duncan Sands8c582282007-12-21 19:19:01 +00001460 }
Devang Patel9cc98122008-10-01 23:41:25 +00001461
Bill Wendling77543892013-01-18 21:11:39 +00001462 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1463 return;
1464
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001465 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001466
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001467 Assert(
1468 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1469 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1470 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001471
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001472 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001473 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1474 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1475 Attribute::InaccessibleMemOrArgMemOnly)),
1476 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1477
1478 Assert(
1479 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1480 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1481 Attribute::InaccessibleMemOnly)),
1482 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1483
1484 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001485 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1486 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1487 Attribute::AlwaysInline)),
1488 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001489
1490 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1491 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001492 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1493 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001494
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001495 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1496 Attribute::OptimizeForSize),
1497 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001498
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001499 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1500 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001501 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001502
1503 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1504 Attribute::JumpTable)) {
1505 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001506 Assert(GV->hasUnnamedAddr(),
1507 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001508 }
Duncan Sands8c582282007-12-21 19:19:01 +00001509}
1510
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001511void Verifier::verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +00001512 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1513 if (MDs.empty())
1514 return;
1515
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001516 for (const auto &Pair : MDs) {
1517 if (Pair.first == LLVMContext::MD_prof) {
1518 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001519 Assert(MD->getNumOperands() == 2,
1520 "!prof annotations should have exactly 2 operands", MD);
1521
1522 // Check first operand.
1523 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1524 MD);
1525 Assert(isa<MDString>(MD->getOperand(0)),
1526 "expected string with name of the !prof annotation", MD);
1527 MDString *MDS = cast<MDString>(MD->getOperand(0));
1528 StringRef ProfName = MDS->getString();
1529 Assert(ProfName.equals("function_entry_count"),
1530 "first operand should be 'function_entry_count'", MD);
1531
1532 // Check second operand.
1533 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1534 MD);
1535 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1536 "expected integer argument to function_entry_count", MD);
1537 }
1538 }
1539}
1540
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001541void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1542 if (!ConstantExprVisited.insert(EntryC).second)
1543 return;
1544
1545 SmallVector<const Constant *, 16> Stack;
1546 Stack.push_back(EntryC);
1547
1548 while (!Stack.empty()) {
1549 const Constant *C = Stack.pop_back_val();
1550
1551 // Check this constant expression.
1552 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1553 visitConstantExpr(CE);
1554
Keno Fischerf6d17b92016-01-14 22:42:02 +00001555 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1556 // Global Values get visited separately, but we do need to make sure
1557 // that the global value is in the correct module
1558 Assert(GV->getParent() == M, "Referencing global in another module!",
1559 EntryC, M, GV, GV->getParent());
1560 continue;
1561 }
1562
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001563 // Visit all sub-expressions.
1564 for (const Use &U : C->operands()) {
1565 const auto *OpC = dyn_cast<Constant>(U);
1566 if (!OpC)
1567 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001568 if (!ConstantExprVisited.insert(OpC).second)
1569 continue;
1570 Stack.push_back(OpC);
1571 }
1572 }
1573}
1574
1575void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001576 if (CE->getOpcode() != Instruction::BitCast)
1577 return;
1578
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001579 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1580 CE->getType()),
1581 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001582}
1583
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001584bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001585 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001586 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001587
Devang Patel82fed672008-09-23 22:35:17 +00001588 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001589 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001590 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001591 || (LastIndex == AttributeSet::FunctionIndex
1592 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001593 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001594
Devang Patel82fed672008-09-23 22:35:17 +00001595 return false;
1596}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001597
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001598/// Verify that statepoint intrinsic is well formed.
1599void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001600 assert(CS.getCalledFunction() &&
1601 CS.getCalledFunction()->getIntrinsicID() ==
1602 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001603
Philip Reames0285c742015-02-03 23:18:47 +00001604 const Instruction &CI = *CS.getInstruction();
1605
Igor Laevsky39d662f2015-07-11 10:30:36 +00001606 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1607 !CS.onlyAccessesArgMemory(),
1608 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001609 "reordering restrictions required by safepoint semantics",
1610 &CI);
1611
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001612 const Value *IDV = CS.getArgument(0);
1613 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1614 &CI);
1615
1616 const Value *NumPatchBytesV = CS.getArgument(1);
1617 Assert(isa<ConstantInt>(NumPatchBytesV),
1618 "gc.statepoint number of patchable bytes must be a constant integer",
1619 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001620 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001621 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1622 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1623 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1624 "positive",
1625 &CI);
1626
1627 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001628 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001629 Assert(PT && PT->getElementType()->isFunctionTy(),
1630 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001631 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001632
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001633 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001634 Assert(isa<ConstantInt>(NumCallArgsV),
1635 "gc.statepoint number of arguments to underlying call "
1636 "must be constant integer",
1637 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001638 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001639 Assert(NumCallArgs >= 0,
1640 "gc.statepoint number of arguments to underlying call "
1641 "must be positive",
1642 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001643 const int NumParams = (int)TargetFuncType->getNumParams();
1644 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001645 Assert(NumCallArgs >= NumParams,
1646 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001647
1648 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001649 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1650 "gc.statepoint doesn't support wrapping non-void "
1651 "vararg functions yet",
1652 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001653 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001654 Assert(NumCallArgs == NumParams,
1655 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001656
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001657 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001658 Assert(isa<ConstantInt>(FlagsV),
1659 "gc.statepoint flags must be constant integer", &CI);
1660 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1661 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1662 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001663
1664 // Verify that the types of the call parameter arguments match
1665 // the type of the wrapped callee.
1666 for (int i = 0; i < NumParams; i++) {
1667 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001668 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001669 Assert(ArgType == ParamType,
1670 "gc.statepoint call argument does not match wrapped "
1671 "function type",
1672 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001673 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001674
1675 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001676
1677 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1678 Assert(isa<ConstantInt>(NumTransitionArgsV),
1679 "gc.statepoint number of transition arguments "
1680 "must be constant integer",
1681 &CI);
1682 const int NumTransitionArgs =
1683 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1684 Assert(NumTransitionArgs >= 0,
1685 "gc.statepoint number of transition arguments must be positive", &CI);
1686 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1687
1688 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001689 Assert(isa<ConstantInt>(NumDeoptArgsV),
1690 "gc.statepoint number of deoptimization arguments "
1691 "must be constant integer",
1692 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001693 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001694 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1695 "must be positive",
1696 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001697
Pat Gavlincc0431d2015-05-08 18:07:42 +00001698 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001699 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001700 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001701 "gc.statepoint too few arguments according to length fields", &CI);
1702
Philip Reames1ffa9372015-01-30 23:28:05 +00001703 // Check that the only uses of this gc.statepoint are gc.result or
1704 // gc.relocate calls which are tied to this statepoint and thus part
1705 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001706 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001707 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001708 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001709 if (!Call) continue;
Manuel Jacob83eefa62016-01-05 04:03:00 +00001710 Assert(isa<GCRelocateInst>(Call) || isGCResult(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001711 "gc.result or gc.relocate are the only value uses"
1712 "of a gc.statepoint",
1713 &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001714 if (isGCResult(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001715 Assert(Call->getArgOperand(0) == &CI,
1716 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001717 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001718 Assert(Call->getArgOperand(0) == &CI,
1719 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001720 }
1721 }
1722
1723 // Note: It is legal for a single derived pointer to be listed multiple
1724 // times. It's non-optimal, but it is legal. It can also happen after
1725 // insertion if we strip a bitcast away.
1726 // Note: It is really tempting to check that each base is relocated and
1727 // that a derived pointer is never reused as a base pointer. This turns
1728 // out to be problematic since optimizations run after safepoint insertion
1729 // can recognize equality properties that the insertion logic doesn't know
1730 // about. See example statepoint.ll in the verifier subdirectory
1731}
1732
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001733void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001734 for (auto &Counts : FrameEscapeInfo) {
1735 Function *F = Counts.first;
1736 unsigned EscapedObjectCount = Counts.second.first;
1737 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001738 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001739 "all indices passed to llvm.localrecover must be less than the "
1740 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001741 "function",
1742 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001743 }
1744}
1745
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001746static Instruction *getSuccPad(TerminatorInst *Terminator) {
1747 BasicBlock *UnwindDest;
1748 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1749 UnwindDest = II->getUnwindDest();
1750 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1751 UnwindDest = CSI->getUnwindDest();
1752 else
1753 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1754 return UnwindDest->getFirstNonPHI();
1755}
1756
1757void Verifier::verifySiblingFuncletUnwinds() {
1758 SmallPtrSet<Instruction *, 8> Visited;
1759 SmallPtrSet<Instruction *, 8> Active;
1760 for (const auto &Pair : SiblingFuncletInfo) {
1761 Instruction *PredPad = Pair.first;
1762 if (Visited.count(PredPad))
1763 continue;
1764 Active.insert(PredPad);
1765 TerminatorInst *Terminator = Pair.second;
1766 do {
1767 Instruction *SuccPad = getSuccPad(Terminator);
1768 if (Active.count(SuccPad)) {
1769 // Found a cycle; report error
1770 Instruction *CyclePad = SuccPad;
1771 SmallVector<Instruction *, 8> CycleNodes;
1772 do {
1773 CycleNodes.push_back(CyclePad);
1774 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1775 if (CycleTerminator != CyclePad)
1776 CycleNodes.push_back(CycleTerminator);
1777 CyclePad = getSuccPad(CycleTerminator);
1778 } while (CyclePad != SuccPad);
1779 Assert(false, "EH pads can't handle each other's exceptions",
1780 ArrayRef<Instruction *>(CycleNodes));
1781 }
1782 // Don't re-walk a node we've already checked
1783 if (!Visited.insert(SuccPad).second)
1784 break;
1785 // Walk to this successor if it has a map entry.
1786 PredPad = SuccPad;
1787 auto TermI = SiblingFuncletInfo.find(PredPad);
1788 if (TermI == SiblingFuncletInfo.end())
1789 break;
1790 Terminator = TermI->second;
1791 Active.insert(PredPad);
1792 } while (true);
1793 // Each node only has one successor, so we've walked all the active
1794 // nodes' successors.
1795 Active.clear();
1796 }
1797}
1798
Chris Lattner0e851da2002-04-18 20:37:37 +00001799// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001800//
Chandler Carruth043949d2014-01-19 02:22:18 +00001801void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001802 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001803 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001804 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001805
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001806 Assert(Context == &F.getContext(),
1807 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001808
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001809 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1810 Assert(FT->getNumParams() == NumArgs,
1811 "# formal arguments must match # of arguments for function type!", &F,
1812 FT);
1813 Assert(F.getReturnType()->isFirstClassType() ||
1814 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1815 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001816
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001817 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1818 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001819
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001820 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001821
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001822 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001823 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001824
Duncan Sands8c582282007-12-21 19:19:01 +00001825 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001826 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001827
Michael Gottesman41748d72013-06-27 00:25:01 +00001828 // On function declarations/definitions, we do not support the builtin
1829 // attribute. We do not check this in VerifyFunctionAttrs since that is
1830 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001831 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1832 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001833
Chris Lattneref13ee32006-05-19 21:25:17 +00001834 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001835 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1836 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001837 switch (F.getCallingConv()) {
1838 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001839 case CallingConv::C:
1840 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001841 case CallingConv::Fast:
1842 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001843 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001844 case CallingConv::PTX_Kernel:
1845 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001846 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1847 "perfect forwarding!",
1848 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001849 break;
1850 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001851
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001852 bool isLLVMdotName = F.getName().size() >= 5 &&
1853 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001854
Chris Lattneraf95e582002-04-13 22:48:46 +00001855 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001856 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001857 for (const Argument &Arg : F.args()) {
1858 Assert(Arg.getType() == FT->getParamType(i),
1859 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001860 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001861 Assert(Arg.getType()->isFirstClassType(),
1862 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001863 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001864 Assert(!Arg.getType()->isMetadataTy(),
1865 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1866 Assert(!Arg.getType()->isTokenTy(),
1867 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001868 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001869 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001870 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001871
David Majnemerb611e3f2015-08-14 05:09:07 +00001872 if (!isLLVMdotName)
1873 Assert(!F.getReturnType()->isTokenTy(),
1874 "Functions returns a token but isn't an intrinsic", &F);
1875
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001876 // Get the function metadata attachments.
1877 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1878 F.getAllMetadata(MDs);
1879 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001880 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001881
Keno Fischer2ac0c272015-11-16 05:13:30 +00001882 // Check validity of the personality function
1883 if (F.hasPersonalityFn()) {
1884 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1885 if (Per)
1886 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001887 "Referencing personality function in another module!",
1888 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001889 }
1890
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001891 if (F.isMaterializable()) {
1892 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001893 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1894 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001895 } else if (F.isDeclaration()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001896 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1897 "invalid linkage type for function declaration", &F);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001898 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1899 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001900 Assert(!F.hasPersonalityFn(),
1901 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001902 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001903 // Verify that this function (which has a body) is not named "llvm.*". It
1904 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001905 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001906
Chris Lattner149376d2002-10-13 20:57:00 +00001907 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001908 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001909 Assert(pred_empty(Entry),
1910 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001911
Chris Lattner27471742009-11-01 04:08:01 +00001912 // The address of the entry block cannot be taken, unless it is dead.
1913 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001914 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1915 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001916 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001917
1918 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001919 for (const auto &I : MDs) {
1920 // Verify that the attachment is legal.
1921 switch (I.first) {
1922 default:
1923 break;
1924 case LLVMContext::MD_dbg:
1925 Assert(isa<DISubprogram>(I.second),
1926 "function !dbg attachment must be a subprogram", &F, I.second);
1927 break;
1928 }
1929
1930 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001931 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001932 }
Chris Lattner149376d2002-10-13 20:57:00 +00001933 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001934
Chris Lattner7730dcc2009-09-11 17:05:29 +00001935 // If this function is actually an intrinsic, verify that it is only used in
1936 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00001937 // Only do this if the module is materialized, otherwise we don't have all the
1938 // uses.
1939 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001940 const User *U;
1941 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001942 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00001943 }
Nico Rieck7157bb72014-01-14 15:22:47 +00001944
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001945 Assert(!F.hasDLLImportStorageClass() ||
1946 (F.isDeclaration() && F.hasExternalLinkage()) ||
1947 F.hasAvailableExternallyLinkage(),
1948 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00001949
1950 auto *N = F.getSubprogram();
1951 if (!N)
1952 return;
1953
1954 // Check that all !dbg attachments lead to back to N (or, at least, another
1955 // subprogram that describes the same function).
1956 //
1957 // FIXME: Check this incrementally while visiting !dbg attachments.
1958 // FIXME: Only check when N is the canonical subprogram for F.
1959 SmallPtrSet<const MDNode *, 32> Seen;
1960 for (auto &BB : F)
1961 for (auto &I : BB) {
1962 // Be careful about using DILocation here since we might be dealing with
1963 // broken code (this is the Verifier after all).
1964 DILocation *DL =
1965 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1966 if (!DL)
1967 continue;
1968 if (!Seen.insert(DL).second)
1969 continue;
1970
1971 DILocalScope *Scope = DL->getInlinedAtScope();
1972 if (Scope && !Seen.insert(Scope).second)
1973 continue;
1974
1975 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00001976
1977 // Scope and SP could be the same MDNode and we don't want to skip
1978 // validation in that case
1979 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00001980 continue;
1981
1982 // FIXME: Once N is canonical, check "SP == &N".
1983 Assert(SP->describes(&F),
1984 "!dbg attachment points at wrong subprogram for function", N, &F,
1985 &I, DL, Scope, SP);
1986 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001987}
1988
Chris Lattner0e851da2002-04-18 20:37:37 +00001989// verifyBasicBlock - Verify that a basic block is well formed...
1990//
Chris Lattner069a7952002-06-25 15:56:27 +00001991void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00001992 InstsInThisBlock.clear();
1993
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00001994 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001995 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00001996
Chris Lattnerdf9779c2003-10-05 17:44:18 +00001997 // Check constraints that this basic block imposes on all of the PHI nodes in
1998 // it.
1999 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002000 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2001 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002002 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002003 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002004 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002005 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002006 Assert(PN->getNumIncomingValues() != 0,
2007 "PHI nodes must have at least one entry. If the block is dead, "
2008 "the PHI should be removed!",
2009 PN);
2010 Assert(PN->getNumIncomingValues() == Preds.size(),
2011 "PHINode should have one entry for each predecessor of its "
2012 "parent basic block!",
2013 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002014
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002015 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002016 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002017 Values.reserve(PN->getNumIncomingValues());
2018 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2019 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2020 PN->getIncomingValue(i)));
2021 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002022
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002023 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2024 // Check to make sure that if there is more than one entry for a
2025 // particular basic block in this PHI node, that the incoming values are
2026 // all identical.
2027 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002028 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2029 Values[i].second == Values[i - 1].second,
2030 "PHI node has multiple entries for the same basic block with "
2031 "different incoming values!",
2032 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002033
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002034 // Check to make sure that the predecessors and PHI node entries are
2035 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002036 Assert(Values[i].first == Preds[i],
2037 "PHI node entries do not match predecessors!", PN,
2038 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002039 }
2040 }
2041 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002042
2043 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002044 for (auto &I : BB)
2045 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002046 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002047 }
Chris Lattner069a7952002-06-25 15:56:27 +00002048}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002049
Chris Lattner069a7952002-06-25 15:56:27 +00002050void Verifier::visitTerminatorInst(TerminatorInst &I) {
2051 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002052 Assert(&I == I.getParent()->getTerminator(),
2053 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002054 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002055}
2056
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002057void Verifier::visitBranchInst(BranchInst &BI) {
2058 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002059 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2060 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002061 }
2062 visitTerminatorInst(BI);
2063}
2064
Chris Lattner069a7952002-06-25 15:56:27 +00002065void Verifier::visitReturnInst(ReturnInst &RI) {
2066 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002067 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002068 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002069 Assert(N == 0,
2070 "Found return instr that returns non-void in Function of void "
2071 "return type!",
2072 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002073 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002074 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2075 "Function return type does not match operand "
2076 "type of return inst!",
2077 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002078
Misha Brukman7eb05a12003-08-18 14:43:39 +00002079 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002080 // terminators...
2081 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002082}
2083
Chris Lattnerab5aa142004-05-21 16:47:21 +00002084void Verifier::visitSwitchInst(SwitchInst &SI) {
2085 // Check to make sure that all of the constants in the switch instruction
2086 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002087 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002088 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002089 for (auto &Case : SI.cases()) {
2090 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002091 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002092 Assert(Constants.insert(Case.getCaseValue()).second,
2093 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002094 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002095
Chris Lattnerab5aa142004-05-21 16:47:21 +00002096 visitTerminatorInst(SI);
2097}
2098
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002099void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002100 Assert(BI.getAddress()->getType()->isPointerTy(),
2101 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002102 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002103 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2104 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002105
2106 visitTerminatorInst(BI);
2107}
2108
Chris Lattner75648e72004-03-12 05:54:31 +00002109void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002110 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2111 SI.getOperand(2)),
2112 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002113
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002114 Assert(SI.getTrueValue()->getType() == SI.getType(),
2115 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002116 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002117}
2118
Misha Brukmanc566ca362004-03-02 00:22:19 +00002119/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2120/// a pass, if any exist, it's an error.
2121///
Chris Lattner903a25d2002-11-21 16:54:22 +00002122void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002123 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002124}
Chris Lattner0e851da2002-04-18 20:37:37 +00002125
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002126void Verifier::visitTruncInst(TruncInst &I) {
2127 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002128 Type *SrcTy = I.getOperand(0)->getType();
2129 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002130
2131 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002132 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2133 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002134
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002135 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2136 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2137 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2138 "trunc source and destination must both be a vector or neither", &I);
2139 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002140
2141 visitInstruction(I);
2142}
2143
2144void Verifier::visitZExtInst(ZExtInst &I) {
2145 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002146 Type *SrcTy = I.getOperand(0)->getType();
2147 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002148
2149 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002150 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2151 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2152 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2153 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002154 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2155 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002156
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002157 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002158
2159 visitInstruction(I);
2160}
2161
2162void Verifier::visitSExtInst(SExtInst &I) {
2163 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002164 Type *SrcTy = I.getOperand(0)->getType();
2165 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002166
2167 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002168 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2169 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002170
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002171 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2172 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2173 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2174 "sext source and destination must both be a vector or neither", &I);
2175 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002176
2177 visitInstruction(I);
2178}
2179
2180void Verifier::visitFPTruncInst(FPTruncInst &I) {
2181 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002182 Type *SrcTy = I.getOperand(0)->getType();
2183 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002184 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002185 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2186 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002187
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002188 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2189 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2190 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2191 "fptrunc source and destination must both be a vector or neither", &I);
2192 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002193
2194 visitInstruction(I);
2195}
2196
2197void Verifier::visitFPExtInst(FPExtInst &I) {
2198 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002199 Type *SrcTy = I.getOperand(0)->getType();
2200 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002201
2202 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002203 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2204 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002205
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002206 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2207 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2208 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2209 "fpext source and destination must both be a vector or neither", &I);
2210 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002211
2212 visitInstruction(I);
2213}
2214
2215void Verifier::visitUIToFPInst(UIToFPInst &I) {
2216 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002217 Type *SrcTy = I.getOperand(0)->getType();
2218 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002219
Duncan Sands19d0b472010-02-16 11:11:14 +00002220 bool SrcVec = SrcTy->isVectorTy();
2221 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002222
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002223 Assert(SrcVec == DstVec,
2224 "UIToFP source and dest must both be vector or scalar", &I);
2225 Assert(SrcTy->isIntOrIntVectorTy(),
2226 "UIToFP source must be integer or integer vector", &I);
2227 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2228 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002229
2230 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002231 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2232 cast<VectorType>(DestTy)->getNumElements(),
2233 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002234
2235 visitInstruction(I);
2236}
2237
2238void Verifier::visitSIToFPInst(SIToFPInst &I) {
2239 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002240 Type *SrcTy = I.getOperand(0)->getType();
2241 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002242
Duncan Sands19d0b472010-02-16 11:11:14 +00002243 bool SrcVec = SrcTy->isVectorTy();
2244 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002245
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002246 Assert(SrcVec == DstVec,
2247 "SIToFP source and dest must both be vector or scalar", &I);
2248 Assert(SrcTy->isIntOrIntVectorTy(),
2249 "SIToFP source must be integer or integer vector", &I);
2250 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2251 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002252
2253 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002254 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2255 cast<VectorType>(DestTy)->getNumElements(),
2256 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002257
2258 visitInstruction(I);
2259}
2260
2261void Verifier::visitFPToUIInst(FPToUIInst &I) {
2262 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002263 Type *SrcTy = I.getOperand(0)->getType();
2264 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002265
Duncan Sands19d0b472010-02-16 11:11:14 +00002266 bool SrcVec = SrcTy->isVectorTy();
2267 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002268
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002269 Assert(SrcVec == DstVec,
2270 "FPToUI source and dest must both be vector or scalar", &I);
2271 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2272 &I);
2273 Assert(DestTy->isIntOrIntVectorTy(),
2274 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002275
2276 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002277 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2278 cast<VectorType>(DestTy)->getNumElements(),
2279 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002280
2281 visitInstruction(I);
2282}
2283
2284void Verifier::visitFPToSIInst(FPToSIInst &I) {
2285 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002286 Type *SrcTy = I.getOperand(0)->getType();
2287 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002288
Duncan Sands19d0b472010-02-16 11:11:14 +00002289 bool SrcVec = SrcTy->isVectorTy();
2290 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002291
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002292 Assert(SrcVec == DstVec,
2293 "FPToSI source and dest must both be vector or scalar", &I);
2294 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2295 &I);
2296 Assert(DestTy->isIntOrIntVectorTy(),
2297 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002298
2299 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002300 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2301 cast<VectorType>(DestTy)->getNumElements(),
2302 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002303
2304 visitInstruction(I);
2305}
2306
2307void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2308 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002309 Type *SrcTy = I.getOperand(0)->getType();
2310 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002311
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002312 Assert(SrcTy->getScalarType()->isPointerTy(),
2313 "PtrToInt source must be pointer", &I);
2314 Assert(DestTy->getScalarType()->isIntegerTy(),
2315 "PtrToInt result must be integral", &I);
2316 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2317 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002318
2319 if (SrcTy->isVectorTy()) {
2320 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2321 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002322 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2323 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002324 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002325
2326 visitInstruction(I);
2327}
2328
2329void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2330 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002331 Type *SrcTy = I.getOperand(0)->getType();
2332 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002333
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002334 Assert(SrcTy->getScalarType()->isIntegerTy(),
2335 "IntToPtr source must be an integral", &I);
2336 Assert(DestTy->getScalarType()->isPointerTy(),
2337 "IntToPtr result must be a pointer", &I);
2338 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2339 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002340 if (SrcTy->isVectorTy()) {
2341 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2342 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002343 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2344 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002345 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002346 visitInstruction(I);
2347}
2348
2349void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002350 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002351 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2352 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002353 visitInstruction(I);
2354}
2355
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002356void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2357 Type *SrcTy = I.getOperand(0)->getType();
2358 Type *DestTy = I.getType();
2359
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002360 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2361 &I);
2362 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2363 &I);
2364 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2365 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002366 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002367 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2368 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002369 visitInstruction(I);
2370}
2371
Misha Brukmanc566ca362004-03-02 00:22:19 +00002372/// visitPHINode - Ensure that a PHI node is well formed.
2373///
Chris Lattner069a7952002-06-25 15:56:27 +00002374void Verifier::visitPHINode(PHINode &PN) {
2375 // Ensure that the PHI nodes are all grouped together at the top of the block.
2376 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002377 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002378 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002379 Assert(&PN == &PN.getParent()->front() ||
2380 isa<PHINode>(--BasicBlock::iterator(&PN)),
2381 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002382
David Majnemerb611e3f2015-08-14 05:09:07 +00002383 // Check that a PHI doesn't yield a Token.
2384 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2385
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002386 // Check that all of the values of the PHI node have the same type as the
2387 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002388 for (Value *IncValue : PN.incoming_values()) {
2389 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002390 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002391 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002392
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002393 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002394
2395 visitInstruction(PN);
2396}
2397
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002398void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002399 Instruction *I = CS.getInstruction();
2400
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002401 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2402 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002403 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002404
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002405 Assert(FPTy->getElementType()->isFunctionTy(),
2406 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002407
2408 Assert(FPTy->getElementType() == CS.getFunctionType(),
2409 "Called function is not the same type as the call!", I);
2410
2411 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002412
2413 // Verify that the correct number of arguments are being passed
2414 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002415 Assert(CS.arg_size() >= FTy->getNumParams(),
2416 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002417 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002418 Assert(CS.arg_size() == FTy->getNumParams(),
2419 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002420
Chris Lattner609de002010-05-10 20:58:42 +00002421 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002422 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002423 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2424 "Call parameter type does not match function signature!",
2425 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002426
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002427 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002428
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002429 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002430 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002431
Duncan Sands8c582282007-12-21 19:19:01 +00002432 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002433 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002434
David Majnemer91db08b2014-04-30 17:22:00 +00002435 // Conservatively check the inalloca argument.
2436 // We have a bug if we can find that there is an underlying alloca without
2437 // inalloca.
2438 if (CS.hasInAllocaArgument()) {
2439 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2440 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002441 Assert(AI->isUsedWithInAlloca(),
2442 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002443 }
2444
Stephen Linb8bd2322013-04-20 05:14:40 +00002445 if (FTy->isVarArg()) {
2446 // FIXME? is 'nest' even legal here?
2447 bool SawNest = false;
2448 bool SawReturned = false;
2449
2450 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2451 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2452 SawNest = true;
2453 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2454 SawReturned = true;
2455 }
2456
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002457 // Check attributes on the varargs part.
2458 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002459 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002460 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002461
Stephen Linb8bd2322013-04-20 05:14:40 +00002462 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002463 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002464 SawNest = true;
2465 }
2466
2467 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002468 Assert(!SawReturned, "More than one parameter has attribute returned!",
2469 I);
2470 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2471 "Incompatible argument and return types for 'returned' "
2472 "attribute",
2473 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002474 SawReturned = true;
2475 }
Duncan Sands0009c442008-01-12 16:42:01 +00002476
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002477 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2478 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002479
2480 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002481 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002482 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002483 }
Duncan Sands8c582282007-12-21 19:19:01 +00002484
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002485 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002486 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002487 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002488 for (Type *ParamTy : FTy->params()) {
2489 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002490 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002491 Assert(!ParamTy->isTokenTy(),
2492 "Function has token parameter but isn't an intrinsic", I);
2493 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002494 }
2495
David Majnemerb611e3f2015-08-14 05:09:07 +00002496 // Verify that indirect calls don't return tokens.
2497 if (CS.getCalledFunction() == nullptr)
2498 Assert(!FTy->getReturnType()->isTokenTy(),
2499 "Return type cannot be token for indirect call!");
2500
Philip Reamesa3c6f002015-06-26 21:39:44 +00002501 if (Function *F = CS.getCalledFunction())
2502 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002503 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002504
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002505 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2506 // at most one "gc-transition" operand bundle.
2507 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2508 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002509 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002510 OperandBundleUse BU = CS.getOperandBundleAt(i);
2511 uint32_t Tag = BU.getTagID();
2512 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002513 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2514 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002515 } else if (Tag == LLVMContext::OB_gc_transition) {
2516 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2517 I);
2518 FoundGCTransitionBundle = true;
2519 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002520 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2521 FoundFuncletBundle = true;
2522 Assert(BU.Inputs.size() == 1,
2523 "Expected exactly one funclet bundle operand", I);
2524 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2525 "Funclet bundle operands should correspond to a FuncletPadInst",
2526 I);
2527 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002528 }
2529
Duncan Sands8c582282007-12-21 19:19:01 +00002530 visitInstruction(*I);
2531}
2532
Reid Kleckner5772b772014-04-24 20:14:34 +00002533/// Two types are "congruent" if they are identical, or if they are both pointer
2534/// types with different pointee types and the same address space.
2535static bool isTypeCongruent(Type *L, Type *R) {
2536 if (L == R)
2537 return true;
2538 PointerType *PL = dyn_cast<PointerType>(L);
2539 PointerType *PR = dyn_cast<PointerType>(R);
2540 if (!PL || !PR)
2541 return false;
2542 return PL->getAddressSpace() == PR->getAddressSpace();
2543}
2544
Reid Klecknerd20c9702014-05-15 23:58:57 +00002545static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2546 static const Attribute::AttrKind ABIAttrs[] = {
2547 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2548 Attribute::InReg, Attribute::Returned};
2549 AttrBuilder Copy;
2550 for (auto AK : ABIAttrs) {
2551 if (Attrs.hasAttribute(I + 1, AK))
2552 Copy.addAttribute(AK);
2553 }
2554 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2555 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2556 return Copy;
2557}
2558
Reid Kleckner5772b772014-04-24 20:14:34 +00002559void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002560 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002561
2562 // - The caller and callee prototypes must match. Pointer types of
2563 // parameters or return types may differ in pointee type, but not
2564 // address space.
2565 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002566 FunctionType *CallerTy = F->getFunctionType();
2567 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002568 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2569 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2570 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2571 "cannot guarantee tail call due to mismatched varargs", &CI);
2572 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2573 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002574 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002575 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002576 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2577 "cannot guarantee tail call due to mismatched parameter types", &CI);
2578 }
2579
2580 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002581 Assert(F->getCallingConv() == CI.getCallingConv(),
2582 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002583
2584 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2585 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002586 AttributeSet CallerAttrs = F->getAttributes();
2587 AttributeSet CalleeAttrs = CI.getAttributes();
2588 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002589 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2590 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002591 Assert(CallerABIAttrs == CalleeABIAttrs,
2592 "cannot guarantee tail call due to mismatched ABI impacting "
2593 "function attributes",
2594 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002595 }
2596
2597 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2598 // or a pointer bitcast followed by a ret instruction.
2599 // - The ret instruction must return the (possibly bitcasted) value
2600 // produced by the call or void.
2601 Value *RetVal = &CI;
2602 Instruction *Next = CI.getNextNode();
2603
2604 // Handle the optional bitcast.
2605 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002606 Assert(BI->getOperand(0) == RetVal,
2607 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002608 RetVal = BI;
2609 Next = BI->getNextNode();
2610 }
2611
2612 // Check the return.
2613 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002614 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2615 &CI);
2616 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2617 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002618}
2619
Duncan Sands8c582282007-12-21 19:19:01 +00002620void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002621 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002622
Reid Kleckner5772b772014-04-24 20:14:34 +00002623 if (CI.isMustTailCall())
2624 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002625}
2626
2627void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002628 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002629
David Majnemer654e1302015-07-31 17:58:14 +00002630 // Verify that the first non-PHI instruction of the unwind destination is an
2631 // exception handling instruction.
2632 Assert(
2633 II.getUnwindDest()->isEHPad(),
2634 "The unwind destination does not have an exception handling instruction!",
2635 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002636
Dan Gohman9c6e1882010-08-02 23:09:14 +00002637 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002638}
Chris Lattner0e851da2002-04-18 20:37:37 +00002639
Misha Brukmanc566ca362004-03-02 00:22:19 +00002640/// visitBinaryOperator - Check that both arguments to the binary operator are
2641/// of the same type!
2642///
Chris Lattner069a7952002-06-25 15:56:27 +00002643void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002644 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2645 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002646
Reid Spencer2341c222007-02-02 02:16:23 +00002647 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002648 // Check that integer arithmetic operators are only used with
2649 // integral operands.
2650 case Instruction::Add:
2651 case Instruction::Sub:
2652 case Instruction::Mul:
2653 case Instruction::SDiv:
2654 case Instruction::UDiv:
2655 case Instruction::SRem:
2656 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002657 Assert(B.getType()->isIntOrIntVectorTy(),
2658 "Integer arithmetic operators only work with integral types!", &B);
2659 Assert(B.getType() == B.getOperand(0)->getType(),
2660 "Integer arithmetic operators must have same type "
2661 "for operands and result!",
2662 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002663 break;
2664 // Check that floating-point arithmetic operators are only used with
2665 // floating-point operands.
2666 case Instruction::FAdd:
2667 case Instruction::FSub:
2668 case Instruction::FMul:
2669 case Instruction::FDiv:
2670 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002671 Assert(B.getType()->isFPOrFPVectorTy(),
2672 "Floating-point arithmetic operators only work with "
2673 "floating-point types!",
2674 &B);
2675 Assert(B.getType() == B.getOperand(0)->getType(),
2676 "Floating-point arithmetic operators must have same type "
2677 "for operands and result!",
2678 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002679 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002680 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002681 case Instruction::And:
2682 case Instruction::Or:
2683 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002684 Assert(B.getType()->isIntOrIntVectorTy(),
2685 "Logical operators only work with integral types!", &B);
2686 Assert(B.getType() == B.getOperand(0)->getType(),
2687 "Logical operators must have same type for operands and result!",
2688 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002689 break;
2690 case Instruction::Shl:
2691 case Instruction::LShr:
2692 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002693 Assert(B.getType()->isIntOrIntVectorTy(),
2694 "Shifts only work with integral types!", &B);
2695 Assert(B.getType() == B.getOperand(0)->getType(),
2696 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002697 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002698 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002699 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002700 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002701
Chris Lattner0e851da2002-04-18 20:37:37 +00002702 visitInstruction(B);
2703}
2704
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002705void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002706 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002707 Type *Op0Ty = IC.getOperand(0)->getType();
2708 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002709 Assert(Op0Ty == Op1Ty,
2710 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002711 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002712 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2713 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002714 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002715 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2716 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2717 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002718
Reid Spencerd9436b62006-11-20 01:22:35 +00002719 visitInstruction(IC);
2720}
2721
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002722void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002723 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002724 Type *Op0Ty = FC.getOperand(0)->getType();
2725 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002726 Assert(Op0Ty == Op1Ty,
2727 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002728 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002729 Assert(Op0Ty->isFPOrFPVectorTy(),
2730 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002731 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002732 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2733 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2734 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002735
Reid Spencerd9436b62006-11-20 01:22:35 +00002736 visitInstruction(FC);
2737}
2738
Robert Bocchino23004482006-01-10 19:05:34 +00002739void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002740 Assert(
2741 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2742 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002743 visitInstruction(EI);
2744}
2745
Robert Bocchinoca27f032006-01-17 20:07:22 +00002746void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002747 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2748 IE.getOperand(2)),
2749 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002750 visitInstruction(IE);
2751}
2752
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002753void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002754 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2755 SV.getOperand(2)),
2756 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002757 visitInstruction(SV);
2758}
2759
Chris Lattner069a7952002-06-25 15:56:27 +00002760void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002761 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002762
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002763 Assert(isa<PointerType>(TargetTy),
2764 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002765 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002766 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002767 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002768 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002769 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002770
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002771 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002772 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002773 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002774
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002775 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002776 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002777 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2778 if (GEP.getPointerOperandType()->isVectorTy())
2779 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2780 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002781 for (Value *Idx : Idxs) {
2782 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002783 if (IndexTy->isVectorTy()) {
2784 unsigned IndexWidth = IndexTy->getVectorNumElements();
2785 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2786 }
2787 Assert(IndexTy->getScalarType()->isIntegerTy(),
2788 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002789 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002790 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002791 visitInstruction(GEP);
2792}
2793
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002794static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2795 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2796}
2797
Philip Reamesbf9676f2014-10-20 23:52:07 +00002798void Verifier::visitRangeMetadata(Instruction& I,
2799 MDNode* Range, Type* Ty) {
2800 assert(Range &&
2801 Range == I.getMetadata(LLVMContext::MD_range) &&
2802 "precondition violation");
2803
2804 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002805 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002806 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002807 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2808
Philip Reamesbf9676f2014-10-20 23:52:07 +00002809 ConstantRange LastRange(1); // Dummy initial value
2810 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002811 ConstantInt *Low =
2812 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002813 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002814 ConstantInt *High =
2815 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002816 Assert(High, "The upper limit must be an integer!", High);
2817 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2818 "Range types must match instruction type!", &I);
2819
Philip Reamesbf9676f2014-10-20 23:52:07 +00002820 APInt HighV = High->getValue();
2821 APInt LowV = Low->getValue();
2822 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002823 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2824 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002825 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002826 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2827 "Intervals are overlapping", Range);
2828 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2829 Range);
2830 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2831 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002832 }
2833 LastRange = ConstantRange(LowV, HighV);
2834 }
2835 if (NumRanges > 2) {
2836 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002837 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002838 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002839 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002840 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002841 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2842 "Intervals are overlapping", Range);
2843 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2844 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002845 }
2846}
2847
JF Bastiend1fb5852015-12-17 22:09:19 +00002848void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2849 const Instruction *I) {
2850 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2851 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2852 Assert(!(Size & (Size - 1)),
2853 "atomic memory access' operand must have a power-of-two size", Ty, I);
2854}
2855
Chris Lattner069a7952002-06-25 15:56:27 +00002856void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002857 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002858 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002859 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002860 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2861 "huge alignment values are unsupported", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002862 if (LI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002863 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2864 "Load cannot have Release ordering", &LI);
2865 Assert(LI.getAlignment() != 0,
2866 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002867 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2868 ElTy->isFloatingPointTy(),
2869 "atomic load operand must have integer, pointer, or floating point "
2870 "type!",
2871 ElTy, &LI);
2872 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002873 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002874 Assert(LI.getSynchScope() == CrossThread,
2875 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002876 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002877
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002878 visitInstruction(LI);
2879}
2880
Chris Lattner069a7952002-06-25 15:56:27 +00002881void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002882 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002883 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002884 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002885 Assert(ElTy == SI.getOperand(0)->getType(),
2886 "Stored value type does not match pointer operand type!", &SI, ElTy);
2887 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2888 "huge alignment values are unsupported", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002889 if (SI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002890 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2891 "Store cannot have Acquire ordering", &SI);
2892 Assert(SI.getAlignment() != 0,
2893 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002894 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2895 ElTy->isFloatingPointTy(),
2896 "atomic store operand must have integer, pointer, or floating point "
2897 "type!",
2898 ElTy, &SI);
2899 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002900 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002901 Assert(SI.getSynchScope() == CrossThread,
2902 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002903 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002904 visitInstruction(SI);
2905}
2906
Victor Hernandez8acf2952009-10-23 21:09:37 +00002907void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00002908 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00002909 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002910 Assert(PTy->getAddressSpace() == 0,
2911 "Allocation instruction pointer not in the generic address space!",
2912 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00002913 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002914 "Cannot allocate unsized type", &AI);
2915 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2916 "Alloca array size must have integer type", &AI);
2917 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2918 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00002919
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00002920 visitInstruction(AI);
2921}
2922
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002923void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00002924
2925 // FIXME: more conditions???
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002926 Assert(CXI.getSuccessOrdering() != NotAtomic,
2927 "cmpxchg instructions must be atomic.", &CXI);
2928 Assert(CXI.getFailureOrdering() != NotAtomic,
2929 "cmpxchg instructions must be atomic.", &CXI);
2930 Assert(CXI.getSuccessOrdering() != Unordered,
2931 "cmpxchg instructions cannot be unordered.", &CXI);
2932 Assert(CXI.getFailureOrdering() != Unordered,
2933 "cmpxchg instructions cannot be unordered.", &CXI);
2934 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2935 "cmpxchg instructions be at least as constrained on success as fail",
2936 &CXI);
2937 Assert(CXI.getFailureOrdering() != Release &&
2938 CXI.getFailureOrdering() != AcquireRelease,
2939 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00002940
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002941 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002942 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002943 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00002944 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
2945 "cmpxchg operand must have integer or pointer type",
2946 ElTy, &CXI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002947 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002948 Assert(ElTy == CXI.getOperand(1)->getType(),
2949 "Expected value type does not match pointer operand type!", &CXI,
2950 ElTy);
2951 Assert(ElTy == CXI.getOperand(2)->getType(),
2952 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002953 visitInstruction(CXI);
2954}
2955
2956void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002957 Assert(RMWI.getOrdering() != NotAtomic,
2958 "atomicrmw instructions must be atomic.", &RMWI);
2959 Assert(RMWI.getOrdering() != Unordered,
2960 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002961 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002962 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002963 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002964 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2965 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00002966 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002967 Assert(ElTy == RMWI.getOperand(1)->getType(),
2968 "Argument value type does not match pointer operand type!", &RMWI,
2969 ElTy);
2970 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2971 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2972 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002973 visitInstruction(RMWI);
2974}
2975
Eli Friedmanfee02c62011-07-25 23:16:38 +00002976void Verifier::visitFenceInst(FenceInst &FI) {
2977 const AtomicOrdering Ordering = FI.getOrdering();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002978 Assert(Ordering == Acquire || Ordering == Release ||
2979 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2980 "fence instructions may only have "
2981 "acquire, release, acq_rel, or seq_cst ordering.",
2982 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00002983 visitInstruction(FI);
2984}
2985
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002986void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002987 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2988 EVI.getIndices()) == EVI.getType(),
2989 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002990
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002991 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00002992}
2993
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002994void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002995 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2996 IVI.getIndices()) ==
2997 IVI.getOperand(1)->getType(),
2998 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002999
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003000 visitInstruction(IVI);
3001}
Chris Lattner0e851da2002-04-18 20:37:37 +00003002
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003003static Value *getParentPad(Value *EHPad) {
3004 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3005 return FPI->getParentPad();
3006
3007 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3008}
3009
David Majnemer85a549d2015-08-11 02:48:30 +00003010void Verifier::visitEHPadPredecessors(Instruction &I) {
3011 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003012
David Majnemer85a549d2015-08-11 02:48:30 +00003013 BasicBlock *BB = I.getParent();
3014 Function *F = BB->getParent();
3015
3016 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3017
3018 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3019 // The landingpad instruction defines its parent as a landing pad block. The
3020 // landing pad block may be branched to only by the unwind edge of an
3021 // invoke.
3022 for (BasicBlock *PredBB : predecessors(BB)) {
3023 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3024 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3025 "Block containing LandingPadInst must be jumped to "
3026 "only by the unwind edge of an invoke.",
3027 LPI);
3028 }
3029 return;
3030 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003031 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3032 if (!pred_empty(BB))
3033 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3034 "Block containg CatchPadInst must be jumped to "
3035 "only by its catchswitch.",
3036 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003037 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3038 "Catchswitch cannot unwind to one of its catchpads",
3039 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003040 return;
3041 }
David Majnemer85a549d2015-08-11 02:48:30 +00003042
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003043 // Verify that each pred has a legal terminator with a legal to/from EH
3044 // pad relationship.
3045 Instruction *ToPad = &I;
3046 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003047 for (BasicBlock *PredBB : predecessors(BB)) {
3048 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003049 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003050 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003051 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003052 "EH pad must be jumped to via an unwind edge", ToPad, II);
3053 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3054 FromPad = Bundle->Inputs[0];
3055 else
3056 FromPad = ConstantTokenNone::get(II->getContext());
3057 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
3058 FromPad = CRI->getCleanupPad();
3059 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3060 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3061 FromPad = CSI;
3062 } else {
3063 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3064 }
3065
3066 // The edge may exit from zero or more nested pads.
3067 for (;; FromPad = getParentPad(FromPad)) {
3068 Assert(FromPad != ToPad,
3069 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3070 if (FromPad == ToPadParent) {
3071 // This is a legal unwind edge.
3072 break;
3073 }
3074 Assert(!isa<ConstantTokenNone>(FromPad),
3075 "A single unwind edge may only enter one EH pad", TI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003076 }
David Majnemer85a549d2015-08-11 02:48:30 +00003077 }
3078}
3079
3080void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003081 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3082 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003083 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3084 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003085
David Majnemer85a549d2015-08-11 02:48:30 +00003086 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003087
David Majnemer654e1302015-07-31 17:58:14 +00003088 if (!LandingPadResultTy)
3089 LandingPadResultTy = LPI.getType();
3090 else
3091 Assert(LandingPadResultTy == LPI.getType(),
3092 "The landingpad instruction should have a consistent result type "
3093 "inside a function.",
3094 &LPI);
3095
David Majnemer7fddecc2015-06-17 20:52:32 +00003096 Function *F = LPI.getParent()->getParent();
3097 Assert(F->hasPersonalityFn(),
3098 "LandingPadInst needs to be in a function with a personality.", &LPI);
3099
Bill Wendlingfae14752011-08-12 20:24:12 +00003100 // The landingpad instruction must be the first non-PHI instruction in the
3101 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003102 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3103 "LandingPadInst not the first non-PHI instruction in the block.",
3104 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003105
Duncan Sands86de1a62011-09-27 16:43:19 +00003106 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003107 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003108 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003109 Assert(isa<PointerType>(Clause->getType()),
3110 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003111 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003112 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3113 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3114 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003115 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003116 }
3117
Bill Wendlingfae14752011-08-12 20:24:12 +00003118 visitInstruction(LPI);
3119}
3120
David Majnemer654e1302015-07-31 17:58:14 +00003121void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003122 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003123
David Majnemer654e1302015-07-31 17:58:14 +00003124 Function *F = BB->getParent();
3125 Assert(F->hasPersonalityFn(),
3126 "CatchPadInst needs to be in a function with a personality.", &CPI);
3127
David Majnemer8a1c45d2015-12-12 05:38:55 +00003128 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3129 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3130 CPI.getParentPad());
3131
David Majnemer654e1302015-07-31 17:58:14 +00003132 // The catchpad instruction must be the first non-PHI instruction in the
3133 // block.
3134 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003135 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003136
David Majnemerfe2f7f32016-02-29 22:56:36 +00003137 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003138 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003139}
3140
David Majnemer8a1c45d2015-12-12 05:38:55 +00003141void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3142 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3143 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3144 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003145
David Majnemer8a1c45d2015-12-12 05:38:55 +00003146 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003147}
3148
3149void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3150 BasicBlock *BB = CPI.getParent();
3151
David Majnemer654e1302015-07-31 17:58:14 +00003152 Function *F = BB->getParent();
3153 Assert(F->hasPersonalityFn(),
3154 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3155
3156 // The cleanuppad instruction must be the first non-PHI instruction in the
3157 // block.
3158 Assert(BB->getFirstNonPHI() == &CPI,
3159 "CleanupPadInst not the first non-PHI instruction in the block.",
3160 &CPI);
3161
David Majnemer8a1c45d2015-12-12 05:38:55 +00003162 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003163 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003164 "CleanupPadInst has an invalid parent.", &CPI);
3165
David Majnemerfe2f7f32016-02-29 22:56:36 +00003166 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003167 visitFuncletPadInst(CPI);
3168}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003169
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003170void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3171 User *FirstUser = nullptr;
3172 Value *FirstUnwindPad = nullptr;
3173 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerfe2f7f32016-02-29 22:56:36 +00003174 std::set<FuncletPadInst *> Seen;
3175
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003176 while (!Worklist.empty()) {
3177 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003178 Assert(Seen.insert(CurrentPad).second,
3179 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003180 Value *UnresolvedAncestorPad = nullptr;
3181 for (User *U : CurrentPad->users()) {
3182 BasicBlock *UnwindDest;
3183 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3184 UnwindDest = CRI->getUnwindDest();
3185 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3186 // We allow catchswitch unwind to caller to nest
3187 // within an outer pad that unwinds somewhere else,
3188 // because catchswitch doesn't have a nounwind variant.
3189 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3190 if (CSI->unwindsToCaller())
3191 continue;
3192 UnwindDest = CSI->getUnwindDest();
3193 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3194 UnwindDest = II->getUnwindDest();
3195 } else if (isa<CallInst>(U)) {
3196 // Calls which don't unwind may be found inside funclet
3197 // pads that unwind somewhere else. We don't *require*
3198 // such calls to be annotated nounwind.
3199 continue;
3200 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3201 // The unwind dest for a cleanup can only be found by
3202 // recursive search. Add it to the worklist, and we'll
3203 // search for its first use that determines where it unwinds.
3204 Worklist.push_back(CPI);
3205 continue;
3206 } else {
3207 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3208 continue;
3209 }
3210
3211 Value *UnwindPad;
3212 bool ExitsFPI;
3213 if (UnwindDest) {
3214 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003215 if (!cast<Instruction>(UnwindPad)->isEHPad())
3216 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003217 Value *UnwindParent = getParentPad(UnwindPad);
3218 // Ignore unwind edges that don't exit CurrentPad.
3219 if (UnwindParent == CurrentPad)
3220 continue;
3221 // Determine whether the original funclet pad is exited,
3222 // and if we are scanning nested pads determine how many
3223 // of them are exited so we can stop searching their
3224 // children.
3225 Value *ExitedPad = CurrentPad;
3226 ExitsFPI = false;
3227 do {
3228 if (ExitedPad == &FPI) {
3229 ExitsFPI = true;
3230 // Now we can resolve any ancestors of CurrentPad up to
3231 // FPI, but not including FPI since we need to make sure
3232 // to check all direct users of FPI for consistency.
3233 UnresolvedAncestorPad = &FPI;
3234 break;
3235 }
3236 Value *ExitedParent = getParentPad(ExitedPad);
3237 if (ExitedParent == UnwindParent) {
3238 // ExitedPad is the ancestor-most pad which this unwind
3239 // edge exits, so we can resolve up to it, meaning that
3240 // ExitedParent is the first ancestor still unresolved.
3241 UnresolvedAncestorPad = ExitedParent;
3242 break;
3243 }
3244 ExitedPad = ExitedParent;
3245 } while (!isa<ConstantTokenNone>(ExitedPad));
3246 } else {
3247 // Unwinding to caller exits all pads.
3248 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3249 ExitsFPI = true;
3250 UnresolvedAncestorPad = &FPI;
3251 }
3252
3253 if (ExitsFPI) {
3254 // This unwind edge exits FPI. Make sure it agrees with other
3255 // such edges.
3256 if (FirstUser) {
3257 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3258 "pad must have the same unwind "
3259 "dest",
3260 &FPI, U, FirstUser);
3261 } else {
3262 FirstUser = U;
3263 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003264 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3265 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3266 getParentPad(UnwindPad) == getParentPad(&FPI))
3267 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003268 }
3269 }
3270 // Make sure we visit all uses of FPI, but for nested pads stop as
3271 // soon as we know where they unwind to.
3272 if (CurrentPad != &FPI)
3273 break;
3274 }
3275 if (UnresolvedAncestorPad) {
3276 if (CurrentPad == UnresolvedAncestorPad) {
3277 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3278 // we've found an unwind edge that exits it, because we need to verify
3279 // all direct uses of FPI.
3280 assert(CurrentPad == &FPI);
3281 continue;
3282 }
3283 // Pop off the worklist any nested pads that we've found an unwind
3284 // destination for. The pads on the worklist are the uncles,
3285 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3286 // for all ancestors of CurrentPad up to but not including
3287 // UnresolvedAncestorPad.
3288 Value *ResolvedPad = CurrentPad;
3289 while (!Worklist.empty()) {
3290 Value *UnclePad = Worklist.back();
3291 Value *AncestorPad = getParentPad(UnclePad);
3292 // Walk ResolvedPad up the ancestor list until we either find the
3293 // uncle's parent or the last resolved ancestor.
3294 while (ResolvedPad != AncestorPad) {
3295 Value *ResolvedParent = getParentPad(ResolvedPad);
3296 if (ResolvedParent == UnresolvedAncestorPad) {
3297 break;
3298 }
3299 ResolvedPad = ResolvedParent;
3300 }
3301 // If the resolved ancestor search didn't find the uncle's parent,
3302 // then the uncle is not yet resolved.
3303 if (ResolvedPad != AncestorPad)
3304 break;
3305 // This uncle is resolved, so pop it from the worklist.
3306 Worklist.pop_back();
3307 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003308 }
3309 }
3310
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003311 if (FirstUnwindPad) {
3312 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3313 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3314 Value *SwitchUnwindPad;
3315 if (SwitchUnwindDest)
3316 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3317 else
3318 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3319 Assert(SwitchUnwindPad == FirstUnwindPad,
3320 "Unwind edges out of a catch must have the same unwind dest as "
3321 "the parent catchswitch",
3322 &FPI, FirstUser, CatchSwitch);
3323 }
3324 }
3325
3326 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003327}
3328
David Majnemer8a1c45d2015-12-12 05:38:55 +00003329void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003330 BasicBlock *BB = CatchSwitch.getParent();
3331
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003332 Function *F = BB->getParent();
3333 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003334 "CatchSwitchInst needs to be in a function with a personality.",
3335 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003336
David Majnemer8a1c45d2015-12-12 05:38:55 +00003337 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003338 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003339 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3340 "CatchSwitchInst not the first non-PHI instruction in the block.",
3341 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003342
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003343 auto *ParentPad = CatchSwitch.getParentPad();
3344 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3345 "CatchSwitchInst has an invalid parent.", ParentPad);
3346
David Majnemer8a1c45d2015-12-12 05:38:55 +00003347 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003348 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003349 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3350 "CatchSwitchInst must unwind to an EH block which is not a "
3351 "landingpad.",
3352 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003353
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003354 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3355 if (getParentPad(I) == ParentPad)
3356 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3357 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003358
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003359 Assert(CatchSwitch.getNumHandlers() != 0,
3360 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3361
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003362 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003363 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3364 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003365 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003366
David Majnemerfe2f7f32016-02-29 22:56:36 +00003367 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003368 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003369}
3370
David Majnemer654e1302015-07-31 17:58:14 +00003371void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003372 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3373 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3374 CRI.getOperand(0));
3375
David Majnemer654e1302015-07-31 17:58:14 +00003376 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3377 Instruction *I = UnwindDest->getFirstNonPHI();
3378 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3379 "CleanupReturnInst must unwind to an EH block which is not a "
3380 "landingpad.",
3381 &CRI);
3382 }
3383
3384 visitTerminatorInst(CRI);
3385}
3386
Rafael Espindola654320a2012-02-26 02:23:37 +00003387void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3388 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003389 // If the we have an invalid invoke, don't try to compute the dominance.
3390 // We already reject it in the invoke specific checks and the dominance
3391 // computation doesn't handle multiple edges.
3392 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3393 if (II->getNormalDest() == II->getUnwindDest())
3394 return;
3395 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003396
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003397 const Use &U = I.getOperandUse(i);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003398 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3399 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003400}
3401
Artur Pilipenkocca80022015-10-09 17:41:29 +00003402void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3403 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3404 "apply only to pointer types", &I);
3405 Assert(isa<LoadInst>(I),
3406 "dereferenceable, dereferenceable_or_null apply only to load"
3407 " instructions, use attributes for calls or invokes", &I);
3408 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3409 "take one operand!", &I);
3410 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3411 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3412 "dereferenceable_or_null metadata value must be an i64!", &I);
3413}
3414
Misha Brukmanc566ca362004-03-02 00:22:19 +00003415/// verifyInstruction - Verify that an instruction is well formed.
3416///
Chris Lattner069a7952002-06-25 15:56:27 +00003417void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003418 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003419 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003420
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003421 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003422 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003423 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3424 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003425 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003426 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003427
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003428 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003429 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3430 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003431
Chris Lattner5f126b72004-03-29 00:29:36 +00003432 // Check that the return value of the instruction is either void or a legal
3433 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003434 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3435 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003436
Nick Lewycky93e06a52009-09-27 23:27:42 +00003437 // Check that the instruction doesn't produce metadata. Calls are already
3438 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003439 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3440 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003441
Chris Lattner0e851da2002-04-18 20:37:37 +00003442 // Check that all uses of the instruction, if they are instructions
3443 // themselves, actually have parent basic blocks. If the use is not an
3444 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003445 for (Use &U : I.uses()) {
3446 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003447 Assert(Used->getParent() != nullptr,
3448 "Instruction referencing"
3449 " instruction not embedded in a basic block!",
3450 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003451 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003452 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003453 return;
3454 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003455 }
3456
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003457 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003458 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003459
3460 // Check to make sure that only first-class-values are operands to
3461 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003462 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003463 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003464 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003465
Chris Lattner9ece94b2004-03-14 03:23:54 +00003466 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003467 // Check to make sure that the "address of" an intrinsic function is never
3468 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003469 Assert(
3470 !F->isIntrinsic() ||
3471 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3472 "Cannot take the address of an intrinsic!", &I);
3473 Assert(
3474 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003475 F->getIntrinsicID() == Intrinsic::donothing ||
3476 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003477 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3478 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Sanjoy Das999dc752016-02-29 22:04:25 +00003479 "Cannot invoke an intrinsic other than donothing, patchpoint or "
3480 "statepoint",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003481 &I);
3482 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003483 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003484 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003485 Assert(OpBB->getParent() == BB->getParent(),
3486 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003487 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003488 Assert(OpArg->getParent() == BB->getParent(),
3489 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003490 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003491 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003492 } else if (isa<Instruction>(I.getOperand(i))) {
3493 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003494 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003495 Assert((i + 1 == e && isa<CallInst>(I)) ||
3496 (i + 3 == e && isa<InvokeInst>(I)),
3497 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003498 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3499 if (CE->getType()->isPtrOrPtrVectorTy()) {
3500 // If we have a ConstantExpr pointer, we need to see if it came from an
3501 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003502 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003503 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003504 }
3505 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003506
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003507 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003508 Assert(I.getType()->isFPOrFPVectorTy(),
3509 "fpmath requires a floating point result!", &I);
3510 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003511 if (ConstantFP *CFP0 =
3512 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003513 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003514 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3515 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003516 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003517 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003518 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003519 }
3520
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003521 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003522 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3523 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003524 visitRangeMetadata(I, Range, I.getType());
3525 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003526
Philip Reames0ca58b32014-10-21 20:56:29 +00003527 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003528 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3529 &I);
3530 Assert(isa<LoadInst>(I),
3531 "nonnull applies only to load instructions, use attributes"
3532 " for calls or invokes",
3533 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003534 }
3535
Artur Pilipenkocca80022015-10-09 17:41:29 +00003536 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3537 visitDereferenceableMetadata(I, MD);
3538
3539 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3540 visitDereferenceableMetadata(I, MD);
3541
3542 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3543 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3544 &I);
3545 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3546 "use attributes for calls or invokes", &I);
3547 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3548 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3549 Assert(CI && CI->getType()->isIntegerTy(64),
3550 "align metadata value must be an i64!", &I);
3551 uint64_t Align = CI->getZExtValue();
3552 Assert(isPowerOf2_64(Align),
3553 "align metadata value must be a power of 2!", &I);
3554 Assert(Align <= Value::MaximumAlignment,
3555 "alignment is larger that implementation defined limit", &I);
3556 }
3557
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003558 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003559 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003560 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003561 }
3562
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003563 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003564}
3565
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003566/// Verify that the specified type (which comes from an intrinsic argument or
3567/// return value) matches the type constraints specified by the .td file (e.g.
3568/// an "any integer" argument really is an integer).
Chris Lattner144b6192012-05-27 19:37:05 +00003569///
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003570/// This returns true on error but does not print a message.
3571bool Verifier::verifyIntrinsicType(Type *Ty,
Chris Lattner144b6192012-05-27 19:37:05 +00003572 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3573 SmallVectorImpl<Type*> &ArgTys) {
3574 using namespace Intrinsic;
3575
3576 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003577 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003578 IITDescriptor D = Infos.front();
3579 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003580
Chris Lattner144b6192012-05-27 19:37:05 +00003581 switch (D.Kind) {
3582 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003583 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003584 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003585 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003586 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003587 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003588 case IITDescriptor::Float: return !Ty->isFloatTy();
3589 case IITDescriptor::Double: return !Ty->isDoubleTy();
3590 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3591 case IITDescriptor::Vector: {
3592 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003593 return !VT || VT->getNumElements() != D.Vector_Width ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003594 verifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003595 }
3596 case IITDescriptor::Pointer: {
3597 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003598 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003599 verifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003600 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003601
Chris Lattner144b6192012-05-27 19:37:05 +00003602 case IITDescriptor::Struct: {
3603 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003604 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003605 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003606
Chris Lattner144b6192012-05-27 19:37:05 +00003607 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003608 if (verifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
Chris Lattner144b6192012-05-27 19:37:05 +00003609 return true;
3610 return false;
3611 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003612
Chris Lattner144b6192012-05-27 19:37:05 +00003613 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003614 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003615 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003616 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003617 return Ty != ArgTys[D.getArgumentNumber()];
3618
Chris Lattner144b6192012-05-27 19:37:05 +00003619 // Otherwise, if this is the first instance of an argument, record it and
3620 // verify the "Any" kind.
3621 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3622 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003623
Chris Lattner144b6192012-05-27 19:37:05 +00003624 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003625 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003626 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3627 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3628 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3629 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3630 }
3631 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003632
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003633 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003634 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003635 if (D.getArgumentNumber() >= ArgTys.size())
3636 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003637
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003638 Type *NewTy = ArgTys[D.getArgumentNumber()];
3639 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3640 NewTy = VectorType::getExtendedElementVectorType(VTy);
3641 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3642 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3643 else
3644 return true;
3645
3646 return Ty != NewTy;
3647 }
3648 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003649 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003650 if (D.getArgumentNumber() >= ArgTys.size())
3651 return true;
3652
3653 Type *NewTy = ArgTys[D.getArgumentNumber()];
3654 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3655 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3656 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3657 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3658 else
3659 return true;
3660
3661 return Ty != NewTy;
3662 }
Tim Northover4516de32014-03-29 07:04:54 +00003663 case IITDescriptor::HalfVecArgument:
3664 // This may only be used when referring to a previous vector argument.
3665 return D.getArgumentNumber() >= ArgTys.size() ||
3666 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3667 VectorType::getHalfElementsVectorType(
3668 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003669 case IITDescriptor::SameVecWidthArgument: {
3670 if (D.getArgumentNumber() >= ArgTys.size())
3671 return true;
3672 VectorType * ReferenceType =
3673 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3674 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3675 if (!ThisArgType || !ReferenceType ||
3676 (ReferenceType->getVectorNumElements() !=
3677 ThisArgType->getVectorNumElements()))
3678 return true;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003679 return verifyIntrinsicType(ThisArgType->getVectorElementType(),
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003680 Infos, ArgTys);
3681 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003682 case IITDescriptor::PtrToArgument: {
3683 if (D.getArgumentNumber() >= ArgTys.size())
3684 return true;
3685 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3686 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3687 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3688 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003689 case IITDescriptor::VecOfPtrsToElt: {
3690 if (D.getArgumentNumber() >= ArgTys.size())
3691 return true;
3692 VectorType * ReferenceType =
3693 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3694 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3695 if (!ThisArgVecTy || !ReferenceType ||
3696 (ReferenceType->getVectorNumElements() !=
3697 ThisArgVecTy->getVectorNumElements()))
3698 return true;
3699 PointerType *ThisArgEltTy =
3700 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3701 if (!ThisArgEltTy)
3702 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003703 return ThisArgEltTy->getElementType() !=
3704 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003705 }
Chris Lattner144b6192012-05-27 19:37:05 +00003706 }
3707 llvm_unreachable("unhandled");
3708}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003709
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003710/// Verify if the intrinsic has variable arguments. This method is intended to
3711/// be called after all the fixed arguments have been verified first.
Andrew Tricka2efd992013-10-31 17:18:11 +00003712///
3713/// This method returns true on error and does not print an error message.
3714bool
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003715Verifier::verifyIntrinsicIsVarArg(bool isVarArg,
Andrew Tricka2efd992013-10-31 17:18:11 +00003716 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3717 using namespace Intrinsic;
3718
3719 // If there are no descriptors left, then it can't be a vararg.
3720 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003721 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003722
3723 // There should be only one descriptor remaining at this point.
3724 if (Infos.size() != 1)
3725 return true;
3726
3727 // Check and verify the descriptor.
3728 IITDescriptor D = Infos.front();
3729 Infos = Infos.slice(1);
3730 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003731 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003732
3733 return true;
3734}
3735
Philip Reames007561a2015-06-26 22:21:52 +00003736/// Allow intrinsics to be verified in different ways.
3737void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003738 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003739 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3740 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003741
Chris Lattner144b6192012-05-27 19:37:05 +00003742 // Verify that the intrinsic prototype lines up with what the .td files
3743 // describe.
3744 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003745 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003746
Chris Lattner144b6192012-05-27 19:37:05 +00003747 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3748 getIntrinsicInfoTableEntries(ID, Table);
3749 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003750
Chris Lattner144b6192012-05-27 19:37:05 +00003751 SmallVector<Type *, 4> ArgTys;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003752 Assert(!verifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003753 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003754 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003755 Assert(!verifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003756 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003757
3758 // Verify if the intrinsic call matches the vararg property.
3759 if (IsVarArg)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003760 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003761 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003762 else
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003763 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003764 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003765
3766 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003767 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003768
3769 // Now that we have the intrinsic ID and the actual argument types (and we
3770 // know they are legal for the intrinsic!) get the intrinsic name through the
3771 // usual means. This allows us to verify the mangling of argument types into
3772 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003773 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003774 Assert(ExpectedName == IF->getName(),
3775 "Intrinsic name not mangled correctly for type arguments! "
3776 "Should be: " +
3777 ExpectedName,
3778 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003779
Chris Lattner588096e2009-12-28 09:07:21 +00003780 // If the intrinsic takes MDNode arguments, verify that they are either global
3781 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003782 for (Value *V : CS.args())
3783 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3784 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003785
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003786 switch (ID) {
3787 default:
3788 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003789 case Intrinsic::ctlz: // llvm.ctlz
3790 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003791 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003792 "is_zero_undef argument of bit counting intrinsics must be a "
3793 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003794 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003795 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003796 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003797 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3798 "invalid llvm.dbg.declare intrinsic call 1", CS);
3799 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003800 break;
3801 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003802 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003803 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003804 case Intrinsic::memcpy:
3805 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003806 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003807 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003808 Assert(AlignCI,
3809 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003810 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003811 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003812 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003813 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003814 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003815 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003816 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003817 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003818 }
Bill Wendling05604e02008-08-23 09:46:46 +00003819 case Intrinsic::gcroot:
3820 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003821 case Intrinsic::gcread:
3822 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003823 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003824 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3825 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3826 Assert(isa<Constant>(CS.getArgOperand(1)),
3827 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003828 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003829 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003830 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3831 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003832 CS);
Talin2e59f142010-09-30 20:23:47 +00003833 }
Chris Lattner25852062008-08-24 20:46:13 +00003834 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003835
Philip Reames9818dd72015-06-26 22:04:34 +00003836 Assert(CS.getParent()->getParent()->hasGC(),
3837 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003838 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003839 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003840 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003841 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003842 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003843 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003844 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003845 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3846 isa<ConstantInt>(CS.getArgOperand(2)) &&
3847 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3848 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3849 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003850 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003851 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003852 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3853 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003854 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003855 case Intrinsic::lifetime_start:
3856 case Intrinsic::lifetime_end:
3857 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003858 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003859 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003860 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003861 break;
3862 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003863 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3864 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003865 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003866
Reid Kleckner60381792015-07-07 22:25:32 +00003867 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003868 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003869 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003870 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003871 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003872 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003873 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003874 if (isa<ConstantPointerNull>(Arg))
3875 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003876 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003877 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003878 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003879 }
Philip Reames9818dd72015-06-26 22:04:34 +00003880 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003881 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003882 break;
3883 }
Reid Kleckner60381792015-07-07 22:25:32 +00003884 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003885 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003886 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003887 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003888 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003889 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003890 CS);
3891 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003892 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003893 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003894 auto &Entry = FrameEscapeInfo[Fn];
3895 Entry.second = unsigned(
3896 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003897 break;
3898 }
3899
Philip Reames1ffa9372015-01-30 23:28:05 +00003900 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00003901 Assert(!CS.isInlineAsm(),
3902 "gc.statepoint support for inline assembly unimplemented", CS);
3903 Assert(CS.getParent()->getParent()->hasGC(),
3904 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00003905
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003906 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003907 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003908 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00003909 Assert(CS.getParent()->getParent()->hasGC(),
3910 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003911 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00003912 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00003913 const Function *StatepointFn =
3914 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003915 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3916 StatepointFn->getIntrinsicID() ==
3917 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00003918 "gc.result operand #1 must be from a statepoint", CS,
3919 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00003920
Philip Reamesb23713a2014-12-03 22:23:24 +00003921 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003922 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00003923 auto *PT = cast<PointerType>(Target->getType());
3924 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00003925 Assert(CS.getType() == TargetFuncType->getReturnType(),
3926 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003927 break;
3928 }
3929 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00003930 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003931
Philip Reames3e2cf532016-01-07 03:32:11 +00003932 Assert(isa<PointerType>(CS.getType()->getScalarType()),
3933 "gc.relocate must return a pointer or a vector of pointers", CS);
3934
Igor Laevsky9570ff92015-02-19 11:28:47 +00003935 // Check that this relocate is correctly tied to the statepoint
3936
3937 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00003938 if (LandingPadInst *LandingPad =
3939 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00003940
Sanjoy Das5665c992015-05-11 23:47:27 +00003941 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00003942 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00003943
3944 // Landingpad relocates should have only one predecessor with invoke
3945 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00003946 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00003947 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00003948 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3949 InvokeBB);
3950 Assert(isStatepoint(InvokeBB->getTerminator()),
3951 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003952 }
3953 else {
3954 // In all other cases relocate should be tied to the statepoint directly.
3955 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003956 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00003957 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003958 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00003959 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003960 }
3961
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003962 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00003963
Manuel Jacob83eefa62016-01-05 04:03:00 +00003964 ImmutableCallSite StatepointCS(
3965 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00003966
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003967 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00003968 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003969 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00003970 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003971
Philip Reames9818dd72015-06-26 22:04:34 +00003972 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003973 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00003974 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003975
3976 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3977 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3978 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003979 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003980 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003981 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00003982 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00003983
3984 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003985 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003986 Assert(StatepointCS.arg_size() > 0,
3987 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003988 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00003989 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003990 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003991 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3992 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00003993 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003994 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00003995 "gc.statepoint: number of transition arguments must be "
3996 "a constant integer");
3997 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003998 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3999 ->getZExtValue();
4000 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004001 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004002 "gc.statepoint: number of deoptimization arguments must be "
4003 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004004 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004005 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4006 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004007 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004008 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004009 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4010 "gc.relocate: statepoint base index doesn't fall within the "
4011 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004012 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004013 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4014 "gc.relocate: statepoint derived index doesn't fall within the "
4015 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004016 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004017
Philip Reames3e2cf532016-01-07 03:32:11 +00004018 // Relocated value must be either a pointer type or vector-of-pointer type,
4019 // but gc_relocate does not need to return the same pointer type as the
4020 // relocated pointer. It can be casted to the correct type later if it's
4021 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004022 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004023 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004024 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004025
Philip Reames3e2cf532016-01-07 03:32:11 +00004026 auto ResultType = CS.getType();
4027 auto DerivedType = Relocate.getDerivedPtr()->getType();
4028 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004029 "gc.relocate: vector relocates to vector and pointer to pointer",
4030 CS);
4031 Assert(
4032 ResultType->getPointerAddressSpace() ==
4033 DerivedType->getPointerAddressSpace(),
4034 "gc.relocate: relocating a pointer shouldn't change its address space",
4035 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004036 break;
4037 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004038 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004039 case Intrinsic::eh_exceptionpointer: {
4040 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4041 "eh.exceptionpointer argument must be a catchpad", CS);
4042 break;
4043 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004044 case Intrinsic::masked_load: {
4045 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4046
4047 Value *Ptr = CS.getArgOperand(0);
4048 //Value *Alignment = CS.getArgOperand(1);
4049 Value *Mask = CS.getArgOperand(2);
4050 Value *PassThru = CS.getArgOperand(3);
4051 Assert(Mask->getType()->isVectorTy(),
4052 "masked_load: mask must be vector", CS);
4053
4054 // DataTy is the overloaded type
4055 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4056 Assert(DataTy == CS.getType(),
4057 "masked_load: return must match pointer type", CS);
4058 Assert(PassThru->getType() == DataTy,
4059 "masked_load: pass through and data type must match", CS);
4060 Assert(Mask->getType()->getVectorNumElements() ==
4061 DataTy->getVectorNumElements(),
4062 "masked_load: vector mask must be same length as data", CS);
4063 break;
4064 }
4065 case Intrinsic::masked_store: {
4066 Value *Val = CS.getArgOperand(0);
4067 Value *Ptr = CS.getArgOperand(1);
4068 //Value *Alignment = CS.getArgOperand(2);
4069 Value *Mask = CS.getArgOperand(3);
4070 Assert(Mask->getType()->isVectorTy(),
4071 "masked_store: mask must be vector", CS);
4072
4073 // DataTy is the overloaded type
4074 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4075 Assert(DataTy == Val->getType(),
4076 "masked_store: storee must match pointer type", CS);
4077 Assert(Mask->getType()->getVectorNumElements() ==
4078 DataTy->getVectorNumElements(),
4079 "masked_store: vector mask must be same length as data", CS);
4080 break;
4081 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004082 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004083}
4084
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004085/// \brief Carefully grab the subprogram from a local scope.
4086///
4087/// This carefully grabs the subprogram from a local scope, avoiding the
4088/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004089static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004090 if (!LocalScope)
4091 return nullptr;
4092
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004093 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004094 return SP;
4095
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004096 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004097 return getSubprogram(LB->getRawScope());
4098
4099 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004100 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004101 return nullptr;
4102}
4103
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004104template <class DbgIntrinsicTy>
4105void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4106 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
4107 Assert(isa<ValueAsMetadata>(MD) ||
4108 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4109 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004110 Assert(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004111 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4112 DII.getRawVariable());
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004113 Assert(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004114 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4115 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004116
4117 // Ignore broken !dbg attachments; they're checked elsewhere.
4118 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004119 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004120 return;
4121
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004122 BasicBlock *BB = DII.getParent();
4123 Function *F = BB ? BB->getParent() : nullptr;
4124
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004125 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004126 DILocalVariable *Var = DII.getVariable();
4127 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004128 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4129 &DII, BB, F);
4130
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004131 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4132 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004133 if (!VarSP || !LocSP)
4134 return; // Broken scope chains are checked elsewhere.
4135
4136 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4137 " variable and !dbg attachment",
4138 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4139 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004140}
4141
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004142template <class MapTy>
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004143static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004144 // Be careful of broken types (checked elsewhere).
4145 const Metadata *RawType = V.getRawType();
4146 while (RawType) {
4147 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004148 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004149 if (uint64_t Size = T->getSizeInBits())
4150 return Size;
4151
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004152 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004153 // Look at the base type.
4154 RawType = DT->getRawBaseType();
4155 continue;
4156 }
4157
4158 if (auto *S = dyn_cast<MDString>(RawType)) {
4159 // Don't error on missing types (checked elsewhere).
4160 RawType = Map.lookup(S);
4161 continue;
4162 }
4163
4164 // Missing type or size.
4165 break;
4166 }
4167
4168 // Fail gracefully.
4169 return 0;
4170}
4171
4172template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +00004173void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
4174 const MapTy &TypeRefs) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004175 DILocalVariable *V;
4176 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004177 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004178 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4179 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004180 } else {
4181 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004182 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4183 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004184 }
4185
4186 // We don't know whether this intrinsic verified correctly.
4187 if (!V || !E || !E->isValid())
4188 return;
4189
Keno Fischer253a7bd2016-01-15 02:12:38 +00004190 // Nothing to do if this isn't a bit piece expression.
4191 if (!E->isBitPiece())
4192 return;
4193
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004194 // The frontend helps out GDB by emitting the members of local anonymous
4195 // unions as artificial local variables with shared storage. When SROA splits
4196 // the storage for artificial local variables that are smaller than the entire
4197 // union, the overhang piece will be outside of the allotted space for the
4198 // variable and this check fails.
4199 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4200 if (V->isArtificial())
4201 return;
4202
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004203 // If there's no size, the type is broken, but that should be checked
4204 // elsewhere.
4205 uint64_t VarSize = getVariableSize(*V, TypeRefs);
4206 if (!VarSize)
4207 return;
4208
Keno Fischer253a7bd2016-01-15 02:12:38 +00004209 unsigned PieceSize = E->getBitPieceSize();
4210 unsigned PieceOffset = E->getBitPieceOffset();
4211 Assert(PieceSize + PieceOffset <= VarSize,
4212 "piece is larger than or outside of variable", &I, V, E);
4213 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004214}
4215
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004216void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
4217 // This is in its own function so we get an error for each bad type ref (not
4218 // just the first).
4219 Assert(false, "unresolved type ref", S, N);
4220}
4221
4222void Verifier::verifyTypeRefs() {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004223 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4224 if (!CUs)
4225 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004226
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004227 // Visit all the compile units again to map the type references.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004228 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004229 for (auto *CU : CUs->operands())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004230 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
4231 for (DIType *Op : Ts)
David Blaikie3c338f32015-08-22 22:36:40 +00004232 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004233 if (auto *S = T->getRawIdentifier()) {
4234 UnresolvedTypeRefs.erase(S);
4235 TypeRefs.insert(std::make_pair(S, T));
4236 }
4237
4238 // Verify debug info intrinsic bit piece expressions. This needs a second
4239 // pass through the intructions, since we haven't built TypeRefs yet when
4240 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
4241 // later/now would queue up some that could be later deleted.
4242 for (const Function &F : *M)
4243 for (const BasicBlock &BB : F)
4244 for (const Instruction &I : BB)
4245 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Keno Fischer253a7bd2016-01-15 02:12:38 +00004246 verifyBitPieceExpression(*DII, TypeRefs);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004247
4248 // Return early if all typerefs were resolved.
4249 if (UnresolvedTypeRefs.empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004250 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004251
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004252 // Sort the unresolved references by name so the output is deterministic.
4253 typedef std::pair<const MDString *, const MDNode *> TypeRef;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004254 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
4255 UnresolvedTypeRefs.end());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004256 std::sort(Unresolved.begin(), Unresolved.end(),
4257 [](const TypeRef &LHS, const TypeRef &RHS) {
4258 return LHS.first->getString() < RHS.first->getString();
4259 });
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004260
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004261 // Visit the unresolved refs (printing out the errors).
4262 for (const TypeRef &TR : Unresolved)
4263 visitUnresolvedTypeRef(TR.first, TR.second);
Manman Ren74c61b92013-07-19 00:31:03 +00004264}
4265
Chris Lattner0e851da2002-04-18 20:37:37 +00004266//===----------------------------------------------------------------------===//
4267// Implement the public interfaces to this file...
4268//===----------------------------------------------------------------------===//
4269
Chandler Carruth043949d2014-01-19 02:22:18 +00004270bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004271 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00004272 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00004273
Chandler Carruth043949d2014-01-19 02:22:18 +00004274 raw_null_ostream NullStr;
4275 Verifier V(OS ? *OS : NullStr);
4276
4277 // Note that this function's return value is inverted from what you would
4278 // expect of a function called "verify".
4279 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004280}
4281
Chandler Carruth043949d2014-01-19 02:22:18 +00004282bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
4283 raw_null_ostream NullStr;
4284 Verifier V(OS ? *OS : NullStr);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004285
Chandler Carruth043949d2014-01-19 02:22:18 +00004286 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004287 for (const Function &F : M)
4288 if (!F.isDeclaration() && !F.isMaterializable())
4289 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004290
4291 // Note that this function's return value is inverted from what you would
4292 // expect of a function called "verify".
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +00004293 return !V.verify(M) || Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004294}
Chandler Carruth043949d2014-01-19 02:22:18 +00004295
4296namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004297struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004298 static char ID;
4299
4300 Verifier V;
4301 bool FatalErrors;
4302
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +00004303 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004304 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004305 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004306 explicit VerifierLegacyPass(bool FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004307 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004308 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004309 }
4310
Craig Topperf398d7c2014-03-05 06:35:38 +00004311 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004312 if (!V.verify(F) && FatalErrors)
4313 report_fatal_error("Broken function found, compilation aborted!");
4314
4315 return false;
4316 }
4317
Craig Topperf398d7c2014-03-05 06:35:38 +00004318 bool doFinalization(Module &M) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004319 if (!V.verify(M) && FatalErrors)
4320 report_fatal_error("Broken module found, compilation aborted!");
4321
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004322 return false;
4323 }
4324
4325 void getAnalysisUsage(AnalysisUsage &AU) const override {
4326 AU.setPreservesAll();
4327 }
4328};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004329}
Chandler Carruth043949d2014-01-19 02:22:18 +00004330
Chandler Carruth4d356312014-01-20 11:34:08 +00004331char VerifierLegacyPass::ID = 0;
4332INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004333
4334FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004335 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004336}
4337
Chandler Carruthd174ce42015-01-05 02:47:05 +00004338PreservedAnalyses VerifierPass::run(Module &M) {
4339 if (verifyModule(M, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004340 report_fatal_error("Broken module found, compilation aborted!");
4341
4342 return PreservedAnalyses::all();
4343}
4344
Chandler Carruthd174ce42015-01-05 02:47:05 +00004345PreservedAnalyses VerifierPass::run(Function &F) {
4346 if (verifyFunction(F, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004347 report_fatal_error("Broken function found, compilation aborted!");
4348
4349 return PreservedAnalyses::all();
4350}