blob: fad4aacb52df83375e5571c57f92bb1349c23a76 [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
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000199 /// Track all DICompileUnits visited.
200 SmallPtrSet<const Metadata *, 2> CUVisited;
201
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000202 /// \brief Track unresolved string-based type references.
203 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000204
David Majnemer654e1302015-07-31 17:58:14 +0000205 /// \brief The result type for a landingpad.
206 Type *LandingPadResultTy;
207
Reid Kleckner60381792015-07-07 22:25:32 +0000208 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000209 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000210 bool SawFrameEscape;
211
Reid Kleckner60381792015-07-07 22:25:32 +0000212 /// Stores the count of how many objects were passed to llvm.localescape for a
213 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000214 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000215
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000216 // Maps catchswitches and cleanuppads that unwind to siblings to the
217 // terminators that indicate the unwind, used to detect cycles therein.
218 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
219
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000220 /// Cache of constants visited in search of ConstantExprs.
221 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
222
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000223 // Verify that this GlobalValue is only used in this module.
224 // This map is used to avoid visiting uses twice. We can arrive at a user
225 // twice, if they have multiple operands. In particular for very large
226 // constant expressions, we can arrive at a particular user many times.
227 SmallPtrSet<const Value *, 32> GlobalValueVisited;
228
JF Bastiend1fb5852015-12-17 22:09:19 +0000229 void checkAtomicMemAccessSize(const Module *M, Type *Ty,
230 const Instruction *I);
Chandler Carruth043949d2014-01-19 02:22:18 +0000231public:
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +0000232 explicit Verifier(raw_ostream &OS)
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +0000233 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
David Majnemer654e1302015-07-31 17:58:14 +0000234 SawFrameEscape(false) {}
Chris Lattner0e851da2002-04-18 20:37:37 +0000235
Chandler Carruth043949d2014-01-19 02:22:18 +0000236 bool verify(const Function &F) {
237 M = F.getParent();
238 Context = &M->getContext();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000239
240 // First ensure the function is well-enough formed to compute dominance
241 // information.
Chandler Carruth043949d2014-01-19 02:22:18 +0000242 if (F.empty()) {
243 OS << "Function '" << F.getName()
244 << "' does not contain an entry block!\n";
245 return false;
246 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000247 for (const BasicBlock &BB : F) {
248 if (BB.empty() || !BB.back().isTerminator()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000249 OS << "Basic Block in function '" << F.getName()
250 << "' does not have terminator!\n";
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000251 BB.printAsOperand(OS, true);
Chandler Carruth043949d2014-01-19 02:22:18 +0000252 OS << "\n";
253 return false;
Chandler Carruth76777602014-01-17 10:56:02 +0000254 }
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000255 }
Chandler Carruth76777602014-01-17 10:56:02 +0000256
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000257 // Now directly compute a dominance tree. We don't rely on the pass
258 // manager to provide this as it isolates us from a potentially
259 // out-of-date dominator tree and makes it significantly more complex to
260 // run this code outside of a pass manager.
Chandler Carruth043949d2014-01-19 02:22:18 +0000261 // FIXME: It's really gross that we have to cast away constness here.
262 DT.recalculate(const_cast<Function &>(F));
Chris Lattneraf332ee2007-04-20 23:59:29 +0000263
Chandler Carruth043949d2014-01-19 02:22:18 +0000264 Broken = false;
265 // FIXME: We strip const here because the inst visitor strips const.
266 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000267 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000268 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000269 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000270 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000271 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000272
Chandler Carruth043949d2014-01-19 02:22:18 +0000273 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000274 }
275
Chandler Carruth043949d2014-01-19 02:22:18 +0000276 bool verify(const Module &M) {
277 this->M = &M;
278 Context = &M.getContext();
Chandler Carruth043949d2014-01-19 02:22:18 +0000279 Broken = false;
280
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000281 // Scan through, checking all of the external function's linkage now...
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000282 for (const Function &F : M) {
283 visitGlobalValue(F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000284
285 // Check to make sure function prototypes are okay.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000286 if (F.isDeclaration())
287 visitFunction(F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000288 }
289
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000290 // Now that we've visited every function, verify that we never asked to
291 // recover a frame index that wasn't escaped.
292 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000293 for (const GlobalVariable &GV : M.globals())
294 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000295
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000296 for (const GlobalAlias &GA : M.aliases())
297 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000298
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000299 for (const NamedMDNode &NMD : M.named_metadata())
300 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000301
David Majnemerdad0a642014-06-27 18:19:56 +0000302 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
303 visitComdat(SMEC.getValue());
304
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000305 visitModuleFlags(M);
306 visitModuleIdents(M);
307
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000308 verifyCompileUnits();
309
310 // Verify type references last.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000311 verifyTypeRefs();
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000312
Chandler Carruth043949d2014-01-19 02:22:18 +0000313 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000314 }
Chris Lattner9713b842002-04-28 16:04:26 +0000315
Chandler Carruth043949d2014-01-19 02:22:18 +0000316private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000317 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000318 void visitGlobalValue(const GlobalValue &GV);
319 void visitGlobalVariable(const GlobalVariable &GV);
320 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000321 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000322 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000323 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000324 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000325 void visitMDNode(const MDNode &MD);
326 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
327 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000328 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000329 void visitModuleIdents(const Module &M);
330 void visitModuleFlags(const Module &M);
331 void visitModuleFlag(const MDNode *Op,
332 DenseMap<const MDString *, const MDNode *> &SeenIDs,
333 SmallVectorImpl<const MDNode *> &Requirements);
334 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000335 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000336 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000337 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000338
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000339 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000340#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
341#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000342 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000343 void visitDIVariable(const DIVariable &N);
344 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
345 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000346
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000347 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
348
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000349 /// \brief Check for a valid string-based type reference.
350 ///
351 /// Checks if \c MD is a string-based type reference. If it is, keeps track
352 /// of it (and its user, \c N) for error messages later.
353 bool isValidUUID(const MDNode &N, const Metadata *MD);
354
355 /// \brief Check for a valid type reference.
356 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000357 /// Checks for subclasses of \a DIType, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000358 bool isTypeRef(const MDNode &N, const Metadata *MD);
359
360 /// \brief Check for a valid scope reference.
361 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000362 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000363 bool isScopeRef(const MDNode &N, const Metadata *MD);
364
365 /// \brief Check for a valid debug info reference.
366 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000367 /// Checks for subclasses of \a DINode, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000368 bool isDIRef(const MDNode &N, const Metadata *MD);
369
Chandler Carruth043949d2014-01-19 02:22:18 +0000370 // InstVisitor overrides...
371 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000372 void visit(Instruction &I);
373
374 void visitTruncInst(TruncInst &I);
375 void visitZExtInst(ZExtInst &I);
376 void visitSExtInst(SExtInst &I);
377 void visitFPTruncInst(FPTruncInst &I);
378 void visitFPExtInst(FPExtInst &I);
379 void visitFPToUIInst(FPToUIInst &I);
380 void visitFPToSIInst(FPToSIInst &I);
381 void visitUIToFPInst(UIToFPInst &I);
382 void visitSIToFPInst(SIToFPInst &I);
383 void visitIntToPtrInst(IntToPtrInst &I);
384 void visitPtrToIntInst(PtrToIntInst &I);
385 void visitBitCastInst(BitCastInst &I);
386 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
387 void visitPHINode(PHINode &PN);
388 void visitBinaryOperator(BinaryOperator &B);
389 void visitICmpInst(ICmpInst &IC);
390 void visitFCmpInst(FCmpInst &FC);
391 void visitExtractElementInst(ExtractElementInst &EI);
392 void visitInsertElementInst(InsertElementInst &EI);
393 void visitShuffleVectorInst(ShuffleVectorInst &EI);
394 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
395 void visitCallInst(CallInst &CI);
396 void visitInvokeInst(InvokeInst &II);
397 void visitGetElementPtrInst(GetElementPtrInst &GEP);
398 void visitLoadInst(LoadInst &LI);
399 void visitStoreInst(StoreInst &SI);
400 void verifyDominatesUse(Instruction &I, unsigned i);
401 void visitInstruction(Instruction &I);
402 void visitTerminatorInst(TerminatorInst &I);
403 void visitBranchInst(BranchInst &BI);
404 void visitReturnInst(ReturnInst &RI);
405 void visitSwitchInst(SwitchInst &SI);
406 void visitIndirectBrInst(IndirectBrInst &BI);
407 void visitSelectInst(SelectInst &SI);
408 void visitUserOp1(Instruction &I);
409 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000410 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000411 template <class DbgIntrinsicTy>
412 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000413 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
414 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
415 void visitFenceInst(FenceInst &FI);
416 void visitAllocaInst(AllocaInst &AI);
417 void visitExtractValueInst(ExtractValueInst &EVI);
418 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000419 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000420 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemer654e1302015-07-31 17:58:14 +0000421 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000422 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000423 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000424 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000425 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000426 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000427
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000428 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000429 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
430 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000431 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000432 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000433 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000434 bool verifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000435 SmallVectorImpl<Type *> &ArgTys);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000436 bool verifyIntrinsicIsVarArg(bool isVarArg,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000437 ArrayRef<Intrinsic::IITDescriptor> &Infos);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000438 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
439 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000440 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000441 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000442 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000443 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000444 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000445 void verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +0000446 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000447
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000448 void visitConstantExprsRecursively(const Constant *EntryC);
449 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000450 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000451 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000452 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000453
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000454 /// @{
455 /// Module-level debug info verification...
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000456 void verifyTypeRefs();
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000457 void verifyCompileUnits();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000458 template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +0000459 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
460 const MapTy &TypeRefs);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000461 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000462 /// @}
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000463};
Chris Lattner189d19f2003-11-21 20:23:48 +0000464} // End anonymous namespace
465
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000466// Assert - We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000467#define Assert(C, ...) \
468 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000469
Chris Lattnere5a22c02008-08-28 04:02:44 +0000470void Verifier::visit(Instruction &I) {
471 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000472 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000473 InstVisitor<Verifier>::visit(I);
474}
475
Keno Fischer60f82a22016-01-14 22:20:56 +0000476// Helper to recursively iterate over indirect users. By
477// returning false, the callback can ask to stop recursing
478// further.
479static void forEachUser(const Value *User,
480 SmallPtrSet<const Value *, 32> &Visited,
481 llvm::function_ref<bool(const Value *)> Callback) {
482 if (!Visited.insert(User).second)
483 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000484 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000485 if (Callback(TheNextUser))
486 forEachUser(TheNextUser, Visited, Callback);
487}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000488
Chandler Carruth043949d2014-01-19 02:22:18 +0000489void Verifier::visitGlobalValue(const GlobalValue &GV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000490 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
491 GV.hasExternalWeakLinkage(),
492 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000493
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000494 Assert(GV.getAlignment() <= Value::MaximumAlignment,
495 "huge alignment values are unsupported", &GV);
496 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
497 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000498
499 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000500 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000501 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000502 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000503 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000504
505 if (GV.isDeclarationForLinker())
506 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000507
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000508 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000509 if (const Instruction *I = dyn_cast<Instruction>(V)) {
510 if (!I->getParent() || !I->getParent()->getParent())
511 CheckFailed("Global is referenced by parentless instruction!", &GV,
512 M, I);
513 else if (I->getParent()->getParent()->getParent() != M)
514 CheckFailed("Global is referenced in a different module!", &GV,
515 M, I, I->getParent()->getParent(),
516 I->getParent()->getParent()->getParent());
517 return false;
518 } else if (const Function *F = dyn_cast<Function>(V)) {
519 if (F->getParent() != M)
520 CheckFailed("Global is used by function in a different module", &GV,
521 M, F, F->getParent());
522 return false;
523 }
524 return true;
525 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000526}
527
Chandler Carruth043949d2014-01-19 02:22:18 +0000528void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000529 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000530 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000531 "Global variable initializer type does not match global "
532 "variable type!",
533 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000534
Chris Lattner0aff0b22009-08-05 05:41:44 +0000535 // If the global has common linkage, it must have a zero initializer and
536 // cannot be constant.
537 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000538 Assert(GV.getInitializer()->isNullValue(),
539 "'common' global must have a zero initializer!", &GV);
540 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
541 &GV);
542 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000543 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000544 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000545 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
546 "invalid linkage type for global declaration", &GV);
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000547 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000548
Nick Lewycky466d0c12011-04-08 07:30:21 +0000549 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
550 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000551 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
552 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000553 // Don't worry about emitting an error for it not being an array,
554 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000555 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000556 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
557 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000558 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000559 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000560 Assert(STy &&
561 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
562 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
563 STy->getTypeAtIndex(1) == FuncPtrTy,
564 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000565 if (STy->getNumElements() == 3) {
566 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000567 Assert(ETy->isPointerTy() &&
568 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
569 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000570 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000571 }
572 }
573
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000574 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000575 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000576 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
577 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000578 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000579 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
580 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000581 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000582 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000583 const Constant *Init = GV.getInitializer();
584 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000585 Assert(InitArray, "wrong initalizer for intrinsic global variable",
586 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000587 for (Value *Op : InitArray->operands()) {
588 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000589 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
590 isa<GlobalAlias>(V),
591 "invalid llvm.used member", V);
592 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000593 }
594 }
595 }
596 }
597
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000598 Assert(!GV.hasDLLImportStorageClass() ||
599 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
600 GV.hasAvailableExternallyLinkage(),
601 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000602
Matt Arsenault24b49c42013-07-31 17:49:08 +0000603 if (!GV.hasInitializer()) {
604 visitGlobalValue(GV);
605 return;
606 }
607
608 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000609 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000610
Chris Lattnere3400652004-12-15 20:23:49 +0000611 visitGlobalValue(GV);
612}
613
Rafael Espindola64c1e182014-06-03 02:41:57 +0000614void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
615 SmallPtrSet<const GlobalAlias*, 4> Visited;
616 Visited.insert(&GA);
617 visitAliaseeSubExpr(Visited, GA, C);
618}
619
Craig Topper71b7b682014-08-21 05:55:13 +0000620void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000621 const GlobalAlias &GA, const Constant &C) {
622 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000623 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
624 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000625
626 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000627 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000628
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000629 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
630 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000631 } else {
632 // Only continue verifying subexpressions of GlobalAliases.
633 // Do not recurse into global initializers.
634 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000635 }
636 }
637
638 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000639 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000640
641 for (const Use &U : C.operands()) {
642 Value *V = &*U;
643 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
644 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
645 else if (const auto *C2 = dyn_cast<Constant>(V))
646 visitAliaseeSubExpr(Visited, GA, *C2);
647 }
648}
649
Chandler Carruth043949d2014-01-19 02:22:18 +0000650void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000651 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
652 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
653 "weak_odr, or external linkage!",
654 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000655 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000656 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
657 Assert(GA.getType() == Aliasee->getType(),
658 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000659
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000660 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
661 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000662
Rafael Espindola64c1e182014-06-03 02:41:57 +0000663 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000664
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000665 visitGlobalValue(GA);
666}
667
Chandler Carruth043949d2014-01-19 02:22:18 +0000668void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000669 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000670 if (NMD.getName() == "llvm.dbg.cu") {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000671 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000672 }
673
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000674 if (!MD)
675 continue;
676
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000677 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000678 }
679}
680
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000681void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000682 // Only visit each node once. Metadata can be mutually recursive, so this
683 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000684 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000685 return;
686
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000687 switch (MD.getMetadataID()) {
688 default:
689 llvm_unreachable("Invalid MDNode subclass");
690 case Metadata::MDTupleKind:
691 break;
692#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
693 case Metadata::CLASS##Kind: \
694 visit##CLASS(cast<CLASS>(MD)); \
695 break;
696#include "llvm/IR/Metadata.def"
697 }
698
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000699 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000700 if (!Op)
701 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000702 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
703 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000704 if (auto *N = dyn_cast<MDNode>(Op)) {
705 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000706 continue;
707 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000708 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
709 visitValueAsMetadata(*V, nullptr);
710 continue;
711 }
Duncan Sands76d62172010-04-29 16:10:30 +0000712 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000713
714 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000715 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
716 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000717}
718
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000719void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000720 Assert(MD.getValue(), "Expected valid value", &MD);
721 Assert(!MD.getValue()->getType()->isMetadataTy(),
722 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000723
724 auto *L = dyn_cast<LocalAsMetadata>(&MD);
725 if (!L)
726 return;
727
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000728 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000729
730 // If this was an instruction, bb, or argument, verify that it is in the
731 // function that we expect.
732 Function *ActualF = nullptr;
733 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000734 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000735 ActualF = I->getParent()->getParent();
736 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
737 ActualF = BB->getParent();
738 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
739 ActualF = A->getParent();
740 assert(ActualF && "Unimplemented function local metadata case!");
741
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000742 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000743}
744
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000745void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000746 Metadata *MD = MDV.getMetadata();
747 if (auto *N = dyn_cast<MDNode>(MD)) {
748 visitMDNode(*N);
749 return;
750 }
751
752 // Only visit each node once. Metadata can be mutually recursive, so this
753 // avoids infinite recursion here, as well as being an optimization.
754 if (!MDNodes.insert(MD).second)
755 return;
756
757 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
758 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000759}
760
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000761bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
762 auto *S = dyn_cast<MDString>(MD);
763 if (!S)
764 return false;
765 if (S->getString().empty())
766 return false;
767
768 // Keep track of names of types referenced via UUID so we can check that they
769 // actually exist.
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000770 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000771 return true;
772}
773
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000774/// \brief Check if a value can be a reference to a type.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000775bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000776 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000777}
778
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000779/// \brief Check if a value can be a ScopeRef.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000780bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000781 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000782}
783
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000784/// \brief Check if a value can be a debug info ref.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000785bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000786 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000787}
788
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000789template <class Ty>
790bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
791 for (Metadata *MD : N.operands()) {
792 if (MD) {
793 if (!isa<Ty>(MD))
794 return false;
795 } else {
796 if (!AllowNull)
797 return false;
798 }
799 }
800 return true;
801}
802
803template <class Ty>
804bool isValidMetadataArray(const MDTuple &N) {
805 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
806}
807
808template <class Ty>
809bool isValidMetadataNullArray(const MDTuple &N) {
810 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
811}
812
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000813void Verifier::visitDILocation(const DILocation &N) {
814 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000815 "location requires a valid scope", &N, N.getRawScope());
816 if (auto *IA = N.getRawInlinedAt())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000817 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000818}
819
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000820void Verifier::visitGenericDINode(const GenericDINode &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000821 Assert(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000822}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000823
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000824void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000825 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000826 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000827}
828
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000829void Verifier::visitDISubrange(const DISubrange &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000830 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000831 Assert(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000832}
833
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000834void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000835 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000836}
837
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000838void Verifier::visitDIBasicType(const DIBasicType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000839 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
840 N.getTag() == dwarf::DW_TAG_unspecified_type,
841 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000842}
843
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000844void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000845 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000846 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000847
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000848 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
849 N.getTag() == dwarf::DW_TAG_pointer_type ||
850 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
851 N.getTag() == dwarf::DW_TAG_reference_type ||
852 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
853 N.getTag() == dwarf::DW_TAG_const_type ||
854 N.getTag() == dwarf::DW_TAG_volatile_type ||
855 N.getTag() == dwarf::DW_TAG_restrict_type ||
856 N.getTag() == dwarf::DW_TAG_member ||
857 N.getTag() == dwarf::DW_TAG_inheritance ||
858 N.getTag() == dwarf::DW_TAG_friend,
859 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000860 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000861 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
862 N.getExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000863 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000864
865 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
866 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
867 N.getBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000868}
869
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000870static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000871 return (Flags & DINode::FlagLValueReference) &&
872 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000873}
874
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000875void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
876 auto *Params = dyn_cast<MDTuple>(&RawParams);
877 Assert(Params, "invalid template params", &N, &RawParams);
878 for (Metadata *Op : Params->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000879 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000880 Params, Op);
881 }
882}
883
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000884void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000885 // Common scope checks.
886 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000887
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000888 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
889 N.getTag() == dwarf::DW_TAG_structure_type ||
890 N.getTag() == dwarf::DW_TAG_union_type ||
891 N.getTag() == dwarf::DW_TAG_enumeration_type ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000892 N.getTag() == dwarf::DW_TAG_class_type,
893 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000894
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000895 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
896 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
897 N.getBaseType());
898
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000899 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
900 "invalid composite elements", &N, N.getRawElements());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000901 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000902 N.getRawVTableHolder());
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000903 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
904 &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000905 if (auto *Params = N.getRawTemplateParams())
906 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000907
908 if (N.getTag() == dwarf::DW_TAG_class_type ||
909 N.getTag() == dwarf::DW_TAG_union_type) {
910 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
911 "class/union requires a filename", &N, N.getFile());
912 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000913}
914
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000915void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000916 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000917 if (auto *Types = N.getRawTypeArray()) {
918 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
919 for (Metadata *Ty : N.getTypeArray()->operands()) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000920 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000921 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000922 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000923 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
924 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000925}
926
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000927void Verifier::visitDIFile(const DIFile &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000928 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000929}
930
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000931void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000932 Assert(N.isDistinct(), "compile units must be distinct", &N);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000933 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000934
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000935 // Don't bother verifying the compilation directory or producer string
936 // as those could be empty.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000937 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
938 N.getRawFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000939 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
940 N.getFile());
941
Adrian Prantlb939a252016-03-31 23:56:58 +0000942 Assert((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
943 "invalid emission kind", &N);
944
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000945 if (auto *Array = N.getRawEnumTypes()) {
946 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
947 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000948 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000949 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
950 "invalid enum type", &N, N.getEnumTypes(), Op);
951 }
952 }
953 if (auto *Array = N.getRawRetainedTypes()) {
954 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
955 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000956 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 }
958 }
959 if (auto *Array = N.getRawSubprograms()) {
960 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
961 for (Metadata *Op : N.getSubprograms()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000962 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000963 }
964 }
965 if (auto *Array = N.getRawGlobalVariables()) {
966 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
967 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000968 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000969 Op);
970 }
971 }
972 if (auto *Array = N.getRawImportedEntities()) {
973 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
974 for (Metadata *Op : N.getImportedEntities()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000975 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000976 Op);
977 }
978 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000979 if (auto *Array = N.getRawMacros()) {
980 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
981 for (Metadata *Op : N.getMacros()->operands()) {
982 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
983 }
984 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000985 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000986}
987
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000988void Verifier::visitDISubprogram(const DISubprogram &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000989 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000990 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000991 if (auto *T = N.getRawType())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000992 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000993 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000994 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000995 if (auto *Params = N.getRawTemplateParams())
996 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000997 if (auto *S = N.getRawDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000998 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000999 "invalid subprogram declaration", &N, S);
1000 }
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001001 if (auto *RawVars = N.getRawVariables()) {
1002 auto *Vars = dyn_cast<MDTuple>(RawVars);
1003 Assert(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001004 for (Metadata *Op : Vars->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001005 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001006 Op);
1007 }
1008 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +00001009 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
1010 &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001011
Duncan P. N. Exon Smith814b8e92015-08-28 20:26:49 +00001012 if (N.isDefinition())
1013 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001014}
1015
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001016void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001017 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001018 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001019 "invalid local scope", &N, N.getRawScope());
1020}
1021
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001022void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1023 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001024
1025 Assert(N.getLine() || !N.getColumn(),
1026 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001027}
1028
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001029void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1030 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001031}
1032
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001033void Verifier::visitDINamespace(const DINamespace &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001034 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001035 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001036 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001037}
1038
Amjad Abouda9bcf162015-12-10 12:56:35 +00001039void Verifier::visitDIMacro(const DIMacro &N) {
1040 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1041 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1042 "invalid macinfo type", &N);
1043 Assert(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001044 if (!N.getValue().empty()) {
1045 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1046 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001047}
1048
1049void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1050 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1051 "invalid macinfo type", &N);
1052 if (auto *F = N.getRawFile())
1053 Assert(isa<DIFile>(F), "invalid file", &N, F);
1054
1055 if (auto *Array = N.getRawElements()) {
1056 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1057 for (Metadata *Op : N.getElements()->operands()) {
1058 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1059 }
1060 }
1061}
1062
Adrian Prantlab1243f2015-06-29 23:03:47 +00001063void Verifier::visitDIModule(const DIModule &N) {
1064 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1065 Assert(!N.getName().empty(), "anonymous module", &N);
1066}
1067
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001068void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001069 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001070}
1071
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001072void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1073 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001074
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001075 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1076 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001077}
1078
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001079void Verifier::visitDITemplateValueParameter(
1080 const DITemplateValueParameter &N) {
1081 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001082
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001083 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1084 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1085 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1086 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001087}
1088
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001089void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001090 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001091 Assert(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001092 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001093 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001094 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001095}
1096
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001097void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001098 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001099 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001100
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001101 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smith94d58f82015-03-31 01:28:22 +00001102 Assert(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001103 if (auto *V = N.getRawVariable()) {
1104 Assert(isa<ConstantAsMetadata>(V) &&
1105 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1106 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001107 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001108 }
1109 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001110 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001111 &N, Member);
1112 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001113}
1114
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001115void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001116 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001117 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001118
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +00001119 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001120 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001121 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001122}
1123
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001124void Verifier::visitDIExpression(const DIExpression &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001125 Assert(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001126}
1127
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001128void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001129 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001130 if (auto *T = N.getRawType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001131 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001132 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001133 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001134}
1135
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001136void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001137 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1138 N.getTag() == dwarf::DW_TAG_imported_declaration,
1139 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001140 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001141 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001142 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1143 N.getEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001144}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001145
David Majnemerdad0a642014-06-27 18:19:56 +00001146void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001147 // The Module is invalid if the GlobalValue has private linkage. Entities
1148 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001149 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001150 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1151 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001152}
1153
Chandler Carruth043949d2014-01-19 02:22:18 +00001154void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001155 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1156 if (!Idents)
1157 return;
1158
1159 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1160 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001161 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001162 Assert(N->getNumOperands() == 1,
1163 "incorrect number of operands in llvm.ident metadata", N);
1164 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1165 ("invalid value for llvm.ident metadata entry operand"
1166 "(the operand should be a string)"),
1167 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001168 }
1169}
1170
Chandler Carruth043949d2014-01-19 02:22:18 +00001171void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001172 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1173 if (!Flags) return;
1174
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001175 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001176 DenseMap<const MDString*, const MDNode*> SeenIDs;
1177 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001178 for (const MDNode *MDN : Flags->operands())
1179 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001180
1181 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001182 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001183 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001184 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001185
Chandler Carruth043949d2014-01-19 02:22:18 +00001186 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001187 if (!Op) {
1188 CheckFailed("invalid requirement on flag, flag is not present in module",
1189 Flag);
1190 continue;
1191 }
1192
1193 if (Op->getOperand(2) != ReqValue) {
1194 CheckFailed(("invalid requirement on flag, "
1195 "flag does not have the required value"),
1196 Flag);
1197 continue;
1198 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001199 }
1200}
1201
Chandler Carruth043949d2014-01-19 02:22:18 +00001202void
1203Verifier::visitModuleFlag(const MDNode *Op,
1204 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1205 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001206 // Each module flag should have three arguments, the merge behavior (a
1207 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001208 Assert(Op->getNumOperands() == 3,
1209 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001210 Module::ModFlagBehavior MFB;
1211 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001212 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001213 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001214 "invalid behavior operand in module flag (expected constant integer)",
1215 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001216 Assert(false,
1217 "invalid behavior operand in module flag (unexpected constant)",
1218 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001219 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001220 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001221 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1222 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001223
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001224 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001225 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001226 case Module::Error:
1227 case Module::Warning:
1228 case Module::Override:
1229 // These behavior types accept any value.
1230 break;
1231
1232 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001233 // The value should itself be an MDNode with two operands, a flag ID (an
1234 // MDString), and a value.
1235 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001236 Assert(Value && Value->getNumOperands() == 2,
1237 "invalid value for 'require' module flag (expected metadata pair)",
1238 Op->getOperand(2));
1239 Assert(isa<MDString>(Value->getOperand(0)),
1240 ("invalid value for 'require' module flag "
1241 "(first value operand should be a string)"),
1242 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001243
1244 // Append it to the list of requirements, to check once all module flags are
1245 // scanned.
1246 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001247 break;
1248 }
1249
1250 case Module::Append:
1251 case Module::AppendUnique: {
1252 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001253 Assert(isa<MDNode>(Op->getOperand(2)),
1254 "invalid value for 'append'-type module flag "
1255 "(expected a metadata node)",
1256 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001257 break;
1258 }
1259 }
1260
1261 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001262 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001263 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001264 Assert(Inserted,
1265 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001266 }
1267}
1268
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001269void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001270 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001271 unsigned Slot = ~0U;
1272 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1273 if (Attrs.getSlotIndex(I) == Idx) {
1274 Slot = I;
1275 break;
1276 }
1277
1278 assert(Slot != ~0U && "Attribute set inconsistency!");
1279
1280 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1281 I != E; ++I) {
1282 if (I->isStringAttribute())
1283 continue;
1284
1285 if (I->getKindAsEnum() == Attribute::NoReturn ||
1286 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001287 I->getKindAsEnum() == Attribute::NoInline ||
1288 I->getKindAsEnum() == Attribute::AlwaysInline ||
1289 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1290 I->getKindAsEnum() == Attribute::StackProtect ||
1291 I->getKindAsEnum() == Attribute::StackProtectReq ||
1292 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001293 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001294 I->getKindAsEnum() == Attribute::NoRedZone ||
1295 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1296 I->getKindAsEnum() == Attribute::Naked ||
1297 I->getKindAsEnum() == Attribute::InlineHint ||
1298 I->getKindAsEnum() == Attribute::StackAlignment ||
1299 I->getKindAsEnum() == Attribute::UWTable ||
1300 I->getKindAsEnum() == Attribute::NonLazyBind ||
1301 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1302 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1303 I->getKindAsEnum() == Attribute::SanitizeThread ||
1304 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1305 I->getKindAsEnum() == Attribute::MinSize ||
1306 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001307 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001308 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001309 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001310 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001311 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001312 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001313 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001314 I->getKindAsEnum() == Attribute::NoRecurse ||
1315 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1316 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001317 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001318 CheckFailed("Attribute '" + I->getAsString() +
1319 "' only applies to functions!", V);
1320 return;
1321 }
1322 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1323 I->getKindAsEnum() == Attribute::ReadNone) {
1324 if (Idx == 0) {
1325 CheckFailed("Attribute '" + I->getAsString() +
1326 "' does not apply to function returns");
1327 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001328 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001329 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001330 CheckFailed("Attribute '" + I->getAsString() +
1331 "' does not apply to functions!", V);
1332 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001333 }
1334 }
1335}
1336
Duncan Sandsc3a79922009-06-11 08:11:03 +00001337// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001338// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001339void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001340 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001341 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001342 return;
1343
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001344 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001345
Bill Wendling908126a2012-10-09 09:51:10 +00001346 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001347 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1348 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1349 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1350 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1351 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001352 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001353 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1354 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001355 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001356 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001357 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001358 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001359
Reid Klecknera534a382013-12-19 02:14:12 +00001360 // Check for mutually incompatible attributes. Only inreg is compatible with
1361 // sret.
1362 unsigned AttrCount = 0;
1363 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1364 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1365 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1366 Attrs.hasAttribute(Idx, Attribute::InReg);
1367 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001368 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1369 "and 'sret' are incompatible!",
1370 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001371
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001372 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1373 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1374 "Attributes "
1375 "'inalloca and readonly' are incompatible!",
1376 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001377
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001378 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1379 Attrs.hasAttribute(Idx, Attribute::Returned)),
1380 "Attributes "
1381 "'sret and returned' are incompatible!",
1382 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001383
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001384 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1385 Attrs.hasAttribute(Idx, Attribute::SExt)),
1386 "Attributes "
1387 "'zeroext and signext' are incompatible!",
1388 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001389
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001390 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1391 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1392 "Attributes "
1393 "'readnone and readonly' are incompatible!",
1394 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001395
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001396 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1397 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1398 "Attributes "
1399 "'noinline and alwaysinline' are incompatible!",
1400 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001401
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001402 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001403 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001404 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001405 AttributeSet::get(*Context, Idx,
1406 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001407 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001408
Reid Klecknera534a382013-12-19 02:14:12 +00001409 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001410 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001411 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001412 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1413 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1414 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1415 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001416 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001417 if (!isa<PointerType>(PTy->getElementType()))
1418 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1419 "Attribute 'swifterror' only applies to parameters "
1420 "with pointer to pointer type!",
1421 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001422 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001423 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1424 "Attribute 'byval' only applies to parameters with pointer type!",
1425 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001426 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1427 "Attribute 'swifterror' only applies to parameters "
1428 "with pointer type!",
1429 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001430 }
Duncan Sands0009c442008-01-12 16:42:01 +00001431}
1432
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001433// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001434// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001435void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001436 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001437 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001438 return;
1439
Duncan Sands8c582282007-12-21 19:19:01 +00001440 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001441 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001442 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001443 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001444 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001445
Chris Lattner8a923e72008-03-12 17:45:29 +00001446 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001447 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001448
Chris Lattner229907c2011-07-18 04:54:35 +00001449 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001450 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001451 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001452 else if (Idx-1 < FT->getNumParams())
1453 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001454 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001455 break; // VarArgs attributes, verified elsewhere.
1456
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001457 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001458
Stephen Linb8bd2322013-04-20 05:14:40 +00001459 if (Idx == 0)
1460 continue;
1461
1462 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001463 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001464 SawNest = true;
1465 }
1466
Stephen Linb8bd2322013-04-20 05:14:40 +00001467 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001468 Assert(!SawReturned, "More than one parameter has attribute returned!",
1469 V);
1470 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1471 "Incompatible "
1472 "argument and return types for 'returned' attribute",
1473 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001474 SawReturned = true;
1475 }
1476
Reid Kleckner79418562014-05-09 22:32:13 +00001477 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001478 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1479 Assert(Idx == 1 || Idx == 2,
1480 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001481 SawSRet = true;
1482 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001483
Manman Renf46262e2016-03-29 17:37:21 +00001484 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1485 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1486 SawSwiftSelf = true;
1487 }
1488
Manman Ren9bfd0d02016-04-01 21:41:15 +00001489 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1490 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1491 V);
1492 SawSwiftError = true;
1493 }
1494
Reid Kleckner60d3a832014-01-16 22:59:24 +00001495 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001496 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1497 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001498 }
Duncan Sands8c582282007-12-21 19:19:01 +00001499 }
Devang Patel9cc98122008-10-01 23:41:25 +00001500
Bill Wendling77543892013-01-18 21:11:39 +00001501 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1502 return;
1503
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001504 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001505
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001506 Assert(
1507 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1508 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1509 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001510
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001511 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001512 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1513 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1514 Attribute::InaccessibleMemOrArgMemOnly)),
1515 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1516
1517 Assert(
1518 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1519 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1520 Attribute::InaccessibleMemOnly)),
1521 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1522
1523 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001524 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1525 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1526 Attribute::AlwaysInline)),
1527 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001528
1529 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1530 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001531 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1532 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001533
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001534 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1535 Attribute::OptimizeForSize),
1536 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001537
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001538 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1539 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001540 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001541
1542 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1543 Attribute::JumpTable)) {
1544 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001545 Assert(GV->hasUnnamedAddr(),
1546 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001547 }
Duncan Sands8c582282007-12-21 19:19:01 +00001548}
1549
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001550void Verifier::verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +00001551 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1552 if (MDs.empty())
1553 return;
1554
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001555 for (const auto &Pair : MDs) {
1556 if (Pair.first == LLVMContext::MD_prof) {
1557 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001558 Assert(MD->getNumOperands() == 2,
1559 "!prof annotations should have exactly 2 operands", MD);
1560
1561 // Check first operand.
1562 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1563 MD);
1564 Assert(isa<MDString>(MD->getOperand(0)),
1565 "expected string with name of the !prof annotation", MD);
1566 MDString *MDS = cast<MDString>(MD->getOperand(0));
1567 StringRef ProfName = MDS->getString();
1568 Assert(ProfName.equals("function_entry_count"),
1569 "first operand should be 'function_entry_count'", MD);
1570
1571 // Check second operand.
1572 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1573 MD);
1574 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1575 "expected integer argument to function_entry_count", MD);
1576 }
1577 }
1578}
1579
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001580void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1581 if (!ConstantExprVisited.insert(EntryC).second)
1582 return;
1583
1584 SmallVector<const Constant *, 16> Stack;
1585 Stack.push_back(EntryC);
1586
1587 while (!Stack.empty()) {
1588 const Constant *C = Stack.pop_back_val();
1589
1590 // Check this constant expression.
1591 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1592 visitConstantExpr(CE);
1593
Keno Fischerf6d17b92016-01-14 22:42:02 +00001594 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1595 // Global Values get visited separately, but we do need to make sure
1596 // that the global value is in the correct module
1597 Assert(GV->getParent() == M, "Referencing global in another module!",
1598 EntryC, M, GV, GV->getParent());
1599 continue;
1600 }
1601
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001602 // Visit all sub-expressions.
1603 for (const Use &U : C->operands()) {
1604 const auto *OpC = dyn_cast<Constant>(U);
1605 if (!OpC)
1606 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001607 if (!ConstantExprVisited.insert(OpC).second)
1608 continue;
1609 Stack.push_back(OpC);
1610 }
1611 }
1612}
1613
1614void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001615 if (CE->getOpcode() != Instruction::BitCast)
1616 return;
1617
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001618 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1619 CE->getType()),
1620 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001621}
1622
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001623bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001624 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001625 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001626
Devang Patel82fed672008-09-23 22:35:17 +00001627 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001628 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001629 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001630 || (LastIndex == AttributeSet::FunctionIndex
1631 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001632 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001633
Devang Patel82fed672008-09-23 22:35:17 +00001634 return false;
1635}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001636
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001637/// Verify that statepoint intrinsic is well formed.
1638void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001639 assert(CS.getCalledFunction() &&
1640 CS.getCalledFunction()->getIntrinsicID() ==
1641 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001642
Philip Reames0285c742015-02-03 23:18:47 +00001643 const Instruction &CI = *CS.getInstruction();
1644
Igor Laevsky39d662f2015-07-11 10:30:36 +00001645 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1646 !CS.onlyAccessesArgMemory(),
1647 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001648 "reordering restrictions required by safepoint semantics",
1649 &CI);
1650
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001651 const Value *IDV = CS.getArgument(0);
1652 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1653 &CI);
1654
1655 const Value *NumPatchBytesV = CS.getArgument(1);
1656 Assert(isa<ConstantInt>(NumPatchBytesV),
1657 "gc.statepoint number of patchable bytes must be a constant integer",
1658 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001659 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001660 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1661 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1662 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1663 "positive",
1664 &CI);
1665
1666 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001667 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001668 Assert(PT && PT->getElementType()->isFunctionTy(),
1669 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001670 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001671
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001672 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001673 Assert(isa<ConstantInt>(NumCallArgsV),
1674 "gc.statepoint number of arguments to underlying call "
1675 "must be constant integer",
1676 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001677 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001678 Assert(NumCallArgs >= 0,
1679 "gc.statepoint number of arguments to underlying call "
1680 "must be positive",
1681 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001682 const int NumParams = (int)TargetFuncType->getNumParams();
1683 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001684 Assert(NumCallArgs >= NumParams,
1685 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001686
1687 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001688 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1689 "gc.statepoint doesn't support wrapping non-void "
1690 "vararg functions yet",
1691 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001692 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001693 Assert(NumCallArgs == NumParams,
1694 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001695
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001696 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001697 Assert(isa<ConstantInt>(FlagsV),
1698 "gc.statepoint flags must be constant integer", &CI);
1699 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1700 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1701 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001702
1703 // Verify that the types of the call parameter arguments match
1704 // the type of the wrapped callee.
1705 for (int i = 0; i < NumParams; i++) {
1706 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001707 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001708 Assert(ArgType == ParamType,
1709 "gc.statepoint call argument does not match wrapped "
1710 "function type",
1711 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001712 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001713
1714 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001715
1716 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1717 Assert(isa<ConstantInt>(NumTransitionArgsV),
1718 "gc.statepoint number of transition arguments "
1719 "must be constant integer",
1720 &CI);
1721 const int NumTransitionArgs =
1722 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1723 Assert(NumTransitionArgs >= 0,
1724 "gc.statepoint number of transition arguments must be positive", &CI);
1725 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1726
1727 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001728 Assert(isa<ConstantInt>(NumDeoptArgsV),
1729 "gc.statepoint number of deoptimization arguments "
1730 "must be constant integer",
1731 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001732 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001733 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1734 "must be positive",
1735 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001736
Pat Gavlincc0431d2015-05-08 18:07:42 +00001737 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001738 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001739 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001740 "gc.statepoint too few arguments according to length fields", &CI);
1741
Philip Reames1ffa9372015-01-30 23:28:05 +00001742 // Check that the only uses of this gc.statepoint are gc.result or
1743 // gc.relocate calls which are tied to this statepoint and thus part
1744 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001745 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001746 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001747 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001748 if (!Call) continue;
Manuel Jacob83eefa62016-01-05 04:03:00 +00001749 Assert(isa<GCRelocateInst>(Call) || isGCResult(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001750 "gc.result or gc.relocate are the only value uses"
1751 "of a gc.statepoint",
1752 &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001753 if (isGCResult(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001754 Assert(Call->getArgOperand(0) == &CI,
1755 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001756 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001757 Assert(Call->getArgOperand(0) == &CI,
1758 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001759 }
1760 }
1761
1762 // Note: It is legal for a single derived pointer to be listed multiple
1763 // times. It's non-optimal, but it is legal. It can also happen after
1764 // insertion if we strip a bitcast away.
1765 // Note: It is really tempting to check that each base is relocated and
1766 // that a derived pointer is never reused as a base pointer. This turns
1767 // out to be problematic since optimizations run after safepoint insertion
1768 // can recognize equality properties that the insertion logic doesn't know
1769 // about. See example statepoint.ll in the verifier subdirectory
1770}
1771
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001772void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001773 for (auto &Counts : FrameEscapeInfo) {
1774 Function *F = Counts.first;
1775 unsigned EscapedObjectCount = Counts.second.first;
1776 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001777 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001778 "all indices passed to llvm.localrecover must be less than the "
1779 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001780 "function",
1781 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001782 }
1783}
1784
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001785static Instruction *getSuccPad(TerminatorInst *Terminator) {
1786 BasicBlock *UnwindDest;
1787 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1788 UnwindDest = II->getUnwindDest();
1789 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1790 UnwindDest = CSI->getUnwindDest();
1791 else
1792 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1793 return UnwindDest->getFirstNonPHI();
1794}
1795
1796void Verifier::verifySiblingFuncletUnwinds() {
1797 SmallPtrSet<Instruction *, 8> Visited;
1798 SmallPtrSet<Instruction *, 8> Active;
1799 for (const auto &Pair : SiblingFuncletInfo) {
1800 Instruction *PredPad = Pair.first;
1801 if (Visited.count(PredPad))
1802 continue;
1803 Active.insert(PredPad);
1804 TerminatorInst *Terminator = Pair.second;
1805 do {
1806 Instruction *SuccPad = getSuccPad(Terminator);
1807 if (Active.count(SuccPad)) {
1808 // Found a cycle; report error
1809 Instruction *CyclePad = SuccPad;
1810 SmallVector<Instruction *, 8> CycleNodes;
1811 do {
1812 CycleNodes.push_back(CyclePad);
1813 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1814 if (CycleTerminator != CyclePad)
1815 CycleNodes.push_back(CycleTerminator);
1816 CyclePad = getSuccPad(CycleTerminator);
1817 } while (CyclePad != SuccPad);
1818 Assert(false, "EH pads can't handle each other's exceptions",
1819 ArrayRef<Instruction *>(CycleNodes));
1820 }
1821 // Don't re-walk a node we've already checked
1822 if (!Visited.insert(SuccPad).second)
1823 break;
1824 // Walk to this successor if it has a map entry.
1825 PredPad = SuccPad;
1826 auto TermI = SiblingFuncletInfo.find(PredPad);
1827 if (TermI == SiblingFuncletInfo.end())
1828 break;
1829 Terminator = TermI->second;
1830 Active.insert(PredPad);
1831 } while (true);
1832 // Each node only has one successor, so we've walked all the active
1833 // nodes' successors.
1834 Active.clear();
1835 }
1836}
1837
Chris Lattner0e851da2002-04-18 20:37:37 +00001838// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001839//
Chandler Carruth043949d2014-01-19 02:22:18 +00001840void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001841 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001842 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001843 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001844
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001845 Assert(Context == &F.getContext(),
1846 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001847
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001848 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1849 Assert(FT->getNumParams() == NumArgs,
1850 "# formal arguments must match # of arguments for function type!", &F,
1851 FT);
1852 Assert(F.getReturnType()->isFirstClassType() ||
1853 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1854 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001855
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001856 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1857 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001858
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001859 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001860
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001861 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001862 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001863
Duncan Sands8c582282007-12-21 19:19:01 +00001864 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001865 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001866
Michael Gottesman41748d72013-06-27 00:25:01 +00001867 // On function declarations/definitions, we do not support the builtin
1868 // attribute. We do not check this in VerifyFunctionAttrs since that is
1869 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001870 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1871 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001872
Chris Lattneref13ee32006-05-19 21:25:17 +00001873 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001874 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1875 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001876 switch (F.getCallingConv()) {
1877 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001878 case CallingConv::C:
1879 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001880 case CallingConv::Fast:
1881 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001882 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001883 case CallingConv::PTX_Kernel:
1884 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001885 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1886 "perfect forwarding!",
1887 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001888 break;
1889 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001890
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001891 bool isLLVMdotName = F.getName().size() >= 5 &&
1892 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001893
Chris Lattneraf95e582002-04-13 22:48:46 +00001894 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001895 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001896 for (const Argument &Arg : F.args()) {
1897 Assert(Arg.getType() == FT->getParamType(i),
1898 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001899 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001900 Assert(Arg.getType()->isFirstClassType(),
1901 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001902 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001903 Assert(!Arg.getType()->isMetadataTy(),
1904 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1905 Assert(!Arg.getType()->isTokenTy(),
1906 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001907 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001908
1909 // Check that swifterror argument is only used by loads and stores.
1910 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1911 verifySwiftErrorValue(&Arg);
1912 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001913 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001914 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001915
David Majnemerb611e3f2015-08-14 05:09:07 +00001916 if (!isLLVMdotName)
1917 Assert(!F.getReturnType()->isTokenTy(),
1918 "Functions returns a token but isn't an intrinsic", &F);
1919
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001920 // Get the function metadata attachments.
1921 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1922 F.getAllMetadata(MDs);
1923 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001924 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001925
Keno Fischer2ac0c272015-11-16 05:13:30 +00001926 // Check validity of the personality function
1927 if (F.hasPersonalityFn()) {
1928 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1929 if (Per)
1930 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001931 "Referencing personality function in another module!",
1932 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001933 }
1934
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001935 if (F.isMaterializable()) {
1936 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001937 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1938 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001939 } else if (F.isDeclaration()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001940 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1941 "invalid linkage type for function declaration", &F);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001942 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1943 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001944 Assert(!F.hasPersonalityFn(),
1945 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001946 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001947 // Verify that this function (which has a body) is not named "llvm.*". It
1948 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001949 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001950
Chris Lattner149376d2002-10-13 20:57:00 +00001951 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001952 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001953 Assert(pred_empty(Entry),
1954 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001955
Chris Lattner27471742009-11-01 04:08:01 +00001956 // The address of the entry block cannot be taken, unless it is dead.
1957 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001958 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1959 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001960 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001961
1962 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001963 for (const auto &I : MDs) {
1964 // Verify that the attachment is legal.
1965 switch (I.first) {
1966 default:
1967 break;
1968 case LLVMContext::MD_dbg:
1969 Assert(isa<DISubprogram>(I.second),
1970 "function !dbg attachment must be a subprogram", &F, I.second);
1971 break;
1972 }
1973
1974 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001975 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001976 }
Chris Lattner149376d2002-10-13 20:57:00 +00001977 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001978
Chris Lattner7730dcc2009-09-11 17:05:29 +00001979 // If this function is actually an intrinsic, verify that it is only used in
1980 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00001981 // Only do this if the module is materialized, otherwise we don't have all the
1982 // uses.
1983 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001984 const User *U;
1985 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001986 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00001987 }
Nico Rieck7157bb72014-01-14 15:22:47 +00001988
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001989 Assert(!F.hasDLLImportStorageClass() ||
1990 (F.isDeclaration() && F.hasExternalLinkage()) ||
1991 F.hasAvailableExternallyLinkage(),
1992 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00001993
1994 auto *N = F.getSubprogram();
1995 if (!N)
1996 return;
1997
1998 // Check that all !dbg attachments lead to back to N (or, at least, another
1999 // subprogram that describes the same function).
2000 //
2001 // FIXME: Check this incrementally while visiting !dbg attachments.
2002 // FIXME: Only check when N is the canonical subprogram for F.
2003 SmallPtrSet<const MDNode *, 32> Seen;
2004 for (auto &BB : F)
2005 for (auto &I : BB) {
2006 // Be careful about using DILocation here since we might be dealing with
2007 // broken code (this is the Verifier after all).
2008 DILocation *DL =
2009 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2010 if (!DL)
2011 continue;
2012 if (!Seen.insert(DL).second)
2013 continue;
2014
2015 DILocalScope *Scope = DL->getInlinedAtScope();
2016 if (Scope && !Seen.insert(Scope).second)
2017 continue;
2018
2019 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002020
2021 // Scope and SP could be the same MDNode and we don't want to skip
2022 // validation in that case
2023 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002024 continue;
2025
2026 // FIXME: Once N is canonical, check "SP == &N".
2027 Assert(SP->describes(&F),
2028 "!dbg attachment points at wrong subprogram for function", N, &F,
2029 &I, DL, Scope, SP);
2030 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002031}
2032
Chris Lattner0e851da2002-04-18 20:37:37 +00002033// verifyBasicBlock - Verify that a basic block is well formed...
2034//
Chris Lattner069a7952002-06-25 15:56:27 +00002035void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002036 InstsInThisBlock.clear();
2037
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002038 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002039 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002040
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002041 // Check constraints that this basic block imposes on all of the PHI nodes in
2042 // it.
2043 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002044 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2045 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002046 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002047 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002048 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002049 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002050 Assert(PN->getNumIncomingValues() != 0,
2051 "PHI nodes must have at least one entry. If the block is dead, "
2052 "the PHI should be removed!",
2053 PN);
2054 Assert(PN->getNumIncomingValues() == Preds.size(),
2055 "PHINode should have one entry for each predecessor of its "
2056 "parent basic block!",
2057 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002058
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002059 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002060 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002061 Values.reserve(PN->getNumIncomingValues());
2062 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2063 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2064 PN->getIncomingValue(i)));
2065 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002066
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002067 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2068 // Check to make sure that if there is more than one entry for a
2069 // particular basic block in this PHI node, that the incoming values are
2070 // all identical.
2071 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002072 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2073 Values[i].second == Values[i - 1].second,
2074 "PHI node has multiple entries for the same basic block with "
2075 "different incoming values!",
2076 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002077
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002078 // Check to make sure that the predecessors and PHI node entries are
2079 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002080 Assert(Values[i].first == Preds[i],
2081 "PHI node entries do not match predecessors!", PN,
2082 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002083 }
2084 }
2085 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002086
2087 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002088 for (auto &I : BB)
2089 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002090 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002091 }
Chris Lattner069a7952002-06-25 15:56:27 +00002092}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002093
Chris Lattner069a7952002-06-25 15:56:27 +00002094void Verifier::visitTerminatorInst(TerminatorInst &I) {
2095 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002096 Assert(&I == I.getParent()->getTerminator(),
2097 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002098 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002099}
2100
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002101void Verifier::visitBranchInst(BranchInst &BI) {
2102 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002103 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2104 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002105 }
2106 visitTerminatorInst(BI);
2107}
2108
Chris Lattner069a7952002-06-25 15:56:27 +00002109void Verifier::visitReturnInst(ReturnInst &RI) {
2110 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002111 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002112 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002113 Assert(N == 0,
2114 "Found return instr that returns non-void in Function of void "
2115 "return type!",
2116 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002117 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002118 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2119 "Function return type does not match operand "
2120 "type of return inst!",
2121 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002122
Misha Brukman7eb05a12003-08-18 14:43:39 +00002123 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002124 // terminators...
2125 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002126}
2127
Chris Lattnerab5aa142004-05-21 16:47:21 +00002128void Verifier::visitSwitchInst(SwitchInst &SI) {
2129 // Check to make sure that all of the constants in the switch instruction
2130 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002131 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002132 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002133 for (auto &Case : SI.cases()) {
2134 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002135 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002136 Assert(Constants.insert(Case.getCaseValue()).second,
2137 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002138 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002139
Chris Lattnerab5aa142004-05-21 16:47:21 +00002140 visitTerminatorInst(SI);
2141}
2142
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002143void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002144 Assert(BI.getAddress()->getType()->isPointerTy(),
2145 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002146 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002147 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2148 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002149
2150 visitTerminatorInst(BI);
2151}
2152
Chris Lattner75648e72004-03-12 05:54:31 +00002153void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002154 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2155 SI.getOperand(2)),
2156 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002157
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002158 Assert(SI.getTrueValue()->getType() == SI.getType(),
2159 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002160 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002161}
2162
Misha Brukmanc566ca362004-03-02 00:22:19 +00002163/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2164/// a pass, if any exist, it's an error.
2165///
Chris Lattner903a25d2002-11-21 16:54:22 +00002166void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002167 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002168}
Chris Lattner0e851da2002-04-18 20:37:37 +00002169
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002170void Verifier::visitTruncInst(TruncInst &I) {
2171 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002172 Type *SrcTy = I.getOperand(0)->getType();
2173 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002174
2175 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002176 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2177 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002178
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002179 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2180 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2181 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2182 "trunc source and destination must both be a vector or neither", &I);
2183 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002184
2185 visitInstruction(I);
2186}
2187
2188void Verifier::visitZExtInst(ZExtInst &I) {
2189 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002190 Type *SrcTy = I.getOperand(0)->getType();
2191 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002192
2193 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002194 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2195 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2196 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2197 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002198 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2199 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002200
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002201 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002202
2203 visitInstruction(I);
2204}
2205
2206void Verifier::visitSExtInst(SExtInst &I) {
2207 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002208 Type *SrcTy = I.getOperand(0)->getType();
2209 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002210
2211 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002212 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2213 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002214
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002215 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2216 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2217 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2218 "sext source and destination must both be a vector or neither", &I);
2219 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002220
2221 visitInstruction(I);
2222}
2223
2224void Verifier::visitFPTruncInst(FPTruncInst &I) {
2225 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002226 Type *SrcTy = I.getOperand(0)->getType();
2227 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002228 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002229 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2230 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002231
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002232 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2233 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2234 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2235 "fptrunc source and destination must both be a vector or neither", &I);
2236 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002237
2238 visitInstruction(I);
2239}
2240
2241void Verifier::visitFPExtInst(FPExtInst &I) {
2242 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002243 Type *SrcTy = I.getOperand(0)->getType();
2244 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002245
2246 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002247 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2248 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002249
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002250 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2251 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2252 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2253 "fpext source and destination must both be a vector or neither", &I);
2254 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002255
2256 visitInstruction(I);
2257}
2258
2259void Verifier::visitUIToFPInst(UIToFPInst &I) {
2260 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002261 Type *SrcTy = I.getOperand(0)->getType();
2262 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002263
Duncan Sands19d0b472010-02-16 11:11:14 +00002264 bool SrcVec = SrcTy->isVectorTy();
2265 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002266
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002267 Assert(SrcVec == DstVec,
2268 "UIToFP source and dest must both be vector or scalar", &I);
2269 Assert(SrcTy->isIntOrIntVectorTy(),
2270 "UIToFP source must be integer or integer vector", &I);
2271 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2272 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002273
2274 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002275 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2276 cast<VectorType>(DestTy)->getNumElements(),
2277 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002278
2279 visitInstruction(I);
2280}
2281
2282void Verifier::visitSIToFPInst(SIToFPInst &I) {
2283 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002284 Type *SrcTy = I.getOperand(0)->getType();
2285 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002286
Duncan Sands19d0b472010-02-16 11:11:14 +00002287 bool SrcVec = SrcTy->isVectorTy();
2288 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002289
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002290 Assert(SrcVec == DstVec,
2291 "SIToFP source and dest must both be vector or scalar", &I);
2292 Assert(SrcTy->isIntOrIntVectorTy(),
2293 "SIToFP source must be integer or integer vector", &I);
2294 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2295 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002296
2297 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002298 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2299 cast<VectorType>(DestTy)->getNumElements(),
2300 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002301
2302 visitInstruction(I);
2303}
2304
2305void Verifier::visitFPToUIInst(FPToUIInst &I) {
2306 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002307 Type *SrcTy = I.getOperand(0)->getType();
2308 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002309
Duncan Sands19d0b472010-02-16 11:11:14 +00002310 bool SrcVec = SrcTy->isVectorTy();
2311 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002312
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002313 Assert(SrcVec == DstVec,
2314 "FPToUI source and dest must both be vector or scalar", &I);
2315 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2316 &I);
2317 Assert(DestTy->isIntOrIntVectorTy(),
2318 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002319
2320 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002321 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2322 cast<VectorType>(DestTy)->getNumElements(),
2323 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002324
2325 visitInstruction(I);
2326}
2327
2328void Verifier::visitFPToSIInst(FPToSIInst &I) {
2329 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002330 Type *SrcTy = I.getOperand(0)->getType();
2331 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002332
Duncan Sands19d0b472010-02-16 11:11:14 +00002333 bool SrcVec = SrcTy->isVectorTy();
2334 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002335
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002336 Assert(SrcVec == DstVec,
2337 "FPToSI source and dest must both be vector or scalar", &I);
2338 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2339 &I);
2340 Assert(DestTy->isIntOrIntVectorTy(),
2341 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002342
2343 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002344 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2345 cast<VectorType>(DestTy)->getNumElements(),
2346 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002347
2348 visitInstruction(I);
2349}
2350
2351void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2352 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002353 Type *SrcTy = I.getOperand(0)->getType();
2354 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002355
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002356 Assert(SrcTy->getScalarType()->isPointerTy(),
2357 "PtrToInt source must be pointer", &I);
2358 Assert(DestTy->getScalarType()->isIntegerTy(),
2359 "PtrToInt result must be integral", &I);
2360 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2361 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002362
2363 if (SrcTy->isVectorTy()) {
2364 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2365 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002366 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2367 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002368 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002369
2370 visitInstruction(I);
2371}
2372
2373void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2374 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002375 Type *SrcTy = I.getOperand(0)->getType();
2376 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002377
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002378 Assert(SrcTy->getScalarType()->isIntegerTy(),
2379 "IntToPtr source must be an integral", &I);
2380 Assert(DestTy->getScalarType()->isPointerTy(),
2381 "IntToPtr result must be a pointer", &I);
2382 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2383 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002384 if (SrcTy->isVectorTy()) {
2385 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2386 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002387 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2388 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002389 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002390 visitInstruction(I);
2391}
2392
2393void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002394 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002395 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2396 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002397 visitInstruction(I);
2398}
2399
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002400void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2401 Type *SrcTy = I.getOperand(0)->getType();
2402 Type *DestTy = I.getType();
2403
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002404 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2405 &I);
2406 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2407 &I);
2408 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2409 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002410 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002411 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2412 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002413 visitInstruction(I);
2414}
2415
Misha Brukmanc566ca362004-03-02 00:22:19 +00002416/// visitPHINode - Ensure that a PHI node is well formed.
2417///
Chris Lattner069a7952002-06-25 15:56:27 +00002418void Verifier::visitPHINode(PHINode &PN) {
2419 // Ensure that the PHI nodes are all grouped together at the top of the block.
2420 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002421 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002422 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002423 Assert(&PN == &PN.getParent()->front() ||
2424 isa<PHINode>(--BasicBlock::iterator(&PN)),
2425 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002426
David Majnemerb611e3f2015-08-14 05:09:07 +00002427 // Check that a PHI doesn't yield a Token.
2428 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2429
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002430 // Check that all of the values of the PHI node have the same type as the
2431 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002432 for (Value *IncValue : PN.incoming_values()) {
2433 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002434 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002435 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002436
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002437 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002438
2439 visitInstruction(PN);
2440}
2441
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002442void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002443 Instruction *I = CS.getInstruction();
2444
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002445 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2446 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002447 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002448
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002449 Assert(FPTy->getElementType()->isFunctionTy(),
2450 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002451
2452 Assert(FPTy->getElementType() == CS.getFunctionType(),
2453 "Called function is not the same type as the call!", I);
2454
2455 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002456
2457 // Verify that the correct number of arguments are being passed
2458 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002459 Assert(CS.arg_size() >= FTy->getNumParams(),
2460 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002461 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002462 Assert(CS.arg_size() == FTy->getNumParams(),
2463 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002464
Chris Lattner609de002010-05-10 20:58:42 +00002465 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002466 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002467 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2468 "Call parameter type does not match function signature!",
2469 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002470
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002471 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002472
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002473 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002474 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002475
Duncan Sands8c582282007-12-21 19:19:01 +00002476 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002477 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002478
David Majnemer91db08b2014-04-30 17:22:00 +00002479 // Conservatively check the inalloca argument.
2480 // We have a bug if we can find that there is an underlying alloca without
2481 // inalloca.
2482 if (CS.hasInAllocaArgument()) {
2483 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2484 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002485 Assert(AI->isUsedWithInAlloca(),
2486 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002487 }
2488
Manman Ren9bfd0d02016-04-01 21:41:15 +00002489 // For each argument of the callsite, if it has the swifterror argument,
2490 // make sure the underlying alloca has swifterror as well.
2491 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2492 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2493 Value *SwiftErrorArg = CS.getArgument(i);
2494 auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets());
2495 Assert(AI, "swifterror argument should come from alloca", AI, I);
2496 if (AI)
2497 Assert(AI->isSwiftError(),
2498 "swifterror argument for call has mismatched alloca", AI, I);
2499 }
2500
Stephen Linb8bd2322013-04-20 05:14:40 +00002501 if (FTy->isVarArg()) {
2502 // FIXME? is 'nest' even legal here?
2503 bool SawNest = false;
2504 bool SawReturned = false;
2505
2506 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2507 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2508 SawNest = true;
2509 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2510 SawReturned = true;
2511 }
2512
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002513 // Check attributes on the varargs part.
2514 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002515 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002516 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002517
Stephen Linb8bd2322013-04-20 05:14:40 +00002518 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002519 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002520 SawNest = true;
2521 }
2522
2523 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002524 Assert(!SawReturned, "More than one parameter has attribute returned!",
2525 I);
2526 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2527 "Incompatible argument and return types for 'returned' "
2528 "attribute",
2529 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002530 SawReturned = true;
2531 }
Duncan Sands0009c442008-01-12 16:42:01 +00002532
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002533 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2534 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002535
2536 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002537 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002538 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002539 }
Duncan Sands8c582282007-12-21 19:19:01 +00002540
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002541 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002542 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002543 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002544 for (Type *ParamTy : FTy->params()) {
2545 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002546 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002547 Assert(!ParamTy->isTokenTy(),
2548 "Function has token parameter but isn't an intrinsic", I);
2549 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002550 }
2551
David Majnemerb611e3f2015-08-14 05:09:07 +00002552 // Verify that indirect calls don't return tokens.
2553 if (CS.getCalledFunction() == nullptr)
2554 Assert(!FTy->getReturnType()->isTokenTy(),
2555 "Return type cannot be token for indirect call!");
2556
Philip Reamesa3c6f002015-06-26 21:39:44 +00002557 if (Function *F = CS.getCalledFunction())
2558 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002559 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002560
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002561 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2562 // at most one "gc-transition" operand bundle.
2563 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2564 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002565 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002566 OperandBundleUse BU = CS.getOperandBundleAt(i);
2567 uint32_t Tag = BU.getTagID();
2568 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002569 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2570 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002571 } else if (Tag == LLVMContext::OB_gc_transition) {
2572 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2573 I);
2574 FoundGCTransitionBundle = true;
2575 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002576 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2577 FoundFuncletBundle = true;
2578 Assert(BU.Inputs.size() == 1,
2579 "Expected exactly one funclet bundle operand", I);
2580 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2581 "Funclet bundle operands should correspond to a FuncletPadInst",
2582 I);
2583 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002584 }
2585
Duncan Sands8c582282007-12-21 19:19:01 +00002586 visitInstruction(*I);
2587}
2588
Reid Kleckner5772b772014-04-24 20:14:34 +00002589/// Two types are "congruent" if they are identical, or if they are both pointer
2590/// types with different pointee types and the same address space.
2591static bool isTypeCongruent(Type *L, Type *R) {
2592 if (L == R)
2593 return true;
2594 PointerType *PL = dyn_cast<PointerType>(L);
2595 PointerType *PR = dyn_cast<PointerType>(R);
2596 if (!PL || !PR)
2597 return false;
2598 return PL->getAddressSpace() == PR->getAddressSpace();
2599}
2600
Reid Klecknerd20c9702014-05-15 23:58:57 +00002601static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2602 static const Attribute::AttrKind ABIAttrs[] = {
2603 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002604 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2605 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002606 AttrBuilder Copy;
2607 for (auto AK : ABIAttrs) {
2608 if (Attrs.hasAttribute(I + 1, AK))
2609 Copy.addAttribute(AK);
2610 }
2611 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2612 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2613 return Copy;
2614}
2615
Reid Kleckner5772b772014-04-24 20:14:34 +00002616void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002617 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002618
2619 // - The caller and callee prototypes must match. Pointer types of
2620 // parameters or return types may differ in pointee type, but not
2621 // address space.
2622 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002623 FunctionType *CallerTy = F->getFunctionType();
2624 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002625 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2626 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2627 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2628 "cannot guarantee tail call due to mismatched varargs", &CI);
2629 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2630 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002631 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002632 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002633 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2634 "cannot guarantee tail call due to mismatched parameter types", &CI);
2635 }
2636
2637 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002638 Assert(F->getCallingConv() == CI.getCallingConv(),
2639 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002640
2641 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2642 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002643 AttributeSet CallerAttrs = F->getAttributes();
2644 AttributeSet CalleeAttrs = CI.getAttributes();
2645 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002646 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2647 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002648 Assert(CallerABIAttrs == CalleeABIAttrs,
2649 "cannot guarantee tail call due to mismatched ABI impacting "
2650 "function attributes",
2651 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002652 }
2653
2654 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2655 // or a pointer bitcast followed by a ret instruction.
2656 // - The ret instruction must return the (possibly bitcasted) value
2657 // produced by the call or void.
2658 Value *RetVal = &CI;
2659 Instruction *Next = CI.getNextNode();
2660
2661 // Handle the optional bitcast.
2662 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002663 Assert(BI->getOperand(0) == RetVal,
2664 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002665 RetVal = BI;
2666 Next = BI->getNextNode();
2667 }
2668
2669 // Check the return.
2670 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002671 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2672 &CI);
2673 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2674 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002675}
2676
Duncan Sands8c582282007-12-21 19:19:01 +00002677void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002678 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002679
Reid Kleckner5772b772014-04-24 20:14:34 +00002680 if (CI.isMustTailCall())
2681 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002682}
2683
2684void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002685 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002686
David Majnemer654e1302015-07-31 17:58:14 +00002687 // Verify that the first non-PHI instruction of the unwind destination is an
2688 // exception handling instruction.
2689 Assert(
2690 II.getUnwindDest()->isEHPad(),
2691 "The unwind destination does not have an exception handling instruction!",
2692 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002693
Dan Gohman9c6e1882010-08-02 23:09:14 +00002694 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002695}
Chris Lattner0e851da2002-04-18 20:37:37 +00002696
Misha Brukmanc566ca362004-03-02 00:22:19 +00002697/// visitBinaryOperator - Check that both arguments to the binary operator are
2698/// of the same type!
2699///
Chris Lattner069a7952002-06-25 15:56:27 +00002700void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002701 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2702 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002703
Reid Spencer2341c222007-02-02 02:16:23 +00002704 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002705 // Check that integer arithmetic operators are only used with
2706 // integral operands.
2707 case Instruction::Add:
2708 case Instruction::Sub:
2709 case Instruction::Mul:
2710 case Instruction::SDiv:
2711 case Instruction::UDiv:
2712 case Instruction::SRem:
2713 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002714 Assert(B.getType()->isIntOrIntVectorTy(),
2715 "Integer arithmetic operators only work with integral types!", &B);
2716 Assert(B.getType() == B.getOperand(0)->getType(),
2717 "Integer arithmetic operators must have same type "
2718 "for operands and result!",
2719 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002720 break;
2721 // Check that floating-point arithmetic operators are only used with
2722 // floating-point operands.
2723 case Instruction::FAdd:
2724 case Instruction::FSub:
2725 case Instruction::FMul:
2726 case Instruction::FDiv:
2727 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002728 Assert(B.getType()->isFPOrFPVectorTy(),
2729 "Floating-point arithmetic operators only work with "
2730 "floating-point types!",
2731 &B);
2732 Assert(B.getType() == B.getOperand(0)->getType(),
2733 "Floating-point arithmetic operators must have same type "
2734 "for operands and result!",
2735 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002736 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002737 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002738 case Instruction::And:
2739 case Instruction::Or:
2740 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002741 Assert(B.getType()->isIntOrIntVectorTy(),
2742 "Logical operators only work with integral types!", &B);
2743 Assert(B.getType() == B.getOperand(0)->getType(),
2744 "Logical operators must have same type for operands and result!",
2745 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002746 break;
2747 case Instruction::Shl:
2748 case Instruction::LShr:
2749 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002750 Assert(B.getType()->isIntOrIntVectorTy(),
2751 "Shifts only work with integral types!", &B);
2752 Assert(B.getType() == B.getOperand(0)->getType(),
2753 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002754 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002755 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002756 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002757 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002758
Chris Lattner0e851da2002-04-18 20:37:37 +00002759 visitInstruction(B);
2760}
2761
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002762void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002763 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002764 Type *Op0Ty = IC.getOperand(0)->getType();
2765 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002766 Assert(Op0Ty == Op1Ty,
2767 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002768 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002769 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2770 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002771 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002772 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2773 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2774 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002775
Reid Spencerd9436b62006-11-20 01:22:35 +00002776 visitInstruction(IC);
2777}
2778
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002779void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002780 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002781 Type *Op0Ty = FC.getOperand(0)->getType();
2782 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002783 Assert(Op0Ty == Op1Ty,
2784 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002785 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002786 Assert(Op0Ty->isFPOrFPVectorTy(),
2787 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002788 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002789 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2790 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2791 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002792
Reid Spencerd9436b62006-11-20 01:22:35 +00002793 visitInstruction(FC);
2794}
2795
Robert Bocchino23004482006-01-10 19:05:34 +00002796void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002797 Assert(
2798 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2799 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002800 visitInstruction(EI);
2801}
2802
Robert Bocchinoca27f032006-01-17 20:07:22 +00002803void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002804 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2805 IE.getOperand(2)),
2806 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002807 visitInstruction(IE);
2808}
2809
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002810void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002811 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2812 SV.getOperand(2)),
2813 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002814 visitInstruction(SV);
2815}
2816
Chris Lattner069a7952002-06-25 15:56:27 +00002817void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002818 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002819
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002820 Assert(isa<PointerType>(TargetTy),
2821 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002822 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002823 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002824 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002825 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002826 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002827
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002828 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002829 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002830 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002831
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002832 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002833 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002834 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2835 if (GEP.getPointerOperandType()->isVectorTy())
2836 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2837 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002838 for (Value *Idx : Idxs) {
2839 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002840 if (IndexTy->isVectorTy()) {
2841 unsigned IndexWidth = IndexTy->getVectorNumElements();
2842 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2843 }
2844 Assert(IndexTy->getScalarType()->isIntegerTy(),
2845 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002846 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002847 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002848 visitInstruction(GEP);
2849}
2850
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002851static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2852 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2853}
2854
Philip Reamesbf9676f2014-10-20 23:52:07 +00002855void Verifier::visitRangeMetadata(Instruction& I,
2856 MDNode* Range, Type* Ty) {
2857 assert(Range &&
2858 Range == I.getMetadata(LLVMContext::MD_range) &&
2859 "precondition violation");
2860
2861 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002862 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002863 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002864 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2865
Philip Reamesbf9676f2014-10-20 23:52:07 +00002866 ConstantRange LastRange(1); // Dummy initial value
2867 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002868 ConstantInt *Low =
2869 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002870 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002871 ConstantInt *High =
2872 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002873 Assert(High, "The upper limit must be an integer!", High);
2874 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2875 "Range types must match instruction type!", &I);
2876
Philip Reamesbf9676f2014-10-20 23:52:07 +00002877 APInt HighV = High->getValue();
2878 APInt LowV = Low->getValue();
2879 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002880 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2881 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002882 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002883 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2884 "Intervals are overlapping", Range);
2885 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2886 Range);
2887 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2888 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002889 }
2890 LastRange = ConstantRange(LowV, HighV);
2891 }
2892 if (NumRanges > 2) {
2893 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002894 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002895 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002896 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002897 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002898 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2899 "Intervals are overlapping", Range);
2900 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2901 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002902 }
2903}
2904
JF Bastiend1fb5852015-12-17 22:09:19 +00002905void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2906 const Instruction *I) {
2907 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2908 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2909 Assert(!(Size & (Size - 1)),
2910 "atomic memory access' operand must have a power-of-two size", Ty, I);
2911}
2912
Chris Lattner069a7952002-06-25 15:56:27 +00002913void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002914 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002915 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002916 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002917 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2918 "huge alignment values are unsupported", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002919 if (LI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002920 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2921 "Load cannot have Release ordering", &LI);
2922 Assert(LI.getAlignment() != 0,
2923 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002924 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2925 ElTy->isFloatingPointTy(),
2926 "atomic load operand must have integer, pointer, or floating point "
2927 "type!",
2928 ElTy, &LI);
2929 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002930 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002931 Assert(LI.getSynchScope() == CrossThread,
2932 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002933 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002934
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002935 visitInstruction(LI);
2936}
2937
Chris Lattner069a7952002-06-25 15:56:27 +00002938void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002939 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002940 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002941 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002942 Assert(ElTy == SI.getOperand(0)->getType(),
2943 "Stored value type does not match pointer operand type!", &SI, ElTy);
2944 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2945 "huge alignment values are unsupported", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002946 if (SI.isAtomic()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002947 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2948 "Store cannot have Acquire ordering", &SI);
2949 Assert(SI.getAlignment() != 0,
2950 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002951 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2952 ElTy->isFloatingPointTy(),
2953 "atomic store operand must have integer, pointer, or floating point "
2954 "type!",
2955 ElTy, &SI);
2956 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002957 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002958 Assert(SI.getSynchScope() == CrossThread,
2959 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002960 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002961 visitInstruction(SI);
2962}
2963
Manman Ren9bfd0d02016-04-01 21:41:15 +00002964/// Check that SwiftErrorVal is used as a swifterror argument in CS.
2965void Verifier::verifySwiftErrorCallSite(CallSite CS,
2966 const Value *SwiftErrorVal) {
2967 unsigned Idx = 0;
2968 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
2969 I != E; ++I, ++Idx) {
2970 if (*I == SwiftErrorVal) {
2971 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
2972 "swifterror value when used in a callsite should be marked "
2973 "with swifterror attribute",
2974 SwiftErrorVal, CS);
2975 }
2976 }
2977}
2978
2979void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
2980 // Check that swifterror value is only used by loads, stores, or as
2981 // a swifterror argument.
2982 for (const User *U : SwiftErrorVal->users()) {
2983 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
2984 isa<InvokeInst>(U),
2985 "swifterror value can only be loaded and stored from, or "
2986 "as a swifterror argument!",
2987 SwiftErrorVal, U);
2988 // If it is used by a store, check it is the second operand.
2989 if (auto StoreI = dyn_cast<StoreInst>(U))
2990 Assert(StoreI->getOperand(1) == SwiftErrorVal,
2991 "swifterror value should be the second operand when used "
2992 "by stores", SwiftErrorVal, U);
2993 if (auto CallI = dyn_cast<CallInst>(U))
2994 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
2995 if (auto II = dyn_cast<InvokeInst>(U))
2996 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
2997 }
2998}
2999
Victor Hernandez8acf2952009-10-23 21:09:37 +00003000void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003001 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003002 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003003 Assert(PTy->getAddressSpace() == 0,
3004 "Allocation instruction pointer not in the generic address space!",
3005 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003006 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003007 "Cannot allocate unsized type", &AI);
3008 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3009 "Alloca array size must have integer type", &AI);
3010 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3011 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003012
Manman Ren9bfd0d02016-04-01 21:41:15 +00003013 if (AI.isSwiftError()) {
3014 verifySwiftErrorValue(&AI);
3015 }
3016
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003017 visitInstruction(AI);
3018}
3019
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003020void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003021
3022 // FIXME: more conditions???
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003023 Assert(CXI.getSuccessOrdering() != NotAtomic,
3024 "cmpxchg instructions must be atomic.", &CXI);
3025 Assert(CXI.getFailureOrdering() != NotAtomic,
3026 "cmpxchg instructions must be atomic.", &CXI);
3027 Assert(CXI.getSuccessOrdering() != Unordered,
3028 "cmpxchg instructions cannot be unordered.", &CXI);
3029 Assert(CXI.getFailureOrdering() != Unordered,
3030 "cmpxchg instructions cannot be unordered.", &CXI);
3031 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
3032 "cmpxchg instructions be at least as constrained on success as fail",
3033 &CXI);
3034 Assert(CXI.getFailureOrdering() != Release &&
3035 CXI.getFailureOrdering() != AcquireRelease,
3036 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003037
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003038 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003039 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003040 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003041 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3042 "cmpxchg operand must have integer or pointer type",
3043 ElTy, &CXI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003044 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003045 Assert(ElTy == CXI.getOperand(1)->getType(),
3046 "Expected value type does not match pointer operand type!", &CXI,
3047 ElTy);
3048 Assert(ElTy == CXI.getOperand(2)->getType(),
3049 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003050 visitInstruction(CXI);
3051}
3052
3053void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003054 Assert(RMWI.getOrdering() != NotAtomic,
3055 "atomicrmw instructions must be atomic.", &RMWI);
3056 Assert(RMWI.getOrdering() != Unordered,
3057 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003058 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003059 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003060 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003061 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3062 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00003063 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003064 Assert(ElTy == RMWI.getOperand(1)->getType(),
3065 "Argument value type does not match pointer operand type!", &RMWI,
3066 ElTy);
3067 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3068 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3069 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003070 visitInstruction(RMWI);
3071}
3072
Eli Friedmanfee02c62011-07-25 23:16:38 +00003073void Verifier::visitFenceInst(FenceInst &FI) {
3074 const AtomicOrdering Ordering = FI.getOrdering();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003075 Assert(Ordering == Acquire || Ordering == Release ||
3076 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
3077 "fence instructions may only have "
3078 "acquire, release, acq_rel, or seq_cst ordering.",
3079 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003080 visitInstruction(FI);
3081}
3082
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003083void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003084 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3085 EVI.getIndices()) == EVI.getType(),
3086 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003087
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003088 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003089}
3090
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003091void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003092 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3093 IVI.getIndices()) ==
3094 IVI.getOperand(1)->getType(),
3095 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003096
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003097 visitInstruction(IVI);
3098}
Chris Lattner0e851da2002-04-18 20:37:37 +00003099
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003100static Value *getParentPad(Value *EHPad) {
3101 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3102 return FPI->getParentPad();
3103
3104 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3105}
3106
David Majnemer85a549d2015-08-11 02:48:30 +00003107void Verifier::visitEHPadPredecessors(Instruction &I) {
3108 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003109
David Majnemer85a549d2015-08-11 02:48:30 +00003110 BasicBlock *BB = I.getParent();
3111 Function *F = BB->getParent();
3112
3113 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3114
3115 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3116 // The landingpad instruction defines its parent as a landing pad block. The
3117 // landing pad block may be branched to only by the unwind edge of an
3118 // invoke.
3119 for (BasicBlock *PredBB : predecessors(BB)) {
3120 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3121 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3122 "Block containing LandingPadInst must be jumped to "
3123 "only by the unwind edge of an invoke.",
3124 LPI);
3125 }
3126 return;
3127 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003128 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3129 if (!pred_empty(BB))
3130 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3131 "Block containg CatchPadInst must be jumped to "
3132 "only by its catchswitch.",
3133 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003134 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3135 "Catchswitch cannot unwind to one of its catchpads",
3136 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003137 return;
3138 }
David Majnemer85a549d2015-08-11 02:48:30 +00003139
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003140 // Verify that each pred has a legal terminator with a legal to/from EH
3141 // pad relationship.
3142 Instruction *ToPad = &I;
3143 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003144 for (BasicBlock *PredBB : predecessors(BB)) {
3145 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003146 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003147 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003148 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003149 "EH pad must be jumped to via an unwind edge", ToPad, II);
3150 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3151 FromPad = Bundle->Inputs[0];
3152 else
3153 FromPad = ConstantTokenNone::get(II->getContext());
3154 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003155 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003156 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3157 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3158 FromPad = CSI;
3159 } else {
3160 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3161 }
3162
3163 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003164 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003165 for (;; FromPad = getParentPad(FromPad)) {
3166 Assert(FromPad != ToPad,
3167 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3168 if (FromPad == ToPadParent) {
3169 // This is a legal unwind edge.
3170 break;
3171 }
3172 Assert(!isa<ConstantTokenNone>(FromPad),
3173 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003174 Assert(Seen.insert(FromPad).second,
3175 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003176 }
David Majnemer85a549d2015-08-11 02:48:30 +00003177 }
3178}
3179
3180void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003181 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3182 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003183 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3184 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003185
David Majnemer85a549d2015-08-11 02:48:30 +00003186 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003187
David Majnemer654e1302015-07-31 17:58:14 +00003188 if (!LandingPadResultTy)
3189 LandingPadResultTy = LPI.getType();
3190 else
3191 Assert(LandingPadResultTy == LPI.getType(),
3192 "The landingpad instruction should have a consistent result type "
3193 "inside a function.",
3194 &LPI);
3195
David Majnemer7fddecc2015-06-17 20:52:32 +00003196 Function *F = LPI.getParent()->getParent();
3197 Assert(F->hasPersonalityFn(),
3198 "LandingPadInst needs to be in a function with a personality.", &LPI);
3199
Bill Wendlingfae14752011-08-12 20:24:12 +00003200 // The landingpad instruction must be the first non-PHI instruction in the
3201 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003202 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3203 "LandingPadInst not the first non-PHI instruction in the block.",
3204 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003205
Duncan Sands86de1a62011-09-27 16:43:19 +00003206 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003207 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003208 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003209 Assert(isa<PointerType>(Clause->getType()),
3210 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003211 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003212 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3213 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3214 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003215 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003216 }
3217
Bill Wendlingfae14752011-08-12 20:24:12 +00003218 visitInstruction(LPI);
3219}
3220
David Majnemer654e1302015-07-31 17:58:14 +00003221void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003222 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003223
David Majnemer654e1302015-07-31 17:58:14 +00003224 Function *F = BB->getParent();
3225 Assert(F->hasPersonalityFn(),
3226 "CatchPadInst needs to be in a function with a personality.", &CPI);
3227
David Majnemer8a1c45d2015-12-12 05:38:55 +00003228 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3229 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3230 CPI.getParentPad());
3231
David Majnemer654e1302015-07-31 17:58:14 +00003232 // The catchpad instruction must be the first non-PHI instruction in the
3233 // block.
3234 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003235 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003236
David Majnemerfe2f7f32016-02-29 22:56:36 +00003237 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003238 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003239}
3240
David Majnemer8a1c45d2015-12-12 05:38:55 +00003241void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3242 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3243 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3244 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003245
David Majnemer8a1c45d2015-12-12 05:38:55 +00003246 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003247}
3248
3249void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3250 BasicBlock *BB = CPI.getParent();
3251
David Majnemer654e1302015-07-31 17:58:14 +00003252 Function *F = BB->getParent();
3253 Assert(F->hasPersonalityFn(),
3254 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3255
3256 // The cleanuppad instruction must be the first non-PHI instruction in the
3257 // block.
3258 Assert(BB->getFirstNonPHI() == &CPI,
3259 "CleanupPadInst not the first non-PHI instruction in the block.",
3260 &CPI);
3261
David Majnemer8a1c45d2015-12-12 05:38:55 +00003262 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003263 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003264 "CleanupPadInst has an invalid parent.", &CPI);
3265
David Majnemerfe2f7f32016-02-29 22:56:36 +00003266 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003267 visitFuncletPadInst(CPI);
3268}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003269
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003270void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3271 User *FirstUser = nullptr;
3272 Value *FirstUnwindPad = nullptr;
3273 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003274 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003275
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003276 while (!Worklist.empty()) {
3277 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003278 Assert(Seen.insert(CurrentPad).second,
3279 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003280 Value *UnresolvedAncestorPad = nullptr;
3281 for (User *U : CurrentPad->users()) {
3282 BasicBlock *UnwindDest;
3283 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3284 UnwindDest = CRI->getUnwindDest();
3285 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3286 // We allow catchswitch unwind to caller to nest
3287 // within an outer pad that unwinds somewhere else,
3288 // because catchswitch doesn't have a nounwind variant.
3289 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3290 if (CSI->unwindsToCaller())
3291 continue;
3292 UnwindDest = CSI->getUnwindDest();
3293 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3294 UnwindDest = II->getUnwindDest();
3295 } else if (isa<CallInst>(U)) {
3296 // Calls which don't unwind may be found inside funclet
3297 // pads that unwind somewhere else. We don't *require*
3298 // such calls to be annotated nounwind.
3299 continue;
3300 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3301 // The unwind dest for a cleanup can only be found by
3302 // recursive search. Add it to the worklist, and we'll
3303 // search for its first use that determines where it unwinds.
3304 Worklist.push_back(CPI);
3305 continue;
3306 } else {
3307 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3308 continue;
3309 }
3310
3311 Value *UnwindPad;
3312 bool ExitsFPI;
3313 if (UnwindDest) {
3314 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003315 if (!cast<Instruction>(UnwindPad)->isEHPad())
3316 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003317 Value *UnwindParent = getParentPad(UnwindPad);
3318 // Ignore unwind edges that don't exit CurrentPad.
3319 if (UnwindParent == CurrentPad)
3320 continue;
3321 // Determine whether the original funclet pad is exited,
3322 // and if we are scanning nested pads determine how many
3323 // of them are exited so we can stop searching their
3324 // children.
3325 Value *ExitedPad = CurrentPad;
3326 ExitsFPI = false;
3327 do {
3328 if (ExitedPad == &FPI) {
3329 ExitsFPI = true;
3330 // Now we can resolve any ancestors of CurrentPad up to
3331 // FPI, but not including FPI since we need to make sure
3332 // to check all direct users of FPI for consistency.
3333 UnresolvedAncestorPad = &FPI;
3334 break;
3335 }
3336 Value *ExitedParent = getParentPad(ExitedPad);
3337 if (ExitedParent == UnwindParent) {
3338 // ExitedPad is the ancestor-most pad which this unwind
3339 // edge exits, so we can resolve up to it, meaning that
3340 // ExitedParent is the first ancestor still unresolved.
3341 UnresolvedAncestorPad = ExitedParent;
3342 break;
3343 }
3344 ExitedPad = ExitedParent;
3345 } while (!isa<ConstantTokenNone>(ExitedPad));
3346 } else {
3347 // Unwinding to caller exits all pads.
3348 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3349 ExitsFPI = true;
3350 UnresolvedAncestorPad = &FPI;
3351 }
3352
3353 if (ExitsFPI) {
3354 // This unwind edge exits FPI. Make sure it agrees with other
3355 // such edges.
3356 if (FirstUser) {
3357 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3358 "pad must have the same unwind "
3359 "dest",
3360 &FPI, U, FirstUser);
3361 } else {
3362 FirstUser = U;
3363 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003364 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3365 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3366 getParentPad(UnwindPad) == getParentPad(&FPI))
3367 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003368 }
3369 }
3370 // Make sure we visit all uses of FPI, but for nested pads stop as
3371 // soon as we know where they unwind to.
3372 if (CurrentPad != &FPI)
3373 break;
3374 }
3375 if (UnresolvedAncestorPad) {
3376 if (CurrentPad == UnresolvedAncestorPad) {
3377 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3378 // we've found an unwind edge that exits it, because we need to verify
3379 // all direct uses of FPI.
3380 assert(CurrentPad == &FPI);
3381 continue;
3382 }
3383 // Pop off the worklist any nested pads that we've found an unwind
3384 // destination for. The pads on the worklist are the uncles,
3385 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3386 // for all ancestors of CurrentPad up to but not including
3387 // UnresolvedAncestorPad.
3388 Value *ResolvedPad = CurrentPad;
3389 while (!Worklist.empty()) {
3390 Value *UnclePad = Worklist.back();
3391 Value *AncestorPad = getParentPad(UnclePad);
3392 // Walk ResolvedPad up the ancestor list until we either find the
3393 // uncle's parent or the last resolved ancestor.
3394 while (ResolvedPad != AncestorPad) {
3395 Value *ResolvedParent = getParentPad(ResolvedPad);
3396 if (ResolvedParent == UnresolvedAncestorPad) {
3397 break;
3398 }
3399 ResolvedPad = ResolvedParent;
3400 }
3401 // If the resolved ancestor search didn't find the uncle's parent,
3402 // then the uncle is not yet resolved.
3403 if (ResolvedPad != AncestorPad)
3404 break;
3405 // This uncle is resolved, so pop it from the worklist.
3406 Worklist.pop_back();
3407 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003408 }
3409 }
3410
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003411 if (FirstUnwindPad) {
3412 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3413 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3414 Value *SwitchUnwindPad;
3415 if (SwitchUnwindDest)
3416 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3417 else
3418 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3419 Assert(SwitchUnwindPad == FirstUnwindPad,
3420 "Unwind edges out of a catch must have the same unwind dest as "
3421 "the parent catchswitch",
3422 &FPI, FirstUser, CatchSwitch);
3423 }
3424 }
3425
3426 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003427}
3428
David Majnemer8a1c45d2015-12-12 05:38:55 +00003429void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003430 BasicBlock *BB = CatchSwitch.getParent();
3431
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003432 Function *F = BB->getParent();
3433 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003434 "CatchSwitchInst needs to be in a function with a personality.",
3435 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003436
David Majnemer8a1c45d2015-12-12 05:38:55 +00003437 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003438 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003439 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3440 "CatchSwitchInst not the first non-PHI instruction in the block.",
3441 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003442
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003443 auto *ParentPad = CatchSwitch.getParentPad();
3444 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3445 "CatchSwitchInst has an invalid parent.", ParentPad);
3446
David Majnemer8a1c45d2015-12-12 05:38:55 +00003447 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003448 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003449 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3450 "CatchSwitchInst must unwind to an EH block which is not a "
3451 "landingpad.",
3452 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003453
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003454 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3455 if (getParentPad(I) == ParentPad)
3456 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3457 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003458
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003459 Assert(CatchSwitch.getNumHandlers() != 0,
3460 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3461
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003462 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003463 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3464 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003465 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003466
David Majnemerfe2f7f32016-02-29 22:56:36 +00003467 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003468 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003469}
3470
David Majnemer654e1302015-07-31 17:58:14 +00003471void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003472 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3473 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3474 CRI.getOperand(0));
3475
David Majnemer654e1302015-07-31 17:58:14 +00003476 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3477 Instruction *I = UnwindDest->getFirstNonPHI();
3478 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3479 "CleanupReturnInst must unwind to an EH block which is not a "
3480 "landingpad.",
3481 &CRI);
3482 }
3483
3484 visitTerminatorInst(CRI);
3485}
3486
Rafael Espindola654320a2012-02-26 02:23:37 +00003487void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3488 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003489 // If the we have an invalid invoke, don't try to compute the dominance.
3490 // We already reject it in the invoke specific checks and the dominance
3491 // computation doesn't handle multiple edges.
3492 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3493 if (II->getNormalDest() == II->getUnwindDest())
3494 return;
3495 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003496
Michael Kruseff379b62016-03-26 23:32:57 +00003497 // Quick check whether the def has already been encountered in the same block.
3498 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3499 // uses are defined to happen on the incoming edge, not at the instruction.
3500 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3501 return;
3502
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003503 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003504 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003505 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003506}
3507
Artur Pilipenkocca80022015-10-09 17:41:29 +00003508void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3509 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3510 "apply only to pointer types", &I);
3511 Assert(isa<LoadInst>(I),
3512 "dereferenceable, dereferenceable_or_null apply only to load"
3513 " instructions, use attributes for calls or invokes", &I);
3514 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3515 "take one operand!", &I);
3516 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3517 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3518 "dereferenceable_or_null metadata value must be an i64!", &I);
3519}
3520
Misha Brukmanc566ca362004-03-02 00:22:19 +00003521/// verifyInstruction - Verify that an instruction is well formed.
3522///
Chris Lattner069a7952002-06-25 15:56:27 +00003523void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003524 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003525 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003526
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003527 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003528 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003529 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3530 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003531 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003532 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003533
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003534 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003535 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3536 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003537
Chris Lattner5f126b72004-03-29 00:29:36 +00003538 // Check that the return value of the instruction is either void or a legal
3539 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003540 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3541 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003542
Nick Lewycky93e06a52009-09-27 23:27:42 +00003543 // Check that the instruction doesn't produce metadata. Calls are already
3544 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003545 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3546 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003547
Chris Lattner0e851da2002-04-18 20:37:37 +00003548 // Check that all uses of the instruction, if they are instructions
3549 // themselves, actually have parent basic blocks. If the use is not an
3550 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003551 for (Use &U : I.uses()) {
3552 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003553 Assert(Used->getParent() != nullptr,
3554 "Instruction referencing"
3555 " instruction not embedded in a basic block!",
3556 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003557 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003558 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003559 return;
3560 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003561 }
3562
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003563 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003564 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003565
3566 // Check to make sure that only first-class-values are operands to
3567 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003568 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003569 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003570 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003571
Chris Lattner9ece94b2004-03-14 03:23:54 +00003572 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003573 // Check to make sure that the "address of" an intrinsic function is never
3574 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003575 Assert(
3576 !F->isIntrinsic() ||
3577 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3578 "Cannot take the address of an intrinsic!", &I);
3579 Assert(
3580 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003581 F->getIntrinsicID() == Intrinsic::donothing ||
3582 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003583 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3584 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Sanjoy Das999dc752016-02-29 22:04:25 +00003585 "Cannot invoke an intrinsic other than donothing, patchpoint or "
3586 "statepoint",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003587 &I);
3588 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003589 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003590 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003591 Assert(OpBB->getParent() == BB->getParent(),
3592 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003593 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003594 Assert(OpArg->getParent() == BB->getParent(),
3595 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003596 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003597 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003598 } else if (isa<Instruction>(I.getOperand(i))) {
3599 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003600 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003601 Assert((i + 1 == e && isa<CallInst>(I)) ||
3602 (i + 3 == e && isa<InvokeInst>(I)),
3603 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003604 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3605 if (CE->getType()->isPtrOrPtrVectorTy()) {
3606 // If we have a ConstantExpr pointer, we need to see if it came from an
3607 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003608 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003609 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003610 }
3611 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003612
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003613 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003614 Assert(I.getType()->isFPOrFPVectorTy(),
3615 "fpmath requires a floating point result!", &I);
3616 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003617 if (ConstantFP *CFP0 =
3618 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003619 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003620 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3621 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003622 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003623 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003624 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003625 }
3626
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003627 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003628 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3629 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003630 visitRangeMetadata(I, Range, I.getType());
3631 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003632
Philip Reames0ca58b32014-10-21 20:56:29 +00003633 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003634 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3635 &I);
3636 Assert(isa<LoadInst>(I),
3637 "nonnull applies only to load instructions, use attributes"
3638 " for calls or invokes",
3639 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003640 }
3641
Artur Pilipenkocca80022015-10-09 17:41:29 +00003642 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3643 visitDereferenceableMetadata(I, MD);
3644
3645 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3646 visitDereferenceableMetadata(I, MD);
3647
3648 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3649 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3650 &I);
3651 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3652 "use attributes for calls or invokes", &I);
3653 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3654 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3655 Assert(CI && CI->getType()->isIntegerTy(64),
3656 "align metadata value must be an i64!", &I);
3657 uint64_t Align = CI->getZExtValue();
3658 Assert(isPowerOf2_64(Align),
3659 "align metadata value must be a power of 2!", &I);
3660 Assert(Align <= Value::MaximumAlignment,
3661 "alignment is larger that implementation defined limit", &I);
3662 }
3663
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003664 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003665 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003666 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003667 }
3668
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003669 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003670}
3671
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003672/// Verify that the specified type (which comes from an intrinsic argument or
3673/// return value) matches the type constraints specified by the .td file (e.g.
3674/// an "any integer" argument really is an integer).
Chris Lattner144b6192012-05-27 19:37:05 +00003675///
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003676/// This returns true on error but does not print a message.
3677bool Verifier::verifyIntrinsicType(Type *Ty,
Chris Lattner144b6192012-05-27 19:37:05 +00003678 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3679 SmallVectorImpl<Type*> &ArgTys) {
3680 using namespace Intrinsic;
3681
3682 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003683 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003684 IITDescriptor D = Infos.front();
3685 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003686
Chris Lattner144b6192012-05-27 19:37:05 +00003687 switch (D.Kind) {
3688 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003689 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003690 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003691 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003692 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003693 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003694 case IITDescriptor::Float: return !Ty->isFloatTy();
3695 case IITDescriptor::Double: return !Ty->isDoubleTy();
3696 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3697 case IITDescriptor::Vector: {
3698 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003699 return !VT || VT->getNumElements() != D.Vector_Width ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003700 verifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003701 }
3702 case IITDescriptor::Pointer: {
3703 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003704 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003705 verifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003706 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003707
Chris Lattner144b6192012-05-27 19:37:05 +00003708 case IITDescriptor::Struct: {
3709 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003710 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003711 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003712
Chris Lattner144b6192012-05-27 19:37:05 +00003713 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003714 if (verifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
Chris Lattner144b6192012-05-27 19:37:05 +00003715 return true;
3716 return false;
3717 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003718
Chris Lattner144b6192012-05-27 19:37:05 +00003719 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003720 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003721 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003722 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003723 return Ty != ArgTys[D.getArgumentNumber()];
3724
Chris Lattner144b6192012-05-27 19:37:05 +00003725 // Otherwise, if this is the first instance of an argument, record it and
3726 // verify the "Any" kind.
3727 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3728 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003729
Chris Lattner144b6192012-05-27 19:37:05 +00003730 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003731 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003732 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3733 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3734 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3735 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3736 }
3737 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003738
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003739 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003740 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003741 if (D.getArgumentNumber() >= ArgTys.size())
3742 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003743
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003744 Type *NewTy = ArgTys[D.getArgumentNumber()];
3745 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3746 NewTy = VectorType::getExtendedElementVectorType(VTy);
3747 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3748 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3749 else
3750 return true;
3751
3752 return Ty != NewTy;
3753 }
3754 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003755 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003756 if (D.getArgumentNumber() >= ArgTys.size())
3757 return true;
3758
3759 Type *NewTy = ArgTys[D.getArgumentNumber()];
3760 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3761 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3762 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3763 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3764 else
3765 return true;
3766
3767 return Ty != NewTy;
3768 }
Tim Northover4516de32014-03-29 07:04:54 +00003769 case IITDescriptor::HalfVecArgument:
3770 // This may only be used when referring to a previous vector argument.
3771 return D.getArgumentNumber() >= ArgTys.size() ||
3772 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3773 VectorType::getHalfElementsVectorType(
3774 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003775 case IITDescriptor::SameVecWidthArgument: {
3776 if (D.getArgumentNumber() >= ArgTys.size())
3777 return true;
3778 VectorType * ReferenceType =
3779 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3780 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3781 if (!ThisArgType || !ReferenceType ||
3782 (ReferenceType->getVectorNumElements() !=
3783 ThisArgType->getVectorNumElements()))
3784 return true;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003785 return verifyIntrinsicType(ThisArgType->getVectorElementType(),
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003786 Infos, ArgTys);
3787 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003788 case IITDescriptor::PtrToArgument: {
3789 if (D.getArgumentNumber() >= ArgTys.size())
3790 return true;
3791 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3792 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3793 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3794 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003795 case IITDescriptor::VecOfPtrsToElt: {
3796 if (D.getArgumentNumber() >= ArgTys.size())
3797 return true;
3798 VectorType * ReferenceType =
3799 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3800 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3801 if (!ThisArgVecTy || !ReferenceType ||
3802 (ReferenceType->getVectorNumElements() !=
3803 ThisArgVecTy->getVectorNumElements()))
3804 return true;
3805 PointerType *ThisArgEltTy =
3806 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3807 if (!ThisArgEltTy)
3808 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003809 return ThisArgEltTy->getElementType() !=
3810 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003811 }
Chris Lattner144b6192012-05-27 19:37:05 +00003812 }
3813 llvm_unreachable("unhandled");
3814}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003815
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003816/// Verify if the intrinsic has variable arguments. This method is intended to
3817/// be called after all the fixed arguments have been verified first.
Andrew Tricka2efd992013-10-31 17:18:11 +00003818///
3819/// This method returns true on error and does not print an error message.
3820bool
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003821Verifier::verifyIntrinsicIsVarArg(bool isVarArg,
Andrew Tricka2efd992013-10-31 17:18:11 +00003822 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3823 using namespace Intrinsic;
3824
3825 // If there are no descriptors left, then it can't be a vararg.
3826 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003827 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003828
3829 // There should be only one descriptor remaining at this point.
3830 if (Infos.size() != 1)
3831 return true;
3832
3833 // Check and verify the descriptor.
3834 IITDescriptor D = Infos.front();
3835 Infos = Infos.slice(1);
3836 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003837 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003838
3839 return true;
3840}
3841
Philip Reames007561a2015-06-26 22:21:52 +00003842/// Allow intrinsics to be verified in different ways.
3843void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003844 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003845 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3846 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003847
Chris Lattner144b6192012-05-27 19:37:05 +00003848 // Verify that the intrinsic prototype lines up with what the .td files
3849 // describe.
3850 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003851 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003852
Chris Lattner144b6192012-05-27 19:37:05 +00003853 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3854 getIntrinsicInfoTableEntries(ID, Table);
3855 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003856
Chris Lattner144b6192012-05-27 19:37:05 +00003857 SmallVector<Type *, 4> ArgTys;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003858 Assert(!verifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003859 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003860 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003861 Assert(!verifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003862 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003863
3864 // Verify if the intrinsic call matches the vararg property.
3865 if (IsVarArg)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003866 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003867 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003868 else
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003869 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003870 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003871
3872 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003873 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003874
3875 // Now that we have the intrinsic ID and the actual argument types (and we
3876 // know they are legal for the intrinsic!) get the intrinsic name through the
3877 // usual means. This allows us to verify the mangling of argument types into
3878 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003879 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003880 Assert(ExpectedName == IF->getName(),
3881 "Intrinsic name not mangled correctly for type arguments! "
3882 "Should be: " +
3883 ExpectedName,
3884 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003885
Chris Lattner588096e2009-12-28 09:07:21 +00003886 // If the intrinsic takes MDNode arguments, verify that they are either global
3887 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003888 for (Value *V : CS.args())
3889 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3890 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003891
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003892 switch (ID) {
3893 default:
3894 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003895 case Intrinsic::ctlz: // llvm.ctlz
3896 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003897 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003898 "is_zero_undef argument of bit counting intrinsics must be a "
3899 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003900 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003901 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003902 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003903 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3904 "invalid llvm.dbg.declare intrinsic call 1", CS);
3905 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003906 break;
3907 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003908 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003909 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003910 case Intrinsic::memcpy:
3911 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003912 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003913 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003914 Assert(AlignCI,
3915 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003916 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003917 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003918 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003919 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003920 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003921 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003922 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003923 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003924 }
Bill Wendling05604e02008-08-23 09:46:46 +00003925 case Intrinsic::gcroot:
3926 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003927 case Intrinsic::gcread:
3928 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003929 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003930 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3931 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3932 Assert(isa<Constant>(CS.getArgOperand(1)),
3933 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003934 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003935 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003936 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3937 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003938 CS);
Talin2e59f142010-09-30 20:23:47 +00003939 }
Chris Lattner25852062008-08-24 20:46:13 +00003940 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003941
Philip Reames9818dd72015-06-26 22:04:34 +00003942 Assert(CS.getParent()->getParent()->hasGC(),
3943 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003944 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003945 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003946 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003947 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003948 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003949 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003950 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003951 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3952 isa<ConstantInt>(CS.getArgOperand(2)) &&
3953 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3954 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3955 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003956 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003957 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003958 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3959 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003960 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003961 case Intrinsic::lifetime_start:
3962 case Intrinsic::lifetime_end:
3963 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003964 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003965 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003966 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003967 break;
3968 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003969 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3970 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003971 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003972
Reid Kleckner60381792015-07-07 22:25:32 +00003973 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003974 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003975 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003976 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003977 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003978 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003979 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003980 if (isa<ConstantPointerNull>(Arg))
3981 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003982 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003983 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003984 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003985 }
Philip Reames9818dd72015-06-26 22:04:34 +00003986 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003987 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003988 break;
3989 }
Reid Kleckner60381792015-07-07 22:25:32 +00003990 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003991 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003992 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003993 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003994 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003995 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003996 CS);
3997 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003998 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003999 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004000 auto &Entry = FrameEscapeInfo[Fn];
4001 Entry.second = unsigned(
4002 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004003 break;
4004 }
4005
Philip Reames1ffa9372015-01-30 23:28:05 +00004006 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004007 Assert(!CS.isInlineAsm(),
4008 "gc.statepoint support for inline assembly unimplemented", CS);
4009 Assert(CS.getParent()->getParent()->hasGC(),
4010 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004011
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004012 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004013 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004014 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004015 Assert(CS.getParent()->getParent()->hasGC(),
4016 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004017 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004018 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004019 const Function *StatepointFn =
4020 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004021 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4022 StatepointFn->getIntrinsicID() ==
4023 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004024 "gc.result operand #1 must be from a statepoint", CS,
4025 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004026
Philip Reamesb23713a2014-12-03 22:23:24 +00004027 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004028 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004029 auto *PT = cast<PointerType>(Target->getType());
4030 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004031 Assert(CS.getType() == TargetFuncType->getReturnType(),
4032 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004033 break;
4034 }
4035 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004036 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004037
Philip Reames3e2cf532016-01-07 03:32:11 +00004038 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4039 "gc.relocate must return a pointer or a vector of pointers", CS);
4040
Igor Laevsky9570ff92015-02-19 11:28:47 +00004041 // Check that this relocate is correctly tied to the statepoint
4042
4043 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004044 if (LandingPadInst *LandingPad =
4045 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004046
Sanjoy Das5665c992015-05-11 23:47:27 +00004047 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004048 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004049
4050 // Landingpad relocates should have only one predecessor with invoke
4051 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004052 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004053 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004054 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4055 InvokeBB);
4056 Assert(isStatepoint(InvokeBB->getTerminator()),
4057 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004058 }
4059 else {
4060 // In all other cases relocate should be tied to the statepoint directly.
4061 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004062 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004063 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004064 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004065 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004066 }
4067
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004068 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004069
Manuel Jacob83eefa62016-01-05 04:03:00 +00004070 ImmutableCallSite StatepointCS(
4071 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004072
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004073 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004074 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004075 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004076 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004077
Philip Reames9818dd72015-06-26 22:04:34 +00004078 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004079 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004080 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004081
4082 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4083 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4084 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004085 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004086 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004087 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004088 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004089
4090 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004091 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004092 Assert(StatepointCS.arg_size() > 0,
4093 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004094 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004095 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004096 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004097 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4098 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004099 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004100 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004101 "gc.statepoint: number of transition arguments must be "
4102 "a constant integer");
4103 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004104 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4105 ->getZExtValue();
4106 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004107 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004108 "gc.statepoint: number of deoptimization arguments must be "
4109 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004110 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004111 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4112 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004113 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004114 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004115 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4116 "gc.relocate: statepoint base index doesn't fall within the "
4117 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004118 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004119 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4120 "gc.relocate: statepoint derived index doesn't fall within the "
4121 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004122 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004123
Philip Reames3e2cf532016-01-07 03:32:11 +00004124 // Relocated value must be either a pointer type or vector-of-pointer type,
4125 // but gc_relocate does not need to return the same pointer type as the
4126 // relocated pointer. It can be casted to the correct type later if it's
4127 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004128 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004129 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004130 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004131
Philip Reames3e2cf532016-01-07 03:32:11 +00004132 auto ResultType = CS.getType();
4133 auto DerivedType = Relocate.getDerivedPtr()->getType();
4134 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004135 "gc.relocate: vector relocates to vector and pointer to pointer",
4136 CS);
4137 Assert(
4138 ResultType->getPointerAddressSpace() ==
4139 DerivedType->getPointerAddressSpace(),
4140 "gc.relocate: relocating a pointer shouldn't change its address space",
4141 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004142 break;
4143 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004144 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004145 case Intrinsic::eh_exceptionpointer: {
4146 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4147 "eh.exceptionpointer argument must be a catchpad", CS);
4148 break;
4149 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004150 case Intrinsic::masked_load: {
4151 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4152
4153 Value *Ptr = CS.getArgOperand(0);
4154 //Value *Alignment = CS.getArgOperand(1);
4155 Value *Mask = CS.getArgOperand(2);
4156 Value *PassThru = CS.getArgOperand(3);
4157 Assert(Mask->getType()->isVectorTy(),
4158 "masked_load: mask must be vector", CS);
4159
4160 // DataTy is the overloaded type
4161 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4162 Assert(DataTy == CS.getType(),
4163 "masked_load: return must match pointer type", CS);
4164 Assert(PassThru->getType() == DataTy,
4165 "masked_load: pass through and data type must match", CS);
4166 Assert(Mask->getType()->getVectorNumElements() ==
4167 DataTy->getVectorNumElements(),
4168 "masked_load: vector mask must be same length as data", CS);
4169 break;
4170 }
4171 case Intrinsic::masked_store: {
4172 Value *Val = CS.getArgOperand(0);
4173 Value *Ptr = CS.getArgOperand(1);
4174 //Value *Alignment = CS.getArgOperand(2);
4175 Value *Mask = CS.getArgOperand(3);
4176 Assert(Mask->getType()->isVectorTy(),
4177 "masked_store: mask must be vector", CS);
4178
4179 // DataTy is the overloaded type
4180 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4181 Assert(DataTy == Val->getType(),
4182 "masked_store: storee must match pointer type", CS);
4183 Assert(Mask->getType()->getVectorNumElements() ==
4184 DataTy->getVectorNumElements(),
4185 "masked_store: vector mask must be same length as data", CS);
4186 break;
4187 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004188
Sanjoy Das021de052016-03-31 00:18:46 +00004189 case Intrinsic::experimental_guard: {
4190 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4191 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4192 "experimental_guard must have exactly one "
4193 "\"deopt\" operand bundle");
4194 break;
4195 }
4196
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004197 case Intrinsic::experimental_deoptimize: {
4198 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4199 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4200 "experimental_deoptimize must have exactly one "
4201 "\"deopt\" operand bundle");
4202 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4203 "experimental_deoptimize return type must match caller return type");
4204
4205 if (CS.isCall()) {
4206 auto *DeoptCI = CS.getInstruction();
4207 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4208 Assert(RI,
4209 "calls to experimental_deoptimize must be followed by a return");
4210
4211 if (!CS.getType()->isVoidTy() && RI)
4212 Assert(RI->getReturnValue() == DeoptCI,
4213 "calls to experimental_deoptimize must be followed by a return "
4214 "of the value computed by experimental_deoptimize");
4215 }
4216
4217 break;
4218 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004219 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004220}
4221
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004222/// \brief Carefully grab the subprogram from a local scope.
4223///
4224/// This carefully grabs the subprogram from a local scope, avoiding the
4225/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004226static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004227 if (!LocalScope)
4228 return nullptr;
4229
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004230 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004231 return SP;
4232
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004233 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004234 return getSubprogram(LB->getRawScope());
4235
4236 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004237 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004238 return nullptr;
4239}
4240
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004241template <class DbgIntrinsicTy>
4242void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4243 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
4244 Assert(isa<ValueAsMetadata>(MD) ||
4245 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4246 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004247 Assert(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004248 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4249 DII.getRawVariable());
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004250 Assert(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004251 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4252 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004253
4254 // Ignore broken !dbg attachments; they're checked elsewhere.
4255 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004256 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004257 return;
4258
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004259 BasicBlock *BB = DII.getParent();
4260 Function *F = BB ? BB->getParent() : nullptr;
4261
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004262 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004263 DILocalVariable *Var = DII.getVariable();
4264 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004265 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4266 &DII, BB, F);
4267
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004268 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4269 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004270 if (!VarSP || !LocSP)
4271 return; // Broken scope chains are checked elsewhere.
4272
4273 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4274 " variable and !dbg attachment",
4275 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4276 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004277}
4278
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004279template <class MapTy>
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004280static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004281 // Be careful of broken types (checked elsewhere).
4282 const Metadata *RawType = V.getRawType();
4283 while (RawType) {
4284 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004285 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004286 if (uint64_t Size = T->getSizeInBits())
4287 return Size;
4288
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004289 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004290 // Look at the base type.
4291 RawType = DT->getRawBaseType();
4292 continue;
4293 }
4294
4295 if (auto *S = dyn_cast<MDString>(RawType)) {
4296 // Don't error on missing types (checked elsewhere).
4297 RawType = Map.lookup(S);
4298 continue;
4299 }
4300
4301 // Missing type or size.
4302 break;
4303 }
4304
4305 // Fail gracefully.
4306 return 0;
4307}
4308
4309template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +00004310void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
4311 const MapTy &TypeRefs) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004312 DILocalVariable *V;
4313 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004314 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004315 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4316 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004317 } else {
4318 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004319 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4320 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004321 }
4322
4323 // We don't know whether this intrinsic verified correctly.
4324 if (!V || !E || !E->isValid())
4325 return;
4326
Keno Fischer253a7bd2016-01-15 02:12:38 +00004327 // Nothing to do if this isn't a bit piece expression.
4328 if (!E->isBitPiece())
4329 return;
4330
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004331 // The frontend helps out GDB by emitting the members of local anonymous
4332 // unions as artificial local variables with shared storage. When SROA splits
4333 // the storage for artificial local variables that are smaller than the entire
4334 // union, the overhang piece will be outside of the allotted space for the
4335 // variable and this check fails.
4336 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4337 if (V->isArtificial())
4338 return;
4339
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004340 // If there's no size, the type is broken, but that should be checked
4341 // elsewhere.
4342 uint64_t VarSize = getVariableSize(*V, TypeRefs);
4343 if (!VarSize)
4344 return;
4345
Keno Fischer253a7bd2016-01-15 02:12:38 +00004346 unsigned PieceSize = E->getBitPieceSize();
4347 unsigned PieceOffset = E->getBitPieceOffset();
4348 Assert(PieceSize + PieceOffset <= VarSize,
4349 "piece is larger than or outside of variable", &I, V, E);
4350 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004351}
4352
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004353void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
4354 // This is in its own function so we get an error for each bad type ref (not
4355 // just the first).
4356 Assert(false, "unresolved type ref", S, N);
4357}
4358
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004359void Verifier::verifyCompileUnits() {
4360 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4361 SmallPtrSet<const Metadata *, 2> Listed;
4362 if (CUs)
4363 Listed.insert(CUs->op_begin(), CUs->op_end());
4364 Assert(
4365 std::all_of(CUVisited.begin(), CUVisited.end(),
4366 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
4367 "All DICompileUnits must be listed in llvm.dbg.cu");
4368 CUVisited.clear();
4369}
4370
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004371void Verifier::verifyTypeRefs() {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004372 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4373 if (!CUs)
4374 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004375
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004376 // Visit all the compile units again to map the type references.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004377 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
Davide Italiano18c96862016-04-06 18:13:44 +00004378 for (auto *MD : CUs->operands())
4379 if (auto *CU = dyn_cast<DICompileUnit>(MD))
4380 for (DIType *Op : CU->getRetainedTypes())
4381 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
4382 if (auto *S = T->getRawIdentifier()) {
4383 UnresolvedTypeRefs.erase(S);
4384 TypeRefs.insert(std::make_pair(S, T));
4385 }
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004386
4387 // Verify debug info intrinsic bit piece expressions. This needs a second
4388 // pass through the intructions, since we haven't built TypeRefs yet when
4389 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
4390 // later/now would queue up some that could be later deleted.
4391 for (const Function &F : *M)
4392 for (const BasicBlock &BB : F)
4393 for (const Instruction &I : BB)
4394 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Keno Fischer253a7bd2016-01-15 02:12:38 +00004395 verifyBitPieceExpression(*DII, TypeRefs);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004396
4397 // Return early if all typerefs were resolved.
4398 if (UnresolvedTypeRefs.empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004399 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004400
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004401 // Sort the unresolved references by name so the output is deterministic.
4402 typedef std::pair<const MDString *, const MDNode *> TypeRef;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004403 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
4404 UnresolvedTypeRefs.end());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004405 std::sort(Unresolved.begin(), Unresolved.end(),
4406 [](const TypeRef &LHS, const TypeRef &RHS) {
4407 return LHS.first->getString() < RHS.first->getString();
4408 });
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004409
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004410 // Visit the unresolved refs (printing out the errors).
4411 for (const TypeRef &TR : Unresolved)
4412 visitUnresolvedTypeRef(TR.first, TR.second);
Manman Ren74c61b92013-07-19 00:31:03 +00004413}
4414
Chris Lattner0e851da2002-04-18 20:37:37 +00004415//===----------------------------------------------------------------------===//
4416// Implement the public interfaces to this file...
4417//===----------------------------------------------------------------------===//
4418
Chandler Carruth043949d2014-01-19 02:22:18 +00004419bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004420 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00004421 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00004422
Chandler Carruth043949d2014-01-19 02:22:18 +00004423 raw_null_ostream NullStr;
4424 Verifier V(OS ? *OS : NullStr);
4425
4426 // Note that this function's return value is inverted from what you would
4427 // expect of a function called "verify".
4428 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004429}
4430
Chandler Carruth043949d2014-01-19 02:22:18 +00004431bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
4432 raw_null_ostream NullStr;
4433 Verifier V(OS ? *OS : NullStr);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004434
Chandler Carruth043949d2014-01-19 02:22:18 +00004435 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004436 for (const Function &F : M)
4437 if (!F.isDeclaration() && !F.isMaterializable())
4438 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004439
4440 // Note that this function's return value is inverted from what you would
4441 // expect of a function called "verify".
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +00004442 return !V.verify(M) || Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004443}
Chandler Carruth043949d2014-01-19 02:22:18 +00004444
4445namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004446struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004447 static char ID;
4448
4449 Verifier V;
4450 bool FatalErrors;
4451
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +00004452 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004453 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004454 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004455 explicit VerifierLegacyPass(bool FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004456 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004457 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004458 }
4459
Craig Topperf398d7c2014-03-05 06:35:38 +00004460 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004461 if (!V.verify(F) && FatalErrors)
4462 report_fatal_error("Broken function found, compilation aborted!");
4463
4464 return false;
4465 }
4466
Craig Topperf398d7c2014-03-05 06:35:38 +00004467 bool doFinalization(Module &M) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004468 if (!V.verify(M) && FatalErrors)
4469 report_fatal_error("Broken module found, compilation aborted!");
4470
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004471 return false;
4472 }
4473
4474 void getAnalysisUsage(AnalysisUsage &AU) const override {
4475 AU.setPreservesAll();
4476 }
4477};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004478}
Chandler Carruth043949d2014-01-19 02:22:18 +00004479
Chandler Carruth4d356312014-01-20 11:34:08 +00004480char VerifierLegacyPass::ID = 0;
4481INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004482
4483FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004484 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004485}
4486
Chandler Carruthd174ce42015-01-05 02:47:05 +00004487PreservedAnalyses VerifierPass::run(Module &M) {
4488 if (verifyModule(M, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004489 report_fatal_error("Broken module found, compilation aborted!");
4490
4491 return PreservedAnalyses::all();
4492}
4493
Chandler Carruthd174ce42015-01-05 02:47:05 +00004494PreservedAnalyses VerifierPass::run(Function &F) {
4495 if (verifyFunction(F, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004496 report_fatal_error("Broken function found, compilation aborted!");
4497
4498 return PreservedAnalyses::all();
4499}