blob: b5ef242fce03bf38d68b7611569c281592a8d9bc [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;
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +000086 const Module *M = nullptr;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000087
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +000088 /// Track the brokenness of the module while recursively visiting.
89 bool Broken = false;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000090
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +000091 explicit VerifierSupport(raw_ostream &OS) : OS(OS) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000092
Benjamin Kramerf027ad72015-03-07 21:15:40 +000093private:
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +000094 template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
95 Write(&*I);
96 }
97
Keno Fischera6c4ce42015-12-01 19:06:36 +000098 void Write(const Module *M) {
99 if (!M)
100 return;
101 OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
102 }
103
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000104 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000105 if (!V)
106 return;
107 if (isa<Instruction>(V)) {
108 OS << *V << '\n';
109 } else {
110 V->printAsOperand(OS, true, M);
111 OS << '\n';
112 }
113 }
Philip Reames9818dd72015-06-26 22:04:34 +0000114 void Write(ImmutableCallSite CS) {
115 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000116 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000117
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000118 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000119 if (!MD)
120 return;
Duncan P. N. Exon Smithd6d70e72015-03-14 20:19:36 +0000121 MD->print(OS, M);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000122 OS << '\n';
123 }
124
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000125 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
126 Write(MD.get());
127 }
128
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000129 void Write(const NamedMDNode *NMD) {
130 if (!NMD)
131 return;
132 NMD->print(OS);
133 OS << '\n';
134 }
135
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000136 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000137 if (!T)
138 return;
139 OS << ' ' << *T;
140 }
141
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000142 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000143 if (!C)
144 return;
145 OS << *C;
146 }
147
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000148 template <typename T> void Write(ArrayRef<T> Vs) {
149 for (const T &V : Vs)
150 Write(V);
151 }
152
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000153 template <typename T1, typename... Ts>
154 void WriteTs(const T1 &V1, const Ts &... Vs) {
155 Write(V1);
156 WriteTs(Vs...);
157 }
158
159 template <typename... Ts> void WriteTs() {}
160
161public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000162 /// \brief A check failed, so printout out the condition and the message.
163 ///
164 /// This provides a nice place to put a breakpoint if you want to see why
165 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000166 void CheckFailed(const Twine &Message) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000167 OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000168 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000169 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000170
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000171 /// \brief A check failed (with values to print).
172 ///
173 /// This calls the Message-only version so that the above is easier to set a
174 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000175 template <typename T1, typename... Ts>
176 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
177 CheckFailed(Message);
178 WriteTs(V1, Vs...);
179 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000180};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000181
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000182class Verifier : public InstVisitor<Verifier>, VerifierSupport {
183 friend class InstVisitor<Verifier>;
184
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000185 LLVMContext *Context;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000186 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000187
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000188 /// \brief When verifying a basic block, keep track of all of the
189 /// instructions we have seen so far.
190 ///
191 /// This allows us to do efficient dominance checks for the case when an
192 /// instruction has an operand that is an instruction in the same block.
193 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000194
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000195 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000196 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000197
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000198 /// Track all DICompileUnits visited.
199 SmallPtrSet<const Metadata *, 2> CUVisited;
200
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000201 /// \brief Track unresolved string-based type references.
202 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000203
David Majnemer654e1302015-07-31 17:58:14 +0000204 /// \brief The result type for a landingpad.
205 Type *LandingPadResultTy;
206
Reid Kleckner60381792015-07-07 22:25:32 +0000207 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000208 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000209 bool SawFrameEscape;
210
Reid Kleckner60381792015-07-07 22:25:32 +0000211 /// Stores the count of how many objects were passed to llvm.localescape for a
212 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000213 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000214
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000215 // Maps catchswitches and cleanuppads that unwind to siblings to the
216 // terminators that indicate the unwind, used to detect cycles therein.
217 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
218
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000219 /// Cache of constants visited in search of ConstantExprs.
220 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
221
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000222 // Verify that this GlobalValue is only used in this module.
223 // This map is used to avoid visiting uses twice. We can arrive at a user
224 // twice, if they have multiple operands. In particular for very large
225 // constant expressions, we can arrive at a particular user many times.
226 SmallPtrSet<const Value *, 32> GlobalValueVisited;
227
JF Bastiend1fb5852015-12-17 22:09:19 +0000228 void checkAtomicMemAccessSize(const Module *M, Type *Ty,
229 const Instruction *I);
Chandler Carruth043949d2014-01-19 02:22:18 +0000230public:
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +0000231 explicit Verifier(raw_ostream &OS)
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +0000232 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
David Majnemer654e1302015-07-31 17:58:14 +0000233 SawFrameEscape(false) {}
Chris Lattner0e851da2002-04-18 20:37:37 +0000234
Chandler Carruth043949d2014-01-19 02:22:18 +0000235 bool verify(const Function &F) {
236 M = F.getParent();
237 Context = &M->getContext();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000238
239 // First ensure the function is well-enough formed to compute dominance
240 // information.
Chandler Carruth043949d2014-01-19 02:22:18 +0000241 if (F.empty()) {
242 OS << "Function '" << F.getName()
243 << "' does not contain an entry block!\n";
244 return false;
245 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000246 for (const BasicBlock &BB : F) {
247 if (BB.empty() || !BB.back().isTerminator()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000248 OS << "Basic Block in function '" << F.getName()
249 << "' does not have terminator!\n";
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000250 BB.printAsOperand(OS, true);
Chandler Carruth043949d2014-01-19 02:22:18 +0000251 OS << "\n";
252 return false;
Chandler Carruth76777602014-01-17 10:56:02 +0000253 }
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000254 }
Chandler Carruth76777602014-01-17 10:56:02 +0000255
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000256 // Now directly compute a dominance tree. We don't rely on the pass
257 // manager to provide this as it isolates us from a potentially
258 // out-of-date dominator tree and makes it significantly more complex to
259 // run this code outside of a pass manager.
Chandler Carruth043949d2014-01-19 02:22:18 +0000260 // FIXME: It's really gross that we have to cast away constness here.
261 DT.recalculate(const_cast<Function &>(F));
Chris Lattneraf332ee2007-04-20 23:59:29 +0000262
Chandler Carruth043949d2014-01-19 02:22:18 +0000263 Broken = false;
264 // FIXME: We strip const here because the inst visitor strips const.
265 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000266 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000267 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000268 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000269 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000270 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000271
Chandler Carruth043949d2014-01-19 02:22:18 +0000272 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000273 }
274
Chandler Carruth043949d2014-01-19 02:22:18 +0000275 bool verify(const Module &M) {
276 this->M = &M;
277 Context = &M.getContext();
Chandler Carruth043949d2014-01-19 02:22:18 +0000278 Broken = false;
279
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000280 // Scan through, checking all of the external function's linkage now...
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000281 for (const Function &F : M) {
282 visitGlobalValue(F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000283
284 // Check to make sure function prototypes are okay.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000285 if (F.isDeclaration())
286 visitFunction(F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000287 }
288
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000289 // Now that we've visited every function, verify that we never asked to
290 // recover a frame index that wasn't escaped.
291 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000292 for (const GlobalVariable &GV : M.globals())
293 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000294
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000295 for (const GlobalAlias &GA : M.aliases())
296 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000297
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000298 for (const NamedMDNode &NMD : M.named_metadata())
299 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000300
David Majnemerdad0a642014-06-27 18:19:56 +0000301 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
302 visitComdat(SMEC.getValue());
303
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000304 visitModuleFlags(M);
305 visitModuleIdents(M);
306
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000307 verifyCompileUnits();
308
309 // Verify type references last.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000310 verifyTypeRefs();
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +0000311
Chandler Carruth043949d2014-01-19 02:22:18 +0000312 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000313 }
Chris Lattner9713b842002-04-28 16:04:26 +0000314
Chandler Carruth043949d2014-01-19 02:22:18 +0000315private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000316 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000317 void visitGlobalValue(const GlobalValue &GV);
318 void visitGlobalVariable(const GlobalVariable &GV);
319 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000320 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000321 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000322 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000323 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000324 void visitMDNode(const MDNode &MD);
325 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
326 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000327 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000328 void visitModuleIdents(const Module &M);
329 void visitModuleFlags(const Module &M);
330 void visitModuleFlag(const MDNode *Op,
331 DenseMap<const MDString *, const MDNode *> &SeenIDs,
332 SmallVectorImpl<const MDNode *> &Requirements);
333 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000334 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000335 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000336 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000337
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000338 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000339#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
340#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000341 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000342 void visitDIVariable(const DIVariable &N);
343 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
344 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000345
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000346 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
347
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000348 /// \brief Check for a valid string-based type reference.
349 ///
350 /// Checks if \c MD is a string-based type reference. If it is, keeps track
351 /// of it (and its user, \c N) for error messages later.
352 bool isValidUUID(const MDNode &N, const Metadata *MD);
353
354 /// \brief Check for a valid type reference.
355 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000356 /// Checks for subclasses of \a DIType, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000357 bool isTypeRef(const MDNode &N, const Metadata *MD);
358
359 /// \brief Check for a valid scope reference.
360 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000361 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000362 bool isScopeRef(const MDNode &N, const Metadata *MD);
363
364 /// \brief Check for a valid debug info reference.
365 ///
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000366 /// Checks for subclasses of \a DINode, or \a isValidUUID().
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000367 bool isDIRef(const MDNode &N, const Metadata *MD);
368
Chandler Carruth043949d2014-01-19 02:22:18 +0000369 // InstVisitor overrides...
370 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000371 void visit(Instruction &I);
372
373 void visitTruncInst(TruncInst &I);
374 void visitZExtInst(ZExtInst &I);
375 void visitSExtInst(SExtInst &I);
376 void visitFPTruncInst(FPTruncInst &I);
377 void visitFPExtInst(FPExtInst &I);
378 void visitFPToUIInst(FPToUIInst &I);
379 void visitFPToSIInst(FPToSIInst &I);
380 void visitUIToFPInst(UIToFPInst &I);
381 void visitSIToFPInst(SIToFPInst &I);
382 void visitIntToPtrInst(IntToPtrInst &I);
383 void visitPtrToIntInst(PtrToIntInst &I);
384 void visitBitCastInst(BitCastInst &I);
385 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
386 void visitPHINode(PHINode &PN);
387 void visitBinaryOperator(BinaryOperator &B);
388 void visitICmpInst(ICmpInst &IC);
389 void visitFCmpInst(FCmpInst &FC);
390 void visitExtractElementInst(ExtractElementInst &EI);
391 void visitInsertElementInst(InsertElementInst &EI);
392 void visitShuffleVectorInst(ShuffleVectorInst &EI);
393 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
394 void visitCallInst(CallInst &CI);
395 void visitInvokeInst(InvokeInst &II);
396 void visitGetElementPtrInst(GetElementPtrInst &GEP);
397 void visitLoadInst(LoadInst &LI);
398 void visitStoreInst(StoreInst &SI);
399 void verifyDominatesUse(Instruction &I, unsigned i);
400 void visitInstruction(Instruction &I);
401 void visitTerminatorInst(TerminatorInst &I);
402 void visitBranchInst(BranchInst &BI);
403 void visitReturnInst(ReturnInst &RI);
404 void visitSwitchInst(SwitchInst &SI);
405 void visitIndirectBrInst(IndirectBrInst &BI);
406 void visitSelectInst(SelectInst &SI);
407 void visitUserOp1(Instruction &I);
408 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000409 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000410 template <class DbgIntrinsicTy>
411 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000412 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
413 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
414 void visitFenceInst(FenceInst &FI);
415 void visitAllocaInst(AllocaInst &AI);
416 void visitExtractValueInst(ExtractValueInst &EVI);
417 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000418 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000419 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemer654e1302015-07-31 17:58:14 +0000420 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000421 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000422 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000423 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000424 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000425 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000426
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000427 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000428 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
429 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000430 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000431 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000432 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000433 bool verifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000434 SmallVectorImpl<Type *> &ArgTys);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000435 bool verifyIntrinsicIsVarArg(bool isVarArg,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000436 ArrayRef<Intrinsic::IITDescriptor> &Infos);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000437 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
438 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000439 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000440 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000441 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000442 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000443 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000444 void verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +0000445 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000446
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000447 void visitConstantExprsRecursively(const Constant *EntryC);
448 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000449 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000450 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000451 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000452
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000453 /// @{
454 /// Module-level debug info verification...
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000455 void verifyTypeRefs();
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000456 void verifyCompileUnits();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000457 template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +0000458 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
459 const MapTy &TypeRefs);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000460 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000461 /// @}
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000462};
Chris Lattner189d19f2003-11-21 20:23:48 +0000463} // End anonymous namespace
464
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000465// Assert - We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000466#define Assert(C, ...) \
467 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000468
Chris Lattnere5a22c02008-08-28 04:02:44 +0000469void Verifier::visit(Instruction &I) {
470 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000471 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000472 InstVisitor<Verifier>::visit(I);
473}
474
Keno Fischer60f82a22016-01-14 22:20:56 +0000475// Helper to recursively iterate over indirect users. By
476// returning false, the callback can ask to stop recursing
477// further.
478static void forEachUser(const Value *User,
479 SmallPtrSet<const Value *, 32> &Visited,
480 llvm::function_ref<bool(const Value *)> Callback) {
481 if (!Visited.insert(User).second)
482 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000483 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000484 if (Callback(TheNextUser))
485 forEachUser(TheNextUser, Visited, Callback);
486}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000487
Chandler Carruth043949d2014-01-19 02:22:18 +0000488void Verifier::visitGlobalValue(const GlobalValue &GV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000489 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
490 GV.hasExternalWeakLinkage(),
491 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000492
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000493 Assert(GV.getAlignment() <= Value::MaximumAlignment,
494 "huge alignment values are unsupported", &GV);
495 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
496 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000497
498 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000499 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000500 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000501 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000502 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000503
504 if (GV.isDeclarationForLinker())
505 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000506
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000507 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000508 if (const Instruction *I = dyn_cast<Instruction>(V)) {
509 if (!I->getParent() || !I->getParent()->getParent())
510 CheckFailed("Global is referenced by parentless instruction!", &GV,
511 M, I);
512 else if (I->getParent()->getParent()->getParent() != M)
513 CheckFailed("Global is referenced in a different module!", &GV,
514 M, I, I->getParent()->getParent(),
515 I->getParent()->getParent()->getParent());
516 return false;
517 } else if (const Function *F = dyn_cast<Function>(V)) {
518 if (F->getParent() != M)
519 CheckFailed("Global is used by function in a different module", &GV,
520 M, F, F->getParent());
521 return false;
522 }
523 return true;
524 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000525}
526
Chandler Carruth043949d2014-01-19 02:22:18 +0000527void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000528 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000529 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000530 "Global variable initializer type does not match global "
531 "variable type!",
532 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000533
Chris Lattner0aff0b22009-08-05 05:41:44 +0000534 // If the global has common linkage, it must have a zero initializer and
535 // cannot be constant.
536 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000537 Assert(GV.getInitializer()->isNullValue(),
538 "'common' global must have a zero initializer!", &GV);
539 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
540 &GV);
541 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000542 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000543 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000544 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
545 "invalid linkage type for global declaration", &GV);
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000546 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000547
Nick Lewycky466d0c12011-04-08 07:30:21 +0000548 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
549 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000550 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
551 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000552 // Don't worry about emitting an error for it not being an array,
553 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000554 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000555 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
556 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000557 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000558 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000559 Assert(STy &&
560 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
561 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
562 STy->getTypeAtIndex(1) == FuncPtrTy,
563 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000564 if (STy->getNumElements() == 3) {
565 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000566 Assert(ETy->isPointerTy() &&
567 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
568 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000569 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000570 }
571 }
572
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000573 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000574 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000575 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
576 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000577 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000578 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
579 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000580 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000581 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000582 const Constant *Init = GV.getInitializer();
583 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000584 Assert(InitArray, "wrong initalizer for intrinsic global variable",
585 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000586 for (Value *Op : InitArray->operands()) {
587 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000588 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
589 isa<GlobalAlias>(V),
590 "invalid llvm.used member", V);
591 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000592 }
593 }
594 }
595 }
596
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000597 Assert(!GV.hasDLLImportStorageClass() ||
598 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
599 GV.hasAvailableExternallyLinkage(),
600 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000601
Matt Arsenault24b49c42013-07-31 17:49:08 +0000602 if (!GV.hasInitializer()) {
603 visitGlobalValue(GV);
604 return;
605 }
606
607 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000608 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000609
Chris Lattnere3400652004-12-15 20:23:49 +0000610 visitGlobalValue(GV);
611}
612
Rafael Espindola64c1e182014-06-03 02:41:57 +0000613void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
614 SmallPtrSet<const GlobalAlias*, 4> Visited;
615 Visited.insert(&GA);
616 visitAliaseeSubExpr(Visited, GA, C);
617}
618
Craig Topper71b7b682014-08-21 05:55:13 +0000619void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000620 const GlobalAlias &GA, const Constant &C) {
621 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000622 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
623 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000624
625 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000626 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000627
Sanjoy Das5ce32722016-04-08 00:48:30 +0000628 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000629 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000630 } else {
631 // Only continue verifying subexpressions of GlobalAliases.
632 // Do not recurse into global initializers.
633 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000634 }
635 }
636
637 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000638 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000639
640 for (const Use &U : C.operands()) {
641 Value *V = &*U;
642 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
643 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
644 else if (const auto *C2 = dyn_cast<Constant>(V))
645 visitAliaseeSubExpr(Visited, GA, *C2);
646 }
647}
648
Chandler Carruth043949d2014-01-19 02:22:18 +0000649void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000650 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
651 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
652 "weak_odr, or external linkage!",
653 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000654 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000655 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
656 Assert(GA.getType() == Aliasee->getType(),
657 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000658
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000659 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
660 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000661
Rafael Espindola64c1e182014-06-03 02:41:57 +0000662 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000663
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000664 visitGlobalValue(GA);
665}
666
Chandler Carruth043949d2014-01-19 02:22:18 +0000667void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000668 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000669 if (NMD.getName() == "llvm.dbg.cu") {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000670 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000671 }
672
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000673 if (!MD)
674 continue;
675
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000676 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000677 }
678}
679
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000680void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000681 // Only visit each node once. Metadata can be mutually recursive, so this
682 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000683 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000684 return;
685
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000686 switch (MD.getMetadataID()) {
687 default:
688 llvm_unreachable("Invalid MDNode subclass");
689 case Metadata::MDTupleKind:
690 break;
691#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
692 case Metadata::CLASS##Kind: \
693 visit##CLASS(cast<CLASS>(MD)); \
694 break;
695#include "llvm/IR/Metadata.def"
696 }
697
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000698 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000699 if (!Op)
700 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000701 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
702 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000703 if (auto *N = dyn_cast<MDNode>(Op)) {
704 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000705 continue;
706 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000707 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
708 visitValueAsMetadata(*V, nullptr);
709 continue;
710 }
Duncan Sands76d62172010-04-29 16:10:30 +0000711 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000712
713 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000714 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
715 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000716}
717
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000718void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000719 Assert(MD.getValue(), "Expected valid value", &MD);
720 Assert(!MD.getValue()->getType()->isMetadataTy(),
721 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000722
723 auto *L = dyn_cast<LocalAsMetadata>(&MD);
724 if (!L)
725 return;
726
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000727 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000728
729 // If this was an instruction, bb, or argument, verify that it is in the
730 // function that we expect.
731 Function *ActualF = nullptr;
732 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000733 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000734 ActualF = I->getParent()->getParent();
735 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
736 ActualF = BB->getParent();
737 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
738 ActualF = A->getParent();
739 assert(ActualF && "Unimplemented function local metadata case!");
740
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000741 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000742}
743
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000744void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000745 Metadata *MD = MDV.getMetadata();
746 if (auto *N = dyn_cast<MDNode>(MD)) {
747 visitMDNode(*N);
748 return;
749 }
750
751 // Only visit each node once. Metadata can be mutually recursive, so this
752 // avoids infinite recursion here, as well as being an optimization.
753 if (!MDNodes.insert(MD).second)
754 return;
755
756 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
757 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000758}
759
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000760bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
761 auto *S = dyn_cast<MDString>(MD);
Davide Italiano14e351a2016-04-07 15:55:28 +0000762 if (!S || S->getString().empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000763 return false;
764
765 // Keep track of names of types referenced via UUID so we can check that they
766 // actually exist.
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +0000767 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000768 return true;
769}
770
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000771/// \brief Check if a value can be a reference to a type.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000772bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000773 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +0000774}
775
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000776/// \brief Check if a value can be a ScopeRef.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000777bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000778 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000779}
780
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000781/// \brief Check if a value can be a debug info ref.
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000782bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000783 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000784}
785
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000786template <class Ty>
787bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
788 for (Metadata *MD : N.operands()) {
789 if (MD) {
790 if (!isa<Ty>(MD))
791 return false;
792 } else {
793 if (!AllowNull)
794 return false;
795 }
796 }
797 return true;
798}
799
800template <class Ty>
801bool isValidMetadataArray(const MDTuple &N) {
802 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
803}
804
805template <class Ty>
806bool isValidMetadataNullArray(const MDTuple &N) {
807 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
808}
809
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000810void Verifier::visitDILocation(const DILocation &N) {
811 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000812 "location requires a valid scope", &N, N.getRawScope());
813 if (auto *IA = N.getRawInlinedAt())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000814 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000815}
816
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000817void Verifier::visitGenericDINode(const GenericDINode &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000818 Assert(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000819}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000820
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000821void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000822 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000823 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000824}
825
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000826void Verifier::visitDISubrange(const DISubrange &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000827 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000828 Assert(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000829}
830
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000831void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000832 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000833}
834
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000835void Verifier::visitDIBasicType(const DIBasicType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000836 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
837 N.getTag() == dwarf::DW_TAG_unspecified_type,
838 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000839}
840
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000841void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000842 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000843 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000844
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000845 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
846 N.getTag() == dwarf::DW_TAG_pointer_type ||
847 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
848 N.getTag() == dwarf::DW_TAG_reference_type ||
849 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
850 N.getTag() == dwarf::DW_TAG_const_type ||
851 N.getTag() == dwarf::DW_TAG_volatile_type ||
852 N.getTag() == dwarf::DW_TAG_restrict_type ||
853 N.getTag() == dwarf::DW_TAG_member ||
854 N.getTag() == dwarf::DW_TAG_inheritance ||
855 N.getTag() == dwarf::DW_TAG_friend,
856 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000857 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000858 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
859 N.getExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000860 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000861
Duncan P. N. Exon Smithc98ec202016-04-17 05:41:09 +0000862 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000863 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
864 N.getBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000865}
866
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000867static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000868 return (Flags & DINode::FlagLValueReference) &&
869 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000870}
871
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000872void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
873 auto *Params = dyn_cast<MDTuple>(&RawParams);
874 Assert(Params, "invalid template params", &N, &RawParams);
875 for (Metadata *Op : Params->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000876 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000877 Params, Op);
878 }
879}
880
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000881void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000882 // Common scope checks.
883 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000884
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000885 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
886 N.getTag() == dwarf::DW_TAG_structure_type ||
887 N.getTag() == dwarf::DW_TAG_union_type ||
888 N.getTag() == dwarf::DW_TAG_enumeration_type ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000889 N.getTag() == dwarf::DW_TAG_class_type,
890 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000891
Duncan P. N. Exon Smithc98ec202016-04-17 05:41:09 +0000892 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000893 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
894 N.getBaseType());
895
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000896 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
897 "invalid composite elements", &N, N.getRawElements());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000898 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000899 N.getRawVTableHolder());
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000900 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
901 &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000902 if (auto *Params = N.getRawTemplateParams())
903 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000904
905 if (N.getTag() == dwarf::DW_TAG_class_type ||
906 N.getTag() == dwarf::DW_TAG_union_type) {
907 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
908 "class/union requires a filename", &N, N.getFile());
909 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000910}
911
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000912void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000913 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000914 if (auto *Types = N.getRawTypeArray()) {
915 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
916 for (Metadata *Ty : N.getTypeArray()->operands()) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000917 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000918 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000919 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000920 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
921 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000922}
923
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000924void Verifier::visitDIFile(const DIFile &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000925 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000926}
927
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000928void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000929 Assert(N.isDistinct(), "compile units must be distinct", &N);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000930 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000931
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000932 // Don't bother verifying the compilation directory or producer string
933 // as those could be empty.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000934 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
935 N.getRawFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000936 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
937 N.getFile());
938
Adrian Prantlb939a252016-03-31 23:56:58 +0000939 Assert((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
940 "invalid emission kind", &N);
941
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000942 if (auto *Array = N.getRawEnumTypes()) {
943 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
944 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000945 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000946 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
947 "invalid enum type", &N, N.getEnumTypes(), Op);
948 }
949 }
950 if (auto *Array = N.getRawRetainedTypes()) {
951 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
952 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl75819ae2016-04-15 15:57:41 +0000953 Assert(Op && (isa<DIType>(Op) ||
954 (isa<DISubprogram>(Op) &&
955 cast<DISubprogram>(Op)->isDefinition() == false)),
956 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 }
958 }
959 if (auto *Array = N.getRawGlobalVariables()) {
960 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
961 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000962 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000963 Op);
964 }
965 }
966 if (auto *Array = N.getRawImportedEntities()) {
967 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
968 for (Metadata *Op : N.getImportedEntities()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000969 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000970 Op);
971 }
972 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000973 if (auto *Array = N.getRawMacros()) {
974 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
975 for (Metadata *Op : N.getMacros()->operands()) {
976 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
977 }
978 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000979 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000980}
981
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000982void Verifier::visitDISubprogram(const DISubprogram &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000983 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000984 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +0000985 if (auto *F = N.getRawFile())
986 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000987 if (auto *T = N.getRawType())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000988 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000989 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000990 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000991 if (auto *Params = N.getRawTemplateParams())
992 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +0000993 if (auto *S = N.getRawDeclaration())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000994 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000995 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000996 if (auto *RawVars = N.getRawVariables()) {
997 auto *Vars = dyn_cast<MDTuple>(RawVars);
998 Assert(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000999 for (Metadata *Op : Vars->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001000 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001001 Op);
1002 }
1003 }
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +00001004 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
1005 &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001006
Adrian Prantl75819ae2016-04-15 15:57:41 +00001007 auto *Unit = N.getRawUnit();
1008 if (N.isDefinition()) {
1009 // Subprogram definitions (not part of the type hierarchy).
Duncan P. N. Exon Smith814b8e92015-08-28 20:26:49 +00001010 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001011 Assert(Unit, "subprogram definitions must have a compile unit", &N);
1012 Assert(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
1013 } else {
1014 // Subprogram declarations (part of the type hierarchy).
1015 Assert(!Unit, "subprogram declarations must not have a compile unit", &N);
1016 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001017}
1018
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001019void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001020 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001021 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001022 "invalid local scope", &N, N.getRawScope());
1023}
1024
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001025void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1026 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001027
1028 Assert(N.getLine() || !N.getColumn(),
1029 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001030}
1031
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001032void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1033 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001034}
1035
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001036void Verifier::visitDINamespace(const DINamespace &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001037 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001038 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001039 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001040}
1041
Amjad Abouda9bcf162015-12-10 12:56:35 +00001042void Verifier::visitDIMacro(const DIMacro &N) {
1043 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1044 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1045 "invalid macinfo type", &N);
1046 Assert(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001047 if (!N.getValue().empty()) {
1048 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1049 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001050}
1051
1052void Verifier::visitDIMacroFile(const DIMacroFile &N) {
1053 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1054 "invalid macinfo type", &N);
1055 if (auto *F = N.getRawFile())
1056 Assert(isa<DIFile>(F), "invalid file", &N, F);
1057
1058 if (auto *Array = N.getRawElements()) {
1059 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
1060 for (Metadata *Op : N.getElements()->operands()) {
1061 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1062 }
1063 }
1064}
1065
Adrian Prantlab1243f2015-06-29 23:03:47 +00001066void Verifier::visitDIModule(const DIModule &N) {
1067 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1068 Assert(!N.getName().empty(), "anonymous module", &N);
1069}
1070
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001071void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001072 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001073}
1074
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001075void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1076 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001077
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001078 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1079 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001080}
1081
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001082void Verifier::visitDITemplateValueParameter(
1083 const DITemplateValueParameter &N) {
1084 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001085
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001086 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1087 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1088 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1089 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001090}
1091
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001092void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001093 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001094 Assert(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001095 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001096 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001097 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001098}
1099
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001100void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001101 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001102 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001103
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001104 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smith94d58f82015-03-31 01:28:22 +00001105 Assert(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001106 if (auto *V = N.getRawVariable()) {
1107 Assert(isa<ConstantAsMetadata>(V) &&
1108 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1109 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001110 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001111 }
1112 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001113 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001114 &N, Member);
1115 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001116}
1117
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001118void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001119 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001120 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001121
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +00001122 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001123 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001124 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001125}
1126
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001127void Verifier::visitDIExpression(const DIExpression &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001128 Assert(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001129}
1130
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001131void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001132 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001133 if (auto *T = N.getRawType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001134 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001135 if (auto *F = N.getRawFile())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001136 Assert(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001137}
1138
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001139void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001140 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1141 N.getTag() == dwarf::DW_TAG_imported_declaration,
1142 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001143 if (auto *S = N.getRawScope())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001144 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00001145 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1146 N.getEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001147}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001148
David Majnemerdad0a642014-06-27 18:19:56 +00001149void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001150 // The Module is invalid if the GlobalValue has private linkage. Entities
1151 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001152 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001153 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1154 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001155}
1156
Chandler Carruth043949d2014-01-19 02:22:18 +00001157void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001158 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1159 if (!Idents)
1160 return;
1161
1162 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1163 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001164 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001165 Assert(N->getNumOperands() == 1,
1166 "incorrect number of operands in llvm.ident metadata", N);
1167 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1168 ("invalid value for llvm.ident metadata entry operand"
1169 "(the operand should be a string)"),
1170 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001171 }
1172}
1173
Chandler Carruth043949d2014-01-19 02:22:18 +00001174void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001175 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1176 if (!Flags) return;
1177
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001178 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001179 DenseMap<const MDString*, const MDNode*> SeenIDs;
1180 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001181 for (const MDNode *MDN : Flags->operands())
1182 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001183
1184 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001185 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001186 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001187 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001188
Chandler Carruth043949d2014-01-19 02:22:18 +00001189 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001190 if (!Op) {
1191 CheckFailed("invalid requirement on flag, flag is not present in module",
1192 Flag);
1193 continue;
1194 }
1195
1196 if (Op->getOperand(2) != ReqValue) {
1197 CheckFailed(("invalid requirement on flag, "
1198 "flag does not have the required value"),
1199 Flag);
1200 continue;
1201 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001202 }
1203}
1204
Chandler Carruth043949d2014-01-19 02:22:18 +00001205void
1206Verifier::visitModuleFlag(const MDNode *Op,
1207 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1208 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001209 // Each module flag should have three arguments, the merge behavior (a
1210 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001211 Assert(Op->getNumOperands() == 3,
1212 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001213 Module::ModFlagBehavior MFB;
1214 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001215 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001216 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001217 "invalid behavior operand in module flag (expected constant integer)",
1218 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001219 Assert(false,
1220 "invalid behavior operand in module flag (unexpected constant)",
1221 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001222 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001223 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001224 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1225 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001226
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001227 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001228 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001229 case Module::Error:
1230 case Module::Warning:
1231 case Module::Override:
1232 // These behavior types accept any value.
1233 break;
1234
1235 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001236 // The value should itself be an MDNode with two operands, a flag ID (an
1237 // MDString), and a value.
1238 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001239 Assert(Value && Value->getNumOperands() == 2,
1240 "invalid value for 'require' module flag (expected metadata pair)",
1241 Op->getOperand(2));
1242 Assert(isa<MDString>(Value->getOperand(0)),
1243 ("invalid value for 'require' module flag "
1244 "(first value operand should be a string)"),
1245 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001246
1247 // Append it to the list of requirements, to check once all module flags are
1248 // scanned.
1249 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001250 break;
1251 }
1252
1253 case Module::Append:
1254 case Module::AppendUnique: {
1255 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001256 Assert(isa<MDNode>(Op->getOperand(2)),
1257 "invalid value for 'append'-type module flag "
1258 "(expected a metadata node)",
1259 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001260 break;
1261 }
1262 }
1263
1264 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001265 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001266 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001267 Assert(Inserted,
1268 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001269 }
1270}
1271
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001272void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001273 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001274 unsigned Slot = ~0U;
1275 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1276 if (Attrs.getSlotIndex(I) == Idx) {
1277 Slot = I;
1278 break;
1279 }
1280
1281 assert(Slot != ~0U && "Attribute set inconsistency!");
1282
1283 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1284 I != E; ++I) {
1285 if (I->isStringAttribute())
1286 continue;
1287
1288 if (I->getKindAsEnum() == Attribute::NoReturn ||
1289 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001290 I->getKindAsEnum() == Attribute::NoInline ||
1291 I->getKindAsEnum() == Attribute::AlwaysInline ||
1292 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1293 I->getKindAsEnum() == Attribute::StackProtect ||
1294 I->getKindAsEnum() == Attribute::StackProtectReq ||
1295 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001296 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001297 I->getKindAsEnum() == Attribute::NoRedZone ||
1298 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1299 I->getKindAsEnum() == Attribute::Naked ||
1300 I->getKindAsEnum() == Attribute::InlineHint ||
1301 I->getKindAsEnum() == Attribute::StackAlignment ||
1302 I->getKindAsEnum() == Attribute::UWTable ||
1303 I->getKindAsEnum() == Attribute::NonLazyBind ||
1304 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1305 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1306 I->getKindAsEnum() == Attribute::SanitizeThread ||
1307 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1308 I->getKindAsEnum() == Attribute::MinSize ||
1309 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001310 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001311 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001312 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001313 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001314 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001315 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001316 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001317 I->getKindAsEnum() == Attribute::NoRecurse ||
1318 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001319 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1320 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001321 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001322 CheckFailed("Attribute '" + I->getAsString() +
1323 "' only applies to functions!", V);
1324 return;
1325 }
1326 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1327 I->getKindAsEnum() == Attribute::ReadNone) {
1328 if (Idx == 0) {
1329 CheckFailed("Attribute '" + I->getAsString() +
1330 "' does not apply to function returns");
1331 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001332 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001333 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001334 CheckFailed("Attribute '" + I->getAsString() +
1335 "' does not apply to functions!", V);
1336 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001337 }
1338 }
1339}
1340
Duncan Sandsc3a79922009-06-11 08:11:03 +00001341// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001342// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001343void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001344 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001345 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001346 return;
1347
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001348 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001349
Bill Wendling908126a2012-10-09 09:51:10 +00001350 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001351 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1352 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1353 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1354 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1355 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001356 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001357 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1358 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001359 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001360 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001361 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001362 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001363
Reid Klecknera534a382013-12-19 02:14:12 +00001364 // Check for mutually incompatible attributes. Only inreg is compatible with
1365 // sret.
1366 unsigned AttrCount = 0;
1367 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1368 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1369 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1370 Attrs.hasAttribute(Idx, Attribute::InReg);
1371 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001372 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1373 "and 'sret' are incompatible!",
1374 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001375
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001376 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1377 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1378 "Attributes "
1379 "'inalloca and readonly' are incompatible!",
1380 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001381
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001382 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1383 Attrs.hasAttribute(Idx, Attribute::Returned)),
1384 "Attributes "
1385 "'sret and returned' are incompatible!",
1386 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001387
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001388 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1389 Attrs.hasAttribute(Idx, Attribute::SExt)),
1390 "Attributes "
1391 "'zeroext and signext' are incompatible!",
1392 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001393
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001394 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1395 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1396 "Attributes "
1397 "'readnone and readonly' are incompatible!",
1398 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001399
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001400 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1401 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1402 "Attributes "
1403 "'noinline and alwaysinline' are incompatible!",
1404 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001405
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001406 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001407 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001408 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001409 AttributeSet::get(*Context, Idx,
1410 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001411 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001412
Reid Klecknera534a382013-12-19 02:14:12 +00001413 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001414 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001415 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001416 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1417 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1418 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1419 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001420 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001421 if (!isa<PointerType>(PTy->getElementType()))
1422 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1423 "Attribute 'swifterror' only applies to parameters "
1424 "with pointer to pointer type!",
1425 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001426 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001427 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1428 "Attribute 'byval' only applies to parameters with pointer type!",
1429 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001430 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1431 "Attribute 'swifterror' only applies to parameters "
1432 "with pointer type!",
1433 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001434 }
Duncan Sands0009c442008-01-12 16:42:01 +00001435}
1436
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001437// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001438// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001439void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001440 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001441 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001442 return;
1443
Duncan Sands8c582282007-12-21 19:19:01 +00001444 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001445 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001446 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001447 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001448 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001449
Chris Lattner8a923e72008-03-12 17:45:29 +00001450 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001451 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001452
Chris Lattner229907c2011-07-18 04:54:35 +00001453 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001454 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001455 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001456 else if (Idx-1 < FT->getNumParams())
1457 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001458 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001459 break; // VarArgs attributes, verified elsewhere.
1460
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001461 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001462
Stephen Linb8bd2322013-04-20 05:14:40 +00001463 if (Idx == 0)
1464 continue;
1465
1466 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001467 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001468 SawNest = true;
1469 }
1470
Stephen Linb8bd2322013-04-20 05:14:40 +00001471 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001472 Assert(!SawReturned, "More than one parameter has attribute returned!",
1473 V);
1474 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1475 "Incompatible "
1476 "argument and return types for 'returned' attribute",
1477 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001478 SawReturned = true;
1479 }
1480
Reid Kleckner79418562014-05-09 22:32:13 +00001481 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001482 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1483 Assert(Idx == 1 || Idx == 2,
1484 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001485 SawSRet = true;
1486 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001487
Manman Renf46262e2016-03-29 17:37:21 +00001488 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1489 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1490 SawSwiftSelf = true;
1491 }
1492
Manman Ren9bfd0d02016-04-01 21:41:15 +00001493 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1494 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1495 V);
1496 SawSwiftError = true;
1497 }
1498
Reid Kleckner60d3a832014-01-16 22:59:24 +00001499 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001500 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1501 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001502 }
Duncan Sands8c582282007-12-21 19:19:01 +00001503 }
Devang Patel9cc98122008-10-01 23:41:25 +00001504
Bill Wendling77543892013-01-18 21:11:39 +00001505 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1506 return;
1507
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001508 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001509
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001510 Assert(
1511 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1512 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1513 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001514
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001515 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001516 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1517 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1518 Attribute::InaccessibleMemOrArgMemOnly)),
1519 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1520
1521 Assert(
1522 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1523 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1524 Attribute::InaccessibleMemOnly)),
1525 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1526
1527 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001528 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1529 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1530 Attribute::AlwaysInline)),
1531 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001532
1533 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1534 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001535 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1536 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001537
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001538 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1539 Attribute::OptimizeForSize),
1540 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001541
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001542 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1543 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001544 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001545
1546 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1547 Attribute::JumpTable)) {
1548 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001549 Assert(GV->hasUnnamedAddr(),
1550 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001551 }
George Burgess IV278199f2016-04-12 01:05:35 +00001552
1553 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1554 std::pair<unsigned, Optional<unsigned>> Args =
1555 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1556
1557 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1558 if (ParamNo >= FT->getNumParams()) {
1559 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1560 return false;
1561 }
1562
1563 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1564 CheckFailed("'allocsize' " + Name +
1565 " argument must refer to an integer parameter",
1566 V);
1567 return false;
1568 }
1569
1570 return true;
1571 };
1572
1573 if (!CheckParam("element size", Args.first))
1574 return;
1575
1576 if (Args.second && !CheckParam("number of elements", *Args.second))
1577 return;
1578 }
Duncan Sands8c582282007-12-21 19:19:01 +00001579}
1580
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001581void Verifier::verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +00001582 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1583 if (MDs.empty())
1584 return;
1585
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001586 for (const auto &Pair : MDs) {
1587 if (Pair.first == LLVMContext::MD_prof) {
1588 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001589 Assert(MD->getNumOperands() == 2,
1590 "!prof annotations should have exactly 2 operands", MD);
1591
1592 // Check first operand.
1593 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1594 MD);
1595 Assert(isa<MDString>(MD->getOperand(0)),
1596 "expected string with name of the !prof annotation", MD);
1597 MDString *MDS = cast<MDString>(MD->getOperand(0));
1598 StringRef ProfName = MDS->getString();
1599 Assert(ProfName.equals("function_entry_count"),
1600 "first operand should be 'function_entry_count'", MD);
1601
1602 // Check second operand.
1603 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1604 MD);
1605 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1606 "expected integer argument to function_entry_count", MD);
1607 }
1608 }
1609}
1610
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001611void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1612 if (!ConstantExprVisited.insert(EntryC).second)
1613 return;
1614
1615 SmallVector<const Constant *, 16> Stack;
1616 Stack.push_back(EntryC);
1617
1618 while (!Stack.empty()) {
1619 const Constant *C = Stack.pop_back_val();
1620
1621 // Check this constant expression.
1622 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1623 visitConstantExpr(CE);
1624
Keno Fischerf6d17b92016-01-14 22:42:02 +00001625 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1626 // Global Values get visited separately, but we do need to make sure
1627 // that the global value is in the correct module
1628 Assert(GV->getParent() == M, "Referencing global in another module!",
1629 EntryC, M, GV, GV->getParent());
1630 continue;
1631 }
1632
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001633 // Visit all sub-expressions.
1634 for (const Use &U : C->operands()) {
1635 const auto *OpC = dyn_cast<Constant>(U);
1636 if (!OpC)
1637 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001638 if (!ConstantExprVisited.insert(OpC).second)
1639 continue;
1640 Stack.push_back(OpC);
1641 }
1642 }
1643}
1644
1645void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001646 if (CE->getOpcode() != Instruction::BitCast)
1647 return;
1648
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001649 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1650 CE->getType()),
1651 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001652}
1653
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001654bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001655 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001656 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001657
Devang Patel82fed672008-09-23 22:35:17 +00001658 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001659 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001660 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001661 || (LastIndex == AttributeSet::FunctionIndex
1662 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001663 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001664
Devang Patel82fed672008-09-23 22:35:17 +00001665 return false;
1666}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001667
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001668/// Verify that statepoint intrinsic is well formed.
1669void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001670 assert(CS.getCalledFunction() &&
1671 CS.getCalledFunction()->getIntrinsicID() ==
1672 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001673
Philip Reames0285c742015-02-03 23:18:47 +00001674 const Instruction &CI = *CS.getInstruction();
1675
Igor Laevsky39d662f2015-07-11 10:30:36 +00001676 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1677 !CS.onlyAccessesArgMemory(),
1678 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001679 "reordering restrictions required by safepoint semantics",
1680 &CI);
1681
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001682 const Value *IDV = CS.getArgument(0);
1683 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1684 &CI);
1685
1686 const Value *NumPatchBytesV = CS.getArgument(1);
1687 Assert(isa<ConstantInt>(NumPatchBytesV),
1688 "gc.statepoint number of patchable bytes must be a constant integer",
1689 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001690 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001691 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1692 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1693 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1694 "positive",
1695 &CI);
1696
1697 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001698 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001699 Assert(PT && PT->getElementType()->isFunctionTy(),
1700 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001701 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001702
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001703 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001704 Assert(isa<ConstantInt>(NumCallArgsV),
1705 "gc.statepoint number of arguments to underlying call "
1706 "must be constant integer",
1707 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001708 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001709 Assert(NumCallArgs >= 0,
1710 "gc.statepoint number of arguments to underlying call "
1711 "must be positive",
1712 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001713 const int NumParams = (int)TargetFuncType->getNumParams();
1714 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001715 Assert(NumCallArgs >= NumParams,
1716 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001717
1718 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001719 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1720 "gc.statepoint doesn't support wrapping non-void "
1721 "vararg functions yet",
1722 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001723 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001724 Assert(NumCallArgs == NumParams,
1725 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001726
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001727 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001728 Assert(isa<ConstantInt>(FlagsV),
1729 "gc.statepoint flags must be constant integer", &CI);
1730 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1731 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1732 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001733
1734 // Verify that the types of the call parameter arguments match
1735 // the type of the wrapped callee.
1736 for (int i = 0; i < NumParams; i++) {
1737 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001738 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001739 Assert(ArgType == ParamType,
1740 "gc.statepoint call argument does not match wrapped "
1741 "function type",
1742 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001743 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001744
1745 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001746
1747 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1748 Assert(isa<ConstantInt>(NumTransitionArgsV),
1749 "gc.statepoint number of transition arguments "
1750 "must be constant integer",
1751 &CI);
1752 const int NumTransitionArgs =
1753 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1754 Assert(NumTransitionArgs >= 0,
1755 "gc.statepoint number of transition arguments must be positive", &CI);
1756 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1757
1758 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001759 Assert(isa<ConstantInt>(NumDeoptArgsV),
1760 "gc.statepoint number of deoptimization arguments "
1761 "must be constant integer",
1762 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001763 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001764 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1765 "must be positive",
1766 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001767
Pat Gavlincc0431d2015-05-08 18:07:42 +00001768 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001769 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001770 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001771 "gc.statepoint too few arguments according to length fields", &CI);
1772
Philip Reames1ffa9372015-01-30 23:28:05 +00001773 // Check that the only uses of this gc.statepoint are gc.result or
1774 // gc.relocate calls which are tied to this statepoint and thus part
1775 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001776 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001777 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001778 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001779 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001780 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001781 "gc.result or gc.relocate are the only value uses"
1782 "of a gc.statepoint",
1783 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001784 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001785 Assert(Call->getArgOperand(0) == &CI,
1786 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001787 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001788 Assert(Call->getArgOperand(0) == &CI,
1789 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001790 }
1791 }
1792
1793 // Note: It is legal for a single derived pointer to be listed multiple
1794 // times. It's non-optimal, but it is legal. It can also happen after
1795 // insertion if we strip a bitcast away.
1796 // Note: It is really tempting to check that each base is relocated and
1797 // that a derived pointer is never reused as a base pointer. This turns
1798 // out to be problematic since optimizations run after safepoint insertion
1799 // can recognize equality properties that the insertion logic doesn't know
1800 // about. See example statepoint.ll in the verifier subdirectory
1801}
1802
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001803void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001804 for (auto &Counts : FrameEscapeInfo) {
1805 Function *F = Counts.first;
1806 unsigned EscapedObjectCount = Counts.second.first;
1807 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001808 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001809 "all indices passed to llvm.localrecover must be less than the "
1810 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001811 "function",
1812 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001813 }
1814}
1815
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001816static Instruction *getSuccPad(TerminatorInst *Terminator) {
1817 BasicBlock *UnwindDest;
1818 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1819 UnwindDest = II->getUnwindDest();
1820 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1821 UnwindDest = CSI->getUnwindDest();
1822 else
1823 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1824 return UnwindDest->getFirstNonPHI();
1825}
1826
1827void Verifier::verifySiblingFuncletUnwinds() {
1828 SmallPtrSet<Instruction *, 8> Visited;
1829 SmallPtrSet<Instruction *, 8> Active;
1830 for (const auto &Pair : SiblingFuncletInfo) {
1831 Instruction *PredPad = Pair.first;
1832 if (Visited.count(PredPad))
1833 continue;
1834 Active.insert(PredPad);
1835 TerminatorInst *Terminator = Pair.second;
1836 do {
1837 Instruction *SuccPad = getSuccPad(Terminator);
1838 if (Active.count(SuccPad)) {
1839 // Found a cycle; report error
1840 Instruction *CyclePad = SuccPad;
1841 SmallVector<Instruction *, 8> CycleNodes;
1842 do {
1843 CycleNodes.push_back(CyclePad);
1844 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1845 if (CycleTerminator != CyclePad)
1846 CycleNodes.push_back(CycleTerminator);
1847 CyclePad = getSuccPad(CycleTerminator);
1848 } while (CyclePad != SuccPad);
1849 Assert(false, "EH pads can't handle each other's exceptions",
1850 ArrayRef<Instruction *>(CycleNodes));
1851 }
1852 // Don't re-walk a node we've already checked
1853 if (!Visited.insert(SuccPad).second)
1854 break;
1855 // Walk to this successor if it has a map entry.
1856 PredPad = SuccPad;
1857 auto TermI = SiblingFuncletInfo.find(PredPad);
1858 if (TermI == SiblingFuncletInfo.end())
1859 break;
1860 Terminator = TermI->second;
1861 Active.insert(PredPad);
1862 } while (true);
1863 // Each node only has one successor, so we've walked all the active
1864 // nodes' successors.
1865 Active.clear();
1866 }
1867}
1868
Chris Lattner0e851da2002-04-18 20:37:37 +00001869// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001870//
Chandler Carruth043949d2014-01-19 02:22:18 +00001871void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001872 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001873 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001874 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001875
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001876 Assert(Context == &F.getContext(),
1877 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001878
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001879 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1880 Assert(FT->getNumParams() == NumArgs,
1881 "# formal arguments must match # of arguments for function type!", &F,
1882 FT);
1883 Assert(F.getReturnType()->isFirstClassType() ||
1884 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1885 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001886
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001887 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1888 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001889
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001890 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001891
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001892 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001893 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001894
Duncan Sands8c582282007-12-21 19:19:01 +00001895 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001896 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001897
Michael Gottesman41748d72013-06-27 00:25:01 +00001898 // On function declarations/definitions, we do not support the builtin
1899 // attribute. We do not check this in VerifyFunctionAttrs since that is
1900 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001901 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1902 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001903
Chris Lattneref13ee32006-05-19 21:25:17 +00001904 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001905 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1906 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001907 switch (F.getCallingConv()) {
1908 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001909 case CallingConv::C:
1910 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001911 case CallingConv::Fast:
1912 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001913 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001914 case CallingConv::PTX_Kernel:
1915 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001916 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1917 "perfect forwarding!",
1918 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001919 break;
1920 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001921
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001922 bool isLLVMdotName = F.getName().size() >= 5 &&
1923 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001924
Chris Lattneraf95e582002-04-13 22:48:46 +00001925 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001926 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001927 for (const Argument &Arg : F.args()) {
1928 Assert(Arg.getType() == FT->getParamType(i),
1929 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001930 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001931 Assert(Arg.getType()->isFirstClassType(),
1932 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001933 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001934 Assert(!Arg.getType()->isMetadataTy(),
1935 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1936 Assert(!Arg.getType()->isTokenTy(),
1937 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001938 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001939
1940 // Check that swifterror argument is only used by loads and stores.
1941 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1942 verifySwiftErrorValue(&Arg);
1943 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001944 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001945 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001946
David Majnemerb611e3f2015-08-14 05:09:07 +00001947 if (!isLLVMdotName)
1948 Assert(!F.getReturnType()->isTokenTy(),
1949 "Functions returns a token but isn't an intrinsic", &F);
1950
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001951 // Get the function metadata attachments.
1952 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1953 F.getAllMetadata(MDs);
1954 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001955 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001956
Keno Fischer2ac0c272015-11-16 05:13:30 +00001957 // Check validity of the personality function
1958 if (F.hasPersonalityFn()) {
1959 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1960 if (Per)
1961 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001962 "Referencing personality function in another module!",
1963 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001964 }
1965
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001966 if (F.isMaterializable()) {
1967 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001968 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1969 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001970 } else if (F.isDeclaration()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001971 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1972 "invalid linkage type for function declaration", &F);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001973 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1974 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001975 Assert(!F.hasPersonalityFn(),
1976 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001977 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001978 // Verify that this function (which has a body) is not named "llvm.*". It
1979 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001980 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001981
Chris Lattner149376d2002-10-13 20:57:00 +00001982 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001983 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001984 Assert(pred_empty(Entry),
1985 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001986
Chris Lattner27471742009-11-01 04:08:01 +00001987 // The address of the entry block cannot be taken, unless it is dead.
1988 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001989 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1990 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001991 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001992
1993 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001994 for (const auto &I : MDs) {
1995 // Verify that the attachment is legal.
1996 switch (I.first) {
1997 default:
1998 break;
1999 case LLVMContext::MD_dbg:
2000 Assert(isa<DISubprogram>(I.second),
2001 "function !dbg attachment must be a subprogram", &F, I.second);
2002 break;
2003 }
2004
2005 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002006 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002007 }
Chris Lattner149376d2002-10-13 20:57:00 +00002008 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002009
Chris Lattner7730dcc2009-09-11 17:05:29 +00002010 // If this function is actually an intrinsic, verify that it is only used in
2011 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002012 // Only do this if the module is materialized, otherwise we don't have all the
2013 // uses.
2014 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002015 const User *U;
2016 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002017 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002018 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002019
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002020 Assert(!F.hasDLLImportStorageClass() ||
2021 (F.isDeclaration() && F.hasExternalLinkage()) ||
2022 F.hasAvailableExternallyLinkage(),
2023 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002024
2025 auto *N = F.getSubprogram();
2026 if (!N)
2027 return;
2028
Adrian Prantl75819ae2016-04-15 15:57:41 +00002029 visitDISubprogram(*N);
2030
Peter Collingbourned4bff302015-11-05 22:03:56 +00002031 // Check that all !dbg attachments lead to back to N (or, at least, another
2032 // subprogram that describes the same function).
2033 //
2034 // FIXME: Check this incrementally while visiting !dbg attachments.
2035 // FIXME: Only check when N is the canonical subprogram for F.
2036 SmallPtrSet<const MDNode *, 32> Seen;
2037 for (auto &BB : F)
2038 for (auto &I : BB) {
2039 // Be careful about using DILocation here since we might be dealing with
2040 // broken code (this is the Verifier after all).
2041 DILocation *DL =
2042 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2043 if (!DL)
2044 continue;
2045 if (!Seen.insert(DL).second)
2046 continue;
2047
2048 DILocalScope *Scope = DL->getInlinedAtScope();
2049 if (Scope && !Seen.insert(Scope).second)
2050 continue;
2051
2052 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002053
2054 // Scope and SP could be the same MDNode and we don't want to skip
2055 // validation in that case
2056 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002057 continue;
2058
2059 // FIXME: Once N is canonical, check "SP == &N".
2060 Assert(SP->describes(&F),
2061 "!dbg attachment points at wrong subprogram for function", N, &F,
2062 &I, DL, Scope, SP);
2063 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002064}
2065
Chris Lattner0e851da2002-04-18 20:37:37 +00002066// verifyBasicBlock - Verify that a basic block is well formed...
2067//
Chris Lattner069a7952002-06-25 15:56:27 +00002068void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002069 InstsInThisBlock.clear();
2070
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002071 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002072 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002073
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002074 // Check constraints that this basic block imposes on all of the PHI nodes in
2075 // it.
2076 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002077 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2078 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002079 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002080 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002081 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002082 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002083 Assert(PN->getNumIncomingValues() != 0,
2084 "PHI nodes must have at least one entry. If the block is dead, "
2085 "the PHI should be removed!",
2086 PN);
2087 Assert(PN->getNumIncomingValues() == Preds.size(),
2088 "PHINode should have one entry for each predecessor of its "
2089 "parent basic block!",
2090 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002091
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002092 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002093 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002094 Values.reserve(PN->getNumIncomingValues());
2095 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2096 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2097 PN->getIncomingValue(i)));
2098 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002099
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002100 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2101 // Check to make sure that if there is more than one entry for a
2102 // particular basic block in this PHI node, that the incoming values are
2103 // all identical.
2104 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002105 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2106 Values[i].second == Values[i - 1].second,
2107 "PHI node has multiple entries for the same basic block with "
2108 "different incoming values!",
2109 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002110
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002111 // Check to make sure that the predecessors and PHI node entries are
2112 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002113 Assert(Values[i].first == Preds[i],
2114 "PHI node entries do not match predecessors!", PN,
2115 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002116 }
2117 }
2118 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002119
2120 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002121 for (auto &I : BB)
2122 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002123 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002124 }
Chris Lattner069a7952002-06-25 15:56:27 +00002125}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002126
Chris Lattner069a7952002-06-25 15:56:27 +00002127void Verifier::visitTerminatorInst(TerminatorInst &I) {
2128 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002129 Assert(&I == I.getParent()->getTerminator(),
2130 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002131 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002132}
2133
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002134void Verifier::visitBranchInst(BranchInst &BI) {
2135 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002136 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2137 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002138 }
2139 visitTerminatorInst(BI);
2140}
2141
Chris Lattner069a7952002-06-25 15:56:27 +00002142void Verifier::visitReturnInst(ReturnInst &RI) {
2143 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002144 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002145 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002146 Assert(N == 0,
2147 "Found return instr that returns non-void in Function of void "
2148 "return type!",
2149 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002150 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002151 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2152 "Function return type does not match operand "
2153 "type of return inst!",
2154 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002155
Misha Brukman7eb05a12003-08-18 14:43:39 +00002156 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002157 // terminators...
2158 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002159}
2160
Chris Lattnerab5aa142004-05-21 16:47:21 +00002161void Verifier::visitSwitchInst(SwitchInst &SI) {
2162 // Check to make sure that all of the constants in the switch instruction
2163 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002164 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002165 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002166 for (auto &Case : SI.cases()) {
2167 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002168 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002169 Assert(Constants.insert(Case.getCaseValue()).second,
2170 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002171 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002172
Chris Lattnerab5aa142004-05-21 16:47:21 +00002173 visitTerminatorInst(SI);
2174}
2175
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002176void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002177 Assert(BI.getAddress()->getType()->isPointerTy(),
2178 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002179 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002180 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2181 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002182
2183 visitTerminatorInst(BI);
2184}
2185
Chris Lattner75648e72004-03-12 05:54:31 +00002186void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002187 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2188 SI.getOperand(2)),
2189 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002190
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002191 Assert(SI.getTrueValue()->getType() == SI.getType(),
2192 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002193 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002194}
2195
Misha Brukmanc566ca362004-03-02 00:22:19 +00002196/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2197/// a pass, if any exist, it's an error.
2198///
Chris Lattner903a25d2002-11-21 16:54:22 +00002199void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002200 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002201}
Chris Lattner0e851da2002-04-18 20:37:37 +00002202
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002203void Verifier::visitTruncInst(TruncInst &I) {
2204 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002205 Type *SrcTy = I.getOperand(0)->getType();
2206 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002207
2208 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002209 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2210 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002211
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002212 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2213 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2214 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2215 "trunc source and destination must both be a vector or neither", &I);
2216 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002217
2218 visitInstruction(I);
2219}
2220
2221void Verifier::visitZExtInst(ZExtInst &I) {
2222 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002223 Type *SrcTy = I.getOperand(0)->getType();
2224 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002225
2226 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002227 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2228 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2229 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2230 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002231 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2232 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002233
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002234 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002235
2236 visitInstruction(I);
2237}
2238
2239void Verifier::visitSExtInst(SExtInst &I) {
2240 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002241 Type *SrcTy = I.getOperand(0)->getType();
2242 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002243
2244 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002245 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2246 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002247
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002248 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2249 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2250 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2251 "sext source and destination must both be a vector or neither", &I);
2252 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002253
2254 visitInstruction(I);
2255}
2256
2257void Verifier::visitFPTruncInst(FPTruncInst &I) {
2258 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002259 Type *SrcTy = I.getOperand(0)->getType();
2260 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002261 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002262 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2263 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002264
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002265 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2266 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2267 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2268 "fptrunc source and destination must both be a vector or neither", &I);
2269 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002270
2271 visitInstruction(I);
2272}
2273
2274void Verifier::visitFPExtInst(FPExtInst &I) {
2275 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002276 Type *SrcTy = I.getOperand(0)->getType();
2277 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002278
2279 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002280 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2281 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002282
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002283 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2284 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2285 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2286 "fpext source and destination must both be a vector or neither", &I);
2287 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002288
2289 visitInstruction(I);
2290}
2291
2292void Verifier::visitUIToFPInst(UIToFPInst &I) {
2293 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002294 Type *SrcTy = I.getOperand(0)->getType();
2295 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002296
Duncan Sands19d0b472010-02-16 11:11:14 +00002297 bool SrcVec = SrcTy->isVectorTy();
2298 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002299
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002300 Assert(SrcVec == DstVec,
2301 "UIToFP source and dest must both be vector or scalar", &I);
2302 Assert(SrcTy->isIntOrIntVectorTy(),
2303 "UIToFP source must be integer or integer vector", &I);
2304 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2305 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002306
2307 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002308 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2309 cast<VectorType>(DestTy)->getNumElements(),
2310 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002311
2312 visitInstruction(I);
2313}
2314
2315void Verifier::visitSIToFPInst(SIToFPInst &I) {
2316 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002317 Type *SrcTy = I.getOperand(0)->getType();
2318 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002319
Duncan Sands19d0b472010-02-16 11:11:14 +00002320 bool SrcVec = SrcTy->isVectorTy();
2321 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002322
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002323 Assert(SrcVec == DstVec,
2324 "SIToFP source and dest must both be vector or scalar", &I);
2325 Assert(SrcTy->isIntOrIntVectorTy(),
2326 "SIToFP source must be integer or integer vector", &I);
2327 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2328 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002329
2330 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002331 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2332 cast<VectorType>(DestTy)->getNumElements(),
2333 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002334
2335 visitInstruction(I);
2336}
2337
2338void Verifier::visitFPToUIInst(FPToUIInst &I) {
2339 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002340 Type *SrcTy = I.getOperand(0)->getType();
2341 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002342
Duncan Sands19d0b472010-02-16 11:11:14 +00002343 bool SrcVec = SrcTy->isVectorTy();
2344 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002345
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002346 Assert(SrcVec == DstVec,
2347 "FPToUI source and dest must both be vector or scalar", &I);
2348 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2349 &I);
2350 Assert(DestTy->isIntOrIntVectorTy(),
2351 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002352
2353 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002354 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2355 cast<VectorType>(DestTy)->getNumElements(),
2356 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002357
2358 visitInstruction(I);
2359}
2360
2361void Verifier::visitFPToSIInst(FPToSIInst &I) {
2362 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002363 Type *SrcTy = I.getOperand(0)->getType();
2364 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002365
Duncan Sands19d0b472010-02-16 11:11:14 +00002366 bool SrcVec = SrcTy->isVectorTy();
2367 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002368
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002369 Assert(SrcVec == DstVec,
2370 "FPToSI source and dest must both be vector or scalar", &I);
2371 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2372 &I);
2373 Assert(DestTy->isIntOrIntVectorTy(),
2374 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002375
2376 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002377 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2378 cast<VectorType>(DestTy)->getNumElements(),
2379 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002380
2381 visitInstruction(I);
2382}
2383
2384void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2385 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002386 Type *SrcTy = I.getOperand(0)->getType();
2387 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002388
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002389 Assert(SrcTy->getScalarType()->isPointerTy(),
2390 "PtrToInt source must be pointer", &I);
2391 Assert(DestTy->getScalarType()->isIntegerTy(),
2392 "PtrToInt result must be integral", &I);
2393 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2394 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002395
2396 if (SrcTy->isVectorTy()) {
2397 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2398 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002399 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2400 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002401 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002402
2403 visitInstruction(I);
2404}
2405
2406void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2407 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002408 Type *SrcTy = I.getOperand(0)->getType();
2409 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002410
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002411 Assert(SrcTy->getScalarType()->isIntegerTy(),
2412 "IntToPtr source must be an integral", &I);
2413 Assert(DestTy->getScalarType()->isPointerTy(),
2414 "IntToPtr result must be a pointer", &I);
2415 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2416 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002417 if (SrcTy->isVectorTy()) {
2418 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2419 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002420 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2421 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002422 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002423 visitInstruction(I);
2424}
2425
2426void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002427 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002428 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2429 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002430 visitInstruction(I);
2431}
2432
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002433void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2434 Type *SrcTy = I.getOperand(0)->getType();
2435 Type *DestTy = I.getType();
2436
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002437 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2438 &I);
2439 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2440 &I);
2441 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2442 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002443 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002444 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2445 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002446 visitInstruction(I);
2447}
2448
Misha Brukmanc566ca362004-03-02 00:22:19 +00002449/// visitPHINode - Ensure that a PHI node is well formed.
2450///
Chris Lattner069a7952002-06-25 15:56:27 +00002451void Verifier::visitPHINode(PHINode &PN) {
2452 // Ensure that the PHI nodes are all grouped together at the top of the block.
2453 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002454 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002455 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002456 Assert(&PN == &PN.getParent()->front() ||
2457 isa<PHINode>(--BasicBlock::iterator(&PN)),
2458 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002459
David Majnemerb611e3f2015-08-14 05:09:07 +00002460 // Check that a PHI doesn't yield a Token.
2461 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2462
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002463 // Check that all of the values of the PHI node have the same type as the
2464 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002465 for (Value *IncValue : PN.incoming_values()) {
2466 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002467 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002468 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002469
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002470 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002471
2472 visitInstruction(PN);
2473}
2474
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002475void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002476 Instruction *I = CS.getInstruction();
2477
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002478 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2479 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002480 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002481
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002482 Assert(FPTy->getElementType()->isFunctionTy(),
2483 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002484
2485 Assert(FPTy->getElementType() == CS.getFunctionType(),
2486 "Called function is not the same type as the call!", I);
2487
2488 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002489
2490 // Verify that the correct number of arguments are being passed
2491 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002492 Assert(CS.arg_size() >= FTy->getNumParams(),
2493 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002494 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002495 Assert(CS.arg_size() == FTy->getNumParams(),
2496 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002497
Chris Lattner609de002010-05-10 20:58:42 +00002498 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002499 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002500 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2501 "Call parameter type does not match function signature!",
2502 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002503
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002504 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002505
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002506 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002507 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002508
Duncan Sands8c582282007-12-21 19:19:01 +00002509 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002510 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002511
David Majnemer91db08b2014-04-30 17:22:00 +00002512 // Conservatively check the inalloca argument.
2513 // We have a bug if we can find that there is an underlying alloca without
2514 // inalloca.
2515 if (CS.hasInAllocaArgument()) {
2516 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2517 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002518 Assert(AI->isUsedWithInAlloca(),
2519 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002520 }
2521
Manman Ren9bfd0d02016-04-01 21:41:15 +00002522 // For each argument of the callsite, if it has the swifterror argument,
2523 // make sure the underlying alloca has swifterror as well.
2524 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2525 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2526 Value *SwiftErrorArg = CS.getArgument(i);
2527 auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets());
2528 Assert(AI, "swifterror argument should come from alloca", AI, I);
2529 if (AI)
2530 Assert(AI->isSwiftError(),
2531 "swifterror argument for call has mismatched alloca", AI, I);
2532 }
2533
Stephen Linb8bd2322013-04-20 05:14:40 +00002534 if (FTy->isVarArg()) {
2535 // FIXME? is 'nest' even legal here?
2536 bool SawNest = false;
2537 bool SawReturned = false;
2538
2539 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2540 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2541 SawNest = true;
2542 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2543 SawReturned = true;
2544 }
2545
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002546 // Check attributes on the varargs part.
2547 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002548 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002549 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002550
Stephen Linb8bd2322013-04-20 05:14:40 +00002551 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002552 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002553 SawNest = true;
2554 }
2555
2556 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002557 Assert(!SawReturned, "More than one parameter has attribute returned!",
2558 I);
2559 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2560 "Incompatible argument and return types for 'returned' "
2561 "attribute",
2562 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002563 SawReturned = true;
2564 }
Duncan Sands0009c442008-01-12 16:42:01 +00002565
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002566 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2567 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002568
2569 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002570 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002571 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002572 }
Duncan Sands8c582282007-12-21 19:19:01 +00002573
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002574 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002575 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002576 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002577 for (Type *ParamTy : FTy->params()) {
2578 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002579 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002580 Assert(!ParamTy->isTokenTy(),
2581 "Function has token parameter but isn't an intrinsic", I);
2582 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002583 }
2584
David Majnemerb611e3f2015-08-14 05:09:07 +00002585 // Verify that indirect calls don't return tokens.
2586 if (CS.getCalledFunction() == nullptr)
2587 Assert(!FTy->getReturnType()->isTokenTy(),
2588 "Return type cannot be token for indirect call!");
2589
Philip Reamesa3c6f002015-06-26 21:39:44 +00002590 if (Function *F = CS.getCalledFunction())
2591 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002592 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002593
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002594 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2595 // at most one "gc-transition" operand bundle.
2596 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2597 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002598 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002599 OperandBundleUse BU = CS.getOperandBundleAt(i);
2600 uint32_t Tag = BU.getTagID();
2601 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002602 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2603 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002604 } else if (Tag == LLVMContext::OB_gc_transition) {
2605 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2606 I);
2607 FoundGCTransitionBundle = true;
2608 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002609 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2610 FoundFuncletBundle = true;
2611 Assert(BU.Inputs.size() == 1,
2612 "Expected exactly one funclet bundle operand", I);
2613 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2614 "Funclet bundle operands should correspond to a FuncletPadInst",
2615 I);
2616 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002617 }
2618
Duncan Sands8c582282007-12-21 19:19:01 +00002619 visitInstruction(*I);
2620}
2621
Reid Kleckner5772b772014-04-24 20:14:34 +00002622/// Two types are "congruent" if they are identical, or if they are both pointer
2623/// types with different pointee types and the same address space.
2624static bool isTypeCongruent(Type *L, Type *R) {
2625 if (L == R)
2626 return true;
2627 PointerType *PL = dyn_cast<PointerType>(L);
2628 PointerType *PR = dyn_cast<PointerType>(R);
2629 if (!PL || !PR)
2630 return false;
2631 return PL->getAddressSpace() == PR->getAddressSpace();
2632}
2633
Reid Klecknerd20c9702014-05-15 23:58:57 +00002634static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2635 static const Attribute::AttrKind ABIAttrs[] = {
2636 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002637 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2638 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002639 AttrBuilder Copy;
2640 for (auto AK : ABIAttrs) {
2641 if (Attrs.hasAttribute(I + 1, AK))
2642 Copy.addAttribute(AK);
2643 }
2644 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2645 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2646 return Copy;
2647}
2648
Reid Kleckner5772b772014-04-24 20:14:34 +00002649void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002650 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002651
2652 // - The caller and callee prototypes must match. Pointer types of
2653 // parameters or return types may differ in pointee type, but not
2654 // address space.
2655 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002656 FunctionType *CallerTy = F->getFunctionType();
2657 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002658 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2659 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2660 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2661 "cannot guarantee tail call due to mismatched varargs", &CI);
2662 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2663 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002664 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002665 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002666 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2667 "cannot guarantee tail call due to mismatched parameter types", &CI);
2668 }
2669
2670 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002671 Assert(F->getCallingConv() == CI.getCallingConv(),
2672 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002673
2674 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2675 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002676 AttributeSet CallerAttrs = F->getAttributes();
2677 AttributeSet CalleeAttrs = CI.getAttributes();
2678 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002679 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2680 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002681 Assert(CallerABIAttrs == CalleeABIAttrs,
2682 "cannot guarantee tail call due to mismatched ABI impacting "
2683 "function attributes",
2684 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002685 }
2686
2687 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2688 // or a pointer bitcast followed by a ret instruction.
2689 // - The ret instruction must return the (possibly bitcasted) value
2690 // produced by the call or void.
2691 Value *RetVal = &CI;
2692 Instruction *Next = CI.getNextNode();
2693
2694 // Handle the optional bitcast.
2695 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002696 Assert(BI->getOperand(0) == RetVal,
2697 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002698 RetVal = BI;
2699 Next = BI->getNextNode();
2700 }
2701
2702 // Check the return.
2703 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002704 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2705 &CI);
2706 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2707 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002708}
2709
Duncan Sands8c582282007-12-21 19:19:01 +00002710void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002711 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002712
Reid Kleckner5772b772014-04-24 20:14:34 +00002713 if (CI.isMustTailCall())
2714 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002715}
2716
2717void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002718 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002719
David Majnemer654e1302015-07-31 17:58:14 +00002720 // Verify that the first non-PHI instruction of the unwind destination is an
2721 // exception handling instruction.
2722 Assert(
2723 II.getUnwindDest()->isEHPad(),
2724 "The unwind destination does not have an exception handling instruction!",
2725 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002726
Dan Gohman9c6e1882010-08-02 23:09:14 +00002727 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002728}
Chris Lattner0e851da2002-04-18 20:37:37 +00002729
Misha Brukmanc566ca362004-03-02 00:22:19 +00002730/// visitBinaryOperator - Check that both arguments to the binary operator are
2731/// of the same type!
2732///
Chris Lattner069a7952002-06-25 15:56:27 +00002733void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002734 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2735 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002736
Reid Spencer2341c222007-02-02 02:16:23 +00002737 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002738 // Check that integer arithmetic operators are only used with
2739 // integral operands.
2740 case Instruction::Add:
2741 case Instruction::Sub:
2742 case Instruction::Mul:
2743 case Instruction::SDiv:
2744 case Instruction::UDiv:
2745 case Instruction::SRem:
2746 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002747 Assert(B.getType()->isIntOrIntVectorTy(),
2748 "Integer arithmetic operators only work with integral types!", &B);
2749 Assert(B.getType() == B.getOperand(0)->getType(),
2750 "Integer arithmetic operators must have same type "
2751 "for operands and result!",
2752 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002753 break;
2754 // Check that floating-point arithmetic operators are only used with
2755 // floating-point operands.
2756 case Instruction::FAdd:
2757 case Instruction::FSub:
2758 case Instruction::FMul:
2759 case Instruction::FDiv:
2760 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002761 Assert(B.getType()->isFPOrFPVectorTy(),
2762 "Floating-point arithmetic operators only work with "
2763 "floating-point types!",
2764 &B);
2765 Assert(B.getType() == B.getOperand(0)->getType(),
2766 "Floating-point arithmetic operators must have same type "
2767 "for operands and result!",
2768 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002769 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002770 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002771 case Instruction::And:
2772 case Instruction::Or:
2773 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002774 Assert(B.getType()->isIntOrIntVectorTy(),
2775 "Logical operators only work with integral types!", &B);
2776 Assert(B.getType() == B.getOperand(0)->getType(),
2777 "Logical operators must have same type for operands and result!",
2778 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002779 break;
2780 case Instruction::Shl:
2781 case Instruction::LShr:
2782 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002783 Assert(B.getType()->isIntOrIntVectorTy(),
2784 "Shifts only work with integral types!", &B);
2785 Assert(B.getType() == B.getOperand(0)->getType(),
2786 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002787 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002788 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002789 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002790 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002791
Chris Lattner0e851da2002-04-18 20:37:37 +00002792 visitInstruction(B);
2793}
2794
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002795void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002796 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002797 Type *Op0Ty = IC.getOperand(0)->getType();
2798 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002799 Assert(Op0Ty == Op1Ty,
2800 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002801 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002802 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2803 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002804 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002805 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2806 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2807 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002808
Reid Spencerd9436b62006-11-20 01:22:35 +00002809 visitInstruction(IC);
2810}
2811
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002812void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002813 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002814 Type *Op0Ty = FC.getOperand(0)->getType();
2815 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002816 Assert(Op0Ty == Op1Ty,
2817 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002818 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002819 Assert(Op0Ty->isFPOrFPVectorTy(),
2820 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002821 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002822 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2823 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2824 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002825
Reid Spencerd9436b62006-11-20 01:22:35 +00002826 visitInstruction(FC);
2827}
2828
Robert Bocchino23004482006-01-10 19:05:34 +00002829void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002830 Assert(
2831 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2832 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002833 visitInstruction(EI);
2834}
2835
Robert Bocchinoca27f032006-01-17 20:07:22 +00002836void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002837 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2838 IE.getOperand(2)),
2839 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002840 visitInstruction(IE);
2841}
2842
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002843void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002844 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2845 SV.getOperand(2)),
2846 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002847 visitInstruction(SV);
2848}
2849
Chris Lattner069a7952002-06-25 15:56:27 +00002850void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002851 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002852
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002853 Assert(isa<PointerType>(TargetTy),
2854 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002855 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002856 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002857 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002858 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002859 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002860
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002861 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002862 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002863 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002864
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002865 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002866 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002867 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2868 if (GEP.getPointerOperandType()->isVectorTy())
2869 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2870 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002871 for (Value *Idx : Idxs) {
2872 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002873 if (IndexTy->isVectorTy()) {
2874 unsigned IndexWidth = IndexTy->getVectorNumElements();
2875 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2876 }
2877 Assert(IndexTy->getScalarType()->isIntegerTy(),
2878 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002879 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002880 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002881 visitInstruction(GEP);
2882}
2883
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002884static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2885 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2886}
2887
Philip Reamesbf9676f2014-10-20 23:52:07 +00002888void Verifier::visitRangeMetadata(Instruction& I,
2889 MDNode* Range, Type* Ty) {
2890 assert(Range &&
2891 Range == I.getMetadata(LLVMContext::MD_range) &&
2892 "precondition violation");
2893
2894 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002895 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002896 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002897 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2898
Philip Reamesbf9676f2014-10-20 23:52:07 +00002899 ConstantRange LastRange(1); // Dummy initial value
2900 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002901 ConstantInt *Low =
2902 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002903 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002904 ConstantInt *High =
2905 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002906 Assert(High, "The upper limit must be an integer!", High);
2907 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2908 "Range types must match instruction type!", &I);
2909
Philip Reamesbf9676f2014-10-20 23:52:07 +00002910 APInt HighV = High->getValue();
2911 APInt LowV = Low->getValue();
2912 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002913 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2914 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002915 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002916 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2917 "Intervals are overlapping", Range);
2918 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2919 Range);
2920 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2921 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002922 }
2923 LastRange = ConstantRange(LowV, HighV);
2924 }
2925 if (NumRanges > 2) {
2926 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002927 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002928 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002929 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002930 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002931 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2932 "Intervals are overlapping", Range);
2933 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2934 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002935 }
2936}
2937
JF Bastiend1fb5852015-12-17 22:09:19 +00002938void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2939 const Instruction *I) {
2940 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2941 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2942 Assert(!(Size & (Size - 1)),
2943 "atomic memory access' operand must have a power-of-two size", Ty, I);
2944}
2945
Chris Lattner069a7952002-06-25 15:56:27 +00002946void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002947 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002948 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002949 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002950 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2951 "huge alignment values are unsupported", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002952 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00002953 Assert(LI.getOrdering() != AtomicOrdering::Release &&
2954 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002955 "Load cannot have Release ordering", &LI);
2956 Assert(LI.getAlignment() != 0,
2957 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002958 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2959 ElTy->isFloatingPointTy(),
2960 "atomic load operand must have integer, pointer, or floating point "
2961 "type!",
2962 ElTy, &LI);
2963 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002964 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002965 Assert(LI.getSynchScope() == CrossThread,
2966 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002967 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002968
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002969 visitInstruction(LI);
2970}
2971
Chris Lattner069a7952002-06-25 15:56:27 +00002972void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002973 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002974 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002975 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002976 Assert(ElTy == SI.getOperand(0)->getType(),
2977 "Stored value type does not match pointer operand type!", &SI, ElTy);
2978 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2979 "huge alignment values are unsupported", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002980 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00002981 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
2982 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002983 "Store cannot have Acquire ordering", &SI);
2984 Assert(SI.getAlignment() != 0,
2985 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002986 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2987 ElTy->isFloatingPointTy(),
2988 "atomic store operand must have integer, pointer, or floating point "
2989 "type!",
2990 ElTy, &SI);
2991 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002992 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002993 Assert(SI.getSynchScope() == CrossThread,
2994 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002995 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002996 visitInstruction(SI);
2997}
2998
Manman Ren9bfd0d02016-04-01 21:41:15 +00002999/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3000void Verifier::verifySwiftErrorCallSite(CallSite CS,
3001 const Value *SwiftErrorVal) {
3002 unsigned Idx = 0;
3003 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3004 I != E; ++I, ++Idx) {
3005 if (*I == SwiftErrorVal) {
3006 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3007 "swifterror value when used in a callsite should be marked "
3008 "with swifterror attribute",
3009 SwiftErrorVal, CS);
3010 }
3011 }
3012}
3013
3014void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3015 // Check that swifterror value is only used by loads, stores, or as
3016 // a swifterror argument.
3017 for (const User *U : SwiftErrorVal->users()) {
3018 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3019 isa<InvokeInst>(U),
3020 "swifterror value can only be loaded and stored from, or "
3021 "as a swifterror argument!",
3022 SwiftErrorVal, U);
3023 // If it is used by a store, check it is the second operand.
3024 if (auto StoreI = dyn_cast<StoreInst>(U))
3025 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3026 "swifterror value should be the second operand when used "
3027 "by stores", SwiftErrorVal, U);
3028 if (auto CallI = dyn_cast<CallInst>(U))
3029 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3030 if (auto II = dyn_cast<InvokeInst>(U))
3031 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3032 }
3033}
3034
Victor Hernandez8acf2952009-10-23 21:09:37 +00003035void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003036 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003037 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003038 Assert(PTy->getAddressSpace() == 0,
3039 "Allocation instruction pointer not in the generic address space!",
3040 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003041 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003042 "Cannot allocate unsized type", &AI);
3043 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3044 "Alloca array size must have integer type", &AI);
3045 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3046 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003047
Manman Ren9bfd0d02016-04-01 21:41:15 +00003048 if (AI.isSwiftError()) {
3049 verifySwiftErrorValue(&AI);
3050 }
3051
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003052 visitInstruction(AI);
3053}
3054
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003055void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003056
3057 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003058 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003059 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003060 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003061 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003062 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003063 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003064 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003065 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003066 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3067 "cmpxchg instructions failure argument shall be no stronger than the "
3068 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003069 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003070 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3071 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003072 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003073
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003074 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003075 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003076 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003077 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3078 "cmpxchg operand must have integer or pointer type",
3079 ElTy, &CXI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003080 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003081 Assert(ElTy == CXI.getOperand(1)->getType(),
3082 "Expected value type does not match pointer operand type!", &CXI,
3083 ElTy);
3084 Assert(ElTy == CXI.getOperand(2)->getType(),
3085 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003086 visitInstruction(CXI);
3087}
3088
3089void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003090 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003091 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003092 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003093 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003094 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003095 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003096 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003097 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3098 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00003099 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003100 Assert(ElTy == RMWI.getOperand(1)->getType(),
3101 "Argument value type does not match pointer operand type!", &RMWI,
3102 ElTy);
3103 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3104 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3105 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003106 visitInstruction(RMWI);
3107}
3108
Eli Friedmanfee02c62011-07-25 23:16:38 +00003109void Verifier::visitFenceInst(FenceInst &FI) {
3110 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003111 Assert(Ordering == AtomicOrdering::Acquire ||
3112 Ordering == AtomicOrdering::Release ||
3113 Ordering == AtomicOrdering::AcquireRelease ||
3114 Ordering == AtomicOrdering::SequentiallyConsistent,
3115 "fence instructions may only have acquire, release, acq_rel, or "
3116 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003117 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003118 visitInstruction(FI);
3119}
3120
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003121void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003122 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3123 EVI.getIndices()) == EVI.getType(),
3124 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003125
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003126 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003127}
3128
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003129void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003130 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3131 IVI.getIndices()) ==
3132 IVI.getOperand(1)->getType(),
3133 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003134
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003135 visitInstruction(IVI);
3136}
Chris Lattner0e851da2002-04-18 20:37:37 +00003137
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003138static Value *getParentPad(Value *EHPad) {
3139 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3140 return FPI->getParentPad();
3141
3142 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3143}
3144
David Majnemer85a549d2015-08-11 02:48:30 +00003145void Verifier::visitEHPadPredecessors(Instruction &I) {
3146 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003147
David Majnemer85a549d2015-08-11 02:48:30 +00003148 BasicBlock *BB = I.getParent();
3149 Function *F = BB->getParent();
3150
3151 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3152
3153 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3154 // The landingpad instruction defines its parent as a landing pad block. The
3155 // landing pad block may be branched to only by the unwind edge of an
3156 // invoke.
3157 for (BasicBlock *PredBB : predecessors(BB)) {
3158 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3159 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3160 "Block containing LandingPadInst must be jumped to "
3161 "only by the unwind edge of an invoke.",
3162 LPI);
3163 }
3164 return;
3165 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003166 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3167 if (!pred_empty(BB))
3168 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3169 "Block containg CatchPadInst must be jumped to "
3170 "only by its catchswitch.",
3171 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003172 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3173 "Catchswitch cannot unwind to one of its catchpads",
3174 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003175 return;
3176 }
David Majnemer85a549d2015-08-11 02:48:30 +00003177
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003178 // Verify that each pred has a legal terminator with a legal to/from EH
3179 // pad relationship.
3180 Instruction *ToPad = &I;
3181 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003182 for (BasicBlock *PredBB : predecessors(BB)) {
3183 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003184 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003185 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003186 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003187 "EH pad must be jumped to via an unwind edge", ToPad, II);
3188 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3189 FromPad = Bundle->Inputs[0];
3190 else
3191 FromPad = ConstantTokenNone::get(II->getContext());
3192 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003193 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003194 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3195 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3196 FromPad = CSI;
3197 } else {
3198 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3199 }
3200
3201 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003202 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003203 for (;; FromPad = getParentPad(FromPad)) {
3204 Assert(FromPad != ToPad,
3205 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3206 if (FromPad == ToPadParent) {
3207 // This is a legal unwind edge.
3208 break;
3209 }
3210 Assert(!isa<ConstantTokenNone>(FromPad),
3211 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003212 Assert(Seen.insert(FromPad).second,
3213 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003214 }
David Majnemer85a549d2015-08-11 02:48:30 +00003215 }
3216}
3217
3218void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003219 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3220 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003221 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3222 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003223
David Majnemer85a549d2015-08-11 02:48:30 +00003224 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003225
David Majnemer654e1302015-07-31 17:58:14 +00003226 if (!LandingPadResultTy)
3227 LandingPadResultTy = LPI.getType();
3228 else
3229 Assert(LandingPadResultTy == LPI.getType(),
3230 "The landingpad instruction should have a consistent result type "
3231 "inside a function.",
3232 &LPI);
3233
David Majnemer7fddecc2015-06-17 20:52:32 +00003234 Function *F = LPI.getParent()->getParent();
3235 Assert(F->hasPersonalityFn(),
3236 "LandingPadInst needs to be in a function with a personality.", &LPI);
3237
Bill Wendlingfae14752011-08-12 20:24:12 +00003238 // The landingpad instruction must be the first non-PHI instruction in the
3239 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003240 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3241 "LandingPadInst not the first non-PHI instruction in the block.",
3242 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003243
Duncan Sands86de1a62011-09-27 16:43:19 +00003244 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003245 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003246 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003247 Assert(isa<PointerType>(Clause->getType()),
3248 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003249 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003250 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3251 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3252 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003253 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003254 }
3255
Bill Wendlingfae14752011-08-12 20:24:12 +00003256 visitInstruction(LPI);
3257}
3258
David Majnemer654e1302015-07-31 17:58:14 +00003259void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003260 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003261
David Majnemer654e1302015-07-31 17:58:14 +00003262 Function *F = BB->getParent();
3263 Assert(F->hasPersonalityFn(),
3264 "CatchPadInst needs to be in a function with a personality.", &CPI);
3265
David Majnemer8a1c45d2015-12-12 05:38:55 +00003266 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3267 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3268 CPI.getParentPad());
3269
David Majnemer654e1302015-07-31 17:58:14 +00003270 // The catchpad instruction must be the first non-PHI instruction in the
3271 // block.
3272 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003273 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003274
David Majnemerfe2f7f32016-02-29 22:56:36 +00003275 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003276 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003277}
3278
David Majnemer8a1c45d2015-12-12 05:38:55 +00003279void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3280 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3281 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3282 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003283
David Majnemer8a1c45d2015-12-12 05:38:55 +00003284 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003285}
3286
3287void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3288 BasicBlock *BB = CPI.getParent();
3289
David Majnemer654e1302015-07-31 17:58:14 +00003290 Function *F = BB->getParent();
3291 Assert(F->hasPersonalityFn(),
3292 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3293
3294 // The cleanuppad instruction must be the first non-PHI instruction in the
3295 // block.
3296 Assert(BB->getFirstNonPHI() == &CPI,
3297 "CleanupPadInst not the first non-PHI instruction in the block.",
3298 &CPI);
3299
David Majnemer8a1c45d2015-12-12 05:38:55 +00003300 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003301 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003302 "CleanupPadInst has an invalid parent.", &CPI);
3303
David Majnemerfe2f7f32016-02-29 22:56:36 +00003304 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003305 visitFuncletPadInst(CPI);
3306}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003307
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003308void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3309 User *FirstUser = nullptr;
3310 Value *FirstUnwindPad = nullptr;
3311 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003312 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003313
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003314 while (!Worklist.empty()) {
3315 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003316 Assert(Seen.insert(CurrentPad).second,
3317 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003318 Value *UnresolvedAncestorPad = nullptr;
3319 for (User *U : CurrentPad->users()) {
3320 BasicBlock *UnwindDest;
3321 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3322 UnwindDest = CRI->getUnwindDest();
3323 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3324 // We allow catchswitch unwind to caller to nest
3325 // within an outer pad that unwinds somewhere else,
3326 // because catchswitch doesn't have a nounwind variant.
3327 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3328 if (CSI->unwindsToCaller())
3329 continue;
3330 UnwindDest = CSI->getUnwindDest();
3331 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3332 UnwindDest = II->getUnwindDest();
3333 } else if (isa<CallInst>(U)) {
3334 // Calls which don't unwind may be found inside funclet
3335 // pads that unwind somewhere else. We don't *require*
3336 // such calls to be annotated nounwind.
3337 continue;
3338 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3339 // The unwind dest for a cleanup can only be found by
3340 // recursive search. Add it to the worklist, and we'll
3341 // search for its first use that determines where it unwinds.
3342 Worklist.push_back(CPI);
3343 continue;
3344 } else {
3345 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3346 continue;
3347 }
3348
3349 Value *UnwindPad;
3350 bool ExitsFPI;
3351 if (UnwindDest) {
3352 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003353 if (!cast<Instruction>(UnwindPad)->isEHPad())
3354 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003355 Value *UnwindParent = getParentPad(UnwindPad);
3356 // Ignore unwind edges that don't exit CurrentPad.
3357 if (UnwindParent == CurrentPad)
3358 continue;
3359 // Determine whether the original funclet pad is exited,
3360 // and if we are scanning nested pads determine how many
3361 // of them are exited so we can stop searching their
3362 // children.
3363 Value *ExitedPad = CurrentPad;
3364 ExitsFPI = false;
3365 do {
3366 if (ExitedPad == &FPI) {
3367 ExitsFPI = true;
3368 // Now we can resolve any ancestors of CurrentPad up to
3369 // FPI, but not including FPI since we need to make sure
3370 // to check all direct users of FPI for consistency.
3371 UnresolvedAncestorPad = &FPI;
3372 break;
3373 }
3374 Value *ExitedParent = getParentPad(ExitedPad);
3375 if (ExitedParent == UnwindParent) {
3376 // ExitedPad is the ancestor-most pad which this unwind
3377 // edge exits, so we can resolve up to it, meaning that
3378 // ExitedParent is the first ancestor still unresolved.
3379 UnresolvedAncestorPad = ExitedParent;
3380 break;
3381 }
3382 ExitedPad = ExitedParent;
3383 } while (!isa<ConstantTokenNone>(ExitedPad));
3384 } else {
3385 // Unwinding to caller exits all pads.
3386 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3387 ExitsFPI = true;
3388 UnresolvedAncestorPad = &FPI;
3389 }
3390
3391 if (ExitsFPI) {
3392 // This unwind edge exits FPI. Make sure it agrees with other
3393 // such edges.
3394 if (FirstUser) {
3395 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3396 "pad must have the same unwind "
3397 "dest",
3398 &FPI, U, FirstUser);
3399 } else {
3400 FirstUser = U;
3401 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003402 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3403 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3404 getParentPad(UnwindPad) == getParentPad(&FPI))
3405 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003406 }
3407 }
3408 // Make sure we visit all uses of FPI, but for nested pads stop as
3409 // soon as we know where they unwind to.
3410 if (CurrentPad != &FPI)
3411 break;
3412 }
3413 if (UnresolvedAncestorPad) {
3414 if (CurrentPad == UnresolvedAncestorPad) {
3415 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3416 // we've found an unwind edge that exits it, because we need to verify
3417 // all direct uses of FPI.
3418 assert(CurrentPad == &FPI);
3419 continue;
3420 }
3421 // Pop off the worklist any nested pads that we've found an unwind
3422 // destination for. The pads on the worklist are the uncles,
3423 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3424 // for all ancestors of CurrentPad up to but not including
3425 // UnresolvedAncestorPad.
3426 Value *ResolvedPad = CurrentPad;
3427 while (!Worklist.empty()) {
3428 Value *UnclePad = Worklist.back();
3429 Value *AncestorPad = getParentPad(UnclePad);
3430 // Walk ResolvedPad up the ancestor list until we either find the
3431 // uncle's parent or the last resolved ancestor.
3432 while (ResolvedPad != AncestorPad) {
3433 Value *ResolvedParent = getParentPad(ResolvedPad);
3434 if (ResolvedParent == UnresolvedAncestorPad) {
3435 break;
3436 }
3437 ResolvedPad = ResolvedParent;
3438 }
3439 // If the resolved ancestor search didn't find the uncle's parent,
3440 // then the uncle is not yet resolved.
3441 if (ResolvedPad != AncestorPad)
3442 break;
3443 // This uncle is resolved, so pop it from the worklist.
3444 Worklist.pop_back();
3445 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003446 }
3447 }
3448
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003449 if (FirstUnwindPad) {
3450 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3451 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3452 Value *SwitchUnwindPad;
3453 if (SwitchUnwindDest)
3454 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3455 else
3456 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3457 Assert(SwitchUnwindPad == FirstUnwindPad,
3458 "Unwind edges out of a catch must have the same unwind dest as "
3459 "the parent catchswitch",
3460 &FPI, FirstUser, CatchSwitch);
3461 }
3462 }
3463
3464 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003465}
3466
David Majnemer8a1c45d2015-12-12 05:38:55 +00003467void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003468 BasicBlock *BB = CatchSwitch.getParent();
3469
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003470 Function *F = BB->getParent();
3471 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003472 "CatchSwitchInst needs to be in a function with a personality.",
3473 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003474
David Majnemer8a1c45d2015-12-12 05:38:55 +00003475 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003476 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003477 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3478 "CatchSwitchInst not the first non-PHI instruction in the block.",
3479 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003480
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003481 auto *ParentPad = CatchSwitch.getParentPad();
3482 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3483 "CatchSwitchInst has an invalid parent.", ParentPad);
3484
David Majnemer8a1c45d2015-12-12 05:38:55 +00003485 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003486 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003487 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3488 "CatchSwitchInst must unwind to an EH block which is not a "
3489 "landingpad.",
3490 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003491
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003492 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3493 if (getParentPad(I) == ParentPad)
3494 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3495 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003496
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003497 Assert(CatchSwitch.getNumHandlers() != 0,
3498 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3499
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003500 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003501 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3502 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003503 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003504
David Majnemerfe2f7f32016-02-29 22:56:36 +00003505 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003506 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003507}
3508
David Majnemer654e1302015-07-31 17:58:14 +00003509void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003510 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3511 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3512 CRI.getOperand(0));
3513
David Majnemer654e1302015-07-31 17:58:14 +00003514 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3515 Instruction *I = UnwindDest->getFirstNonPHI();
3516 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3517 "CleanupReturnInst must unwind to an EH block which is not a "
3518 "landingpad.",
3519 &CRI);
3520 }
3521
3522 visitTerminatorInst(CRI);
3523}
3524
Rafael Espindola654320a2012-02-26 02:23:37 +00003525void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3526 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003527 // If the we have an invalid invoke, don't try to compute the dominance.
3528 // We already reject it in the invoke specific checks and the dominance
3529 // computation doesn't handle multiple edges.
3530 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3531 if (II->getNormalDest() == II->getUnwindDest())
3532 return;
3533 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003534
Michael Kruseff379b62016-03-26 23:32:57 +00003535 // Quick check whether the def has already been encountered in the same block.
3536 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3537 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003538 //
3539 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3540 // wrapping an SSA value, assert that we've already encountered it. See
3541 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003542 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3543 return;
3544
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003545 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003546 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003547 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003548}
3549
Artur Pilipenkocca80022015-10-09 17:41:29 +00003550void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3551 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3552 "apply only to pointer types", &I);
3553 Assert(isa<LoadInst>(I),
3554 "dereferenceable, dereferenceable_or_null apply only to load"
3555 " instructions, use attributes for calls or invokes", &I);
3556 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3557 "take one operand!", &I);
3558 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3559 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3560 "dereferenceable_or_null metadata value must be an i64!", &I);
3561}
3562
Misha Brukmanc566ca362004-03-02 00:22:19 +00003563/// verifyInstruction - Verify that an instruction is well formed.
3564///
Chris Lattner069a7952002-06-25 15:56:27 +00003565void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003566 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003567 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003568
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003569 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003570 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003571 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3572 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003573 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003574 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003575
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003576 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003577 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3578 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003579
Chris Lattner5f126b72004-03-29 00:29:36 +00003580 // Check that the return value of the instruction is either void or a legal
3581 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003582 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3583 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003584
Nick Lewycky93e06a52009-09-27 23:27:42 +00003585 // Check that the instruction doesn't produce metadata. Calls are already
3586 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003587 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3588 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003589
Chris Lattner0e851da2002-04-18 20:37:37 +00003590 // Check that all uses of the instruction, if they are instructions
3591 // themselves, actually have parent basic blocks. If the use is not an
3592 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003593 for (Use &U : I.uses()) {
3594 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003595 Assert(Used->getParent() != nullptr,
3596 "Instruction referencing"
3597 " instruction not embedded in a basic block!",
3598 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003599 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003600 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003601 return;
3602 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003603 }
3604
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003605 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003606 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003607
3608 // Check to make sure that only first-class-values are operands to
3609 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003610 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003611 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003612 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003613
Chris Lattner9ece94b2004-03-14 03:23:54 +00003614 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003615 // Check to make sure that the "address of" an intrinsic function is never
3616 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003617 Assert(
3618 !F->isIntrinsic() ||
3619 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3620 "Cannot take the address of an intrinsic!", &I);
3621 Assert(
3622 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003623 F->getIntrinsicID() == Intrinsic::donothing ||
3624 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003625 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3626 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Sanjoy Das999dc752016-02-29 22:04:25 +00003627 "Cannot invoke an intrinsic other than donothing, patchpoint or "
3628 "statepoint",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003629 &I);
3630 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003631 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003632 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003633 Assert(OpBB->getParent() == BB->getParent(),
3634 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003635 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003636 Assert(OpArg->getParent() == BB->getParent(),
3637 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003638 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003639 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003640 } else if (isa<Instruction>(I.getOperand(i))) {
3641 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003642 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003643 Assert((i + 1 == e && isa<CallInst>(I)) ||
3644 (i + 3 == e && isa<InvokeInst>(I)),
3645 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003646 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3647 if (CE->getType()->isPtrOrPtrVectorTy()) {
3648 // If we have a ConstantExpr pointer, we need to see if it came from an
3649 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003650 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003651 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003652 }
3653 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003654
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003655 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003656 Assert(I.getType()->isFPOrFPVectorTy(),
3657 "fpmath requires a floating point result!", &I);
3658 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003659 if (ConstantFP *CFP0 =
3660 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003661 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003662 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3663 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003664 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003665 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003666 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003667 }
3668
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003669 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003670 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3671 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003672 visitRangeMetadata(I, Range, I.getType());
3673 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003674
Philip Reames0ca58b32014-10-21 20:56:29 +00003675 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003676 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3677 &I);
3678 Assert(isa<LoadInst>(I),
3679 "nonnull applies only to load instructions, use attributes"
3680 " for calls or invokes",
3681 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003682 }
3683
Artur Pilipenkocca80022015-10-09 17:41:29 +00003684 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3685 visitDereferenceableMetadata(I, MD);
3686
3687 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3688 visitDereferenceableMetadata(I, MD);
3689
3690 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3691 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3692 &I);
3693 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3694 "use attributes for calls or invokes", &I);
3695 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3696 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3697 Assert(CI && CI->getType()->isIntegerTy(64),
3698 "align metadata value must be an i64!", &I);
3699 uint64_t Align = CI->getZExtValue();
3700 Assert(isPowerOf2_64(Align),
3701 "align metadata value must be a power of 2!", &I);
3702 Assert(Align <= Value::MaximumAlignment,
3703 "alignment is larger that implementation defined limit", &I);
3704 }
3705
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003706 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00003707 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003708 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003709 }
3710
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003711 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003712}
3713
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003714/// Verify that the specified type (which comes from an intrinsic argument or
3715/// return value) matches the type constraints specified by the .td file (e.g.
3716/// an "any integer" argument really is an integer).
Chris Lattner144b6192012-05-27 19:37:05 +00003717///
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003718/// This returns true on error but does not print a message.
3719bool Verifier::verifyIntrinsicType(Type *Ty,
Chris Lattner144b6192012-05-27 19:37:05 +00003720 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3721 SmallVectorImpl<Type*> &ArgTys) {
3722 using namespace Intrinsic;
3723
3724 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003725 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003726 IITDescriptor D = Infos.front();
3727 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003728
Chris Lattner144b6192012-05-27 19:37:05 +00003729 switch (D.Kind) {
3730 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003731 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003732 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003733 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003734 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003735 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003736 case IITDescriptor::Float: return !Ty->isFloatTy();
3737 case IITDescriptor::Double: return !Ty->isDoubleTy();
3738 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3739 case IITDescriptor::Vector: {
3740 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003741 return !VT || VT->getNumElements() != D.Vector_Width ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003742 verifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003743 }
3744 case IITDescriptor::Pointer: {
3745 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003746 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003747 verifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003748 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003749
Chris Lattner144b6192012-05-27 19:37:05 +00003750 case IITDescriptor::Struct: {
3751 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003752 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003753 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003754
Chris Lattner144b6192012-05-27 19:37:05 +00003755 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003756 if (verifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
Chris Lattner144b6192012-05-27 19:37:05 +00003757 return true;
3758 return false;
3759 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003760
Chris Lattner144b6192012-05-27 19:37:05 +00003761 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003762 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003763 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003764 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003765 return Ty != ArgTys[D.getArgumentNumber()];
3766
Chris Lattner144b6192012-05-27 19:37:05 +00003767 // Otherwise, if this is the first instance of an argument, record it and
3768 // verify the "Any" kind.
3769 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3770 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003771
Chris Lattner144b6192012-05-27 19:37:05 +00003772 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003773 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003774 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3775 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3776 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3777 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3778 }
3779 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003780
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003781 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003782 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003783 if (D.getArgumentNumber() >= ArgTys.size())
3784 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003785
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003786 Type *NewTy = ArgTys[D.getArgumentNumber()];
3787 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3788 NewTy = VectorType::getExtendedElementVectorType(VTy);
3789 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3790 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3791 else
3792 return true;
3793
3794 return Ty != NewTy;
3795 }
3796 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003797 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003798 if (D.getArgumentNumber() >= ArgTys.size())
3799 return true;
3800
3801 Type *NewTy = ArgTys[D.getArgumentNumber()];
3802 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3803 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3804 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3805 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3806 else
3807 return true;
3808
3809 return Ty != NewTy;
3810 }
Tim Northover4516de32014-03-29 07:04:54 +00003811 case IITDescriptor::HalfVecArgument:
3812 // This may only be used when referring to a previous vector argument.
3813 return D.getArgumentNumber() >= ArgTys.size() ||
3814 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3815 VectorType::getHalfElementsVectorType(
3816 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003817 case IITDescriptor::SameVecWidthArgument: {
3818 if (D.getArgumentNumber() >= ArgTys.size())
3819 return true;
3820 VectorType * ReferenceType =
3821 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3822 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3823 if (!ThisArgType || !ReferenceType ||
3824 (ReferenceType->getVectorNumElements() !=
3825 ThisArgType->getVectorNumElements()))
3826 return true;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003827 return verifyIntrinsicType(ThisArgType->getVectorElementType(),
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003828 Infos, ArgTys);
3829 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003830 case IITDescriptor::PtrToArgument: {
3831 if (D.getArgumentNumber() >= ArgTys.size())
3832 return true;
3833 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3834 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3835 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3836 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003837 case IITDescriptor::VecOfPtrsToElt: {
3838 if (D.getArgumentNumber() >= ArgTys.size())
3839 return true;
3840 VectorType * ReferenceType =
3841 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3842 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3843 if (!ThisArgVecTy || !ReferenceType ||
3844 (ReferenceType->getVectorNumElements() !=
3845 ThisArgVecTy->getVectorNumElements()))
3846 return true;
3847 PointerType *ThisArgEltTy =
3848 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3849 if (!ThisArgEltTy)
3850 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003851 return ThisArgEltTy->getElementType() !=
3852 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003853 }
Chris Lattner144b6192012-05-27 19:37:05 +00003854 }
3855 llvm_unreachable("unhandled");
3856}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003857
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003858/// Verify if the intrinsic has variable arguments. This method is intended to
3859/// be called after all the fixed arguments have been verified first.
Andrew Tricka2efd992013-10-31 17:18:11 +00003860///
3861/// This method returns true on error and does not print an error message.
3862bool
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003863Verifier::verifyIntrinsicIsVarArg(bool isVarArg,
Andrew Tricka2efd992013-10-31 17:18:11 +00003864 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3865 using namespace Intrinsic;
3866
3867 // If there are no descriptors left, then it can't be a vararg.
3868 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003869 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003870
3871 // There should be only one descriptor remaining at this point.
3872 if (Infos.size() != 1)
3873 return true;
3874
3875 // Check and verify the descriptor.
3876 IITDescriptor D = Infos.front();
3877 Infos = Infos.slice(1);
3878 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003879 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003880
3881 return true;
3882}
3883
Philip Reames007561a2015-06-26 22:21:52 +00003884/// Allow intrinsics to be verified in different ways.
3885void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003886 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003887 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3888 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003889
Chris Lattner144b6192012-05-27 19:37:05 +00003890 // Verify that the intrinsic prototype lines up with what the .td files
3891 // describe.
3892 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003893 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003894
Chris Lattner144b6192012-05-27 19:37:05 +00003895 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3896 getIntrinsicInfoTableEntries(ID, Table);
3897 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003898
Chris Lattner144b6192012-05-27 19:37:05 +00003899 SmallVector<Type *, 4> ArgTys;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003900 Assert(!verifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003901 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003902 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003903 Assert(!verifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003904 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003905
3906 // Verify if the intrinsic call matches the vararg property.
3907 if (IsVarArg)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003908 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003909 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003910 else
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003911 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003912 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003913
3914 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003915 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003916
3917 // Now that we have the intrinsic ID and the actual argument types (and we
3918 // know they are legal for the intrinsic!) get the intrinsic name through the
3919 // usual means. This allows us to verify the mangling of argument types into
3920 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003921 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003922 Assert(ExpectedName == IF->getName(),
3923 "Intrinsic name not mangled correctly for type arguments! "
3924 "Should be: " +
3925 ExpectedName,
3926 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003927
Chris Lattner588096e2009-12-28 09:07:21 +00003928 // If the intrinsic takes MDNode arguments, verify that they are either global
3929 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003930 for (Value *V : CS.args())
3931 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3932 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003933
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003934 switch (ID) {
3935 default:
3936 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003937 case Intrinsic::ctlz: // llvm.ctlz
3938 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003939 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003940 "is_zero_undef argument of bit counting intrinsics must be a "
3941 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003942 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003943 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003944 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003945 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3946 "invalid llvm.dbg.declare intrinsic call 1", CS);
3947 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003948 break;
3949 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003950 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003951 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003952 case Intrinsic::memcpy:
3953 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003954 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003955 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003956 Assert(AlignCI,
3957 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003958 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003959 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003960 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003961 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003962 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003963 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003964 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003965 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003966 }
Bill Wendling05604e02008-08-23 09:46:46 +00003967 case Intrinsic::gcroot:
3968 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003969 case Intrinsic::gcread:
3970 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003971 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003972 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3973 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3974 Assert(isa<Constant>(CS.getArgOperand(1)),
3975 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003976 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003977 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003978 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3979 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003980 CS);
Talin2e59f142010-09-30 20:23:47 +00003981 }
Chris Lattner25852062008-08-24 20:46:13 +00003982 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003983
Philip Reames9818dd72015-06-26 22:04:34 +00003984 Assert(CS.getParent()->getParent()->hasGC(),
3985 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003986 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003987 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003988 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003989 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003990 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003991 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003992 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003993 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3994 isa<ConstantInt>(CS.getArgOperand(2)) &&
3995 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3996 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3997 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003998 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003999 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004000 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4001 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004002 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004003 case Intrinsic::lifetime_start:
4004 case Intrinsic::lifetime_end:
4005 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004006 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004007 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004008 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004009 break;
4010 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004011 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4012 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004013 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004014
Reid Kleckner60381792015-07-07 22:25:32 +00004015 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004016 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004017 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004018 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004019 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004020 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004021 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004022 if (isa<ConstantPointerNull>(Arg))
4023 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004024 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004025 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004026 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004027 }
Philip Reames9818dd72015-06-26 22:04:34 +00004028 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004029 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004030 break;
4031 }
Reid Kleckner60381792015-07-07 22:25:32 +00004032 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004033 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004034 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004035 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004036 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004037 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004038 CS);
4039 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004040 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004041 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004042 auto &Entry = FrameEscapeInfo[Fn];
4043 Entry.second = unsigned(
4044 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004045 break;
4046 }
4047
Philip Reames1ffa9372015-01-30 23:28:05 +00004048 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004049 Assert(!CS.isInlineAsm(),
4050 "gc.statepoint support for inline assembly unimplemented", CS);
4051 Assert(CS.getParent()->getParent()->hasGC(),
4052 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004053
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004054 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004055 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004056 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004057 Assert(CS.getParent()->getParent()->hasGC(),
4058 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004059 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004060 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004061 const Function *StatepointFn =
4062 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004063 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4064 StatepointFn->getIntrinsicID() ==
4065 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004066 "gc.result operand #1 must be from a statepoint", CS,
4067 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004068
Philip Reamesb23713a2014-12-03 22:23:24 +00004069 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004070 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004071 auto *PT = cast<PointerType>(Target->getType());
4072 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004073 Assert(CS.getType() == TargetFuncType->getReturnType(),
4074 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004075 break;
4076 }
4077 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004078 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004079
Philip Reames3e2cf532016-01-07 03:32:11 +00004080 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4081 "gc.relocate must return a pointer or a vector of pointers", CS);
4082
Igor Laevsky9570ff92015-02-19 11:28:47 +00004083 // Check that this relocate is correctly tied to the statepoint
4084
4085 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004086 if (LandingPadInst *LandingPad =
4087 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004088
Sanjoy Das5665c992015-05-11 23:47:27 +00004089 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004090 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004091
4092 // Landingpad relocates should have only one predecessor with invoke
4093 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004094 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004095 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004096 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4097 InvokeBB);
4098 Assert(isStatepoint(InvokeBB->getTerminator()),
4099 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004100 }
4101 else {
4102 // In all other cases relocate should be tied to the statepoint directly.
4103 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004104 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004105 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004106 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004107 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004108 }
4109
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004110 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004111
Manuel Jacob83eefa62016-01-05 04:03:00 +00004112 ImmutableCallSite StatepointCS(
4113 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004114
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004115 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004116 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004117 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004118 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004119
Philip Reames9818dd72015-06-26 22:04:34 +00004120 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004121 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004122 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004123
4124 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4125 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4126 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004127 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004128 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004129 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004130 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004131
4132 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004133 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004134 Assert(StatepointCS.arg_size() > 0,
4135 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004136 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004137 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004138 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004139 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4140 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004141 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004142 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004143 "gc.statepoint: number of transition arguments must be "
4144 "a constant integer");
4145 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004146 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4147 ->getZExtValue();
4148 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004149 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004150 "gc.statepoint: number of deoptimization arguments must be "
4151 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004152 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004153 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4154 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004155 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004156 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004157 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4158 "gc.relocate: statepoint base index doesn't fall within the "
4159 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004160 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004161 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4162 "gc.relocate: statepoint derived index doesn't fall within the "
4163 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004164 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004165
Philip Reames3e2cf532016-01-07 03:32:11 +00004166 // Relocated value must be either a pointer type or vector-of-pointer type,
4167 // but gc_relocate does not need to return the same pointer type as the
4168 // relocated pointer. It can be casted to the correct type later if it's
4169 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004170 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004171 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004172 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004173
Philip Reames3e2cf532016-01-07 03:32:11 +00004174 auto ResultType = CS.getType();
4175 auto DerivedType = Relocate.getDerivedPtr()->getType();
4176 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004177 "gc.relocate: vector relocates to vector and pointer to pointer",
4178 CS);
4179 Assert(
4180 ResultType->getPointerAddressSpace() ==
4181 DerivedType->getPointerAddressSpace(),
4182 "gc.relocate: relocating a pointer shouldn't change its address space",
4183 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004184 break;
4185 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004186 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004187 case Intrinsic::eh_exceptionpointer: {
4188 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4189 "eh.exceptionpointer argument must be a catchpad", CS);
4190 break;
4191 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004192 case Intrinsic::masked_load: {
4193 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4194
4195 Value *Ptr = CS.getArgOperand(0);
4196 //Value *Alignment = CS.getArgOperand(1);
4197 Value *Mask = CS.getArgOperand(2);
4198 Value *PassThru = CS.getArgOperand(3);
4199 Assert(Mask->getType()->isVectorTy(),
4200 "masked_load: mask must be vector", CS);
4201
4202 // DataTy is the overloaded type
4203 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4204 Assert(DataTy == CS.getType(),
4205 "masked_load: return must match pointer type", CS);
4206 Assert(PassThru->getType() == DataTy,
4207 "masked_load: pass through and data type must match", CS);
4208 Assert(Mask->getType()->getVectorNumElements() ==
4209 DataTy->getVectorNumElements(),
4210 "masked_load: vector mask must be same length as data", CS);
4211 break;
4212 }
4213 case Intrinsic::masked_store: {
4214 Value *Val = CS.getArgOperand(0);
4215 Value *Ptr = CS.getArgOperand(1);
4216 //Value *Alignment = CS.getArgOperand(2);
4217 Value *Mask = CS.getArgOperand(3);
4218 Assert(Mask->getType()->isVectorTy(),
4219 "masked_store: mask must be vector", CS);
4220
4221 // DataTy is the overloaded type
4222 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4223 Assert(DataTy == Val->getType(),
4224 "masked_store: storee must match pointer type", CS);
4225 Assert(Mask->getType()->getVectorNumElements() ==
4226 DataTy->getVectorNumElements(),
4227 "masked_store: vector mask must be same length as data", CS);
4228 break;
4229 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004230
Sanjoy Das021de052016-03-31 00:18:46 +00004231 case Intrinsic::experimental_guard: {
4232 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4233 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4234 "experimental_guard must have exactly one "
4235 "\"deopt\" operand bundle");
4236 break;
4237 }
4238
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004239 case Intrinsic::experimental_deoptimize: {
4240 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4241 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4242 "experimental_deoptimize must have exactly one "
4243 "\"deopt\" operand bundle");
4244 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4245 "experimental_deoptimize return type must match caller return type");
4246
4247 if (CS.isCall()) {
4248 auto *DeoptCI = CS.getInstruction();
4249 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4250 Assert(RI,
4251 "calls to experimental_deoptimize must be followed by a return");
4252
4253 if (!CS.getType()->isVoidTy() && RI)
4254 Assert(RI->getReturnValue() == DeoptCI,
4255 "calls to experimental_deoptimize must be followed by a return "
4256 "of the value computed by experimental_deoptimize");
4257 }
4258
4259 break;
4260 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004261 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004262}
4263
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004264/// \brief Carefully grab the subprogram from a local scope.
4265///
4266/// This carefully grabs the subprogram from a local scope, avoiding the
4267/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004268static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004269 if (!LocalScope)
4270 return nullptr;
4271
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004272 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004273 return SP;
4274
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004275 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004276 return getSubprogram(LB->getRawScope());
4277
4278 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004279 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004280 return nullptr;
4281}
4282
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004283template <class DbgIntrinsicTy>
4284void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4285 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
4286 Assert(isa<ValueAsMetadata>(MD) ||
4287 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4288 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004289 Assert(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004290 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4291 DII.getRawVariable());
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004292 Assert(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004293 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4294 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004295
4296 // Ignore broken !dbg attachments; they're checked elsewhere.
4297 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004298 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004299 return;
4300
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004301 BasicBlock *BB = DII.getParent();
4302 Function *F = BB ? BB->getParent() : nullptr;
4303
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004304 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004305 DILocalVariable *Var = DII.getVariable();
4306 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004307 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4308 &DII, BB, F);
4309
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004310 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4311 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004312 if (!VarSP || !LocSP)
4313 return; // Broken scope chains are checked elsewhere.
4314
4315 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4316 " variable and !dbg attachment",
4317 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4318 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004319}
4320
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004321template <class MapTy>
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004322static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004323 // Be careful of broken types (checked elsewhere).
4324 const Metadata *RawType = V.getRawType();
4325 while (RawType) {
4326 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004327 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004328 if (uint64_t Size = T->getSizeInBits())
4329 return Size;
4330
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004331 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004332 // Look at the base type.
4333 RawType = DT->getRawBaseType();
4334 continue;
4335 }
4336
4337 if (auto *S = dyn_cast<MDString>(RawType)) {
4338 // Don't error on missing types (checked elsewhere).
4339 RawType = Map.lookup(S);
4340 continue;
4341 }
4342
4343 // Missing type or size.
4344 break;
4345 }
4346
4347 // Fail gracefully.
4348 return 0;
4349}
4350
4351template <class MapTy>
Keno Fischer253a7bd2016-01-15 02:12:38 +00004352void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
4353 const MapTy &TypeRefs) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004354 DILocalVariable *V;
4355 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004356 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004357 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4358 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004359 } else {
4360 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004361 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4362 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004363 }
4364
4365 // We don't know whether this intrinsic verified correctly.
4366 if (!V || !E || !E->isValid())
4367 return;
4368
Keno Fischer253a7bd2016-01-15 02:12:38 +00004369 // Nothing to do if this isn't a bit piece expression.
4370 if (!E->isBitPiece())
4371 return;
4372
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004373 // The frontend helps out GDB by emitting the members of local anonymous
4374 // unions as artificial local variables with shared storage. When SROA splits
4375 // the storage for artificial local variables that are smaller than the entire
4376 // union, the overhang piece will be outside of the allotted space for the
4377 // variable and this check fails.
4378 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4379 if (V->isArtificial())
4380 return;
4381
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004382 // If there's no size, the type is broken, but that should be checked
4383 // elsewhere.
4384 uint64_t VarSize = getVariableSize(*V, TypeRefs);
4385 if (!VarSize)
4386 return;
4387
Keno Fischer253a7bd2016-01-15 02:12:38 +00004388 unsigned PieceSize = E->getBitPieceSize();
4389 unsigned PieceOffset = E->getBitPieceOffset();
4390 Assert(PieceSize + PieceOffset <= VarSize,
4391 "piece is larger than or outside of variable", &I, V, E);
4392 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004393}
4394
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004395void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
4396 // This is in its own function so we get an error for each bad type ref (not
4397 // just the first).
4398 Assert(false, "unresolved type ref", S, N);
4399}
4400
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004401void Verifier::verifyCompileUnits() {
4402 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4403 SmallPtrSet<const Metadata *, 2> Listed;
4404 if (CUs)
4405 Listed.insert(CUs->op_begin(), CUs->op_end());
4406 Assert(
4407 std::all_of(CUVisited.begin(), CUVisited.end(),
4408 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
4409 "All DICompileUnits must be listed in llvm.dbg.cu");
4410 CUVisited.clear();
4411}
4412
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004413void Verifier::verifyTypeRefs() {
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004414 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4415 if (!CUs)
4416 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004417
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004418 // Visit all the compile units again to map the type references.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004419 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
Davide Italiano08f8f212016-04-08 00:01:32 +00004420 for (auto *MD : CUs->operands()) {
4421 auto *CU = dyn_cast<DICompileUnit>(MD);
4422 if (!CU)
4423 continue;
4424 auto *Array = CU->getRawRetainedTypes();
4425 if (!Array || !isa<MDTuple>(Array))
4426 continue;
Adrian Prantl75819ae2016-04-15 15:57:41 +00004427 for (DIScope *Op : CU->getRetainedTypes())
Davide Italiano08f8f212016-04-08 00:01:32 +00004428 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
4429 if (auto *S = T->getRawIdentifier()) {
4430 UnresolvedTypeRefs.erase(S);
4431 TypeRefs.insert(std::make_pair(S, T));
4432 }
4433 }
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004434
4435 // Verify debug info intrinsic bit piece expressions. This needs a second
4436 // pass through the intructions, since we haven't built TypeRefs yet when
4437 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
4438 // later/now would queue up some that could be later deleted.
4439 for (const Function &F : *M)
4440 for (const BasicBlock &BB : F)
4441 for (const Instruction &I : BB)
4442 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Keno Fischer253a7bd2016-01-15 02:12:38 +00004443 verifyBitPieceExpression(*DII, TypeRefs);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004444
4445 // Return early if all typerefs were resolved.
4446 if (UnresolvedTypeRefs.empty())
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004447 return;
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004448
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004449 // Sort the unresolved references by name so the output is deterministic.
4450 typedef std::pair<const MDString *, const MDNode *> TypeRef;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004451 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
4452 UnresolvedTypeRefs.end());
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004453 std::sort(Unresolved.begin(), Unresolved.end(),
4454 [](const TypeRef &LHS, const TypeRef &RHS) {
4455 return LHS.first->getString() < RHS.first->getString();
4456 });
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004457
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +00004458 // Visit the unresolved refs (printing out the errors).
4459 for (const TypeRef &TR : Unresolved)
4460 visitUnresolvedTypeRef(TR.first, TR.second);
Manman Ren74c61b92013-07-19 00:31:03 +00004461}
4462
Chris Lattner0e851da2002-04-18 20:37:37 +00004463//===----------------------------------------------------------------------===//
4464// Implement the public interfaces to this file...
4465//===----------------------------------------------------------------------===//
4466
Chandler Carruth043949d2014-01-19 02:22:18 +00004467bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004468 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00004469 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00004470
Chandler Carruth043949d2014-01-19 02:22:18 +00004471 raw_null_ostream NullStr;
4472 Verifier V(OS ? *OS : NullStr);
4473
4474 // Note that this function's return value is inverted from what you would
4475 // expect of a function called "verify".
4476 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004477}
4478
Chandler Carruth043949d2014-01-19 02:22:18 +00004479bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
4480 raw_null_ostream NullStr;
4481 Verifier V(OS ? *OS : NullStr);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004482
Chandler Carruth043949d2014-01-19 02:22:18 +00004483 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004484 for (const Function &F : M)
4485 if (!F.isDeclaration() && !F.isMaterializable())
4486 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004487
4488 // Note that this function's return value is inverted from what you would
4489 // expect of a function called "verify".
Duncan P. N. Exon Smith8b866d12015-03-20 00:48:23 +00004490 return !V.verify(M) || Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004491}
Chandler Carruth043949d2014-01-19 02:22:18 +00004492
4493namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004494struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004495 static char ID;
4496
4497 Verifier V;
4498 bool FatalErrors;
4499
Duncan P. N. Exon Smith6fb58c42015-03-15 00:46:57 +00004500 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004501 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004502 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004503 explicit VerifierLegacyPass(bool FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004504 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004505 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004506 }
4507
Craig Topperf398d7c2014-03-05 06:35:38 +00004508 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004509 if (!V.verify(F) && FatalErrors)
4510 report_fatal_error("Broken function found, compilation aborted!");
4511
4512 return false;
4513 }
4514
Craig Topperf398d7c2014-03-05 06:35:38 +00004515 bool doFinalization(Module &M) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004516 if (!V.verify(M) && FatalErrors)
4517 report_fatal_error("Broken module found, compilation aborted!");
4518
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004519 return false;
4520 }
4521
4522 void getAnalysisUsage(AnalysisUsage &AU) const override {
4523 AU.setPreservesAll();
4524 }
4525};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004526}
Chandler Carruth043949d2014-01-19 02:22:18 +00004527
Chandler Carruth4d356312014-01-20 11:34:08 +00004528char VerifierLegacyPass::ID = 0;
4529INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004530
4531FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004532 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004533}
4534
Chandler Carruthd174ce42015-01-05 02:47:05 +00004535PreservedAnalyses VerifierPass::run(Module &M) {
4536 if (verifyModule(M, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004537 report_fatal_error("Broken module found, compilation aborted!");
4538
4539 return PreservedAnalyses::all();
4540}
4541
Chandler Carruthd174ce42015-01-05 02:47:05 +00004542PreservedAnalyses VerifierPass::run(Function &F) {
4543 if (verifyFunction(F, &dbgs()) && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004544 report_fatal_error("Broken function found, compilation aborted!");
4545
4546 return PreservedAnalyses::all();
4547}