blob: 29550e2e733ad84e23571b23bacf9da54889b0ea [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 Majnemer654e1302015-07-31 17:58:14 +0000431 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000432 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000433 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000434 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000435 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000436 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000437
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000438 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000439 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
440 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000441 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000442 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000443 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000444 bool verifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000445 SmallVectorImpl<Type *> &ArgTys);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000446 bool verifyIntrinsicIsVarArg(bool isVarArg,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000447 ArrayRef<Intrinsic::IITDescriptor> &Infos);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000448 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
449 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000450 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000451 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000452 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000453 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000454 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000455 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000456
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000457 void visitConstantExprsRecursively(const Constant *EntryC);
458 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000459 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000460 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000461 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000462
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000463 void verifyBitPieceExpression(const DbgInfoIntrinsic &I);
464
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000465 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000466 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000467
468 /// Module-level verification that all @llvm.experimental.deoptimize
469 /// declarations share the same calling convention.
470 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000471};
Chris Lattner189d19f2003-11-21 20:23:48 +0000472} // End anonymous namespace
473
Adrian Prantl541a9c52016-05-06 19:26:47 +0000474/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000475#define Assert(C, ...) \
476 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000477
Adrian Prantl541a9c52016-05-06 19:26:47 +0000478/// We know that a debug info condition should be true, if not print
479/// an error message.
480#define AssertDI(C, ...) \
481 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (0)
482
483
Chris Lattnere5a22c02008-08-28 04:02:44 +0000484void Verifier::visit(Instruction &I) {
485 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000486 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000487 InstVisitor<Verifier>::visit(I);
488}
489
Keno Fischer60f82a22016-01-14 22:20:56 +0000490// Helper to recursively iterate over indirect users. By
491// returning false, the callback can ask to stop recursing
492// further.
493static void forEachUser(const Value *User,
494 SmallPtrSet<const Value *, 32> &Visited,
495 llvm::function_ref<bool(const Value *)> Callback) {
496 if (!Visited.insert(User).second)
497 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000498 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000499 if (Callback(TheNextUser))
500 forEachUser(TheNextUser, Visited, Callback);
501}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000502
Chandler Carruth043949d2014-01-19 02:22:18 +0000503void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000504 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000505 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000506
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000507 Assert(GV.getAlignment() <= Value::MaximumAlignment,
508 "huge alignment values are unsupported", &GV);
509 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
510 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000511
512 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000513 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000514 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000515 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000516 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000517
518 if (GV.isDeclarationForLinker())
519 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000520
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000521 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000522 if (const Instruction *I = dyn_cast<Instruction>(V)) {
523 if (!I->getParent() || !I->getParent()->getParent())
524 CheckFailed("Global is referenced by parentless instruction!", &GV,
525 M, I);
526 else if (I->getParent()->getParent()->getParent() != M)
527 CheckFailed("Global is referenced in a different module!", &GV,
528 M, I, I->getParent()->getParent(),
529 I->getParent()->getParent()->getParent());
530 return false;
531 } else if (const Function *F = dyn_cast<Function>(V)) {
532 if (F->getParent() != M)
533 CheckFailed("Global is used by function in a different module", &GV,
534 M, F, F->getParent());
535 return false;
536 }
537 return true;
538 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000539}
540
Chandler Carruth043949d2014-01-19 02:22:18 +0000541void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000542 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000543 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000544 "Global variable initializer type does not match global "
545 "variable type!",
546 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000547
Chris Lattner0aff0b22009-08-05 05:41:44 +0000548 // If the global has common linkage, it must have a zero initializer and
549 // cannot be constant.
550 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000551 Assert(GV.getInitializer()->isNullValue(),
552 "'common' global must have a zero initializer!", &GV);
553 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
554 &GV);
555 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000556 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000557 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000558
Nick Lewycky466d0c12011-04-08 07:30:21 +0000559 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
560 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000561 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
562 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000563 // Don't worry about emitting an error for it not being an array,
564 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000565 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000566 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
567 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000568 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000569 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000570 Assert(STy &&
571 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
572 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
573 STy->getTypeAtIndex(1) == FuncPtrTy,
574 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000575 if (STy->getNumElements() == 3) {
576 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000577 Assert(ETy->isPointerTy() &&
578 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
579 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000580 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000581 }
582 }
583
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000584 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000585 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000586 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
587 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000588 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000589 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
590 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000591 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000592 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000593 const Constant *Init = GV.getInitializer();
594 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000595 Assert(InitArray, "wrong initalizer for intrinsic global variable",
596 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000597 for (Value *Op : InitArray->operands()) {
598 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000599 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
600 isa<GlobalAlias>(V),
601 "invalid llvm.used member", V);
602 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000603 }
604 }
605 }
606 }
607
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000608 Assert(!GV.hasDLLImportStorageClass() ||
609 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
610 GV.hasAvailableExternallyLinkage(),
611 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000612
Matt Arsenault24b49c42013-07-31 17:49:08 +0000613 if (!GV.hasInitializer()) {
614 visitGlobalValue(GV);
615 return;
616 }
617
618 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000619 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000620
Chris Lattnere3400652004-12-15 20:23:49 +0000621 visitGlobalValue(GV);
622}
623
Rafael Espindola64c1e182014-06-03 02:41:57 +0000624void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
625 SmallPtrSet<const GlobalAlias*, 4> Visited;
626 Visited.insert(&GA);
627 visitAliaseeSubExpr(Visited, GA, C);
628}
629
Craig Topper71b7b682014-08-21 05:55:13 +0000630void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000631 const GlobalAlias &GA, const Constant &C) {
632 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000633 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
634 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000635
636 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000637 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000638
Sanjoy Das5ce32722016-04-08 00:48:30 +0000639 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000640 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000641 } else {
642 // Only continue verifying subexpressions of GlobalAliases.
643 // Do not recurse into global initializers.
644 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000645 }
646 }
647
648 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000649 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000650
651 for (const Use &U : C.operands()) {
652 Value *V = &*U;
653 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
654 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
655 else if (const auto *C2 = dyn_cast<Constant>(V))
656 visitAliaseeSubExpr(Visited, GA, *C2);
657 }
658}
659
Chandler Carruth043949d2014-01-19 02:22:18 +0000660void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000661 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
662 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
663 "weak_odr, or external linkage!",
664 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000665 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000666 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
667 Assert(GA.getType() == Aliasee->getType(),
668 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000669
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000670 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
671 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000672
Rafael Espindola64c1e182014-06-03 02:41:57 +0000673 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000674
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000675 visitGlobalValue(GA);
676}
677
Chandler Carruth043949d2014-01-19 02:22:18 +0000678void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000679 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000680 if (NMD.getName() == "llvm.dbg.cu") {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000681 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000682 }
683
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000684 if (!MD)
685 continue;
686
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000687 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000688 }
689}
690
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000691void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000692 // Only visit each node once. Metadata can be mutually recursive, so this
693 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000694 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000695 return;
696
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000697 switch (MD.getMetadataID()) {
698 default:
699 llvm_unreachable("Invalid MDNode subclass");
700 case Metadata::MDTupleKind:
701 break;
702#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
703 case Metadata::CLASS##Kind: \
704 visit##CLASS(cast<CLASS>(MD)); \
705 break;
706#include "llvm/IR/Metadata.def"
707 }
708
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000709 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000710 if (!Op)
711 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000712 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
713 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000714 if (auto *N = dyn_cast<MDNode>(Op)) {
715 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000716 continue;
717 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000718 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
719 visitValueAsMetadata(*V, nullptr);
720 continue;
721 }
Duncan Sands76d62172010-04-29 16:10:30 +0000722 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000723
724 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000725 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
726 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000727}
728
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000729void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000730 Assert(MD.getValue(), "Expected valid value", &MD);
731 Assert(!MD.getValue()->getType()->isMetadataTy(),
732 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000733
734 auto *L = dyn_cast<LocalAsMetadata>(&MD);
735 if (!L)
736 return;
737
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000738 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000739
740 // If this was an instruction, bb, or argument, verify that it is in the
741 // function that we expect.
742 Function *ActualF = nullptr;
743 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000744 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000745 ActualF = I->getParent()->getParent();
746 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
747 ActualF = BB->getParent();
748 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
749 ActualF = A->getParent();
750 assert(ActualF && "Unimplemented function local metadata case!");
751
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000752 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000753}
754
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000755void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000756 Metadata *MD = MDV.getMetadata();
757 if (auto *N = dyn_cast<MDNode>(MD)) {
758 visitMDNode(*N);
759 return;
760 }
761
762 // Only visit each node once. Metadata can be mutually recursive, so this
763 // avoids infinite recursion here, as well as being an optimization.
764 if (!MDNodes.insert(MD).second)
765 return;
766
767 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
768 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000769}
770
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000771static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
772static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
773static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000774
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000775template <class Ty>
776bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
777 for (Metadata *MD : N.operands()) {
778 if (MD) {
779 if (!isa<Ty>(MD))
780 return false;
781 } else {
782 if (!AllowNull)
783 return false;
784 }
785 }
786 return true;
787}
788
789template <class Ty>
790bool isValidMetadataArray(const MDTuple &N) {
791 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
792}
793
794template <class Ty>
795bool isValidMetadataNullArray(const MDTuple &N) {
796 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
797}
798
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000799void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000800 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
801 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000802 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000803 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000804}
805
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000806void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000807 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000808}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000809
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000810void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000811 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000812 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000813}
814
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000815void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000816 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
817 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000818}
819
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000820void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000821 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000822}
823
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000824void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000825 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
826 N.getTag() == dwarf::DW_TAG_unspecified_type,
827 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000828}
829
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000830void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000831 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000832 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000833
Adrian Prantl541a9c52016-05-06 19:26:47 +0000834 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
835 N.getTag() == dwarf::DW_TAG_pointer_type ||
836 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
837 N.getTag() == dwarf::DW_TAG_reference_type ||
838 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
839 N.getTag() == dwarf::DW_TAG_const_type ||
840 N.getTag() == dwarf::DW_TAG_volatile_type ||
841 N.getTag() == dwarf::DW_TAG_restrict_type ||
842 N.getTag() == dwarf::DW_TAG_member ||
843 N.getTag() == dwarf::DW_TAG_inheritance ||
844 N.getTag() == dwarf::DW_TAG_friend,
845 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000846 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000847 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
848 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000849 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000850
Adrian Prantl541a9c52016-05-06 19:26:47 +0000851 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
852 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
853 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000854}
855
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000856static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000857 return (Flags & DINode::FlagLValueReference) &&
858 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000859}
860
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000861void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
862 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000863 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000864 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000865 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
866 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000867 }
868}
869
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000870void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000871 // Common scope checks.
872 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000873
Adrian Prantl541a9c52016-05-06 19:26:47 +0000874 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
875 N.getTag() == dwarf::DW_TAG_structure_type ||
876 N.getTag() == dwarf::DW_TAG_union_type ||
877 N.getTag() == dwarf::DW_TAG_enumeration_type ||
878 N.getTag() == dwarf::DW_TAG_class_type,
879 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000880
Adrian Prantl541a9c52016-05-06 19:26:47 +0000881 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
882 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
883 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000884
Adrian Prantl541a9c52016-05-06 19:26:47 +0000885 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
886 "invalid composite elements", &N, N.getRawElements());
887 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
888 N.getRawVTableHolder());
889 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
890 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000891 if (auto *Params = N.getRawTemplateParams())
892 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000893
894 if (N.getTag() == dwarf::DW_TAG_class_type ||
895 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000896 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
897 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000898 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000899}
900
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000901void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000902 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000903 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000904 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000905 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000906 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000907 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000908 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000909 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
910 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000911}
912
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000913void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000914 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000915}
916
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000917void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000918 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
919 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000920
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000921 // Don't bother verifying the compilation directory or producer string
922 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000923 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
924 N.getRawFile());
925 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
926 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000927
Adrian Prantl541a9c52016-05-06 19:26:47 +0000928 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
929 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000930
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000931 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000932 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000933 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000934 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000935 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
936 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000937 }
938 }
939 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000940 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000941 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000942 AssertDI(Op && (isa<DIType>(Op) ||
943 (isa<DISubprogram>(Op) &&
944 cast<DISubprogram>(Op)->isDefinition() == false)),
945 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000946 }
947 }
948 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000949 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000950 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000951 AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref",
952 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000953 }
954 }
955 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000956 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000958 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
959 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000960 }
961 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000962 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000963 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000964 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000965 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000966 }
967 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000968 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000969}
970
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000971void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000972 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
973 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +0000974 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000975 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000976 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000977 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
978 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
979 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000980 if (auto *Params = N.getRawTemplateParams())
981 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +0000982 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000983 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
984 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000985 if (auto *RawVars = N.getRawVariables()) {
986 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000987 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000988 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000989 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
990 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000991 }
992 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000993 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
994 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +0000995
Adrian Prantl75819ae2016-04-15 15:57:41 +0000996 auto *Unit = N.getRawUnit();
997 if (N.isDefinition()) {
998 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +0000999 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1000 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1001 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001002 } else {
1003 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001004 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001005 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001006}
1007
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001008void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001009 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1010 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1011 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001012}
1013
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001014void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1015 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001016
Adrian Prantl541a9c52016-05-06 19:26:47 +00001017 AssertDI(N.getLine() || !N.getColumn(),
1018 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001019}
1020
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001021void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1022 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001023}
1024
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001025void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001026 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001027 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001028 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001029}
1030
Amjad Abouda9bcf162015-12-10 12:56:35 +00001031void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001032 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1033 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1034 "invalid macinfo type", &N);
1035 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001036 if (!N.getValue().empty()) {
1037 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1038 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001039}
1040
1041void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001042 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1043 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001044 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001045 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001046
1047 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001048 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001049 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001050 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001051 }
1052 }
1053}
1054
Adrian Prantlab1243f2015-06-29 23:03:47 +00001055void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001056 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1057 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001058}
1059
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001060void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001061 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001062}
1063
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001064void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1065 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001066
Adrian Prantl541a9c52016-05-06 19:26:47 +00001067 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1068 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001069}
1070
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001071void Verifier::visitDITemplateValueParameter(
1072 const DITemplateValueParameter &N) {
1073 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001074
Adrian Prantl541a9c52016-05-06 19:26:47 +00001075 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1076 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1077 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1078 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001079}
1080
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001081void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001082 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001083 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1084 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001085 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001086 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001087}
1088
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001089void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001090 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001091 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001092
Adrian Prantl541a9c52016-05-06 19:26:47 +00001093 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1094 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001095 if (auto *V = N.getRawVariable()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001096 AssertDI(isa<ConstantAsMetadata>(V) &&
1097 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1098 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001099 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001100 }
1101 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001102 AssertDI(isa<DIDerivedType>(Member),
1103 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001104 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001105}
1106
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001107void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001108 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001109 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001110
Adrian Prantl541a9c52016-05-06 19:26:47 +00001111 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1112 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1113 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001114}
1115
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001116void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001117 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001118}
1119
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001120void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001121 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001122 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001123 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001124 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001125 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001126}
1127
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001128void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001129 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1130 N.getTag() == dwarf::DW_TAG_imported_declaration,
1131 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001132 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001133 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1134 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1135 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001136}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001137
David Majnemerdad0a642014-06-27 18:19:56 +00001138void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001139 // The Module is invalid if the GlobalValue has private linkage. Entities
1140 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001141 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001142 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1143 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001144}
1145
Chandler Carruth043949d2014-01-19 02:22:18 +00001146void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001147 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1148 if (!Idents)
1149 return;
1150
1151 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1152 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001153 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001154 Assert(N->getNumOperands() == 1,
1155 "incorrect number of operands in llvm.ident metadata", N);
1156 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1157 ("invalid value for llvm.ident metadata entry operand"
1158 "(the operand should be a string)"),
1159 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001160 }
1161}
1162
Chandler Carruth043949d2014-01-19 02:22:18 +00001163void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001164 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1165 if (!Flags) return;
1166
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001167 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001168 DenseMap<const MDString*, const MDNode*> SeenIDs;
1169 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001170 for (const MDNode *MDN : Flags->operands())
1171 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001172
1173 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001174 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001175 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001176 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001177
Chandler Carruth043949d2014-01-19 02:22:18 +00001178 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001179 if (!Op) {
1180 CheckFailed("invalid requirement on flag, flag is not present in module",
1181 Flag);
1182 continue;
1183 }
1184
1185 if (Op->getOperand(2) != ReqValue) {
1186 CheckFailed(("invalid requirement on flag, "
1187 "flag does not have the required value"),
1188 Flag);
1189 continue;
1190 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001191 }
1192}
1193
Chandler Carruth043949d2014-01-19 02:22:18 +00001194void
1195Verifier::visitModuleFlag(const MDNode *Op,
1196 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1197 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001198 // Each module flag should have three arguments, the merge behavior (a
1199 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001200 Assert(Op->getNumOperands() == 3,
1201 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001202 Module::ModFlagBehavior MFB;
1203 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001204 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001205 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001206 "invalid behavior operand in module flag (expected constant integer)",
1207 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001208 Assert(false,
1209 "invalid behavior operand in module flag (unexpected constant)",
1210 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001211 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001212 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001213 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1214 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001215
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001216 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001217 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001218 case Module::Error:
1219 case Module::Warning:
1220 case Module::Override:
1221 // These behavior types accept any value.
1222 break;
1223
1224 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001225 // The value should itself be an MDNode with two operands, a flag ID (an
1226 // MDString), and a value.
1227 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001228 Assert(Value && Value->getNumOperands() == 2,
1229 "invalid value for 'require' module flag (expected metadata pair)",
1230 Op->getOperand(2));
1231 Assert(isa<MDString>(Value->getOperand(0)),
1232 ("invalid value for 'require' module flag "
1233 "(first value operand should be a string)"),
1234 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001235
1236 // Append it to the list of requirements, to check once all module flags are
1237 // scanned.
1238 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001239 break;
1240 }
1241
1242 case Module::Append:
1243 case Module::AppendUnique: {
1244 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001245 Assert(isa<MDNode>(Op->getOperand(2)),
1246 "invalid value for 'append'-type module flag "
1247 "(expected a metadata node)",
1248 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001249 break;
1250 }
1251 }
1252
1253 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001254 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001255 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001256 Assert(Inserted,
1257 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001258 }
1259}
1260
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001261void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001262 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001263 unsigned Slot = ~0U;
1264 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1265 if (Attrs.getSlotIndex(I) == Idx) {
1266 Slot = I;
1267 break;
1268 }
1269
1270 assert(Slot != ~0U && "Attribute set inconsistency!");
1271
1272 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1273 I != E; ++I) {
1274 if (I->isStringAttribute())
1275 continue;
1276
1277 if (I->getKindAsEnum() == Attribute::NoReturn ||
1278 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001279 I->getKindAsEnum() == Attribute::NoInline ||
1280 I->getKindAsEnum() == Attribute::AlwaysInline ||
1281 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1282 I->getKindAsEnum() == Attribute::StackProtect ||
1283 I->getKindAsEnum() == Attribute::StackProtectReq ||
1284 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001285 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001286 I->getKindAsEnum() == Attribute::NoRedZone ||
1287 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1288 I->getKindAsEnum() == Attribute::Naked ||
1289 I->getKindAsEnum() == Attribute::InlineHint ||
1290 I->getKindAsEnum() == Attribute::StackAlignment ||
1291 I->getKindAsEnum() == Attribute::UWTable ||
1292 I->getKindAsEnum() == Attribute::NonLazyBind ||
1293 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1294 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1295 I->getKindAsEnum() == Attribute::SanitizeThread ||
1296 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1297 I->getKindAsEnum() == Attribute::MinSize ||
1298 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001299 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001300 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001301 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001302 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001303 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001304 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001305 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001306 I->getKindAsEnum() == Attribute::NoRecurse ||
1307 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001308 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1309 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001310 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001311 CheckFailed("Attribute '" + I->getAsString() +
1312 "' only applies to functions!", V);
1313 return;
1314 }
1315 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1316 I->getKindAsEnum() == Attribute::ReadNone) {
1317 if (Idx == 0) {
1318 CheckFailed("Attribute '" + I->getAsString() +
1319 "' does not apply to function returns");
1320 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001321 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001322 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001323 CheckFailed("Attribute '" + I->getAsString() +
1324 "' does not apply to functions!", V);
1325 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001326 }
1327 }
1328}
1329
Duncan Sandsc3a79922009-06-11 08:11:03 +00001330// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001331// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001332void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001333 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001334 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001335 return;
1336
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001337 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001338
Bill Wendling908126a2012-10-09 09:51:10 +00001339 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001340 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1341 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1342 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1343 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1344 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001345 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001346 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1347 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001348 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001349 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001350 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001351 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001352
Reid Klecknera534a382013-12-19 02:14:12 +00001353 // Check for mutually incompatible attributes. Only inreg is compatible with
1354 // sret.
1355 unsigned AttrCount = 0;
1356 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1357 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1358 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1359 Attrs.hasAttribute(Idx, Attribute::InReg);
1360 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001361 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1362 "and 'sret' are incompatible!",
1363 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001364
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001365 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1366 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1367 "Attributes "
1368 "'inalloca and readonly' are incompatible!",
1369 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001370
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001371 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1372 Attrs.hasAttribute(Idx, Attribute::Returned)),
1373 "Attributes "
1374 "'sret and returned' are incompatible!",
1375 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001376
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001377 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1378 Attrs.hasAttribute(Idx, Attribute::SExt)),
1379 "Attributes "
1380 "'zeroext and signext' are incompatible!",
1381 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001382
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001383 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1384 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1385 "Attributes "
1386 "'readnone and readonly' are incompatible!",
1387 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001388
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001389 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1390 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1391 "Attributes "
1392 "'noinline and alwaysinline' are incompatible!",
1393 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001394
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001395 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001396 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001397 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001398 AttributeSet::get(*Context, Idx,
1399 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001400 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001401
Reid Klecknera534a382013-12-19 02:14:12 +00001402 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001403 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001404 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001405 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1406 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1407 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1408 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001409 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001410 if (!isa<PointerType>(PTy->getElementType()))
1411 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1412 "Attribute 'swifterror' only applies to parameters "
1413 "with pointer to pointer type!",
1414 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001415 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001416 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1417 "Attribute 'byval' only applies to parameters with pointer type!",
1418 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001419 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1420 "Attribute 'swifterror' only applies to parameters "
1421 "with pointer type!",
1422 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001423 }
Duncan Sands0009c442008-01-12 16:42:01 +00001424}
1425
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001426// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001427// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001428void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001429 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001430 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001431 return;
1432
Duncan Sands8c582282007-12-21 19:19:01 +00001433 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001434 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001435 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001436 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001437 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001438
Chris Lattner8a923e72008-03-12 17:45:29 +00001439 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001440 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001441
Chris Lattner229907c2011-07-18 04:54:35 +00001442 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001443 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001444 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001445 else if (Idx-1 < FT->getNumParams())
1446 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001447 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001448 break; // VarArgs attributes, verified elsewhere.
1449
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001450 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001451
Stephen Linb8bd2322013-04-20 05:14:40 +00001452 if (Idx == 0)
1453 continue;
1454
1455 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001456 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001457 SawNest = true;
1458 }
1459
Stephen Linb8bd2322013-04-20 05:14:40 +00001460 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001461 Assert(!SawReturned, "More than one parameter has attribute returned!",
1462 V);
1463 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1464 "Incompatible "
1465 "argument and return types for 'returned' attribute",
1466 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001467 SawReturned = true;
1468 }
1469
Reid Kleckner79418562014-05-09 22:32:13 +00001470 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001471 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1472 Assert(Idx == 1 || Idx == 2,
1473 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001474 SawSRet = true;
1475 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001476
Manman Renf46262e2016-03-29 17:37:21 +00001477 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1478 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1479 SawSwiftSelf = true;
1480 }
1481
Manman Ren9bfd0d02016-04-01 21:41:15 +00001482 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1483 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1484 V);
1485 SawSwiftError = true;
1486 }
1487
Reid Kleckner60d3a832014-01-16 22:59:24 +00001488 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001489 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1490 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001491 }
Duncan Sands8c582282007-12-21 19:19:01 +00001492 }
Devang Patel9cc98122008-10-01 23:41:25 +00001493
Bill Wendling77543892013-01-18 21:11:39 +00001494 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1495 return;
1496
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001497 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001498
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001499 Assert(
1500 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1501 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1502 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001503
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001504 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001505 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1506 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1507 Attribute::InaccessibleMemOrArgMemOnly)),
1508 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1509
1510 Assert(
1511 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1512 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1513 Attribute::InaccessibleMemOnly)),
1514 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1515
1516 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001517 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1518 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1519 Attribute::AlwaysInline)),
1520 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001521
1522 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1523 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001524 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1525 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001526
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001527 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1528 Attribute::OptimizeForSize),
1529 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001530
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001531 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1532 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001533 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001534
1535 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1536 Attribute::JumpTable)) {
1537 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001538 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001539 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001540 }
George Burgess IV278199f2016-04-12 01:05:35 +00001541
1542 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1543 std::pair<unsigned, Optional<unsigned>> Args =
1544 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1545
1546 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1547 if (ParamNo >= FT->getNumParams()) {
1548 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1549 return false;
1550 }
1551
1552 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1553 CheckFailed("'allocsize' " + Name +
1554 " argument must refer to an integer parameter",
1555 V);
1556 return false;
1557 }
1558
1559 return true;
1560 };
1561
1562 if (!CheckParam("element size", Args.first))
1563 return;
1564
1565 if (Args.second && !CheckParam("number of elements", *Args.second))
1566 return;
1567 }
Duncan Sands8c582282007-12-21 19:19:01 +00001568}
1569
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001570void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001571 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001572 for (const auto &Pair : MDs) {
1573 if (Pair.first == LLVMContext::MD_prof) {
1574 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001575 Assert(MD->getNumOperands() == 2,
1576 "!prof annotations should have exactly 2 operands", MD);
1577
1578 // Check first operand.
1579 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1580 MD);
1581 Assert(isa<MDString>(MD->getOperand(0)),
1582 "expected string with name of the !prof annotation", MD);
1583 MDString *MDS = cast<MDString>(MD->getOperand(0));
1584 StringRef ProfName = MDS->getString();
1585 Assert(ProfName.equals("function_entry_count"),
1586 "first operand should be 'function_entry_count'", MD);
1587
1588 // Check second operand.
1589 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1590 MD);
1591 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1592 "expected integer argument to function_entry_count", MD);
1593 }
1594 }
1595}
1596
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001597void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1598 if (!ConstantExprVisited.insert(EntryC).second)
1599 return;
1600
1601 SmallVector<const Constant *, 16> Stack;
1602 Stack.push_back(EntryC);
1603
1604 while (!Stack.empty()) {
1605 const Constant *C = Stack.pop_back_val();
1606
1607 // Check this constant expression.
1608 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1609 visitConstantExpr(CE);
1610
Keno Fischerf6d17b92016-01-14 22:42:02 +00001611 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1612 // Global Values get visited separately, but we do need to make sure
1613 // that the global value is in the correct module
1614 Assert(GV->getParent() == M, "Referencing global in another module!",
1615 EntryC, M, GV, GV->getParent());
1616 continue;
1617 }
1618
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001619 // Visit all sub-expressions.
1620 for (const Use &U : C->operands()) {
1621 const auto *OpC = dyn_cast<Constant>(U);
1622 if (!OpC)
1623 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001624 if (!ConstantExprVisited.insert(OpC).second)
1625 continue;
1626 Stack.push_back(OpC);
1627 }
1628 }
1629}
1630
1631void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001632 if (CE->getOpcode() != Instruction::BitCast)
1633 return;
1634
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001635 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1636 CE->getType()),
1637 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001638}
1639
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001640bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001641 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001642 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001643
Devang Patel82fed672008-09-23 22:35:17 +00001644 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001645 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001646 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001647 || (LastIndex == AttributeSet::FunctionIndex
1648 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001649 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001650
Devang Patel82fed672008-09-23 22:35:17 +00001651 return false;
1652}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001653
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001654/// Verify that statepoint intrinsic is well formed.
1655void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001656 assert(CS.getCalledFunction() &&
1657 CS.getCalledFunction()->getIntrinsicID() ==
1658 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001659
Philip Reames0285c742015-02-03 23:18:47 +00001660 const Instruction &CI = *CS.getInstruction();
1661
Igor Laevsky39d662f2015-07-11 10:30:36 +00001662 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1663 !CS.onlyAccessesArgMemory(),
1664 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001665 "reordering restrictions required by safepoint semantics",
1666 &CI);
1667
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001668 const Value *IDV = CS.getArgument(0);
1669 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1670 &CI);
1671
1672 const Value *NumPatchBytesV = CS.getArgument(1);
1673 Assert(isa<ConstantInt>(NumPatchBytesV),
1674 "gc.statepoint number of patchable bytes must be a constant integer",
1675 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001676 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001677 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1678 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1679 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1680 "positive",
1681 &CI);
1682
1683 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001684 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001685 Assert(PT && PT->getElementType()->isFunctionTy(),
1686 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001687 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001688
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001689 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001690 Assert(isa<ConstantInt>(NumCallArgsV),
1691 "gc.statepoint number of arguments to underlying call "
1692 "must be constant integer",
1693 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001694 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001695 Assert(NumCallArgs >= 0,
1696 "gc.statepoint number of arguments to underlying call "
1697 "must be positive",
1698 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001699 const int NumParams = (int)TargetFuncType->getNumParams();
1700 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001701 Assert(NumCallArgs >= NumParams,
1702 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001703
1704 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001705 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1706 "gc.statepoint doesn't support wrapping non-void "
1707 "vararg functions yet",
1708 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001709 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001710 Assert(NumCallArgs == NumParams,
1711 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001712
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001713 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001714 Assert(isa<ConstantInt>(FlagsV),
1715 "gc.statepoint flags must be constant integer", &CI);
1716 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1717 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1718 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001719
1720 // Verify that the types of the call parameter arguments match
1721 // the type of the wrapped callee.
1722 for (int i = 0; i < NumParams; i++) {
1723 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001724 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001725 Assert(ArgType == ParamType,
1726 "gc.statepoint call argument does not match wrapped "
1727 "function type",
1728 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001729 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001730
1731 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001732
1733 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1734 Assert(isa<ConstantInt>(NumTransitionArgsV),
1735 "gc.statepoint number of transition arguments "
1736 "must be constant integer",
1737 &CI);
1738 const int NumTransitionArgs =
1739 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1740 Assert(NumTransitionArgs >= 0,
1741 "gc.statepoint number of transition arguments must be positive", &CI);
1742 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1743
1744 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001745 Assert(isa<ConstantInt>(NumDeoptArgsV),
1746 "gc.statepoint number of deoptimization arguments "
1747 "must be constant integer",
1748 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001749 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001750 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1751 "must be positive",
1752 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001753
Pat Gavlincc0431d2015-05-08 18:07:42 +00001754 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001755 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001756 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001757 "gc.statepoint too few arguments according to length fields", &CI);
1758
Philip Reames1ffa9372015-01-30 23:28:05 +00001759 // Check that the only uses of this gc.statepoint are gc.result or
1760 // gc.relocate calls which are tied to this statepoint and thus part
1761 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001762 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001763 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001764 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001765 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001766 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001767 "gc.result or gc.relocate are the only value uses"
1768 "of a gc.statepoint",
1769 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001770 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001771 Assert(Call->getArgOperand(0) == &CI,
1772 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001773 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001774 Assert(Call->getArgOperand(0) == &CI,
1775 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001776 }
1777 }
1778
1779 // Note: It is legal for a single derived pointer to be listed multiple
1780 // times. It's non-optimal, but it is legal. It can also happen after
1781 // insertion if we strip a bitcast away.
1782 // Note: It is really tempting to check that each base is relocated and
1783 // that a derived pointer is never reused as a base pointer. This turns
1784 // out to be problematic since optimizations run after safepoint insertion
1785 // can recognize equality properties that the insertion logic doesn't know
1786 // about. See example statepoint.ll in the verifier subdirectory
1787}
1788
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001789void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001790 for (auto &Counts : FrameEscapeInfo) {
1791 Function *F = Counts.first;
1792 unsigned EscapedObjectCount = Counts.second.first;
1793 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001794 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001795 "all indices passed to llvm.localrecover must be less than the "
1796 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001797 "function",
1798 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001799 }
1800}
1801
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001802static Instruction *getSuccPad(TerminatorInst *Terminator) {
1803 BasicBlock *UnwindDest;
1804 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1805 UnwindDest = II->getUnwindDest();
1806 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1807 UnwindDest = CSI->getUnwindDest();
1808 else
1809 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1810 return UnwindDest->getFirstNonPHI();
1811}
1812
1813void Verifier::verifySiblingFuncletUnwinds() {
1814 SmallPtrSet<Instruction *, 8> Visited;
1815 SmallPtrSet<Instruction *, 8> Active;
1816 for (const auto &Pair : SiblingFuncletInfo) {
1817 Instruction *PredPad = Pair.first;
1818 if (Visited.count(PredPad))
1819 continue;
1820 Active.insert(PredPad);
1821 TerminatorInst *Terminator = Pair.second;
1822 do {
1823 Instruction *SuccPad = getSuccPad(Terminator);
1824 if (Active.count(SuccPad)) {
1825 // Found a cycle; report error
1826 Instruction *CyclePad = SuccPad;
1827 SmallVector<Instruction *, 8> CycleNodes;
1828 do {
1829 CycleNodes.push_back(CyclePad);
1830 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1831 if (CycleTerminator != CyclePad)
1832 CycleNodes.push_back(CycleTerminator);
1833 CyclePad = getSuccPad(CycleTerminator);
1834 } while (CyclePad != SuccPad);
1835 Assert(false, "EH pads can't handle each other's exceptions",
1836 ArrayRef<Instruction *>(CycleNodes));
1837 }
1838 // Don't re-walk a node we've already checked
1839 if (!Visited.insert(SuccPad).second)
1840 break;
1841 // Walk to this successor if it has a map entry.
1842 PredPad = SuccPad;
1843 auto TermI = SiblingFuncletInfo.find(PredPad);
1844 if (TermI == SiblingFuncletInfo.end())
1845 break;
1846 Terminator = TermI->second;
1847 Active.insert(PredPad);
1848 } while (true);
1849 // Each node only has one successor, so we've walked all the active
1850 // nodes' successors.
1851 Active.clear();
1852 }
1853}
1854
Chris Lattner0e851da2002-04-18 20:37:37 +00001855// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001856//
Chandler Carruth043949d2014-01-19 02:22:18 +00001857void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001858 visitGlobalValue(F);
1859
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001860 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001861 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001862 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001863
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001864 Assert(Context == &F.getContext(),
1865 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001866
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001867 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1868 Assert(FT->getNumParams() == NumArgs,
1869 "# formal arguments must match # of arguments for function type!", &F,
1870 FT);
1871 Assert(F.getReturnType()->isFirstClassType() ||
1872 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1873 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001874
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001875 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1876 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001877
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001878 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001879
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001880 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001881 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001882
Duncan Sands8c582282007-12-21 19:19:01 +00001883 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001884 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001885
Michael Gottesman41748d72013-06-27 00:25:01 +00001886 // On function declarations/definitions, we do not support the builtin
1887 // attribute. We do not check this in VerifyFunctionAttrs since that is
1888 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001889 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1890 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001891
Chris Lattneref13ee32006-05-19 21:25:17 +00001892 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001893 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1894 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001895 switch (F.getCallingConv()) {
1896 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001897 case CallingConv::C:
1898 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001899 case CallingConv::Fast:
1900 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001901 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001902 case CallingConv::PTX_Kernel:
1903 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001904 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1905 "perfect forwarding!",
1906 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001907 break;
1908 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001909
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001910 bool isLLVMdotName = F.getName().size() >= 5 &&
1911 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001912
Chris Lattneraf95e582002-04-13 22:48:46 +00001913 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001914 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001915 for (const Argument &Arg : F.args()) {
1916 Assert(Arg.getType() == FT->getParamType(i),
1917 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001918 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001919 Assert(Arg.getType()->isFirstClassType(),
1920 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001921 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001922 Assert(!Arg.getType()->isMetadataTy(),
1923 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1924 Assert(!Arg.getType()->isTokenTy(),
1925 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001926 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001927
1928 // Check that swifterror argument is only used by loads and stores.
1929 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1930 verifySwiftErrorValue(&Arg);
1931 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001932 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001933 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001934
David Majnemerb611e3f2015-08-14 05:09:07 +00001935 if (!isLLVMdotName)
1936 Assert(!F.getReturnType()->isTokenTy(),
1937 "Functions returns a token but isn't an intrinsic", &F);
1938
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001939 // Get the function metadata attachments.
1940 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1941 F.getAllMetadata(MDs);
1942 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001943 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001944
Keno Fischer2ac0c272015-11-16 05:13:30 +00001945 // Check validity of the personality function
1946 if (F.hasPersonalityFn()) {
1947 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1948 if (Per)
1949 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001950 "Referencing personality function in another module!",
1951 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001952 }
1953
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001954 if (F.isMaterializable()) {
1955 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001956 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1957 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001958 } else if (F.isDeclaration()) {
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001959 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1960 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001961 Assert(!F.hasPersonalityFn(),
1962 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001963 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001964 // Verify that this function (which has a body) is not named "llvm.*". It
1965 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001966 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001967
Chris Lattner149376d2002-10-13 20:57:00 +00001968 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001969 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001970 Assert(pred_empty(Entry),
1971 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001972
Chris Lattner27471742009-11-01 04:08:01 +00001973 // The address of the entry block cannot be taken, unless it is dead.
1974 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001975 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1976 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001977 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001978
Peter Collingbourne6dbee002016-06-14 23:13:15 +00001979 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001980 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001981 for (const auto &I : MDs) {
1982 // Verify that the attachment is legal.
1983 switch (I.first) {
1984 default:
1985 break;
1986 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00001987 ++NumDebugAttachments;
1988 AssertDI(NumDebugAttachments == 1,
1989 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001990 AssertDI(isa<DISubprogram>(I.second),
1991 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001992 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00001993 case LLVMContext::MD_prof:
1994 ++NumProfAttachments;
1995 Assert(NumProfAttachments == 1,
1996 "function must have a single !prof attachment", &F, I.second);
1997 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001998 }
1999
2000 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002001 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002002 }
Chris Lattner149376d2002-10-13 20:57:00 +00002003 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002004
Chris Lattner7730dcc2009-09-11 17:05:29 +00002005 // If this function is actually an intrinsic, verify that it is only used in
2006 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002007 // Only do this if the module is materialized, otherwise we don't have all the
2008 // uses.
2009 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002010 const User *U;
2011 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002012 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002013 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002014
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002015 Assert(!F.hasDLLImportStorageClass() ||
2016 (F.isDeclaration() && F.hasExternalLinkage()) ||
2017 F.hasAvailableExternallyLinkage(),
2018 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002019
2020 auto *N = F.getSubprogram();
2021 if (!N)
2022 return;
2023
Adrian Prantl75819ae2016-04-15 15:57:41 +00002024 visitDISubprogram(*N);
2025
Peter Collingbourned4bff302015-11-05 22:03:56 +00002026 // Check that all !dbg attachments lead to back to N (or, at least, another
2027 // subprogram that describes the same function).
2028 //
2029 // FIXME: Check this incrementally while visiting !dbg attachments.
2030 // FIXME: Only check when N is the canonical subprogram for F.
2031 SmallPtrSet<const MDNode *, 32> Seen;
2032 for (auto &BB : F)
2033 for (auto &I : BB) {
2034 // Be careful about using DILocation here since we might be dealing with
2035 // broken code (this is the Verifier after all).
2036 DILocation *DL =
2037 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2038 if (!DL)
2039 continue;
2040 if (!Seen.insert(DL).second)
2041 continue;
2042
2043 DILocalScope *Scope = DL->getInlinedAtScope();
2044 if (Scope && !Seen.insert(Scope).second)
2045 continue;
2046
2047 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002048
2049 // Scope and SP could be the same MDNode and we don't want to skip
2050 // validation in that case
2051 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002052 continue;
2053
2054 // FIXME: Once N is canonical, check "SP == &N".
2055 Assert(SP->describes(&F),
2056 "!dbg attachment points at wrong subprogram for function", N, &F,
2057 &I, DL, Scope, SP);
2058 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002059}
2060
Chris Lattner0e851da2002-04-18 20:37:37 +00002061// verifyBasicBlock - Verify that a basic block is well formed...
2062//
Chris Lattner069a7952002-06-25 15:56:27 +00002063void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002064 InstsInThisBlock.clear();
2065
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002066 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002067 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002068
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002069 // Check constraints that this basic block imposes on all of the PHI nodes in
2070 // it.
2071 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002072 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2073 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002074 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002075 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002076 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002077 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002078 Assert(PN->getNumIncomingValues() != 0,
2079 "PHI nodes must have at least one entry. If the block is dead, "
2080 "the PHI should be removed!",
2081 PN);
2082 Assert(PN->getNumIncomingValues() == Preds.size(),
2083 "PHINode should have one entry for each predecessor of its "
2084 "parent basic block!",
2085 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002086
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002087 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002088 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002089 Values.reserve(PN->getNumIncomingValues());
2090 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2091 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2092 PN->getIncomingValue(i)));
2093 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002094
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002095 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2096 // Check to make sure that if there is more than one entry for a
2097 // particular basic block in this PHI node, that the incoming values are
2098 // all identical.
2099 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002100 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2101 Values[i].second == Values[i - 1].second,
2102 "PHI node has multiple entries for the same basic block with "
2103 "different incoming values!",
2104 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002105
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002106 // Check to make sure that the predecessors and PHI node entries are
2107 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002108 Assert(Values[i].first == Preds[i],
2109 "PHI node entries do not match predecessors!", PN,
2110 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002111 }
2112 }
2113 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002114
2115 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002116 for (auto &I : BB)
2117 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002118 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002119 }
Chris Lattner069a7952002-06-25 15:56:27 +00002120}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002121
Chris Lattner069a7952002-06-25 15:56:27 +00002122void Verifier::visitTerminatorInst(TerminatorInst &I) {
2123 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002124 Assert(&I == I.getParent()->getTerminator(),
2125 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002126 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002127}
2128
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002129void Verifier::visitBranchInst(BranchInst &BI) {
2130 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002131 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2132 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002133 }
2134 visitTerminatorInst(BI);
2135}
2136
Chris Lattner069a7952002-06-25 15:56:27 +00002137void Verifier::visitReturnInst(ReturnInst &RI) {
2138 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002139 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002140 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002141 Assert(N == 0,
2142 "Found return instr that returns non-void in Function of void "
2143 "return type!",
2144 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002145 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002146 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2147 "Function return type does not match operand "
2148 "type of return inst!",
2149 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002150
Misha Brukman7eb05a12003-08-18 14:43:39 +00002151 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002152 // terminators...
2153 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002154}
2155
Chris Lattnerab5aa142004-05-21 16:47:21 +00002156void Verifier::visitSwitchInst(SwitchInst &SI) {
2157 // Check to make sure that all of the constants in the switch instruction
2158 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002159 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002160 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002161 for (auto &Case : SI.cases()) {
2162 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002163 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002164 Assert(Constants.insert(Case.getCaseValue()).second,
2165 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002166 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002167
Chris Lattnerab5aa142004-05-21 16:47:21 +00002168 visitTerminatorInst(SI);
2169}
2170
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002171void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002172 Assert(BI.getAddress()->getType()->isPointerTy(),
2173 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002174 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002175 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2176 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002177
2178 visitTerminatorInst(BI);
2179}
2180
Chris Lattner75648e72004-03-12 05:54:31 +00002181void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002182 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2183 SI.getOperand(2)),
2184 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002185
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002186 Assert(SI.getTrueValue()->getType() == SI.getType(),
2187 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002188 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002189}
2190
Misha Brukmanc566ca362004-03-02 00:22:19 +00002191/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2192/// a pass, if any exist, it's an error.
2193///
Chris Lattner903a25d2002-11-21 16:54:22 +00002194void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002195 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002196}
Chris Lattner0e851da2002-04-18 20:37:37 +00002197
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002198void Verifier::visitTruncInst(TruncInst &I) {
2199 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002200 Type *SrcTy = I.getOperand(0)->getType();
2201 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002202
2203 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002204 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2205 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002206
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002207 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2208 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2209 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2210 "trunc source and destination must both be a vector or neither", &I);
2211 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002212
2213 visitInstruction(I);
2214}
2215
2216void Verifier::visitZExtInst(ZExtInst &I) {
2217 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002218 Type *SrcTy = I.getOperand(0)->getType();
2219 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002220
2221 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002222 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2223 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2224 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2225 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002226 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2227 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002228
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002229 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002230
2231 visitInstruction(I);
2232}
2233
2234void Verifier::visitSExtInst(SExtInst &I) {
2235 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002236 Type *SrcTy = I.getOperand(0)->getType();
2237 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002238
2239 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002240 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2241 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002242
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002243 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2244 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2245 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2246 "sext source and destination must both be a vector or neither", &I);
2247 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002248
2249 visitInstruction(I);
2250}
2251
2252void Verifier::visitFPTruncInst(FPTruncInst &I) {
2253 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002254 Type *SrcTy = I.getOperand(0)->getType();
2255 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002256 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002257 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2258 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002259
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002260 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2261 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2262 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2263 "fptrunc source and destination must both be a vector or neither", &I);
2264 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002265
2266 visitInstruction(I);
2267}
2268
2269void Verifier::visitFPExtInst(FPExtInst &I) {
2270 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002271 Type *SrcTy = I.getOperand(0)->getType();
2272 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002273
2274 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002275 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2276 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002277
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002278 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2279 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2280 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2281 "fpext source and destination must both be a vector or neither", &I);
2282 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002283
2284 visitInstruction(I);
2285}
2286
2287void Verifier::visitUIToFPInst(UIToFPInst &I) {
2288 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002289 Type *SrcTy = I.getOperand(0)->getType();
2290 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002291
Duncan Sands19d0b472010-02-16 11:11:14 +00002292 bool SrcVec = SrcTy->isVectorTy();
2293 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002294
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002295 Assert(SrcVec == DstVec,
2296 "UIToFP source and dest must both be vector or scalar", &I);
2297 Assert(SrcTy->isIntOrIntVectorTy(),
2298 "UIToFP source must be integer or integer vector", &I);
2299 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2300 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002301
2302 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002303 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2304 cast<VectorType>(DestTy)->getNumElements(),
2305 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002306
2307 visitInstruction(I);
2308}
2309
2310void Verifier::visitSIToFPInst(SIToFPInst &I) {
2311 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002312 Type *SrcTy = I.getOperand(0)->getType();
2313 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002314
Duncan Sands19d0b472010-02-16 11:11:14 +00002315 bool SrcVec = SrcTy->isVectorTy();
2316 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002317
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002318 Assert(SrcVec == DstVec,
2319 "SIToFP source and dest must both be vector or scalar", &I);
2320 Assert(SrcTy->isIntOrIntVectorTy(),
2321 "SIToFP source must be integer or integer vector", &I);
2322 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2323 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002324
2325 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002326 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2327 cast<VectorType>(DestTy)->getNumElements(),
2328 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002329
2330 visitInstruction(I);
2331}
2332
2333void Verifier::visitFPToUIInst(FPToUIInst &I) {
2334 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002335 Type *SrcTy = I.getOperand(0)->getType();
2336 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002337
Duncan Sands19d0b472010-02-16 11:11:14 +00002338 bool SrcVec = SrcTy->isVectorTy();
2339 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002340
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002341 Assert(SrcVec == DstVec,
2342 "FPToUI source and dest must both be vector or scalar", &I);
2343 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2344 &I);
2345 Assert(DestTy->isIntOrIntVectorTy(),
2346 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002347
2348 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002349 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2350 cast<VectorType>(DestTy)->getNumElements(),
2351 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002352
2353 visitInstruction(I);
2354}
2355
2356void Verifier::visitFPToSIInst(FPToSIInst &I) {
2357 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002358 Type *SrcTy = I.getOperand(0)->getType();
2359 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002360
Duncan Sands19d0b472010-02-16 11:11:14 +00002361 bool SrcVec = SrcTy->isVectorTy();
2362 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002363
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002364 Assert(SrcVec == DstVec,
2365 "FPToSI source and dest must both be vector or scalar", &I);
2366 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2367 &I);
2368 Assert(DestTy->isIntOrIntVectorTy(),
2369 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002370
2371 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002372 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2373 cast<VectorType>(DestTy)->getNumElements(),
2374 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002375
2376 visitInstruction(I);
2377}
2378
2379void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2380 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002381 Type *SrcTy = I.getOperand(0)->getType();
2382 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002383
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002384 Assert(SrcTy->getScalarType()->isPointerTy(),
2385 "PtrToInt source must be pointer", &I);
2386 Assert(DestTy->getScalarType()->isIntegerTy(),
2387 "PtrToInt result must be integral", &I);
2388 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2389 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002390
2391 if (SrcTy->isVectorTy()) {
2392 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2393 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002394 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2395 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002396 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002397
2398 visitInstruction(I);
2399}
2400
2401void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2402 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002403 Type *SrcTy = I.getOperand(0)->getType();
2404 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002405
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002406 Assert(SrcTy->getScalarType()->isIntegerTy(),
2407 "IntToPtr source must be an integral", &I);
2408 Assert(DestTy->getScalarType()->isPointerTy(),
2409 "IntToPtr result must be a pointer", &I);
2410 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2411 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002412 if (SrcTy->isVectorTy()) {
2413 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2414 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002415 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2416 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002417 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002418 visitInstruction(I);
2419}
2420
2421void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002422 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002423 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2424 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002425 visitInstruction(I);
2426}
2427
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002428void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2429 Type *SrcTy = I.getOperand(0)->getType();
2430 Type *DestTy = I.getType();
2431
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002432 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2433 &I);
2434 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2435 &I);
2436 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2437 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002438 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002439 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2440 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002441 visitInstruction(I);
2442}
2443
Misha Brukmanc566ca362004-03-02 00:22:19 +00002444/// visitPHINode - Ensure that a PHI node is well formed.
2445///
Chris Lattner069a7952002-06-25 15:56:27 +00002446void Verifier::visitPHINode(PHINode &PN) {
2447 // Ensure that the PHI nodes are all grouped together at the top of the block.
2448 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002449 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002450 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002451 Assert(&PN == &PN.getParent()->front() ||
2452 isa<PHINode>(--BasicBlock::iterator(&PN)),
2453 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002454
David Majnemerb611e3f2015-08-14 05:09:07 +00002455 // Check that a PHI doesn't yield a Token.
2456 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2457
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002458 // Check that all of the values of the PHI node have the same type as the
2459 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002460 for (Value *IncValue : PN.incoming_values()) {
2461 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002462 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002463 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002464
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002465 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002466
2467 visitInstruction(PN);
2468}
2469
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002470void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002471 Instruction *I = CS.getInstruction();
2472
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002473 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2474 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002475 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002476
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002477 Assert(FPTy->getElementType()->isFunctionTy(),
2478 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002479
2480 Assert(FPTy->getElementType() == CS.getFunctionType(),
2481 "Called function is not the same type as the call!", I);
2482
2483 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002484
2485 // Verify that the correct number of arguments are being passed
2486 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002487 Assert(CS.arg_size() >= FTy->getNumParams(),
2488 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002489 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002490 Assert(CS.arg_size() == FTy->getNumParams(),
2491 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002492
Chris Lattner609de002010-05-10 20:58:42 +00002493 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002494 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002495 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2496 "Call parameter type does not match function signature!",
2497 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002498
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002499 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002500
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002501 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002502 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002503
Duncan Sands8c582282007-12-21 19:19:01 +00002504 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002505 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002506
David Majnemer91db08b2014-04-30 17:22:00 +00002507 // Conservatively check the inalloca argument.
2508 // We have a bug if we can find that there is an underlying alloca without
2509 // inalloca.
2510 if (CS.hasInAllocaArgument()) {
2511 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2512 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002513 Assert(AI->isUsedWithInAlloca(),
2514 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002515 }
2516
Manman Ren9bfd0d02016-04-01 21:41:15 +00002517 // For each argument of the callsite, if it has the swifterror argument,
2518 // make sure the underlying alloca has swifterror as well.
2519 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2520 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2521 Value *SwiftErrorArg = CS.getArgument(i);
2522 auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets());
2523 Assert(AI, "swifterror argument should come from alloca", AI, I);
2524 if (AI)
2525 Assert(AI->isSwiftError(),
2526 "swifterror argument for call has mismatched alloca", AI, I);
2527 }
2528
Stephen Linb8bd2322013-04-20 05:14:40 +00002529 if (FTy->isVarArg()) {
2530 // FIXME? is 'nest' even legal here?
2531 bool SawNest = false;
2532 bool SawReturned = false;
2533
2534 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2535 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2536 SawNest = true;
2537 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2538 SawReturned = true;
2539 }
2540
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002541 // Check attributes on the varargs part.
2542 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002543 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002544 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002545
Stephen Linb8bd2322013-04-20 05:14:40 +00002546 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002547 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002548 SawNest = true;
2549 }
2550
2551 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002552 Assert(!SawReturned, "More than one parameter has attribute returned!",
2553 I);
2554 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2555 "Incompatible argument and return types for 'returned' "
2556 "attribute",
2557 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002558 SawReturned = true;
2559 }
Duncan Sands0009c442008-01-12 16:42:01 +00002560
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002561 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2562 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002563
2564 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002565 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002566 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002567 }
Duncan Sands8c582282007-12-21 19:19:01 +00002568
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002569 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002570 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002571 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002572 for (Type *ParamTy : FTy->params()) {
2573 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002574 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002575 Assert(!ParamTy->isTokenTy(),
2576 "Function has token parameter but isn't an intrinsic", I);
2577 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002578 }
2579
David Majnemerb611e3f2015-08-14 05:09:07 +00002580 // Verify that indirect calls don't return tokens.
2581 if (CS.getCalledFunction() == nullptr)
2582 Assert(!FTy->getReturnType()->isTokenTy(),
2583 "Return type cannot be token for indirect call!");
2584
Philip Reamesa3c6f002015-06-26 21:39:44 +00002585 if (Function *F = CS.getCalledFunction())
2586 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002587 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002588
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002589 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2590 // at most one "gc-transition" operand bundle.
2591 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2592 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002593 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002594 OperandBundleUse BU = CS.getOperandBundleAt(i);
2595 uint32_t Tag = BU.getTagID();
2596 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002597 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2598 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002599 } else if (Tag == LLVMContext::OB_gc_transition) {
2600 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2601 I);
2602 FoundGCTransitionBundle = true;
2603 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002604 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2605 FoundFuncletBundle = true;
2606 Assert(BU.Inputs.size() == 1,
2607 "Expected exactly one funclet bundle operand", I);
2608 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2609 "Funclet bundle operands should correspond to a FuncletPadInst",
2610 I);
2611 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002612 }
2613
Adrian Prantl93035c82016-04-24 22:23:13 +00002614 // Verify that each inlinable callsite of a debug-info-bearing function in a
2615 // debug-info-bearing function has a debug location attached to it. Failure to
2616 // do so causes assertion failures when the inliner sets up inline scope info.
2617 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2618 CS.getCalledFunction()->getSubprogram())
2619 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2620 "info must have a !dbg location",
2621 I);
2622
Duncan Sands8c582282007-12-21 19:19:01 +00002623 visitInstruction(*I);
2624}
2625
Reid Kleckner5772b772014-04-24 20:14:34 +00002626/// Two types are "congruent" if they are identical, or if they are both pointer
2627/// types with different pointee types and the same address space.
2628static bool isTypeCongruent(Type *L, Type *R) {
2629 if (L == R)
2630 return true;
2631 PointerType *PL = dyn_cast<PointerType>(L);
2632 PointerType *PR = dyn_cast<PointerType>(R);
2633 if (!PL || !PR)
2634 return false;
2635 return PL->getAddressSpace() == PR->getAddressSpace();
2636}
2637
Reid Klecknerd20c9702014-05-15 23:58:57 +00002638static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2639 static const Attribute::AttrKind ABIAttrs[] = {
2640 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002641 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2642 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002643 AttrBuilder Copy;
2644 for (auto AK : ABIAttrs) {
2645 if (Attrs.hasAttribute(I + 1, AK))
2646 Copy.addAttribute(AK);
2647 }
2648 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2649 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2650 return Copy;
2651}
2652
Reid Kleckner5772b772014-04-24 20:14:34 +00002653void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002654 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002655
2656 // - The caller and callee prototypes must match. Pointer types of
2657 // parameters or return types may differ in pointee type, but not
2658 // address space.
2659 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002660 FunctionType *CallerTy = F->getFunctionType();
2661 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002662 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2663 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2664 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2665 "cannot guarantee tail call due to mismatched varargs", &CI);
2666 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2667 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002668 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002669 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002670 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2671 "cannot guarantee tail call due to mismatched parameter types", &CI);
2672 }
2673
2674 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002675 Assert(F->getCallingConv() == CI.getCallingConv(),
2676 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002677
2678 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2679 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002680 AttributeSet CallerAttrs = F->getAttributes();
2681 AttributeSet CalleeAttrs = CI.getAttributes();
2682 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002683 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2684 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002685 Assert(CallerABIAttrs == CalleeABIAttrs,
2686 "cannot guarantee tail call due to mismatched ABI impacting "
2687 "function attributes",
2688 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002689 }
2690
2691 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2692 // or a pointer bitcast followed by a ret instruction.
2693 // - The ret instruction must return the (possibly bitcasted) value
2694 // produced by the call or void.
2695 Value *RetVal = &CI;
2696 Instruction *Next = CI.getNextNode();
2697
2698 // Handle the optional bitcast.
2699 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002700 Assert(BI->getOperand(0) == RetVal,
2701 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002702 RetVal = BI;
2703 Next = BI->getNextNode();
2704 }
2705
2706 // Check the return.
2707 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002708 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2709 &CI);
2710 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2711 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002712}
2713
Duncan Sands8c582282007-12-21 19:19:01 +00002714void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002715 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002716
Reid Kleckner5772b772014-04-24 20:14:34 +00002717 if (CI.isMustTailCall())
2718 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002719}
2720
2721void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002722 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002723
David Majnemer654e1302015-07-31 17:58:14 +00002724 // Verify that the first non-PHI instruction of the unwind destination is an
2725 // exception handling instruction.
2726 Assert(
2727 II.getUnwindDest()->isEHPad(),
2728 "The unwind destination does not have an exception handling instruction!",
2729 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002730
Dan Gohman9c6e1882010-08-02 23:09:14 +00002731 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002732}
Chris Lattner0e851da2002-04-18 20:37:37 +00002733
Misha Brukmanc566ca362004-03-02 00:22:19 +00002734/// visitBinaryOperator - Check that both arguments to the binary operator are
2735/// of the same type!
2736///
Chris Lattner069a7952002-06-25 15:56:27 +00002737void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002738 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2739 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002740
Reid Spencer2341c222007-02-02 02:16:23 +00002741 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002742 // Check that integer arithmetic operators are only used with
2743 // integral operands.
2744 case Instruction::Add:
2745 case Instruction::Sub:
2746 case Instruction::Mul:
2747 case Instruction::SDiv:
2748 case Instruction::UDiv:
2749 case Instruction::SRem:
2750 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002751 Assert(B.getType()->isIntOrIntVectorTy(),
2752 "Integer arithmetic operators only work with integral types!", &B);
2753 Assert(B.getType() == B.getOperand(0)->getType(),
2754 "Integer arithmetic operators must have same type "
2755 "for operands and result!",
2756 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002757 break;
2758 // Check that floating-point arithmetic operators are only used with
2759 // floating-point operands.
2760 case Instruction::FAdd:
2761 case Instruction::FSub:
2762 case Instruction::FMul:
2763 case Instruction::FDiv:
2764 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002765 Assert(B.getType()->isFPOrFPVectorTy(),
2766 "Floating-point arithmetic operators only work with "
2767 "floating-point types!",
2768 &B);
2769 Assert(B.getType() == B.getOperand(0)->getType(),
2770 "Floating-point arithmetic operators must have same type "
2771 "for operands and result!",
2772 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002773 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002774 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002775 case Instruction::And:
2776 case Instruction::Or:
2777 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002778 Assert(B.getType()->isIntOrIntVectorTy(),
2779 "Logical operators only work with integral types!", &B);
2780 Assert(B.getType() == B.getOperand(0)->getType(),
2781 "Logical operators must have same type for operands and result!",
2782 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002783 break;
2784 case Instruction::Shl:
2785 case Instruction::LShr:
2786 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002787 Assert(B.getType()->isIntOrIntVectorTy(),
2788 "Shifts only work with integral types!", &B);
2789 Assert(B.getType() == B.getOperand(0)->getType(),
2790 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002791 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002792 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002793 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002794 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002795
Chris Lattner0e851da2002-04-18 20:37:37 +00002796 visitInstruction(B);
2797}
2798
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002799void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002800 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002801 Type *Op0Ty = IC.getOperand(0)->getType();
2802 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002803 Assert(Op0Ty == Op1Ty,
2804 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002805 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002806 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2807 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002808 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002809 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2810 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2811 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002812
Reid Spencerd9436b62006-11-20 01:22:35 +00002813 visitInstruction(IC);
2814}
2815
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002816void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002817 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002818 Type *Op0Ty = FC.getOperand(0)->getType();
2819 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002820 Assert(Op0Ty == Op1Ty,
2821 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002822 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002823 Assert(Op0Ty->isFPOrFPVectorTy(),
2824 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002825 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002826 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2827 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2828 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002829
Reid Spencerd9436b62006-11-20 01:22:35 +00002830 visitInstruction(FC);
2831}
2832
Robert Bocchino23004482006-01-10 19:05:34 +00002833void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002834 Assert(
2835 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2836 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002837 visitInstruction(EI);
2838}
2839
Robert Bocchinoca27f032006-01-17 20:07:22 +00002840void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002841 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2842 IE.getOperand(2)),
2843 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002844 visitInstruction(IE);
2845}
2846
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002847void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002848 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2849 SV.getOperand(2)),
2850 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002851 visitInstruction(SV);
2852}
2853
Chris Lattner069a7952002-06-25 15:56:27 +00002854void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002855 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002856
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002857 Assert(isa<PointerType>(TargetTy),
2858 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002859 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002860 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002861 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002862 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002863 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002864
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002865 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002866 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002867 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002868
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002869 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002870 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002871 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2872 if (GEP.getPointerOperandType()->isVectorTy())
2873 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2874 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002875 for (Value *Idx : Idxs) {
2876 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002877 if (IndexTy->isVectorTy()) {
2878 unsigned IndexWidth = IndexTy->getVectorNumElements();
2879 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2880 }
2881 Assert(IndexTy->getScalarType()->isIntegerTy(),
2882 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002883 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002884 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002885 visitInstruction(GEP);
2886}
2887
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002888static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2889 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2890}
2891
Philip Reamesbf9676f2014-10-20 23:52:07 +00002892void Verifier::visitRangeMetadata(Instruction& I,
2893 MDNode* Range, Type* Ty) {
2894 assert(Range &&
2895 Range == I.getMetadata(LLVMContext::MD_range) &&
2896 "precondition violation");
2897
2898 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002899 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002900 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002901 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2902
Philip Reamesbf9676f2014-10-20 23:52:07 +00002903 ConstantRange LastRange(1); // Dummy initial value
2904 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002905 ConstantInt *Low =
2906 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002907 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002908 ConstantInt *High =
2909 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002910 Assert(High, "The upper limit must be an integer!", High);
2911 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2912 "Range types must match instruction type!", &I);
2913
Philip Reamesbf9676f2014-10-20 23:52:07 +00002914 APInt HighV = High->getValue();
2915 APInt LowV = Low->getValue();
2916 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002917 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2918 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002919 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002920 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2921 "Intervals are overlapping", Range);
2922 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2923 Range);
2924 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2925 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002926 }
2927 LastRange = ConstantRange(LowV, HighV);
2928 }
2929 if (NumRanges > 2) {
2930 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002931 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002932 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002933 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002934 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002935 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2936 "Intervals are overlapping", Range);
2937 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2938 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002939 }
2940}
2941
JF Bastiend1fb5852015-12-17 22:09:19 +00002942void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2943 const Instruction *I) {
2944 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2945 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2946 Assert(!(Size & (Size - 1)),
2947 "atomic memory access' operand must have a power-of-two size", Ty, I);
2948}
2949
Chris Lattner069a7952002-06-25 15:56:27 +00002950void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002951 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002952 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002953 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002954 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2955 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00002956 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002957 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00002958 Assert(LI.getOrdering() != AtomicOrdering::Release &&
2959 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002960 "Load cannot have Release ordering", &LI);
2961 Assert(LI.getAlignment() != 0,
2962 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002963 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2964 ElTy->isFloatingPointTy(),
2965 "atomic load operand must have integer, pointer, or floating point "
2966 "type!",
2967 ElTy, &LI);
2968 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002969 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002970 Assert(LI.getSynchScope() == CrossThread,
2971 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002972 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002973
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002974 visitInstruction(LI);
2975}
2976
Chris Lattner069a7952002-06-25 15:56:27 +00002977void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002978 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002979 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002980 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002981 Assert(ElTy == SI.getOperand(0)->getType(),
2982 "Stored value type does not match pointer operand type!", &SI, ElTy);
2983 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2984 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00002985 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002986 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00002987 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
2988 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002989 "Store cannot have Acquire ordering", &SI);
2990 Assert(SI.getAlignment() != 0,
2991 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002992 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2993 ElTy->isFloatingPointTy(),
2994 "atomic store operand must have integer, pointer, or floating point "
2995 "type!",
2996 ElTy, &SI);
2997 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002998 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002999 Assert(SI.getSynchScope() == CrossThread,
3000 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003001 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003002 visitInstruction(SI);
3003}
3004
Manman Ren9bfd0d02016-04-01 21:41:15 +00003005/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3006void Verifier::verifySwiftErrorCallSite(CallSite CS,
3007 const Value *SwiftErrorVal) {
3008 unsigned Idx = 0;
3009 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3010 I != E; ++I, ++Idx) {
3011 if (*I == SwiftErrorVal) {
3012 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3013 "swifterror value when used in a callsite should be marked "
3014 "with swifterror attribute",
3015 SwiftErrorVal, CS);
3016 }
3017 }
3018}
3019
3020void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3021 // Check that swifterror value is only used by loads, stores, or as
3022 // a swifterror argument.
3023 for (const User *U : SwiftErrorVal->users()) {
3024 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3025 isa<InvokeInst>(U),
3026 "swifterror value can only be loaded and stored from, or "
3027 "as a swifterror argument!",
3028 SwiftErrorVal, U);
3029 // If it is used by a store, check it is the second operand.
3030 if (auto StoreI = dyn_cast<StoreInst>(U))
3031 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3032 "swifterror value should be the second operand when used "
3033 "by stores", SwiftErrorVal, U);
3034 if (auto CallI = dyn_cast<CallInst>(U))
3035 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3036 if (auto II = dyn_cast<InvokeInst>(U))
3037 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3038 }
3039}
3040
Victor Hernandez8acf2952009-10-23 21:09:37 +00003041void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003042 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003043 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003044 Assert(PTy->getAddressSpace() == 0,
3045 "Allocation instruction pointer not in the generic address space!",
3046 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003047 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003048 "Cannot allocate unsized type", &AI);
3049 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3050 "Alloca array size must have integer type", &AI);
3051 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3052 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003053
Manman Ren9bfd0d02016-04-01 21:41:15 +00003054 if (AI.isSwiftError()) {
3055 verifySwiftErrorValue(&AI);
3056 }
3057
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003058 visitInstruction(AI);
3059}
3060
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003061void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003062
3063 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003064 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003065 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003066 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003067 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003068 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003069 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003070 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003071 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003072 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3073 "cmpxchg instructions failure argument shall be no stronger than the "
3074 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003075 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003076 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3077 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003078 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003079
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003080 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003081 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003082 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003083 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3084 "cmpxchg operand must have integer or pointer type",
3085 ElTy, &CXI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003086 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003087 Assert(ElTy == CXI.getOperand(1)->getType(),
3088 "Expected value type does not match pointer operand type!", &CXI,
3089 ElTy);
3090 Assert(ElTy == CXI.getOperand(2)->getType(),
3091 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003092 visitInstruction(CXI);
3093}
3094
3095void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003096 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003097 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003098 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003099 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003100 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003101 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003102 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003103 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3104 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00003105 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003106 Assert(ElTy == RMWI.getOperand(1)->getType(),
3107 "Argument value type does not match pointer operand type!", &RMWI,
3108 ElTy);
3109 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3110 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3111 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003112 visitInstruction(RMWI);
3113}
3114
Eli Friedmanfee02c62011-07-25 23:16:38 +00003115void Verifier::visitFenceInst(FenceInst &FI) {
3116 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003117 Assert(Ordering == AtomicOrdering::Acquire ||
3118 Ordering == AtomicOrdering::Release ||
3119 Ordering == AtomicOrdering::AcquireRelease ||
3120 Ordering == AtomicOrdering::SequentiallyConsistent,
3121 "fence instructions may only have acquire, release, acq_rel, or "
3122 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003123 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003124 visitInstruction(FI);
3125}
3126
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003127void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003128 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3129 EVI.getIndices()) == EVI.getType(),
3130 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003131
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003132 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003133}
3134
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003135void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003136 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3137 IVI.getIndices()) ==
3138 IVI.getOperand(1)->getType(),
3139 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003140
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003141 visitInstruction(IVI);
3142}
Chris Lattner0e851da2002-04-18 20:37:37 +00003143
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003144static Value *getParentPad(Value *EHPad) {
3145 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3146 return FPI->getParentPad();
3147
3148 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3149}
3150
David Majnemer85a549d2015-08-11 02:48:30 +00003151void Verifier::visitEHPadPredecessors(Instruction &I) {
3152 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003153
David Majnemer85a549d2015-08-11 02:48:30 +00003154 BasicBlock *BB = I.getParent();
3155 Function *F = BB->getParent();
3156
3157 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3158
3159 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3160 // The landingpad instruction defines its parent as a landing pad block. The
3161 // landing pad block may be branched to only by the unwind edge of an
3162 // invoke.
3163 for (BasicBlock *PredBB : predecessors(BB)) {
3164 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3165 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3166 "Block containing LandingPadInst must be jumped to "
3167 "only by the unwind edge of an invoke.",
3168 LPI);
3169 }
3170 return;
3171 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003172 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3173 if (!pred_empty(BB))
3174 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3175 "Block containg CatchPadInst must be jumped to "
3176 "only by its catchswitch.",
3177 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003178 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3179 "Catchswitch cannot unwind to one of its catchpads",
3180 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003181 return;
3182 }
David Majnemer85a549d2015-08-11 02:48:30 +00003183
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003184 // Verify that each pred has a legal terminator with a legal to/from EH
3185 // pad relationship.
3186 Instruction *ToPad = &I;
3187 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003188 for (BasicBlock *PredBB : predecessors(BB)) {
3189 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003190 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003191 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003192 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003193 "EH pad must be jumped to via an unwind edge", ToPad, II);
3194 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3195 FromPad = Bundle->Inputs[0];
3196 else
3197 FromPad = ConstantTokenNone::get(II->getContext());
3198 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003199 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003200 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3201 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3202 FromPad = CSI;
3203 } else {
3204 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3205 }
3206
3207 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003208 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003209 for (;; FromPad = getParentPad(FromPad)) {
3210 Assert(FromPad != ToPad,
3211 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3212 if (FromPad == ToPadParent) {
3213 // This is a legal unwind edge.
3214 break;
3215 }
3216 Assert(!isa<ConstantTokenNone>(FromPad),
3217 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003218 Assert(Seen.insert(FromPad).second,
3219 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003220 }
David Majnemer85a549d2015-08-11 02:48:30 +00003221 }
3222}
3223
3224void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003225 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3226 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003227 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3228 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003229
David Majnemer85a549d2015-08-11 02:48:30 +00003230 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003231
David Majnemer654e1302015-07-31 17:58:14 +00003232 if (!LandingPadResultTy)
3233 LandingPadResultTy = LPI.getType();
3234 else
3235 Assert(LandingPadResultTy == LPI.getType(),
3236 "The landingpad instruction should have a consistent result type "
3237 "inside a function.",
3238 &LPI);
3239
David Majnemer7fddecc2015-06-17 20:52:32 +00003240 Function *F = LPI.getParent()->getParent();
3241 Assert(F->hasPersonalityFn(),
3242 "LandingPadInst needs to be in a function with a personality.", &LPI);
3243
Bill Wendlingfae14752011-08-12 20:24:12 +00003244 // The landingpad instruction must be the first non-PHI instruction in the
3245 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003246 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3247 "LandingPadInst not the first non-PHI instruction in the block.",
3248 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003249
Duncan Sands86de1a62011-09-27 16:43:19 +00003250 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003251 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003252 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003253 Assert(isa<PointerType>(Clause->getType()),
3254 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003255 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003256 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3257 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3258 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003259 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003260 }
3261
Bill Wendlingfae14752011-08-12 20:24:12 +00003262 visitInstruction(LPI);
3263}
3264
David Majnemer654e1302015-07-31 17:58:14 +00003265void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003266 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003267
David Majnemer654e1302015-07-31 17:58:14 +00003268 Function *F = BB->getParent();
3269 Assert(F->hasPersonalityFn(),
3270 "CatchPadInst needs to be in a function with a personality.", &CPI);
3271
David Majnemer8a1c45d2015-12-12 05:38:55 +00003272 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3273 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3274 CPI.getParentPad());
3275
David Majnemer654e1302015-07-31 17:58:14 +00003276 // The catchpad instruction must be the first non-PHI instruction in the
3277 // block.
3278 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003279 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003280
David Majnemerfe2f7f32016-02-29 22:56:36 +00003281 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003282 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003283}
3284
David Majnemer8a1c45d2015-12-12 05:38:55 +00003285void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3286 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3287 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3288 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003289
David Majnemer8a1c45d2015-12-12 05:38:55 +00003290 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003291}
3292
3293void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3294 BasicBlock *BB = CPI.getParent();
3295
David Majnemer654e1302015-07-31 17:58:14 +00003296 Function *F = BB->getParent();
3297 Assert(F->hasPersonalityFn(),
3298 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3299
3300 // The cleanuppad instruction must be the first non-PHI instruction in the
3301 // block.
3302 Assert(BB->getFirstNonPHI() == &CPI,
3303 "CleanupPadInst not the first non-PHI instruction in the block.",
3304 &CPI);
3305
David Majnemer8a1c45d2015-12-12 05:38:55 +00003306 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003307 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003308 "CleanupPadInst has an invalid parent.", &CPI);
3309
David Majnemerfe2f7f32016-02-29 22:56:36 +00003310 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003311 visitFuncletPadInst(CPI);
3312}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003313
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003314void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3315 User *FirstUser = nullptr;
3316 Value *FirstUnwindPad = nullptr;
3317 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003318 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003319
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003320 while (!Worklist.empty()) {
3321 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003322 Assert(Seen.insert(CurrentPad).second,
3323 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003324 Value *UnresolvedAncestorPad = nullptr;
3325 for (User *U : CurrentPad->users()) {
3326 BasicBlock *UnwindDest;
3327 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3328 UnwindDest = CRI->getUnwindDest();
3329 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3330 // We allow catchswitch unwind to caller to nest
3331 // within an outer pad that unwinds somewhere else,
3332 // because catchswitch doesn't have a nounwind variant.
3333 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3334 if (CSI->unwindsToCaller())
3335 continue;
3336 UnwindDest = CSI->getUnwindDest();
3337 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3338 UnwindDest = II->getUnwindDest();
3339 } else if (isa<CallInst>(U)) {
3340 // Calls which don't unwind may be found inside funclet
3341 // pads that unwind somewhere else. We don't *require*
3342 // such calls to be annotated nounwind.
3343 continue;
3344 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3345 // The unwind dest for a cleanup can only be found by
3346 // recursive search. Add it to the worklist, and we'll
3347 // search for its first use that determines where it unwinds.
3348 Worklist.push_back(CPI);
3349 continue;
3350 } else {
3351 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3352 continue;
3353 }
3354
3355 Value *UnwindPad;
3356 bool ExitsFPI;
3357 if (UnwindDest) {
3358 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003359 if (!cast<Instruction>(UnwindPad)->isEHPad())
3360 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003361 Value *UnwindParent = getParentPad(UnwindPad);
3362 // Ignore unwind edges that don't exit CurrentPad.
3363 if (UnwindParent == CurrentPad)
3364 continue;
3365 // Determine whether the original funclet pad is exited,
3366 // and if we are scanning nested pads determine how many
3367 // of them are exited so we can stop searching their
3368 // children.
3369 Value *ExitedPad = CurrentPad;
3370 ExitsFPI = false;
3371 do {
3372 if (ExitedPad == &FPI) {
3373 ExitsFPI = true;
3374 // Now we can resolve any ancestors of CurrentPad up to
3375 // FPI, but not including FPI since we need to make sure
3376 // to check all direct users of FPI for consistency.
3377 UnresolvedAncestorPad = &FPI;
3378 break;
3379 }
3380 Value *ExitedParent = getParentPad(ExitedPad);
3381 if (ExitedParent == UnwindParent) {
3382 // ExitedPad is the ancestor-most pad which this unwind
3383 // edge exits, so we can resolve up to it, meaning that
3384 // ExitedParent is the first ancestor still unresolved.
3385 UnresolvedAncestorPad = ExitedParent;
3386 break;
3387 }
3388 ExitedPad = ExitedParent;
3389 } while (!isa<ConstantTokenNone>(ExitedPad));
3390 } else {
3391 // Unwinding to caller exits all pads.
3392 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3393 ExitsFPI = true;
3394 UnresolvedAncestorPad = &FPI;
3395 }
3396
3397 if (ExitsFPI) {
3398 // This unwind edge exits FPI. Make sure it agrees with other
3399 // such edges.
3400 if (FirstUser) {
3401 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3402 "pad must have the same unwind "
3403 "dest",
3404 &FPI, U, FirstUser);
3405 } else {
3406 FirstUser = U;
3407 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003408 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3409 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3410 getParentPad(UnwindPad) == getParentPad(&FPI))
3411 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003412 }
3413 }
3414 // Make sure we visit all uses of FPI, but for nested pads stop as
3415 // soon as we know where they unwind to.
3416 if (CurrentPad != &FPI)
3417 break;
3418 }
3419 if (UnresolvedAncestorPad) {
3420 if (CurrentPad == UnresolvedAncestorPad) {
3421 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3422 // we've found an unwind edge that exits it, because we need to verify
3423 // all direct uses of FPI.
3424 assert(CurrentPad == &FPI);
3425 continue;
3426 }
3427 // Pop off the worklist any nested pads that we've found an unwind
3428 // destination for. The pads on the worklist are the uncles,
3429 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3430 // for all ancestors of CurrentPad up to but not including
3431 // UnresolvedAncestorPad.
3432 Value *ResolvedPad = CurrentPad;
3433 while (!Worklist.empty()) {
3434 Value *UnclePad = Worklist.back();
3435 Value *AncestorPad = getParentPad(UnclePad);
3436 // Walk ResolvedPad up the ancestor list until we either find the
3437 // uncle's parent or the last resolved ancestor.
3438 while (ResolvedPad != AncestorPad) {
3439 Value *ResolvedParent = getParentPad(ResolvedPad);
3440 if (ResolvedParent == UnresolvedAncestorPad) {
3441 break;
3442 }
3443 ResolvedPad = ResolvedParent;
3444 }
3445 // If the resolved ancestor search didn't find the uncle's parent,
3446 // then the uncle is not yet resolved.
3447 if (ResolvedPad != AncestorPad)
3448 break;
3449 // This uncle is resolved, so pop it from the worklist.
3450 Worklist.pop_back();
3451 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003452 }
3453 }
3454
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003455 if (FirstUnwindPad) {
3456 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3457 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3458 Value *SwitchUnwindPad;
3459 if (SwitchUnwindDest)
3460 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3461 else
3462 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3463 Assert(SwitchUnwindPad == FirstUnwindPad,
3464 "Unwind edges out of a catch must have the same unwind dest as "
3465 "the parent catchswitch",
3466 &FPI, FirstUser, CatchSwitch);
3467 }
3468 }
3469
3470 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003471}
3472
David Majnemer8a1c45d2015-12-12 05:38:55 +00003473void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003474 BasicBlock *BB = CatchSwitch.getParent();
3475
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003476 Function *F = BB->getParent();
3477 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003478 "CatchSwitchInst needs to be in a function with a personality.",
3479 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003480
David Majnemer8a1c45d2015-12-12 05:38:55 +00003481 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003482 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003483 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3484 "CatchSwitchInst not the first non-PHI instruction in the block.",
3485 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003486
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003487 auto *ParentPad = CatchSwitch.getParentPad();
3488 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3489 "CatchSwitchInst has an invalid parent.", ParentPad);
3490
David Majnemer8a1c45d2015-12-12 05:38:55 +00003491 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003492 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003493 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3494 "CatchSwitchInst must unwind to an EH block which is not a "
3495 "landingpad.",
3496 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003497
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003498 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3499 if (getParentPad(I) == ParentPad)
3500 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3501 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003502
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003503 Assert(CatchSwitch.getNumHandlers() != 0,
3504 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3505
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003506 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003507 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3508 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003509 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003510
David Majnemerfe2f7f32016-02-29 22:56:36 +00003511 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003512 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003513}
3514
David Majnemer654e1302015-07-31 17:58:14 +00003515void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003516 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3517 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3518 CRI.getOperand(0));
3519
David Majnemer654e1302015-07-31 17:58:14 +00003520 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3521 Instruction *I = UnwindDest->getFirstNonPHI();
3522 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3523 "CleanupReturnInst must unwind to an EH block which is not a "
3524 "landingpad.",
3525 &CRI);
3526 }
3527
3528 visitTerminatorInst(CRI);
3529}
3530
Rafael Espindola654320a2012-02-26 02:23:37 +00003531void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3532 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003533 // If the we have an invalid invoke, don't try to compute the dominance.
3534 // We already reject it in the invoke specific checks and the dominance
3535 // computation doesn't handle multiple edges.
3536 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3537 if (II->getNormalDest() == II->getUnwindDest())
3538 return;
3539 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003540
Michael Kruseff379b62016-03-26 23:32:57 +00003541 // Quick check whether the def has already been encountered in the same block.
3542 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3543 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003544 //
3545 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3546 // wrapping an SSA value, assert that we've already encountered it. See
3547 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003548 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3549 return;
3550
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003551 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003552 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003553 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003554}
3555
Artur Pilipenkocca80022015-10-09 17:41:29 +00003556void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3557 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3558 "apply only to pointer types", &I);
3559 Assert(isa<LoadInst>(I),
3560 "dereferenceable, dereferenceable_or_null apply only to load"
3561 " instructions, use attributes for calls or invokes", &I);
3562 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3563 "take one operand!", &I);
3564 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3565 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3566 "dereferenceable_or_null metadata value must be an i64!", &I);
3567}
3568
Misha Brukmanc566ca362004-03-02 00:22:19 +00003569/// verifyInstruction - Verify that an instruction is well formed.
3570///
Chris Lattner069a7952002-06-25 15:56:27 +00003571void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003572 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003573 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003574
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003575 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003576 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003577 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3578 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003579 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003580 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003581
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003582 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003583 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3584 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003585
Chris Lattner5f126b72004-03-29 00:29:36 +00003586 // Check that the return value of the instruction is either void or a legal
3587 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003588 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3589 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003590
Nick Lewycky93e06a52009-09-27 23:27:42 +00003591 // Check that the instruction doesn't produce metadata. Calls are already
3592 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003593 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3594 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003595
Chris Lattner0e851da2002-04-18 20:37:37 +00003596 // Check that all uses of the instruction, if they are instructions
3597 // themselves, actually have parent basic blocks. If the use is not an
3598 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003599 for (Use &U : I.uses()) {
3600 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003601 Assert(Used->getParent() != nullptr,
3602 "Instruction referencing"
3603 " instruction not embedded in a basic block!",
3604 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003605 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003606 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003607 return;
3608 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003609 }
3610
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003611 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003612 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003613
3614 // Check to make sure that only first-class-values are operands to
3615 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003616 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003617 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003618 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003619
Chris Lattner9ece94b2004-03-14 03:23:54 +00003620 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003621 // Check to make sure that the "address of" an intrinsic function is never
3622 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003623 Assert(
3624 !F->isIntrinsic() ||
3625 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3626 "Cannot take the address of an intrinsic!", &I);
3627 Assert(
3628 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003629 F->getIntrinsicID() == Intrinsic::donothing ||
3630 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003631 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3632 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Sanjoy Das999dc752016-02-29 22:04:25 +00003633 "Cannot invoke an intrinsic other than donothing, patchpoint or "
3634 "statepoint",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003635 &I);
3636 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003637 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003638 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003639 Assert(OpBB->getParent() == BB->getParent(),
3640 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003641 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003642 Assert(OpArg->getParent() == BB->getParent(),
3643 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003644 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003645 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003646 } else if (isa<Instruction>(I.getOperand(i))) {
3647 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003648 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003649 Assert((i + 1 == e && isa<CallInst>(I)) ||
3650 (i + 3 == e && isa<InvokeInst>(I)),
3651 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003652 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3653 if (CE->getType()->isPtrOrPtrVectorTy()) {
3654 // If we have a ConstantExpr pointer, we need to see if it came from an
3655 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003656 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003657 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003658 }
3659 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003660
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003661 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003662 Assert(I.getType()->isFPOrFPVectorTy(),
3663 "fpmath requires a floating point result!", &I);
3664 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003665 if (ConstantFP *CFP0 =
3666 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003667 const APFloat &Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003668 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3669 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003670 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003671 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003672 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003673 }
3674
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003675 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003676 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3677 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003678 visitRangeMetadata(I, Range, I.getType());
3679 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003680
Philip Reames0ca58b32014-10-21 20:56:29 +00003681 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003682 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3683 &I);
3684 Assert(isa<LoadInst>(I),
3685 "nonnull applies only to load instructions, use attributes"
3686 " for calls or invokes",
3687 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003688 }
3689
Artur Pilipenkocca80022015-10-09 17:41:29 +00003690 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3691 visitDereferenceableMetadata(I, MD);
3692
3693 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3694 visitDereferenceableMetadata(I, MD);
3695
3696 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3697 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3698 &I);
3699 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3700 "use attributes for calls or invokes", &I);
3701 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3702 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3703 Assert(CI && CI->getType()->isIntegerTy(64),
3704 "align metadata value must be an i64!", &I);
3705 uint64_t Align = CI->getZExtValue();
3706 Assert(isPowerOf2_64(Align),
3707 "align metadata value must be a power of 2!", &I);
3708 Assert(Align <= Value::MaximumAlignment,
3709 "alignment is larger that implementation defined limit", &I);
3710 }
3711
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003712 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003713 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003714 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003715 }
3716
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003717 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3718 verifyBitPieceExpression(*DII);
3719
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003720 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003721}
3722
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003723/// Verify that the specified type (which comes from an intrinsic argument or
3724/// return value) matches the type constraints specified by the .td file (e.g.
3725/// an "any integer" argument really is an integer).
Chris Lattner144b6192012-05-27 19:37:05 +00003726///
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003727/// This returns true on error but does not print a message.
3728bool Verifier::verifyIntrinsicType(Type *Ty,
Chris Lattner144b6192012-05-27 19:37:05 +00003729 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3730 SmallVectorImpl<Type*> &ArgTys) {
3731 using namespace Intrinsic;
3732
3733 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003734 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003735 IITDescriptor D = Infos.front();
3736 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003737
Chris Lattner144b6192012-05-27 19:37:05 +00003738 switch (D.Kind) {
3739 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003740 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003741 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003742 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003743 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003744 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003745 case IITDescriptor::Float: return !Ty->isFloatTy();
3746 case IITDescriptor::Double: return !Ty->isDoubleTy();
3747 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3748 case IITDescriptor::Vector: {
3749 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003750 return !VT || VT->getNumElements() != D.Vector_Width ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003751 verifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003752 }
3753 case IITDescriptor::Pointer: {
3754 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003755 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003756 verifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003757 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003758
Chris Lattner144b6192012-05-27 19:37:05 +00003759 case IITDescriptor::Struct: {
3760 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003761 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003762 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003763
Chris Lattner144b6192012-05-27 19:37:05 +00003764 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003765 if (verifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
Chris Lattner144b6192012-05-27 19:37:05 +00003766 return true;
3767 return false;
3768 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003769
Chris Lattner144b6192012-05-27 19:37:05 +00003770 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003771 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003772 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003773 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003774 return Ty != ArgTys[D.getArgumentNumber()];
3775
Chris Lattner144b6192012-05-27 19:37:05 +00003776 // Otherwise, if this is the first instance of an argument, record it and
3777 // verify the "Any" kind.
3778 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3779 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003780
Chris Lattner144b6192012-05-27 19:37:05 +00003781 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003782 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003783 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3784 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3785 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3786 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3787 }
3788 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003789
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003790 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003791 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003792 if (D.getArgumentNumber() >= ArgTys.size())
3793 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003794
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003795 Type *NewTy = ArgTys[D.getArgumentNumber()];
3796 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3797 NewTy = VectorType::getExtendedElementVectorType(VTy);
3798 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3799 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3800 else
3801 return true;
3802
3803 return Ty != NewTy;
3804 }
3805 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003806 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003807 if (D.getArgumentNumber() >= ArgTys.size())
3808 return true;
3809
3810 Type *NewTy = ArgTys[D.getArgumentNumber()];
3811 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3812 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3813 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3814 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3815 else
3816 return true;
3817
3818 return Ty != NewTy;
3819 }
Tim Northover4516de32014-03-29 07:04:54 +00003820 case IITDescriptor::HalfVecArgument:
3821 // This may only be used when referring to a previous vector argument.
3822 return D.getArgumentNumber() >= ArgTys.size() ||
3823 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3824 VectorType::getHalfElementsVectorType(
3825 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003826 case IITDescriptor::SameVecWidthArgument: {
3827 if (D.getArgumentNumber() >= ArgTys.size())
3828 return true;
3829 VectorType * ReferenceType =
3830 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3831 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3832 if (!ThisArgType || !ReferenceType ||
3833 (ReferenceType->getVectorNumElements() !=
3834 ThisArgType->getVectorNumElements()))
3835 return true;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003836 return verifyIntrinsicType(ThisArgType->getVectorElementType(),
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003837 Infos, ArgTys);
3838 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003839 case IITDescriptor::PtrToArgument: {
3840 if (D.getArgumentNumber() >= ArgTys.size())
3841 return true;
3842 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3843 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3844 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3845 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003846 case IITDescriptor::VecOfPtrsToElt: {
3847 if (D.getArgumentNumber() >= ArgTys.size())
3848 return true;
3849 VectorType * ReferenceType =
3850 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3851 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3852 if (!ThisArgVecTy || !ReferenceType ||
3853 (ReferenceType->getVectorNumElements() !=
3854 ThisArgVecTy->getVectorNumElements()))
3855 return true;
3856 PointerType *ThisArgEltTy =
3857 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3858 if (!ThisArgEltTy)
3859 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003860 return ThisArgEltTy->getElementType() !=
3861 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003862 }
Chris Lattner144b6192012-05-27 19:37:05 +00003863 }
3864 llvm_unreachable("unhandled");
3865}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003866
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003867/// Verify if the intrinsic has variable arguments. This method is intended to
3868/// be called after all the fixed arguments have been verified first.
Andrew Tricka2efd992013-10-31 17:18:11 +00003869///
3870/// This method returns true on error and does not print an error message.
3871bool
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003872Verifier::verifyIntrinsicIsVarArg(bool isVarArg,
Andrew Tricka2efd992013-10-31 17:18:11 +00003873 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3874 using namespace Intrinsic;
3875
3876 // If there are no descriptors left, then it can't be a vararg.
3877 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003878 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003879
3880 // There should be only one descriptor remaining at this point.
3881 if (Infos.size() != 1)
3882 return true;
3883
3884 // Check and verify the descriptor.
3885 IITDescriptor D = Infos.front();
3886 Infos = Infos.slice(1);
3887 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003888 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003889
3890 return true;
3891}
3892
Philip Reames007561a2015-06-26 22:21:52 +00003893/// Allow intrinsics to be verified in different ways.
3894void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003895 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003896 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3897 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003898
Chris Lattner144b6192012-05-27 19:37:05 +00003899 // Verify that the intrinsic prototype lines up with what the .td files
3900 // describe.
3901 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003902 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003903
Chris Lattner144b6192012-05-27 19:37:05 +00003904 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3905 getIntrinsicInfoTableEntries(ID, Table);
3906 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003907
Chris Lattner144b6192012-05-27 19:37:05 +00003908 SmallVector<Type *, 4> ArgTys;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003909 Assert(!verifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003910 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003911 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003912 Assert(!verifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003913 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003914
3915 // Verify if the intrinsic call matches the vararg property.
3916 if (IsVarArg)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003917 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003918 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003919 else
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003920 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003921 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003922
3923 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003924 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003925
3926 // Now that we have the intrinsic ID and the actual argument types (and we
3927 // know they are legal for the intrinsic!) get the intrinsic name through the
3928 // usual means. This allows us to verify the mangling of argument types into
3929 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003930 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003931 Assert(ExpectedName == IF->getName(),
3932 "Intrinsic name not mangled correctly for type arguments! "
3933 "Should be: " +
3934 ExpectedName,
3935 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003936
Chris Lattner588096e2009-12-28 09:07:21 +00003937 // If the intrinsic takes MDNode arguments, verify that they are either global
3938 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003939 for (Value *V : CS.args())
3940 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3941 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003942
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003943 switch (ID) {
3944 default:
3945 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003946 case Intrinsic::ctlz: // llvm.ctlz
3947 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003948 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003949 "is_zero_undef argument of bit counting intrinsics must be a "
3950 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003951 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003952 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003953 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003954 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3955 "invalid llvm.dbg.declare intrinsic call 1", CS);
3956 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003957 break;
3958 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003959 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003960 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003961 case Intrinsic::memcpy:
3962 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003963 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003964 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003965 Assert(AlignCI,
3966 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003967 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003968 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003969 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003970 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003971 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003972 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003973 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003974 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003975 }
Bill Wendling05604e02008-08-23 09:46:46 +00003976 case Intrinsic::gcroot:
3977 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003978 case Intrinsic::gcread:
3979 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003980 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003981 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3982 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3983 Assert(isa<Constant>(CS.getArgOperand(1)),
3984 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003985 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003986 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003987 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3988 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003989 CS);
Talin2e59f142010-09-30 20:23:47 +00003990 }
Chris Lattner25852062008-08-24 20:46:13 +00003991 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003992
Philip Reames9818dd72015-06-26 22:04:34 +00003993 Assert(CS.getParent()->getParent()->hasGC(),
3994 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003995 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003996 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003997 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003998 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003999 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004000 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004001 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004002 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4003 isa<ConstantInt>(CS.getArgOperand(2)) &&
4004 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4005 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4006 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004007 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004008 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004009 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4010 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004011 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004012 case Intrinsic::lifetime_start:
4013 case Intrinsic::lifetime_end:
4014 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004015 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004016 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004017 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004018 break;
4019 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004020 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4021 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004022 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004023
Reid Kleckner60381792015-07-07 22:25:32 +00004024 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004025 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004026 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004027 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004028 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004029 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004030 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004031 if (isa<ConstantPointerNull>(Arg))
4032 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004033 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004034 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004035 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004036 }
Philip Reames9818dd72015-06-26 22:04:34 +00004037 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004038 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004039 break;
4040 }
Reid Kleckner60381792015-07-07 22:25:32 +00004041 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004042 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004043 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004044 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004045 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004046 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004047 CS);
4048 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004049 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004050 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004051 auto &Entry = FrameEscapeInfo[Fn];
4052 Entry.second = unsigned(
4053 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004054 break;
4055 }
4056
Philip Reames1ffa9372015-01-30 23:28:05 +00004057 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004058 Assert(!CS.isInlineAsm(),
4059 "gc.statepoint support for inline assembly unimplemented", CS);
4060 Assert(CS.getParent()->getParent()->hasGC(),
4061 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004062
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004063 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004064 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004065 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004066 Assert(CS.getParent()->getParent()->hasGC(),
4067 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004068 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004069 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004070 const Function *StatepointFn =
4071 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004072 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4073 StatepointFn->getIntrinsicID() ==
4074 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004075 "gc.result operand #1 must be from a statepoint", CS,
4076 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004077
Philip Reamesb23713a2014-12-03 22:23:24 +00004078 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004079 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004080 auto *PT = cast<PointerType>(Target->getType());
4081 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004082 Assert(CS.getType() == TargetFuncType->getReturnType(),
4083 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004084 break;
4085 }
4086 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004087 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004088
Philip Reames3e2cf532016-01-07 03:32:11 +00004089 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4090 "gc.relocate must return a pointer or a vector of pointers", CS);
4091
Igor Laevsky9570ff92015-02-19 11:28:47 +00004092 // Check that this relocate is correctly tied to the statepoint
4093
4094 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004095 if (LandingPadInst *LandingPad =
4096 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004097
Sanjoy Das5665c992015-05-11 23:47:27 +00004098 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004099 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004100
4101 // Landingpad relocates should have only one predecessor with invoke
4102 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004103 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004104 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004105 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4106 InvokeBB);
4107 Assert(isStatepoint(InvokeBB->getTerminator()),
4108 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004109 }
4110 else {
4111 // In all other cases relocate should be tied to the statepoint directly.
4112 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004113 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004114 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004115 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004116 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004117 }
4118
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004119 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004120
Manuel Jacob83eefa62016-01-05 04:03:00 +00004121 ImmutableCallSite StatepointCS(
4122 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004123
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004124 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004125 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004126 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004127 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004128
Philip Reames9818dd72015-06-26 22:04:34 +00004129 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004130 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004131 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004132
4133 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4134 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4135 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004136 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004137 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004138 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004139 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004140
4141 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004142 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004143 Assert(StatepointCS.arg_size() > 0,
4144 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004145 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004146 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004147 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004148 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4149 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004150 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004151 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004152 "gc.statepoint: number of transition arguments must be "
4153 "a constant integer");
4154 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004155 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4156 ->getZExtValue();
4157 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004158 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004159 "gc.statepoint: number of deoptimization arguments must be "
4160 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004161 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004162 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4163 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004164 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004165 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004166 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4167 "gc.relocate: statepoint base index doesn't fall within the "
4168 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004169 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004170 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4171 "gc.relocate: statepoint derived index doesn't fall within the "
4172 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004173 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004174
Philip Reames3e2cf532016-01-07 03:32:11 +00004175 // Relocated value must be either a pointer type or vector-of-pointer type,
4176 // but gc_relocate does not need to return the same pointer type as the
4177 // relocated pointer. It can be casted to the correct type later if it's
4178 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004179 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004180 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004181 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004182
Philip Reames3e2cf532016-01-07 03:32:11 +00004183 auto ResultType = CS.getType();
4184 auto DerivedType = Relocate.getDerivedPtr()->getType();
4185 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004186 "gc.relocate: vector relocates to vector and pointer to pointer",
4187 CS);
4188 Assert(
4189 ResultType->getPointerAddressSpace() ==
4190 DerivedType->getPointerAddressSpace(),
4191 "gc.relocate: relocating a pointer shouldn't change its address space",
4192 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004193 break;
4194 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004195 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004196 case Intrinsic::eh_exceptionpointer: {
4197 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4198 "eh.exceptionpointer argument must be a catchpad", CS);
4199 break;
4200 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004201 case Intrinsic::masked_load: {
4202 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4203
4204 Value *Ptr = CS.getArgOperand(0);
4205 //Value *Alignment = CS.getArgOperand(1);
4206 Value *Mask = CS.getArgOperand(2);
4207 Value *PassThru = CS.getArgOperand(3);
4208 Assert(Mask->getType()->isVectorTy(),
4209 "masked_load: mask must be vector", CS);
4210
4211 // DataTy is the overloaded type
4212 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4213 Assert(DataTy == CS.getType(),
4214 "masked_load: return must match pointer type", CS);
4215 Assert(PassThru->getType() == DataTy,
4216 "masked_load: pass through and data type must match", CS);
4217 Assert(Mask->getType()->getVectorNumElements() ==
4218 DataTy->getVectorNumElements(),
4219 "masked_load: vector mask must be same length as data", CS);
4220 break;
4221 }
4222 case Intrinsic::masked_store: {
4223 Value *Val = CS.getArgOperand(0);
4224 Value *Ptr = CS.getArgOperand(1);
4225 //Value *Alignment = CS.getArgOperand(2);
4226 Value *Mask = CS.getArgOperand(3);
4227 Assert(Mask->getType()->isVectorTy(),
4228 "masked_store: mask must be vector", CS);
4229
4230 // DataTy is the overloaded type
4231 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4232 Assert(DataTy == Val->getType(),
4233 "masked_store: storee must match pointer type", CS);
4234 Assert(Mask->getType()->getVectorNumElements() ==
4235 DataTy->getVectorNumElements(),
4236 "masked_store: vector mask must be same length as data", CS);
4237 break;
4238 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004239
Sanjoy Das021de052016-03-31 00:18:46 +00004240 case Intrinsic::experimental_guard: {
4241 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4242 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4243 "experimental_guard must have exactly one "
4244 "\"deopt\" operand bundle");
4245 break;
4246 }
4247
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004248 case Intrinsic::experimental_deoptimize: {
4249 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4250 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4251 "experimental_deoptimize must have exactly one "
4252 "\"deopt\" operand bundle");
4253 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4254 "experimental_deoptimize return type must match caller return type");
4255
4256 if (CS.isCall()) {
4257 auto *DeoptCI = CS.getInstruction();
4258 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4259 Assert(RI,
4260 "calls to experimental_deoptimize must be followed by a return");
4261
4262 if (!CS.getType()->isVoidTy() && RI)
4263 Assert(RI->getReturnValue() == DeoptCI,
4264 "calls to experimental_deoptimize must be followed by a return "
4265 "of the value computed by experimental_deoptimize");
4266 }
4267
4268 break;
4269 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004270 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004271}
4272
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004273/// \brief Carefully grab the subprogram from a local scope.
4274///
4275/// This carefully grabs the subprogram from a local scope, avoiding the
4276/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004277static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004278 if (!LocalScope)
4279 return nullptr;
4280
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004281 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004282 return SP;
4283
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004284 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004285 return getSubprogram(LB->getRawScope());
4286
4287 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004288 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004289 return nullptr;
4290}
4291
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004292template <class DbgIntrinsicTy>
4293void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4294 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004295 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004296 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4297 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004298 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004299 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4300 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004301 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004302 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4303 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004304
4305 // Ignore broken !dbg attachments; they're checked elsewhere.
4306 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004307 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004308 return;
4309
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004310 BasicBlock *BB = DII.getParent();
4311 Function *F = BB ? BB->getParent() : nullptr;
4312
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004313 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004314 DILocalVariable *Var = DII.getVariable();
4315 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004316 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4317 &DII, BB, F);
4318
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004319 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4320 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004321 if (!VarSP || !LocSP)
4322 return; // Broken scope chains are checked elsewhere.
4323
4324 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4325 " variable and !dbg attachment",
4326 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4327 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004328}
4329
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004330static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004331 // Be careful of broken types (checked elsewhere).
4332 const Metadata *RawType = V.getRawType();
4333 while (RawType) {
4334 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004335 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004336 if (uint64_t Size = T->getSizeInBits())
4337 return Size;
4338
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004339 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004340 // Look at the base type.
4341 RawType = DT->getRawBaseType();
4342 continue;
4343 }
4344
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004345 // Missing type or size.
4346 break;
4347 }
4348
4349 // Fail gracefully.
4350 return 0;
4351}
4352
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004353void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004354 DILocalVariable *V;
4355 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004356 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004357 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4358 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004359 } else {
4360 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004361 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4362 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004363 }
4364
4365 // We don't know whether this intrinsic verified correctly.
4366 if (!V || !E || !E->isValid())
4367 return;
4368
Keno Fischer253a7bd2016-01-15 02:12:38 +00004369 // Nothing to do if this isn't a bit piece expression.
4370 if (!E->isBitPiece())
4371 return;
4372
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004373 // The frontend helps out GDB by emitting the members of local anonymous
4374 // unions as artificial local variables with shared storage. When SROA splits
4375 // the storage for artificial local variables that are smaller than the entire
4376 // union, the overhang piece will be outside of the allotted space for the
4377 // variable and this check fails.
4378 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4379 if (V->isArtificial())
4380 return;
4381
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004382 // If there's no size, the type is broken, but that should be checked
4383 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004384 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004385 if (!VarSize)
4386 return;
4387
Keno Fischer253a7bd2016-01-15 02:12:38 +00004388 unsigned PieceSize = E->getBitPieceSize();
4389 unsigned PieceOffset = E->getBitPieceOffset();
4390 Assert(PieceSize + PieceOffset <= VarSize,
4391 "piece is larger than or outside of variable", &I, V, E);
4392 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004393}
4394
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004395void Verifier::verifyCompileUnits() {
4396 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4397 SmallPtrSet<const Metadata *, 2> Listed;
4398 if (CUs)
4399 Listed.insert(CUs->op_begin(), CUs->op_end());
4400 Assert(
4401 std::all_of(CUVisited.begin(), CUVisited.end(),
4402 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
4403 "All DICompileUnits must be listed in llvm.dbg.cu");
4404 CUVisited.clear();
4405}
4406
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004407void Verifier::verifyDeoptimizeCallingConvs() {
4408 if (DeoptimizeDeclarations.empty())
4409 return;
4410
4411 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004412 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004413 Assert(First->getCallingConv() == F->getCallingConv(),
4414 "All llvm.experimental.deoptimize declarations must have the same "
4415 "calling convention",
4416 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004417 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004418}
4419
Chris Lattner0e851da2002-04-18 20:37:37 +00004420//===----------------------------------------------------------------------===//
4421// Implement the public interfaces to this file...
4422//===----------------------------------------------------------------------===//
4423
Chandler Carruth043949d2014-01-19 02:22:18 +00004424bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004425 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004426
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004427 // Don't use a raw_null_ostream. Printing IR is expensive.
Adrian Prantl541a9c52016-05-06 19:26:47 +00004428 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true);
Chandler Carruth043949d2014-01-19 02:22:18 +00004429
4430 // Note that this function's return value is inverted from what you would
4431 // expect of a function called "verify".
4432 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004433}
4434
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004435bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4436 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004437 // Don't use a raw_null_ostream. Printing IR is expensive.
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004438 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004439
Chandler Carruth043949d2014-01-19 02:22:18 +00004440 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004441 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004442 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004443
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004444 Broken |= !V.verify(M);
4445 if (BrokenDebugInfo)
4446 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004447 // Note that this function's return value is inverted from what you would
4448 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004449 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004450}
Chandler Carruth043949d2014-01-19 02:22:18 +00004451
4452namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004453struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004454 static char ID;
4455
4456 Verifier V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004457 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004458
Adrian Prantl541a9c52016-05-06 19:26:47 +00004459 VerifierLegacyPass()
4460 : FunctionPass(ID),
Adrian Prantl94a903e2016-05-25 21:33:20 +00004461 V(&dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004462 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004463 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004464 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004465 : FunctionPass(ID),
Adrian Prantl94a903e2016-05-25 21:33:20 +00004466 V(&dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004467 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004468 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004469 }
4470
Craig Topperf398d7c2014-03-05 06:35:38 +00004471 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004472 if (!V.verify(F) && FatalErrors)
4473 report_fatal_error("Broken function found, compilation aborted!");
4474
4475 return false;
4476 }
4477
Craig Topperf398d7c2014-03-05 06:35:38 +00004478 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004479 bool HasErrors = false;
4480 for (Function &F : M)
4481 if (F.isDeclaration())
4482 HasErrors |= !V.verify(F);
4483
4484 HasErrors |= !V.verify(M);
Adrian Prantl94a903e2016-05-25 21:33:20 +00004485 if (FatalErrors) {
4486 if (HasErrors)
4487 report_fatal_error("Broken module found, compilation aborted!");
4488 assert(!V.hasBrokenDebugInfo() && "Module contains invalid debug info");
4489 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004490
Adrian Prantl94a903e2016-05-25 21:33:20 +00004491 // Strip broken debug info.
4492 if (V.hasBrokenDebugInfo()) {
4493 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4494 M.getContext().diagnose(DiagInvalid);
4495 if (!StripDebugInfo(M))
4496 report_fatal_error("Failed to strip malformed debug info");
4497 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004498 return false;
4499 }
4500
4501 void getAnalysisUsage(AnalysisUsage &AU) const override {
4502 AU.setPreservesAll();
4503 }
4504};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004505}
Chandler Carruth043949d2014-01-19 02:22:18 +00004506
Chandler Carruth4d356312014-01-20 11:34:08 +00004507char VerifierLegacyPass::ID = 0;
4508INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004509
4510FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004511 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004512}
4513
Adrian Prantle3656182016-05-09 19:57:29 +00004514char VerifierAnalysis::PassID;
4515VerifierAnalysis::Result VerifierAnalysis::run(Module &M) {
4516 Result Res;
4517 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4518 return Res;
4519}
Chandler Carruth4d356312014-01-20 11:34:08 +00004520
Adrian Prantle3656182016-05-09 19:57:29 +00004521VerifierAnalysis::Result VerifierAnalysis::run(Function &F) {
4522 return { llvm::verifyFunction(F, &dbgs()), false };
4523}
4524
4525PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4526 auto Res = AM.getResult<VerifierAnalysis>(M);
4527 if (FatalErrors) {
4528 if (Res.IRBroken)
4529 report_fatal_error("Broken module found, compilation aborted!");
4530 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4531 }
4532
4533 // Strip broken debug info.
4534 if (Res.DebugInfoBroken) {
4535 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4536 M.getContext().diagnose(DiagInvalid);
4537 if (!StripDebugInfo(M))
4538 report_fatal_error("Failed to strip malformed debug info");
4539 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004540 return PreservedAnalyses::all();
4541}
4542
Adrian Prantle3656182016-05-09 19:57:29 +00004543PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4544 auto res = AM.getResult<VerifierAnalysis>(F);
4545 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004546 report_fatal_error("Broken function found, compilation aborted!");
4547
4548 return PreservedAnalyses::all();
4549}