blob: f7807d1e1b0a398c1aa5293e2544b102eca25f93 [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
279 // information.
Chandler Carruth043949d2014-01-19 02:22:18 +0000280 if (F.empty()) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000281 if (OS)
282 *OS << "Function '" << F.getName()
283 << "' does not contain an entry block!\n";
Chandler Carruth043949d2014-01-19 02:22:18 +0000284 return false;
285 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000286 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000287 if (!BB.empty() && BB.back().isTerminator())
288 continue;
289
290 if (OS) {
291 *OS << "Basic Block in function '" << F.getName()
292 << "' does not have terminator!\n";
Duncan P. N. Exon Smith51e7adf2016-04-20 18:42:51 +0000293 BB.printAsOperand(*OS, true, *MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000294 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000295 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000296 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000297 }
Chandler Carruth76777602014-01-17 10:56:02 +0000298
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000299 // Now directly compute a dominance tree. We don't rely on the pass
300 // manager to provide this as it isolates us from a potentially
301 // out-of-date dominator tree and makes it significantly more complex to
302 // run this code outside of a pass manager.
Chandler Carruth043949d2014-01-19 02:22:18 +0000303 // FIXME: It's really gross that we have to cast away constness here.
304 DT.recalculate(const_cast<Function &>(F));
Chris Lattneraf332ee2007-04-20 23:59:29 +0000305
Chandler Carruth043949d2014-01-19 02:22:18 +0000306 Broken = false;
307 // FIXME: We strip const here because the inst visitor strips const.
308 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000309 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000310 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000311 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000312 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000313 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000314
Chandler Carruth043949d2014-01-19 02:22:18 +0000315 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000316 }
317
Chandler Carruth043949d2014-01-19 02:22:18 +0000318 bool verify(const Module &M) {
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000319 updateModule(&M);
Chandler Carruth043949d2014-01-19 02:22:18 +0000320 Context = &M.getContext();
Chandler Carruth043949d2014-01-19 02:22:18 +0000321 Broken = false;
322
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000323 // Scan through, checking all of the external function's linkage now...
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000324 for (const Function &F : M) {
325 visitGlobalValue(F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000326
327 // Check to make sure function prototypes are okay.
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000328 if (F.isDeclaration()) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000329 visitFunction(F);
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000330 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
331 DeoptimizeDeclarations.push_back(&F);
332 }
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000333 }
334
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000335 // Now that we've visited every function, verify that we never asked to
336 // recover a frame index that wasn't escaped.
337 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000338 for (const GlobalVariable &GV : M.globals())
339 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000340
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000341 for (const GlobalAlias &GA : M.aliases())
342 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000343
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000344 for (const NamedMDNode &NMD : M.named_metadata())
345 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000346
David Majnemerdad0a642014-06-27 18:19:56 +0000347 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
348 visitComdat(SMEC.getValue());
349
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000350 visitModuleFlags(M);
351 visitModuleIdents(M);
352
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000353 verifyCompileUnits();
354
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000355 verifyDeoptimizeCallingConvs();
356
Chandler Carruth043949d2014-01-19 02:22:18 +0000357 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000358 }
Chris Lattner9713b842002-04-28 16:04:26 +0000359
Chandler Carruth043949d2014-01-19 02:22:18 +0000360private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000361 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000362 void visitGlobalValue(const GlobalValue &GV);
363 void visitGlobalVariable(const GlobalVariable &GV);
364 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000365 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000366 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000367 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000368 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000369 void visitMDNode(const MDNode &MD);
370 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
371 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000372 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000373 void visitModuleIdents(const Module &M);
374 void visitModuleFlags(const Module &M);
375 void visitModuleFlag(const MDNode *Op,
376 DenseMap<const MDString *, const MDNode *> &SeenIDs,
377 SmallVectorImpl<const MDNode *> &Requirements);
378 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000379 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000380 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000381 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000382
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000383 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000384#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
385#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000386 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000387 void visitDIVariable(const DIVariable &N);
388 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
389 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000390
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000391 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
392
Chandler Carruth043949d2014-01-19 02:22:18 +0000393 // InstVisitor overrides...
394 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000395 void visit(Instruction &I);
396
397 void visitTruncInst(TruncInst &I);
398 void visitZExtInst(ZExtInst &I);
399 void visitSExtInst(SExtInst &I);
400 void visitFPTruncInst(FPTruncInst &I);
401 void visitFPExtInst(FPExtInst &I);
402 void visitFPToUIInst(FPToUIInst &I);
403 void visitFPToSIInst(FPToSIInst &I);
404 void visitUIToFPInst(UIToFPInst &I);
405 void visitSIToFPInst(SIToFPInst &I);
406 void visitIntToPtrInst(IntToPtrInst &I);
407 void visitPtrToIntInst(PtrToIntInst &I);
408 void visitBitCastInst(BitCastInst &I);
409 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
410 void visitPHINode(PHINode &PN);
411 void visitBinaryOperator(BinaryOperator &B);
412 void visitICmpInst(ICmpInst &IC);
413 void visitFCmpInst(FCmpInst &FC);
414 void visitExtractElementInst(ExtractElementInst &EI);
415 void visitInsertElementInst(InsertElementInst &EI);
416 void visitShuffleVectorInst(ShuffleVectorInst &EI);
417 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
418 void visitCallInst(CallInst &CI);
419 void visitInvokeInst(InvokeInst &II);
420 void visitGetElementPtrInst(GetElementPtrInst &GEP);
421 void visitLoadInst(LoadInst &LI);
422 void visitStoreInst(StoreInst &SI);
423 void verifyDominatesUse(Instruction &I, unsigned i);
424 void visitInstruction(Instruction &I);
425 void visitTerminatorInst(TerminatorInst &I);
426 void visitBranchInst(BranchInst &BI);
427 void visitReturnInst(ReturnInst &RI);
428 void visitSwitchInst(SwitchInst &SI);
429 void visitIndirectBrInst(IndirectBrInst &BI);
430 void visitSelectInst(SelectInst &SI);
431 void visitUserOp1(Instruction &I);
432 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000433 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000434 template <class DbgIntrinsicTy>
435 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000436 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
437 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
438 void visitFenceInst(FenceInst &FI);
439 void visitAllocaInst(AllocaInst &AI);
440 void visitExtractValueInst(ExtractValueInst &EVI);
441 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000442 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000443 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemer654e1302015-07-31 17:58:14 +0000444 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000445 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000446 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000447 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000448 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000449 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000450
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000451 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000452 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
453 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000454 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000455 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000456 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000457 bool verifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000458 SmallVectorImpl<Type *> &ArgTys);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000459 bool verifyIntrinsicIsVarArg(bool isVarArg,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000460 ArrayRef<Intrinsic::IITDescriptor> &Infos);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000461 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
462 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000463 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000464 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000465 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000466 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000467 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000468 void verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +0000469 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000470
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000471 void visitConstantExprsRecursively(const Constant *EntryC);
472 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000473 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000474 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000475 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000476
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000477 void verifyBitPieceExpression(const DbgInfoIntrinsic &I);
478
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000479 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000480 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000481
482 /// Module-level verification that all @llvm.experimental.deoptimize
483 /// declarations share the same calling convention.
484 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000485};
Chris Lattner189d19f2003-11-21 20:23:48 +0000486} // End anonymous namespace
487
Adrian Prantl541a9c52016-05-06 19:26:47 +0000488/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000489#define Assert(C, ...) \
490 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000491
Adrian Prantl541a9c52016-05-06 19:26:47 +0000492/// We know that a debug info condition should be true, if not print
493/// an error message.
494#define AssertDI(C, ...) \
495 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (0)
496
497
Chris Lattnere5a22c02008-08-28 04:02:44 +0000498void Verifier::visit(Instruction &I) {
499 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000500 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000501 InstVisitor<Verifier>::visit(I);
502}
503
Keno Fischer60f82a22016-01-14 22:20:56 +0000504// Helper to recursively iterate over indirect users. By
505// returning false, the callback can ask to stop recursing
506// further.
507static void forEachUser(const Value *User,
508 SmallPtrSet<const Value *, 32> &Visited,
509 llvm::function_ref<bool(const Value *)> Callback) {
510 if (!Visited.insert(User).second)
511 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000512 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000513 if (Callback(TheNextUser))
514 forEachUser(TheNextUser, Visited, Callback);
515}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000516
Chandler Carruth043949d2014-01-19 02:22:18 +0000517void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000518 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000519 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000520
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000521 Assert(GV.getAlignment() <= Value::MaximumAlignment,
522 "huge alignment values are unsupported", &GV);
523 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
524 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000525
526 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000527 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000528 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000529 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000530 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000531
532 if (GV.isDeclarationForLinker())
533 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000534
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000535 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000536 if (const Instruction *I = dyn_cast<Instruction>(V)) {
537 if (!I->getParent() || !I->getParent()->getParent())
538 CheckFailed("Global is referenced by parentless instruction!", &GV,
539 M, I);
540 else if (I->getParent()->getParent()->getParent() != M)
541 CheckFailed("Global is referenced in a different module!", &GV,
542 M, I, I->getParent()->getParent(),
543 I->getParent()->getParent()->getParent());
544 return false;
545 } else if (const Function *F = dyn_cast<Function>(V)) {
546 if (F->getParent() != M)
547 CheckFailed("Global is used by function in a different module", &GV,
548 M, F, F->getParent());
549 return false;
550 }
551 return true;
552 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000553}
554
Chandler Carruth043949d2014-01-19 02:22:18 +0000555void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000556 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000557 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000558 "Global variable initializer type does not match global "
559 "variable type!",
560 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000561
Chris Lattner0aff0b22009-08-05 05:41:44 +0000562 // If the global has common linkage, it must have a zero initializer and
563 // cannot be constant.
564 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000565 Assert(GV.getInitializer()->isNullValue(),
566 "'common' global must have a zero initializer!", &GV);
567 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
568 &GV);
569 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000570 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000571 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000572
Nick Lewycky466d0c12011-04-08 07:30:21 +0000573 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
574 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000575 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
576 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000577 // Don't worry about emitting an error for it not being an array,
578 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000579 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000580 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
581 PointerType *FuncPtrTy =
Micah Villmow51e72462012-10-24 17:25:11 +0000582 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000583 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000584 Assert(STy &&
585 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
586 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
587 STy->getTypeAtIndex(1) == FuncPtrTy,
588 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000589 if (STy->getNumElements() == 3) {
590 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000591 Assert(ETy->isPointerTy() &&
592 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
593 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000594 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000595 }
596 }
597
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000598 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000599 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000600 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
601 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000602 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000603 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
604 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000605 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000606 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000607 const Constant *Init = GV.getInitializer();
608 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000609 Assert(InitArray, "wrong initalizer for intrinsic global variable",
610 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000611 for (Value *Op : InitArray->operands()) {
612 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000613 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
614 isa<GlobalAlias>(V),
615 "invalid llvm.used member", V);
616 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000617 }
618 }
619 }
620 }
621
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000622 Assert(!GV.hasDLLImportStorageClass() ||
623 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
624 GV.hasAvailableExternallyLinkage(),
625 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000626
Matt Arsenault24b49c42013-07-31 17:49:08 +0000627 if (!GV.hasInitializer()) {
628 visitGlobalValue(GV);
629 return;
630 }
631
632 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000633 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000634
Chris Lattnere3400652004-12-15 20:23:49 +0000635 visitGlobalValue(GV);
636}
637
Rafael Espindola64c1e182014-06-03 02:41:57 +0000638void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
639 SmallPtrSet<const GlobalAlias*, 4> Visited;
640 Visited.insert(&GA);
641 visitAliaseeSubExpr(Visited, GA, C);
642}
643
Craig Topper71b7b682014-08-21 05:55:13 +0000644void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000645 const GlobalAlias &GA, const Constant &C) {
646 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000647 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
648 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000649
650 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000651 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000652
Sanjoy Das5ce32722016-04-08 00:48:30 +0000653 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000654 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000655 } else {
656 // Only continue verifying subexpressions of GlobalAliases.
657 // Do not recurse into global initializers.
658 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000659 }
660 }
661
662 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000663 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000664
665 for (const Use &U : C.operands()) {
666 Value *V = &*U;
667 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
668 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
669 else if (const auto *C2 = dyn_cast<Constant>(V))
670 visitAliaseeSubExpr(Visited, GA, *C2);
671 }
672}
673
Chandler Carruth043949d2014-01-19 02:22:18 +0000674void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000675 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
676 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
677 "weak_odr, or external linkage!",
678 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000679 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000680 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
681 Assert(GA.getType() == Aliasee->getType(),
682 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000683
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000684 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
685 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000686
Rafael Espindola64c1e182014-06-03 02:41:57 +0000687 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000688
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000689 visitGlobalValue(GA);
690}
691
Chandler Carruth043949d2014-01-19 02:22:18 +0000692void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000693 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000694 if (NMD.getName() == "llvm.dbg.cu") {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000695 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000696 }
697
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000698 if (!MD)
699 continue;
700
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000701 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000702 }
703}
704
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000705void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000706 // Only visit each node once. Metadata can be mutually recursive, so this
707 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000708 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000709 return;
710
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000711 switch (MD.getMetadataID()) {
712 default:
713 llvm_unreachable("Invalid MDNode subclass");
714 case Metadata::MDTupleKind:
715 break;
716#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
717 case Metadata::CLASS##Kind: \
718 visit##CLASS(cast<CLASS>(MD)); \
719 break;
720#include "llvm/IR/Metadata.def"
721 }
722
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000723 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000724 if (!Op)
725 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000726 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
727 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000728 if (auto *N = dyn_cast<MDNode>(Op)) {
729 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000730 continue;
731 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000732 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
733 visitValueAsMetadata(*V, nullptr);
734 continue;
735 }
Duncan Sands76d62172010-04-29 16:10:30 +0000736 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000737
738 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000739 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
740 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000741}
742
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000743void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000744 Assert(MD.getValue(), "Expected valid value", &MD);
745 Assert(!MD.getValue()->getType()->isMetadataTy(),
746 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000747
748 auto *L = dyn_cast<LocalAsMetadata>(&MD);
749 if (!L)
750 return;
751
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000752 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000753
754 // If this was an instruction, bb, or argument, verify that it is in the
755 // function that we expect.
756 Function *ActualF = nullptr;
757 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000758 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000759 ActualF = I->getParent()->getParent();
760 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
761 ActualF = BB->getParent();
762 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
763 ActualF = A->getParent();
764 assert(ActualF && "Unimplemented function local metadata case!");
765
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000766 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000767}
768
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000769void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000770 Metadata *MD = MDV.getMetadata();
771 if (auto *N = dyn_cast<MDNode>(MD)) {
772 visitMDNode(*N);
773 return;
774 }
775
776 // Only visit each node once. Metadata can be mutually recursive, so this
777 // avoids infinite recursion here, as well as being an optimization.
778 if (!MDNodes.insert(MD).second)
779 return;
780
781 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
782 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000783}
784
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000785static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
786static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
787static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000788
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000789template <class Ty>
790bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
791 for (Metadata *MD : N.operands()) {
792 if (MD) {
793 if (!isa<Ty>(MD))
794 return false;
795 } else {
796 if (!AllowNull)
797 return false;
798 }
799 }
800 return true;
801}
802
803template <class Ty>
804bool isValidMetadataArray(const MDTuple &N) {
805 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
806}
807
808template <class Ty>
809bool isValidMetadataNullArray(const MDTuple &N) {
810 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
811}
812
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000813void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000814 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
815 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000816 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000817 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000818}
819
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000820void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000821 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000822}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000823
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000824void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000825 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000826 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000827}
828
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000829void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000830 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
831 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000832}
833
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000834void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000835 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000836}
837
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000838void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000839 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
840 N.getTag() == dwarf::DW_TAG_unspecified_type,
841 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000842}
843
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000844void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000845 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000846 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000847
Adrian Prantl541a9c52016-05-06 19:26:47 +0000848 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
849 N.getTag() == dwarf::DW_TAG_pointer_type ||
850 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
851 N.getTag() == dwarf::DW_TAG_reference_type ||
852 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
853 N.getTag() == dwarf::DW_TAG_const_type ||
854 N.getTag() == dwarf::DW_TAG_volatile_type ||
855 N.getTag() == dwarf::DW_TAG_restrict_type ||
856 N.getTag() == dwarf::DW_TAG_member ||
857 N.getTag() == dwarf::DW_TAG_inheritance ||
858 N.getTag() == dwarf::DW_TAG_friend,
859 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000860 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000861 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
862 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000863 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000864
Adrian Prantl541a9c52016-05-06 19:26:47 +0000865 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
866 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
867 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000868}
869
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000870static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000871 return (Flags & DINode::FlagLValueReference) &&
872 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000873}
874
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000875void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
876 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000877 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000878 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000879 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
880 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000881 }
882}
883
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000884void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000885 // Common scope checks.
886 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000887
Adrian Prantl541a9c52016-05-06 19:26:47 +0000888 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
889 N.getTag() == dwarf::DW_TAG_structure_type ||
890 N.getTag() == dwarf::DW_TAG_union_type ||
891 N.getTag() == dwarf::DW_TAG_enumeration_type ||
892 N.getTag() == dwarf::DW_TAG_class_type,
893 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000894
Adrian Prantl541a9c52016-05-06 19:26:47 +0000895 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
896 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
897 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000898
Adrian Prantl541a9c52016-05-06 19:26:47 +0000899 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
900 "invalid composite elements", &N, N.getRawElements());
901 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
902 N.getRawVTableHolder());
903 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
904 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000905 if (auto *Params = N.getRawTemplateParams())
906 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000907
908 if (N.getTag() == dwarf::DW_TAG_class_type ||
909 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000910 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
911 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000912 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000913}
914
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000915void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000916 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000917 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000918 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000919 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000920 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000921 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000922 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000923 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
924 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000925}
926
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000927void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000928 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000929}
930
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000931void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000932 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
933 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000934
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000935 // Don't bother verifying the compilation directory or producer string
936 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000937 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
938 N.getRawFile());
939 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
940 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000941
Adrian Prantl541a9c52016-05-06 19:26:47 +0000942 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
943 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000944
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000945 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000946 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000947 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000948 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000949 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
950 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000951 }
952 }
953 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000954 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000955 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000956 AssertDI(Op && (isa<DIType>(Op) ||
957 (isa<DISubprogram>(Op) &&
958 cast<DISubprogram>(Op)->isDefinition() == false)),
959 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000960 }
961 }
962 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000963 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000964 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000965 AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref",
966 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000967 }
968 }
969 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000970 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000971 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000972 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
973 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000974 }
975 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000976 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000977 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000978 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000979 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000980 }
981 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000982 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000983}
984
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000985void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000986 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
987 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +0000988 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000989 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000990 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000991 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
992 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
993 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000994 if (auto *Params = N.getRawTemplateParams())
995 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +0000996 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000997 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
998 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000999 if (auto *RawVars = N.getRawVariables()) {
1000 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001001 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001002 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001003 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1004 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001005 }
1006 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001007 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1008 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001009
Adrian Prantl75819ae2016-04-15 15:57:41 +00001010 auto *Unit = N.getRawUnit();
1011 if (N.isDefinition()) {
1012 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001013 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1014 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1015 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001016 } else {
1017 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001018 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001019 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001020}
1021
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001022void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001023 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1024 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1025 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001026}
1027
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001028void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1029 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001030
Adrian Prantl541a9c52016-05-06 19:26:47 +00001031 AssertDI(N.getLine() || !N.getColumn(),
1032 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001033}
1034
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001035void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1036 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001037}
1038
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001039void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001040 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001041 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001042 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001043}
1044
Amjad Abouda9bcf162015-12-10 12:56:35 +00001045void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001046 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1047 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1048 "invalid macinfo type", &N);
1049 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001050 if (!N.getValue().empty()) {
1051 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1052 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001053}
1054
1055void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001056 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1057 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001058 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001059 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001060
1061 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001062 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001063 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001064 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001065 }
1066 }
1067}
1068
Adrian Prantlab1243f2015-06-29 23:03:47 +00001069void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001070 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1071 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001072}
1073
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001074void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001075 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001076}
1077
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001078void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1079 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001080
Adrian Prantl541a9c52016-05-06 19:26:47 +00001081 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1082 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001083}
1084
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001085void Verifier::visitDITemplateValueParameter(
1086 const DITemplateValueParameter &N) {
1087 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001088
Adrian Prantl541a9c52016-05-06 19:26:47 +00001089 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1090 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1091 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1092 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001093}
1094
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001095void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001096 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001097 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1098 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001099 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001100 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001101}
1102
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001103void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001104 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001105 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001106
Adrian Prantl541a9c52016-05-06 19:26:47 +00001107 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1108 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001109 if (auto *V = N.getRawVariable()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001110 AssertDI(isa<ConstantAsMetadata>(V) &&
1111 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1112 "invalid global varaible ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001113 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001114 }
1115 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001116 AssertDI(isa<DIDerivedType>(Member),
1117 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001118 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001119}
1120
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001121void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001122 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001123 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001124
Adrian Prantl541a9c52016-05-06 19:26:47 +00001125 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1126 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1127 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001128}
1129
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001130void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001131 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001132}
1133
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001134void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001135 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001136 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001137 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001138 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001139 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001140}
1141
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001142void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001143 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1144 N.getTag() == dwarf::DW_TAG_imported_declaration,
1145 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001146 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001147 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1148 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1149 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001150}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001151
David Majnemerdad0a642014-06-27 18:19:56 +00001152void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001153 // The Module is invalid if the GlobalValue has private linkage. Entities
1154 // with private linkage don't have entries in the symbol table.
David Majnemerab457812015-02-20 19:58:48 +00001155 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001156 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1157 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001158}
1159
Chandler Carruth043949d2014-01-19 02:22:18 +00001160void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001161 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1162 if (!Idents)
1163 return;
1164
1165 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1166 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001167 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001168 Assert(N->getNumOperands() == 1,
1169 "incorrect number of operands in llvm.ident metadata", N);
1170 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1171 ("invalid value for llvm.ident metadata entry operand"
1172 "(the operand should be a string)"),
1173 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001174 }
1175}
1176
Chandler Carruth043949d2014-01-19 02:22:18 +00001177void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001178 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1179 if (!Flags) return;
1180
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001181 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001182 DenseMap<const MDString*, const MDNode*> SeenIDs;
1183 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001184 for (const MDNode *MDN : Flags->operands())
1185 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001186
1187 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001188 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001189 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001190 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001191
Chandler Carruth043949d2014-01-19 02:22:18 +00001192 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001193 if (!Op) {
1194 CheckFailed("invalid requirement on flag, flag is not present in module",
1195 Flag);
1196 continue;
1197 }
1198
1199 if (Op->getOperand(2) != ReqValue) {
1200 CheckFailed(("invalid requirement on flag, "
1201 "flag does not have the required value"),
1202 Flag);
1203 continue;
1204 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001205 }
1206}
1207
Chandler Carruth043949d2014-01-19 02:22:18 +00001208void
1209Verifier::visitModuleFlag(const MDNode *Op,
1210 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1211 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001212 // Each module flag should have three arguments, the merge behavior (a
1213 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001214 Assert(Op->getNumOperands() == 3,
1215 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001216 Module::ModFlagBehavior MFB;
1217 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001218 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001219 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001220 "invalid behavior operand in module flag (expected constant integer)",
1221 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001222 Assert(false,
1223 "invalid behavior operand in module flag (unexpected constant)",
1224 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001225 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001226 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001227 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1228 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001229
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001230 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001231 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001232 case Module::Error:
1233 case Module::Warning:
1234 case Module::Override:
1235 // These behavior types accept any value.
1236 break;
1237
1238 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001239 // The value should itself be an MDNode with two operands, a flag ID (an
1240 // MDString), and a value.
1241 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001242 Assert(Value && Value->getNumOperands() == 2,
1243 "invalid value for 'require' module flag (expected metadata pair)",
1244 Op->getOperand(2));
1245 Assert(isa<MDString>(Value->getOperand(0)),
1246 ("invalid value for 'require' module flag "
1247 "(first value operand should be a string)"),
1248 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001249
1250 // Append it to the list of requirements, to check once all module flags are
1251 // scanned.
1252 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001253 break;
1254 }
1255
1256 case Module::Append:
1257 case Module::AppendUnique: {
1258 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001259 Assert(isa<MDNode>(Op->getOperand(2)),
1260 "invalid value for 'append'-type module flag "
1261 "(expected a metadata node)",
1262 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001263 break;
1264 }
1265 }
1266
1267 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001268 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001269 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001270 Assert(Inserted,
1271 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001272 }
1273}
1274
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001275void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001276 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001277 unsigned Slot = ~0U;
1278 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1279 if (Attrs.getSlotIndex(I) == Idx) {
1280 Slot = I;
1281 break;
1282 }
1283
1284 assert(Slot != ~0U && "Attribute set inconsistency!");
1285
1286 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1287 I != E; ++I) {
1288 if (I->isStringAttribute())
1289 continue;
1290
1291 if (I->getKindAsEnum() == Attribute::NoReturn ||
1292 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001293 I->getKindAsEnum() == Attribute::NoInline ||
1294 I->getKindAsEnum() == Attribute::AlwaysInline ||
1295 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1296 I->getKindAsEnum() == Attribute::StackProtect ||
1297 I->getKindAsEnum() == Attribute::StackProtectReq ||
1298 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001299 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001300 I->getKindAsEnum() == Attribute::NoRedZone ||
1301 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1302 I->getKindAsEnum() == Attribute::Naked ||
1303 I->getKindAsEnum() == Attribute::InlineHint ||
1304 I->getKindAsEnum() == Attribute::StackAlignment ||
1305 I->getKindAsEnum() == Attribute::UWTable ||
1306 I->getKindAsEnum() == Attribute::NonLazyBind ||
1307 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1308 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1309 I->getKindAsEnum() == Attribute::SanitizeThread ||
1310 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1311 I->getKindAsEnum() == Attribute::MinSize ||
1312 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001313 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001314 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001315 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001316 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001317 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001318 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001319 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001320 I->getKindAsEnum() == Attribute::NoRecurse ||
1321 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001322 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1323 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001324 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001325 CheckFailed("Attribute '" + I->getAsString() +
1326 "' only applies to functions!", V);
1327 return;
1328 }
1329 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1330 I->getKindAsEnum() == Attribute::ReadNone) {
1331 if (Idx == 0) {
1332 CheckFailed("Attribute '" + I->getAsString() +
1333 "' does not apply to function returns");
1334 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001335 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001336 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001337 CheckFailed("Attribute '" + I->getAsString() +
1338 "' does not apply to functions!", V);
1339 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001340 }
1341 }
1342}
1343
Duncan Sandsc3a79922009-06-11 08:11:03 +00001344// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001345// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001346void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001347 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001348 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001349 return;
1350
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001351 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001352
Bill Wendling908126a2012-10-09 09:51:10 +00001353 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001354 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1355 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1356 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1357 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1358 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001359 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001360 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1361 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001362 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001363 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001364 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001365 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001366
Reid Klecknera534a382013-12-19 02:14:12 +00001367 // Check for mutually incompatible attributes. Only inreg is compatible with
1368 // sret.
1369 unsigned AttrCount = 0;
1370 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1371 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1372 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1373 Attrs.hasAttribute(Idx, Attribute::InReg);
1374 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001375 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1376 "and 'sret' are incompatible!",
1377 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001378
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001379 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1380 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1381 "Attributes "
1382 "'inalloca and readonly' are incompatible!",
1383 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001384
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001385 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1386 Attrs.hasAttribute(Idx, Attribute::Returned)),
1387 "Attributes "
1388 "'sret and returned' are incompatible!",
1389 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001390
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001391 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1392 Attrs.hasAttribute(Idx, Attribute::SExt)),
1393 "Attributes "
1394 "'zeroext and signext' are incompatible!",
1395 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001396
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001397 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1398 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1399 "Attributes "
1400 "'readnone and readonly' are incompatible!",
1401 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001402
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001403 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1404 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1405 "Attributes "
1406 "'noinline and alwaysinline' are incompatible!",
1407 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001408
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001409 Assert(!AttrBuilder(Attrs, Idx)
Pete Cooper2777d8872015-05-06 23:19:56 +00001410 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001411 "Wrong types for attribute: " +
Pete Cooper2777d8872015-05-06 23:19:56 +00001412 AttributeSet::get(*Context, Idx,
1413 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001414 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001415
Reid Klecknera534a382013-12-19 02:14:12 +00001416 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001417 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001418 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001419 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1420 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1421 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1422 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001423 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001424 if (!isa<PointerType>(PTy->getElementType()))
1425 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1426 "Attribute 'swifterror' only applies to parameters "
1427 "with pointer to pointer type!",
1428 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001429 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001430 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1431 "Attribute 'byval' only applies to parameters with pointer type!",
1432 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001433 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1434 "Attribute 'swifterror' only applies to parameters "
1435 "with pointer type!",
1436 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001437 }
Duncan Sands0009c442008-01-12 16:42:01 +00001438}
1439
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001440// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001441// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001442void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001443 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001444 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001445 return;
1446
Duncan Sands8c582282007-12-21 19:19:01 +00001447 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001448 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001449 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001450 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001451 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001452
Chris Lattner8a923e72008-03-12 17:45:29 +00001453 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001454 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001455
Chris Lattner229907c2011-07-18 04:54:35 +00001456 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001457 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001458 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001459 else if (Idx-1 < FT->getNumParams())
1460 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001461 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001462 break; // VarArgs attributes, verified elsewhere.
1463
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001464 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001465
Stephen Linb8bd2322013-04-20 05:14:40 +00001466 if (Idx == 0)
1467 continue;
1468
1469 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001470 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001471 SawNest = true;
1472 }
1473
Stephen Linb8bd2322013-04-20 05:14:40 +00001474 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001475 Assert(!SawReturned, "More than one parameter has attribute returned!",
1476 V);
1477 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1478 "Incompatible "
1479 "argument and return types for 'returned' attribute",
1480 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001481 SawReturned = true;
1482 }
1483
Reid Kleckner79418562014-05-09 22:32:13 +00001484 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001485 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1486 Assert(Idx == 1 || Idx == 2,
1487 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001488 SawSRet = true;
1489 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001490
Manman Renf46262e2016-03-29 17:37:21 +00001491 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1492 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1493 SawSwiftSelf = true;
1494 }
1495
Manman Ren9bfd0d02016-04-01 21:41:15 +00001496 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1497 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1498 V);
1499 SawSwiftError = true;
1500 }
1501
Reid Kleckner60d3a832014-01-16 22:59:24 +00001502 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001503 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1504 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001505 }
Duncan Sands8c582282007-12-21 19:19:01 +00001506 }
Devang Patel9cc98122008-10-01 23:41:25 +00001507
Bill Wendling77543892013-01-18 21:11:39 +00001508 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1509 return;
1510
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001511 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001512
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001513 Assert(
1514 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1515 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1516 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001517
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001518 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001519 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1520 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1521 Attribute::InaccessibleMemOrArgMemOnly)),
1522 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1523
1524 Assert(
1525 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1526 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1527 Attribute::InaccessibleMemOnly)),
1528 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1529
1530 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001531 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1532 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1533 Attribute::AlwaysInline)),
1534 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001535
1536 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1537 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001538 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1539 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001540
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001541 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1542 Attribute::OptimizeForSize),
1543 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001544
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001545 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1546 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001547 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001548
1549 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1550 Attribute::JumpTable)) {
1551 const GlobalValue *GV = cast<GlobalValue>(V);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001552 Assert(GV->hasUnnamedAddr(),
1553 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001554 }
George Burgess IV278199f2016-04-12 01:05:35 +00001555
1556 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1557 std::pair<unsigned, Optional<unsigned>> Args =
1558 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1559
1560 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1561 if (ParamNo >= FT->getNumParams()) {
1562 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1563 return false;
1564 }
1565
1566 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1567 CheckFailed("'allocsize' " + Name +
1568 " argument must refer to an integer parameter",
1569 V);
1570 return false;
1571 }
1572
1573 return true;
1574 };
1575
1576 if (!CheckParam("element size", Args.first))
1577 return;
1578
1579 if (Args.second && !CheckParam("number of elements", *Args.second))
1580 return;
1581 }
Duncan Sands8c582282007-12-21 19:19:01 +00001582}
1583
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001584void Verifier::verifyFunctionMetadata(
Diego Novillo2567f3d2015-05-13 15:13:45 +00001585 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1586 if (MDs.empty())
1587 return;
1588
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001589 for (const auto &Pair : MDs) {
1590 if (Pair.first == LLVMContext::MD_prof) {
1591 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001592 Assert(MD->getNumOperands() == 2,
1593 "!prof annotations should have exactly 2 operands", MD);
1594
1595 // Check first operand.
1596 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1597 MD);
1598 Assert(isa<MDString>(MD->getOperand(0)),
1599 "expected string with name of the !prof annotation", MD);
1600 MDString *MDS = cast<MDString>(MD->getOperand(0));
1601 StringRef ProfName = MDS->getString();
1602 Assert(ProfName.equals("function_entry_count"),
1603 "first operand should be 'function_entry_count'", MD);
1604
1605 // Check second operand.
1606 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1607 MD);
1608 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1609 "expected integer argument to function_entry_count", MD);
1610 }
1611 }
1612}
1613
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001614void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1615 if (!ConstantExprVisited.insert(EntryC).second)
1616 return;
1617
1618 SmallVector<const Constant *, 16> Stack;
1619 Stack.push_back(EntryC);
1620
1621 while (!Stack.empty()) {
1622 const Constant *C = Stack.pop_back_val();
1623
1624 // Check this constant expression.
1625 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1626 visitConstantExpr(CE);
1627
Keno Fischerf6d17b92016-01-14 22:42:02 +00001628 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1629 // Global Values get visited separately, but we do need to make sure
1630 // that the global value is in the correct module
1631 Assert(GV->getParent() == M, "Referencing global in another module!",
1632 EntryC, M, GV, GV->getParent());
1633 continue;
1634 }
1635
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001636 // Visit all sub-expressions.
1637 for (const Use &U : C->operands()) {
1638 const auto *OpC = dyn_cast<Constant>(U);
1639 if (!OpC)
1640 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001641 if (!ConstantExprVisited.insert(OpC).second)
1642 continue;
1643 Stack.push_back(OpC);
1644 }
1645 }
1646}
1647
1648void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001649 if (CE->getOpcode() != Instruction::BitCast)
1650 return;
1651
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001652 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1653 CE->getType()),
1654 "Invalid bitcast", CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00001655}
1656
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001657bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001658 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001659 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001660
Devang Patel82fed672008-09-23 22:35:17 +00001661 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001662 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001663 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001664 || (LastIndex == AttributeSet::FunctionIndex
1665 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001666 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001667
Devang Patel82fed672008-09-23 22:35:17 +00001668 return false;
1669}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001670
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001671/// Verify that statepoint intrinsic is well formed.
1672void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001673 assert(CS.getCalledFunction() &&
1674 CS.getCalledFunction()->getIntrinsicID() ==
1675 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001676
Philip Reames0285c742015-02-03 23:18:47 +00001677 const Instruction &CI = *CS.getInstruction();
1678
Igor Laevsky39d662f2015-07-11 10:30:36 +00001679 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1680 !CS.onlyAccessesArgMemory(),
1681 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001682 "reordering restrictions required by safepoint semantics",
1683 &CI);
1684
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001685 const Value *IDV = CS.getArgument(0);
1686 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1687 &CI);
1688
1689 const Value *NumPatchBytesV = CS.getArgument(1);
1690 Assert(isa<ConstantInt>(NumPatchBytesV),
1691 "gc.statepoint number of patchable bytes must be a constant integer",
1692 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001693 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001694 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1695 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1696 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1697 "positive",
1698 &CI);
1699
1700 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001701 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001702 Assert(PT && PT->getElementType()->isFunctionTy(),
1703 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001704 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001705
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001706 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001707 Assert(isa<ConstantInt>(NumCallArgsV),
1708 "gc.statepoint number of arguments to underlying call "
1709 "must be constant integer",
1710 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001711 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001712 Assert(NumCallArgs >= 0,
1713 "gc.statepoint number of arguments to underlying call "
1714 "must be positive",
1715 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001716 const int NumParams = (int)TargetFuncType->getNumParams();
1717 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001718 Assert(NumCallArgs >= NumParams,
1719 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001720
1721 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001722 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1723 "gc.statepoint doesn't support wrapping non-void "
1724 "vararg functions yet",
1725 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001726 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001727 Assert(NumCallArgs == NumParams,
1728 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001729
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001730 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001731 Assert(isa<ConstantInt>(FlagsV),
1732 "gc.statepoint flags must be constant integer", &CI);
1733 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1734 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1735 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001736
1737 // Verify that the types of the call parameter arguments match
1738 // the type of the wrapped callee.
1739 for (int i = 0; i < NumParams; i++) {
1740 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001741 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001742 Assert(ArgType == ParamType,
1743 "gc.statepoint call argument does not match wrapped "
1744 "function type",
1745 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001746 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001747
1748 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001749
1750 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1751 Assert(isa<ConstantInt>(NumTransitionArgsV),
1752 "gc.statepoint number of transition arguments "
1753 "must be constant integer",
1754 &CI);
1755 const int NumTransitionArgs =
1756 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1757 Assert(NumTransitionArgs >= 0,
1758 "gc.statepoint number of transition arguments must be positive", &CI);
1759 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1760
1761 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001762 Assert(isa<ConstantInt>(NumDeoptArgsV),
1763 "gc.statepoint number of deoptimization arguments "
1764 "must be constant integer",
1765 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001766 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001767 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1768 "must be positive",
1769 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001770
Pat Gavlincc0431d2015-05-08 18:07:42 +00001771 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001772 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001773 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001774 "gc.statepoint too few arguments according to length fields", &CI);
1775
Philip Reames1ffa9372015-01-30 23:28:05 +00001776 // Check that the only uses of this gc.statepoint are gc.result or
1777 // gc.relocate calls which are tied to this statepoint and thus part
1778 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001779 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001780 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001781 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001782 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001783 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001784 "gc.result or gc.relocate are the only value uses"
1785 "of a gc.statepoint",
1786 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001787 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001788 Assert(Call->getArgOperand(0) == &CI,
1789 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001790 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001791 Assert(Call->getArgOperand(0) == &CI,
1792 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001793 }
1794 }
1795
1796 // Note: It is legal for a single derived pointer to be listed multiple
1797 // times. It's non-optimal, but it is legal. It can also happen after
1798 // insertion if we strip a bitcast away.
1799 // Note: It is really tempting to check that each base is relocated and
1800 // that a derived pointer is never reused as a base pointer. This turns
1801 // out to be problematic since optimizations run after safepoint insertion
1802 // can recognize equality properties that the insertion logic doesn't know
1803 // about. See example statepoint.ll in the verifier subdirectory
1804}
1805
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001806void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001807 for (auto &Counts : FrameEscapeInfo) {
1808 Function *F = Counts.first;
1809 unsigned EscapedObjectCount = Counts.second.first;
1810 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001811 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001812 "all indices passed to llvm.localrecover must be less than the "
1813 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001814 "function",
1815 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001816 }
1817}
1818
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001819static Instruction *getSuccPad(TerminatorInst *Terminator) {
1820 BasicBlock *UnwindDest;
1821 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1822 UnwindDest = II->getUnwindDest();
1823 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1824 UnwindDest = CSI->getUnwindDest();
1825 else
1826 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1827 return UnwindDest->getFirstNonPHI();
1828}
1829
1830void Verifier::verifySiblingFuncletUnwinds() {
1831 SmallPtrSet<Instruction *, 8> Visited;
1832 SmallPtrSet<Instruction *, 8> Active;
1833 for (const auto &Pair : SiblingFuncletInfo) {
1834 Instruction *PredPad = Pair.first;
1835 if (Visited.count(PredPad))
1836 continue;
1837 Active.insert(PredPad);
1838 TerminatorInst *Terminator = Pair.second;
1839 do {
1840 Instruction *SuccPad = getSuccPad(Terminator);
1841 if (Active.count(SuccPad)) {
1842 // Found a cycle; report error
1843 Instruction *CyclePad = SuccPad;
1844 SmallVector<Instruction *, 8> CycleNodes;
1845 do {
1846 CycleNodes.push_back(CyclePad);
1847 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1848 if (CycleTerminator != CyclePad)
1849 CycleNodes.push_back(CycleTerminator);
1850 CyclePad = getSuccPad(CycleTerminator);
1851 } while (CyclePad != SuccPad);
1852 Assert(false, "EH pads can't handle each other's exceptions",
1853 ArrayRef<Instruction *>(CycleNodes));
1854 }
1855 // Don't re-walk a node we've already checked
1856 if (!Visited.insert(SuccPad).second)
1857 break;
1858 // Walk to this successor if it has a map entry.
1859 PredPad = SuccPad;
1860 auto TermI = SiblingFuncletInfo.find(PredPad);
1861 if (TermI == SiblingFuncletInfo.end())
1862 break;
1863 Terminator = TermI->second;
1864 Active.insert(PredPad);
1865 } while (true);
1866 // Each node only has one successor, so we've walked all the active
1867 // nodes' successors.
1868 Active.clear();
1869 }
1870}
1871
Chris Lattner0e851da2002-04-18 20:37:37 +00001872// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001873//
Chandler Carruth043949d2014-01-19 02:22:18 +00001874void Verifier::visitFunction(const Function &F) {
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001875 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001876 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001877 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001878
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001879 Assert(Context == &F.getContext(),
1880 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001881
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001882 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1883 Assert(FT->getNumParams() == NumArgs,
1884 "# formal arguments must match # of arguments for function type!", &F,
1885 FT);
1886 Assert(F.getReturnType()->isFirstClassType() ||
1887 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1888 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001889
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001890 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1891 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001892
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001893 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001894
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001895 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001896 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001897
Duncan Sands8c582282007-12-21 19:19:01 +00001898 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001899 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001900
Michael Gottesman41748d72013-06-27 00:25:01 +00001901 // On function declarations/definitions, we do not support the builtin
1902 // attribute. We do not check this in VerifyFunctionAttrs since that is
1903 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001904 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1905 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001906
Chris Lattneref13ee32006-05-19 21:25:17 +00001907 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001908 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1909 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001910 switch (F.getCallingConv()) {
1911 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001912 case CallingConv::C:
1913 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001914 case CallingConv::Fast:
1915 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001916 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001917 case CallingConv::PTX_Kernel:
1918 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001919 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1920 "perfect forwarding!",
1921 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001922 break;
1923 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001924
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001925 bool isLLVMdotName = F.getName().size() >= 5 &&
1926 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001927
Chris Lattneraf95e582002-04-13 22:48:46 +00001928 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001929 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001930 for (const Argument &Arg : F.args()) {
1931 Assert(Arg.getType() == FT->getParamType(i),
1932 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001933 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001934 Assert(Arg.getType()->isFirstClassType(),
1935 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001936 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001937 Assert(!Arg.getType()->isMetadataTy(),
1938 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1939 Assert(!Arg.getType()->isTokenTy(),
1940 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001941 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001942
1943 // Check that swifterror argument is only used by loads and stores.
1944 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1945 verifySwiftErrorValue(&Arg);
1946 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001947 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001948 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001949
David Majnemerb611e3f2015-08-14 05:09:07 +00001950 if (!isLLVMdotName)
1951 Assert(!F.getReturnType()->isTokenTy(),
1952 "Functions returns a token but isn't an intrinsic", &F);
1953
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001954 // Get the function metadata attachments.
1955 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1956 F.getAllMetadata(MDs);
1957 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001958 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001959
Keno Fischer2ac0c272015-11-16 05:13:30 +00001960 // Check validity of the personality function
1961 if (F.hasPersonalityFn()) {
1962 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1963 if (Per)
1964 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00001965 "Referencing personality function in another module!",
1966 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00001967 }
1968
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001969 if (F.isMaterializable()) {
1970 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001971 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1972 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00001973 } else if (F.isDeclaration()) {
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001974 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1975 MDs.empty() ? nullptr : MDs.front().second);
David Majnemer7fddecc2015-06-17 20:52:32 +00001976 Assert(!F.hasPersonalityFn(),
1977 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00001978 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00001979 // Verify that this function (which has a body) is not named "llvm.*". It
1980 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001981 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001982
Chris Lattner149376d2002-10-13 20:57:00 +00001983 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00001984 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001985 Assert(pred_empty(Entry),
1986 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001987
Chris Lattner27471742009-11-01 04:08:01 +00001988 // The address of the entry block cannot be taken, unless it is dead.
1989 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001990 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1991 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00001992 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001993
Peter Collingbourne382d81c2016-06-01 01:17:57 +00001994 unsigned NumDebugAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001995 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00001996 for (const auto &I : MDs) {
1997 // Verify that the attachment is legal.
1998 switch (I.first) {
1999 default:
2000 break;
2001 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002002 ++NumDebugAttachments;
2003 AssertDI(NumDebugAttachments == 1,
2004 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002005 AssertDI(isa<DISubprogram>(I.second),
2006 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002007 break;
2008 }
2009
2010 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002011 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002012 }
Chris Lattner149376d2002-10-13 20:57:00 +00002013 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002014
Chris Lattner7730dcc2009-09-11 17:05:29 +00002015 // If this function is actually an intrinsic, verify that it is only used in
2016 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002017 // Only do this if the module is materialized, otherwise we don't have all the
2018 // uses.
2019 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002020 const User *U;
2021 if (F.hasAddressTaken(&U))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002022 Assert(0, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002023 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002024
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002025 Assert(!F.hasDLLImportStorageClass() ||
2026 (F.isDeclaration() && F.hasExternalLinkage()) ||
2027 F.hasAvailableExternallyLinkage(),
2028 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002029
2030 auto *N = F.getSubprogram();
2031 if (!N)
2032 return;
2033
Adrian Prantl75819ae2016-04-15 15:57:41 +00002034 visitDISubprogram(*N);
2035
Peter Collingbourned4bff302015-11-05 22:03:56 +00002036 // Check that all !dbg attachments lead to back to N (or, at least, another
2037 // subprogram that describes the same function).
2038 //
2039 // FIXME: Check this incrementally while visiting !dbg attachments.
2040 // FIXME: Only check when N is the canonical subprogram for F.
2041 SmallPtrSet<const MDNode *, 32> Seen;
2042 for (auto &BB : F)
2043 for (auto &I : BB) {
2044 // Be careful about using DILocation here since we might be dealing with
2045 // broken code (this is the Verifier after all).
2046 DILocation *DL =
2047 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2048 if (!DL)
2049 continue;
2050 if (!Seen.insert(DL).second)
2051 continue;
2052
2053 DILocalScope *Scope = DL->getInlinedAtScope();
2054 if (Scope && !Seen.insert(Scope).second)
2055 continue;
2056
2057 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002058
2059 // Scope and SP could be the same MDNode and we don't want to skip
2060 // validation in that case
2061 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002062 continue;
2063
2064 // FIXME: Once N is canonical, check "SP == &N".
2065 Assert(SP->describes(&F),
2066 "!dbg attachment points at wrong subprogram for function", N, &F,
2067 &I, DL, Scope, SP);
2068 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002069}
2070
Chris Lattner0e851da2002-04-18 20:37:37 +00002071// verifyBasicBlock - Verify that a basic block is well formed...
2072//
Chris Lattner069a7952002-06-25 15:56:27 +00002073void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002074 InstsInThisBlock.clear();
2075
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002076 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002077 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002078
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002079 // Check constraints that this basic block imposes on all of the PHI nodes in
2080 // it.
2081 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002082 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2083 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002084 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002085 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002086 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002087 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002088 Assert(PN->getNumIncomingValues() != 0,
2089 "PHI nodes must have at least one entry. If the block is dead, "
2090 "the PHI should be removed!",
2091 PN);
2092 Assert(PN->getNumIncomingValues() == Preds.size(),
2093 "PHINode should have one entry for each predecessor of its "
2094 "parent basic block!",
2095 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002096
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002097 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002098 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002099 Values.reserve(PN->getNumIncomingValues());
2100 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2101 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2102 PN->getIncomingValue(i)));
2103 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002104
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002105 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2106 // Check to make sure that if there is more than one entry for a
2107 // particular basic block in this PHI node, that the incoming values are
2108 // all identical.
2109 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002110 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2111 Values[i].second == Values[i - 1].second,
2112 "PHI node has multiple entries for the same basic block with "
2113 "different incoming values!",
2114 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002115
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002116 // Check to make sure that the predecessors and PHI node entries are
2117 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002118 Assert(Values[i].first == Preds[i],
2119 "PHI node entries do not match predecessors!", PN,
2120 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002121 }
2122 }
2123 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002124
2125 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002126 for (auto &I : BB)
2127 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002128 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002129 }
Chris Lattner069a7952002-06-25 15:56:27 +00002130}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002131
Chris Lattner069a7952002-06-25 15:56:27 +00002132void Verifier::visitTerminatorInst(TerminatorInst &I) {
2133 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002134 Assert(&I == I.getParent()->getTerminator(),
2135 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002136 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002137}
2138
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002139void Verifier::visitBranchInst(BranchInst &BI) {
2140 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002141 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2142 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002143 }
2144 visitTerminatorInst(BI);
2145}
2146
Chris Lattner069a7952002-06-25 15:56:27 +00002147void Verifier::visitReturnInst(ReturnInst &RI) {
2148 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002149 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002150 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002151 Assert(N == 0,
2152 "Found return instr that returns non-void in Function of void "
2153 "return type!",
2154 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002155 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002156 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2157 "Function return type does not match operand "
2158 "type of return inst!",
2159 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002160
Misha Brukman7eb05a12003-08-18 14:43:39 +00002161 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002162 // terminators...
2163 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002164}
2165
Chris Lattnerab5aa142004-05-21 16:47:21 +00002166void Verifier::visitSwitchInst(SwitchInst &SI) {
2167 // Check to make sure that all of the constants in the switch instruction
2168 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002169 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002170 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002171 for (auto &Case : SI.cases()) {
2172 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002173 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002174 Assert(Constants.insert(Case.getCaseValue()).second,
2175 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002176 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002177
Chris Lattnerab5aa142004-05-21 16:47:21 +00002178 visitTerminatorInst(SI);
2179}
2180
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002181void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002182 Assert(BI.getAddress()->getType()->isPointerTy(),
2183 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002184 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002185 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2186 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002187
2188 visitTerminatorInst(BI);
2189}
2190
Chris Lattner75648e72004-03-12 05:54:31 +00002191void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002192 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2193 SI.getOperand(2)),
2194 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002195
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002196 Assert(SI.getTrueValue()->getType() == SI.getType(),
2197 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002198 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002199}
2200
Misha Brukmanc566ca362004-03-02 00:22:19 +00002201/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2202/// a pass, if any exist, it's an error.
2203///
Chris Lattner903a25d2002-11-21 16:54:22 +00002204void Verifier::visitUserOp1(Instruction &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002205 Assert(0, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002206}
Chris Lattner0e851da2002-04-18 20:37:37 +00002207
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002208void Verifier::visitTruncInst(TruncInst &I) {
2209 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002210 Type *SrcTy = I.getOperand(0)->getType();
2211 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002212
2213 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002214 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2215 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002216
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002217 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2218 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2219 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2220 "trunc source and destination must both be a vector or neither", &I);
2221 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002222
2223 visitInstruction(I);
2224}
2225
2226void Verifier::visitZExtInst(ZExtInst &I) {
2227 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002228 Type *SrcTy = I.getOperand(0)->getType();
2229 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002230
2231 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002232 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2233 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2234 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2235 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002236 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2237 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002238
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002239 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002240
2241 visitInstruction(I);
2242}
2243
2244void Verifier::visitSExtInst(SExtInst &I) {
2245 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002246 Type *SrcTy = I.getOperand(0)->getType();
2247 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002248
2249 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002250 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2251 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002252
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002253 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2254 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2255 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2256 "sext source and destination must both be a vector or neither", &I);
2257 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002258
2259 visitInstruction(I);
2260}
2261
2262void Verifier::visitFPTruncInst(FPTruncInst &I) {
2263 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002264 Type *SrcTy = I.getOperand(0)->getType();
2265 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002266 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002267 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2268 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002269
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002270 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2271 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2272 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2273 "fptrunc source and destination must both be a vector or neither", &I);
2274 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002275
2276 visitInstruction(I);
2277}
2278
2279void Verifier::visitFPExtInst(FPExtInst &I) {
2280 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002281 Type *SrcTy = I.getOperand(0)->getType();
2282 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002283
2284 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002285 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2286 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002287
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002288 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2289 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2290 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2291 "fpext source and destination must both be a vector or neither", &I);
2292 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002293
2294 visitInstruction(I);
2295}
2296
2297void Verifier::visitUIToFPInst(UIToFPInst &I) {
2298 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002299 Type *SrcTy = I.getOperand(0)->getType();
2300 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002301
Duncan Sands19d0b472010-02-16 11:11:14 +00002302 bool SrcVec = SrcTy->isVectorTy();
2303 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002304
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002305 Assert(SrcVec == DstVec,
2306 "UIToFP source and dest must both be vector or scalar", &I);
2307 Assert(SrcTy->isIntOrIntVectorTy(),
2308 "UIToFP source must be integer or integer vector", &I);
2309 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2310 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002311
2312 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002313 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2314 cast<VectorType>(DestTy)->getNumElements(),
2315 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002316
2317 visitInstruction(I);
2318}
2319
2320void Verifier::visitSIToFPInst(SIToFPInst &I) {
2321 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002322 Type *SrcTy = I.getOperand(0)->getType();
2323 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002324
Duncan Sands19d0b472010-02-16 11:11:14 +00002325 bool SrcVec = SrcTy->isVectorTy();
2326 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002327
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002328 Assert(SrcVec == DstVec,
2329 "SIToFP source and dest must both be vector or scalar", &I);
2330 Assert(SrcTy->isIntOrIntVectorTy(),
2331 "SIToFP source must be integer or integer vector", &I);
2332 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2333 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002334
2335 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002336 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2337 cast<VectorType>(DestTy)->getNumElements(),
2338 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002339
2340 visitInstruction(I);
2341}
2342
2343void Verifier::visitFPToUIInst(FPToUIInst &I) {
2344 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002345 Type *SrcTy = I.getOperand(0)->getType();
2346 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002347
Duncan Sands19d0b472010-02-16 11:11:14 +00002348 bool SrcVec = SrcTy->isVectorTy();
2349 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002350
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002351 Assert(SrcVec == DstVec,
2352 "FPToUI source and dest must both be vector or scalar", &I);
2353 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2354 &I);
2355 Assert(DestTy->isIntOrIntVectorTy(),
2356 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002357
2358 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002359 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2360 cast<VectorType>(DestTy)->getNumElements(),
2361 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002362
2363 visitInstruction(I);
2364}
2365
2366void Verifier::visitFPToSIInst(FPToSIInst &I) {
2367 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002368 Type *SrcTy = I.getOperand(0)->getType();
2369 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002370
Duncan Sands19d0b472010-02-16 11:11:14 +00002371 bool SrcVec = SrcTy->isVectorTy();
2372 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002373
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002374 Assert(SrcVec == DstVec,
2375 "FPToSI source and dest must both be vector or scalar", &I);
2376 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2377 &I);
2378 Assert(DestTy->isIntOrIntVectorTy(),
2379 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002380
2381 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002382 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2383 cast<VectorType>(DestTy)->getNumElements(),
2384 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002385
2386 visitInstruction(I);
2387}
2388
2389void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2390 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002391 Type *SrcTy = I.getOperand(0)->getType();
2392 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002393
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002394 Assert(SrcTy->getScalarType()->isPointerTy(),
2395 "PtrToInt source must be pointer", &I);
2396 Assert(DestTy->getScalarType()->isIntegerTy(),
2397 "PtrToInt result must be integral", &I);
2398 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2399 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002400
2401 if (SrcTy->isVectorTy()) {
2402 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2403 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002404 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2405 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002406 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002407
2408 visitInstruction(I);
2409}
2410
2411void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2412 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002413 Type *SrcTy = I.getOperand(0)->getType();
2414 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002415
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002416 Assert(SrcTy->getScalarType()->isIntegerTy(),
2417 "IntToPtr source must be an integral", &I);
2418 Assert(DestTy->getScalarType()->isPointerTy(),
2419 "IntToPtr result must be a pointer", &I);
2420 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2421 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002422 if (SrcTy->isVectorTy()) {
2423 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2424 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002425 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2426 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002427 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002428 visitInstruction(I);
2429}
2430
2431void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002432 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002433 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2434 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002435 visitInstruction(I);
2436}
2437
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002438void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2439 Type *SrcTy = I.getOperand(0)->getType();
2440 Type *DestTy = I.getType();
2441
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002442 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2443 &I);
2444 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2445 &I);
2446 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2447 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002448 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002449 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2450 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002451 visitInstruction(I);
2452}
2453
Misha Brukmanc566ca362004-03-02 00:22:19 +00002454/// visitPHINode - Ensure that a PHI node is well formed.
2455///
Chris Lattner069a7952002-06-25 15:56:27 +00002456void Verifier::visitPHINode(PHINode &PN) {
2457 // Ensure that the PHI nodes are all grouped together at the top of the block.
2458 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002459 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002460 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002461 Assert(&PN == &PN.getParent()->front() ||
2462 isa<PHINode>(--BasicBlock::iterator(&PN)),
2463 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002464
David Majnemerb611e3f2015-08-14 05:09:07 +00002465 // Check that a PHI doesn't yield a Token.
2466 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2467
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002468 // Check that all of the values of the PHI node have the same type as the
2469 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002470 for (Value *IncValue : PN.incoming_values()) {
2471 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002472 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002473 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002474
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002475 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002476
2477 visitInstruction(PN);
2478}
2479
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002480void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002481 Instruction *I = CS.getInstruction();
2482
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002483 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2484 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002485 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002486
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002487 Assert(FPTy->getElementType()->isFunctionTy(),
2488 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002489
2490 Assert(FPTy->getElementType() == CS.getFunctionType(),
2491 "Called function is not the same type as the call!", I);
2492
2493 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002494
2495 // Verify that the correct number of arguments are being passed
2496 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002497 Assert(CS.arg_size() >= FTy->getNumParams(),
2498 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002499 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002500 Assert(CS.arg_size() == FTy->getNumParams(),
2501 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002502
Chris Lattner609de002010-05-10 20:58:42 +00002503 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002504 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002505 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2506 "Call parameter type does not match function signature!",
2507 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002508
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002509 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002510
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002511 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002512 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002513
Duncan Sands8c582282007-12-21 19:19:01 +00002514 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002515 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002516
David Majnemer91db08b2014-04-30 17:22:00 +00002517 // Conservatively check the inalloca argument.
2518 // We have a bug if we can find that there is an underlying alloca without
2519 // inalloca.
2520 if (CS.hasInAllocaArgument()) {
2521 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2522 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002523 Assert(AI->isUsedWithInAlloca(),
2524 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002525 }
2526
Manman Ren9bfd0d02016-04-01 21:41:15 +00002527 // For each argument of the callsite, if it has the swifterror argument,
2528 // make sure the underlying alloca has swifterror as well.
2529 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2530 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2531 Value *SwiftErrorArg = CS.getArgument(i);
2532 auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets());
2533 Assert(AI, "swifterror argument should come from alloca", AI, I);
2534 if (AI)
2535 Assert(AI->isSwiftError(),
2536 "swifterror argument for call has mismatched alloca", AI, I);
2537 }
2538
Stephen Linb8bd2322013-04-20 05:14:40 +00002539 if (FTy->isVarArg()) {
2540 // FIXME? is 'nest' even legal here?
2541 bool SawNest = false;
2542 bool SawReturned = false;
2543
2544 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2545 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2546 SawNest = true;
2547 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2548 SawReturned = true;
2549 }
2550
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002551 // Check attributes on the varargs part.
2552 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002553 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002554 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002555
Stephen Linb8bd2322013-04-20 05:14:40 +00002556 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002557 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002558 SawNest = true;
2559 }
2560
2561 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002562 Assert(!SawReturned, "More than one parameter has attribute returned!",
2563 I);
2564 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2565 "Incompatible argument and return types for 'returned' "
2566 "attribute",
2567 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002568 SawReturned = true;
2569 }
Duncan Sands0009c442008-01-12 16:42:01 +00002570
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002571 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2572 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002573
2574 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002575 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002576 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002577 }
Duncan Sands8c582282007-12-21 19:19:01 +00002578
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002579 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002580 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002581 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002582 for (Type *ParamTy : FTy->params()) {
2583 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002584 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002585 Assert(!ParamTy->isTokenTy(),
2586 "Function has token parameter but isn't an intrinsic", I);
2587 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002588 }
2589
David Majnemerb611e3f2015-08-14 05:09:07 +00002590 // Verify that indirect calls don't return tokens.
2591 if (CS.getCalledFunction() == nullptr)
2592 Assert(!FTy->getReturnType()->isTokenTy(),
2593 "Return type cannot be token for indirect call!");
2594
Philip Reamesa3c6f002015-06-26 21:39:44 +00002595 if (Function *F = CS.getCalledFunction())
2596 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002597 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002598
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002599 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2600 // at most one "gc-transition" operand bundle.
2601 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2602 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002603 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002604 OperandBundleUse BU = CS.getOperandBundleAt(i);
2605 uint32_t Tag = BU.getTagID();
2606 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002607 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2608 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002609 } else if (Tag == LLVMContext::OB_gc_transition) {
2610 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2611 I);
2612 FoundGCTransitionBundle = true;
2613 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002614 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2615 FoundFuncletBundle = true;
2616 Assert(BU.Inputs.size() == 1,
2617 "Expected exactly one funclet bundle operand", I);
2618 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2619 "Funclet bundle operands should correspond to a FuncletPadInst",
2620 I);
2621 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002622 }
2623
Adrian Prantl93035c82016-04-24 22:23:13 +00002624 // Verify that each inlinable callsite of a debug-info-bearing function in a
2625 // debug-info-bearing function has a debug location attached to it. Failure to
2626 // do so causes assertion failures when the inliner sets up inline scope info.
2627 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2628 CS.getCalledFunction()->getSubprogram())
2629 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2630 "info must have a !dbg location",
2631 I);
2632
Duncan Sands8c582282007-12-21 19:19:01 +00002633 visitInstruction(*I);
2634}
2635
Reid Kleckner5772b772014-04-24 20:14:34 +00002636/// Two types are "congruent" if they are identical, or if they are both pointer
2637/// types with different pointee types and the same address space.
2638static bool isTypeCongruent(Type *L, Type *R) {
2639 if (L == R)
2640 return true;
2641 PointerType *PL = dyn_cast<PointerType>(L);
2642 PointerType *PR = dyn_cast<PointerType>(R);
2643 if (!PL || !PR)
2644 return false;
2645 return PL->getAddressSpace() == PR->getAddressSpace();
2646}
2647
Reid Klecknerd20c9702014-05-15 23:58:57 +00002648static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2649 static const Attribute::AttrKind ABIAttrs[] = {
2650 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002651 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2652 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002653 AttrBuilder Copy;
2654 for (auto AK : ABIAttrs) {
2655 if (Attrs.hasAttribute(I + 1, AK))
2656 Copy.addAttribute(AK);
2657 }
2658 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2659 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2660 return Copy;
2661}
2662
Reid Kleckner5772b772014-04-24 20:14:34 +00002663void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002664 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002665
2666 // - The caller and callee prototypes must match. Pointer types of
2667 // parameters or return types may differ in pointee type, but not
2668 // address space.
2669 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002670 FunctionType *CallerTy = F->getFunctionType();
2671 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002672 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2673 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2674 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2675 "cannot guarantee tail call due to mismatched varargs", &CI);
2676 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2677 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002678 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002679 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002680 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2681 "cannot guarantee tail call due to mismatched parameter types", &CI);
2682 }
2683
2684 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002685 Assert(F->getCallingConv() == CI.getCallingConv(),
2686 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002687
2688 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2689 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002690 AttributeSet CallerAttrs = F->getAttributes();
2691 AttributeSet CalleeAttrs = CI.getAttributes();
2692 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002693 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2694 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002695 Assert(CallerABIAttrs == CalleeABIAttrs,
2696 "cannot guarantee tail call due to mismatched ABI impacting "
2697 "function attributes",
2698 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002699 }
2700
2701 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2702 // or a pointer bitcast followed by a ret instruction.
2703 // - The ret instruction must return the (possibly bitcasted) value
2704 // produced by the call or void.
2705 Value *RetVal = &CI;
2706 Instruction *Next = CI.getNextNode();
2707
2708 // Handle the optional bitcast.
2709 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002710 Assert(BI->getOperand(0) == RetVal,
2711 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002712 RetVal = BI;
2713 Next = BI->getNextNode();
2714 }
2715
2716 // Check the return.
2717 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002718 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2719 &CI);
2720 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2721 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002722}
2723
Duncan Sands8c582282007-12-21 19:19:01 +00002724void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002725 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002726
Reid Kleckner5772b772014-04-24 20:14:34 +00002727 if (CI.isMustTailCall())
2728 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002729}
2730
2731void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002732 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002733
David Majnemer654e1302015-07-31 17:58:14 +00002734 // Verify that the first non-PHI instruction of the unwind destination is an
2735 // exception handling instruction.
2736 Assert(
2737 II.getUnwindDest()->isEHPad(),
2738 "The unwind destination does not have an exception handling instruction!",
2739 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002740
Dan Gohman9c6e1882010-08-02 23:09:14 +00002741 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002742}
Chris Lattner0e851da2002-04-18 20:37:37 +00002743
Misha Brukmanc566ca362004-03-02 00:22:19 +00002744/// visitBinaryOperator - Check that both arguments to the binary operator are
2745/// of the same type!
2746///
Chris Lattner069a7952002-06-25 15:56:27 +00002747void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002748 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2749 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002750
Reid Spencer2341c222007-02-02 02:16:23 +00002751 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002752 // Check that integer arithmetic operators are only used with
2753 // integral operands.
2754 case Instruction::Add:
2755 case Instruction::Sub:
2756 case Instruction::Mul:
2757 case Instruction::SDiv:
2758 case Instruction::UDiv:
2759 case Instruction::SRem:
2760 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002761 Assert(B.getType()->isIntOrIntVectorTy(),
2762 "Integer arithmetic operators only work with integral types!", &B);
2763 Assert(B.getType() == B.getOperand(0)->getType(),
2764 "Integer arithmetic operators must have same type "
2765 "for operands and result!",
2766 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002767 break;
2768 // Check that floating-point arithmetic operators are only used with
2769 // floating-point operands.
2770 case Instruction::FAdd:
2771 case Instruction::FSub:
2772 case Instruction::FMul:
2773 case Instruction::FDiv:
2774 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002775 Assert(B.getType()->isFPOrFPVectorTy(),
2776 "Floating-point arithmetic operators only work with "
2777 "floating-point types!",
2778 &B);
2779 Assert(B.getType() == B.getOperand(0)->getType(),
2780 "Floating-point arithmetic operators must have same type "
2781 "for operands and result!",
2782 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002783 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002784 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002785 case Instruction::And:
2786 case Instruction::Or:
2787 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002788 Assert(B.getType()->isIntOrIntVectorTy(),
2789 "Logical operators only work with integral types!", &B);
2790 Assert(B.getType() == B.getOperand(0)->getType(),
2791 "Logical operators must have same type for operands and result!",
2792 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002793 break;
2794 case Instruction::Shl:
2795 case Instruction::LShr:
2796 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002797 Assert(B.getType()->isIntOrIntVectorTy(),
2798 "Shifts only work with integral types!", &B);
2799 Assert(B.getType() == B.getOperand(0)->getType(),
2800 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002801 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002802 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002803 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002804 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002805
Chris Lattner0e851da2002-04-18 20:37:37 +00002806 visitInstruction(B);
2807}
2808
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002809void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002810 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002811 Type *Op0Ty = IC.getOperand(0)->getType();
2812 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002813 Assert(Op0Ty == Op1Ty,
2814 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002815 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002816 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2817 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002818 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002819 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2820 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2821 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002822
Reid Spencerd9436b62006-11-20 01:22:35 +00002823 visitInstruction(IC);
2824}
2825
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002826void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002827 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002828 Type *Op0Ty = FC.getOperand(0)->getType();
2829 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002830 Assert(Op0Ty == Op1Ty,
2831 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002832 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002833 Assert(Op0Ty->isFPOrFPVectorTy(),
2834 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002835 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002836 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2837 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2838 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002839
Reid Spencerd9436b62006-11-20 01:22:35 +00002840 visitInstruction(FC);
2841}
2842
Robert Bocchino23004482006-01-10 19:05:34 +00002843void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002844 Assert(
2845 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2846 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002847 visitInstruction(EI);
2848}
2849
Robert Bocchinoca27f032006-01-17 20:07:22 +00002850void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002851 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2852 IE.getOperand(2)),
2853 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002854 visitInstruction(IE);
2855}
2856
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002857void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002858 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2859 SV.getOperand(2)),
2860 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002861 visitInstruction(SV);
2862}
2863
Chris Lattner069a7952002-06-25 15:56:27 +00002864void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002865 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002866
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002867 Assert(isa<PointerType>(TargetTy),
2868 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002869 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002870 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002871 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002872 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002873 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002874
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002875 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002876 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002877 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002878
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002879 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002880 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002881 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2882 if (GEP.getPointerOperandType()->isVectorTy())
2883 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2884 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002885 for (Value *Idx : Idxs) {
2886 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002887 if (IndexTy->isVectorTy()) {
2888 unsigned IndexWidth = IndexTy->getVectorNumElements();
2889 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2890 }
2891 Assert(IndexTy->getScalarType()->isIntegerTy(),
2892 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002893 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002894 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002895 visitInstruction(GEP);
2896}
2897
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002898static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2899 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2900}
2901
Philip Reamesbf9676f2014-10-20 23:52:07 +00002902void Verifier::visitRangeMetadata(Instruction& I,
2903 MDNode* Range, Type* Ty) {
2904 assert(Range &&
2905 Range == I.getMetadata(LLVMContext::MD_range) &&
2906 "precondition violation");
2907
2908 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002909 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002910 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002911 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2912
Philip Reamesbf9676f2014-10-20 23:52:07 +00002913 ConstantRange LastRange(1); // Dummy initial value
2914 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002915 ConstantInt *Low =
2916 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002917 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002918 ConstantInt *High =
2919 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002920 Assert(High, "The upper limit must be an integer!", High);
2921 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2922 "Range types must match instruction type!", &I);
2923
Philip Reamesbf9676f2014-10-20 23:52:07 +00002924 APInt HighV = High->getValue();
2925 APInt LowV = Low->getValue();
2926 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002927 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2928 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002929 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002930 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2931 "Intervals are overlapping", Range);
2932 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2933 Range);
2934 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2935 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002936 }
2937 LastRange = ConstantRange(LowV, HighV);
2938 }
2939 if (NumRanges > 2) {
2940 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002941 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002942 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002943 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00002944 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002945 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2946 "Intervals are overlapping", Range);
2947 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2948 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002949 }
2950}
2951
JF Bastiend1fb5852015-12-17 22:09:19 +00002952void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2953 const Instruction *I) {
2954 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2955 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2956 Assert(!(Size & (Size - 1)),
2957 "atomic memory access' operand must have a power-of-two size", Ty, I);
2958}
2959
Chris Lattner069a7952002-06-25 15:56:27 +00002960void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002961 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002962 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00002963 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002964 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2965 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00002966 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002967 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00002968 Assert(LI.getOrdering() != AtomicOrdering::Release &&
2969 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002970 "Load cannot have Release ordering", &LI);
2971 Assert(LI.getAlignment() != 0,
2972 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00002973 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2974 ElTy->isFloatingPointTy(),
2975 "atomic load operand must have integer, pointer, or floating point "
2976 "type!",
2977 ElTy, &LI);
2978 checkAtomicMemAccessSize(M, ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002979 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002980 Assert(LI.getSynchScope() == CrossThread,
2981 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00002982 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00002983
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002984 visitInstruction(LI);
2985}
2986
Chris Lattner069a7952002-06-25 15:56:27 +00002987void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00002988 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002989 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00002990 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002991 Assert(ElTy == SI.getOperand(0)->getType(),
2992 "Stored value type does not match pointer operand type!", &SI, ElTy);
2993 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2994 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00002995 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00002996 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00002997 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
2998 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002999 "Store cannot have Acquire ordering", &SI);
3000 Assert(SI.getAlignment() != 0,
3001 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003002 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3003 ElTy->isFloatingPointTy(),
3004 "atomic store operand must have integer, pointer, or floating point "
3005 "type!",
3006 ElTy, &SI);
3007 checkAtomicMemAccessSize(M, ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003008 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003009 Assert(SI.getSynchScope() == CrossThread,
3010 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003011 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003012 visitInstruction(SI);
3013}
3014
Manman Ren9bfd0d02016-04-01 21:41:15 +00003015/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3016void Verifier::verifySwiftErrorCallSite(CallSite CS,
3017 const Value *SwiftErrorVal) {
3018 unsigned Idx = 0;
3019 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3020 I != E; ++I, ++Idx) {
3021 if (*I == SwiftErrorVal) {
3022 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3023 "swifterror value when used in a callsite should be marked "
3024 "with swifterror attribute",
3025 SwiftErrorVal, CS);
3026 }
3027 }
3028}
3029
3030void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3031 // Check that swifterror value is only used by loads, stores, or as
3032 // a swifterror argument.
3033 for (const User *U : SwiftErrorVal->users()) {
3034 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3035 isa<InvokeInst>(U),
3036 "swifterror value can only be loaded and stored from, or "
3037 "as a swifterror argument!",
3038 SwiftErrorVal, U);
3039 // If it is used by a store, check it is the second operand.
3040 if (auto StoreI = dyn_cast<StoreInst>(U))
3041 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3042 "swifterror value should be the second operand when used "
3043 "by stores", SwiftErrorVal, U);
3044 if (auto CallI = dyn_cast<CallInst>(U))
3045 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3046 if (auto II = dyn_cast<InvokeInst>(U))
3047 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3048 }
3049}
3050
Victor Hernandez8acf2952009-10-23 21:09:37 +00003051void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003052 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003053 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003054 Assert(PTy->getAddressSpace() == 0,
3055 "Allocation instruction pointer not in the generic address space!",
3056 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003057 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003058 "Cannot allocate unsized type", &AI);
3059 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3060 "Alloca array size must have integer type", &AI);
3061 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3062 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003063
Manman Ren9bfd0d02016-04-01 21:41:15 +00003064 if (AI.isSwiftError()) {
3065 verifySwiftErrorValue(&AI);
3066 }
3067
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003068 visitInstruction(AI);
3069}
3070
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003071void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003072
3073 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003074 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003075 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003076 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003077 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003078 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003079 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003080 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003081 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003082 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3083 "cmpxchg instructions failure argument shall be no stronger than the "
3084 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003085 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003086 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3087 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003088 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003089
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003090 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003091 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003092 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003093 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3094 "cmpxchg operand must have integer or pointer type",
3095 ElTy, &CXI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003096 checkAtomicMemAccessSize(M, ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003097 Assert(ElTy == CXI.getOperand(1)->getType(),
3098 "Expected value type does not match pointer operand type!", &CXI,
3099 ElTy);
3100 Assert(ElTy == CXI.getOperand(2)->getType(),
3101 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003102 visitInstruction(CXI);
3103}
3104
3105void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003106 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003107 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003108 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003109 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003110 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003111 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003112 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003113 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3114 &RMWI, ElTy);
JF Bastiend1fb5852015-12-17 22:09:19 +00003115 checkAtomicMemAccessSize(M, ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003116 Assert(ElTy == RMWI.getOperand(1)->getType(),
3117 "Argument value type does not match pointer operand type!", &RMWI,
3118 ElTy);
3119 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3120 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3121 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003122 visitInstruction(RMWI);
3123}
3124
Eli Friedmanfee02c62011-07-25 23:16:38 +00003125void Verifier::visitFenceInst(FenceInst &FI) {
3126 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003127 Assert(Ordering == AtomicOrdering::Acquire ||
3128 Ordering == AtomicOrdering::Release ||
3129 Ordering == AtomicOrdering::AcquireRelease ||
3130 Ordering == AtomicOrdering::SequentiallyConsistent,
3131 "fence instructions may only have acquire, release, acq_rel, or "
3132 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003133 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003134 visitInstruction(FI);
3135}
3136
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003137void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003138 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3139 EVI.getIndices()) == EVI.getType(),
3140 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003141
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003142 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003143}
3144
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003145void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003146 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3147 IVI.getIndices()) ==
3148 IVI.getOperand(1)->getType(),
3149 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003150
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003151 visitInstruction(IVI);
3152}
Chris Lattner0e851da2002-04-18 20:37:37 +00003153
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003154static Value *getParentPad(Value *EHPad) {
3155 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3156 return FPI->getParentPad();
3157
3158 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3159}
3160
David Majnemer85a549d2015-08-11 02:48:30 +00003161void Verifier::visitEHPadPredecessors(Instruction &I) {
3162 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003163
David Majnemer85a549d2015-08-11 02:48:30 +00003164 BasicBlock *BB = I.getParent();
3165 Function *F = BB->getParent();
3166
3167 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3168
3169 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3170 // The landingpad instruction defines its parent as a landing pad block. The
3171 // landing pad block may be branched to only by the unwind edge of an
3172 // invoke.
3173 for (BasicBlock *PredBB : predecessors(BB)) {
3174 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3175 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3176 "Block containing LandingPadInst must be jumped to "
3177 "only by the unwind edge of an invoke.",
3178 LPI);
3179 }
3180 return;
3181 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003182 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3183 if (!pred_empty(BB))
3184 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3185 "Block containg CatchPadInst must be jumped to "
3186 "only by its catchswitch.",
3187 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003188 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3189 "Catchswitch cannot unwind to one of its catchpads",
3190 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003191 return;
3192 }
David Majnemer85a549d2015-08-11 02:48:30 +00003193
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003194 // Verify that each pred has a legal terminator with a legal to/from EH
3195 // pad relationship.
3196 Instruction *ToPad = &I;
3197 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003198 for (BasicBlock *PredBB : predecessors(BB)) {
3199 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003200 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003201 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003202 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003203 "EH pad must be jumped to via an unwind edge", ToPad, II);
3204 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3205 FromPad = Bundle->Inputs[0];
3206 else
3207 FromPad = ConstantTokenNone::get(II->getContext());
3208 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003209 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003210 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3211 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3212 FromPad = CSI;
3213 } else {
3214 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3215 }
3216
3217 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003218 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003219 for (;; FromPad = getParentPad(FromPad)) {
3220 Assert(FromPad != ToPad,
3221 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3222 if (FromPad == ToPadParent) {
3223 // This is a legal unwind edge.
3224 break;
3225 }
3226 Assert(!isa<ConstantTokenNone>(FromPad),
3227 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003228 Assert(Seen.insert(FromPad).second,
3229 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003230 }
David Majnemer85a549d2015-08-11 02:48:30 +00003231 }
3232}
3233
3234void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003235 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3236 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003237 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3238 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003239
David Majnemer85a549d2015-08-11 02:48:30 +00003240 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003241
David Majnemer654e1302015-07-31 17:58:14 +00003242 if (!LandingPadResultTy)
3243 LandingPadResultTy = LPI.getType();
3244 else
3245 Assert(LandingPadResultTy == LPI.getType(),
3246 "The landingpad instruction should have a consistent result type "
3247 "inside a function.",
3248 &LPI);
3249
David Majnemer7fddecc2015-06-17 20:52:32 +00003250 Function *F = LPI.getParent()->getParent();
3251 Assert(F->hasPersonalityFn(),
3252 "LandingPadInst needs to be in a function with a personality.", &LPI);
3253
Bill Wendlingfae14752011-08-12 20:24:12 +00003254 // The landingpad instruction must be the first non-PHI instruction in the
3255 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003256 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3257 "LandingPadInst not the first non-PHI instruction in the block.",
3258 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003259
Duncan Sands86de1a62011-09-27 16:43:19 +00003260 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003261 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003262 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003263 Assert(isa<PointerType>(Clause->getType()),
3264 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003265 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003266 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3267 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3268 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003269 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003270 }
3271
Bill Wendlingfae14752011-08-12 20:24:12 +00003272 visitInstruction(LPI);
3273}
3274
David Majnemer654e1302015-07-31 17:58:14 +00003275void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003276 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003277
David Majnemer654e1302015-07-31 17:58:14 +00003278 Function *F = BB->getParent();
3279 Assert(F->hasPersonalityFn(),
3280 "CatchPadInst needs to be in a function with a personality.", &CPI);
3281
David Majnemer8a1c45d2015-12-12 05:38:55 +00003282 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3283 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3284 CPI.getParentPad());
3285
David Majnemer654e1302015-07-31 17:58:14 +00003286 // The catchpad instruction must be the first non-PHI instruction in the
3287 // block.
3288 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003289 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003290
David Majnemerfe2f7f32016-02-29 22:56:36 +00003291 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003292 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003293}
3294
David Majnemer8a1c45d2015-12-12 05:38:55 +00003295void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3296 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3297 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3298 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003299
David Majnemer8a1c45d2015-12-12 05:38:55 +00003300 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003301}
3302
3303void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3304 BasicBlock *BB = CPI.getParent();
3305
David Majnemer654e1302015-07-31 17:58:14 +00003306 Function *F = BB->getParent();
3307 Assert(F->hasPersonalityFn(),
3308 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3309
3310 // The cleanuppad instruction must be the first non-PHI instruction in the
3311 // block.
3312 Assert(BB->getFirstNonPHI() == &CPI,
3313 "CleanupPadInst not the first non-PHI instruction in the block.",
3314 &CPI);
3315
David Majnemer8a1c45d2015-12-12 05:38:55 +00003316 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003317 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003318 "CleanupPadInst has an invalid parent.", &CPI);
3319
David Majnemerfe2f7f32016-02-29 22:56:36 +00003320 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003321 visitFuncletPadInst(CPI);
3322}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003323
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003324void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3325 User *FirstUser = nullptr;
3326 Value *FirstUnwindPad = nullptr;
3327 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003328 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003329
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003330 while (!Worklist.empty()) {
3331 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003332 Assert(Seen.insert(CurrentPad).second,
3333 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003334 Value *UnresolvedAncestorPad = nullptr;
3335 for (User *U : CurrentPad->users()) {
3336 BasicBlock *UnwindDest;
3337 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3338 UnwindDest = CRI->getUnwindDest();
3339 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3340 // We allow catchswitch unwind to caller to nest
3341 // within an outer pad that unwinds somewhere else,
3342 // because catchswitch doesn't have a nounwind variant.
3343 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3344 if (CSI->unwindsToCaller())
3345 continue;
3346 UnwindDest = CSI->getUnwindDest();
3347 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3348 UnwindDest = II->getUnwindDest();
3349 } else if (isa<CallInst>(U)) {
3350 // Calls which don't unwind may be found inside funclet
3351 // pads that unwind somewhere else. We don't *require*
3352 // such calls to be annotated nounwind.
3353 continue;
3354 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3355 // The unwind dest for a cleanup can only be found by
3356 // recursive search. Add it to the worklist, and we'll
3357 // search for its first use that determines where it unwinds.
3358 Worklist.push_back(CPI);
3359 continue;
3360 } else {
3361 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3362 continue;
3363 }
3364
3365 Value *UnwindPad;
3366 bool ExitsFPI;
3367 if (UnwindDest) {
3368 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003369 if (!cast<Instruction>(UnwindPad)->isEHPad())
3370 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003371 Value *UnwindParent = getParentPad(UnwindPad);
3372 // Ignore unwind edges that don't exit CurrentPad.
3373 if (UnwindParent == CurrentPad)
3374 continue;
3375 // Determine whether the original funclet pad is exited,
3376 // and if we are scanning nested pads determine how many
3377 // of them are exited so we can stop searching their
3378 // children.
3379 Value *ExitedPad = CurrentPad;
3380 ExitsFPI = false;
3381 do {
3382 if (ExitedPad == &FPI) {
3383 ExitsFPI = true;
3384 // Now we can resolve any ancestors of CurrentPad up to
3385 // FPI, but not including FPI since we need to make sure
3386 // to check all direct users of FPI for consistency.
3387 UnresolvedAncestorPad = &FPI;
3388 break;
3389 }
3390 Value *ExitedParent = getParentPad(ExitedPad);
3391 if (ExitedParent == UnwindParent) {
3392 // ExitedPad is the ancestor-most pad which this unwind
3393 // edge exits, so we can resolve up to it, meaning that
3394 // ExitedParent is the first ancestor still unresolved.
3395 UnresolvedAncestorPad = ExitedParent;
3396 break;
3397 }
3398 ExitedPad = ExitedParent;
3399 } while (!isa<ConstantTokenNone>(ExitedPad));
3400 } else {
3401 // Unwinding to caller exits all pads.
3402 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3403 ExitsFPI = true;
3404 UnresolvedAncestorPad = &FPI;
3405 }
3406
3407 if (ExitsFPI) {
3408 // This unwind edge exits FPI. Make sure it agrees with other
3409 // such edges.
3410 if (FirstUser) {
3411 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3412 "pad must have the same unwind "
3413 "dest",
3414 &FPI, U, FirstUser);
3415 } else {
3416 FirstUser = U;
3417 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003418 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3419 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3420 getParentPad(UnwindPad) == getParentPad(&FPI))
3421 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003422 }
3423 }
3424 // Make sure we visit all uses of FPI, but for nested pads stop as
3425 // soon as we know where they unwind to.
3426 if (CurrentPad != &FPI)
3427 break;
3428 }
3429 if (UnresolvedAncestorPad) {
3430 if (CurrentPad == UnresolvedAncestorPad) {
3431 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3432 // we've found an unwind edge that exits it, because we need to verify
3433 // all direct uses of FPI.
3434 assert(CurrentPad == &FPI);
3435 continue;
3436 }
3437 // Pop off the worklist any nested pads that we've found an unwind
3438 // destination for. The pads on the worklist are the uncles,
3439 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3440 // for all ancestors of CurrentPad up to but not including
3441 // UnresolvedAncestorPad.
3442 Value *ResolvedPad = CurrentPad;
3443 while (!Worklist.empty()) {
3444 Value *UnclePad = Worklist.back();
3445 Value *AncestorPad = getParentPad(UnclePad);
3446 // Walk ResolvedPad up the ancestor list until we either find the
3447 // uncle's parent or the last resolved ancestor.
3448 while (ResolvedPad != AncestorPad) {
3449 Value *ResolvedParent = getParentPad(ResolvedPad);
3450 if (ResolvedParent == UnresolvedAncestorPad) {
3451 break;
3452 }
3453 ResolvedPad = ResolvedParent;
3454 }
3455 // If the resolved ancestor search didn't find the uncle's parent,
3456 // then the uncle is not yet resolved.
3457 if (ResolvedPad != AncestorPad)
3458 break;
3459 // This uncle is resolved, so pop it from the worklist.
3460 Worklist.pop_back();
3461 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003462 }
3463 }
3464
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003465 if (FirstUnwindPad) {
3466 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3467 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3468 Value *SwitchUnwindPad;
3469 if (SwitchUnwindDest)
3470 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3471 else
3472 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3473 Assert(SwitchUnwindPad == FirstUnwindPad,
3474 "Unwind edges out of a catch must have the same unwind dest as "
3475 "the parent catchswitch",
3476 &FPI, FirstUser, CatchSwitch);
3477 }
3478 }
3479
3480 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003481}
3482
David Majnemer8a1c45d2015-12-12 05:38:55 +00003483void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003484 BasicBlock *BB = CatchSwitch.getParent();
3485
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003486 Function *F = BB->getParent();
3487 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003488 "CatchSwitchInst needs to be in a function with a personality.",
3489 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003490
David Majnemer8a1c45d2015-12-12 05:38:55 +00003491 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003492 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003493 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3494 "CatchSwitchInst not the first non-PHI instruction in the block.",
3495 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003496
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003497 auto *ParentPad = CatchSwitch.getParentPad();
3498 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3499 "CatchSwitchInst has an invalid parent.", ParentPad);
3500
David Majnemer8a1c45d2015-12-12 05:38:55 +00003501 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003502 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003503 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3504 "CatchSwitchInst must unwind to an EH block which is not a "
3505 "landingpad.",
3506 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003507
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003508 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3509 if (getParentPad(I) == ParentPad)
3510 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3511 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003512
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003513 Assert(CatchSwitch.getNumHandlers() != 0,
3514 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3515
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003516 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003517 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3518 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003519 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003520
David Majnemerfe2f7f32016-02-29 22:56:36 +00003521 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003522 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003523}
3524
David Majnemer654e1302015-07-31 17:58:14 +00003525void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003526 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3527 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3528 CRI.getOperand(0));
3529
David Majnemer654e1302015-07-31 17:58:14 +00003530 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3531 Instruction *I = UnwindDest->getFirstNonPHI();
3532 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3533 "CleanupReturnInst must unwind to an EH block which is not a "
3534 "landingpad.",
3535 &CRI);
3536 }
3537
3538 visitTerminatorInst(CRI);
3539}
3540
Rafael Espindola654320a2012-02-26 02:23:37 +00003541void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3542 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003543 // If the we have an invalid invoke, don't try to compute the dominance.
3544 // We already reject it in the invoke specific checks and the dominance
3545 // computation doesn't handle multiple edges.
3546 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3547 if (II->getNormalDest() == II->getUnwindDest())
3548 return;
3549 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003550
Michael Kruseff379b62016-03-26 23:32:57 +00003551 // Quick check whether the def has already been encountered in the same block.
3552 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3553 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003554 //
3555 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3556 // wrapping an SSA value, assert that we've already encountered it. See
3557 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003558 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3559 return;
3560
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003561 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003562 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003563 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003564}
3565
Artur Pilipenkocca80022015-10-09 17:41:29 +00003566void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3567 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3568 "apply only to pointer types", &I);
3569 Assert(isa<LoadInst>(I),
3570 "dereferenceable, dereferenceable_or_null apply only to load"
3571 " instructions, use attributes for calls or invokes", &I);
3572 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3573 "take one operand!", &I);
3574 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3575 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3576 "dereferenceable_or_null metadata value must be an i64!", &I);
3577}
3578
Misha Brukmanc566ca362004-03-02 00:22:19 +00003579/// verifyInstruction - Verify that an instruction is well formed.
3580///
Chris Lattner069a7952002-06-25 15:56:27 +00003581void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003582 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003583 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003584
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003585 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003586 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003587 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3588 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003589 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003590 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003591
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003592 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003593 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3594 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003595
Chris Lattner5f126b72004-03-29 00:29:36 +00003596 // Check that the return value of the instruction is either void or a legal
3597 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003598 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3599 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003600
Nick Lewycky93e06a52009-09-27 23:27:42 +00003601 // Check that the instruction doesn't produce metadata. Calls are already
3602 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003603 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3604 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003605
Chris Lattner0e851da2002-04-18 20:37:37 +00003606 // Check that all uses of the instruction, if they are instructions
3607 // themselves, actually have parent basic blocks. If the use is not an
3608 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003609 for (Use &U : I.uses()) {
3610 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003611 Assert(Used->getParent() != nullptr,
3612 "Instruction referencing"
3613 " instruction not embedded in a basic block!",
3614 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003615 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003616 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003617 return;
3618 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003619 }
3620
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003621 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003622 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003623
3624 // Check to make sure that only first-class-values are operands to
3625 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003626 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003627 Assert(0, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003628 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003629
Chris Lattner9ece94b2004-03-14 03:23:54 +00003630 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003631 // Check to make sure that the "address of" an intrinsic function is never
3632 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003633 Assert(
3634 !F->isIntrinsic() ||
3635 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3636 "Cannot take the address of an intrinsic!", &I);
3637 Assert(
3638 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003639 F->getIntrinsicID() == Intrinsic::donothing ||
3640 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003641 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3642 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
Sanjoy Das999dc752016-02-29 22:04:25 +00003643 "Cannot invoke an intrinsic other than donothing, patchpoint or "
3644 "statepoint",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003645 &I);
3646 Assert(F->getParent() == M, "Referencing function in another module!",
Keno Fischera6c4ce42015-12-01 19:06:36 +00003647 &I, M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003648 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003649 Assert(OpBB->getParent() == BB->getParent(),
3650 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003651 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003652 Assert(OpArg->getParent() == BB->getParent(),
3653 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003654 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Keno Fischera6c4ce42015-12-01 19:06:36 +00003655 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003656 } else if (isa<Instruction>(I.getOperand(i))) {
3657 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003658 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003659 Assert((i + 1 == e && isa<CallInst>(I)) ||
3660 (i + 3 == e && isa<InvokeInst>(I)),
3661 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003662 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3663 if (CE->getType()->isPtrOrPtrVectorTy()) {
3664 // If we have a ConstantExpr pointer, we need to see if it came from an
3665 // illegal bitcast (inttoptr <constant int> )
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003666 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003667 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003668 }
3669 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003670
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003671 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003672 Assert(I.getType()->isFPOrFPVectorTy(),
3673 "fpmath requires a floating point result!", &I);
3674 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003675 if (ConstantFP *CFP0 =
3676 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Duncan Sands05f4df82012-04-16 16:28:59 +00003677 APFloat Accuracy = CFP0->getValueAPF();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003678 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3679 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003680 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003681 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003682 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003683 }
3684
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003685 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003686 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3687 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003688 visitRangeMetadata(I, Range, I.getType());
3689 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003690
Philip Reames0ca58b32014-10-21 20:56:29 +00003691 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003692 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3693 &I);
3694 Assert(isa<LoadInst>(I),
3695 "nonnull applies only to load instructions, use attributes"
3696 " for calls or invokes",
3697 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003698 }
3699
Artur Pilipenkocca80022015-10-09 17:41:29 +00003700 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3701 visitDereferenceableMetadata(I, MD);
3702
3703 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3704 visitDereferenceableMetadata(I, MD);
3705
3706 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3707 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3708 &I);
3709 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3710 "use attributes for calls or invokes", &I);
3711 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3712 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3713 Assert(CI && CI->getType()->isIntegerTy(64),
3714 "align metadata value must be an i64!", &I);
3715 uint64_t Align = CI->getZExtValue();
3716 Assert(isPowerOf2_64(Align),
3717 "align metadata value must be a power of 2!", &I);
3718 Assert(Align <= Value::MaximumAlignment,
3719 "alignment is larger that implementation defined limit", &I);
3720 }
3721
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003722 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003723 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003724 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003725 }
3726
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003727 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3728 verifyBitPieceExpression(*DII);
3729
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003730 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003731}
3732
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003733/// Verify that the specified type (which comes from an intrinsic argument or
3734/// return value) matches the type constraints specified by the .td file (e.g.
3735/// an "any integer" argument really is an integer).
Chris Lattner144b6192012-05-27 19:37:05 +00003736///
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003737/// This returns true on error but does not print a message.
3738bool Verifier::verifyIntrinsicType(Type *Ty,
Chris Lattner144b6192012-05-27 19:37:05 +00003739 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3740 SmallVectorImpl<Type*> &ArgTys) {
3741 using namespace Intrinsic;
3742
3743 // If we ran out of descriptors, there are too many arguments.
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003744 if (Infos.empty()) return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003745 IITDescriptor D = Infos.front();
3746 Infos = Infos.slice(1);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003747
Chris Lattner144b6192012-05-27 19:37:05 +00003748 switch (D.Kind) {
3749 case IITDescriptor::Void: return !Ty->isVoidTy();
Andrew Tricka2efd992013-10-31 17:18:11 +00003750 case IITDescriptor::VarArg: return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003751 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
Joseph Tremoulet917c7382015-09-02 13:36:25 +00003752 case IITDescriptor::Token: return !Ty->isTokenTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003753 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
Michael Ilseman6c6d7152013-01-11 01:45:05 +00003754 case IITDescriptor::Half: return !Ty->isHalfTy();
Chris Lattner144b6192012-05-27 19:37:05 +00003755 case IITDescriptor::Float: return !Ty->isFloatTy();
3756 case IITDescriptor::Double: return !Ty->isDoubleTy();
3757 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3758 case IITDescriptor::Vector: {
3759 VectorType *VT = dyn_cast<VectorType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003760 return !VT || VT->getNumElements() != D.Vector_Width ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003761 verifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003762 }
3763 case IITDescriptor::Pointer: {
3764 PointerType *PT = dyn_cast<PointerType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003765 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003766 verifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
Chris Lattner144b6192012-05-27 19:37:05 +00003767 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003768
Chris Lattner144b6192012-05-27 19:37:05 +00003769 case IITDescriptor::Struct: {
3770 StructType *ST = dyn_cast<StructType>(Ty);
Craig Topperc6207612014-04-09 06:08:46 +00003771 if (!ST || ST->getNumElements() != D.Struct_NumElements)
Chris Lattner144b6192012-05-27 19:37:05 +00003772 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003773
Chris Lattner144b6192012-05-27 19:37:05 +00003774 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003775 if (verifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
Chris Lattner144b6192012-05-27 19:37:05 +00003776 return true;
3777 return false;
3778 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003779
Chris Lattner144b6192012-05-27 19:37:05 +00003780 case IITDescriptor::Argument:
Benjamin Kramerbde91762012-06-02 10:20:22 +00003781 // Two cases here - If this is the second occurrence of an argument, verify
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003782 // that the later instance matches the previous instance.
Chris Lattner144b6192012-05-27 19:37:05 +00003783 if (D.getArgumentNumber() < ArgTys.size())
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003784 return Ty != ArgTys[D.getArgumentNumber()];
3785
Chris Lattner144b6192012-05-27 19:37:05 +00003786 // Otherwise, if this is the first instance of an argument, record it and
3787 // verify the "Any" kind.
3788 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3789 ArgTys.push_back(Ty);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003790
Chris Lattner144b6192012-05-27 19:37:05 +00003791 switch (D.getArgumentKind()) {
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00003792 case IITDescriptor::AK_Any: return false; // Success
Chris Lattner144b6192012-05-27 19:37:05 +00003793 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3794 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3795 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3796 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3797 }
3798 llvm_unreachable("all argument kinds not covered");
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003799
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003800 case IITDescriptor::ExtendArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003801 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003802 if (D.getArgumentNumber() >= ArgTys.size())
3803 return true;
Chris Lattner144b6192012-05-27 19:37:05 +00003804
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003805 Type *NewTy = ArgTys[D.getArgumentNumber()];
3806 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3807 NewTy = VectorType::getExtendedElementVectorType(VTy);
3808 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3809 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3810 else
3811 return true;
3812
3813 return Ty != NewTy;
3814 }
3815 case IITDescriptor::TruncArgument: {
Chris Lattner144b6192012-05-27 19:37:05 +00003816 // This may only be used when referring to a previous vector argument.
Tim Northoveraa3cf1e2014-03-28 12:31:39 +00003817 if (D.getArgumentNumber() >= ArgTys.size())
3818 return true;
3819
3820 Type *NewTy = ArgTys[D.getArgumentNumber()];
3821 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3822 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3823 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3824 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3825 else
3826 return true;
3827
3828 return Ty != NewTy;
3829 }
Tim Northover4516de32014-03-29 07:04:54 +00003830 case IITDescriptor::HalfVecArgument:
3831 // This may only be used when referring to a previous vector argument.
3832 return D.getArgumentNumber() >= ArgTys.size() ||
3833 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3834 VectorType::getHalfElementsVectorType(
3835 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003836 case IITDescriptor::SameVecWidthArgument: {
3837 if (D.getArgumentNumber() >= ArgTys.size())
3838 return true;
3839 VectorType * ReferenceType =
3840 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3841 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3842 if (!ThisArgType || !ReferenceType ||
3843 (ReferenceType->getVectorNumElements() !=
3844 ThisArgType->getVectorNumElements()))
3845 return true;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003846 return verifyIntrinsicType(ThisArgType->getVectorElementType(),
Elena Demikhovskyf1de34b2014-12-04 09:40:44 +00003847 Infos, ArgTys);
3848 }
Elena Demikhovskyfb81b932014-12-25 07:49:20 +00003849 case IITDescriptor::PtrToArgument: {
3850 if (D.getArgumentNumber() >= ArgTys.size())
3851 return true;
3852 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3853 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3854 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3855 }
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003856 case IITDescriptor::VecOfPtrsToElt: {
3857 if (D.getArgumentNumber() >= ArgTys.size())
3858 return true;
3859 VectorType * ReferenceType =
3860 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3861 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3862 if (!ThisArgVecTy || !ReferenceType ||
3863 (ReferenceType->getVectorNumElements() !=
3864 ThisArgVecTy->getVectorNumElements()))
3865 return true;
3866 PointerType *ThisArgEltTy =
3867 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3868 if (!ThisArgEltTy)
3869 return true;
David Blaikie96b48192015-05-11 23:09:25 +00003870 return ThisArgEltTy->getElementType() !=
3871 ReferenceType->getVectorElementType();
Elena Demikhovsky23a485a2015-02-08 08:27:19 +00003872 }
Chris Lattner144b6192012-05-27 19:37:05 +00003873 }
3874 llvm_unreachable("unhandled");
3875}
Bob Wilsonf76486a2009-01-07 00:09:01 +00003876
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003877/// Verify if the intrinsic has variable arguments. This method is intended to
3878/// be called after all the fixed arguments have been verified first.
Andrew Tricka2efd992013-10-31 17:18:11 +00003879///
3880/// This method returns true on error and does not print an error message.
3881bool
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003882Verifier::verifyIntrinsicIsVarArg(bool isVarArg,
Andrew Tricka2efd992013-10-31 17:18:11 +00003883 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3884 using namespace Intrinsic;
3885
3886 // If there are no descriptors left, then it can't be a vararg.
3887 if (Infos.empty())
David Blaikiedc3f01e2015-03-09 01:57:13 +00003888 return isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003889
3890 // There should be only one descriptor remaining at this point.
3891 if (Infos.size() != 1)
3892 return true;
3893
3894 // Check and verify the descriptor.
3895 IITDescriptor D = Infos.front();
3896 Infos = Infos.slice(1);
3897 if (D.Kind == IITDescriptor::VarArg)
David Blaikiedc3f01e2015-03-09 01:57:13 +00003898 return !isVarArg;
Andrew Tricka2efd992013-10-31 17:18:11 +00003899
3900 return true;
3901}
3902
Philip Reames007561a2015-06-26 22:21:52 +00003903/// Allow intrinsics to be verified in different ways.
3904void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003905 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003906 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3907 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003908
Chris Lattner144b6192012-05-27 19:37:05 +00003909 // Verify that the intrinsic prototype lines up with what the .td files
3910 // describe.
3911 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003912 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003913
Chris Lattner144b6192012-05-27 19:37:05 +00003914 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3915 getIntrinsicInfoTableEntries(ID, Table);
3916 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003917
Chris Lattner144b6192012-05-27 19:37:05 +00003918 SmallVector<Type *, 4> ArgTys;
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003919 Assert(!verifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003920 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003921 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003922 Assert(!verifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003923 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003924
3925 // Verify if the intrinsic call matches the vararg property.
3926 if (IsVarArg)
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003927 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003928 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003929 else
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00003930 Assert(!verifyIntrinsicIsVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003931 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003932
3933 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003934 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003935
3936 // Now that we have the intrinsic ID and the actual argument types (and we
3937 // know they are legal for the intrinsic!) get the intrinsic name through the
3938 // usual means. This allows us to verify the mangling of argument types into
3939 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003940 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003941 Assert(ExpectedName == IF->getName(),
3942 "Intrinsic name not mangled correctly for type arguments! "
3943 "Should be: " +
3944 ExpectedName,
3945 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003946
Chris Lattner588096e2009-12-28 09:07:21 +00003947 // If the intrinsic takes MDNode arguments, verify that they are either global
3948 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003949 for (Value *V : CS.args())
3950 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3951 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003952
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003953 switch (ID) {
3954 default:
3955 break;
Chandler Carruth026cc372011-12-12 04:36:02 +00003956 case Intrinsic::ctlz: // llvm.ctlz
3957 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003958 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003959 "is_zero_undef argument of bit counting intrinsics must be a "
3960 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003961 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003962 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003963 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003964 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3965 "invalid llvm.dbg.declare intrinsic call 1", CS);
3966 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003967 break;
3968 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003969 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003970 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003971 case Intrinsic::memcpy:
3972 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003973 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003974 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003975 Assert(AlignCI,
3976 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003977 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003978 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003979 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003980 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003981 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003982 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003983 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003984 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003985 }
Bill Wendling05604e02008-08-23 09:46:46 +00003986 case Intrinsic::gcroot:
3987 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003988 case Intrinsic::gcread:
3989 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003990 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003991 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3992 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3993 Assert(isa<Constant>(CS.getArgOperand(1)),
3994 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003995 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003996 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003997 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3998 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003999 CS);
Talin2e59f142010-09-30 20:23:47 +00004000 }
Chris Lattner25852062008-08-24 20:46:13 +00004001 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00004002
Philip Reames9818dd72015-06-26 22:04:34 +00004003 Assert(CS.getParent()->getParent()->hasGC(),
4004 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00004005 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00004006 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00004007 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004008 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00004009 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004010 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004011 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004012 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4013 isa<ConstantInt>(CS.getArgOperand(2)) &&
4014 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4015 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4016 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004017 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004018 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004019 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4020 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004021 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004022 case Intrinsic::lifetime_start:
4023 case Intrinsic::lifetime_end:
4024 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004025 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004026 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004027 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004028 break;
4029 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004030 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4031 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004032 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004033
Reid Kleckner60381792015-07-07 22:25:32 +00004034 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004035 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004036 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004037 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004038 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004039 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004040 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004041 if (isa<ConstantPointerNull>(Arg))
4042 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004043 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004044 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004045 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004046 }
Philip Reames9818dd72015-06-26 22:04:34 +00004047 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004048 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004049 break;
4050 }
Reid Kleckner60381792015-07-07 22:25:32 +00004051 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004052 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004053 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004054 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004055 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004056 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004057 CS);
4058 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004059 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004060 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004061 auto &Entry = FrameEscapeInfo[Fn];
4062 Entry.second = unsigned(
4063 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004064 break;
4065 }
4066
Philip Reames1ffa9372015-01-30 23:28:05 +00004067 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004068 Assert(!CS.isInlineAsm(),
4069 "gc.statepoint support for inline assembly unimplemented", CS);
4070 Assert(CS.getParent()->getParent()->hasGC(),
4071 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004072
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004073 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004074 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004075 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004076 Assert(CS.getParent()->getParent()->hasGC(),
4077 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004078 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004079 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004080 const Function *StatepointFn =
4081 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004082 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4083 StatepointFn->getIntrinsicID() ==
4084 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004085 "gc.result operand #1 must be from a statepoint", CS,
4086 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004087
Philip Reamesb23713a2014-12-03 22:23:24 +00004088 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004089 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004090 auto *PT = cast<PointerType>(Target->getType());
4091 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004092 Assert(CS.getType() == TargetFuncType->getReturnType(),
4093 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004094 break;
4095 }
4096 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004097 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004098
Philip Reames3e2cf532016-01-07 03:32:11 +00004099 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4100 "gc.relocate must return a pointer or a vector of pointers", CS);
4101
Igor Laevsky9570ff92015-02-19 11:28:47 +00004102 // Check that this relocate is correctly tied to the statepoint
4103
4104 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004105 if (LandingPadInst *LandingPad =
4106 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004107
Sanjoy Das5665c992015-05-11 23:47:27 +00004108 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004109 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004110
4111 // Landingpad relocates should have only one predecessor with invoke
4112 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004113 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004114 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004115 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4116 InvokeBB);
4117 Assert(isStatepoint(InvokeBB->getTerminator()),
4118 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004119 }
4120 else {
4121 // In all other cases relocate should be tied to the statepoint directly.
4122 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004123 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004124 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004125 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004126 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004127 }
4128
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004129 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004130
Manuel Jacob83eefa62016-01-05 04:03:00 +00004131 ImmutableCallSite StatepointCS(
4132 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004133
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004134 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004135 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004136 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004137 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004138
Philip Reames9818dd72015-06-26 22:04:34 +00004139 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004140 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004141 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004142
4143 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4144 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4145 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004146 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004147 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004148 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004149 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004150
4151 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004152 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004153 Assert(StatepointCS.arg_size() > 0,
4154 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004155 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004156 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004157 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004158 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4159 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004160 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004161 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004162 "gc.statepoint: number of transition arguments must be "
4163 "a constant integer");
4164 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004165 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4166 ->getZExtValue();
4167 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004168 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004169 "gc.statepoint: number of deoptimization arguments must be "
4170 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004171 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004172 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4173 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004174 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004175 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004176 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4177 "gc.relocate: statepoint base index doesn't fall within the "
4178 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004179 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004180 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4181 "gc.relocate: statepoint derived index doesn't fall within the "
4182 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004183 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004184
Philip Reames3e2cf532016-01-07 03:32:11 +00004185 // Relocated value must be either a pointer type or vector-of-pointer type,
4186 // but gc_relocate does not need to return the same pointer type as the
4187 // relocated pointer. It can be casted to the correct type later if it's
4188 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004189 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004190 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004191 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004192
Philip Reames3e2cf532016-01-07 03:32:11 +00004193 auto ResultType = CS.getType();
4194 auto DerivedType = Relocate.getDerivedPtr()->getType();
4195 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004196 "gc.relocate: vector relocates to vector and pointer to pointer",
4197 CS);
4198 Assert(
4199 ResultType->getPointerAddressSpace() ==
4200 DerivedType->getPointerAddressSpace(),
4201 "gc.relocate: relocating a pointer shouldn't change its address space",
4202 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004203 break;
4204 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004205 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004206 case Intrinsic::eh_exceptionpointer: {
4207 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4208 "eh.exceptionpointer argument must be a catchpad", CS);
4209 break;
4210 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004211 case Intrinsic::masked_load: {
4212 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4213
4214 Value *Ptr = CS.getArgOperand(0);
4215 //Value *Alignment = CS.getArgOperand(1);
4216 Value *Mask = CS.getArgOperand(2);
4217 Value *PassThru = CS.getArgOperand(3);
4218 Assert(Mask->getType()->isVectorTy(),
4219 "masked_load: mask must be vector", CS);
4220
4221 // DataTy is the overloaded type
4222 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4223 Assert(DataTy == CS.getType(),
4224 "masked_load: return must match pointer type", CS);
4225 Assert(PassThru->getType() == DataTy,
4226 "masked_load: pass through and data type must match", CS);
4227 Assert(Mask->getType()->getVectorNumElements() ==
4228 DataTy->getVectorNumElements(),
4229 "masked_load: vector mask must be same length as data", CS);
4230 break;
4231 }
4232 case Intrinsic::masked_store: {
4233 Value *Val = CS.getArgOperand(0);
4234 Value *Ptr = CS.getArgOperand(1);
4235 //Value *Alignment = CS.getArgOperand(2);
4236 Value *Mask = CS.getArgOperand(3);
4237 Assert(Mask->getType()->isVectorTy(),
4238 "masked_store: mask must be vector", CS);
4239
4240 // DataTy is the overloaded type
4241 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4242 Assert(DataTy == Val->getType(),
4243 "masked_store: storee must match pointer type", CS);
4244 Assert(Mask->getType()->getVectorNumElements() ==
4245 DataTy->getVectorNumElements(),
4246 "masked_store: vector mask must be same length as data", CS);
4247 break;
4248 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004249
Sanjoy Das021de052016-03-31 00:18:46 +00004250 case Intrinsic::experimental_guard: {
4251 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4252 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4253 "experimental_guard must have exactly one "
4254 "\"deopt\" operand bundle");
4255 break;
4256 }
4257
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004258 case Intrinsic::experimental_deoptimize: {
4259 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4260 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4261 "experimental_deoptimize must have exactly one "
4262 "\"deopt\" operand bundle");
4263 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4264 "experimental_deoptimize return type must match caller return type");
4265
4266 if (CS.isCall()) {
4267 auto *DeoptCI = CS.getInstruction();
4268 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4269 Assert(RI,
4270 "calls to experimental_deoptimize must be followed by a return");
4271
4272 if (!CS.getType()->isVoidTy() && RI)
4273 Assert(RI->getReturnValue() == DeoptCI,
4274 "calls to experimental_deoptimize must be followed by a return "
4275 "of the value computed by experimental_deoptimize");
4276 }
4277
4278 break;
4279 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004280 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004281}
4282
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004283/// \brief Carefully grab the subprogram from a local scope.
4284///
4285/// This carefully grabs the subprogram from a local scope, avoiding the
4286/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004287static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004288 if (!LocalScope)
4289 return nullptr;
4290
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004291 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004292 return SP;
4293
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004294 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004295 return getSubprogram(LB->getRawScope());
4296
4297 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004298 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004299 return nullptr;
4300}
4301
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004302template <class DbgIntrinsicTy>
4303void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4304 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004305 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004306 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4307 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004308 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004309 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4310 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004311 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004312 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4313 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004314
4315 // Ignore broken !dbg attachments; they're checked elsewhere.
4316 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004317 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004318 return;
4319
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004320 BasicBlock *BB = DII.getParent();
4321 Function *F = BB ? BB->getParent() : nullptr;
4322
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004323 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004324 DILocalVariable *Var = DII.getVariable();
4325 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004326 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4327 &DII, BB, F);
4328
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004329 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4330 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004331 if (!VarSP || !LocSP)
4332 return; // Broken scope chains are checked elsewhere.
4333
4334 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4335 " variable and !dbg attachment",
4336 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4337 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004338}
4339
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004340static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004341 // Be careful of broken types (checked elsewhere).
4342 const Metadata *RawType = V.getRawType();
4343 while (RawType) {
4344 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004345 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004346 if (uint64_t Size = T->getSizeInBits())
4347 return Size;
4348
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004349 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004350 // Look at the base type.
4351 RawType = DT->getRawBaseType();
4352 continue;
4353 }
4354
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004355 // Missing type or size.
4356 break;
4357 }
4358
4359 // Fail gracefully.
4360 return 0;
4361}
4362
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004363void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004364 DILocalVariable *V;
4365 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004366 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004367 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4368 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004369 } else {
4370 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004371 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4372 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004373 }
4374
4375 // We don't know whether this intrinsic verified correctly.
4376 if (!V || !E || !E->isValid())
4377 return;
4378
Keno Fischer253a7bd2016-01-15 02:12:38 +00004379 // Nothing to do if this isn't a bit piece expression.
4380 if (!E->isBitPiece())
4381 return;
4382
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004383 // The frontend helps out GDB by emitting the members of local anonymous
4384 // unions as artificial local variables with shared storage. When SROA splits
4385 // the storage for artificial local variables that are smaller than the entire
4386 // union, the overhang piece will be outside of the allotted space for the
4387 // variable and this check fails.
4388 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4389 if (V->isArtificial())
4390 return;
4391
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004392 // If there's no size, the type is broken, but that should be checked
4393 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004394 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004395 if (!VarSize)
4396 return;
4397
Keno Fischer253a7bd2016-01-15 02:12:38 +00004398 unsigned PieceSize = E->getBitPieceSize();
4399 unsigned PieceOffset = E->getBitPieceOffset();
4400 Assert(PieceSize + PieceOffset <= VarSize,
4401 "piece is larger than or outside of variable", &I, V, E);
4402 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004403}
4404
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004405void Verifier::verifyCompileUnits() {
4406 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
4407 SmallPtrSet<const Metadata *, 2> Listed;
4408 if (CUs)
4409 Listed.insert(CUs->op_begin(), CUs->op_end());
4410 Assert(
4411 std::all_of(CUVisited.begin(), CUVisited.end(),
4412 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
4413 "All DICompileUnits must be listed in llvm.dbg.cu");
4414 CUVisited.clear();
4415}
4416
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004417void Verifier::verifyDeoptimizeCallingConvs() {
4418 if (DeoptimizeDeclarations.empty())
4419 return;
4420
4421 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004422 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004423 Assert(First->getCallingConv() == F->getCallingConv(),
4424 "All llvm.experimental.deoptimize declarations must have the same "
4425 "calling convention",
4426 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004427 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004428}
4429
Chris Lattner0e851da2002-04-18 20:37:37 +00004430//===----------------------------------------------------------------------===//
4431// Implement the public interfaces to this file...
4432//===----------------------------------------------------------------------===//
4433
Chandler Carruth043949d2014-01-19 02:22:18 +00004434bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004435 Function &F = const_cast<Function &>(f);
Reid Spencer5301e7c2007-01-30 20:08:39 +00004436 assert(!F.isDeclaration() && "Cannot verify external functions");
Misha Brukmanb1c93172005-04-21 23:48:37 +00004437
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004438 // Don't use a raw_null_ostream. Printing IR is expensive.
Adrian Prantl541a9c52016-05-06 19:26:47 +00004439 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true);
Chandler Carruth043949d2014-01-19 02:22:18 +00004440
4441 // Note that this function's return value is inverted from what you would
4442 // expect of a function called "verify".
4443 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004444}
4445
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004446bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4447 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004448 // Don't use a raw_null_ostream. Printing IR is expensive.
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004449 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004450
Chandler Carruth043949d2014-01-19 02:22:18 +00004451 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004452 for (const Function &F : M)
4453 if (!F.isDeclaration() && !F.isMaterializable())
4454 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004455
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004456 Broken |= !V.verify(M);
4457 if (BrokenDebugInfo)
4458 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004459 // Note that this function's return value is inverted from what you would
4460 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004461 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004462}
Chandler Carruth043949d2014-01-19 02:22:18 +00004463
4464namespace {
Chandler Carruth4d356312014-01-20 11:34:08 +00004465struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004466 static char ID;
4467
4468 Verifier V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004469 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004470
Adrian Prantl541a9c52016-05-06 19:26:47 +00004471 VerifierLegacyPass()
4472 : FunctionPass(ID),
Adrian Prantl94a903e2016-05-25 21:33:20 +00004473 V(&dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004474 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004475 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004476 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004477 : FunctionPass(ID),
Adrian Prantl94a903e2016-05-25 21:33:20 +00004478 V(&dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004479 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004480 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004481 }
4482
Craig Topperf398d7c2014-03-05 06:35:38 +00004483 bool runOnFunction(Function &F) override {
Chandler Carruth043949d2014-01-19 02:22:18 +00004484 if (!V.verify(F) && FatalErrors)
4485 report_fatal_error("Broken function found, compilation aborted!");
4486
4487 return false;
4488 }
4489
Craig Topperf398d7c2014-03-05 06:35:38 +00004490 bool doFinalization(Module &M) override {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004491 bool HasErrors = !V.verify(M);
4492 if (FatalErrors) {
4493 if (HasErrors)
4494 report_fatal_error("Broken module found, compilation aborted!");
4495 assert(!V.hasBrokenDebugInfo() && "Module contains invalid debug info");
4496 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004497
Adrian Prantl94a903e2016-05-25 21:33:20 +00004498 // Strip broken debug info.
4499 if (V.hasBrokenDebugInfo()) {
4500 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4501 M.getContext().diagnose(DiagInvalid);
4502 if (!StripDebugInfo(M))
4503 report_fatal_error("Failed to strip malformed debug info");
4504 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004505 return false;
4506 }
4507
4508 void getAnalysisUsage(AnalysisUsage &AU) const override {
4509 AU.setPreservesAll();
4510 }
4511};
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004512}
Chandler Carruth043949d2014-01-19 02:22:18 +00004513
Chandler Carruth4d356312014-01-20 11:34:08 +00004514char VerifierLegacyPass::ID = 0;
4515INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004516
4517FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004518 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004519}
4520
Adrian Prantle3656182016-05-09 19:57:29 +00004521char VerifierAnalysis::PassID;
4522VerifierAnalysis::Result VerifierAnalysis::run(Module &M) {
4523 Result Res;
4524 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4525 return Res;
4526}
Chandler Carruth4d356312014-01-20 11:34:08 +00004527
Adrian Prantle3656182016-05-09 19:57:29 +00004528VerifierAnalysis::Result VerifierAnalysis::run(Function &F) {
4529 return { llvm::verifyFunction(F, &dbgs()), false };
4530}
4531
4532PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4533 auto Res = AM.getResult<VerifierAnalysis>(M);
4534 if (FatalErrors) {
4535 if (Res.IRBroken)
4536 report_fatal_error("Broken module found, compilation aborted!");
4537 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4538 }
4539
4540 // Strip broken debug info.
4541 if (Res.DebugInfoBroken) {
4542 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4543 M.getContext().diagnose(DiagInvalid);
4544 if (!StripDebugInfo(M))
4545 report_fatal_error("Failed to strip malformed debug info");
4546 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004547 return PreservedAnalyses::all();
4548}
4549
Adrian Prantle3656182016-05-09 19:57:29 +00004550PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4551 auto res = AM.getResult<VerifierAnalysis>(F);
4552 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004553 report_fatal_error("Broken function found, compilation aborted!");
4554
4555 return PreservedAnalyses::all();
4556}