blob: 57beb42a4a98b0f62b9012cc399c08a340c4dbe3 [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"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000048#include "llvm/ADT/APFloat.h"
49#include "llvm/ADT/APInt.h"
50#include "llvm/ADT/ArrayRef.h"
51#include "llvm/ADT/DenseMap.h"
52#include "llvm/ADT/ilist.h"
Joseph Tremoulet8ea80862016-01-10 04:31:05 +000053#include "llvm/ADT/MapVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000054#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000055#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000056#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000057#include "llvm/ADT/SmallSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000058#include "llvm/ADT/SmallVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000059#include "llvm/ADT/StringMap.h"
60#include "llvm/ADT/StringRef.h"
61#include "llvm/ADT/Twine.h"
62#include "llvm/IR/Argument.h"
63#include "llvm/IR/Attributes.h"
64#include "llvm/IR/BasicBlock.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000065#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000066#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000067#include "llvm/IR/CallingConv.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000068#include "llvm/IR/Comdat.h"
69#include "llvm/IR/Constant.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000070#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000071#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000072#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000073#include "llvm/IR/DebugInfo.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000074#include "llvm/IR/DebugInfoMetadata.h"
75#include "llvm/IR/DebugLoc.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000076#include "llvm/IR/DerivedTypes.h"
Adrian Prantle3656182016-05-09 19:57:29 +000077#include "llvm/IR/DiagnosticInfo.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000078#include "llvm/IR/Dominators.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000079#include "llvm/IR/Function.h"
80#include "llvm/IR/GlobalAlias.h"
81#include "llvm/IR/GlobalValue.h"
82#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000083#include "llvm/IR/InlineAsm.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000084#include "llvm/IR/InstrTypes.h"
85#include "llvm/IR/Instruction.h"
86#include "llvm/IR/Instructions.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000087#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000088#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000089#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000090#include "llvm/IR/LLVMContext.h"
91#include "llvm/IR/Metadata.h"
92#include "llvm/IR/Module.h"
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +000093#include "llvm/IR/ModuleSlotTracker.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000094#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000095#include "llvm/IR/Statepoint.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000096#include "llvm/IR/Type.h"
97#include "llvm/IR/Use.h"
98#include "llvm/IR/User.h"
99#include "llvm/IR/Value.h"
Chris Lattner8a923e72008-03-12 17:45:29 +0000100#include "llvm/Pass.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000101#include "llvm/Support/AtomicOrdering.h"
102#include "llvm/Support/Casting.h"
Manman Ren74c61b92013-07-19 00:31:03 +0000103#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +0000104#include "llvm/Support/Debug.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000105#include "llvm/Support/Dwarf.h"
Torok Edwin6dd27302009-07-08 18:01:40 +0000106#include "llvm/Support/ErrorHandling.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000107#include "llvm/Support/MathExtras.h"
Chris Lattner24025262009-02-28 21:05:51 +0000108#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000109#include <algorithm>
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000110#include <cassert>
111#include <cstdint>
112#include <memory>
113#include <string>
114#include <utility>
115
Chris Lattner189d19f2003-11-21 20:23:48 +0000116using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +0000117
Duncan P. N. Exon Smith0633fd72015-03-17 17:28:41 +0000118static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
Manman Ren74c61b92013-07-19 00:31:03 +0000119
Daniel Jaspera44fd302016-12-16 13:53:46 +0000120namespace llvm {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000121
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000122struct VerifierSupport {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000123 raw_ostream *OS;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000124 const Module &M;
125 ModuleSlotTracker MST;
126 const DataLayout &DL;
127 LLVMContext &Context;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000128
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +0000129 /// Track the brokenness of the module while recursively visiting.
130 bool Broken = false;
Adrian Prantl541a9c52016-05-06 19:26:47 +0000131 /// Broken debug info can be "recovered" from by stripping the debug info.
132 bool BrokenDebugInfo = false;
133 /// Whether to treat broken debug info as an error.
134 bool TreatBrokenDebugInfoAsError = true;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000135
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000136 explicit VerifierSupport(raw_ostream *OS, const Module &M)
137 : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000138
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000139private:
Keno Fischera6c4ce42015-12-01 19:06:36 +0000140 void Write(const Module *M) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000141 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
Keno Fischera6c4ce42015-12-01 19:06:36 +0000142 }
143
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000144 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000145 if (!V)
146 return;
147 if (isa<Instruction>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000148 V->print(*OS, MST);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000149 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000150 } else {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000151 V->printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000152 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000153 }
154 }
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000155
Philip Reames9818dd72015-06-26 22:04:34 +0000156 void Write(ImmutableCallSite CS) {
157 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000158 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000159
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000160 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000161 if (!MD)
162 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000163 MD->print(*OS, MST, &M);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000164 *OS << '\n';
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000165 }
166
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000167 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
168 Write(MD.get());
169 }
170
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000171 void Write(const NamedMDNode *NMD) {
172 if (!NMD)
173 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000174 NMD->print(*OS, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000175 *OS << '\n';
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000176 }
177
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000178 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000179 if (!T)
180 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000181 *OS << ' ' << *T;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000182 }
183
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000184 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000185 if (!C)
186 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000187 *OS << *C;
David Majnemerdad0a642014-06-27 18:19:56 +0000188 }
189
Sanjoy Das3336f682016-12-11 20:07:15 +0000190 void Write(const APInt *AI) {
191 if (!AI)
192 return;
193 *OS << *AI << '\n';
194 }
195
196 void Write(const unsigned i) { *OS << i << '\n'; }
197
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000198 template <typename T> void Write(ArrayRef<T> Vs) {
199 for (const T &V : Vs)
200 Write(V);
201 }
202
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000203 template <typename T1, typename... Ts>
204 void WriteTs(const T1 &V1, const Ts &... Vs) {
205 Write(V1);
206 WriteTs(Vs...);
207 }
208
209 template <typename... Ts> void WriteTs() {}
210
211public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000212 /// \brief A check failed, so printout out the condition and the message.
213 ///
214 /// This provides a nice place to put a breakpoint if you want to see why
215 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000216 void CheckFailed(const Twine &Message) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000217 if (OS)
218 *OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000219 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000220 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000221
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000222 /// \brief A check failed (with values to print).
223 ///
224 /// This calls the Message-only version so that the above is easier to set a
225 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000226 template <typename T1, typename... Ts>
227 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
228 CheckFailed(Message);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000229 if (OS)
230 WriteTs(V1, Vs...);
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000231 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000232
233 /// A debug info check failed.
234 void DebugInfoCheckFailed(const Twine &Message) {
235 if (OS)
236 *OS << Message << '\n';
237 Broken |= TreatBrokenDebugInfoAsError;
238 BrokenDebugInfo = true;
239 }
240
241 /// A debug info check failed (with values to print).
242 template <typename T1, typename... Ts>
243 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
244 const Ts &... Vs) {
245 DebugInfoCheckFailed(Message);
246 if (OS)
247 WriteTs(V1, Vs...);
248 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000249};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000250
Daniel Jaspera44fd302016-12-16 13:53:46 +0000251} // namespace llvm
252
253namespace {
254
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000255class Verifier : public InstVisitor<Verifier>, VerifierSupport {
256 friend class InstVisitor<Verifier>;
257
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000258 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000259
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000260 /// \brief When verifying a basic block, keep track of all of the
261 /// instructions we have seen so far.
262 ///
263 /// This allows us to do efficient dominance checks for the case when an
264 /// instruction has an operand that is an instruction in the same block.
265 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000266
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000267 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000268 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000269
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000270 /// Track all DICompileUnits visited.
271 SmallPtrSet<const Metadata *, 2> CUVisited;
272
David Majnemer654e1302015-07-31 17:58:14 +0000273 /// \brief The result type for a landingpad.
274 Type *LandingPadResultTy;
275
Reid Kleckner60381792015-07-07 22:25:32 +0000276 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000277 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000278 bool SawFrameEscape;
279
Reid Kleckner60381792015-07-07 22:25:32 +0000280 /// Stores the count of how many objects were passed to llvm.localescape for a
281 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000282 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000283
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000284 // Maps catchswitches and cleanuppads that unwind to siblings to the
285 // terminators that indicate the unwind, used to detect cycles therein.
286 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
287
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000288 /// Cache of constants visited in search of ConstantExprs.
289 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
290
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000291 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
292 SmallVector<const Function *, 4> DeoptimizeDeclarations;
293
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000294 // Verify that this GlobalValue is only used in this module.
295 // This map is used to avoid visiting uses twice. We can arrive at a user
296 // twice, if they have multiple operands. In particular for very large
297 // constant expressions, we can arrive at a particular user many times.
298 SmallPtrSet<const Value *, 32> GlobalValueVisited;
299
Mehdi Aminia84a8402016-12-16 06:29:14 +0000300 TBAAVerifier TBAAVerifyHelper;
Sanjoy Das3336f682016-12-11 20:07:15 +0000301
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000302 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000303
Chandler Carruth043949d2014-01-19 02:22:18 +0000304public:
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000305 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
306 const Module &M)
307 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
Mehdi Aminia84a8402016-12-16 06:29:14 +0000308 SawFrameEscape(false), TBAAVerifyHelper(this) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000309 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
310 }
311
312 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
Chris Lattner0e851da2002-04-18 20:37:37 +0000313
Chandler Carruth043949d2014-01-19 02:22:18 +0000314 bool verify(const Function &F) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000315 assert(F.getParent() == &M &&
316 "An instance of this class only works with a specific module!");
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000317
318 // First ensure the function is well-enough formed to compute dominance
Peter Collingbourne71bb7942016-06-06 22:32:52 +0000319 // information, and directly compute a dominance tree. We don't rely on the
320 // pass manager to provide this as it isolates us from a potentially
321 // out-of-date dominator tree and makes it significantly more complex to run
322 // this code outside of a pass manager.
323 // FIXME: It's really gross that we have to cast away constness here.
324 if (!F.empty())
325 DT.recalculate(const_cast<Function &>(F));
326
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000327 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000328 if (!BB.empty() && BB.back().isTerminator())
329 continue;
330
331 if (OS) {
332 *OS << "Basic Block in function '" << F.getName()
333 << "' does not have terminator!\n";
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000334 BB.printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000335 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000336 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000337 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000338 }
Chandler Carruth76777602014-01-17 10:56:02 +0000339
Chandler Carruth043949d2014-01-19 02:22:18 +0000340 Broken = false;
341 // FIXME: We strip const here because the inst visitor strips const.
342 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000343 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000344 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000345 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000346 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000347 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000348
Chandler Carruth043949d2014-01-19 02:22:18 +0000349 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000350 }
351
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000352 /// Verify the module that this instance of \c Verifier was initialized with.
353 bool verify() {
Chandler Carruth043949d2014-01-19 02:22:18 +0000354 Broken = false;
355
Peter Collingbournebb738172016-06-06 23:21:27 +0000356 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
357 for (const Function &F : M)
358 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
359 DeoptimizeDeclarations.push_back(&F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000360
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000361 // Now that we've visited every function, verify that we never asked to
362 // recover a frame index that wasn't escaped.
363 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000364 for (const GlobalVariable &GV : M.globals())
365 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000366
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000367 for (const GlobalAlias &GA : M.aliases())
368 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000369
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000370 for (const NamedMDNode &NMD : M.named_metadata())
371 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000372
David Majnemerdad0a642014-06-27 18:19:56 +0000373 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
374 visitComdat(SMEC.getValue());
375
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000376 visitModuleFlags(M);
377 visitModuleIdents(M);
378
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000379 verifyCompileUnits();
380
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000381 verifyDeoptimizeCallingConvs();
382
Chandler Carruth043949d2014-01-19 02:22:18 +0000383 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000384 }
Chris Lattner9713b842002-04-28 16:04:26 +0000385
Chandler Carruth043949d2014-01-19 02:22:18 +0000386private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000387 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000388 void visitGlobalValue(const GlobalValue &GV);
389 void visitGlobalVariable(const GlobalVariable &GV);
390 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000391 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000392 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000393 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000394 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000395 void visitMDNode(const MDNode &MD);
396 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
397 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000398 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000399 void visitModuleIdents(const Module &M);
400 void visitModuleFlags(const Module &M);
401 void visitModuleFlag(const MDNode *Op,
402 DenseMap<const MDString *, const MDNode *> &SeenIDs,
403 SmallVectorImpl<const MDNode *> &Requirements);
404 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000405 void visitBasicBlock(BasicBlock &BB);
Sanjoy Das26f28a22016-11-09 19:36:39 +0000406 void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty);
407 void visitDereferenceableMetadata(Instruction &I, MDNode *MD);
Sanjoy Das3336f682016-12-11 20:07:15 +0000408
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000409 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000410#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
411#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000412 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000413 void visitDIVariable(const DIVariable &N);
414 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
415 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000416
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000417 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
418
Chandler Carruth043949d2014-01-19 02:22:18 +0000419 // InstVisitor overrides...
420 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000421 void visit(Instruction &I);
422
423 void visitTruncInst(TruncInst &I);
424 void visitZExtInst(ZExtInst &I);
425 void visitSExtInst(SExtInst &I);
426 void visitFPTruncInst(FPTruncInst &I);
427 void visitFPExtInst(FPExtInst &I);
428 void visitFPToUIInst(FPToUIInst &I);
429 void visitFPToSIInst(FPToSIInst &I);
430 void visitUIToFPInst(UIToFPInst &I);
431 void visitSIToFPInst(SIToFPInst &I);
432 void visitIntToPtrInst(IntToPtrInst &I);
433 void visitPtrToIntInst(PtrToIntInst &I);
434 void visitBitCastInst(BitCastInst &I);
435 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
436 void visitPHINode(PHINode &PN);
437 void visitBinaryOperator(BinaryOperator &B);
438 void visitICmpInst(ICmpInst &IC);
439 void visitFCmpInst(FCmpInst &FC);
440 void visitExtractElementInst(ExtractElementInst &EI);
441 void visitInsertElementInst(InsertElementInst &EI);
442 void visitShuffleVectorInst(ShuffleVectorInst &EI);
443 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
444 void visitCallInst(CallInst &CI);
445 void visitInvokeInst(InvokeInst &II);
446 void visitGetElementPtrInst(GetElementPtrInst &GEP);
447 void visitLoadInst(LoadInst &LI);
448 void visitStoreInst(StoreInst &SI);
449 void verifyDominatesUse(Instruction &I, unsigned i);
450 void visitInstruction(Instruction &I);
451 void visitTerminatorInst(TerminatorInst &I);
452 void visitBranchInst(BranchInst &BI);
453 void visitReturnInst(ReturnInst &RI);
454 void visitSwitchInst(SwitchInst &SI);
455 void visitIndirectBrInst(IndirectBrInst &BI);
456 void visitSelectInst(SelectInst &SI);
457 void visitUserOp1(Instruction &I);
458 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000459 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000460 template <class DbgIntrinsicTy>
461 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000462 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
463 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
464 void visitFenceInst(FenceInst &FI);
465 void visitAllocaInst(AllocaInst &AI);
466 void visitExtractValueInst(ExtractValueInst &EVI);
467 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000468 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000469 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000470 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000471 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000472 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000473 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000474 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000475 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000476 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000477
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000478 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000479 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
480 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000481 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000482 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000483 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000484 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
485 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000486 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000487 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000488 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000489 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000490 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000491 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000492
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000493 void visitConstantExprsRecursively(const Constant *EntryC);
494 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000495 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000496 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000497 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000498
Adrian Prantl941fa752016-12-05 18:04:47 +0000499 void verifyFragmentExpression(const DbgInfoIntrinsic &I);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000500
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000501 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000502 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000503
504 /// Module-level verification that all @llvm.experimental.deoptimize
505 /// declarations share the same calling convention.
506 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000507};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000508
509} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000510
Adrian Prantl541a9c52016-05-06 19:26:47 +0000511/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000512#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000513 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000514
Adrian Prantl541a9c52016-05-06 19:26:47 +0000515/// We know that a debug info condition should be true, if not print
516/// an error message.
517#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000518 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000519
Chris Lattnere5a22c02008-08-28 04:02:44 +0000520void Verifier::visit(Instruction &I) {
521 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000522 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000523 InstVisitor<Verifier>::visit(I);
524}
525
Keno Fischer60f82a22016-01-14 22:20:56 +0000526// Helper to recursively iterate over indirect users. By
527// returning false, the callback can ask to stop recursing
528// further.
529static void forEachUser(const Value *User,
530 SmallPtrSet<const Value *, 32> &Visited,
531 llvm::function_ref<bool(const Value *)> Callback) {
532 if (!Visited.insert(User).second)
533 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000534 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000535 if (Callback(TheNextUser))
536 forEachUser(TheNextUser, Visited, Callback);
537}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000538
Chandler Carruth043949d2014-01-19 02:22:18 +0000539void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000540 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000541 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000542
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000543 Assert(GV.getAlignment() <= Value::MaximumAlignment,
544 "huge alignment values are unsupported", &GV);
545 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
546 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000547
548 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000549 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000550 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000551 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000552 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000553
554 if (GV.isDeclarationForLinker())
555 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000556
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000557 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000558 if (const Instruction *I = dyn_cast<Instruction>(V)) {
559 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000560 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
561 I);
562 else if (I->getParent()->getParent()->getParent() != &M)
563 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
564 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000565 I->getParent()->getParent()->getParent());
566 return false;
567 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000568 if (F->getParent() != &M)
569 CheckFailed("Global is used by function in a different module", &GV, &M,
570 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000571 return false;
572 }
573 return true;
574 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000575}
576
Chandler Carruth043949d2014-01-19 02:22:18 +0000577void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000578 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000579 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000580 "Global variable initializer type does not match global "
581 "variable type!",
582 &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000583 // If the global has common linkage, it must have a zero initializer and
584 // cannot be constant.
585 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000586 Assert(GV.getInitializer()->isNullValue(),
587 "'common' global must have a zero initializer!", &GV);
588 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
589 &GV);
590 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000591 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000592 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000593
Nick Lewycky466d0c12011-04-08 07:30:21 +0000594 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
595 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000596 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
597 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000598 // Don't worry about emitting an error for it not being an array,
599 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000600 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000601 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
602 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000603 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000604 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000605 Assert(STy &&
606 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
607 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
608 STy->getTypeAtIndex(1) == FuncPtrTy,
609 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000610 if (STy->getNumElements() == 3) {
611 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000612 Assert(ETy->isPointerTy() &&
613 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
614 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000615 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000616 }
617 }
618
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000619 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000620 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000621 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
622 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000623 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000624 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
625 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000626 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000627 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000628 const Constant *Init = GV.getInitializer();
629 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000630 Assert(InitArray, "wrong initalizer for intrinsic global variable",
631 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000632 for (Value *Op : InitArray->operands()) {
633 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000634 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
635 isa<GlobalAlias>(V),
636 "invalid llvm.used member", V);
637 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000638 }
639 }
640 }
641 }
642
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000643 Assert(!GV.hasDLLImportStorageClass() ||
644 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
645 GV.hasAvailableExternallyLinkage(),
646 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000647
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000648 // Visit any debug info attachments.
649 SmallVector<MDNode *, 1> MDs;
650 GV.getMetadata(LLVMContext::MD_dbg, MDs);
Adrian Prantldc6e0162016-12-20 02:33:30 +0000651 for (auto *MD : MDs) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000652 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
653 visitDIGlobalVariableExpression(*GVE);
654 else
655 AssertDI(false, "!dbg attachment of global variable must be a DIGlobalVariableExpression");
Adrian Prantldc6e0162016-12-20 02:33:30 +0000656 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000657
Matt Arsenault24b49c42013-07-31 17:49:08 +0000658 if (!GV.hasInitializer()) {
659 visitGlobalValue(GV);
660 return;
661 }
662
663 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000664 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000665
Chris Lattnere3400652004-12-15 20:23:49 +0000666 visitGlobalValue(GV);
667}
668
Rafael Espindola64c1e182014-06-03 02:41:57 +0000669void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
670 SmallPtrSet<const GlobalAlias*, 4> Visited;
671 Visited.insert(&GA);
672 visitAliaseeSubExpr(Visited, GA, C);
673}
674
Craig Topper71b7b682014-08-21 05:55:13 +0000675void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000676 const GlobalAlias &GA, const Constant &C) {
677 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000678 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
679 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000680
681 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000682 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000683
Sanjoy Das5ce32722016-04-08 00:48:30 +0000684 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000685 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000686 } else {
687 // Only continue verifying subexpressions of GlobalAliases.
688 // Do not recurse into global initializers.
689 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000690 }
691 }
692
693 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000694 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000695
696 for (const Use &U : C.operands()) {
697 Value *V = &*U;
698 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
699 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
700 else if (const auto *C2 = dyn_cast<Constant>(V))
701 visitAliaseeSubExpr(Visited, GA, *C2);
702 }
703}
704
Chandler Carruth043949d2014-01-19 02:22:18 +0000705void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000706 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
707 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
708 "weak_odr, or external linkage!",
709 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000710 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000711 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
712 Assert(GA.getType() == Aliasee->getType(),
713 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000714
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000715 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
716 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000717
Rafael Espindola64c1e182014-06-03 02:41:57 +0000718 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000719
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000720 visitGlobalValue(GA);
721}
722
Chandler Carruth043949d2014-01-19 02:22:18 +0000723void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000724 // There used to be various other llvm.dbg.* nodes, but we don't support
725 // upgrading them and we want to reserve the namespace for future uses.
726 if (NMD.getName().startswith("llvm.dbg."))
727 AssertDI(NMD.getName() == "llvm.dbg.cu",
728 "unrecognized named metadata node in the llvm.dbg namespace",
729 &NMD);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000730 for (const MDNode *MD : NMD.operands()) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000731 if (NMD.getName() == "llvm.dbg.cu")
Adrian Prantl541a9c52016-05-06 19:26:47 +0000732 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000733
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000734 if (!MD)
735 continue;
736
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000737 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000738 }
739}
740
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000741void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000742 // Only visit each node once. Metadata can be mutually recursive, so this
743 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000744 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000745 return;
746
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000747 switch (MD.getMetadataID()) {
748 default:
749 llvm_unreachable("Invalid MDNode subclass");
750 case Metadata::MDTupleKind:
751 break;
752#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
753 case Metadata::CLASS##Kind: \
754 visit##CLASS(cast<CLASS>(MD)); \
755 break;
756#include "llvm/IR/Metadata.def"
757 }
758
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000759 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000760 if (!Op)
761 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000762 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
763 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000764 if (auto *N = dyn_cast<MDNode>(Op)) {
765 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000766 continue;
767 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000768 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
769 visitValueAsMetadata(*V, nullptr);
770 continue;
771 }
Duncan Sands76d62172010-04-29 16:10:30 +0000772 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000773
774 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000775 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
776 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000777}
778
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000779void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000780 Assert(MD.getValue(), "Expected valid value", &MD);
781 Assert(!MD.getValue()->getType()->isMetadataTy(),
782 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000783
784 auto *L = dyn_cast<LocalAsMetadata>(&MD);
785 if (!L)
786 return;
787
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000788 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000789
790 // If this was an instruction, bb, or argument, verify that it is in the
791 // function that we expect.
792 Function *ActualF = nullptr;
793 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000794 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000795 ActualF = I->getParent()->getParent();
796 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
797 ActualF = BB->getParent();
798 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
799 ActualF = A->getParent();
800 assert(ActualF && "Unimplemented function local metadata case!");
801
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000802 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000803}
804
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000805void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000806 Metadata *MD = MDV.getMetadata();
807 if (auto *N = dyn_cast<MDNode>(MD)) {
808 visitMDNode(*N);
809 return;
810 }
811
812 // Only visit each node once. Metadata can be mutually recursive, so this
813 // avoids infinite recursion here, as well as being an optimization.
814 if (!MDNodes.insert(MD).second)
815 return;
816
817 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
818 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000819}
820
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000821static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
822static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
823static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000824
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000825template <class Ty>
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000826static bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000827 for (Metadata *MD : N.operands()) {
828 if (MD) {
829 if (!isa<Ty>(MD))
830 return false;
831 } else {
832 if (!AllowNull)
833 return false;
834 }
835 }
836 return true;
837}
838
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000839template <class Ty> static bool isValidMetadataArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000840 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
841}
842
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000843template <class Ty> static bool isValidMetadataNullArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000844 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
845}
846
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000847void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000848 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
849 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000850 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000851 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000852}
853
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000854void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000855 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000856}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000857
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000858void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000859 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000860 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000861}
862
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000863void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000864 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
865 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000866}
867
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000868void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000869 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000870}
871
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000872void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000873 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
874 N.getTag() == dwarf::DW_TAG_unspecified_type,
875 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000876}
877
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000878void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000879 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000880 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000881
Adrian Prantl541a9c52016-05-06 19:26:47 +0000882 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
883 N.getTag() == dwarf::DW_TAG_pointer_type ||
884 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
885 N.getTag() == dwarf::DW_TAG_reference_type ||
886 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
887 N.getTag() == dwarf::DW_TAG_const_type ||
888 N.getTag() == dwarf::DW_TAG_volatile_type ||
889 N.getTag() == dwarf::DW_TAG_restrict_type ||
Victor Leschuke1156c22016-10-31 19:09:38 +0000890 N.getTag() == dwarf::DW_TAG_atomic_type ||
Adrian Prantl541a9c52016-05-06 19:26:47 +0000891 N.getTag() == dwarf::DW_TAG_member ||
892 N.getTag() == dwarf::DW_TAG_inheritance ||
893 N.getTag() == dwarf::DW_TAG_friend,
894 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000895 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000896 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
897 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000898 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000899
Adrian Prantl541a9c52016-05-06 19:26:47 +0000900 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
901 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
902 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000903}
904
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000905static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000906 return (Flags & DINode::FlagLValueReference) &&
907 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000908}
909
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000910void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
911 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000912 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000913 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000914 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
915 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000916 }
917}
918
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000919void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000920 // Common scope checks.
921 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000922
Adrian Prantl541a9c52016-05-06 19:26:47 +0000923 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
924 N.getTag() == dwarf::DW_TAG_structure_type ||
925 N.getTag() == dwarf::DW_TAG_union_type ||
926 N.getTag() == dwarf::DW_TAG_enumeration_type ||
927 N.getTag() == dwarf::DW_TAG_class_type,
928 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000929
Adrian Prantl541a9c52016-05-06 19:26:47 +0000930 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
931 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
932 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000933
Adrian Prantl541a9c52016-05-06 19:26:47 +0000934 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
935 "invalid composite elements", &N, N.getRawElements());
936 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
937 N.getRawVTableHolder());
938 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
939 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000940 if (auto *Params = N.getRawTemplateParams())
941 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000942
943 if (N.getTag() == dwarf::DW_TAG_class_type ||
944 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000945 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
946 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000947 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000948}
949
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000950void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000951 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000952 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000953 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000954 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000955 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000956 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000958 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
959 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000960}
961
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000962void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000963 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Amjad Aboud7faeecc2016-12-25 10:12:09 +0000964 AssertDI((N.getChecksumKind() != DIFile::CSK_None ||
965 N.getChecksum().empty()), "invalid checksum kind", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000966}
967
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000968void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000969 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
970 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000971
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000972 // Don't bother verifying the compilation directory or producer string
973 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000974 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
975 N.getRawFile());
976 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
977 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000978
Adrian Prantl541a9c52016-05-06 19:26:47 +0000979 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
980 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000981
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000982 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000983 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000984 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000985 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000986 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
987 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000988 }
989 }
990 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000991 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000992 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000993 AssertDI(Op && (isa<DIType>(Op) ||
994 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000995 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000996 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000997 }
998 }
999 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001000 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001001 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001002 AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)),
1003 "invalid global variable ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001004 }
1005 }
1006 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001007 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001008 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001009 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
1010 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001011 }
1012 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001013 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001014 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001015 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001016 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001017 }
1018 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +00001019 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001020}
1021
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001022void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001023 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1024 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +00001025 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001026 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001027 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001028 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1029 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1030 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001031 if (auto *Params = N.getRawTemplateParams())
1032 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001033 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001034 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1035 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001036 if (auto *RawVars = N.getRawVariables()) {
1037 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001038 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001039 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001040 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1041 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001042 }
1043 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001044 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1045 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001046
Adrian Prantl75819ae2016-04-15 15:57:41 +00001047 auto *Unit = N.getRawUnit();
1048 if (N.isDefinition()) {
1049 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001050 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1051 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1052 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001053 } else {
1054 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001055 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001056 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001057}
1058
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001059void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001060 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1061 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1062 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001063}
1064
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001065void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1066 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001067
Adrian Prantl541a9c52016-05-06 19:26:47 +00001068 AssertDI(N.getLine() || !N.getColumn(),
1069 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001070}
1071
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001072void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1073 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001074}
1075
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001076void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001077 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001078 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001079 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001080}
1081
Amjad Abouda9bcf162015-12-10 12:56:35 +00001082void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001083 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1084 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1085 "invalid macinfo type", &N);
1086 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001087 if (!N.getValue().empty()) {
1088 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1089 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001090}
1091
1092void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001093 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1094 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001095 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001096 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001097
1098 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001099 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001100 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001101 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001102 }
1103 }
1104}
1105
Adrian Prantlab1243f2015-06-29 23:03:47 +00001106void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001107 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1108 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001109}
1110
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001111void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001112 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001113}
1114
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001115void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1116 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001117
Adrian Prantl541a9c52016-05-06 19:26:47 +00001118 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1119 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001120}
1121
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001122void Verifier::visitDITemplateValueParameter(
1123 const DITemplateValueParameter &N) {
1124 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001125
Adrian Prantl541a9c52016-05-06 19:26:47 +00001126 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1127 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1128 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1129 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001130}
1131
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001132void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001133 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001134 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1135 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001136 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001137 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001138}
1139
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001140void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001141 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001142 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001143
Adrian Prantl541a9c52016-05-06 19:26:47 +00001144 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1145 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001146 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001147 AssertDI(isa<DIDerivedType>(Member),
1148 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001149 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001150}
1151
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001152void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001153 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001154 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001155
Adrian Prantl541a9c52016-05-06 19:26:47 +00001156 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1157 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1158 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001159}
1160
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001161void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001162 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001163}
1164
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001165void Verifier::visitDIGlobalVariableExpression(
1166 const DIGlobalVariableExpression &GVE) {
1167 AssertDI(GVE.getVariable(), "missing variable");
1168 if (auto *Var = GVE.getVariable())
1169 visitDIGlobalVariable(*Var);
1170 if (auto *Expr = GVE.getExpression())
1171 visitDIExpression(*Expr);
1172}
1173
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001174void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001175 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001176 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001177 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001178 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001179 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001180}
1181
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001182void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001183 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1184 N.getTag() == dwarf::DW_TAG_imported_declaration,
1185 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001186 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001187 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1188 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1189 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001190}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001191
David Majnemerdad0a642014-06-27 18:19:56 +00001192void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001193 // The Module is invalid if the GlobalValue has private linkage. Entities
1194 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001195 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001196 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1197 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001198}
1199
Chandler Carruth043949d2014-01-19 02:22:18 +00001200void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001201 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1202 if (!Idents)
1203 return;
1204
1205 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1206 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001207 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001208 Assert(N->getNumOperands() == 1,
1209 "incorrect number of operands in llvm.ident metadata", N);
1210 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1211 ("invalid value for llvm.ident metadata entry operand"
1212 "(the operand should be a string)"),
1213 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001214 }
1215}
1216
Chandler Carruth043949d2014-01-19 02:22:18 +00001217void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001218 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1219 if (!Flags) return;
1220
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001221 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001222 DenseMap<const MDString*, const MDNode*> SeenIDs;
1223 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001224 for (const MDNode *MDN : Flags->operands())
1225 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001226
1227 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001228 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001229 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001230 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001231
Chandler Carruth043949d2014-01-19 02:22:18 +00001232 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001233 if (!Op) {
1234 CheckFailed("invalid requirement on flag, flag is not present in module",
1235 Flag);
1236 continue;
1237 }
1238
1239 if (Op->getOperand(2) != ReqValue) {
1240 CheckFailed(("invalid requirement on flag, "
1241 "flag does not have the required value"),
1242 Flag);
1243 continue;
1244 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001245 }
1246}
1247
Chandler Carruth043949d2014-01-19 02:22:18 +00001248void
1249Verifier::visitModuleFlag(const MDNode *Op,
1250 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1251 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001252 // Each module flag should have three arguments, the merge behavior (a
1253 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001254 Assert(Op->getNumOperands() == 3,
1255 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001256 Module::ModFlagBehavior MFB;
1257 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001258 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001259 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001260 "invalid behavior operand in module flag (expected constant integer)",
1261 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001262 Assert(false,
1263 "invalid behavior operand in module flag (unexpected constant)",
1264 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001265 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001266 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001267 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1268 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001269
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001270 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001271 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001272 case Module::Error:
1273 case Module::Warning:
1274 case Module::Override:
1275 // These behavior types accept any value.
1276 break;
1277
1278 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001279 // The value should itself be an MDNode with two operands, a flag ID (an
1280 // MDString), and a value.
1281 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001282 Assert(Value && Value->getNumOperands() == 2,
1283 "invalid value for 'require' module flag (expected metadata pair)",
1284 Op->getOperand(2));
1285 Assert(isa<MDString>(Value->getOperand(0)),
1286 ("invalid value for 'require' module flag "
1287 "(first value operand should be a string)"),
1288 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001289
1290 // Append it to the list of requirements, to check once all module flags are
1291 // scanned.
1292 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001293 break;
1294 }
1295
1296 case Module::Append:
1297 case Module::AppendUnique: {
1298 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001299 Assert(isa<MDNode>(Op->getOperand(2)),
1300 "invalid value for 'append'-type module flag "
1301 "(expected a metadata node)",
1302 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001303 break;
1304 }
1305 }
1306
1307 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001308 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001309 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001310 Assert(Inserted,
1311 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001312 }
1313}
1314
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001315void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001316 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001317 unsigned Slot = ~0U;
1318 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1319 if (Attrs.getSlotIndex(I) == Idx) {
1320 Slot = I;
1321 break;
1322 }
1323
1324 assert(Slot != ~0U && "Attribute set inconsistency!");
1325
1326 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1327 I != E; ++I) {
1328 if (I->isStringAttribute())
1329 continue;
1330
1331 if (I->getKindAsEnum() == Attribute::NoReturn ||
1332 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001333 I->getKindAsEnum() == Attribute::NoInline ||
1334 I->getKindAsEnum() == Attribute::AlwaysInline ||
1335 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1336 I->getKindAsEnum() == Attribute::StackProtect ||
1337 I->getKindAsEnum() == Attribute::StackProtectReq ||
1338 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001339 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001340 I->getKindAsEnum() == Attribute::NoRedZone ||
1341 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1342 I->getKindAsEnum() == Attribute::Naked ||
1343 I->getKindAsEnum() == Attribute::InlineHint ||
1344 I->getKindAsEnum() == Attribute::StackAlignment ||
1345 I->getKindAsEnum() == Attribute::UWTable ||
1346 I->getKindAsEnum() == Attribute::NonLazyBind ||
1347 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1348 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1349 I->getKindAsEnum() == Attribute::SanitizeThread ||
1350 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1351 I->getKindAsEnum() == Attribute::MinSize ||
1352 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001353 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001354 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001355 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001356 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001357 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001358 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001359 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001360 I->getKindAsEnum() == Attribute::NoRecurse ||
1361 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001362 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1363 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001364 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001365 CheckFailed("Attribute '" + I->getAsString() +
1366 "' only applies to functions!", V);
1367 return;
1368 }
1369 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001370 I->getKindAsEnum() == Attribute::WriteOnly ||
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001371 I->getKindAsEnum() == Attribute::ReadNone) {
1372 if (Idx == 0) {
1373 CheckFailed("Attribute '" + I->getAsString() +
1374 "' does not apply to function returns");
1375 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001376 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001377 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001378 CheckFailed("Attribute '" + I->getAsString() +
1379 "' does not apply to functions!", V);
1380 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001381 }
1382 }
1383}
1384
Duncan Sandsc3a79922009-06-11 08:11:03 +00001385// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001386// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001387void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001388 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001389 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001390 return;
1391
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001392 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001393
Bill Wendling908126a2012-10-09 09:51:10 +00001394 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001395 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1396 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1397 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1398 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1399 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001400 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001401 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1402 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001403 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001404 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001405 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001406 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001407
Reid Klecknera534a382013-12-19 02:14:12 +00001408 // Check for mutually incompatible attributes. Only inreg is compatible with
1409 // sret.
1410 unsigned AttrCount = 0;
1411 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1412 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1413 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1414 Attrs.hasAttribute(Idx, Attribute::InReg);
1415 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001416 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1417 "and 'sret' are incompatible!",
1418 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001419
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001420 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1421 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1422 "Attributes "
1423 "'inalloca and readonly' are incompatible!",
1424 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001425
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001426 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1427 Attrs.hasAttribute(Idx, Attribute::Returned)),
1428 "Attributes "
1429 "'sret and returned' are incompatible!",
1430 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001431
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001432 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1433 Attrs.hasAttribute(Idx, Attribute::SExt)),
1434 "Attributes "
1435 "'zeroext and signext' are incompatible!",
1436 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001437
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001438 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1439 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1440 "Attributes "
1441 "'readnone and readonly' are incompatible!",
1442 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001443
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001444 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1445 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1446 "Attributes "
1447 "'readnone and writeonly' are incompatible!",
1448 V);
1449
1450 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1451 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1452 "Attributes "
1453 "'readonly and writeonly' are incompatible!",
1454 V);
1455
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001456 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1457 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1458 "Attributes "
1459 "'noinline and alwaysinline' are incompatible!",
1460 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001461
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001462 Assert(
1463 !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)),
1464 "Wrong types for attribute: " +
1465 AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty))
1466 .getAsString(Idx),
1467 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001468
Reid Klecknera534a382013-12-19 02:14:12 +00001469 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001470 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001471 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001472 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1473 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1474 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1475 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001476 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001477 if (!isa<PointerType>(PTy->getElementType()))
1478 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1479 "Attribute 'swifterror' only applies to parameters "
1480 "with pointer to pointer type!",
1481 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001482 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001483 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1484 "Attribute 'byval' only applies to parameters with pointer type!",
1485 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001486 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1487 "Attribute 'swifterror' only applies to parameters "
1488 "with pointer type!",
1489 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001490 }
Duncan Sands0009c442008-01-12 16:42:01 +00001491}
1492
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001493// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001494// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001495void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001496 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001497 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001498 return;
1499
Duncan Sands8c582282007-12-21 19:19:01 +00001500 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001501 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001502 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001503 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001504 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001505
Chris Lattner8a923e72008-03-12 17:45:29 +00001506 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001507 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001508
Chris Lattner229907c2011-07-18 04:54:35 +00001509 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001510 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001511 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001512 else if (Idx-1 < FT->getNumParams())
1513 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001514 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001515 break; // VarArgs attributes, verified elsewhere.
1516
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001517 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001518
Stephen Linb8bd2322013-04-20 05:14:40 +00001519 if (Idx == 0)
1520 continue;
1521
1522 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001523 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001524 SawNest = true;
1525 }
1526
Stephen Linb8bd2322013-04-20 05:14:40 +00001527 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001528 Assert(!SawReturned, "More than one parameter has attribute returned!",
1529 V);
1530 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1531 "Incompatible "
1532 "argument and return types for 'returned' attribute",
1533 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001534 SawReturned = true;
1535 }
1536
Reid Kleckner79418562014-05-09 22:32:13 +00001537 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001538 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1539 Assert(Idx == 1 || Idx == 2,
1540 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001541 SawSRet = true;
1542 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001543
Manman Renf46262e2016-03-29 17:37:21 +00001544 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1545 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1546 SawSwiftSelf = true;
1547 }
1548
Manman Ren9bfd0d02016-04-01 21:41:15 +00001549 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1550 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1551 V);
1552 SawSwiftError = true;
1553 }
1554
Reid Kleckner60d3a832014-01-16 22:59:24 +00001555 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001556 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1557 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001558 }
Duncan Sands8c582282007-12-21 19:19:01 +00001559 }
Devang Patel9cc98122008-10-01 23:41:25 +00001560
Bill Wendling77543892013-01-18 21:11:39 +00001561 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1562 return;
1563
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001564 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001565
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001566 Assert(
1567 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1568 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1569 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001570
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001571 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001572 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001573 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1574 "Attributes 'readnone and writeonly' are incompatible!", V);
1575
1576 Assert(
1577 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1578 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1579 "Attributes 'readonly and writeonly' are incompatible!", V);
1580
1581 Assert(
1582 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001583 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1584 Attribute::InaccessibleMemOrArgMemOnly)),
1585 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1586
1587 Assert(
1588 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1589 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1590 Attribute::InaccessibleMemOnly)),
1591 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1592
1593 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001594 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1595 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1596 Attribute::AlwaysInline)),
1597 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001598
1599 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1600 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001601 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1602 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001603
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001604 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1605 Attribute::OptimizeForSize),
1606 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001607
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001608 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1609 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001610 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001611
1612 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1613 Attribute::JumpTable)) {
1614 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001615 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001616 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001617 }
George Burgess IV278199f2016-04-12 01:05:35 +00001618
1619 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1620 std::pair<unsigned, Optional<unsigned>> Args =
1621 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1622
1623 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1624 if (ParamNo >= FT->getNumParams()) {
1625 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1626 return false;
1627 }
1628
1629 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1630 CheckFailed("'allocsize' " + Name +
1631 " argument must refer to an integer parameter",
1632 V);
1633 return false;
1634 }
1635
1636 return true;
1637 };
1638
1639 if (!CheckParam("element size", Args.first))
1640 return;
1641
1642 if (Args.second && !CheckParam("number of elements", *Args.second))
1643 return;
1644 }
Duncan Sands8c582282007-12-21 19:19:01 +00001645}
1646
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001647void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001648 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001649 for (const auto &Pair : MDs) {
1650 if (Pair.first == LLVMContext::MD_prof) {
1651 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001652 Assert(MD->getNumOperands() == 2,
1653 "!prof annotations should have exactly 2 operands", MD);
1654
1655 // Check first operand.
1656 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1657 MD);
1658 Assert(isa<MDString>(MD->getOperand(0)),
1659 "expected string with name of the !prof annotation", MD);
1660 MDString *MDS = cast<MDString>(MD->getOperand(0));
1661 StringRef ProfName = MDS->getString();
1662 Assert(ProfName.equals("function_entry_count"),
1663 "first operand should be 'function_entry_count'", MD);
1664
1665 // Check second operand.
1666 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1667 MD);
1668 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1669 "expected integer argument to function_entry_count", MD);
1670 }
1671 }
1672}
1673
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001674void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1675 if (!ConstantExprVisited.insert(EntryC).second)
1676 return;
1677
1678 SmallVector<const Constant *, 16> Stack;
1679 Stack.push_back(EntryC);
1680
1681 while (!Stack.empty()) {
1682 const Constant *C = Stack.pop_back_val();
1683
1684 // Check this constant expression.
1685 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1686 visitConstantExpr(CE);
1687
Keno Fischerf6d17b92016-01-14 22:42:02 +00001688 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1689 // Global Values get visited separately, but we do need to make sure
1690 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001691 Assert(GV->getParent() == &M, "Referencing global in another module!",
1692 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001693 continue;
1694 }
1695
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001696 // Visit all sub-expressions.
1697 for (const Use &U : C->operands()) {
1698 const auto *OpC = dyn_cast<Constant>(U);
1699 if (!OpC)
1700 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001701 if (!ConstantExprVisited.insert(OpC).second)
1702 continue;
1703 Stack.push_back(OpC);
1704 }
1705 }
1706}
1707
1708void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001709 if (CE->getOpcode() == Instruction::BitCast)
1710 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1711 CE->getType()),
1712 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001713
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001714 if (CE->getOpcode() == Instruction::IntToPtr ||
1715 CE->getOpcode() == Instruction::PtrToInt) {
1716 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1717 ? CE->getType()
1718 : CE->getOperand(0)->getType();
1719 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1720 ? "inttoptr not supported for non-integral pointers"
1721 : "ptrtoint not supported for non-integral pointers";
1722 Assert(
1723 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1724 Msg);
1725 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001726}
1727
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001728bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001729 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001730 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001731
Devang Patel82fed672008-09-23 22:35:17 +00001732 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001733 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001734 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001735 || (LastIndex == AttributeSet::FunctionIndex
1736 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001737 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001738
Devang Patel82fed672008-09-23 22:35:17 +00001739 return false;
1740}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001741
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001742/// Verify that statepoint intrinsic is well formed.
1743void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001744 assert(CS.getCalledFunction() &&
1745 CS.getCalledFunction()->getIntrinsicID() ==
1746 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001747
Philip Reames0285c742015-02-03 23:18:47 +00001748 const Instruction &CI = *CS.getInstruction();
1749
Igor Laevsky39d662f2015-07-11 10:30:36 +00001750 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1751 !CS.onlyAccessesArgMemory(),
1752 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001753 "reordering restrictions required by safepoint semantics",
1754 &CI);
1755
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001756 const Value *IDV = CS.getArgument(0);
1757 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1758 &CI);
1759
1760 const Value *NumPatchBytesV = CS.getArgument(1);
1761 Assert(isa<ConstantInt>(NumPatchBytesV),
1762 "gc.statepoint number of patchable bytes must be a constant integer",
1763 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001764 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001765 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1766 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1767 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1768 "positive",
1769 &CI);
1770
1771 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001772 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001773 Assert(PT && PT->getElementType()->isFunctionTy(),
1774 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001775 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001776
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001777 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001778 Assert(isa<ConstantInt>(NumCallArgsV),
1779 "gc.statepoint number of arguments to underlying call "
1780 "must be constant integer",
1781 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001782 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001783 Assert(NumCallArgs >= 0,
1784 "gc.statepoint number of arguments to underlying call "
1785 "must be positive",
1786 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001787 const int NumParams = (int)TargetFuncType->getNumParams();
1788 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001789 Assert(NumCallArgs >= NumParams,
1790 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001791
1792 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001793 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1794 "gc.statepoint doesn't support wrapping non-void "
1795 "vararg functions yet",
1796 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001797 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001798 Assert(NumCallArgs == NumParams,
1799 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001800
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001801 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001802 Assert(isa<ConstantInt>(FlagsV),
1803 "gc.statepoint flags must be constant integer", &CI);
1804 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1805 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1806 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001807
1808 // Verify that the types of the call parameter arguments match
1809 // the type of the wrapped callee.
1810 for (int i = 0; i < NumParams; i++) {
1811 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001812 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001813 Assert(ArgType == ParamType,
1814 "gc.statepoint call argument does not match wrapped "
1815 "function type",
1816 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001817 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001818
1819 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001820
1821 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1822 Assert(isa<ConstantInt>(NumTransitionArgsV),
1823 "gc.statepoint number of transition arguments "
1824 "must be constant integer",
1825 &CI);
1826 const int NumTransitionArgs =
1827 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1828 Assert(NumTransitionArgs >= 0,
1829 "gc.statepoint number of transition arguments must be positive", &CI);
1830 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1831
1832 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001833 Assert(isa<ConstantInt>(NumDeoptArgsV),
1834 "gc.statepoint number of deoptimization arguments "
1835 "must be constant integer",
1836 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001837 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001838 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1839 "must be positive",
1840 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001841
Pat Gavlincc0431d2015-05-08 18:07:42 +00001842 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001843 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001844 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001845 "gc.statepoint too few arguments according to length fields", &CI);
1846
Philip Reames1ffa9372015-01-30 23:28:05 +00001847 // Check that the only uses of this gc.statepoint are gc.result or
1848 // gc.relocate calls which are tied to this statepoint and thus part
1849 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001850 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001851 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001852 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001853 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001854 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001855 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001856 "of a gc.statepoint",
1857 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001858 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001859 Assert(Call->getArgOperand(0) == &CI,
1860 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001861 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001862 Assert(Call->getArgOperand(0) == &CI,
1863 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001864 }
1865 }
1866
1867 // Note: It is legal for a single derived pointer to be listed multiple
1868 // times. It's non-optimal, but it is legal. It can also happen after
1869 // insertion if we strip a bitcast away.
1870 // Note: It is really tempting to check that each base is relocated and
1871 // that a derived pointer is never reused as a base pointer. This turns
1872 // out to be problematic since optimizations run after safepoint insertion
1873 // can recognize equality properties that the insertion logic doesn't know
1874 // about. See example statepoint.ll in the verifier subdirectory
1875}
1876
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001877void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001878 for (auto &Counts : FrameEscapeInfo) {
1879 Function *F = Counts.first;
1880 unsigned EscapedObjectCount = Counts.second.first;
1881 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001882 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001883 "all indices passed to llvm.localrecover must be less than the "
1884 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001885 "function",
1886 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001887 }
1888}
1889
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001890static Instruction *getSuccPad(TerminatorInst *Terminator) {
1891 BasicBlock *UnwindDest;
1892 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1893 UnwindDest = II->getUnwindDest();
1894 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1895 UnwindDest = CSI->getUnwindDest();
1896 else
1897 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1898 return UnwindDest->getFirstNonPHI();
1899}
1900
1901void Verifier::verifySiblingFuncletUnwinds() {
1902 SmallPtrSet<Instruction *, 8> Visited;
1903 SmallPtrSet<Instruction *, 8> Active;
1904 for (const auto &Pair : SiblingFuncletInfo) {
1905 Instruction *PredPad = Pair.first;
1906 if (Visited.count(PredPad))
1907 continue;
1908 Active.insert(PredPad);
1909 TerminatorInst *Terminator = Pair.second;
1910 do {
1911 Instruction *SuccPad = getSuccPad(Terminator);
1912 if (Active.count(SuccPad)) {
1913 // Found a cycle; report error
1914 Instruction *CyclePad = SuccPad;
1915 SmallVector<Instruction *, 8> CycleNodes;
1916 do {
1917 CycleNodes.push_back(CyclePad);
1918 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1919 if (CycleTerminator != CyclePad)
1920 CycleNodes.push_back(CycleTerminator);
1921 CyclePad = getSuccPad(CycleTerminator);
1922 } while (CyclePad != SuccPad);
1923 Assert(false, "EH pads can't handle each other's exceptions",
1924 ArrayRef<Instruction *>(CycleNodes));
1925 }
1926 // Don't re-walk a node we've already checked
1927 if (!Visited.insert(SuccPad).second)
1928 break;
1929 // Walk to this successor if it has a map entry.
1930 PredPad = SuccPad;
1931 auto TermI = SiblingFuncletInfo.find(PredPad);
1932 if (TermI == SiblingFuncletInfo.end())
1933 break;
1934 Terminator = TermI->second;
1935 Active.insert(PredPad);
1936 } while (true);
1937 // Each node only has one successor, so we've walked all the active
1938 // nodes' successors.
1939 Active.clear();
1940 }
1941}
1942
Chris Lattner0e851da2002-04-18 20:37:37 +00001943// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001944//
Chandler Carruth043949d2014-01-19 02:22:18 +00001945void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001946 visitGlobalValue(F);
1947
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001948 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001949 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001950 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001951
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001952 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001953 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001954
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001955 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1956 Assert(FT->getNumParams() == NumArgs,
1957 "# formal arguments must match # of arguments for function type!", &F,
1958 FT);
1959 Assert(F.getReturnType()->isFirstClassType() ||
1960 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1961 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001962
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001963 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1964 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001965
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001966 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001967
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001968 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001969 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001970
Duncan Sands8c582282007-12-21 19:19:01 +00001971 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001972 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001973
Michael Gottesman41748d72013-06-27 00:25:01 +00001974 // On function declarations/definitions, we do not support the builtin
1975 // attribute. We do not check this in VerifyFunctionAttrs since that is
1976 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001977 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1978 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001979
Chris Lattneref13ee32006-05-19 21:25:17 +00001980 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001981 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1982 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001983 switch (F.getCallingConv()) {
1984 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001985 case CallingConv::C:
1986 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001987 case CallingConv::Fast:
1988 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001989 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001990 case CallingConv::PTX_Kernel:
1991 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001992 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1993 "perfect forwarding!",
1994 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001995 break;
1996 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001997
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001998 bool isLLVMdotName = F.getName().size() >= 5 &&
1999 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002000
Chris Lattneraf95e582002-04-13 22:48:46 +00002001 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00002002 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002003 for (const Argument &Arg : F.args()) {
2004 Assert(Arg.getType() == FT->getParamType(i),
2005 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002006 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002007 Assert(Arg.getType()->isFirstClassType(),
2008 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00002009 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002010 Assert(!Arg.getType()->isMetadataTy(),
2011 "Function takes metadata but isn't an intrinsic", &Arg, &F);
2012 Assert(!Arg.getType()->isTokenTy(),
2013 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00002014 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00002015
2016 // Check that swifterror argument is only used by loads and stores.
2017 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
2018 verifySwiftErrorValue(&Arg);
2019 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002020 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00002021 }
Chris Lattneraf95e582002-04-13 22:48:46 +00002022
David Majnemerb611e3f2015-08-14 05:09:07 +00002023 if (!isLLVMdotName)
2024 Assert(!F.getReturnType()->isTokenTy(),
2025 "Functions returns a token but isn't an intrinsic", &F);
2026
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002027 // Get the function metadata attachments.
2028 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2029 F.getAllMetadata(MDs);
2030 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002031 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002032
Keno Fischer2ac0c272015-11-16 05:13:30 +00002033 // Check validity of the personality function
2034 if (F.hasPersonalityFn()) {
2035 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2036 if (Per)
2037 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002038 "Referencing personality function in another module!",
2039 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002040 }
2041
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002042 if (F.isMaterializable()) {
2043 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002044 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2045 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002046 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002047 for (const auto &I : MDs) {
2048 AssertDI(I.first != LLVMContext::MD_dbg,
2049 "function declaration may not have a !dbg attachment", &F);
2050 Assert(I.first != LLVMContext::MD_prof,
2051 "function declaration may not have a !prof attachment", &F);
2052
2053 // Verify the metadata itself.
2054 visitMDNode(*I.second);
2055 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002056 Assert(!F.hasPersonalityFn(),
2057 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002058 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002059 // Verify that this function (which has a body) is not named "llvm.*". It
2060 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002061 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002062
Chris Lattner149376d2002-10-13 20:57:00 +00002063 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002064 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002065 Assert(pred_empty(Entry),
2066 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002067
Chris Lattner27471742009-11-01 04:08:01 +00002068 // The address of the entry block cannot be taken, unless it is dead.
2069 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002070 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2071 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002072 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002073
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002074 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002075 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002076 for (const auto &I : MDs) {
2077 // Verify that the attachment is legal.
2078 switch (I.first) {
2079 default:
2080 break;
2081 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002082 ++NumDebugAttachments;
2083 AssertDI(NumDebugAttachments == 1,
2084 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002085 AssertDI(isa<DISubprogram>(I.second),
2086 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002087 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002088 case LLVMContext::MD_prof:
2089 ++NumProfAttachments;
2090 Assert(NumProfAttachments == 1,
2091 "function must have a single !prof attachment", &F, I.second);
2092 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002093 }
2094
2095 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002096 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002097 }
Chris Lattner149376d2002-10-13 20:57:00 +00002098 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002099
Chris Lattner7730dcc2009-09-11 17:05:29 +00002100 // If this function is actually an intrinsic, verify that it is only used in
2101 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002102 // Only do this if the module is materialized, otherwise we don't have all the
2103 // uses.
2104 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002105 const User *U;
2106 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002107 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002108 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002109
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002110 Assert(!F.hasDLLImportStorageClass() ||
2111 (F.isDeclaration() && F.hasExternalLinkage()) ||
2112 F.hasAvailableExternallyLinkage(),
2113 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002114
2115 auto *N = F.getSubprogram();
2116 if (!N)
2117 return;
2118
Adrian Prantl75819ae2016-04-15 15:57:41 +00002119 visitDISubprogram(*N);
2120
Peter Collingbourned4bff302015-11-05 22:03:56 +00002121 // Check that all !dbg attachments lead to back to N (or, at least, another
2122 // subprogram that describes the same function).
2123 //
2124 // FIXME: Check this incrementally while visiting !dbg attachments.
2125 // FIXME: Only check when N is the canonical subprogram for F.
2126 SmallPtrSet<const MDNode *, 32> Seen;
2127 for (auto &BB : F)
2128 for (auto &I : BB) {
2129 // Be careful about using DILocation here since we might be dealing with
2130 // broken code (this is the Verifier after all).
2131 DILocation *DL =
2132 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2133 if (!DL)
2134 continue;
2135 if (!Seen.insert(DL).second)
2136 continue;
2137
2138 DILocalScope *Scope = DL->getInlinedAtScope();
2139 if (Scope && !Seen.insert(Scope).second)
2140 continue;
2141
2142 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002143
2144 // Scope and SP could be the same MDNode and we don't want to skip
2145 // validation in that case
2146 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002147 continue;
2148
2149 // FIXME: Once N is canonical, check "SP == &N".
Adrian Prantla2ef0472016-09-14 17:30:37 +00002150 AssertDI(SP->describes(&F),
2151 "!dbg attachment points at wrong subprogram for function", N, &F,
2152 &I, DL, Scope, SP);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002153 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002154}
2155
Chris Lattner0e851da2002-04-18 20:37:37 +00002156// verifyBasicBlock - Verify that a basic block is well formed...
2157//
Chris Lattner069a7952002-06-25 15:56:27 +00002158void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002159 InstsInThisBlock.clear();
2160
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002161 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002162 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002163
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002164 // Check constraints that this basic block imposes on all of the PHI nodes in
2165 // it.
2166 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002167 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2168 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002169 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002170 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002171 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002172 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002173 Assert(PN->getNumIncomingValues() != 0,
2174 "PHI nodes must have at least one entry. If the block is dead, "
2175 "the PHI should be removed!",
2176 PN);
2177 Assert(PN->getNumIncomingValues() == Preds.size(),
2178 "PHINode should have one entry for each predecessor of its "
2179 "parent basic block!",
2180 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002181
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002182 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002183 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002184 Values.reserve(PN->getNumIncomingValues());
2185 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2186 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2187 PN->getIncomingValue(i)));
2188 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002189
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002190 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2191 // Check to make sure that if there is more than one entry for a
2192 // particular basic block in this PHI node, that the incoming values are
2193 // all identical.
2194 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002195 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2196 Values[i].second == Values[i - 1].second,
2197 "PHI node has multiple entries for the same basic block with "
2198 "different incoming values!",
2199 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002200
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002201 // Check to make sure that the predecessors and PHI node entries are
2202 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002203 Assert(Values[i].first == Preds[i],
2204 "PHI node entries do not match predecessors!", PN,
2205 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002206 }
2207 }
2208 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002209
2210 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002211 for (auto &I : BB)
2212 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002213 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002214 }
Chris Lattner069a7952002-06-25 15:56:27 +00002215}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002216
Chris Lattner069a7952002-06-25 15:56:27 +00002217void Verifier::visitTerminatorInst(TerminatorInst &I) {
2218 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002219 Assert(&I == I.getParent()->getTerminator(),
2220 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002221 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002222}
2223
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002224void Verifier::visitBranchInst(BranchInst &BI) {
2225 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002226 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2227 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002228 }
2229 visitTerminatorInst(BI);
2230}
2231
Chris Lattner069a7952002-06-25 15:56:27 +00002232void Verifier::visitReturnInst(ReturnInst &RI) {
2233 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002234 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002235 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002236 Assert(N == 0,
2237 "Found return instr that returns non-void in Function of void "
2238 "return type!",
2239 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002240 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002241 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2242 "Function return type does not match operand "
2243 "type of return inst!",
2244 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002245
Misha Brukman7eb05a12003-08-18 14:43:39 +00002246 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002247 // terminators...
2248 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002249}
2250
Chris Lattnerab5aa142004-05-21 16:47:21 +00002251void Verifier::visitSwitchInst(SwitchInst &SI) {
2252 // Check to make sure that all of the constants in the switch instruction
2253 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002254 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002255 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002256 for (auto &Case : SI.cases()) {
2257 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002258 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002259 Assert(Constants.insert(Case.getCaseValue()).second,
2260 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002261 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002262
Chris Lattnerab5aa142004-05-21 16:47:21 +00002263 visitTerminatorInst(SI);
2264}
2265
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002266void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002267 Assert(BI.getAddress()->getType()->isPointerTy(),
2268 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002269 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002270 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2271 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002272
2273 visitTerminatorInst(BI);
2274}
2275
Chris Lattner75648e72004-03-12 05:54:31 +00002276void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002277 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2278 SI.getOperand(2)),
2279 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002280
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002281 Assert(SI.getTrueValue()->getType() == SI.getType(),
2282 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002283 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002284}
2285
Misha Brukmanc566ca362004-03-02 00:22:19 +00002286/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2287/// a pass, if any exist, it's an error.
2288///
Chris Lattner903a25d2002-11-21 16:54:22 +00002289void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002290 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002291}
Chris Lattner0e851da2002-04-18 20:37:37 +00002292
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002293void Verifier::visitTruncInst(TruncInst &I) {
2294 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002295 Type *SrcTy = I.getOperand(0)->getType();
2296 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002297
2298 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002299 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2300 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002301
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002302 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2303 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2304 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2305 "trunc source and destination must both be a vector or neither", &I);
2306 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002307
2308 visitInstruction(I);
2309}
2310
2311void Verifier::visitZExtInst(ZExtInst &I) {
2312 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002313 Type *SrcTy = I.getOperand(0)->getType();
2314 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002315
2316 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002317 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2318 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2319 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2320 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002321 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2322 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002323
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002324 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002325
2326 visitInstruction(I);
2327}
2328
2329void Verifier::visitSExtInst(SExtInst &I) {
2330 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002331 Type *SrcTy = I.getOperand(0)->getType();
2332 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002333
2334 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002335 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2336 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002337
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002338 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2339 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2340 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2341 "sext source and destination must both be a vector or neither", &I);
2342 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002343
2344 visitInstruction(I);
2345}
2346
2347void Verifier::visitFPTruncInst(FPTruncInst &I) {
2348 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002349 Type *SrcTy = I.getOperand(0)->getType();
2350 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002351 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002352 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2353 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002354
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002355 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2356 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2357 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2358 "fptrunc source and destination must both be a vector or neither", &I);
2359 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002360
2361 visitInstruction(I);
2362}
2363
2364void Verifier::visitFPExtInst(FPExtInst &I) {
2365 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002366 Type *SrcTy = I.getOperand(0)->getType();
2367 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002368
2369 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002370 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2371 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002372
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002373 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2374 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2375 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2376 "fpext source and destination must both be a vector or neither", &I);
2377 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002378
2379 visitInstruction(I);
2380}
2381
2382void Verifier::visitUIToFPInst(UIToFPInst &I) {
2383 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002384 Type *SrcTy = I.getOperand(0)->getType();
2385 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002386
Duncan Sands19d0b472010-02-16 11:11:14 +00002387 bool SrcVec = SrcTy->isVectorTy();
2388 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002389
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002390 Assert(SrcVec == DstVec,
2391 "UIToFP source and dest must both be vector or scalar", &I);
2392 Assert(SrcTy->isIntOrIntVectorTy(),
2393 "UIToFP source must be integer or integer vector", &I);
2394 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2395 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002396
2397 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002398 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2399 cast<VectorType>(DestTy)->getNumElements(),
2400 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002401
2402 visitInstruction(I);
2403}
2404
2405void Verifier::visitSIToFPInst(SIToFPInst &I) {
2406 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002407 Type *SrcTy = I.getOperand(0)->getType();
2408 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002409
Duncan Sands19d0b472010-02-16 11:11:14 +00002410 bool SrcVec = SrcTy->isVectorTy();
2411 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002412
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002413 Assert(SrcVec == DstVec,
2414 "SIToFP source and dest must both be vector or scalar", &I);
2415 Assert(SrcTy->isIntOrIntVectorTy(),
2416 "SIToFP source must be integer or integer vector", &I);
2417 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2418 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002419
2420 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002421 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2422 cast<VectorType>(DestTy)->getNumElements(),
2423 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002424
2425 visitInstruction(I);
2426}
2427
2428void Verifier::visitFPToUIInst(FPToUIInst &I) {
2429 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002430 Type *SrcTy = I.getOperand(0)->getType();
2431 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002432
Duncan Sands19d0b472010-02-16 11:11:14 +00002433 bool SrcVec = SrcTy->isVectorTy();
2434 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002435
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002436 Assert(SrcVec == DstVec,
2437 "FPToUI source and dest must both be vector or scalar", &I);
2438 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2439 &I);
2440 Assert(DestTy->isIntOrIntVectorTy(),
2441 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002442
2443 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002444 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2445 cast<VectorType>(DestTy)->getNumElements(),
2446 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002447
2448 visitInstruction(I);
2449}
2450
2451void Verifier::visitFPToSIInst(FPToSIInst &I) {
2452 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002453 Type *SrcTy = I.getOperand(0)->getType();
2454 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002455
Duncan Sands19d0b472010-02-16 11:11:14 +00002456 bool SrcVec = SrcTy->isVectorTy();
2457 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002458
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002459 Assert(SrcVec == DstVec,
2460 "FPToSI source and dest must both be vector or scalar", &I);
2461 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2462 &I);
2463 Assert(DestTy->isIntOrIntVectorTy(),
2464 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002465
2466 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002467 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2468 cast<VectorType>(DestTy)->getNumElements(),
2469 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002470
2471 visitInstruction(I);
2472}
2473
2474void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2475 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002476 Type *SrcTy = I.getOperand(0)->getType();
2477 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002478
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002479 Assert(SrcTy->getScalarType()->isPointerTy(),
2480 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002481
2482 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002483 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002484 "ptrtoint not supported for non-integral pointers");
2485
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002486 Assert(DestTy->getScalarType()->isIntegerTy(),
2487 "PtrToInt result must be integral", &I);
2488 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2489 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002490
2491 if (SrcTy->isVectorTy()) {
2492 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2493 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002494 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2495 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002496 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002497
2498 visitInstruction(I);
2499}
2500
2501void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2502 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002503 Type *SrcTy = I.getOperand(0)->getType();
2504 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002505
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002506 Assert(SrcTy->getScalarType()->isIntegerTy(),
2507 "IntToPtr source must be an integral", &I);
2508 Assert(DestTy->getScalarType()->isPointerTy(),
2509 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002510
2511 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002512 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002513 "inttoptr not supported for non-integral pointers");
2514
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002515 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2516 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002517 if (SrcTy->isVectorTy()) {
2518 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2519 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002520 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2521 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002522 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002523 visitInstruction(I);
2524}
2525
2526void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002527 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002528 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2529 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002530 visitInstruction(I);
2531}
2532
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002533void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2534 Type *SrcTy = I.getOperand(0)->getType();
2535 Type *DestTy = I.getType();
2536
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002537 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2538 &I);
2539 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2540 &I);
2541 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2542 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002543 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002544 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2545 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002546 visitInstruction(I);
2547}
2548
Misha Brukmanc566ca362004-03-02 00:22:19 +00002549/// visitPHINode - Ensure that a PHI node is well formed.
2550///
Chris Lattner069a7952002-06-25 15:56:27 +00002551void Verifier::visitPHINode(PHINode &PN) {
2552 // Ensure that the PHI nodes are all grouped together at the top of the block.
2553 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002554 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002555 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002556 Assert(&PN == &PN.getParent()->front() ||
2557 isa<PHINode>(--BasicBlock::iterator(&PN)),
2558 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002559
David Majnemerb611e3f2015-08-14 05:09:07 +00002560 // Check that a PHI doesn't yield a Token.
2561 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2562
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002563 // Check that all of the values of the PHI node have the same type as the
2564 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002565 for (Value *IncValue : PN.incoming_values()) {
2566 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002567 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002568 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002569
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002570 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002571
2572 visitInstruction(PN);
2573}
2574
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002575void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002576 Instruction *I = CS.getInstruction();
2577
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002578 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2579 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002580 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002581
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002582 Assert(FPTy->getElementType()->isFunctionTy(),
2583 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002584
2585 Assert(FPTy->getElementType() == CS.getFunctionType(),
2586 "Called function is not the same type as the call!", I);
2587
2588 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002589
2590 // Verify that the correct number of arguments are being passed
2591 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002592 Assert(CS.arg_size() >= FTy->getNumParams(),
2593 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002594 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002595 Assert(CS.arg_size() == FTy->getNumParams(),
2596 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002597
Chris Lattner609de002010-05-10 20:58:42 +00002598 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002599 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002600 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2601 "Call parameter type does not match function signature!",
2602 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002603
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002604 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002605
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002606 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002607 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002608
Duncan Sands8c582282007-12-21 19:19:01 +00002609 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002610 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002611
David Majnemer91db08b2014-04-30 17:22:00 +00002612 // Conservatively check the inalloca argument.
2613 // We have a bug if we can find that there is an underlying alloca without
2614 // inalloca.
2615 if (CS.hasInAllocaArgument()) {
2616 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2617 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002618 Assert(AI->isUsedWithInAlloca(),
2619 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002620 }
2621
Manman Ren9bfd0d02016-04-01 21:41:15 +00002622 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002623 // make sure the underlying alloca/parameter it comes from has a swifterror as
2624 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002625 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2626 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2627 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002628 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002629 Assert(AI->isSwiftError(),
2630 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002631 continue;
2632 }
2633 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2634 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2635 Assert(ArgI->hasSwiftErrorAttr(),
2636 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002637 }
2638
Stephen Linb8bd2322013-04-20 05:14:40 +00002639 if (FTy->isVarArg()) {
2640 // FIXME? is 'nest' even legal here?
2641 bool SawNest = false;
2642 bool SawReturned = false;
2643
2644 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2645 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2646 SawNest = true;
2647 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2648 SawReturned = true;
2649 }
2650
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002651 // Check attributes on the varargs part.
2652 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002653 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002654 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002655
Stephen Linb8bd2322013-04-20 05:14:40 +00002656 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002657 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002658 SawNest = true;
2659 }
2660
2661 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002662 Assert(!SawReturned, "More than one parameter has attribute returned!",
2663 I);
2664 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2665 "Incompatible argument and return types for 'returned' "
2666 "attribute",
2667 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002668 SawReturned = true;
2669 }
Duncan Sands0009c442008-01-12 16:42:01 +00002670
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002671 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2672 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002673
2674 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002675 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002676 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002677 }
Duncan Sands8c582282007-12-21 19:19:01 +00002678
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002679 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002680 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002681 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002682 for (Type *ParamTy : FTy->params()) {
2683 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002684 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002685 Assert(!ParamTy->isTokenTy(),
2686 "Function has token parameter but isn't an intrinsic", I);
2687 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002688 }
2689
David Majnemerb611e3f2015-08-14 05:09:07 +00002690 // Verify that indirect calls don't return tokens.
2691 if (CS.getCalledFunction() == nullptr)
2692 Assert(!FTy->getReturnType()->isTokenTy(),
2693 "Return type cannot be token for indirect call!");
2694
Philip Reamesa3c6f002015-06-26 21:39:44 +00002695 if (Function *F = CS.getCalledFunction())
2696 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002697 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002698
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002699 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2700 // at most one "gc-transition" operand bundle.
2701 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2702 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002703 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002704 OperandBundleUse BU = CS.getOperandBundleAt(i);
2705 uint32_t Tag = BU.getTagID();
2706 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002707 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2708 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002709 } else if (Tag == LLVMContext::OB_gc_transition) {
2710 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2711 I);
2712 FoundGCTransitionBundle = true;
2713 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002714 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2715 FoundFuncletBundle = true;
2716 Assert(BU.Inputs.size() == 1,
2717 "Expected exactly one funclet bundle operand", I);
2718 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2719 "Funclet bundle operands should correspond to a FuncletPadInst",
2720 I);
2721 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002722 }
2723
Adrian Prantl93035c82016-04-24 22:23:13 +00002724 // Verify that each inlinable callsite of a debug-info-bearing function in a
2725 // debug-info-bearing function has a debug location attached to it. Failure to
2726 // do so causes assertion failures when the inliner sets up inline scope info.
2727 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2728 CS.getCalledFunction()->getSubprogram())
2729 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2730 "info must have a !dbg location",
2731 I);
2732
Duncan Sands8c582282007-12-21 19:19:01 +00002733 visitInstruction(*I);
2734}
2735
Reid Kleckner5772b772014-04-24 20:14:34 +00002736/// Two types are "congruent" if they are identical, or if they are both pointer
2737/// types with different pointee types and the same address space.
2738static bool isTypeCongruent(Type *L, Type *R) {
2739 if (L == R)
2740 return true;
2741 PointerType *PL = dyn_cast<PointerType>(L);
2742 PointerType *PR = dyn_cast<PointerType>(R);
2743 if (!PL || !PR)
2744 return false;
2745 return PL->getAddressSpace() == PR->getAddressSpace();
2746}
2747
Reid Klecknerd20c9702014-05-15 23:58:57 +00002748static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2749 static const Attribute::AttrKind ABIAttrs[] = {
2750 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002751 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2752 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002753 AttrBuilder Copy;
2754 for (auto AK : ABIAttrs) {
2755 if (Attrs.hasAttribute(I + 1, AK))
2756 Copy.addAttribute(AK);
2757 }
2758 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2759 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2760 return Copy;
2761}
2762
Reid Kleckner5772b772014-04-24 20:14:34 +00002763void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002764 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002765
2766 // - The caller and callee prototypes must match. Pointer types of
2767 // parameters or return types may differ in pointee type, but not
2768 // address space.
2769 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002770 FunctionType *CallerTy = F->getFunctionType();
2771 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002772 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2773 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2774 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2775 "cannot guarantee tail call due to mismatched varargs", &CI);
2776 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2777 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002778 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002779 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002780 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2781 "cannot guarantee tail call due to mismatched parameter types", &CI);
2782 }
2783
2784 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002785 Assert(F->getCallingConv() == CI.getCallingConv(),
2786 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002787
2788 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2789 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002790 AttributeSet CallerAttrs = F->getAttributes();
2791 AttributeSet CalleeAttrs = CI.getAttributes();
2792 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002793 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2794 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002795 Assert(CallerABIAttrs == CalleeABIAttrs,
2796 "cannot guarantee tail call due to mismatched ABI impacting "
2797 "function attributes",
2798 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002799 }
2800
2801 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2802 // or a pointer bitcast followed by a ret instruction.
2803 // - The ret instruction must return the (possibly bitcasted) value
2804 // produced by the call or void.
2805 Value *RetVal = &CI;
2806 Instruction *Next = CI.getNextNode();
2807
2808 // Handle the optional bitcast.
2809 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002810 Assert(BI->getOperand(0) == RetVal,
2811 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002812 RetVal = BI;
2813 Next = BI->getNextNode();
2814 }
2815
2816 // Check the return.
2817 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002818 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2819 &CI);
2820 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2821 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002822}
2823
Duncan Sands8c582282007-12-21 19:19:01 +00002824void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002825 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002826
Reid Kleckner5772b772014-04-24 20:14:34 +00002827 if (CI.isMustTailCall())
2828 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002829}
2830
2831void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002832 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002833
David Majnemer654e1302015-07-31 17:58:14 +00002834 // Verify that the first non-PHI instruction of the unwind destination is an
2835 // exception handling instruction.
2836 Assert(
2837 II.getUnwindDest()->isEHPad(),
2838 "The unwind destination does not have an exception handling instruction!",
2839 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002840
Dan Gohman9c6e1882010-08-02 23:09:14 +00002841 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002842}
Chris Lattner0e851da2002-04-18 20:37:37 +00002843
Misha Brukmanc566ca362004-03-02 00:22:19 +00002844/// visitBinaryOperator - Check that both arguments to the binary operator are
2845/// of the same type!
2846///
Chris Lattner069a7952002-06-25 15:56:27 +00002847void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002848 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2849 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002850
Reid Spencer2341c222007-02-02 02:16:23 +00002851 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002852 // Check that integer arithmetic operators are only used with
2853 // integral operands.
2854 case Instruction::Add:
2855 case Instruction::Sub:
2856 case Instruction::Mul:
2857 case Instruction::SDiv:
2858 case Instruction::UDiv:
2859 case Instruction::SRem:
2860 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002861 Assert(B.getType()->isIntOrIntVectorTy(),
2862 "Integer arithmetic operators only work with integral types!", &B);
2863 Assert(B.getType() == B.getOperand(0)->getType(),
2864 "Integer arithmetic operators must have same type "
2865 "for operands and result!",
2866 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002867 break;
2868 // Check that floating-point arithmetic operators are only used with
2869 // floating-point operands.
2870 case Instruction::FAdd:
2871 case Instruction::FSub:
2872 case Instruction::FMul:
2873 case Instruction::FDiv:
2874 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002875 Assert(B.getType()->isFPOrFPVectorTy(),
2876 "Floating-point arithmetic operators only work with "
2877 "floating-point types!",
2878 &B);
2879 Assert(B.getType() == B.getOperand(0)->getType(),
2880 "Floating-point arithmetic operators must have same type "
2881 "for operands and result!",
2882 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002883 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002884 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002885 case Instruction::And:
2886 case Instruction::Or:
2887 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002888 Assert(B.getType()->isIntOrIntVectorTy(),
2889 "Logical operators only work with integral types!", &B);
2890 Assert(B.getType() == B.getOperand(0)->getType(),
2891 "Logical operators must have same type for operands and result!",
2892 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002893 break;
2894 case Instruction::Shl:
2895 case Instruction::LShr:
2896 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002897 Assert(B.getType()->isIntOrIntVectorTy(),
2898 "Shifts only work with integral types!", &B);
2899 Assert(B.getType() == B.getOperand(0)->getType(),
2900 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002901 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002902 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002903 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002904 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002905
Chris Lattner0e851da2002-04-18 20:37:37 +00002906 visitInstruction(B);
2907}
2908
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002909void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002910 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002911 Type *Op0Ty = IC.getOperand(0)->getType();
2912 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002913 Assert(Op0Ty == Op1Ty,
2914 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002915 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002916 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2917 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002918 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002919 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2920 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2921 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002922
Reid Spencerd9436b62006-11-20 01:22:35 +00002923 visitInstruction(IC);
2924}
2925
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002926void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002927 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002928 Type *Op0Ty = FC.getOperand(0)->getType();
2929 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002930 Assert(Op0Ty == Op1Ty,
2931 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002932 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002933 Assert(Op0Ty->isFPOrFPVectorTy(),
2934 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002935 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002936 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2937 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2938 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002939
Reid Spencerd9436b62006-11-20 01:22:35 +00002940 visitInstruction(FC);
2941}
2942
Robert Bocchino23004482006-01-10 19:05:34 +00002943void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002944 Assert(
2945 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2946 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002947 visitInstruction(EI);
2948}
2949
Robert Bocchinoca27f032006-01-17 20:07:22 +00002950void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002951 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2952 IE.getOperand(2)),
2953 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002954 visitInstruction(IE);
2955}
2956
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002957void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002958 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2959 SV.getOperand(2)),
2960 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002961 visitInstruction(SV);
2962}
2963
Chris Lattner069a7952002-06-25 15:56:27 +00002964void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002965 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002966
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002967 Assert(isa<PointerType>(TargetTy),
2968 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002969 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002970 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002971 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002972 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002973 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002974
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002975 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002976 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002977 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002978
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002979 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002980 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002981 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2982 if (GEP.getPointerOperandType()->isVectorTy())
2983 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2984 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002985 for (Value *Idx : Idxs) {
2986 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002987 if (IndexTy->isVectorTy()) {
2988 unsigned IndexWidth = IndexTy->getVectorNumElements();
2989 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2990 }
2991 Assert(IndexTy->getScalarType()->isIntegerTy(),
2992 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002993 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002994 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002995 visitInstruction(GEP);
2996}
2997
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002998static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2999 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
3000}
3001
Sanjoy Das26f28a22016-11-09 19:36:39 +00003002void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
3003 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
Philip Reamesbf9676f2014-10-20 23:52:07 +00003004 "precondition violation");
3005
3006 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003007 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003008 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003009 Assert(NumRanges >= 1, "It should have at least one range!", Range);
3010
Philip Reamesbf9676f2014-10-20 23:52:07 +00003011 ConstantRange LastRange(1); // Dummy initial value
3012 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003013 ConstantInt *Low =
3014 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003015 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003016 ConstantInt *High =
3017 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003018 Assert(High, "The upper limit must be an integer!", High);
3019 Assert(High->getType() == Low->getType() && High->getType() == Ty,
3020 "Range types must match instruction type!", &I);
3021
Philip Reamesbf9676f2014-10-20 23:52:07 +00003022 APInt HighV = High->getValue();
3023 APInt LowV = Low->getValue();
3024 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003025 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
3026 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003027 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003028 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
3029 "Intervals are overlapping", Range);
3030 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3031 Range);
3032 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3033 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003034 }
3035 LastRange = ConstantRange(LowV, HighV);
3036 }
3037 if (NumRanges > 2) {
3038 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003039 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003040 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003041 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003042 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003043 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3044 "Intervals are overlapping", Range);
3045 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3046 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003047 }
3048}
3049
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003050void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3051 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003052 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3053 Assert(!(Size & (Size - 1)),
3054 "atomic memory access' operand must have a power-of-two size", Ty, I);
3055}
3056
Chris Lattner069a7952002-06-25 15:56:27 +00003057void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003058 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003059 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003060 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003061 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3062 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003063 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003064 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003065 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3066 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003067 "Load cannot have Release ordering", &LI);
3068 Assert(LI.getAlignment() != 0,
3069 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003070 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3071 ElTy->isFloatingPointTy(),
3072 "atomic load operand must have integer, pointer, or floating point "
3073 "type!",
3074 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003075 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003076 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003077 Assert(LI.getSynchScope() == CrossThread,
3078 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003079 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003080
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003081 visitInstruction(LI);
3082}
3083
Chris Lattner069a7952002-06-25 15:56:27 +00003084void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003085 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003086 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003087 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003088 Assert(ElTy == SI.getOperand(0)->getType(),
3089 "Stored value type does not match pointer operand type!", &SI, ElTy);
3090 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3091 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003092 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003093 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003094 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3095 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003096 "Store cannot have Acquire ordering", &SI);
3097 Assert(SI.getAlignment() != 0,
3098 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003099 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3100 ElTy->isFloatingPointTy(),
3101 "atomic store operand must have integer, pointer, or floating point "
3102 "type!",
3103 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003104 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003105 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003106 Assert(SI.getSynchScope() == CrossThread,
3107 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003108 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003109 visitInstruction(SI);
3110}
3111
Manman Ren9bfd0d02016-04-01 21:41:15 +00003112/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3113void Verifier::verifySwiftErrorCallSite(CallSite CS,
3114 const Value *SwiftErrorVal) {
3115 unsigned Idx = 0;
3116 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3117 I != E; ++I, ++Idx) {
3118 if (*I == SwiftErrorVal) {
3119 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3120 "swifterror value when used in a callsite should be marked "
3121 "with swifterror attribute",
3122 SwiftErrorVal, CS);
3123 }
3124 }
3125}
3126
3127void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3128 // Check that swifterror value is only used by loads, stores, or as
3129 // a swifterror argument.
3130 for (const User *U : SwiftErrorVal->users()) {
3131 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3132 isa<InvokeInst>(U),
3133 "swifterror value can only be loaded and stored from, or "
3134 "as a swifterror argument!",
3135 SwiftErrorVal, U);
3136 // If it is used by a store, check it is the second operand.
3137 if (auto StoreI = dyn_cast<StoreInst>(U))
3138 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3139 "swifterror value should be the second operand when used "
3140 "by stores", SwiftErrorVal, U);
3141 if (auto CallI = dyn_cast<CallInst>(U))
3142 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3143 if (auto II = dyn_cast<InvokeInst>(U))
3144 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3145 }
3146}
3147
Victor Hernandez8acf2952009-10-23 21:09:37 +00003148void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003149 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003150 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003151 Assert(PTy->getAddressSpace() == 0,
3152 "Allocation instruction pointer not in the generic address space!",
3153 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003154 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003155 "Cannot allocate unsized type", &AI);
3156 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3157 "Alloca array size must have integer type", &AI);
3158 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3159 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003160
Manman Ren9bfd0d02016-04-01 21:41:15 +00003161 if (AI.isSwiftError()) {
3162 verifySwiftErrorValue(&AI);
3163 }
3164
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003165 visitInstruction(AI);
3166}
3167
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003168void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003169
3170 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003171 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003172 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003173 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003174 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003175 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003176 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003177 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003178 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003179 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3180 "cmpxchg instructions failure argument shall be no stronger than the "
3181 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003182 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003183 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3184 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003185 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003186
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003187 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003188 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003189 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003190 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3191 "cmpxchg operand must have integer or pointer type",
3192 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003193 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003194 Assert(ElTy == CXI.getOperand(1)->getType(),
3195 "Expected value type does not match pointer operand type!", &CXI,
3196 ElTy);
3197 Assert(ElTy == CXI.getOperand(2)->getType(),
3198 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003199 visitInstruction(CXI);
3200}
3201
3202void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003203 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003204 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003205 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003206 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003207 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003208 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003209 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003210 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3211 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003212 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003213 Assert(ElTy == RMWI.getOperand(1)->getType(),
3214 "Argument value type does not match pointer operand type!", &RMWI,
3215 ElTy);
3216 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3217 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3218 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003219 visitInstruction(RMWI);
3220}
3221
Eli Friedmanfee02c62011-07-25 23:16:38 +00003222void Verifier::visitFenceInst(FenceInst &FI) {
3223 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003224 Assert(Ordering == AtomicOrdering::Acquire ||
3225 Ordering == AtomicOrdering::Release ||
3226 Ordering == AtomicOrdering::AcquireRelease ||
3227 Ordering == AtomicOrdering::SequentiallyConsistent,
3228 "fence instructions may only have acquire, release, acq_rel, or "
3229 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003230 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003231 visitInstruction(FI);
3232}
3233
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003234void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003235 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3236 EVI.getIndices()) == EVI.getType(),
3237 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003238
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003239 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003240}
3241
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003242void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003243 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3244 IVI.getIndices()) ==
3245 IVI.getOperand(1)->getType(),
3246 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003247
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003248 visitInstruction(IVI);
3249}
Chris Lattner0e851da2002-04-18 20:37:37 +00003250
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003251static Value *getParentPad(Value *EHPad) {
3252 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3253 return FPI->getParentPad();
3254
3255 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3256}
3257
David Majnemer85a549d2015-08-11 02:48:30 +00003258void Verifier::visitEHPadPredecessors(Instruction &I) {
3259 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003260
David Majnemer85a549d2015-08-11 02:48:30 +00003261 BasicBlock *BB = I.getParent();
3262 Function *F = BB->getParent();
3263
3264 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3265
3266 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3267 // The landingpad instruction defines its parent as a landing pad block. The
3268 // landing pad block may be branched to only by the unwind edge of an
3269 // invoke.
3270 for (BasicBlock *PredBB : predecessors(BB)) {
3271 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3272 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3273 "Block containing LandingPadInst must be jumped to "
3274 "only by the unwind edge of an invoke.",
3275 LPI);
3276 }
3277 return;
3278 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003279 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3280 if (!pred_empty(BB))
3281 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3282 "Block containg CatchPadInst must be jumped to "
3283 "only by its catchswitch.",
3284 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003285 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3286 "Catchswitch cannot unwind to one of its catchpads",
3287 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003288 return;
3289 }
David Majnemer85a549d2015-08-11 02:48:30 +00003290
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003291 // Verify that each pred has a legal terminator with a legal to/from EH
3292 // pad relationship.
3293 Instruction *ToPad = &I;
3294 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003295 for (BasicBlock *PredBB : predecessors(BB)) {
3296 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003297 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003298 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003299 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003300 "EH pad must be jumped to via an unwind edge", ToPad, II);
3301 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3302 FromPad = Bundle->Inputs[0];
3303 else
3304 FromPad = ConstantTokenNone::get(II->getContext());
3305 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003306 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003307 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3308 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3309 FromPad = CSI;
3310 } else {
3311 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3312 }
3313
3314 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003315 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003316 for (;; FromPad = getParentPad(FromPad)) {
3317 Assert(FromPad != ToPad,
3318 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3319 if (FromPad == ToPadParent) {
3320 // This is a legal unwind edge.
3321 break;
3322 }
3323 Assert(!isa<ConstantTokenNone>(FromPad),
3324 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003325 Assert(Seen.insert(FromPad).second,
3326 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003327 }
David Majnemer85a549d2015-08-11 02:48:30 +00003328 }
3329}
3330
3331void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003332 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3333 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003334 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3335 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003336
David Majnemer85a549d2015-08-11 02:48:30 +00003337 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003338
David Majnemer654e1302015-07-31 17:58:14 +00003339 if (!LandingPadResultTy)
3340 LandingPadResultTy = LPI.getType();
3341 else
3342 Assert(LandingPadResultTy == LPI.getType(),
3343 "The landingpad instruction should have a consistent result type "
3344 "inside a function.",
3345 &LPI);
3346
David Majnemer7fddecc2015-06-17 20:52:32 +00003347 Function *F = LPI.getParent()->getParent();
3348 Assert(F->hasPersonalityFn(),
3349 "LandingPadInst needs to be in a function with a personality.", &LPI);
3350
Bill Wendlingfae14752011-08-12 20:24:12 +00003351 // The landingpad instruction must be the first non-PHI instruction in the
3352 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003353 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3354 "LandingPadInst not the first non-PHI instruction in the block.",
3355 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003356
Duncan Sands86de1a62011-09-27 16:43:19 +00003357 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003358 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003359 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003360 Assert(isa<PointerType>(Clause->getType()),
3361 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003362 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003363 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3364 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3365 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003366 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003367 }
3368
Bill Wendlingfae14752011-08-12 20:24:12 +00003369 visitInstruction(LPI);
3370}
3371
David Majnemerba6665d2016-08-01 18:06:34 +00003372void Verifier::visitResumeInst(ResumeInst &RI) {
3373 Assert(RI.getFunction()->hasPersonalityFn(),
3374 "ResumeInst needs to be in a function with a personality.", &RI);
3375
3376 if (!LandingPadResultTy)
3377 LandingPadResultTy = RI.getValue()->getType();
3378 else
3379 Assert(LandingPadResultTy == RI.getValue()->getType(),
3380 "The resume instruction should have a consistent result type "
3381 "inside a function.",
3382 &RI);
3383
3384 visitTerminatorInst(RI);
3385}
3386
David Majnemer654e1302015-07-31 17:58:14 +00003387void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003388 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003389
David Majnemer654e1302015-07-31 17:58:14 +00003390 Function *F = BB->getParent();
3391 Assert(F->hasPersonalityFn(),
3392 "CatchPadInst needs to be in a function with a personality.", &CPI);
3393
David Majnemer8a1c45d2015-12-12 05:38:55 +00003394 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3395 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3396 CPI.getParentPad());
3397
David Majnemer654e1302015-07-31 17:58:14 +00003398 // The catchpad instruction must be the first non-PHI instruction in the
3399 // block.
3400 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003401 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003402
David Majnemerfe2f7f32016-02-29 22:56:36 +00003403 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003404 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003405}
3406
David Majnemer8a1c45d2015-12-12 05:38:55 +00003407void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3408 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3409 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3410 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003411
David Majnemer8a1c45d2015-12-12 05:38:55 +00003412 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003413}
3414
3415void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3416 BasicBlock *BB = CPI.getParent();
3417
David Majnemer654e1302015-07-31 17:58:14 +00003418 Function *F = BB->getParent();
3419 Assert(F->hasPersonalityFn(),
3420 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3421
3422 // The cleanuppad instruction must be the first non-PHI instruction in the
3423 // block.
3424 Assert(BB->getFirstNonPHI() == &CPI,
3425 "CleanupPadInst not the first non-PHI instruction in the block.",
3426 &CPI);
3427
David Majnemer8a1c45d2015-12-12 05:38:55 +00003428 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003429 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003430 "CleanupPadInst has an invalid parent.", &CPI);
3431
David Majnemerfe2f7f32016-02-29 22:56:36 +00003432 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003433 visitFuncletPadInst(CPI);
3434}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003435
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003436void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3437 User *FirstUser = nullptr;
3438 Value *FirstUnwindPad = nullptr;
3439 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003440 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003441
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003442 while (!Worklist.empty()) {
3443 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003444 Assert(Seen.insert(CurrentPad).second,
3445 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003446 Value *UnresolvedAncestorPad = nullptr;
3447 for (User *U : CurrentPad->users()) {
3448 BasicBlock *UnwindDest;
3449 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3450 UnwindDest = CRI->getUnwindDest();
3451 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3452 // We allow catchswitch unwind to caller to nest
3453 // within an outer pad that unwinds somewhere else,
3454 // because catchswitch doesn't have a nounwind variant.
3455 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3456 if (CSI->unwindsToCaller())
3457 continue;
3458 UnwindDest = CSI->getUnwindDest();
3459 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3460 UnwindDest = II->getUnwindDest();
3461 } else if (isa<CallInst>(U)) {
3462 // Calls which don't unwind may be found inside funclet
3463 // pads that unwind somewhere else. We don't *require*
3464 // such calls to be annotated nounwind.
3465 continue;
3466 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3467 // The unwind dest for a cleanup can only be found by
3468 // recursive search. Add it to the worklist, and we'll
3469 // search for its first use that determines where it unwinds.
3470 Worklist.push_back(CPI);
3471 continue;
3472 } else {
3473 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3474 continue;
3475 }
3476
3477 Value *UnwindPad;
3478 bool ExitsFPI;
3479 if (UnwindDest) {
3480 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003481 if (!cast<Instruction>(UnwindPad)->isEHPad())
3482 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003483 Value *UnwindParent = getParentPad(UnwindPad);
3484 // Ignore unwind edges that don't exit CurrentPad.
3485 if (UnwindParent == CurrentPad)
3486 continue;
3487 // Determine whether the original funclet pad is exited,
3488 // and if we are scanning nested pads determine how many
3489 // of them are exited so we can stop searching their
3490 // children.
3491 Value *ExitedPad = CurrentPad;
3492 ExitsFPI = false;
3493 do {
3494 if (ExitedPad == &FPI) {
3495 ExitsFPI = true;
3496 // Now we can resolve any ancestors of CurrentPad up to
3497 // FPI, but not including FPI since we need to make sure
3498 // to check all direct users of FPI for consistency.
3499 UnresolvedAncestorPad = &FPI;
3500 break;
3501 }
3502 Value *ExitedParent = getParentPad(ExitedPad);
3503 if (ExitedParent == UnwindParent) {
3504 // ExitedPad is the ancestor-most pad which this unwind
3505 // edge exits, so we can resolve up to it, meaning that
3506 // ExitedParent is the first ancestor still unresolved.
3507 UnresolvedAncestorPad = ExitedParent;
3508 break;
3509 }
3510 ExitedPad = ExitedParent;
3511 } while (!isa<ConstantTokenNone>(ExitedPad));
3512 } else {
3513 // Unwinding to caller exits all pads.
3514 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3515 ExitsFPI = true;
3516 UnresolvedAncestorPad = &FPI;
3517 }
3518
3519 if (ExitsFPI) {
3520 // This unwind edge exits FPI. Make sure it agrees with other
3521 // such edges.
3522 if (FirstUser) {
3523 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3524 "pad must have the same unwind "
3525 "dest",
3526 &FPI, U, FirstUser);
3527 } else {
3528 FirstUser = U;
3529 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003530 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3531 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3532 getParentPad(UnwindPad) == getParentPad(&FPI))
3533 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003534 }
3535 }
3536 // Make sure we visit all uses of FPI, but for nested pads stop as
3537 // soon as we know where they unwind to.
3538 if (CurrentPad != &FPI)
3539 break;
3540 }
3541 if (UnresolvedAncestorPad) {
3542 if (CurrentPad == UnresolvedAncestorPad) {
3543 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3544 // we've found an unwind edge that exits it, because we need to verify
3545 // all direct uses of FPI.
3546 assert(CurrentPad == &FPI);
3547 continue;
3548 }
3549 // Pop off the worklist any nested pads that we've found an unwind
3550 // destination for. The pads on the worklist are the uncles,
3551 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3552 // for all ancestors of CurrentPad up to but not including
3553 // UnresolvedAncestorPad.
3554 Value *ResolvedPad = CurrentPad;
3555 while (!Worklist.empty()) {
3556 Value *UnclePad = Worklist.back();
3557 Value *AncestorPad = getParentPad(UnclePad);
3558 // Walk ResolvedPad up the ancestor list until we either find the
3559 // uncle's parent or the last resolved ancestor.
3560 while (ResolvedPad != AncestorPad) {
3561 Value *ResolvedParent = getParentPad(ResolvedPad);
3562 if (ResolvedParent == UnresolvedAncestorPad) {
3563 break;
3564 }
3565 ResolvedPad = ResolvedParent;
3566 }
3567 // If the resolved ancestor search didn't find the uncle's parent,
3568 // then the uncle is not yet resolved.
3569 if (ResolvedPad != AncestorPad)
3570 break;
3571 // This uncle is resolved, so pop it from the worklist.
3572 Worklist.pop_back();
3573 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003574 }
3575 }
3576
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003577 if (FirstUnwindPad) {
3578 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3579 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3580 Value *SwitchUnwindPad;
3581 if (SwitchUnwindDest)
3582 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3583 else
3584 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3585 Assert(SwitchUnwindPad == FirstUnwindPad,
3586 "Unwind edges out of a catch must have the same unwind dest as "
3587 "the parent catchswitch",
3588 &FPI, FirstUser, CatchSwitch);
3589 }
3590 }
3591
3592 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003593}
3594
David Majnemer8a1c45d2015-12-12 05:38:55 +00003595void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003596 BasicBlock *BB = CatchSwitch.getParent();
3597
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003598 Function *F = BB->getParent();
3599 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003600 "CatchSwitchInst needs to be in a function with a personality.",
3601 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003602
David Majnemer8a1c45d2015-12-12 05:38:55 +00003603 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003604 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003605 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3606 "CatchSwitchInst not the first non-PHI instruction in the block.",
3607 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003608
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003609 auto *ParentPad = CatchSwitch.getParentPad();
3610 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3611 "CatchSwitchInst has an invalid parent.", ParentPad);
3612
David Majnemer8a1c45d2015-12-12 05:38:55 +00003613 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003614 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003615 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3616 "CatchSwitchInst must unwind to an EH block which is not a "
3617 "landingpad.",
3618 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003619
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003620 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3621 if (getParentPad(I) == ParentPad)
3622 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3623 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003624
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003625 Assert(CatchSwitch.getNumHandlers() != 0,
3626 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3627
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003628 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003629 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3630 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003631 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003632
David Majnemerfe2f7f32016-02-29 22:56:36 +00003633 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003634 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003635}
3636
David Majnemer654e1302015-07-31 17:58:14 +00003637void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003638 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3639 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3640 CRI.getOperand(0));
3641
David Majnemer654e1302015-07-31 17:58:14 +00003642 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3643 Instruction *I = UnwindDest->getFirstNonPHI();
3644 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3645 "CleanupReturnInst must unwind to an EH block which is not a "
3646 "landingpad.",
3647 &CRI);
3648 }
3649
3650 visitTerminatorInst(CRI);
3651}
3652
Rafael Espindola654320a2012-02-26 02:23:37 +00003653void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3654 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003655 // If the we have an invalid invoke, don't try to compute the dominance.
3656 // We already reject it in the invoke specific checks and the dominance
3657 // computation doesn't handle multiple edges.
3658 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3659 if (II->getNormalDest() == II->getUnwindDest())
3660 return;
3661 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003662
Michael Kruseff379b62016-03-26 23:32:57 +00003663 // Quick check whether the def has already been encountered in the same block.
3664 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3665 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003666 //
3667 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3668 // wrapping an SSA value, assert that we've already encountered it. See
3669 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003670 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3671 return;
3672
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003673 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003674 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003675 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003676}
3677
Artur Pilipenkocca80022015-10-09 17:41:29 +00003678void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3679 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3680 "apply only to pointer types", &I);
3681 Assert(isa<LoadInst>(I),
3682 "dereferenceable, dereferenceable_or_null apply only to load"
3683 " instructions, use attributes for calls or invokes", &I);
3684 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3685 "take one operand!", &I);
3686 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3687 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3688 "dereferenceable_or_null metadata value must be an i64!", &I);
3689}
3690
Misha Brukmanc566ca362004-03-02 00:22:19 +00003691/// verifyInstruction - Verify that an instruction is well formed.
3692///
Chris Lattner069a7952002-06-25 15:56:27 +00003693void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003694 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003695 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003696
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003697 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003698 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003699 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3700 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003701 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003702 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003703
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003704 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003705 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3706 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003707
Chris Lattner5f126b72004-03-29 00:29:36 +00003708 // Check that the return value of the instruction is either void or a legal
3709 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003710 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3711 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003712
Nick Lewycky93e06a52009-09-27 23:27:42 +00003713 // Check that the instruction doesn't produce metadata. Calls are already
3714 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003715 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3716 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003717
Chris Lattner0e851da2002-04-18 20:37:37 +00003718 // Check that all uses of the instruction, if they are instructions
3719 // themselves, actually have parent basic blocks. If the use is not an
3720 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003721 for (Use &U : I.uses()) {
3722 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003723 Assert(Used->getParent() != nullptr,
3724 "Instruction referencing"
3725 " instruction not embedded in a basic block!",
3726 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003727 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003728 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003729 return;
3730 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003731 }
3732
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003733 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003734 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003735
3736 // Check to make sure that only first-class-values are operands to
3737 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003738 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003739 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003740 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003741
Chris Lattner9ece94b2004-03-14 03:23:54 +00003742 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003743 // Check to make sure that the "address of" an intrinsic function is never
3744 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003745 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003746 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003747 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3748 "Cannot take the address of an intrinsic!", &I);
3749 Assert(
3750 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003751 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003752 F->getIntrinsicID() == Intrinsic::coro_resume ||
3753 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003754 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003755 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3756 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003757 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3758 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003759 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003760 Assert(F->getParent() == &M, "Referencing function in another module!",
3761 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003762 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003763 Assert(OpBB->getParent() == BB->getParent(),
3764 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003765 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003766 Assert(OpArg->getParent() == BB->getParent(),
3767 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003768 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003769 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3770 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003771 } else if (isa<Instruction>(I.getOperand(i))) {
3772 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003773 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003774 Assert((i + 1 == e && isa<CallInst>(I)) ||
3775 (i + 3 == e && isa<InvokeInst>(I)),
3776 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003777 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003778 if (CE->getType()->isPtrOrPtrVectorTy() ||
3779 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003780 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003781 // illegal bitcast. If the datalayout string specifies non-integral
3782 // address spaces then we also need to check for illegal ptrtoint and
3783 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003784 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003785 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003786 }
3787 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003788
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003789 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003790 Assert(I.getType()->isFPOrFPVectorTy(),
3791 "fpmath requires a floating point result!", &I);
3792 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003793 if (ConstantFP *CFP0 =
3794 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003795 const APFloat &Accuracy = CFP0->getValueAPF();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003796 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
Matt Arsenault82f41512016-06-27 19:43:15 +00003797 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003798 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3799 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003800 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003801 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003802 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003803 }
3804
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003805 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003806 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3807 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003808 visitRangeMetadata(I, Range, I.getType());
3809 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003810
Philip Reames0ca58b32014-10-21 20:56:29 +00003811 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003812 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3813 &I);
3814 Assert(isa<LoadInst>(I),
3815 "nonnull applies only to load instructions, use attributes"
3816 " for calls or invokes",
3817 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003818 }
3819
Artur Pilipenkocca80022015-10-09 17:41:29 +00003820 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3821 visitDereferenceableMetadata(I, MD);
3822
3823 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3824 visitDereferenceableMetadata(I, MD);
3825
Mehdi Aminia84a8402016-12-16 06:29:14 +00003826 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
3827 TBAAVerifyHelper.visitTBAAMetadata(I, TBAA);
Sanjoy Das2582e692016-11-08 20:46:01 +00003828
Artur Pilipenkocca80022015-10-09 17:41:29 +00003829 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3830 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3831 &I);
3832 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3833 "use attributes for calls or invokes", &I);
3834 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3835 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3836 Assert(CI && CI->getType()->isIntegerTy(64),
3837 "align metadata value must be an i64!", &I);
3838 uint64_t Align = CI->getZExtValue();
3839 Assert(isPowerOf2_64(Align),
3840 "align metadata value must be a power of 2!", &I);
3841 Assert(Align <= Value::MaximumAlignment,
3842 "alignment is larger that implementation defined limit", &I);
3843 }
3844
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003845 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003846 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003847 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003848 }
3849
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003850 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Adrian Prantl941fa752016-12-05 18:04:47 +00003851 verifyFragmentExpression(*DII);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003852
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003853 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003854}
3855
Philip Reames007561a2015-06-26 22:21:52 +00003856/// Allow intrinsics to be verified in different ways.
3857void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003858 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003859 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3860 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003861
Chris Lattner144b6192012-05-27 19:37:05 +00003862 // Verify that the intrinsic prototype lines up with what the .td files
3863 // describe.
3864 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003865 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003866
Chris Lattner144b6192012-05-27 19:37:05 +00003867 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3868 getIntrinsicInfoTableEntries(ID, Table);
3869 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003870
Chris Lattner144b6192012-05-27 19:37:05 +00003871 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003872 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3873 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003874 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003875 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003876 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3877 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003878 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003879
3880 // Verify if the intrinsic call matches the vararg property.
3881 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003882 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003883 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003884 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003885 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003886 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003887
3888 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003889 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003890
3891 // Now that we have the intrinsic ID and the actual argument types (and we
3892 // know they are legal for the intrinsic!) get the intrinsic name through the
3893 // usual means. This allows us to verify the mangling of argument types into
3894 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003895 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003896 Assert(ExpectedName == IF->getName(),
3897 "Intrinsic name not mangled correctly for type arguments! "
3898 "Should be: " +
3899 ExpectedName,
3900 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003901
Chris Lattner588096e2009-12-28 09:07:21 +00003902 // If the intrinsic takes MDNode arguments, verify that they are either global
3903 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003904 for (Value *V : CS.args())
3905 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3906 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003907
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003908 switch (ID) {
3909 default:
3910 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003911 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003912 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003913 if (isa<ConstantPointerNull>(InfoArg))
3914 break;
3915 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3916 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3917 "info argument of llvm.coro.begin must refer to an initialized "
3918 "constant");
3919 Constant *Init = GV->getInitializer();
3920 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3921 "info argument of llvm.coro.begin must refer to either a struct or "
3922 "an array");
3923 break;
3924 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003925 case Intrinsic::ctlz: // llvm.ctlz
3926 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003927 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003928 "is_zero_undef argument of bit counting intrinsics must be a "
3929 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003930 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003931 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003932 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003933 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3934 "invalid llvm.dbg.declare intrinsic call 1", CS);
3935 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003936 break;
3937 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003938 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003939 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003940 case Intrinsic::memcpy:
3941 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003942 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003943 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003944 Assert(AlignCI,
3945 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003946 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003947 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003948 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003949 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003950 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003951 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003952 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003953 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003954 }
Igor Laevsky4f31e522016-12-29 14:31:07 +00003955 case Intrinsic::memcpy_element_atomic: {
3956 ConstantInt *ElementSizeCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3957 Assert(ElementSizeCI, "element size of the element-wise atomic memory "
3958 "intrinsic must be a constant int",
3959 CS);
3960 const APInt &ElementSizeVal = ElementSizeCI->getValue();
3961 Assert(ElementSizeVal.isPowerOf2(),
3962 "element size of the element-wise atomic memory intrinsic "
3963 "must be a power of 2",
3964 CS);
3965
3966 auto IsValidAlignment = [&](uint64_t Alignment) {
3967 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
3968 };
3969
3970 uint64_t DstAlignment = CS.getParamAlignment(1),
3971 SrcAlignment = CS.getParamAlignment(2);
3972
3973 Assert(IsValidAlignment(DstAlignment),
3974 "incorrect alignment of the destination argument",
3975 CS);
3976 Assert(IsValidAlignment(SrcAlignment),
3977 "incorrect alignment of the source argument",
3978 CS);
3979 break;
3980 }
Bill Wendling05604e02008-08-23 09:46:46 +00003981 case Intrinsic::gcroot:
3982 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003983 case Intrinsic::gcread:
3984 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003985 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003986 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3987 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3988 Assert(isa<Constant>(CS.getArgOperand(1)),
3989 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003990 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003991 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003992 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3993 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003994 CS);
Talin2e59f142010-09-30 20:23:47 +00003995 }
Chris Lattner25852062008-08-24 20:46:13 +00003996 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003997
Philip Reames9818dd72015-06-26 22:04:34 +00003998 Assert(CS.getParent()->getParent()->hasGC(),
3999 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00004000 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00004001 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00004002 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004003 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00004004 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004005 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004006 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004007 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4008 isa<ConstantInt>(CS.getArgOperand(2)) &&
4009 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4010 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4011 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004012 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004013 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004014 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4015 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004016 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004017 case Intrinsic::lifetime_start:
4018 case Intrinsic::lifetime_end:
4019 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004020 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004021 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004022 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004023 break;
4024 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004025 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4026 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004027 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004028
Reid Kleckner60381792015-07-07 22:25:32 +00004029 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004030 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004031 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004032 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004033 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004034 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004035 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004036 if (isa<ConstantPointerNull>(Arg))
4037 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004038 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004039 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004040 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004041 }
Philip Reames9818dd72015-06-26 22:04:34 +00004042 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004043 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004044 break;
4045 }
Reid Kleckner60381792015-07-07 22:25:32 +00004046 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004047 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004048 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004049 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004050 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004051 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004052 CS);
4053 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004054 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004055 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004056 auto &Entry = FrameEscapeInfo[Fn];
4057 Entry.second = unsigned(
4058 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004059 break;
4060 }
4061
Philip Reames1ffa9372015-01-30 23:28:05 +00004062 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004063 Assert(!CS.isInlineAsm(),
4064 "gc.statepoint support for inline assembly unimplemented", CS);
4065 Assert(CS.getParent()->getParent()->hasGC(),
4066 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004067
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004068 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004069 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004070 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004071 Assert(CS.getParent()->getParent()->hasGC(),
4072 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004073 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004074 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004075 const Function *StatepointFn =
4076 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004077 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4078 StatepointFn->getIntrinsicID() ==
4079 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004080 "gc.result operand #1 must be from a statepoint", CS,
4081 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004082
Philip Reamesb23713a2014-12-03 22:23:24 +00004083 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004084 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004085 auto *PT = cast<PointerType>(Target->getType());
4086 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004087 Assert(CS.getType() == TargetFuncType->getReturnType(),
4088 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004089 break;
4090 }
4091 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004092 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004093
Philip Reames3e2cf532016-01-07 03:32:11 +00004094 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4095 "gc.relocate must return a pointer or a vector of pointers", CS);
4096
Igor Laevsky9570ff92015-02-19 11:28:47 +00004097 // Check that this relocate is correctly tied to the statepoint
4098
4099 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004100 if (LandingPadInst *LandingPad =
4101 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004102
Sanjoy Das5665c992015-05-11 23:47:27 +00004103 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004104 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004105
4106 // Landingpad relocates should have only one predecessor with invoke
4107 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004108 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004109 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004110 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4111 InvokeBB);
4112 Assert(isStatepoint(InvokeBB->getTerminator()),
4113 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004114 }
4115 else {
4116 // In all other cases relocate should be tied to the statepoint directly.
4117 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004118 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004119 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004120 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004121 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004122 }
4123
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004124 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004125
Manuel Jacob83eefa62016-01-05 04:03:00 +00004126 ImmutableCallSite StatepointCS(
4127 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004128
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004129 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004130 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004131 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004132 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004133
Philip Reames9818dd72015-06-26 22:04:34 +00004134 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004135 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004136 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004137
4138 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4139 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4140 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004141 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004142 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004143 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004144 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004145
4146 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004147 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004148 Assert(StatepointCS.arg_size() > 0,
4149 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004150 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004151 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004152 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004153 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4154 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004155 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004156 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004157 "gc.statepoint: number of transition arguments must be "
4158 "a constant integer");
4159 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004160 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4161 ->getZExtValue();
4162 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004163 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004164 "gc.statepoint: number of deoptimization arguments must be "
4165 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004166 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004167 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4168 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004169 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004170 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004171 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4172 "gc.relocate: statepoint base index doesn't fall within the "
4173 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004174 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004175 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4176 "gc.relocate: statepoint derived index doesn't fall within the "
4177 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004178 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004179
Philip Reames3e2cf532016-01-07 03:32:11 +00004180 // Relocated value must be either a pointer type or vector-of-pointer type,
4181 // but gc_relocate does not need to return the same pointer type as the
4182 // relocated pointer. It can be casted to the correct type later if it's
4183 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004184 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004185 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004186 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004187
Philip Reames3e2cf532016-01-07 03:32:11 +00004188 auto ResultType = CS.getType();
4189 auto DerivedType = Relocate.getDerivedPtr()->getType();
4190 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004191 "gc.relocate: vector relocates to vector and pointer to pointer",
4192 CS);
4193 Assert(
4194 ResultType->getPointerAddressSpace() ==
4195 DerivedType->getPointerAddressSpace(),
4196 "gc.relocate: relocating a pointer shouldn't change its address space",
4197 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004198 break;
4199 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004200 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004201 case Intrinsic::eh_exceptionpointer: {
4202 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4203 "eh.exceptionpointer argument must be a catchpad", CS);
4204 break;
4205 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004206 case Intrinsic::masked_load: {
4207 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4208
4209 Value *Ptr = CS.getArgOperand(0);
4210 //Value *Alignment = CS.getArgOperand(1);
4211 Value *Mask = CS.getArgOperand(2);
4212 Value *PassThru = CS.getArgOperand(3);
4213 Assert(Mask->getType()->isVectorTy(),
4214 "masked_load: mask must be vector", CS);
4215
4216 // DataTy is the overloaded type
4217 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4218 Assert(DataTy == CS.getType(),
4219 "masked_load: return must match pointer type", CS);
4220 Assert(PassThru->getType() == DataTy,
4221 "masked_load: pass through and data type must match", CS);
4222 Assert(Mask->getType()->getVectorNumElements() ==
4223 DataTy->getVectorNumElements(),
4224 "masked_load: vector mask must be same length as data", CS);
4225 break;
4226 }
4227 case Intrinsic::masked_store: {
4228 Value *Val = CS.getArgOperand(0);
4229 Value *Ptr = CS.getArgOperand(1);
4230 //Value *Alignment = CS.getArgOperand(2);
4231 Value *Mask = CS.getArgOperand(3);
4232 Assert(Mask->getType()->isVectorTy(),
4233 "masked_store: mask must be vector", CS);
4234
4235 // DataTy is the overloaded type
4236 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4237 Assert(DataTy == Val->getType(),
4238 "masked_store: storee must match pointer type", CS);
4239 Assert(Mask->getType()->getVectorNumElements() ==
4240 DataTy->getVectorNumElements(),
4241 "masked_store: vector mask must be same length as data", CS);
4242 break;
4243 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004244
Sanjoy Das021de052016-03-31 00:18:46 +00004245 case Intrinsic::experimental_guard: {
4246 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4247 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4248 "experimental_guard must have exactly one "
4249 "\"deopt\" operand bundle");
4250 break;
4251 }
4252
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004253 case Intrinsic::experimental_deoptimize: {
4254 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4255 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4256 "experimental_deoptimize must have exactly one "
4257 "\"deopt\" operand bundle");
4258 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4259 "experimental_deoptimize return type must match caller return type");
4260
4261 if (CS.isCall()) {
4262 auto *DeoptCI = CS.getInstruction();
4263 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4264 Assert(RI,
4265 "calls to experimental_deoptimize must be followed by a return");
4266
4267 if (!CS.getType()->isVoidTy() && RI)
4268 Assert(RI->getReturnValue() == DeoptCI,
4269 "calls to experimental_deoptimize must be followed by a return "
4270 "of the value computed by experimental_deoptimize");
4271 }
4272
4273 break;
4274 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004275 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004276}
4277
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004278/// \brief Carefully grab the subprogram from a local scope.
4279///
4280/// This carefully grabs the subprogram from a local scope, avoiding the
4281/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004282static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004283 if (!LocalScope)
4284 return nullptr;
4285
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004286 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004287 return SP;
4288
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004289 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004290 return getSubprogram(LB->getRawScope());
4291
4292 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004293 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004294 return nullptr;
4295}
4296
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004297template <class DbgIntrinsicTy>
4298void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4299 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004300 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004301 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4302 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004303 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004304 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4305 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004306 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004307 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4308 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004309
4310 // Ignore broken !dbg attachments; they're checked elsewhere.
4311 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004312 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004313 return;
4314
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004315 BasicBlock *BB = DII.getParent();
4316 Function *F = BB ? BB->getParent() : nullptr;
4317
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004318 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004319 DILocalVariable *Var = DII.getVariable();
4320 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004321 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4322 &DII, BB, F);
4323
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004324 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4325 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004326 if (!VarSP || !LocSP)
4327 return; // Broken scope chains are checked elsewhere.
4328
Adrian Prantla2ef0472016-09-14 17:30:37 +00004329 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4330 " variable and !dbg attachment",
4331 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4332 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004333}
4334
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004335static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004336 // Be careful of broken types (checked elsewhere).
4337 const Metadata *RawType = V.getRawType();
4338 while (RawType) {
4339 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004340 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004341 if (uint64_t Size = T->getSizeInBits())
4342 return Size;
4343
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004344 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004345 // Look at the base type.
4346 RawType = DT->getRawBaseType();
4347 continue;
4348 }
4349
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004350 // Missing type or size.
4351 break;
4352 }
4353
4354 // Fail gracefully.
4355 return 0;
4356}
4357
Adrian Prantl941fa752016-12-05 18:04:47 +00004358void Verifier::verifyFragmentExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004359 DILocalVariable *V;
4360 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004361 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004362 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4363 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004364 } else {
4365 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004366 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4367 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004368 }
4369
4370 // We don't know whether this intrinsic verified correctly.
4371 if (!V || !E || !E->isValid())
4372 return;
4373
Keno Fischer253a7bd2016-01-15 02:12:38 +00004374 // Nothing to do if this isn't a bit piece expression.
Adrian Prantl49797ca2016-12-22 05:27:12 +00004375 auto Fragment = E->getFragmentInfo();
4376 if (!Fragment)
Keno Fischer253a7bd2016-01-15 02:12:38 +00004377 return;
4378
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004379 // The frontend helps out GDB by emitting the members of local anonymous
4380 // unions as artificial local variables with shared storage. When SROA splits
4381 // the storage for artificial local variables that are smaller than the entire
4382 // union, the overhang piece will be outside of the allotted space for the
4383 // variable and this check fails.
4384 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4385 if (V->isArtificial())
4386 return;
4387
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004388 // If there's no size, the type is broken, but that should be checked
4389 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004390 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004391 if (!VarSize)
4392 return;
4393
Adrian Prantl49797ca2016-12-22 05:27:12 +00004394 unsigned FragSize = Fragment->SizeInBits;
4395 unsigned FragOffset = Fragment->OffsetInBits;
Adrian Prantl941fa752016-12-05 18:04:47 +00004396 AssertDI(FragSize + FragOffset <= VarSize,
4397 "fragment is larger than or outside of variable", &I, V, E);
4398 AssertDI(FragSize != VarSize, "fragment covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004399}
4400
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004401void Verifier::verifyCompileUnits() {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004402 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004403 SmallPtrSet<const Metadata *, 2> Listed;
4404 if (CUs)
4405 Listed.insert(CUs->op_begin(), CUs->op_end());
Adrian Prantla2ef0472016-09-14 17:30:37 +00004406 AssertDI(
David Majnemer0a16c222016-08-11 21:15:00 +00004407 all_of(CUVisited,
4408 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004409 "All DICompileUnits must be listed in llvm.dbg.cu");
4410 CUVisited.clear();
4411}
4412
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004413void Verifier::verifyDeoptimizeCallingConvs() {
4414 if (DeoptimizeDeclarations.empty())
4415 return;
4416
4417 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004418 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004419 Assert(First->getCallingConv() == F->getCallingConv(),
4420 "All llvm.experimental.deoptimize declarations must have the same "
4421 "calling convention",
4422 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004423 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004424}
4425
Chris Lattner0e851da2002-04-18 20:37:37 +00004426//===----------------------------------------------------------------------===//
4427// Implement the public interfaces to this file...
4428//===----------------------------------------------------------------------===//
4429
Chandler Carruth043949d2014-01-19 02:22:18 +00004430bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004431 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004432
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004433 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004434 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004435
4436 // Note that this function's return value is inverted from what you would
4437 // expect of a function called "verify".
4438 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004439}
4440
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004441bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4442 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004443 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004444 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004445
Chandler Carruth043949d2014-01-19 02:22:18 +00004446 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004447 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004448 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004449
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004450 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004451 if (BrokenDebugInfo)
4452 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004453 // Note that this function's return value is inverted from what you would
4454 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004455 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004456}
Chandler Carruth043949d2014-01-19 02:22:18 +00004457
4458namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004459
Chandler Carruth4d356312014-01-20 11:34:08 +00004460struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004461 static char ID;
4462
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004463 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004464 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004465
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004466 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004467 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004468 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004469 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004470 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004471 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004472 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004473 }
4474
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004475 bool doInitialization(Module &M) override {
4476 V = llvm::make_unique<Verifier>(
4477 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4478 return false;
4479 }
4480
Craig Topperf398d7c2014-03-05 06:35:38 +00004481 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004482 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004483 report_fatal_error("Broken function found, compilation aborted!");
4484
4485 return false;
4486 }
4487
Craig Topperf398d7c2014-03-05 06:35:38 +00004488 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004489 bool HasErrors = false;
4490 for (Function &F : M)
4491 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004492 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004493
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004494 HasErrors |= !V->verify();
Adrian Prantl94a903e2016-05-25 21:33:20 +00004495 if (FatalErrors) {
4496 if (HasErrors)
4497 report_fatal_error("Broken module found, compilation aborted!");
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004498 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
Adrian Prantl94a903e2016-05-25 21:33:20 +00004499 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004500
Adrian Prantl94a903e2016-05-25 21:33:20 +00004501 // Strip broken debug info.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004502 if (V->hasBrokenDebugInfo()) {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004503 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4504 M.getContext().diagnose(DiagInvalid);
4505 if (!StripDebugInfo(M))
4506 report_fatal_error("Failed to strip malformed debug info");
4507 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004508 return false;
4509 }
4510
4511 void getAnalysisUsage(AnalysisUsage &AU) const override {
4512 AU.setPreservesAll();
4513 }
4514};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004515
4516} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004517
Mehdi Aminia84a8402016-12-16 06:29:14 +00004518/// Helper to issue failure from the TBAA verification
4519template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
4520 if (Diagnostic)
4521 return Diagnostic->CheckFailed(Args...);
4522}
4523
4524#define AssertTBAA(C, ...) \
4525 do { \
4526 if (!(C)) { \
4527 CheckFailed(__VA_ARGS__); \
4528 return false; \
4529 } \
4530 } while (false)
4531
4532/// Verify that \p BaseNode can be used as the "base type" in the struct-path
4533/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
4534/// struct-type node describing an aggregate data structure (like a struct).
4535TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004536TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004537 if (BaseNode->getNumOperands() < 2) {
4538 CheckFailed("Base nodes must have at least two operands", &I, BaseNode);
4539 return {true, ~0u};
4540 }
4541
4542 auto Itr = TBAABaseNodes.find(BaseNode);
4543 if (Itr != TBAABaseNodes.end())
4544 return Itr->second;
4545
4546 auto Result = verifyTBAABaseNodeImpl(I, BaseNode);
4547 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
4548 (void)InsertResult;
4549 assert(InsertResult.second && "We just checked!");
4550 return Result;
4551}
4552
4553TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004554TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004555 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
4556
4557 if (BaseNode->getNumOperands() == 2) {
4558 // This is a scalar base node.
4559 if (!BaseNode->getOperand(0) || !BaseNode->getOperand(1)) {
4560 CheckFailed("Null operands in scalar type nodes!", &I, BaseNode);
4561 return InvalidNode;
4562 }
4563 if (!isa<MDNode>(BaseNode->getOperand(1))) {
4564 CheckFailed("Invalid parent operand in scalar TBAA node", &I, BaseNode);
4565 return InvalidNode;
4566 }
4567 if (!isa<MDString>(BaseNode->getOperand(0))) {
4568 CheckFailed("Invalid name operand in scalar TBAA node", &I, BaseNode);
4569 return InvalidNode;
4570 }
4571
4572 // Scalar nodes can only be accessed at offset 0.
4573 return {false, 0};
4574 }
4575
4576 if (BaseNode->getNumOperands() % 2 != 1) {
4577 CheckFailed("Struct tag nodes must have an odd number of operands!",
4578 BaseNode);
4579 return InvalidNode;
4580 }
4581
4582 bool Failed = false;
4583
4584 Optional<APInt> PrevOffset;
4585 unsigned BitWidth = ~0u;
4586
4587 // We've already checked that BaseNode is not a degenerate root node with one
4588 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
4589 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4590 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
4591 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
4592 if (!isa<MDNode>(FieldTy)) {
4593 CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode);
4594 Failed = true;
4595 continue;
4596 }
4597
4598 auto *OffsetEntryCI =
4599 mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset);
4600 if (!OffsetEntryCI) {
4601 CheckFailed("Offset entries must be constants!", &I, BaseNode);
4602 Failed = true;
4603 continue;
4604 }
4605
4606 if (BitWidth == ~0u)
4607 BitWidth = OffsetEntryCI->getBitWidth();
4608
4609 if (OffsetEntryCI->getBitWidth() != BitWidth) {
4610 CheckFailed(
4611 "Bitwidth between the offsets and struct type entries must match", &I,
4612 BaseNode);
4613 Failed = true;
4614 continue;
4615 }
4616
4617 // NB! As far as I can tell, we generate a non-strictly increasing offset
4618 // sequence only from structs that have zero size bit fields. When
4619 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
4620 // pick the field lexically the latest in struct type metadata node. This
4621 // mirrors the actual behavior of the alias analysis implementation.
4622 bool IsAscending =
4623 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
4624
4625 if (!IsAscending) {
4626 CheckFailed("Offsets must be increasing!", &I, BaseNode);
4627 Failed = true;
4628 }
4629
4630 PrevOffset = OffsetEntryCI->getValue();
4631 }
4632
4633 return Failed ? InvalidNode
4634 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
4635}
4636
4637static bool IsRootTBAANode(const MDNode *MD) {
4638 return MD->getNumOperands() < 2;
4639}
4640
4641static bool IsScalarTBAANodeImpl(const MDNode *MD,
4642 SmallPtrSetImpl<const MDNode *> &Visited) {
4643 if (MD->getNumOperands() == 2)
4644 return true;
4645
4646 if (MD->getNumOperands() != 3)
4647 return false;
4648
4649 auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
4650 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
4651 return false;
4652
4653 auto *Parent = dyn_cast<MDNode>(MD->getOperand(1));
4654 return Visited.insert(Parent).second &&
4655 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
4656}
4657
Sanjoy Das55f12d92016-12-29 15:46:57 +00004658bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
4659 auto ResultIt = TBAAScalarNodes.find(MD);
4660 if (ResultIt != TBAAScalarNodes.end())
4661 return ResultIt->second;
4662
Mehdi Aminia84a8402016-12-16 06:29:14 +00004663 SmallPtrSet<const MDNode *, 4> Visited;
Sanjoy Das55f12d92016-12-29 15:46:57 +00004664 bool Result = IsScalarTBAANodeImpl(MD, Visited);
4665 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
4666 (void)InsertResult;
4667 assert(InsertResult.second && "Just checked!");
4668
4669 return Result;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004670}
4671
4672/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
4673/// Offset in place to be the offset within the field node returned.
4674///
4675/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
4676MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I,
Sanjoy Das600d2a52016-12-29 15:47:01 +00004677 const MDNode *BaseNode,
Mehdi Aminia84a8402016-12-16 06:29:14 +00004678 APInt &Offset) {
4679 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
4680
4681 // Scalar nodes have only one possible "field" -- their parent in the access
4682 // hierarchy. Offset must be zero at this point, but our caller is supposed
4683 // to Assert that.
4684 if (BaseNode->getNumOperands() == 2)
4685 return cast<MDNode>(BaseNode->getOperand(1));
4686
4687 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4688 auto *OffsetEntryCI =
4689 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
4690 if (OffsetEntryCI->getValue().ugt(Offset)) {
4691 if (Idx == 1) {
4692 CheckFailed("Could not find TBAA parent in struct type node", &I,
4693 BaseNode, &Offset);
4694 return nullptr;
4695 }
4696
4697 auto *PrevOffsetEntryCI =
4698 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx - 1));
4699 Offset -= PrevOffsetEntryCI->getValue();
4700 return cast<MDNode>(BaseNode->getOperand(Idx - 2));
4701 }
4702 }
4703
4704 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
4705 BaseNode->getOperand(BaseNode->getNumOperands() - 1));
4706
4707 Offset -= LastOffsetEntryCI->getValue();
4708 return cast<MDNode>(BaseNode->getOperand(BaseNode->getNumOperands() - 2));
4709}
4710
Sanjoy Das600d2a52016-12-29 15:47:01 +00004711bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004712 AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) ||
Sanjoy Das600d2a52016-12-29 15:47:01 +00004713 isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) ||
4714 isa<AtomicCmpXchgInst>(I),
Mehdi Aminia84a8402016-12-16 06:29:14 +00004715 "TBAA is only for loads, stores and calls!", &I);
4716
4717 bool IsStructPathTBAA =
4718 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
4719
4720 AssertTBAA(
4721 IsStructPathTBAA,
4722 "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I);
4723
4724 AssertTBAA(MD->getNumOperands() < 5,
4725 "Struct tag metadata must have either 3 or 4 operands", &I, MD);
4726
4727 MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
4728 MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4729
4730 if (MD->getNumOperands() == 4) {
4731 auto *IsImmutableCI =
4732 mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(3));
4733 AssertTBAA(IsImmutableCI,
4734 "Immutability tag on struct tag metadata must be a constant", &I,
4735 MD);
4736 AssertTBAA(
4737 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
4738 "Immutability part of the struct tag metadata must be either 0 or 1",
4739 &I, MD);
4740 }
4741
4742 AssertTBAA(BaseNode && AccessType,
4743 "Malformed struct tag metadata: base and access-type "
4744 "should be non-null and point to Metadata nodes",
4745 &I, MD, BaseNode, AccessType);
4746
Sanjoy Das55f12d92016-12-29 15:46:57 +00004747 AssertTBAA(isValidScalarTBAANode(AccessType),
4748 "Access type node must be scalar", &I, MD, AccessType);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004749
4750 auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2));
4751 AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD);
4752
4753 APInt Offset = OffsetCI->getValue();
4754 bool SeenAccessTypeInPath = false;
4755
4756 SmallPtrSet<MDNode *, 4> StructPath;
4757
4758 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
4759 BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset)) {
4760 if (!StructPath.insert(BaseNode).second) {
4761 CheckFailed("Cycle detected in struct path", &I, MD);
4762 return false;
4763 }
4764
4765 bool Invalid;
4766 unsigned BaseNodeBitWidth;
4767 std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode);
4768
4769 // If the base node is invalid in itself, then we've already printed all the
4770 // errors we wanted to print.
4771 if (Invalid)
4772 return false;
4773
4774 SeenAccessTypeInPath |= BaseNode == AccessType;
4775
Sanjoy Das55f12d92016-12-29 15:46:57 +00004776 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004777 AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access",
4778 &I, MD, &Offset);
4779
4780 AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
4781 (BaseNodeBitWidth == 0 && Offset == 0),
4782 "Access bit-width not the same as description bit-width", &I, MD,
4783 BaseNodeBitWidth, Offset.getBitWidth());
4784 }
4785
4786 AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!",
4787 &I, MD);
4788 return true;
4789}
4790
Chandler Carruth4d356312014-01-20 11:34:08 +00004791char VerifierLegacyPass::ID = 0;
4792INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004793
4794FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004795 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004796}
4797
Chandler Carruthdab4eae2016-11-23 17:53:26 +00004798AnalysisKey VerifierAnalysis::Key;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004799VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4800 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004801 Result Res;
4802 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4803 return Res;
4804}
Chandler Carruth4d356312014-01-20 11:34:08 +00004805
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004806VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4807 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004808 return { llvm::verifyFunction(F, &dbgs()), false };
4809}
4810
4811PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4812 auto Res = AM.getResult<VerifierAnalysis>(M);
4813 if (FatalErrors) {
4814 if (Res.IRBroken)
4815 report_fatal_error("Broken module found, compilation aborted!");
4816 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4817 }
4818
4819 // Strip broken debug info.
4820 if (Res.DebugInfoBroken) {
4821 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4822 M.getContext().diagnose(DiagInvalid);
4823 if (!StripDebugInfo(M))
4824 report_fatal_error("Failed to strip malformed debug info");
4825 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004826 return PreservedAnalyses::all();
4827}
4828
Adrian Prantle3656182016-05-09 19:57:29 +00004829PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4830 auto res = AM.getResult<VerifierAnalysis>(F);
4831 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004832 report_fatal_error("Broken function found, compilation aborted!");
4833
4834 return PreservedAnalyses::all();
4835}