blob: fd78fa3bb514b77cb5375b0359c22cb90026c7a9 [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"
Adrian Prantle3656182016-05-09 19:57:29 +000062#include "llvm/IR/DiagnosticInfo.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000063#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000064#include "llvm/IR/InlineAsm.h"
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +000065#include "llvm/IR/InstIterator.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000066#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000067#include "llvm/IR/IntrinsicInst.h"
68#include "llvm/IR/LLVMContext.h"
69#include "llvm/IR/Metadata.h"
70#include "llvm/IR/Module.h"
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +000071#include "llvm/IR/ModuleSlotTracker.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000072#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000073#include "llvm/IR/Statepoint.h"
Chris Lattner8a923e72008-03-12 17:45:29 +000074#include "llvm/Pass.h"
Manman Ren74c61b92013-07-19 00:31:03 +000075#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000076#include "llvm/Support/Debug.h"
Torok Edwin6dd27302009-07-08 18:01:40 +000077#include "llvm/Support/ErrorHandling.h"
Chris Lattner24025262009-02-28 21:05:51 +000078#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000079#include <algorithm>
Jeff Cohene4535522006-03-31 07:22:05 +000080#include <cstdarg>
Chris Lattner189d19f2003-11-21 20:23:48 +000081using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000082
Duncan P. N. Exon Smith0633fd72015-03-17 17:28:41 +000083static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
Manman Ren74c61b92013-07-19 00:31:03 +000084
Dan Gohmand78c4002008-05-13 00:00:25 +000085namespace {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000086struct VerifierSupport {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +000087 raw_ostream *OS;
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +000088 const Module *M = nullptr;
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +000089 Optional<ModuleSlotTracker> MST;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000090
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +000091 /// Track the brokenness of the module while recursively visiting.
92 bool Broken = false;
Adrian Prantl541a9c52016-05-06 19:26:47 +000093 /// Broken debug info can be "recovered" from by stripping the debug info.
94 bool BrokenDebugInfo = false;
95 /// Whether to treat broken debug info as an error.
96 bool TreatBrokenDebugInfoAsError = true;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000097
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +000098 explicit VerifierSupport(raw_ostream *OS) : OS(OS) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +000099
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000100private:
Duncan P. N. Exon Smith52888a62015-10-08 23:49:46 +0000101 template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
102 Write(&*I);
103 }
104
Keno Fischera6c4ce42015-12-01 19:06:36 +0000105 void Write(const Module *M) {
106 if (!M)
107 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000108 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
Keno Fischera6c4ce42015-12-01 19:06:36 +0000109 }
110
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000111 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000112 if (!V)
113 return;
114 if (isa<Instruction>(V)) {
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000115 V->print(*OS, *MST);
116 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000117 } else {
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000118 V->printAsOperand(*OS, true, *MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000119 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000120 }
121 }
Philip Reames9818dd72015-06-26 22:04:34 +0000122 void Write(ImmutableCallSite CS) {
123 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000124 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000125
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000126 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000127 if (!MD)
128 return;
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000129 MD->print(*OS, *MST, M);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000130 *OS << '\n';
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000131 }
132
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000133 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
134 Write(MD.get());
135 }
136
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000137 void Write(const NamedMDNode *NMD) {
138 if (!NMD)
139 return;
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000140 NMD->print(*OS, *MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000141 *OS << '\n';
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000142 }
143
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000144 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000145 if (!T)
146 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000147 *OS << ' ' << *T;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000148 }
149
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000150 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000151 if (!C)
152 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000153 *OS << *C;
David Majnemerdad0a642014-06-27 18:19:56 +0000154 }
155
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000156 template <typename T> void Write(ArrayRef<T> Vs) {
157 for (const T &V : Vs)
158 Write(V);
159 }
160
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000161 template <typename T1, typename... Ts>
162 void WriteTs(const T1 &V1, const Ts &... Vs) {
163 Write(V1);
164 WriteTs(Vs...);
165 }
166
167 template <typename... Ts> void WriteTs() {}
168
169public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000170 /// \brief A check failed, so printout out the condition and the message.
171 ///
172 /// This provides a nice place to put a breakpoint if you want to see why
173 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000174 void CheckFailed(const Twine &Message) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000175 if (OS)
176 *OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000177 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000178 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000179
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000180 /// \brief A check failed (with values to print).
181 ///
182 /// This calls the Message-only version so that the above is easier to set a
183 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000184 template <typename T1, typename... Ts>
185 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
186 CheckFailed(Message);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000187 if (OS)
188 WriteTs(V1, Vs...);
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000189 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000190
191 /// A debug info check failed.
192 void DebugInfoCheckFailed(const Twine &Message) {
193 if (OS)
194 *OS << Message << '\n';
195 Broken |= TreatBrokenDebugInfoAsError;
196 BrokenDebugInfo = true;
197 }
198
199 /// A debug info check failed (with values to print).
200 template <typename T1, typename... Ts>
201 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
202 const Ts &... Vs) {
203 DebugInfoCheckFailed(Message);
204 if (OS)
205 WriteTs(V1, Vs...);
206 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000207};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000208
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000209class Verifier : public InstVisitor<Verifier>, VerifierSupport {
210 friend class InstVisitor<Verifier>;
211
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000212 LLVMContext *Context;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000213 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000214
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000215 /// \brief When verifying a basic block, keep track of all of the
216 /// instructions we have seen so far.
217 ///
218 /// This allows us to do efficient dominance checks for the case when an
219 /// instruction has an operand that is an instruction in the same block.
220 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000221
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000222 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000223 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000224
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000225 /// Track all DICompileUnits visited.
226 SmallPtrSet<const Metadata *, 2> CUVisited;
227
David Majnemer654e1302015-07-31 17:58:14 +0000228 /// \brief The result type for a landingpad.
229 Type *LandingPadResultTy;
230
Reid Kleckner60381792015-07-07 22:25:32 +0000231 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000232 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000233 bool SawFrameEscape;
234
Reid Kleckner60381792015-07-07 22:25:32 +0000235 /// Stores the count of how many objects were passed to llvm.localescape for a
236 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000237 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000238
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000239 // Maps catchswitches and cleanuppads that unwind to siblings to the
240 // terminators that indicate the unwind, used to detect cycles therein.
241 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
242
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000243 /// Cache of constants visited in search of ConstantExprs.
244 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
245
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000246 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
247 SmallVector<const Function *, 4> DeoptimizeDeclarations;
248
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000249 // Verify that this GlobalValue is only used in this module.
250 // This map is used to avoid visiting uses twice. We can arrive at a user
251 // twice, if they have multiple operands. In particular for very large
252 // constant expressions, we can arrive at a particular user many times.
253 SmallPtrSet<const Value *, 32> GlobalValueVisited;
254
JF Bastiend1fb5852015-12-17 22:09:19 +0000255 void checkAtomicMemAccessSize(const Module *M, Type *Ty,
256 const Instruction *I);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000257
258 void updateModule(const Module *NewM) {
259 if (M == NewM)
260 return;
261 MST.emplace(NewM);
262 M = NewM;
263 }
264
Chandler Carruth043949d2014-01-19 02:22:18 +0000265public:
Adrian Prantl541a9c52016-05-06 19:26:47 +0000266 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError)
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +0000267 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000268 SawFrameEscape(false) {
269 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
270 }
271
272 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
Chris Lattner0e851da2002-04-18 20:37:37 +0000273
Chandler Carruth043949d2014-01-19 02:22:18 +0000274 bool verify(const Function &F) {
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000275 updateModule(F.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +0000276 Context = &M->getContext();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000277
278 // First ensure the function is well-enough formed to compute dominance
Peter Collingbourne71bb7942016-06-06 22:32:52 +0000279 // information, and directly compute a dominance tree. We don't rely on the
280 // pass manager to provide this as it isolates us from a potentially
281 // out-of-date dominator tree and makes it significantly more complex to run
282 // this code outside of a pass manager.
283 // FIXME: It's really gross that we have to cast away constness here.
284 if (!F.empty())
285 DT.recalculate(const_cast<Function &>(F));
286
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000287 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000288 if (!BB.empty() && BB.back().isTerminator())
289 continue;
290
291 if (OS) {
292 *OS << "Basic Block in function '" << F.getName()
293 << "' does not have terminator!\n";
Duncan P. N. Exon Smith51e7adf2016-04-20 18:42:51 +0000294 BB.printAsOperand(*OS, true, *MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000295 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000296 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000297 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000298 }
Chandler Carruth76777602014-01-17 10:56:02 +0000299
Chandler Carruth043949d2014-01-19 02:22:18 +0000300 Broken = false;
301 // FIXME: We strip const here because the inst visitor strips const.
302 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000303 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000304 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000305 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000306 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000307 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000308
Chandler Carruth043949d2014-01-19 02:22:18 +0000309 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000310 }
311
Chandler Carruth043949d2014-01-19 02:22:18 +0000312 bool verify(const Module &M) {
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000313 updateModule(&M);
Chandler Carruth043949d2014-01-19 02:22:18 +0000314 Context = &M.getContext();
Chandler Carruth043949d2014-01-19 02:22:18 +0000315 Broken = false;
316
Peter Collingbournebb738172016-06-06 23:21:27 +0000317 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
318 for (const Function &F : M)
319 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
320 DeoptimizeDeclarations.push_back(&F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000321
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000322 // Now that we've visited every function, verify that we never asked to
323 // recover a frame index that wasn't escaped.
324 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000325 for (const GlobalVariable &GV : M.globals())
326 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000327
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000328 for (const GlobalAlias &GA : M.aliases())
329 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000330
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000331 for (const NamedMDNode &NMD : M.named_metadata())
332 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000333
David Majnemerdad0a642014-06-27 18:19:56 +0000334 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
335 visitComdat(SMEC.getValue());
336
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000337 visitModuleFlags(M);
338 visitModuleIdents(M);
339
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000340 verifyCompileUnits();
341
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000342 verifyDeoptimizeCallingConvs();
343
Chandler Carruth043949d2014-01-19 02:22:18 +0000344 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000345 }
Chris Lattner9713b842002-04-28 16:04:26 +0000346
Chandler Carruth043949d2014-01-19 02:22:18 +0000347private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000348 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000349 void visitGlobalValue(const GlobalValue &GV);
350 void visitGlobalVariable(const GlobalVariable &GV);
351 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000352 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000353 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000354 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000355 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000356 void visitMDNode(const MDNode &MD);
357 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
358 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000359 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000360 void visitModuleIdents(const Module &M);
361 void visitModuleFlags(const Module &M);
362 void visitModuleFlag(const MDNode *Op,
363 DenseMap<const MDString *, const MDNode *> &SeenIDs,
364 SmallVectorImpl<const MDNode *> &Requirements);
365 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000366 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000367 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000368 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000369
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000370 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000371#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
372#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000373 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000374 void visitDIVariable(const DIVariable &N);
375 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
376 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000377
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000378 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
379
Chandler Carruth043949d2014-01-19 02:22:18 +0000380 // InstVisitor overrides...
381 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000382 void visit(Instruction &I);
383
384 void visitTruncInst(TruncInst &I);
385 void visitZExtInst(ZExtInst &I);
386 void visitSExtInst(SExtInst &I);
387 void visitFPTruncInst(FPTruncInst &I);
388 void visitFPExtInst(FPExtInst &I);
389 void visitFPToUIInst(FPToUIInst &I);
390 void visitFPToSIInst(FPToSIInst &I);
391 void visitUIToFPInst(UIToFPInst &I);
392 void visitSIToFPInst(SIToFPInst &I);
393 void visitIntToPtrInst(IntToPtrInst &I);
394 void visitPtrToIntInst(PtrToIntInst &I);
395 void visitBitCastInst(BitCastInst &I);
396 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
397 void visitPHINode(PHINode &PN);
398 void visitBinaryOperator(BinaryOperator &B);
399 void visitICmpInst(ICmpInst &IC);
400 void visitFCmpInst(FCmpInst &FC);
401 void visitExtractElementInst(ExtractElementInst &EI);
402 void visitInsertElementInst(InsertElementInst &EI);
403 void visitShuffleVectorInst(ShuffleVectorInst &EI);
404 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
405 void visitCallInst(CallInst &CI);
406 void visitInvokeInst(InvokeInst &II);
407 void visitGetElementPtrInst(GetElementPtrInst &GEP);
408 void visitLoadInst(LoadInst &LI);
409 void visitStoreInst(StoreInst &SI);
410 void verifyDominatesUse(Instruction &I, unsigned i);
411 void visitInstruction(Instruction &I);
412 void visitTerminatorInst(TerminatorInst &I);
413 void visitBranchInst(BranchInst &BI);
414 void visitReturnInst(ReturnInst &RI);
415 void visitSwitchInst(SwitchInst &SI);
416 void visitIndirectBrInst(IndirectBrInst &BI);
417 void visitSelectInst(SelectInst &SI);
418 void visitUserOp1(Instruction &I);
419 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000420 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000421 template <class DbgIntrinsicTy>
422 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000423 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
424 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
425 void visitFenceInst(FenceInst &FI);
426 void visitAllocaInst(AllocaInst &AI);
427 void visitExtractValueInst(ExtractValueInst &EVI);
428 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000429 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000430 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000431 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000432 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000433 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000434 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000435 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000436 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000437 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000438
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000439 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000440 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
441 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000442 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000443 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000444 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000445 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
446 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000447 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000448 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000449 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000450 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000451 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000452 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000453
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000454 void visitConstantExprsRecursively(const Constant *EntryC);
455 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000456 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000457 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000458 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000459
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000460 void verifyBitPieceExpression(const DbgInfoIntrinsic &I);
461
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000462 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000463 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000464
465 /// Module-level verification that all @llvm.experimental.deoptimize
466 /// declarations share the same calling convention.
467 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000468};
Chris Lattner189d19f2003-11-21 20:23:48 +0000469} // End anonymous namespace
470
Adrian Prantl541a9c52016-05-06 19:26:47 +0000471/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000472#define Assert(C, ...) \
473 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000474
Adrian Prantl541a9c52016-05-06 19:26:47 +0000475/// We know that a debug info condition should be true, if not print
476/// an error message.
477#define AssertDI(C, ...) \
478 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (0)
479
480
Chris Lattnere5a22c02008-08-28 04:02:44 +0000481void Verifier::visit(Instruction &I) {
482 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000483 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000484 InstVisitor<Verifier>::visit(I);
485}
486
Keno Fischer60f82a22016-01-14 22:20:56 +0000487// Helper to recursively iterate over indirect users. By
488// returning false, the callback can ask to stop recursing
489// further.
490static void forEachUser(const Value *User,
491 SmallPtrSet<const Value *, 32> &Visited,
492 llvm::function_ref<bool(const Value *)> Callback) {
493 if (!Visited.insert(User).second)
494 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000495 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000496 if (Callback(TheNextUser))
497 forEachUser(TheNextUser, Visited, Callback);
498}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000499
Chandler Carruth043949d2014-01-19 02:22:18 +0000500void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000501 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000502 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000503
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000504 Assert(GV.getAlignment() <= Value::MaximumAlignment,
505 "huge alignment values are unsupported", &GV);
506 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
507 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000508
509 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000510 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000511 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000512 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000513 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000514
515 if (GV.isDeclarationForLinker())
516 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000517
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000518 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000519 if (const Instruction *I = dyn_cast<Instruction>(V)) {
520 if (!I->getParent() || !I->getParent()->getParent())
521 CheckFailed("Global is referenced by parentless instruction!", &GV,
522 M, I);
523 else if (I->getParent()->getParent()->getParent() != M)
524 CheckFailed("Global is referenced in a different module!", &GV,
525 M, I, I->getParent()->getParent(),
526 I->getParent()->getParent()->getParent());
527 return false;
528 } else if (const Function *F = dyn_cast<Function>(V)) {
529 if (F->getParent() != M)
530 CheckFailed("Global is used by function in a different module", &GV,
531 M, F, F->getParent());
532 return false;
533 }
534 return true;
535 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000536}
537
Chandler Carruth043949d2014-01-19 02:22:18 +0000538void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000539 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000540 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000541 "Global variable initializer type does not match global "
542 "variable type!",
543 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000544
Chris Lattner0aff0b22009-08-05 05:41:44 +0000545 // If the global has common linkage, it must have a zero initializer and
546 // cannot be constant.
547 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000548 Assert(GV.getInitializer()->isNullValue(),
549 "'common' global must have a zero initializer!", &GV);
550 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
551 &GV);
552 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000553 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000554 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000555
Nick Lewycky466d0c12011-04-08 07:30:21 +0000556 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
557 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000558 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
559 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000560 // Don't worry about emitting an error for it not being an array,
561 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000562 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000563 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
564 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000565 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000566 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000567 Assert(STy &&
568 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
569 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
570 STy->getTypeAtIndex(1) == FuncPtrTy,
571 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000572 if (STy->getNumElements() == 3) {
573 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000574 Assert(ETy->isPointerTy() &&
575 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
576 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000577 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000578 }
579 }
580
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000581 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000582 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000583 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
584 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000585 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000586 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
587 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000588 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000589 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000590 const Constant *Init = GV.getInitializer();
591 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000592 Assert(InitArray, "wrong initalizer for intrinsic global variable",
593 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000594 for (Value *Op : InitArray->operands()) {
595 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000596 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
597 isa<GlobalAlias>(V),
598 "invalid llvm.used member", V);
599 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000600 }
601 }
602 }
603 }
604
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000605 Assert(!GV.hasDLLImportStorageClass() ||
606 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
607 GV.hasAvailableExternallyLinkage(),
608 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000609
Matt Arsenault24b49c42013-07-31 17:49:08 +0000610 if (!GV.hasInitializer()) {
611 visitGlobalValue(GV);
612 return;
613 }
614
615 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000616 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000617
Chris Lattnere3400652004-12-15 20:23:49 +0000618 visitGlobalValue(GV);
619}
620
Rafael Espindola64c1e182014-06-03 02:41:57 +0000621void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
622 SmallPtrSet<const GlobalAlias*, 4> Visited;
623 Visited.insert(&GA);
624 visitAliaseeSubExpr(Visited, GA, C);
625}
626
Craig Topper71b7b682014-08-21 05:55:13 +0000627void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000628 const GlobalAlias &GA, const Constant &C) {
629 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000630 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
631 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000632
633 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000634 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000635
Sanjoy Das5ce32722016-04-08 00:48:30 +0000636 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000637 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000638 } else {
639 // Only continue verifying subexpressions of GlobalAliases.
640 // Do not recurse into global initializers.
641 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000642 }
643 }
644
645 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000646 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000647
648 for (const Use &U : C.operands()) {
649 Value *V = &*U;
650 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
651 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
652 else if (const auto *C2 = dyn_cast<Constant>(V))
653 visitAliaseeSubExpr(Visited, GA, *C2);
654 }
655}
656
Chandler Carruth043949d2014-01-19 02:22:18 +0000657void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000658 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
659 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
660 "weak_odr, or external linkage!",
661 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000662 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000663 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
664 Assert(GA.getType() == Aliasee->getType(),
665 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000666
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000667 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
668 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000669
Rafael Espindola64c1e182014-06-03 02:41:57 +0000670 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000671
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000672 visitGlobalValue(GA);
673}
674
Chandler Carruth043949d2014-01-19 02:22:18 +0000675void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000676 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000677 if (NMD.getName() == "llvm.dbg.cu") {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000678 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000679 }
680
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000681 if (!MD)
682 continue;
683
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000684 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000685 }
686}
687
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000688void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000689 // Only visit each node once. Metadata can be mutually recursive, so this
690 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000691 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000692 return;
693
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000694 switch (MD.getMetadataID()) {
695 default:
696 llvm_unreachable("Invalid MDNode subclass");
697 case Metadata::MDTupleKind:
698 break;
699#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
700 case Metadata::CLASS##Kind: \
701 visit##CLASS(cast<CLASS>(MD)); \
702 break;
703#include "llvm/IR/Metadata.def"
704 }
705
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000706 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000707 if (!Op)
708 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000709 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
710 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000711 if (auto *N = dyn_cast<MDNode>(Op)) {
712 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000713 continue;
714 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000715 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
716 visitValueAsMetadata(*V, nullptr);
717 continue;
718 }
Duncan Sands76d62172010-04-29 16:10:30 +0000719 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000720
721 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000722 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
723 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000724}
725
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000726void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000727 Assert(MD.getValue(), "Expected valid value", &MD);
728 Assert(!MD.getValue()->getType()->isMetadataTy(),
729 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000730
731 auto *L = dyn_cast<LocalAsMetadata>(&MD);
732 if (!L)
733 return;
734
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000735 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000736
737 // If this was an instruction, bb, or argument, verify that it is in the
738 // function that we expect.
739 Function *ActualF = nullptr;
740 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000741 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000742 ActualF = I->getParent()->getParent();
743 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
744 ActualF = BB->getParent();
745 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
746 ActualF = A->getParent();
747 assert(ActualF && "Unimplemented function local metadata case!");
748
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000749 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000750}
751
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000752void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000753 Metadata *MD = MDV.getMetadata();
754 if (auto *N = dyn_cast<MDNode>(MD)) {
755 visitMDNode(*N);
756 return;
757 }
758
759 // Only visit each node once. Metadata can be mutually recursive, so this
760 // avoids infinite recursion here, as well as being an optimization.
761 if (!MDNodes.insert(MD).second)
762 return;
763
764 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
765 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000766}
767
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000768static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
769static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
770static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000771
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000772template <class Ty>
773bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
774 for (Metadata *MD : N.operands()) {
775 if (MD) {
776 if (!isa<Ty>(MD))
777 return false;
778 } else {
779 if (!AllowNull)
780 return false;
781 }
782 }
783 return true;
784}
785
786template <class Ty>
787bool isValidMetadataArray(const MDTuple &N) {
788 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
789}
790
791template <class Ty>
792bool isValidMetadataNullArray(const MDTuple &N) {
793 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
794}
795
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000796void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000797 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
798 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000799 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000800 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000801}
802
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000803void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000804 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000805}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000806
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000807void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000808 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000809 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000810}
811
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000812void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000813 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
814 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000815}
816
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000817void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000818 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000819}
820
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000821void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000822 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
823 N.getTag() == dwarf::DW_TAG_unspecified_type,
824 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000825}
826
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000827void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000828 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000829 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000830
Adrian Prantl541a9c52016-05-06 19:26:47 +0000831 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
832 N.getTag() == dwarf::DW_TAG_pointer_type ||
833 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
834 N.getTag() == dwarf::DW_TAG_reference_type ||
835 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
836 N.getTag() == dwarf::DW_TAG_const_type ||
837 N.getTag() == dwarf::DW_TAG_volatile_type ||
838 N.getTag() == dwarf::DW_TAG_restrict_type ||
839 N.getTag() == dwarf::DW_TAG_member ||
840 N.getTag() == dwarf::DW_TAG_inheritance ||
841 N.getTag() == dwarf::DW_TAG_friend,
842 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000843 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000844 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
845 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000846 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000847
Adrian Prantl541a9c52016-05-06 19:26:47 +0000848 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
849 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
850 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000851}
852
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000853static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000854 return (Flags & DINode::FlagLValueReference) &&
855 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000856}
857
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000858void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
859 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000860 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000861 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000862 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
863 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000864 }
865}
866
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000867void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000868 // Common scope checks.
869 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000870
Adrian Prantl541a9c52016-05-06 19:26:47 +0000871 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
872 N.getTag() == dwarf::DW_TAG_structure_type ||
873 N.getTag() == dwarf::DW_TAG_union_type ||
874 N.getTag() == dwarf::DW_TAG_enumeration_type ||
875 N.getTag() == dwarf::DW_TAG_class_type,
876 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000877
Adrian Prantl541a9c52016-05-06 19:26:47 +0000878 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
879 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
880 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000881
Adrian Prantl541a9c52016-05-06 19:26:47 +0000882 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
883 "invalid composite elements", &N, N.getRawElements());
884 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
885 N.getRawVTableHolder());
886 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
887 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000888 if (auto *Params = N.getRawTemplateParams())
889 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000890
891 if (N.getTag() == dwarf::DW_TAG_class_type ||
892 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000893 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
894 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000895 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000896}
897
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000898void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000899 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000900 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000901 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000902 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000903 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000904 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000905 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000906 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
907 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000908}
909
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000910void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000911 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000912}
913
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000914void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000915 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
916 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000917
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000918 // Don't bother verifying the compilation directory or producer string
919 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000920 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
921 N.getRawFile());
922 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
923 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000924
Adrian Prantl541a9c52016-05-06 19:26:47 +0000925 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
926 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000927
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000928 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000929 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000930 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000931 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000932 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
933 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000934 }
935 }
936 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000937 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000938 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000939 AssertDI(Op && (isa<DIType>(Op) ||
940 (isa<DISubprogram>(Op) &&
941 cast<DISubprogram>(Op)->isDefinition() == false)),
942 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000943 }
944 }
945 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000946 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000947 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000948 AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref",
949 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000950 }
951 }
952 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000953 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000954 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000955 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
956 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 }
958 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000959 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000960 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000961 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000962 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000963 }
964 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000965 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000966}
967
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000968void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000969 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
970 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +0000971 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000972 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000973 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000974 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
975 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
976 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000977 if (auto *Params = N.getRawTemplateParams())
978 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +0000979 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000980 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
981 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000982 if (auto *RawVars = N.getRawVariables()) {
983 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000984 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000985 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000986 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
987 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000988 }
989 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000990 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
991 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +0000992
Adrian Prantl75819ae2016-04-15 15:57:41 +0000993 auto *Unit = N.getRawUnit();
994 if (N.isDefinition()) {
995 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +0000996 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
997 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
998 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +0000999 } else {
1000 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001001 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001002 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001003}
1004
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001005void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001006 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1007 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1008 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001009}
1010
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001011void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1012 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001013
Adrian Prantl541a9c52016-05-06 19:26:47 +00001014 AssertDI(N.getLine() || !N.getColumn(),
1015 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001016}
1017
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001018void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1019 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001020}
1021
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001022void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001023 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001024 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001025 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001026}
1027
Amjad Abouda9bcf162015-12-10 12:56:35 +00001028void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001029 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1030 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1031 "invalid macinfo type", &N);
1032 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001033 if (!N.getValue().empty()) {
1034 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1035 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001036}
1037
1038void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001039 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1040 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001041 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001042 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001043
1044 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001045 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001046 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001047 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001048 }
1049 }
1050}
1051
Adrian Prantlab1243f2015-06-29 23:03:47 +00001052void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001053 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1054 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001055}
1056
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001057void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001058 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001059}
1060
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001061void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1062 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001063
Adrian Prantl541a9c52016-05-06 19:26:47 +00001064 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1065 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001066}
1067
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001068void Verifier::visitDITemplateValueParameter(
1069 const DITemplateValueParameter &N) {
1070 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001071
Adrian Prantl541a9c52016-05-06 19:26:47 +00001072 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1073 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1074 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1075 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001076}
1077
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001078void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001079 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001080 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1081 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001082 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001083 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001084}
1085
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001086void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001087 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001088 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001089
Adrian Prantl541a9c52016-05-06 19:26:47 +00001090 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1091 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001092 if (auto *V = N.getRawVariable()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001093 AssertDI(isa<ConstantAsMetadata>(V) &&
1094 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1095 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001096 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001097 }
1098 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001099 AssertDI(isa<DIDerivedType>(Member),
1100 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001101 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001102}
1103
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001104void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001105 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001106 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001107
Adrian Prantl541a9c52016-05-06 19:26:47 +00001108 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1109 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1110 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001111}
1112
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001113void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001114 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001115}
1116
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001117void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001118 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001119 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001120 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001121 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001122 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001123}
1124
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001125void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001126 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1127 N.getTag() == dwarf::DW_TAG_imported_declaration,
1128 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001129 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001130 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1131 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1132 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001133}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001134
David Majnemerdad0a642014-06-27 18:19:56 +00001135void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001136 // The Module is invalid if the GlobalValue has private linkage. Entities
1137 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001138 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001139 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1140 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001141}
1142
Chandler Carruth043949d2014-01-19 02:22:18 +00001143void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001144 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1145 if (!Idents)
1146 return;
1147
1148 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1149 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001150 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001151 Assert(N->getNumOperands() == 1,
1152 "incorrect number of operands in llvm.ident metadata", N);
1153 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1154 ("invalid value for llvm.ident metadata entry operand"
1155 "(the operand should be a string)"),
1156 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001157 }
1158}
1159
Chandler Carruth043949d2014-01-19 02:22:18 +00001160void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001161 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1162 if (!Flags) return;
1163
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001164 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001165 DenseMap<const MDString*, const MDNode*> SeenIDs;
1166 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001167 for (const MDNode *MDN : Flags->operands())
1168 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001169
1170 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001171 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001172 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001173 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001174
Chandler Carruth043949d2014-01-19 02:22:18 +00001175 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001176 if (!Op) {
1177 CheckFailed("invalid requirement on flag, flag is not present in module",
1178 Flag);
1179 continue;
1180 }
1181
1182 if (Op->getOperand(2) != ReqValue) {
1183 CheckFailed(("invalid requirement on flag, "
1184 "flag does not have the required value"),
1185 Flag);
1186 continue;
1187 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001188 }
1189}
1190
Chandler Carruth043949d2014-01-19 02:22:18 +00001191void
1192Verifier::visitModuleFlag(const MDNode *Op,
1193 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1194 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001195 // Each module flag should have three arguments, the merge behavior (a
1196 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001197 Assert(Op->getNumOperands() == 3,
1198 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001199 Module::ModFlagBehavior MFB;
1200 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001201 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001202 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001203 "invalid behavior operand in module flag (expected constant integer)",
1204 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001205 Assert(false,
1206 "invalid behavior operand in module flag (unexpected constant)",
1207 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001208 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001209 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001210 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1211 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001212
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001213 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001214 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001215 case Module::Error:
1216 case Module::Warning:
1217 case Module::Override:
1218 // These behavior types accept any value.
1219 break;
1220
1221 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001222 // The value should itself be an MDNode with two operands, a flag ID (an
1223 // MDString), and a value.
1224 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001225 Assert(Value && Value->getNumOperands() == 2,
1226 "invalid value for 'require' module flag (expected metadata pair)",
1227 Op->getOperand(2));
1228 Assert(isa<MDString>(Value->getOperand(0)),
1229 ("invalid value for 'require' module flag "
1230 "(first value operand should be a string)"),
1231 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001232
1233 // Append it to the list of requirements, to check once all module flags are
1234 // scanned.
1235 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001236 break;
1237 }
1238
1239 case Module::Append:
1240 case Module::AppendUnique: {
1241 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001242 Assert(isa<MDNode>(Op->getOperand(2)),
1243 "invalid value for 'append'-type module flag "
1244 "(expected a metadata node)",
1245 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001246 break;
1247 }
1248 }
1249
1250 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001251 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001252 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001253 Assert(Inserted,
1254 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001255 }
1256}
1257
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001258void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001259 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001260 unsigned Slot = ~0U;
1261 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1262 if (Attrs.getSlotIndex(I) == Idx) {
1263 Slot = I;
1264 break;
1265 }
1266
1267 assert(Slot != ~0U && "Attribute set inconsistency!");
1268
1269 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1270 I != E; ++I) {
1271 if (I->isStringAttribute())
1272 continue;
1273
1274 if (I->getKindAsEnum() == Attribute::NoReturn ||
1275 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001276 I->getKindAsEnum() == Attribute::NoInline ||
1277 I->getKindAsEnum() == Attribute::AlwaysInline ||
1278 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1279 I->getKindAsEnum() == Attribute::StackProtect ||
1280 I->getKindAsEnum() == Attribute::StackProtectReq ||
1281 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001282 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001283 I->getKindAsEnum() == Attribute::NoRedZone ||
1284 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1285 I->getKindAsEnum() == Attribute::Naked ||
1286 I->getKindAsEnum() == Attribute::InlineHint ||
1287 I->getKindAsEnum() == Attribute::StackAlignment ||
1288 I->getKindAsEnum() == Attribute::UWTable ||
1289 I->getKindAsEnum() == Attribute::NonLazyBind ||
1290 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1291 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1292 I->getKindAsEnum() == Attribute::SanitizeThread ||
1293 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1294 I->getKindAsEnum() == Attribute::MinSize ||
1295 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001296 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001297 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001298 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001299 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001300 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001301 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001302 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001303 I->getKindAsEnum() == Attribute::NoRecurse ||
1304 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001305 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1306 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001307 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001308 CheckFailed("Attribute '" + I->getAsString() +
1309 "' only applies to functions!", V);
1310 return;
1311 }
1312 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001313 I->getKindAsEnum() == Attribute::WriteOnly ||
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001314 I->getKindAsEnum() == Attribute::ReadNone) {
1315 if (Idx == 0) {
1316 CheckFailed("Attribute '" + I->getAsString() +
1317 "' does not apply to function returns");
1318 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001319 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001320 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001321 CheckFailed("Attribute '" + I->getAsString() +
1322 "' does not apply to functions!", V);
1323 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001324 }
1325 }
1326}
1327
Duncan Sandsc3a79922009-06-11 08:11:03 +00001328// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001329// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001330void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001331 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001332 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001333 return;
1334
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001335 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001336
Bill Wendling908126a2012-10-09 09:51:10 +00001337 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001338 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1339 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1340 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1341 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1342 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001343 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001344 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1345 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001346 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001347 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001348 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001349 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001350
Reid Klecknera534a382013-12-19 02:14:12 +00001351 // Check for mutually incompatible attributes. Only inreg is compatible with
1352 // sret.
1353 unsigned AttrCount = 0;
1354 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1355 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1356 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1357 Attrs.hasAttribute(Idx, Attribute::InReg);
1358 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001359 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1360 "and 'sret' are incompatible!",
1361 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001362
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001363 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1364 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1365 "Attributes "
1366 "'inalloca and readonly' are incompatible!",
1367 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001368
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001369 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1370 Attrs.hasAttribute(Idx, Attribute::Returned)),
1371 "Attributes "
1372 "'sret and returned' are incompatible!",
1373 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001374
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001375 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1376 Attrs.hasAttribute(Idx, Attribute::SExt)),
1377 "Attributes "
1378 "'zeroext and signext' are incompatible!",
1379 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001380
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001381 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1382 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1383 "Attributes "
1384 "'readnone and readonly' are incompatible!",
1385 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001386
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001387 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1388 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1389 "Attributes "
1390 "'readnone and writeonly' are incompatible!",
1391 V);
1392
1393 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1394 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1395 "Attributes "
1396 "'readonly and writeonly' are incompatible!",
1397 V);
1398
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001399 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1400 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1401 "Attributes "
1402 "'noinline and alwaysinline' are incompatible!",
1403 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001404
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001405 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001406 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001407 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001408 AttributeSet::get(*Context, Idx,
1409 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001410 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001411
Reid Klecknera534a382013-12-19 02:14:12 +00001412 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001413 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001414 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001415 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1416 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1417 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1418 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001419 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001420 if (!isa<PointerType>(PTy->getElementType()))
1421 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1422 "Attribute 'swifterror' only applies to parameters "
1423 "with pointer to pointer type!",
1424 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001425 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001426 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1427 "Attribute 'byval' only applies to parameters with pointer type!",
1428 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001429 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1430 "Attribute 'swifterror' only applies to parameters "
1431 "with pointer type!",
1432 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001433 }
Duncan Sands0009c442008-01-12 16:42:01 +00001434}
1435
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001436// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001437// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001438void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001439 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001440 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001441 return;
1442
Duncan Sands8c582282007-12-21 19:19:01 +00001443 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001444 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001445 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001446 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001447 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001448
Chris Lattner8a923e72008-03-12 17:45:29 +00001449 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001450 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001451
Chris Lattner229907c2011-07-18 04:54:35 +00001452 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001453 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001454 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001455 else if (Idx-1 < FT->getNumParams())
1456 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001457 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001458 break; // VarArgs attributes, verified elsewhere.
1459
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001460 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001461
Stephen Linb8bd2322013-04-20 05:14:40 +00001462 if (Idx == 0)
1463 continue;
1464
1465 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001466 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001467 SawNest = true;
1468 }
1469
Stephen Linb8bd2322013-04-20 05:14:40 +00001470 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001471 Assert(!SawReturned, "More than one parameter has attribute returned!",
1472 V);
1473 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1474 "Incompatible "
1475 "argument and return types for 'returned' attribute",
1476 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001477 SawReturned = true;
1478 }
1479
Reid Kleckner79418562014-05-09 22:32:13 +00001480 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001481 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1482 Assert(Idx == 1 || Idx == 2,
1483 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001484 SawSRet = true;
1485 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001486
Manman Renf46262e2016-03-29 17:37:21 +00001487 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1488 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1489 SawSwiftSelf = true;
1490 }
1491
Manman Ren9bfd0d02016-04-01 21:41:15 +00001492 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1493 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1494 V);
1495 SawSwiftError = true;
1496 }
1497
Reid Kleckner60d3a832014-01-16 22:59:24 +00001498 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001499 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1500 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001501 }
Duncan Sands8c582282007-12-21 19:19:01 +00001502 }
Devang Patel9cc98122008-10-01 23:41:25 +00001503
Bill Wendling77543892013-01-18 21:11:39 +00001504 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1505 return;
1506
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001507 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001508
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001509 Assert(
1510 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1511 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1512 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001513
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001514 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001515 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001516 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1517 "Attributes 'readnone and writeonly' are incompatible!", V);
1518
1519 Assert(
1520 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1521 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1522 "Attributes 'readonly and writeonly' are incompatible!", V);
1523
1524 Assert(
1525 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001526 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1527 Attribute::InaccessibleMemOrArgMemOnly)),
1528 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1529
1530 Assert(
1531 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1532 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1533 Attribute::InaccessibleMemOnly)),
1534 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1535
1536 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001537 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1538 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1539 Attribute::AlwaysInline)),
1540 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001541
1542 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1543 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001544 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1545 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001546
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001547 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1548 Attribute::OptimizeForSize),
1549 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001550
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001551 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1552 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001553 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001554
1555 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1556 Attribute::JumpTable)) {
1557 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001558 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001559 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001560 }
George Burgess IV278199f2016-04-12 01:05:35 +00001561
1562 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1563 std::pair<unsigned, Optional<unsigned>> Args =
1564 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1565
1566 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1567 if (ParamNo >= FT->getNumParams()) {
1568 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1569 return false;
1570 }
1571
1572 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1573 CheckFailed("'allocsize' " + Name +
1574 " argument must refer to an integer parameter",
1575 V);
1576 return false;
1577 }
1578
1579 return true;
1580 };
1581
1582 if (!CheckParam("element size", Args.first))
1583 return;
1584
1585 if (Args.second && !CheckParam("number of elements", *Args.second))
1586 return;
1587 }
Duncan Sands8c582282007-12-21 19:19:01 +00001588}
1589
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001590void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001591 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001592 for (const auto &Pair : MDs) {
1593 if (Pair.first == LLVMContext::MD_prof) {
1594 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001595 Assert(MD->getNumOperands() == 2,
1596 "!prof annotations should have exactly 2 operands", MD);
1597
1598 // Check first operand.
1599 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1600 MD);
1601 Assert(isa<MDString>(MD->getOperand(0)),
1602 "expected string with name of the !prof annotation", MD);
1603 MDString *MDS = cast<MDString>(MD->getOperand(0));
1604 StringRef ProfName = MDS->getString();
1605 Assert(ProfName.equals("function_entry_count"),
1606 "first operand should be 'function_entry_count'", MD);
1607
1608 // Check second operand.
1609 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1610 MD);
1611 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1612 "expected integer argument to function_entry_count", MD);
1613 }
1614 }
1615}
1616
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001617void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1618 if (!ConstantExprVisited.insert(EntryC).second)
1619 return;
1620
1621 SmallVector<const Constant *, 16> Stack;
1622 Stack.push_back(EntryC);
1623
1624 while (!Stack.empty()) {
1625 const Constant *C = Stack.pop_back_val();
1626
1627 // Check this constant expression.
1628 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1629 visitConstantExpr(CE);
1630
Keno Fischerf6d17b92016-01-14 22:42:02 +00001631 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1632 // Global Values get visited separately, but we do need to make sure
1633 // that the global value is in the correct module
1634 Assert(GV->getParent() == M, "Referencing global in another module!",
1635 EntryC, M, GV, GV->getParent());
1636 continue;
1637 }
1638
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001639 // Visit all sub-expressions.
1640 for (const Use &U : C->operands()) {
1641 const auto *OpC = dyn_cast<Constant>(U);
1642 if (!OpC)
1643 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001644 if (!ConstantExprVisited.insert(OpC).second)
1645 continue;
1646 Stack.push_back(OpC);
1647 }
1648 }
1649}
1650
1651void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001652 if (CE->getOpcode() != Instruction::BitCast)
1653 return;
1654
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001655 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1656 CE->getType()),
1657 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001658}
1659
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001660bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001661 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001662 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001663
Devang Patel82fed672008-09-23 22:35:17 +00001664 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001665 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001666 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001667 || (LastIndex == AttributeSet::FunctionIndex
1668 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001669 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001670
Devang Patel82fed672008-09-23 22:35:17 +00001671 return false;
1672}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001673
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001674/// Verify that statepoint intrinsic is well formed.
1675void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001676 assert(CS.getCalledFunction() &&
1677 CS.getCalledFunction()->getIntrinsicID() ==
1678 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001679
Philip Reames0285c742015-02-03 23:18:47 +00001680 const Instruction &CI = *CS.getInstruction();
1681
Igor Laevsky39d662f2015-07-11 10:30:36 +00001682 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1683 !CS.onlyAccessesArgMemory(),
1684 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001685 "reordering restrictions required by safepoint semantics",
1686 &CI);
1687
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001688 const Value *IDV = CS.getArgument(0);
1689 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1690 &CI);
1691
1692 const Value *NumPatchBytesV = CS.getArgument(1);
1693 Assert(isa<ConstantInt>(NumPatchBytesV),
1694 "gc.statepoint number of patchable bytes must be a constant integer",
1695 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001696 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001697 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1698 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1699 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1700 "positive",
1701 &CI);
1702
1703 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001704 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001705 Assert(PT && PT->getElementType()->isFunctionTy(),
1706 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001707 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001708
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001709 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001710 Assert(isa<ConstantInt>(NumCallArgsV),
1711 "gc.statepoint number of arguments to underlying call "
1712 "must be constant integer",
1713 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001714 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001715 Assert(NumCallArgs >= 0,
1716 "gc.statepoint number of arguments to underlying call "
1717 "must be positive",
1718 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001719 const int NumParams = (int)TargetFuncType->getNumParams();
1720 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001721 Assert(NumCallArgs >= NumParams,
1722 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001723
1724 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001725 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1726 "gc.statepoint doesn't support wrapping non-void "
1727 "vararg functions yet",
1728 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001729 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001730 Assert(NumCallArgs == NumParams,
1731 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001732
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001733 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001734 Assert(isa<ConstantInt>(FlagsV),
1735 "gc.statepoint flags must be constant integer", &CI);
1736 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1737 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1738 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001739
1740 // Verify that the types of the call parameter arguments match
1741 // the type of the wrapped callee.
1742 for (int i = 0; i < NumParams; i++) {
1743 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001744 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001745 Assert(ArgType == ParamType,
1746 "gc.statepoint call argument does not match wrapped "
1747 "function type",
1748 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001749 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001750
1751 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001752
1753 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1754 Assert(isa<ConstantInt>(NumTransitionArgsV),
1755 "gc.statepoint number of transition arguments "
1756 "must be constant integer",
1757 &CI);
1758 const int NumTransitionArgs =
1759 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1760 Assert(NumTransitionArgs >= 0,
1761 "gc.statepoint number of transition arguments must be positive", &CI);
1762 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1763
1764 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001765 Assert(isa<ConstantInt>(NumDeoptArgsV),
1766 "gc.statepoint number of deoptimization arguments "
1767 "must be constant integer",
1768 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001769 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001770 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1771 "must be positive",
1772 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001773
Pat Gavlincc0431d2015-05-08 18:07:42 +00001774 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001775 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001776 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001777 "gc.statepoint too few arguments according to length fields", &CI);
1778
Philip Reames1ffa9372015-01-30 23:28:05 +00001779 // Check that the only uses of this gc.statepoint are gc.result or
1780 // gc.relocate calls which are tied to this statepoint and thus part
1781 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001782 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001783 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001784 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001785 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001786 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001787 "gc.result or gc.relocate are the only value uses"
1788 "of a gc.statepoint",
1789 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001790 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001791 Assert(Call->getArgOperand(0) == &CI,
1792 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001793 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001794 Assert(Call->getArgOperand(0) == &CI,
1795 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001796 }
1797 }
1798
1799 // Note: It is legal for a single derived pointer to be listed multiple
1800 // times. It's non-optimal, but it is legal. It can also happen after
1801 // insertion if we strip a bitcast away.
1802 // Note: It is really tempting to check that each base is relocated and
1803 // that a derived pointer is never reused as a base pointer. This turns
1804 // out to be problematic since optimizations run after safepoint insertion
1805 // can recognize equality properties that the insertion logic doesn't know
1806 // about. See example statepoint.ll in the verifier subdirectory
1807}
1808
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001809void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001810 for (auto &Counts : FrameEscapeInfo) {
1811 Function *F = Counts.first;
1812 unsigned EscapedObjectCount = Counts.second.first;
1813 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001814 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001815 "all indices passed to llvm.localrecover must be less than the "
1816 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001817 "function",
1818 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001819 }
1820}
1821
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001822static Instruction *getSuccPad(TerminatorInst *Terminator) {
1823 BasicBlock *UnwindDest;
1824 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1825 UnwindDest = II->getUnwindDest();
1826 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1827 UnwindDest = CSI->getUnwindDest();
1828 else
1829 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1830 return UnwindDest->getFirstNonPHI();
1831}
1832
1833void Verifier::verifySiblingFuncletUnwinds() {
1834 SmallPtrSet<Instruction *, 8> Visited;
1835 SmallPtrSet<Instruction *, 8> Active;
1836 for (const auto &Pair : SiblingFuncletInfo) {
1837 Instruction *PredPad = Pair.first;
1838 if (Visited.count(PredPad))
1839 continue;
1840 Active.insert(PredPad);
1841 TerminatorInst *Terminator = Pair.second;
1842 do {
1843 Instruction *SuccPad = getSuccPad(Terminator);
1844 if (Active.count(SuccPad)) {
1845 // Found a cycle; report error
1846 Instruction *CyclePad = SuccPad;
1847 SmallVector<Instruction *, 8> CycleNodes;
1848 do {
1849 CycleNodes.push_back(CyclePad);
1850 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1851 if (CycleTerminator != CyclePad)
1852 CycleNodes.push_back(CycleTerminator);
1853 CyclePad = getSuccPad(CycleTerminator);
1854 } while (CyclePad != SuccPad);
1855 Assert(false, "EH pads can't handle each other's exceptions",
1856 ArrayRef<Instruction *>(CycleNodes));
1857 }
1858 // Don't re-walk a node we've already checked
1859 if (!Visited.insert(SuccPad).second)
1860 break;
1861 // Walk to this successor if it has a map entry.
1862 PredPad = SuccPad;
1863 auto TermI = SiblingFuncletInfo.find(PredPad);
1864 if (TermI == SiblingFuncletInfo.end())
1865 break;
1866 Terminator = TermI->second;
1867 Active.insert(PredPad);
1868 } while (true);
1869 // Each node only has one successor, so we've walked all the active
1870 // nodes' successors.
1871 Active.clear();
1872 }
1873}
1874
Chris Lattner0e851da2002-04-18 20:37:37 +00001875// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001876//
Chandler Carruth043949d2014-01-19 02:22:18 +00001877void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001878 visitGlobalValue(F);
1879
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001880 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001881 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001882 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001883
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001884 Assert(Context == &F.getContext(),
1885 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001886
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001887 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1888 Assert(FT->getNumParams() == NumArgs,
1889 "# formal arguments must match # of arguments for function type!", &F,
1890 FT);
1891 Assert(F.getReturnType()->isFirstClassType() ||
1892 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1893 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001894
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001895 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1896 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001897
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001898 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001899
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001900 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001901 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001902
Duncan Sands8c582282007-12-21 19:19:01 +00001903 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001904 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001905
Michael Gottesman41748d72013-06-27 00:25:01 +00001906 // On function declarations/definitions, we do not support the builtin
1907 // attribute. We do not check this in VerifyFunctionAttrs since that is
1908 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001909 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1910 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001911
Chris Lattneref13ee32006-05-19 21:25:17 +00001912 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001913 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1914 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001915 switch (F.getCallingConv()) {
1916 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001917 case CallingConv::C:
1918 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001919 case CallingConv::Fast:
1920 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001921 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001922 case CallingConv::PTX_Kernel:
1923 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001924 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1925 "perfect forwarding!",
1926 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001927 break;
1928 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001929
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001930 bool isLLVMdotName = F.getName().size() >= 5 &&
1931 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001932
Chris Lattneraf95e582002-04-13 22:48:46 +00001933 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001934 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001935 for (const Argument &Arg : F.args()) {
1936 Assert(Arg.getType() == FT->getParamType(i),
1937 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001938 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001939 Assert(Arg.getType()->isFirstClassType(),
1940 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001941 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001942 Assert(!Arg.getType()->isMetadataTy(),
1943 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1944 Assert(!Arg.getType()->isTokenTy(),
1945 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001946 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001947
1948 // Check that swifterror argument is only used by loads and stores.
1949 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1950 verifySwiftErrorValue(&Arg);
1951 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001952 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001953 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001954
David Majnemerb611e3f2015-08-14 05:09:07 +00001955 if (!isLLVMdotName)
1956 Assert(!F.getReturnType()->isTokenTy(),
1957 "Functions returns a token but isn't an intrinsic", &F);
1958
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001959 // Get the function metadata attachments.
1960 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1961 F.getAllMetadata(MDs);
1962 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001963 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001964
Keno Fischer2ac0c272015-11-16 05:13:30 +00001965 // Check validity of the personality function
1966 if (F.hasPersonalityFn()) {
1967 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1968 if (Per)
1969 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001970 "Referencing personality function in another module!",
1971 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001972 }
1973
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001974 if (F.isMaterializable()) {
1975 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001976 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1977 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001978 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00001979 for (const auto &I : MDs) {
1980 AssertDI(I.first != LLVMContext::MD_dbg,
1981 "function declaration may not have a !dbg attachment", &F);
1982 Assert(I.first != LLVMContext::MD_prof,
1983 "function declaration may not have a !prof attachment", &F);
1984
1985 // Verify the metadata itself.
1986 visitMDNode(*I.second);
1987 }
David Majnemer7fddecc2015-06-17 20:52:32 +00001988 Assert(!F.hasPersonalityFn(),
1989 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001990 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001991 // Verify that this function (which has a body) is not named "llvm.*". It
1992 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001993 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001994
Chris Lattner149376d2002-10-13 20:57:00 +00001995 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001996 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001997 Assert(pred_empty(Entry),
1998 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001999
Chris Lattner27471742009-11-01 04:08:01 +00002000 // The address of the entry block cannot be taken, unless it is dead.
2001 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002002 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2003 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002004 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002005
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002006 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002007 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002008 for (const auto &I : MDs) {
2009 // Verify that the attachment is legal.
2010 switch (I.first) {
2011 default:
2012 break;
2013 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002014 ++NumDebugAttachments;
2015 AssertDI(NumDebugAttachments == 1,
2016 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002017 AssertDI(isa<DISubprogram>(I.second),
2018 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002019 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002020 case LLVMContext::MD_prof:
2021 ++NumProfAttachments;
2022 Assert(NumProfAttachments == 1,
2023 "function must have a single !prof attachment", &F, I.second);
2024 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002025 }
2026
2027 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002028 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002029 }
Chris Lattner149376d2002-10-13 20:57:00 +00002030 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002031
Chris Lattner7730dcc2009-09-11 17:05:29 +00002032 // If this function is actually an intrinsic, verify that it is only used in
2033 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002034 // Only do this if the module is materialized, otherwise we don't have all the
2035 // uses.
2036 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002037 const User *U;
2038 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002039 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002040 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002041
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002042 Assert(!F.hasDLLImportStorageClass() ||
2043 (F.isDeclaration() && F.hasExternalLinkage()) ||
2044 F.hasAvailableExternallyLinkage(),
2045 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002046
2047 auto *N = F.getSubprogram();
2048 if (!N)
2049 return;
2050
Adrian Prantl75819ae2016-04-15 15:57:41 +00002051 visitDISubprogram(*N);
2052
Peter Collingbourned4bff302015-11-05 22:03:56 +00002053 // Check that all !dbg attachments lead to back to N (or, at least, another
2054 // subprogram that describes the same function).
2055 //
2056 // FIXME: Check this incrementally while visiting !dbg attachments.
2057 // FIXME: Only check when N is the canonical subprogram for F.
2058 SmallPtrSet<const MDNode *, 32> Seen;
2059 for (auto &BB : F)
2060 for (auto &I : BB) {
2061 // Be careful about using DILocation here since we might be dealing with
2062 // broken code (this is the Verifier after all).
2063 DILocation *DL =
2064 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2065 if (!DL)
2066 continue;
2067 if (!Seen.insert(DL).second)
2068 continue;
2069
2070 DILocalScope *Scope = DL->getInlinedAtScope();
2071 if (Scope && !Seen.insert(Scope).second)
2072 continue;
2073
2074 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002075
2076 // Scope and SP could be the same MDNode and we don't want to skip
2077 // validation in that case
2078 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002079 continue;
2080
2081 // FIXME: Once N is canonical, check "SP == &N".
2082 Assert(SP->describes(&F),
2083 "!dbg attachment points at wrong subprogram for function", N, &F,
2084 &I, DL, Scope, SP);
2085 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002086}
2087
Chris Lattner0e851da2002-04-18 20:37:37 +00002088// verifyBasicBlock - Verify that a basic block is well formed...
2089//
Chris Lattner069a7952002-06-25 15:56:27 +00002090void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002091 InstsInThisBlock.clear();
2092
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002093 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002094 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002095
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002096 // Check constraints that this basic block imposes on all of the PHI nodes in
2097 // it.
2098 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002099 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2100 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002101 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002102 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002103 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002104 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002105 Assert(PN->getNumIncomingValues() != 0,
2106 "PHI nodes must have at least one entry. If the block is dead, "
2107 "the PHI should be removed!",
2108 PN);
2109 Assert(PN->getNumIncomingValues() == Preds.size(),
2110 "PHINode should have one entry for each predecessor of its "
2111 "parent basic block!",
2112 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002113
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002114 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002115 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002116 Values.reserve(PN->getNumIncomingValues());
2117 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2118 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2119 PN->getIncomingValue(i)));
2120 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002121
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002122 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2123 // Check to make sure that if there is more than one entry for a
2124 // particular basic block in this PHI node, that the incoming values are
2125 // all identical.
2126 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002127 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2128 Values[i].second == Values[i - 1].second,
2129 "PHI node has multiple entries for the same basic block with "
2130 "different incoming values!",
2131 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002132
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002133 // Check to make sure that the predecessors and PHI node entries are
2134 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002135 Assert(Values[i].first == Preds[i],
2136 "PHI node entries do not match predecessors!", PN,
2137 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002138 }
2139 }
2140 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002141
2142 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002143 for (auto &I : BB)
2144 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002145 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002146 }
Chris Lattner069a7952002-06-25 15:56:27 +00002147}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002148
Chris Lattner069a7952002-06-25 15:56:27 +00002149void Verifier::visitTerminatorInst(TerminatorInst &I) {
2150 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002151 Assert(&I == I.getParent()->getTerminator(),
2152 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002153 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002154}
2155
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002156void Verifier::visitBranchInst(BranchInst &BI) {
2157 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002158 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2159 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002160 }
2161 visitTerminatorInst(BI);
2162}
2163
Chris Lattner069a7952002-06-25 15:56:27 +00002164void Verifier::visitReturnInst(ReturnInst &RI) {
2165 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002166 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002167 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002168 Assert(N == 0,
2169 "Found return instr that returns non-void in Function of void "
2170 "return type!",
2171 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002172 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002173 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2174 "Function return type does not match operand "
2175 "type of return inst!",
2176 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002177
Misha Brukman7eb05a12003-08-18 14:43:39 +00002178 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002179 // terminators...
2180 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002181}
2182
Chris Lattnerab5aa142004-05-21 16:47:21 +00002183void Verifier::visitSwitchInst(SwitchInst &SI) {
2184 // Check to make sure that all of the constants in the switch instruction
2185 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002186 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002187 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002188 for (auto &Case : SI.cases()) {
2189 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002190 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002191 Assert(Constants.insert(Case.getCaseValue()).second,
2192 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002193 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002194
Chris Lattnerab5aa142004-05-21 16:47:21 +00002195 visitTerminatorInst(SI);
2196}
2197
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002198void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002199 Assert(BI.getAddress()->getType()->isPointerTy(),
2200 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002201 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002202 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2203 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002204
2205 visitTerminatorInst(BI);
2206}
2207
Chris Lattner75648e72004-03-12 05:54:31 +00002208void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002209 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2210 SI.getOperand(2)),
2211 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002212
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002213 Assert(SI.getTrueValue()->getType() == SI.getType(),
2214 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002215 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002216}
2217
Misha Brukmanc566ca362004-03-02 00:22:19 +00002218/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2219/// a pass, if any exist, it's an error.
2220///
Chris Lattner903a25d2002-11-21 16:54:22 +00002221void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002222 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002223}
Chris Lattner0e851da2002-04-18 20:37:37 +00002224
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002225void Verifier::visitTruncInst(TruncInst &I) {
2226 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002227 Type *SrcTy = I.getOperand(0)->getType();
2228 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002229
2230 // Get the size of the types in bits, we'll need this later
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(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2235 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2236 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2237 "trunc source and destination must both be a vector or neither", &I);
2238 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002239
2240 visitInstruction(I);
2241}
2242
2243void Verifier::visitZExtInst(ZExtInst &I) {
2244 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002245 Type *SrcTy = I.getOperand(0)->getType();
2246 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002247
2248 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002249 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2250 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2251 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2252 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002253 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2254 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002255
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002256 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002257
2258 visitInstruction(I);
2259}
2260
2261void Verifier::visitSExtInst(SExtInst &I) {
2262 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002263 Type *SrcTy = I.getOperand(0)->getType();
2264 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002265
2266 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002267 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2268 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002269
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002270 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2271 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2272 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2273 "sext source and destination must both be a vector or neither", &I);
2274 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002275
2276 visitInstruction(I);
2277}
2278
2279void Verifier::visitFPTruncInst(FPTruncInst &I) {
2280 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002281 Type *SrcTy = I.getOperand(0)->getType();
2282 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002283 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002284 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2285 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002286
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002287 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2288 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2289 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2290 "fptrunc source and destination must both be a vector or neither", &I);
2291 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002292
2293 visitInstruction(I);
2294}
2295
2296void Verifier::visitFPExtInst(FPExtInst &I) {
2297 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002298 Type *SrcTy = I.getOperand(0)->getType();
2299 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002300
2301 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002302 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2303 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002304
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002305 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2306 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2307 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2308 "fpext source and destination must both be a vector or neither", &I);
2309 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002310
2311 visitInstruction(I);
2312}
2313
2314void Verifier::visitUIToFPInst(UIToFPInst &I) {
2315 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002316 Type *SrcTy = I.getOperand(0)->getType();
2317 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002318
Duncan Sands19d0b472010-02-16 11:11:14 +00002319 bool SrcVec = SrcTy->isVectorTy();
2320 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002321
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002322 Assert(SrcVec == DstVec,
2323 "UIToFP source and dest must both be vector or scalar", &I);
2324 Assert(SrcTy->isIntOrIntVectorTy(),
2325 "UIToFP source must be integer or integer vector", &I);
2326 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2327 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002328
2329 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002330 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2331 cast<VectorType>(DestTy)->getNumElements(),
2332 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002333
2334 visitInstruction(I);
2335}
2336
2337void Verifier::visitSIToFPInst(SIToFPInst &I) {
2338 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002339 Type *SrcTy = I.getOperand(0)->getType();
2340 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002341
Duncan Sands19d0b472010-02-16 11:11:14 +00002342 bool SrcVec = SrcTy->isVectorTy();
2343 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002344
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002345 Assert(SrcVec == DstVec,
2346 "SIToFP source and dest must both be vector or scalar", &I);
2347 Assert(SrcTy->isIntOrIntVectorTy(),
2348 "SIToFP source must be integer or integer vector", &I);
2349 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2350 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002351
2352 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002353 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2354 cast<VectorType>(DestTy)->getNumElements(),
2355 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002356
2357 visitInstruction(I);
2358}
2359
2360void Verifier::visitFPToUIInst(FPToUIInst &I) {
2361 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002362 Type *SrcTy = I.getOperand(0)->getType();
2363 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002364
Duncan Sands19d0b472010-02-16 11:11:14 +00002365 bool SrcVec = SrcTy->isVectorTy();
2366 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002367
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002368 Assert(SrcVec == DstVec,
2369 "FPToUI source and dest must both be vector or scalar", &I);
2370 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2371 &I);
2372 Assert(DestTy->isIntOrIntVectorTy(),
2373 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002374
2375 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002376 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2377 cast<VectorType>(DestTy)->getNumElements(),
2378 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002379
2380 visitInstruction(I);
2381}
2382
2383void Verifier::visitFPToSIInst(FPToSIInst &I) {
2384 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002385 Type *SrcTy = I.getOperand(0)->getType();
2386 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002387
Duncan Sands19d0b472010-02-16 11:11:14 +00002388 bool SrcVec = SrcTy->isVectorTy();
2389 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002390
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002391 Assert(SrcVec == DstVec,
2392 "FPToSI source and dest must both be vector or scalar", &I);
2393 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2394 &I);
2395 Assert(DestTy->isIntOrIntVectorTy(),
2396 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002397
2398 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002399 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2400 cast<VectorType>(DestTy)->getNumElements(),
2401 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002402
2403 visitInstruction(I);
2404}
2405
2406void Verifier::visitPtrToIntInst(PtrToIntInst &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()->isPointerTy(),
2412 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002413
2414 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
2415 Assert(!M->getDataLayout().isNonIntegralPointerType(PTy),
2416 "ptrtoint not supported for non-integral pointers");
2417
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002418 Assert(DestTy->getScalarType()->isIntegerTy(),
2419 "PtrToInt result must be integral", &I);
2420 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2421 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002422
2423 if (SrcTy->isVectorTy()) {
2424 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2425 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002426 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2427 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002428 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002429
2430 visitInstruction(I);
2431}
2432
2433void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2434 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002435 Type *SrcTy = I.getOperand(0)->getType();
2436 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002437
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002438 Assert(SrcTy->getScalarType()->isIntegerTy(),
2439 "IntToPtr source must be an integral", &I);
2440 Assert(DestTy->getScalarType()->isPointerTy(),
2441 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002442
2443 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
2444 Assert(!M->getDataLayout().isNonIntegralPointerType(PTy),
2445 "inttoptr not supported for non-integral pointers");
2446
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002447 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2448 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002449 if (SrcTy->isVectorTy()) {
2450 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2451 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002452 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2453 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002454 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002455 visitInstruction(I);
2456}
2457
2458void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002459 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002460 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2461 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002462 visitInstruction(I);
2463}
2464
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002465void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2466 Type *SrcTy = I.getOperand(0)->getType();
2467 Type *DestTy = I.getType();
2468
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002469 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2470 &I);
2471 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2472 &I);
2473 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2474 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002475 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002476 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2477 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002478 visitInstruction(I);
2479}
2480
Misha Brukmanc566ca362004-03-02 00:22:19 +00002481/// visitPHINode - Ensure that a PHI node is well formed.
2482///
Chris Lattner069a7952002-06-25 15:56:27 +00002483void Verifier::visitPHINode(PHINode &PN) {
2484 // Ensure that the PHI nodes are all grouped together at the top of the block.
2485 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002486 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002487 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002488 Assert(&PN == &PN.getParent()->front() ||
2489 isa<PHINode>(--BasicBlock::iterator(&PN)),
2490 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002491
David Majnemerb611e3f2015-08-14 05:09:07 +00002492 // Check that a PHI doesn't yield a Token.
2493 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2494
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002495 // Check that all of the values of the PHI node have the same type as the
2496 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002497 for (Value *IncValue : PN.incoming_values()) {
2498 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002499 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002500 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002501
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002502 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002503
2504 visitInstruction(PN);
2505}
2506
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002507void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002508 Instruction *I = CS.getInstruction();
2509
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002510 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2511 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002512 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002513
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002514 Assert(FPTy->getElementType()->isFunctionTy(),
2515 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002516
2517 Assert(FPTy->getElementType() == CS.getFunctionType(),
2518 "Called function is not the same type as the call!", I);
2519
2520 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002521
2522 // Verify that the correct number of arguments are being passed
2523 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002524 Assert(CS.arg_size() >= FTy->getNumParams(),
2525 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002526 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002527 Assert(CS.arg_size() == FTy->getNumParams(),
2528 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002529
Chris Lattner609de002010-05-10 20:58:42 +00002530 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002531 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002532 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2533 "Call parameter type does not match function signature!",
2534 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002535
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002536 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002537
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002538 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002539 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002540
Duncan Sands8c582282007-12-21 19:19:01 +00002541 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002542 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002543
David Majnemer91db08b2014-04-30 17:22:00 +00002544 // Conservatively check the inalloca argument.
2545 // We have a bug if we can find that there is an underlying alloca without
2546 // inalloca.
2547 if (CS.hasInAllocaArgument()) {
2548 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2549 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002550 Assert(AI->isUsedWithInAlloca(),
2551 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002552 }
2553
Manman Ren9bfd0d02016-04-01 21:41:15 +00002554 // For each argument of the callsite, if it has the swifterror argument,
2555 // make sure the underlying alloca has swifterror as well.
2556 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2557 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2558 Value *SwiftErrorArg = CS.getArgument(i);
2559 auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets());
2560 Assert(AI, "swifterror argument should come from alloca", AI, I);
2561 if (AI)
2562 Assert(AI->isSwiftError(),
2563 "swifterror argument for call has mismatched alloca", AI, I);
2564 }
2565
Stephen Linb8bd2322013-04-20 05:14:40 +00002566 if (FTy->isVarArg()) {
2567 // FIXME? is 'nest' even legal here?
2568 bool SawNest = false;
2569 bool SawReturned = false;
2570
2571 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2572 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2573 SawNest = true;
2574 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2575 SawReturned = true;
2576 }
2577
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002578 // Check attributes on the varargs part.
2579 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002580 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002581 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002582
Stephen Linb8bd2322013-04-20 05:14:40 +00002583 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002584 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002585 SawNest = true;
2586 }
2587
2588 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002589 Assert(!SawReturned, "More than one parameter has attribute returned!",
2590 I);
2591 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2592 "Incompatible argument and return types for 'returned' "
2593 "attribute",
2594 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002595 SawReturned = true;
2596 }
Duncan Sands0009c442008-01-12 16:42:01 +00002597
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002598 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2599 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002600
2601 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002602 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002603 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002604 }
Duncan Sands8c582282007-12-21 19:19:01 +00002605
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002606 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002607 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002608 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002609 for (Type *ParamTy : FTy->params()) {
2610 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002611 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002612 Assert(!ParamTy->isTokenTy(),
2613 "Function has token parameter but isn't an intrinsic", I);
2614 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002615 }
2616
David Majnemerb611e3f2015-08-14 05:09:07 +00002617 // Verify that indirect calls don't return tokens.
2618 if (CS.getCalledFunction() == nullptr)
2619 Assert(!FTy->getReturnType()->isTokenTy(),
2620 "Return type cannot be token for indirect call!");
2621
Philip Reamesa3c6f002015-06-26 21:39:44 +00002622 if (Function *F = CS.getCalledFunction())
2623 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002624 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002625
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002626 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2627 // at most one "gc-transition" operand bundle.
2628 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2629 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002630 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002631 OperandBundleUse BU = CS.getOperandBundleAt(i);
2632 uint32_t Tag = BU.getTagID();
2633 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002634 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2635 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002636 } else if (Tag == LLVMContext::OB_gc_transition) {
2637 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2638 I);
2639 FoundGCTransitionBundle = true;
2640 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002641 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2642 FoundFuncletBundle = true;
2643 Assert(BU.Inputs.size() == 1,
2644 "Expected exactly one funclet bundle operand", I);
2645 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2646 "Funclet bundle operands should correspond to a FuncletPadInst",
2647 I);
2648 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002649 }
2650
Adrian Prantl93035c82016-04-24 22:23:13 +00002651 // Verify that each inlinable callsite of a debug-info-bearing function in a
2652 // debug-info-bearing function has a debug location attached to it. Failure to
2653 // do so causes assertion failures when the inliner sets up inline scope info.
2654 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2655 CS.getCalledFunction()->getSubprogram())
2656 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2657 "info must have a !dbg location",
2658 I);
2659
Duncan Sands8c582282007-12-21 19:19:01 +00002660 visitInstruction(*I);
2661}
2662
Reid Kleckner5772b772014-04-24 20:14:34 +00002663/// Two types are "congruent" if they are identical, or if they are both pointer
2664/// types with different pointee types and the same address space.
2665static bool isTypeCongruent(Type *L, Type *R) {
2666 if (L == R)
2667 return true;
2668 PointerType *PL = dyn_cast<PointerType>(L);
2669 PointerType *PR = dyn_cast<PointerType>(R);
2670 if (!PL || !PR)
2671 return false;
2672 return PL->getAddressSpace() == PR->getAddressSpace();
2673}
2674
Reid Klecknerd20c9702014-05-15 23:58:57 +00002675static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2676 static const Attribute::AttrKind ABIAttrs[] = {
2677 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002678 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2679 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002680 AttrBuilder Copy;
2681 for (auto AK : ABIAttrs) {
2682 if (Attrs.hasAttribute(I + 1, AK))
2683 Copy.addAttribute(AK);
2684 }
2685 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2686 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2687 return Copy;
2688}
2689
Reid Kleckner5772b772014-04-24 20:14:34 +00002690void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002691 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002692
2693 // - The caller and callee prototypes must match. Pointer types of
2694 // parameters or return types may differ in pointee type, but not
2695 // address space.
2696 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002697 FunctionType *CallerTy = F->getFunctionType();
2698 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002699 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2700 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2701 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2702 "cannot guarantee tail call due to mismatched varargs", &CI);
2703 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2704 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002705 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002706 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002707 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2708 "cannot guarantee tail call due to mismatched parameter types", &CI);
2709 }
2710
2711 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002712 Assert(F->getCallingConv() == CI.getCallingConv(),
2713 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002714
2715 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2716 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002717 AttributeSet CallerAttrs = F->getAttributes();
2718 AttributeSet CalleeAttrs = CI.getAttributes();
2719 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002720 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2721 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002722 Assert(CallerABIAttrs == CalleeABIAttrs,
2723 "cannot guarantee tail call due to mismatched ABI impacting "
2724 "function attributes",
2725 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002726 }
2727
2728 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2729 // or a pointer bitcast followed by a ret instruction.
2730 // - The ret instruction must return the (possibly bitcasted) value
2731 // produced by the call or void.
2732 Value *RetVal = &CI;
2733 Instruction *Next = CI.getNextNode();
2734
2735 // Handle the optional bitcast.
2736 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002737 Assert(BI->getOperand(0) == RetVal,
2738 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002739 RetVal = BI;
2740 Next = BI->getNextNode();
2741 }
2742
2743 // Check the return.
2744 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002745 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2746 &CI);
2747 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2748 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002749}
2750
Duncan Sands8c582282007-12-21 19:19:01 +00002751void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002752 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002753
Reid Kleckner5772b772014-04-24 20:14:34 +00002754 if (CI.isMustTailCall())
2755 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002756}
2757
2758void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002759 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002760
David Majnemer654e1302015-07-31 17:58:14 +00002761 // Verify that the first non-PHI instruction of the unwind destination is an
2762 // exception handling instruction.
2763 Assert(
2764 II.getUnwindDest()->isEHPad(),
2765 "The unwind destination does not have an exception handling instruction!",
2766 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002767
Dan Gohman9c6e1882010-08-02 23:09:14 +00002768 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002769}
Chris Lattner0e851da2002-04-18 20:37:37 +00002770
Misha Brukmanc566ca362004-03-02 00:22:19 +00002771/// visitBinaryOperator - Check that both arguments to the binary operator are
2772/// of the same type!
2773///
Chris Lattner069a7952002-06-25 15:56:27 +00002774void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002775 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2776 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002777
Reid Spencer2341c222007-02-02 02:16:23 +00002778 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002779 // Check that integer arithmetic operators are only used with
2780 // integral operands.
2781 case Instruction::Add:
2782 case Instruction::Sub:
2783 case Instruction::Mul:
2784 case Instruction::SDiv:
2785 case Instruction::UDiv:
2786 case Instruction::SRem:
2787 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002788 Assert(B.getType()->isIntOrIntVectorTy(),
2789 "Integer arithmetic operators only work with integral types!", &B);
2790 Assert(B.getType() == B.getOperand(0)->getType(),
2791 "Integer arithmetic operators must have same type "
2792 "for operands and result!",
2793 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002794 break;
2795 // Check that floating-point arithmetic operators are only used with
2796 // floating-point operands.
2797 case Instruction::FAdd:
2798 case Instruction::FSub:
2799 case Instruction::FMul:
2800 case Instruction::FDiv:
2801 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002802 Assert(B.getType()->isFPOrFPVectorTy(),
2803 "Floating-point arithmetic operators only work with "
2804 "floating-point types!",
2805 &B);
2806 Assert(B.getType() == B.getOperand(0)->getType(),
2807 "Floating-point arithmetic operators must have same type "
2808 "for operands and result!",
2809 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002810 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002811 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002812 case Instruction::And:
2813 case Instruction::Or:
2814 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002815 Assert(B.getType()->isIntOrIntVectorTy(),
2816 "Logical operators only work with integral types!", &B);
2817 Assert(B.getType() == B.getOperand(0)->getType(),
2818 "Logical operators must have same type for operands and result!",
2819 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002820 break;
2821 case Instruction::Shl:
2822 case Instruction::LShr:
2823 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002824 Assert(B.getType()->isIntOrIntVectorTy(),
2825 "Shifts only work with integral types!", &B);
2826 Assert(B.getType() == B.getOperand(0)->getType(),
2827 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002828 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002829 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002830 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002831 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002832
Chris Lattner0e851da2002-04-18 20:37:37 +00002833 visitInstruction(B);
2834}
2835
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002836void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002837 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002838 Type *Op0Ty = IC.getOperand(0)->getType();
2839 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002840 Assert(Op0Ty == Op1Ty,
2841 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002842 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002843 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2844 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002845 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002846 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2847 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2848 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002849
Reid Spencerd9436b62006-11-20 01:22:35 +00002850 visitInstruction(IC);
2851}
2852
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002853void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002854 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002855 Type *Op0Ty = FC.getOperand(0)->getType();
2856 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002857 Assert(Op0Ty == Op1Ty,
2858 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002859 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002860 Assert(Op0Ty->isFPOrFPVectorTy(),
2861 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002862 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002863 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2864 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2865 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002866
Reid Spencerd9436b62006-11-20 01:22:35 +00002867 visitInstruction(FC);
2868}
2869
Robert Bocchino23004482006-01-10 19:05:34 +00002870void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002871 Assert(
2872 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2873 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002874 visitInstruction(EI);
2875}
2876
Robert Bocchinoca27f032006-01-17 20:07:22 +00002877void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002878 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2879 IE.getOperand(2)),
2880 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002881 visitInstruction(IE);
2882}
2883
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002884void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002885 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2886 SV.getOperand(2)),
2887 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002888 visitInstruction(SV);
2889}
2890
Chris Lattner069a7952002-06-25 15:56:27 +00002891void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002892 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002893
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002894 Assert(isa<PointerType>(TargetTy),
2895 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002896 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002897 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002898 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002899 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002900 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002901
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002902 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002903 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002904 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002905
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002906 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002907 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002908 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2909 if (GEP.getPointerOperandType()->isVectorTy())
2910 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2911 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002912 for (Value *Idx : Idxs) {
2913 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002914 if (IndexTy->isVectorTy()) {
2915 unsigned IndexWidth = IndexTy->getVectorNumElements();
2916 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2917 }
2918 Assert(IndexTy->getScalarType()->isIntegerTy(),
2919 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002920 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002921 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002922 visitInstruction(GEP);
2923}
2924
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002925static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2926 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2927}
2928
Philip Reamesbf9676f2014-10-20 23:52:07 +00002929void Verifier::visitRangeMetadata(Instruction& I,
2930 MDNode* Range, Type* Ty) {
2931 assert(Range &&
2932 Range == I.getMetadata(LLVMContext::MD_range) &&
2933 "precondition violation");
2934
2935 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002936 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002937 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002938 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2939
Philip Reamesbf9676f2014-10-20 23:52:07 +00002940 ConstantRange LastRange(1); // Dummy initial value
2941 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002942 ConstantInt *Low =
2943 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002944 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002945 ConstantInt *High =
2946 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002947 Assert(High, "The upper limit must be an integer!", High);
2948 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2949 "Range types must match instruction type!", &I);
2950
Philip Reamesbf9676f2014-10-20 23:52:07 +00002951 APInt HighV = High->getValue();
2952 APInt LowV = Low->getValue();
2953 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002954 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2955 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002956 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002957 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2958 "Intervals are overlapping", Range);
2959 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2960 Range);
2961 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2962 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002963 }
2964 LastRange = ConstantRange(LowV, HighV);
2965 }
2966 if (NumRanges > 2) {
2967 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002968 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002969 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002970 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002971 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002972 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2973 "Intervals are overlapping", Range);
2974 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2975 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002976 }
2977}
2978
JF Bastiend1fb5852015-12-17 22:09:19 +00002979void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2980 const Instruction *I) {
2981 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2982 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2983 Assert(!(Size & (Size - 1)),
2984 "atomic memory access' operand must have a power-of-two size", Ty, I);
2985}
2986
Chris Lattner069a7952002-06-25 15:56:27 +00002987void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002988 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002989 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002990 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002991 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2992 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00002993 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002994 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00002995 Assert(LI.getOrdering() != AtomicOrdering::Release &&
2996 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002997 "Load cannot have Release ordering", &LI);
2998 Assert(LI.getAlignment() != 0,
2999 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003000 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3001 ElTy->isFloatingPointTy(),
3002 "atomic load operand must have integer, pointer, or floating point "
3003 "type!",
3004 ElTy, &LI);
3005 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003006 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003007 Assert(LI.getSynchScope() == CrossThread,
3008 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003009 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003010
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003011 visitInstruction(LI);
3012}
3013
Chris Lattner069a7952002-06-25 15:56:27 +00003014void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003015 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003016 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003017 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003018 Assert(ElTy == SI.getOperand(0)->getType(),
3019 "Stored value type does not match pointer operand type!", &SI, ElTy);
3020 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3021 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003022 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003023 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003024 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3025 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003026 "Store cannot have Acquire ordering", &SI);
3027 Assert(SI.getAlignment() != 0,
3028 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003029 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3030 ElTy->isFloatingPointTy(),
3031 "atomic store operand must have integer, pointer, or floating point "
3032 "type!",
3033 ElTy, &SI);
3034 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003035 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003036 Assert(SI.getSynchScope() == CrossThread,
3037 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003038 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003039 visitInstruction(SI);
3040}
3041
Manman Ren9bfd0d02016-04-01 21:41:15 +00003042/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3043void Verifier::verifySwiftErrorCallSite(CallSite CS,
3044 const Value *SwiftErrorVal) {
3045 unsigned Idx = 0;
3046 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3047 I != E; ++I, ++Idx) {
3048 if (*I == SwiftErrorVal) {
3049 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3050 "swifterror value when used in a callsite should be marked "
3051 "with swifterror attribute",
3052 SwiftErrorVal, CS);
3053 }
3054 }
3055}
3056
3057void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3058 // Check that swifterror value is only used by loads, stores, or as
3059 // a swifterror argument.
3060 for (const User *U : SwiftErrorVal->users()) {
3061 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3062 isa<InvokeInst>(U),
3063 "swifterror value can only be loaded and stored from, or "
3064 "as a swifterror argument!",
3065 SwiftErrorVal, U);
3066 // If it is used by a store, check it is the second operand.
3067 if (auto StoreI = dyn_cast<StoreInst>(U))
3068 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3069 "swifterror value should be the second operand when used "
3070 "by stores", SwiftErrorVal, U);
3071 if (auto CallI = dyn_cast<CallInst>(U))
3072 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3073 if (auto II = dyn_cast<InvokeInst>(U))
3074 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3075 }
3076}
3077
Victor Hernandez8acf2952009-10-23 21:09:37 +00003078void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003079 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003080 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003081 Assert(PTy->getAddressSpace() == 0,
3082 "Allocation instruction pointer not in the generic address space!",
3083 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003084 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003085 "Cannot allocate unsized type", &AI);
3086 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3087 "Alloca array size must have integer type", &AI);
3088 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3089 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003090
Manman Ren9bfd0d02016-04-01 21:41:15 +00003091 if (AI.isSwiftError()) {
3092 verifySwiftErrorValue(&AI);
3093 }
3094
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003095 visitInstruction(AI);
3096}
3097
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003098void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003099
3100 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003101 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003102 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003103 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003104 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003105 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003106 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003107 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003108 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003109 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3110 "cmpxchg instructions failure argument shall be no stronger than the "
3111 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003112 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003113 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3114 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003115 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003116
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003117 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003118 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003119 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003120 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3121 "cmpxchg operand must have integer or pointer type",
3122 ElTy, &CXI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003123 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003124 Assert(ElTy == CXI.getOperand(1)->getType(),
3125 "Expected value type does not match pointer operand type!", &CXI,
3126 ElTy);
3127 Assert(ElTy == CXI.getOperand(2)->getType(),
3128 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003129 visitInstruction(CXI);
3130}
3131
3132void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003133 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003134 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003135 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003136 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003137 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003138 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003139 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003140 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3141 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00003142 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003143 Assert(ElTy == RMWI.getOperand(1)->getType(),
3144 "Argument value type does not match pointer operand type!", &RMWI,
3145 ElTy);
3146 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3147 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3148 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003149 visitInstruction(RMWI);
3150}
3151
Eli Friedmanfee02c62011-07-25 23:16:38 +00003152void Verifier::visitFenceInst(FenceInst &FI) {
3153 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003154 Assert(Ordering == AtomicOrdering::Acquire ||
3155 Ordering == AtomicOrdering::Release ||
3156 Ordering == AtomicOrdering::AcquireRelease ||
3157 Ordering == AtomicOrdering::SequentiallyConsistent,
3158 "fence instructions may only have acquire, release, acq_rel, or "
3159 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003160 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003161 visitInstruction(FI);
3162}
3163
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003164void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003165 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3166 EVI.getIndices()) == EVI.getType(),
3167 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003168
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003169 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003170}
3171
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003172void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003173 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3174 IVI.getIndices()) ==
3175 IVI.getOperand(1)->getType(),
3176 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003177
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003178 visitInstruction(IVI);
3179}
Chris Lattner0e851da2002-04-18 20:37:37 +00003180
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003181static Value *getParentPad(Value *EHPad) {
3182 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3183 return FPI->getParentPad();
3184
3185 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3186}
3187
David Majnemer85a549d2015-08-11 02:48:30 +00003188void Verifier::visitEHPadPredecessors(Instruction &I) {
3189 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003190
David Majnemer85a549d2015-08-11 02:48:30 +00003191 BasicBlock *BB = I.getParent();
3192 Function *F = BB->getParent();
3193
3194 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3195
3196 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3197 // The landingpad instruction defines its parent as a landing pad block. The
3198 // landing pad block may be branched to only by the unwind edge of an
3199 // invoke.
3200 for (BasicBlock *PredBB : predecessors(BB)) {
3201 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3202 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3203 "Block containing LandingPadInst must be jumped to "
3204 "only by the unwind edge of an invoke.",
3205 LPI);
3206 }
3207 return;
3208 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003209 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3210 if (!pred_empty(BB))
3211 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3212 "Block containg CatchPadInst must be jumped to "
3213 "only by its catchswitch.",
3214 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003215 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3216 "Catchswitch cannot unwind to one of its catchpads",
3217 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003218 return;
3219 }
David Majnemer85a549d2015-08-11 02:48:30 +00003220
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003221 // Verify that each pred has a legal terminator with a legal to/from EH
3222 // pad relationship.
3223 Instruction *ToPad = &I;
3224 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003225 for (BasicBlock *PredBB : predecessors(BB)) {
3226 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003227 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003228 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003229 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003230 "EH pad must be jumped to via an unwind edge", ToPad, II);
3231 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3232 FromPad = Bundle->Inputs[0];
3233 else
3234 FromPad = ConstantTokenNone::get(II->getContext());
3235 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003236 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003237 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3238 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3239 FromPad = CSI;
3240 } else {
3241 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3242 }
3243
3244 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003245 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003246 for (;; FromPad = getParentPad(FromPad)) {
3247 Assert(FromPad != ToPad,
3248 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3249 if (FromPad == ToPadParent) {
3250 // This is a legal unwind edge.
3251 break;
3252 }
3253 Assert(!isa<ConstantTokenNone>(FromPad),
3254 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003255 Assert(Seen.insert(FromPad).second,
3256 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003257 }
David Majnemer85a549d2015-08-11 02:48:30 +00003258 }
3259}
3260
3261void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003262 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3263 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003264 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3265 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003266
David Majnemer85a549d2015-08-11 02:48:30 +00003267 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003268
David Majnemer654e1302015-07-31 17:58:14 +00003269 if (!LandingPadResultTy)
3270 LandingPadResultTy = LPI.getType();
3271 else
3272 Assert(LandingPadResultTy == LPI.getType(),
3273 "The landingpad instruction should have a consistent result type "
3274 "inside a function.",
3275 &LPI);
3276
David Majnemer7fddecc2015-06-17 20:52:32 +00003277 Function *F = LPI.getParent()->getParent();
3278 Assert(F->hasPersonalityFn(),
3279 "LandingPadInst needs to be in a function with a personality.", &LPI);
3280
Bill Wendlingfae14752011-08-12 20:24:12 +00003281 // The landingpad instruction must be the first non-PHI instruction in the
3282 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003283 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3284 "LandingPadInst not the first non-PHI instruction in the block.",
3285 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003286
Duncan Sands86de1a62011-09-27 16:43:19 +00003287 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003288 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003289 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003290 Assert(isa<PointerType>(Clause->getType()),
3291 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003292 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003293 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3294 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3295 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003296 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003297 }
3298
Bill Wendlingfae14752011-08-12 20:24:12 +00003299 visitInstruction(LPI);
3300}
3301
David Majnemerba6665d2016-08-01 18:06:34 +00003302void Verifier::visitResumeInst(ResumeInst &RI) {
3303 Assert(RI.getFunction()->hasPersonalityFn(),
3304 "ResumeInst needs to be in a function with a personality.", &RI);
3305
3306 if (!LandingPadResultTy)
3307 LandingPadResultTy = RI.getValue()->getType();
3308 else
3309 Assert(LandingPadResultTy == RI.getValue()->getType(),
3310 "The resume instruction should have a consistent result type "
3311 "inside a function.",
3312 &RI);
3313
3314 visitTerminatorInst(RI);
3315}
3316
David Majnemer654e1302015-07-31 17:58:14 +00003317void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003318 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003319
David Majnemer654e1302015-07-31 17:58:14 +00003320 Function *F = BB->getParent();
3321 Assert(F->hasPersonalityFn(),
3322 "CatchPadInst needs to be in a function with a personality.", &CPI);
3323
David Majnemer8a1c45d2015-12-12 05:38:55 +00003324 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3325 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3326 CPI.getParentPad());
3327
David Majnemer654e1302015-07-31 17:58:14 +00003328 // The catchpad instruction must be the first non-PHI instruction in the
3329 // block.
3330 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003331 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003332
David Majnemerfe2f7f32016-02-29 22:56:36 +00003333 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003334 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003335}
3336
David Majnemer8a1c45d2015-12-12 05:38:55 +00003337void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3338 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3339 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3340 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003341
David Majnemer8a1c45d2015-12-12 05:38:55 +00003342 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003343}
3344
3345void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3346 BasicBlock *BB = CPI.getParent();
3347
David Majnemer654e1302015-07-31 17:58:14 +00003348 Function *F = BB->getParent();
3349 Assert(F->hasPersonalityFn(),
3350 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3351
3352 // The cleanuppad instruction must be the first non-PHI instruction in the
3353 // block.
3354 Assert(BB->getFirstNonPHI() == &CPI,
3355 "CleanupPadInst not the first non-PHI instruction in the block.",
3356 &CPI);
3357
David Majnemer8a1c45d2015-12-12 05:38:55 +00003358 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003359 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003360 "CleanupPadInst has an invalid parent.", &CPI);
3361
David Majnemerfe2f7f32016-02-29 22:56:36 +00003362 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003363 visitFuncletPadInst(CPI);
3364}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003365
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003366void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3367 User *FirstUser = nullptr;
3368 Value *FirstUnwindPad = nullptr;
3369 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003370 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003371
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003372 while (!Worklist.empty()) {
3373 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003374 Assert(Seen.insert(CurrentPad).second,
3375 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003376 Value *UnresolvedAncestorPad = nullptr;
3377 for (User *U : CurrentPad->users()) {
3378 BasicBlock *UnwindDest;
3379 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3380 UnwindDest = CRI->getUnwindDest();
3381 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3382 // We allow catchswitch unwind to caller to nest
3383 // within an outer pad that unwinds somewhere else,
3384 // because catchswitch doesn't have a nounwind variant.
3385 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3386 if (CSI->unwindsToCaller())
3387 continue;
3388 UnwindDest = CSI->getUnwindDest();
3389 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3390 UnwindDest = II->getUnwindDest();
3391 } else if (isa<CallInst>(U)) {
3392 // Calls which don't unwind may be found inside funclet
3393 // pads that unwind somewhere else. We don't *require*
3394 // such calls to be annotated nounwind.
3395 continue;
3396 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3397 // The unwind dest for a cleanup can only be found by
3398 // recursive search. Add it to the worklist, and we'll
3399 // search for its first use that determines where it unwinds.
3400 Worklist.push_back(CPI);
3401 continue;
3402 } else {
3403 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3404 continue;
3405 }
3406
3407 Value *UnwindPad;
3408 bool ExitsFPI;
3409 if (UnwindDest) {
3410 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003411 if (!cast<Instruction>(UnwindPad)->isEHPad())
3412 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003413 Value *UnwindParent = getParentPad(UnwindPad);
3414 // Ignore unwind edges that don't exit CurrentPad.
3415 if (UnwindParent == CurrentPad)
3416 continue;
3417 // Determine whether the original funclet pad is exited,
3418 // and if we are scanning nested pads determine how many
3419 // of them are exited so we can stop searching their
3420 // children.
3421 Value *ExitedPad = CurrentPad;
3422 ExitsFPI = false;
3423 do {
3424 if (ExitedPad == &FPI) {
3425 ExitsFPI = true;
3426 // Now we can resolve any ancestors of CurrentPad up to
3427 // FPI, but not including FPI since we need to make sure
3428 // to check all direct users of FPI for consistency.
3429 UnresolvedAncestorPad = &FPI;
3430 break;
3431 }
3432 Value *ExitedParent = getParentPad(ExitedPad);
3433 if (ExitedParent == UnwindParent) {
3434 // ExitedPad is the ancestor-most pad which this unwind
3435 // edge exits, so we can resolve up to it, meaning that
3436 // ExitedParent is the first ancestor still unresolved.
3437 UnresolvedAncestorPad = ExitedParent;
3438 break;
3439 }
3440 ExitedPad = ExitedParent;
3441 } while (!isa<ConstantTokenNone>(ExitedPad));
3442 } else {
3443 // Unwinding to caller exits all pads.
3444 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3445 ExitsFPI = true;
3446 UnresolvedAncestorPad = &FPI;
3447 }
3448
3449 if (ExitsFPI) {
3450 // This unwind edge exits FPI. Make sure it agrees with other
3451 // such edges.
3452 if (FirstUser) {
3453 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3454 "pad must have the same unwind "
3455 "dest",
3456 &FPI, U, FirstUser);
3457 } else {
3458 FirstUser = U;
3459 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003460 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3461 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3462 getParentPad(UnwindPad) == getParentPad(&FPI))
3463 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003464 }
3465 }
3466 // Make sure we visit all uses of FPI, but for nested pads stop as
3467 // soon as we know where they unwind to.
3468 if (CurrentPad != &FPI)
3469 break;
3470 }
3471 if (UnresolvedAncestorPad) {
3472 if (CurrentPad == UnresolvedAncestorPad) {
3473 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3474 // we've found an unwind edge that exits it, because we need to verify
3475 // all direct uses of FPI.
3476 assert(CurrentPad == &FPI);
3477 continue;
3478 }
3479 // Pop off the worklist any nested pads that we've found an unwind
3480 // destination for. The pads on the worklist are the uncles,
3481 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3482 // for all ancestors of CurrentPad up to but not including
3483 // UnresolvedAncestorPad.
3484 Value *ResolvedPad = CurrentPad;
3485 while (!Worklist.empty()) {
3486 Value *UnclePad = Worklist.back();
3487 Value *AncestorPad = getParentPad(UnclePad);
3488 // Walk ResolvedPad up the ancestor list until we either find the
3489 // uncle's parent or the last resolved ancestor.
3490 while (ResolvedPad != AncestorPad) {
3491 Value *ResolvedParent = getParentPad(ResolvedPad);
3492 if (ResolvedParent == UnresolvedAncestorPad) {
3493 break;
3494 }
3495 ResolvedPad = ResolvedParent;
3496 }
3497 // If the resolved ancestor search didn't find the uncle's parent,
3498 // then the uncle is not yet resolved.
3499 if (ResolvedPad != AncestorPad)
3500 break;
3501 // This uncle is resolved, so pop it from the worklist.
3502 Worklist.pop_back();
3503 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003504 }
3505 }
3506
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003507 if (FirstUnwindPad) {
3508 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3509 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3510 Value *SwitchUnwindPad;
3511 if (SwitchUnwindDest)
3512 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3513 else
3514 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3515 Assert(SwitchUnwindPad == FirstUnwindPad,
3516 "Unwind edges out of a catch must have the same unwind dest as "
3517 "the parent catchswitch",
3518 &FPI, FirstUser, CatchSwitch);
3519 }
3520 }
3521
3522 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003523}
3524
David Majnemer8a1c45d2015-12-12 05:38:55 +00003525void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003526 BasicBlock *BB = CatchSwitch.getParent();
3527
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003528 Function *F = BB->getParent();
3529 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003530 "CatchSwitchInst needs to be in a function with a personality.",
3531 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003532
David Majnemer8a1c45d2015-12-12 05:38:55 +00003533 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003534 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003535 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3536 "CatchSwitchInst not the first non-PHI instruction in the block.",
3537 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003538
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003539 auto *ParentPad = CatchSwitch.getParentPad();
3540 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3541 "CatchSwitchInst has an invalid parent.", ParentPad);
3542
David Majnemer8a1c45d2015-12-12 05:38:55 +00003543 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003544 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003545 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3546 "CatchSwitchInst must unwind to an EH block which is not a "
3547 "landingpad.",
3548 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003549
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003550 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3551 if (getParentPad(I) == ParentPad)
3552 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3553 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003554
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003555 Assert(CatchSwitch.getNumHandlers() != 0,
3556 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3557
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003558 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003559 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3560 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003561 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003562
David Majnemerfe2f7f32016-02-29 22:56:36 +00003563 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003564 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003565}
3566
David Majnemer654e1302015-07-31 17:58:14 +00003567void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003568 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3569 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3570 CRI.getOperand(0));
3571
David Majnemer654e1302015-07-31 17:58:14 +00003572 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3573 Instruction *I = UnwindDest->getFirstNonPHI();
3574 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3575 "CleanupReturnInst must unwind to an EH block which is not a "
3576 "landingpad.",
3577 &CRI);
3578 }
3579
3580 visitTerminatorInst(CRI);
3581}
3582
Rafael Espindola654320a2012-02-26 02:23:37 +00003583void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3584 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003585 // If the we have an invalid invoke, don't try to compute the dominance.
3586 // We already reject it in the invoke specific checks and the dominance
3587 // computation doesn't handle multiple edges.
3588 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3589 if (II->getNormalDest() == II->getUnwindDest())
3590 return;
3591 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003592
Michael Kruseff379b62016-03-26 23:32:57 +00003593 // Quick check whether the def has already been encountered in the same block.
3594 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3595 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003596 //
3597 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3598 // wrapping an SSA value, assert that we've already encountered it. See
3599 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003600 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3601 return;
3602
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003603 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003604 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003605 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003606}
3607
Artur Pilipenkocca80022015-10-09 17:41:29 +00003608void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3609 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3610 "apply only to pointer types", &I);
3611 Assert(isa<LoadInst>(I),
3612 "dereferenceable, dereferenceable_or_null apply only to load"
3613 " instructions, use attributes for calls or invokes", &I);
3614 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3615 "take one operand!", &I);
3616 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3617 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3618 "dereferenceable_or_null metadata value must be an i64!", &I);
3619}
3620
Misha Brukmanc566ca362004-03-02 00:22:19 +00003621/// verifyInstruction - Verify that an instruction is well formed.
3622///
Chris Lattner069a7952002-06-25 15:56:27 +00003623void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003624 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003625 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003626
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003627 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003628 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003629 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3630 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003631 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003632 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003633
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003634 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003635 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3636 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003637
Chris Lattner5f126b72004-03-29 00:29:36 +00003638 // Check that the return value of the instruction is either void or a legal
3639 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003640 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3641 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003642
Nick Lewycky93e06a52009-09-27 23:27:42 +00003643 // Check that the instruction doesn't produce metadata. Calls are already
3644 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003645 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3646 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003647
Chris Lattner0e851da2002-04-18 20:37:37 +00003648 // Check that all uses of the instruction, if they are instructions
3649 // themselves, actually have parent basic blocks. If the use is not an
3650 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003651 for (Use &U : I.uses()) {
3652 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003653 Assert(Used->getParent() != nullptr,
3654 "Instruction referencing"
3655 " instruction not embedded in a basic block!",
3656 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003657 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003658 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003659 return;
3660 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003661 }
3662
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003663 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003664 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003665
3666 // Check to make sure that only first-class-values are operands to
3667 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003668 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003669 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003670 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003671
Chris Lattner9ece94b2004-03-14 03:23:54 +00003672 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003673 // Check to make sure that the "address of" an intrinsic function is never
3674 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003675 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003676 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003677 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3678 "Cannot take the address of an intrinsic!", &I);
3679 Assert(
3680 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003681 F->getIntrinsicID() == Intrinsic::donothing ||
3682 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003683 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3684 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Sanjoy Das999dc752016-02-29 22:04:25 +00003685 "Cannot invoke an intrinsic other than donothing, patchpoint or "
3686 "statepoint",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003687 &I);
3688 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003689 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003690 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003691 Assert(OpBB->getParent() == BB->getParent(),
3692 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003693 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003694 Assert(OpArg->getParent() == BB->getParent(),
3695 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003696 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003697 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003698 } else if (isa<Instruction>(I.getOperand(i))) {
3699 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003700 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003701 Assert((i + 1 == e && isa<CallInst>(I)) ||
3702 (i + 3 == e && isa<InvokeInst>(I)),
3703 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003704 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3705 if (CE->getType()->isPtrOrPtrVectorTy()) {
3706 // If we have a ConstantExpr pointer, we need to see if it came from an
3707 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003708 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003709 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003710 }
3711 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003712
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003713 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003714 Assert(I.getType()->isFPOrFPVectorTy(),
3715 "fpmath requires a floating point result!", &I);
3716 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003717 if (ConstantFP *CFP0 =
3718 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003719 const APFloat &Accuracy = CFP0->getValueAPF();
Matt Arsenault82f41512016-06-27 19:43:15 +00003720 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle,
3721 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003722 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3723 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003724 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003725 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003726 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003727 }
3728
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003729 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003730 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3731 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003732 visitRangeMetadata(I, Range, I.getType());
3733 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003734
Philip Reames0ca58b32014-10-21 20:56:29 +00003735 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003736 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3737 &I);
3738 Assert(isa<LoadInst>(I),
3739 "nonnull applies only to load instructions, use attributes"
3740 " for calls or invokes",
3741 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003742 }
3743
Artur Pilipenkocca80022015-10-09 17:41:29 +00003744 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3745 visitDereferenceableMetadata(I, MD);
3746
3747 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3748 visitDereferenceableMetadata(I, MD);
3749
3750 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3751 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3752 &I);
3753 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3754 "use attributes for calls or invokes", &I);
3755 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3756 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3757 Assert(CI && CI->getType()->isIntegerTy(64),
3758 "align metadata value must be an i64!", &I);
3759 uint64_t Align = CI->getZExtValue();
3760 Assert(isPowerOf2_64(Align),
3761 "align metadata value must be a power of 2!", &I);
3762 Assert(Align <= Value::MaximumAlignment,
3763 "alignment is larger that implementation defined limit", &I);
3764 }
3765
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003766 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003767 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003768 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003769 }
3770
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003771 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3772 verifyBitPieceExpression(*DII);
3773
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003774 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003775}
3776
Philip Reames007561a2015-06-26 22:21:52 +00003777/// Allow intrinsics to be verified in different ways.
3778void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003779 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003780 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3781 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003782
Chris Lattner144b6192012-05-27 19:37:05 +00003783 // Verify that the intrinsic prototype lines up with what the .td files
3784 // describe.
3785 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003786 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003787
Chris Lattner144b6192012-05-27 19:37:05 +00003788 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3789 getIntrinsicInfoTableEntries(ID, Table);
3790 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003791
Chris Lattner144b6192012-05-27 19:37:05 +00003792 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003793 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3794 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003795 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003796 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003797 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3798 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003799 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003800
3801 // Verify if the intrinsic call matches the vararg property.
3802 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003803 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003804 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003805 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003806 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003807 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003808
3809 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003810 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003811
3812 // Now that we have the intrinsic ID and the actual argument types (and we
3813 // know they are legal for the intrinsic!) get the intrinsic name through the
3814 // usual means. This allows us to verify the mangling of argument types into
3815 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003816 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003817 Assert(ExpectedName == IF->getName(),
3818 "Intrinsic name not mangled correctly for type arguments! "
3819 "Should be: " +
3820 ExpectedName,
3821 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003822
Chris Lattner588096e2009-12-28 09:07:21 +00003823 // If the intrinsic takes MDNode arguments, verify that they are either global
3824 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003825 for (Value *V : CS.args())
3826 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3827 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003828
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003829 switch (ID) {
3830 default:
3831 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003832 case Intrinsic::ctlz: // llvm.ctlz
3833 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003834 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003835 "is_zero_undef argument of bit counting intrinsics must be a "
3836 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003837 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003838 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003839 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003840 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3841 "invalid llvm.dbg.declare intrinsic call 1", CS);
3842 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003843 break;
3844 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003845 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003846 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003847 case Intrinsic::memcpy:
3848 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003849 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003850 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003851 Assert(AlignCI,
3852 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003853 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003854 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003855 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003856 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003857 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003858 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003859 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003860 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003861 }
Bill Wendling05604e02008-08-23 09:46:46 +00003862 case Intrinsic::gcroot:
3863 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003864 case Intrinsic::gcread:
3865 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003866 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003867 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3868 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3869 Assert(isa<Constant>(CS.getArgOperand(1)),
3870 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003871 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003872 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003873 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3874 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003875 CS);
Talin2e59f142010-09-30 20:23:47 +00003876 }
Chris Lattner25852062008-08-24 20:46:13 +00003877 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003878
Philip Reames9818dd72015-06-26 22:04:34 +00003879 Assert(CS.getParent()->getParent()->hasGC(),
3880 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003881 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003882 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003883 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003884 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003885 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003886 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003887 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003888 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3889 isa<ConstantInt>(CS.getArgOperand(2)) &&
3890 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3891 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3892 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003893 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003894 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003895 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3896 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003897 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003898 case Intrinsic::lifetime_start:
3899 case Intrinsic::lifetime_end:
3900 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003901 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003902 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003903 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003904 break;
3905 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003906 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3907 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003908 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003909
Reid Kleckner60381792015-07-07 22:25:32 +00003910 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003911 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003912 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003913 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003914 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003915 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003916 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003917 if (isa<ConstantPointerNull>(Arg))
3918 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003919 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003920 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003921 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003922 }
Philip Reames9818dd72015-06-26 22:04:34 +00003923 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003924 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003925 break;
3926 }
Reid Kleckner60381792015-07-07 22:25:32 +00003927 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003928 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003929 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003930 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003931 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003932 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003933 CS);
3934 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003935 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003936 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003937 auto &Entry = FrameEscapeInfo[Fn];
3938 Entry.second = unsigned(
3939 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003940 break;
3941 }
3942
Philip Reames1ffa9372015-01-30 23:28:05 +00003943 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00003944 Assert(!CS.isInlineAsm(),
3945 "gc.statepoint support for inline assembly unimplemented", CS);
3946 Assert(CS.getParent()->getParent()->hasGC(),
3947 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00003948
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003949 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003950 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003951 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00003952 Assert(CS.getParent()->getParent()->hasGC(),
3953 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003954 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00003955 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00003956 const Function *StatepointFn =
3957 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003958 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3959 StatepointFn->getIntrinsicID() ==
3960 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00003961 "gc.result operand #1 must be from a statepoint", CS,
3962 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00003963
Philip Reamesb23713a2014-12-03 22:23:24 +00003964 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00003965 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00003966 auto *PT = cast<PointerType>(Target->getType());
3967 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00003968 Assert(CS.getType() == TargetFuncType->getReturnType(),
3969 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00003970 break;
3971 }
3972 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00003973 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003974
Philip Reames3e2cf532016-01-07 03:32:11 +00003975 Assert(isa<PointerType>(CS.getType()->getScalarType()),
3976 "gc.relocate must return a pointer or a vector of pointers", CS);
3977
Igor Laevsky9570ff92015-02-19 11:28:47 +00003978 // Check that this relocate is correctly tied to the statepoint
3979
3980 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00003981 if (LandingPadInst *LandingPad =
3982 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00003983
Sanjoy Das5665c992015-05-11 23:47:27 +00003984 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00003985 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00003986
3987 // Landingpad relocates should have only one predecessor with invoke
3988 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00003989 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00003990 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00003991 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3992 InvokeBB);
3993 Assert(isStatepoint(InvokeBB->getTerminator()),
3994 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00003995 }
3996 else {
3997 // In all other cases relocate should be tied to the statepoint directly.
3998 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003999 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004000 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004001 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004002 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004003 }
4004
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004005 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004006
Manuel Jacob83eefa62016-01-05 04:03:00 +00004007 ImmutableCallSite StatepointCS(
4008 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004009
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004010 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004011 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004012 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004013 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004014
Philip Reames9818dd72015-06-26 22:04:34 +00004015 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004016 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004017 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004018
4019 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4020 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4021 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004022 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004023 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004024 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004025 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004026
4027 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004028 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004029 Assert(StatepointCS.arg_size() > 0,
4030 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004031 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004032 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004033 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004034 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4035 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004036 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004037 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004038 "gc.statepoint: number of transition arguments must be "
4039 "a constant integer");
4040 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004041 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4042 ->getZExtValue();
4043 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004044 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004045 "gc.statepoint: number of deoptimization arguments must be "
4046 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004047 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004048 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4049 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004050 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004051 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004052 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4053 "gc.relocate: statepoint base index doesn't fall within the "
4054 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004055 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004056 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4057 "gc.relocate: statepoint derived index doesn't fall within the "
4058 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004059 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004060
Philip Reames3e2cf532016-01-07 03:32:11 +00004061 // Relocated value must be either a pointer type or vector-of-pointer type,
4062 // but gc_relocate does not need to return the same pointer type as the
4063 // relocated pointer. It can be casted to the correct type later if it's
4064 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004065 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004066 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004067 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004068
Philip Reames3e2cf532016-01-07 03:32:11 +00004069 auto ResultType = CS.getType();
4070 auto DerivedType = Relocate.getDerivedPtr()->getType();
4071 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004072 "gc.relocate: vector relocates to vector and pointer to pointer",
4073 CS);
4074 Assert(
4075 ResultType->getPointerAddressSpace() ==
4076 DerivedType->getPointerAddressSpace(),
4077 "gc.relocate: relocating a pointer shouldn't change its address space",
4078 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004079 break;
4080 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004081 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004082 case Intrinsic::eh_exceptionpointer: {
4083 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4084 "eh.exceptionpointer argument must be a catchpad", CS);
4085 break;
4086 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004087 case Intrinsic::masked_load: {
4088 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4089
4090 Value *Ptr = CS.getArgOperand(0);
4091 //Value *Alignment = CS.getArgOperand(1);
4092 Value *Mask = CS.getArgOperand(2);
4093 Value *PassThru = CS.getArgOperand(3);
4094 Assert(Mask->getType()->isVectorTy(),
4095 "masked_load: mask must be vector", CS);
4096
4097 // DataTy is the overloaded type
4098 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4099 Assert(DataTy == CS.getType(),
4100 "masked_load: return must match pointer type", CS);
4101 Assert(PassThru->getType() == DataTy,
4102 "masked_load: pass through and data type must match", CS);
4103 Assert(Mask->getType()->getVectorNumElements() ==
4104 DataTy->getVectorNumElements(),
4105 "masked_load: vector mask must be same length as data", CS);
4106 break;
4107 }
4108 case Intrinsic::masked_store: {
4109 Value *Val = CS.getArgOperand(0);
4110 Value *Ptr = CS.getArgOperand(1);
4111 //Value *Alignment = CS.getArgOperand(2);
4112 Value *Mask = CS.getArgOperand(3);
4113 Assert(Mask->getType()->isVectorTy(),
4114 "masked_store: mask must be vector", CS);
4115
4116 // DataTy is the overloaded type
4117 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4118 Assert(DataTy == Val->getType(),
4119 "masked_store: storee must match pointer type", CS);
4120 Assert(Mask->getType()->getVectorNumElements() ==
4121 DataTy->getVectorNumElements(),
4122 "masked_store: vector mask must be same length as data", CS);
4123 break;
4124 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004125
Sanjoy Das021de052016-03-31 00:18:46 +00004126 case Intrinsic::experimental_guard: {
4127 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4128 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4129 "experimental_guard must have exactly one "
4130 "\"deopt\" operand bundle");
4131 break;
4132 }
4133
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004134 case Intrinsic::experimental_deoptimize: {
4135 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4136 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4137 "experimental_deoptimize must have exactly one "
4138 "\"deopt\" operand bundle");
4139 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4140 "experimental_deoptimize return type must match caller return type");
4141
4142 if (CS.isCall()) {
4143 auto *DeoptCI = CS.getInstruction();
4144 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4145 Assert(RI,
4146 "calls to experimental_deoptimize must be followed by a return");
4147
4148 if (!CS.getType()->isVoidTy() && RI)
4149 Assert(RI->getReturnValue() == DeoptCI,
4150 "calls to experimental_deoptimize must be followed by a return "
4151 "of the value computed by experimental_deoptimize");
4152 }
4153
4154 break;
4155 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004156 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004157}
4158
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004159/// \brief Carefully grab the subprogram from a local scope.
4160///
4161/// This carefully grabs the subprogram from a local scope, avoiding the
4162/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004163static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004164 if (!LocalScope)
4165 return nullptr;
4166
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004167 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004168 return SP;
4169
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004170 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004171 return getSubprogram(LB->getRawScope());
4172
4173 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004174 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004175 return nullptr;
4176}
4177
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004178template <class DbgIntrinsicTy>
4179void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4180 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004181 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004182 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4183 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004184 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004185 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4186 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004187 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004188 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4189 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004190
4191 // Ignore broken !dbg attachments; they're checked elsewhere.
4192 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004193 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004194 return;
4195
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004196 BasicBlock *BB = DII.getParent();
4197 Function *F = BB ? BB->getParent() : nullptr;
4198
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004199 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004200 DILocalVariable *Var = DII.getVariable();
4201 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004202 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4203 &DII, BB, F);
4204
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004205 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4206 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004207 if (!VarSP || !LocSP)
4208 return; // Broken scope chains are checked elsewhere.
4209
4210 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4211 " variable and !dbg attachment",
4212 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4213 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004214}
4215
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004216static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004217 // Be careful of broken types (checked elsewhere).
4218 const Metadata *RawType = V.getRawType();
4219 while (RawType) {
4220 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004221 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004222 if (uint64_t Size = T->getSizeInBits())
4223 return Size;
4224
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004225 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004226 // Look at the base type.
4227 RawType = DT->getRawBaseType();
4228 continue;
4229 }
4230
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004231 // Missing type or size.
4232 break;
4233 }
4234
4235 // Fail gracefully.
4236 return 0;
4237}
4238
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004239void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004240 DILocalVariable *V;
4241 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004242 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004243 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4244 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004245 } else {
4246 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004247 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4248 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004249 }
4250
4251 // We don't know whether this intrinsic verified correctly.
4252 if (!V || !E || !E->isValid())
4253 return;
4254
Keno Fischer253a7bd2016-01-15 02:12:38 +00004255 // Nothing to do if this isn't a bit piece expression.
4256 if (!E->isBitPiece())
4257 return;
4258
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004259 // The frontend helps out GDB by emitting the members of local anonymous
4260 // unions as artificial local variables with shared storage. When SROA splits
4261 // the storage for artificial local variables that are smaller than the entire
4262 // union, the overhang piece will be outside of the allotted space for the
4263 // variable and this check fails.
4264 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4265 if (V->isArtificial())
4266 return;
4267
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004268 // If there's no size, the type is broken, but that should be checked
4269 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004270 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004271 if (!VarSize)
4272 return;
4273
Keno Fischer253a7bd2016-01-15 02:12:38 +00004274 unsigned PieceSize = E->getBitPieceSize();
4275 unsigned PieceOffset = E->getBitPieceOffset();
4276 Assert(PieceSize + PieceOffset <= VarSize,
4277 "piece is larger than or outside of variable", &I, V, E);
4278 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004279}
4280
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004281void Verifier::verifyCompileUnits() {
4282 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4283 SmallPtrSet<const Metadata *, 2> Listed;
4284 if (CUs)
4285 Listed.insert(CUs->op_begin(), CUs->op_end());
4286 Assert(
4287 std::all_of(CUVisited.begin(), CUVisited.end(),
4288 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
4289 "All DICompileUnits must be listed in llvm.dbg.cu");
4290 CUVisited.clear();
4291}
4292
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004293void Verifier::verifyDeoptimizeCallingConvs() {
4294 if (DeoptimizeDeclarations.empty())
4295 return;
4296
4297 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004298 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004299 Assert(First->getCallingConv() == F->getCallingConv(),
4300 "All llvm.experimental.deoptimize declarations must have the same "
4301 "calling convention",
4302 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004303 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004304}
4305
Chris Lattner0e851da2002-04-18 20:37:37 +00004306//===----------------------------------------------------------------------===//
4307// Implement the public interfaces to this file...
4308//===----------------------------------------------------------------------===//
4309
Chandler Carruth043949d2014-01-19 02:22:18 +00004310bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004311 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004312
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004313 // Don't use a raw_null_ostream. Printing IR is expensive.
Adrian Prantl541a9c52016-05-06 19:26:47 +00004314 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true);
Chandler Carruth043949d2014-01-19 02:22:18 +00004315
4316 // Note that this function's return value is inverted from what you would
4317 // expect of a function called "verify".
4318 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004319}
4320
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004321bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4322 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004323 // Don't use a raw_null_ostream. Printing IR is expensive.
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004324 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004325
Chandler Carruth043949d2014-01-19 02:22:18 +00004326 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004327 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004328 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004329
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004330 Broken |= !V.verify(M);
4331 if (BrokenDebugInfo)
4332 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004333 // Note that this function's return value is inverted from what you would
4334 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004335 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004336}
Chandler Carruth043949d2014-01-19 02:22:18 +00004337
4338namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004339struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004340 static char ID;
4341
4342 Verifier V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004343 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004344
Adrian Prantl541a9c52016-05-06 19:26:47 +00004345 VerifierLegacyPass()
4346 : FunctionPass(ID),
Adrian Prantl94a903e2016-05-25 21:33:20 +00004347 V(&dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004348 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004349 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004350 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004351 : FunctionPass(ID),
Adrian Prantl94a903e2016-05-25 21:33:20 +00004352 V(&dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004353 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004354 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004355 }
4356
Craig Topperf398d7c2014-03-05 06:35:38 +00004357 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004358 if (!V.verify(F) && FatalErrors)
4359 report_fatal_error("Broken function found, compilation aborted!");
4360
4361 return false;
4362 }
4363
Craig Topperf398d7c2014-03-05 06:35:38 +00004364 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004365 bool HasErrors = false;
4366 for (Function &F : M)
4367 if (F.isDeclaration())
4368 HasErrors |= !V.verify(F);
4369
4370 HasErrors |= !V.verify(M);
Adrian Prantl94a903e2016-05-25 21:33:20 +00004371 if (FatalErrors) {
4372 if (HasErrors)
4373 report_fatal_error("Broken module found, compilation aborted!");
4374 assert(!V.hasBrokenDebugInfo() && "Module contains invalid debug info");
4375 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004376
Adrian Prantl94a903e2016-05-25 21:33:20 +00004377 // Strip broken debug info.
4378 if (V.hasBrokenDebugInfo()) {
4379 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4380 M.getContext().diagnose(DiagInvalid);
4381 if (!StripDebugInfo(M))
4382 report_fatal_error("Failed to strip malformed debug info");
4383 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004384 return false;
4385 }
4386
4387 void getAnalysisUsage(AnalysisUsage &AU) const override {
4388 AU.setPreservesAll();
4389 }
4390};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004391}
Chandler Carruth043949d2014-01-19 02:22:18 +00004392
Chandler Carruth4d356312014-01-20 11:34:08 +00004393char VerifierLegacyPass::ID = 0;
4394INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004395
4396FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004397 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004398}
4399
Adrian Prantle3656182016-05-09 19:57:29 +00004400char VerifierAnalysis::PassID;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004401VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4402 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004403 Result Res;
4404 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4405 return Res;
4406}
Chandler Carruth4d356312014-01-20 11:34:08 +00004407
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004408VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4409 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004410 return { llvm::verifyFunction(F, &dbgs()), false };
4411}
4412
4413PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4414 auto Res = AM.getResult<VerifierAnalysis>(M);
4415 if (FatalErrors) {
4416 if (Res.IRBroken)
4417 report_fatal_error("Broken module found, compilation aborted!");
4418 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4419 }
4420
4421 // Strip broken debug info.
4422 if (Res.DebugInfoBroken) {
4423 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4424 M.getContext().diagnose(DiagInvalid);
4425 if (!StripDebugInfo(M))
4426 report_fatal_error("Failed to strip malformed debug info");
4427 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004428 return PreservedAnalyses::all();
4429}
4430
Adrian Prantle3656182016-05-09 19:57:29 +00004431PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4432 auto res = AM.getResult<VerifierAnalysis>(F);
4433 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004434 report_fatal_error("Broken function found, compilation aborted!");
4435
4436 return PreservedAnalyses::all();
4437}