blob: 41593af000ca85340f4dc2cf9eaef9a78fb6f0e6 [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);
Andrew Kaylora0a11642017-01-26 23:27:59 +0000460 void visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000461 template <class DbgIntrinsicTy>
462 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000463 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
464 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
465 void visitFenceInst(FenceInst &FI);
466 void visitAllocaInst(AllocaInst &AI);
467 void visitExtractValueInst(ExtractValueInst &EVI);
468 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000469 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000470 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000471 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000472 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000473 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000474 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000475 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000476 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000477 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000478
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000479 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000480 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
481 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000482 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000483 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000484 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000485 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
486 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000487 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000488 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000489 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000490 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000491 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000492 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000493
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000494 void visitConstantExprsRecursively(const Constant *EntryC);
495 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000496 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000497 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000498 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000499
Adrian Prantl941fa752016-12-05 18:04:47 +0000500 void verifyFragmentExpression(const DbgInfoIntrinsic &I);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000501
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000502 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000503 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000504
505 /// Module-level verification that all @llvm.experimental.deoptimize
506 /// declarations share the same calling convention.
507 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000508};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000509
510} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000511
Adrian Prantl541a9c52016-05-06 19:26:47 +0000512/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000513#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000514 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000515
Adrian Prantl541a9c52016-05-06 19:26:47 +0000516/// We know that a debug info condition should be true, if not print
517/// an error message.
518#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000519 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000520
Chris Lattnere5a22c02008-08-28 04:02:44 +0000521void Verifier::visit(Instruction &I) {
522 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000523 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000524 InstVisitor<Verifier>::visit(I);
525}
526
Keno Fischer60f82a22016-01-14 22:20:56 +0000527// Helper to recursively iterate over indirect users. By
528// returning false, the callback can ask to stop recursing
529// further.
530static void forEachUser(const Value *User,
531 SmallPtrSet<const Value *, 32> &Visited,
532 llvm::function_ref<bool(const Value *)> Callback) {
533 if (!Visited.insert(User).second)
534 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000535 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000536 if (Callback(TheNextUser))
537 forEachUser(TheNextUser, Visited, Callback);
538}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000539
Chandler Carruth043949d2014-01-19 02:22:18 +0000540void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000541 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000542 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000543
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000544 Assert(GV.getAlignment() <= Value::MaximumAlignment,
545 "huge alignment values are unsupported", &GV);
546 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
547 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000548
549 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000550 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000551 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000552 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000553 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000554
555 if (GV.isDeclarationForLinker())
556 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000557
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000558 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000559 if (const Instruction *I = dyn_cast<Instruction>(V)) {
560 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000561 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
562 I);
563 else if (I->getParent()->getParent()->getParent() != &M)
564 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
565 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000566 I->getParent()->getParent()->getParent());
567 return false;
568 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000569 if (F->getParent() != &M)
570 CheckFailed("Global is used by function in a different module", &GV, &M,
571 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000572 return false;
573 }
574 return true;
575 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000576}
577
Chandler Carruth043949d2014-01-19 02:22:18 +0000578void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000579 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000580 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000581 "Global variable initializer type does not match global "
582 "variable type!",
583 &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000584 // If the global has common linkage, it must have a zero initializer and
585 // cannot be constant.
586 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000587 Assert(GV.getInitializer()->isNullValue(),
588 "'common' global must have a zero initializer!", &GV);
589 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
590 &GV);
591 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000592 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000593 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000594
Nick Lewycky466d0c12011-04-08 07:30:21 +0000595 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
596 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000597 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
598 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000599 // Don't worry about emitting an error for it not being an array,
600 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000601 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000602 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
603 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000604 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000605 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000606 Assert(STy &&
607 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
608 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
609 STy->getTypeAtIndex(1) == FuncPtrTy,
610 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000611 if (STy->getNumElements() == 3) {
612 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000613 Assert(ETy->isPointerTy() &&
614 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
615 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000616 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000617 }
618 }
619
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000620 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000621 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000622 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
623 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000624 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000625 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
626 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000627 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000628 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000629 const Constant *Init = GV.getInitializer();
630 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000631 Assert(InitArray, "wrong initalizer for intrinsic global variable",
632 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000633 for (Value *Op : InitArray->operands()) {
634 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000635 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
636 isa<GlobalAlias>(V),
637 "invalid llvm.used member", V);
638 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000639 }
640 }
641 }
642 }
643
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000644 Assert(!GV.hasDLLImportStorageClass() ||
645 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
646 GV.hasAvailableExternallyLinkage(),
647 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000648
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000649 // Visit any debug info attachments.
650 SmallVector<MDNode *, 1> MDs;
651 GV.getMetadata(LLVMContext::MD_dbg, MDs);
Adrian Prantldc6e0162016-12-20 02:33:30 +0000652 for (auto *MD : MDs) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000653 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
654 visitDIGlobalVariableExpression(*GVE);
655 else
656 AssertDI(false, "!dbg attachment of global variable must be a DIGlobalVariableExpression");
Adrian Prantldc6e0162016-12-20 02:33:30 +0000657 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000658
Matt Arsenault24b49c42013-07-31 17:49:08 +0000659 if (!GV.hasInitializer()) {
660 visitGlobalValue(GV);
661 return;
662 }
663
664 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000665 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000666
Chris Lattnere3400652004-12-15 20:23:49 +0000667 visitGlobalValue(GV);
668}
669
Rafael Espindola64c1e182014-06-03 02:41:57 +0000670void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
671 SmallPtrSet<const GlobalAlias*, 4> Visited;
672 Visited.insert(&GA);
673 visitAliaseeSubExpr(Visited, GA, C);
674}
675
Craig Topper71b7b682014-08-21 05:55:13 +0000676void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000677 const GlobalAlias &GA, const Constant &C) {
678 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000679 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
680 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000681
682 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000683 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000684
Sanjoy Das5ce32722016-04-08 00:48:30 +0000685 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000686 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000687 } else {
688 // Only continue verifying subexpressions of GlobalAliases.
689 // Do not recurse into global initializers.
690 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000691 }
692 }
693
694 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000695 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000696
697 for (const Use &U : C.operands()) {
698 Value *V = &*U;
699 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
700 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
701 else if (const auto *C2 = dyn_cast<Constant>(V))
702 visitAliaseeSubExpr(Visited, GA, *C2);
703 }
704}
705
Chandler Carruth043949d2014-01-19 02:22:18 +0000706void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000707 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
708 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
709 "weak_odr, or external linkage!",
710 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000711 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000712 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
713 Assert(GA.getType() == Aliasee->getType(),
714 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000715
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000716 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
717 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000718
Rafael Espindola64c1e182014-06-03 02:41:57 +0000719 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000720
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000721 visitGlobalValue(GA);
722}
723
Chandler Carruth043949d2014-01-19 02:22:18 +0000724void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000725 // There used to be various other llvm.dbg.* nodes, but we don't support
726 // upgrading them and we want to reserve the namespace for future uses.
727 if (NMD.getName().startswith("llvm.dbg."))
728 AssertDI(NMD.getName() == "llvm.dbg.cu",
729 "unrecognized named metadata node in the llvm.dbg namespace",
730 &NMD);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000731 for (const MDNode *MD : NMD.operands()) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000732 if (NMD.getName() == "llvm.dbg.cu")
Adrian Prantl541a9c52016-05-06 19:26:47 +0000733 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000734
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000735 if (!MD)
736 continue;
737
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000738 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000739 }
740}
741
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000742void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000743 // Only visit each node once. Metadata can be mutually recursive, so this
744 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000745 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000746 return;
747
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000748 switch (MD.getMetadataID()) {
749 default:
750 llvm_unreachable("Invalid MDNode subclass");
751 case Metadata::MDTupleKind:
752 break;
753#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
754 case Metadata::CLASS##Kind: \
755 visit##CLASS(cast<CLASS>(MD)); \
756 break;
757#include "llvm/IR/Metadata.def"
758 }
759
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000760 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000761 if (!Op)
762 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000763 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
764 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000765 if (auto *N = dyn_cast<MDNode>(Op)) {
766 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000767 continue;
768 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000769 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
770 visitValueAsMetadata(*V, nullptr);
771 continue;
772 }
Duncan Sands76d62172010-04-29 16:10:30 +0000773 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000774
775 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000776 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
777 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000778}
779
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000780void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000781 Assert(MD.getValue(), "Expected valid value", &MD);
782 Assert(!MD.getValue()->getType()->isMetadataTy(),
783 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000784
785 auto *L = dyn_cast<LocalAsMetadata>(&MD);
786 if (!L)
787 return;
788
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000789 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000790
791 // If this was an instruction, bb, or argument, verify that it is in the
792 // function that we expect.
793 Function *ActualF = nullptr;
794 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000795 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000796 ActualF = I->getParent()->getParent();
797 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
798 ActualF = BB->getParent();
799 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
800 ActualF = A->getParent();
801 assert(ActualF && "Unimplemented function local metadata case!");
802
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000803 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000804}
805
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000806void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000807 Metadata *MD = MDV.getMetadata();
808 if (auto *N = dyn_cast<MDNode>(MD)) {
809 visitMDNode(*N);
810 return;
811 }
812
813 // Only visit each node once. Metadata can be mutually recursive, so this
814 // avoids infinite recursion here, as well as being an optimization.
815 if (!MDNodes.insert(MD).second)
816 return;
817
818 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
819 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000820}
821
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000822static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
823static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
824static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000825
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000826template <class Ty>
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000827static bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000828 for (Metadata *MD : N.operands()) {
829 if (MD) {
830 if (!isa<Ty>(MD))
831 return false;
832 } else {
833 if (!AllowNull)
834 return false;
835 }
836 }
837 return true;
838}
839
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000840template <class Ty> static bool isValidMetadataArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000841 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
842}
843
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000844template <class Ty> static bool isValidMetadataNullArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000845 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
846}
847
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000848void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000849 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
850 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000851 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000852 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000853}
854
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000855void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000856 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000857}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000858
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000859void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000860 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000861 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000862}
863
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000864void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000865 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
866 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000867}
868
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000869void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000870 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000871}
872
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000873void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000874 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
875 N.getTag() == dwarf::DW_TAG_unspecified_type,
876 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000877}
878
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000879void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000880 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000881 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000882
Adrian Prantl541a9c52016-05-06 19:26:47 +0000883 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
884 N.getTag() == dwarf::DW_TAG_pointer_type ||
885 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
886 N.getTag() == dwarf::DW_TAG_reference_type ||
887 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
888 N.getTag() == dwarf::DW_TAG_const_type ||
889 N.getTag() == dwarf::DW_TAG_volatile_type ||
890 N.getTag() == dwarf::DW_TAG_restrict_type ||
Victor Leschuke1156c22016-10-31 19:09:38 +0000891 N.getTag() == dwarf::DW_TAG_atomic_type ||
Adrian Prantl541a9c52016-05-06 19:26:47 +0000892 N.getTag() == dwarf::DW_TAG_member ||
893 N.getTag() == dwarf::DW_TAG_inheritance ||
894 N.getTag() == dwarf::DW_TAG_friend,
895 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000896 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000897 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
898 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000899 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000900
Adrian Prantl541a9c52016-05-06 19:26:47 +0000901 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
902 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
903 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000904}
905
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000906static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000907 return (Flags & DINode::FlagLValueReference) &&
908 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000909}
910
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000911void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
912 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000913 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000914 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000915 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
916 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000917 }
918}
919
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000920void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000921 // Common scope checks.
922 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000923
Adrian Prantl541a9c52016-05-06 19:26:47 +0000924 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
925 N.getTag() == dwarf::DW_TAG_structure_type ||
926 N.getTag() == dwarf::DW_TAG_union_type ||
927 N.getTag() == dwarf::DW_TAG_enumeration_type ||
928 N.getTag() == dwarf::DW_TAG_class_type,
929 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000930
Adrian Prantl541a9c52016-05-06 19:26:47 +0000931 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
932 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
933 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000934
Adrian Prantl541a9c52016-05-06 19:26:47 +0000935 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
936 "invalid composite elements", &N, N.getRawElements());
937 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
938 N.getRawVTableHolder());
939 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
940 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000941 if (auto *Params = N.getRawTemplateParams())
942 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000943
944 if (N.getTag() == dwarf::DW_TAG_class_type ||
945 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000946 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
947 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000948 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000949}
950
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000951void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000952 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000953 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000954 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000955 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000956 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000957 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000958 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000959 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
960 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000961}
962
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000963void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000964 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Amjad Aboud7faeecc2016-12-25 10:12:09 +0000965 AssertDI((N.getChecksumKind() != DIFile::CSK_None ||
966 N.getChecksum().empty()), "invalid checksum kind", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000967}
968
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000969void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000970 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
971 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000972
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000973 // Don't bother verifying the compilation directory or producer string
974 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000975 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
976 N.getRawFile());
977 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
978 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000979
Adrian Prantl541a9c52016-05-06 19:26:47 +0000980 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
981 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000982
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000983 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000984 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000985 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000986 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000987 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
988 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000989 }
990 }
991 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000992 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000993 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000994 AssertDI(Op && (isa<DIType>(Op) ||
995 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000996 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000997 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000998 }
999 }
1000 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001001 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001002 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001003 AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)),
1004 "invalid global variable ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001005 }
1006 }
1007 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001008 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001009 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001010 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
1011 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001012 }
1013 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001014 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001015 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001016 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001017 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001018 }
1019 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +00001020 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001021}
1022
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001023void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001024 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1025 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +00001026 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001027 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001028 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001029 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1030 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1031 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001032 if (auto *Params = N.getRawTemplateParams())
1033 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001034 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001035 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1036 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001037 if (auto *RawVars = N.getRawVariables()) {
1038 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001039 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001040 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001041 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1042 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001043 }
1044 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001045 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1046 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001047
Adrian Prantl75819ae2016-04-15 15:57:41 +00001048 auto *Unit = N.getRawUnit();
1049 if (N.isDefinition()) {
1050 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001051 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1052 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1053 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001054 } else {
1055 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001056 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001057 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001058}
1059
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001060void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001061 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1062 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1063 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001064}
1065
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001066void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1067 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001068
Adrian Prantl541a9c52016-05-06 19:26:47 +00001069 AssertDI(N.getLine() || !N.getColumn(),
1070 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001071}
1072
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001073void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1074 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001075}
1076
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001077void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001078 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001079 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001080 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001081}
1082
Amjad Abouda9bcf162015-12-10 12:56:35 +00001083void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001084 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1085 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1086 "invalid macinfo type", &N);
1087 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001088 if (!N.getValue().empty()) {
1089 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1090 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001091}
1092
1093void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001094 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1095 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001096 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001097 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001098
1099 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001100 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001101 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001102 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001103 }
1104 }
1105}
1106
Adrian Prantlab1243f2015-06-29 23:03:47 +00001107void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001108 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1109 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001110}
1111
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001112void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001113 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001114}
1115
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001116void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1117 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001118
Adrian Prantl541a9c52016-05-06 19:26:47 +00001119 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1120 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001121}
1122
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001123void Verifier::visitDITemplateValueParameter(
1124 const DITemplateValueParameter &N) {
1125 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001126
Adrian Prantl541a9c52016-05-06 19:26:47 +00001127 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1128 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1129 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1130 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001131}
1132
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001133void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001134 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001135 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1136 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001137 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001138 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001139}
1140
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001141void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001142 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001143 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001144
Adrian Prantl541a9c52016-05-06 19:26:47 +00001145 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1146 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001147 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001148 AssertDI(isa<DIDerivedType>(Member),
1149 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001150 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001151}
1152
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001153void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001154 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001155 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001156
Adrian Prantl541a9c52016-05-06 19:26:47 +00001157 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1158 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1159 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001160}
1161
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001162void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001163 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001164}
1165
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001166void Verifier::visitDIGlobalVariableExpression(
1167 const DIGlobalVariableExpression &GVE) {
1168 AssertDI(GVE.getVariable(), "missing variable");
1169 if (auto *Var = GVE.getVariable())
1170 visitDIGlobalVariable(*Var);
1171 if (auto *Expr = GVE.getExpression())
1172 visitDIExpression(*Expr);
1173}
1174
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001175void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001176 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001177 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001178 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001179 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001180 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001181}
1182
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001183void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001184 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1185 N.getTag() == dwarf::DW_TAG_imported_declaration,
1186 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001187 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001188 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1189 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1190 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001191}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001192
David Majnemerdad0a642014-06-27 18:19:56 +00001193void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001194 // The Module is invalid if the GlobalValue has private linkage. Entities
1195 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001196 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001197 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1198 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001199}
1200
Chandler Carruth043949d2014-01-19 02:22:18 +00001201void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001202 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1203 if (!Idents)
1204 return;
1205
1206 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1207 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001208 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001209 Assert(N->getNumOperands() == 1,
1210 "incorrect number of operands in llvm.ident metadata", N);
1211 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1212 ("invalid value for llvm.ident metadata entry operand"
1213 "(the operand should be a string)"),
1214 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001215 }
1216}
1217
Chandler Carruth043949d2014-01-19 02:22:18 +00001218void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001219 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1220 if (!Flags) return;
1221
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001222 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001223 DenseMap<const MDString*, const MDNode*> SeenIDs;
1224 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001225 for (const MDNode *MDN : Flags->operands())
1226 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001227
1228 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001229 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001230 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001231 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001232
Chandler Carruth043949d2014-01-19 02:22:18 +00001233 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001234 if (!Op) {
1235 CheckFailed("invalid requirement on flag, flag is not present in module",
1236 Flag);
1237 continue;
1238 }
1239
1240 if (Op->getOperand(2) != ReqValue) {
1241 CheckFailed(("invalid requirement on flag, "
1242 "flag does not have the required value"),
1243 Flag);
1244 continue;
1245 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001246 }
1247}
1248
Chandler Carruth043949d2014-01-19 02:22:18 +00001249void
1250Verifier::visitModuleFlag(const MDNode *Op,
1251 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1252 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001253 // Each module flag should have three arguments, the merge behavior (a
1254 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001255 Assert(Op->getNumOperands() == 3,
1256 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001257 Module::ModFlagBehavior MFB;
1258 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001259 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001260 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001261 "invalid behavior operand in module flag (expected constant integer)",
1262 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001263 Assert(false,
1264 "invalid behavior operand in module flag (unexpected constant)",
1265 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001266 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001267 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001268 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1269 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001270
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001271 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001272 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001273 case Module::Error:
1274 case Module::Warning:
1275 case Module::Override:
1276 // These behavior types accept any value.
1277 break;
1278
1279 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001280 // The value should itself be an MDNode with two operands, a flag ID (an
1281 // MDString), and a value.
1282 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001283 Assert(Value && Value->getNumOperands() == 2,
1284 "invalid value for 'require' module flag (expected metadata pair)",
1285 Op->getOperand(2));
1286 Assert(isa<MDString>(Value->getOperand(0)),
1287 ("invalid value for 'require' module flag "
1288 "(first value operand should be a string)"),
1289 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001290
1291 // Append it to the list of requirements, to check once all module flags are
1292 // scanned.
1293 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001294 break;
1295 }
1296
1297 case Module::Append:
1298 case Module::AppendUnique: {
1299 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001300 Assert(isa<MDNode>(Op->getOperand(2)),
1301 "invalid value for 'append'-type module flag "
1302 "(expected a metadata node)",
1303 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001304 break;
1305 }
1306 }
1307
1308 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001309 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001310 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001311 Assert(Inserted,
1312 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001313 }
1314}
1315
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001316void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001317 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001318 unsigned Slot = ~0U;
1319 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1320 if (Attrs.getSlotIndex(I) == Idx) {
1321 Slot = I;
1322 break;
1323 }
1324
1325 assert(Slot != ~0U && "Attribute set inconsistency!");
1326
1327 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1328 I != E; ++I) {
1329 if (I->isStringAttribute())
1330 continue;
1331
1332 if (I->getKindAsEnum() == Attribute::NoReturn ||
1333 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001334 I->getKindAsEnum() == Attribute::NoInline ||
1335 I->getKindAsEnum() == Attribute::AlwaysInline ||
1336 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1337 I->getKindAsEnum() == Attribute::StackProtect ||
1338 I->getKindAsEnum() == Attribute::StackProtectReq ||
1339 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001340 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001341 I->getKindAsEnum() == Attribute::NoRedZone ||
1342 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1343 I->getKindAsEnum() == Attribute::Naked ||
1344 I->getKindAsEnum() == Attribute::InlineHint ||
1345 I->getKindAsEnum() == Attribute::StackAlignment ||
1346 I->getKindAsEnum() == Attribute::UWTable ||
1347 I->getKindAsEnum() == Attribute::NonLazyBind ||
1348 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1349 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1350 I->getKindAsEnum() == Attribute::SanitizeThread ||
1351 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1352 I->getKindAsEnum() == Attribute::MinSize ||
1353 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001354 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001355 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001356 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001357 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001358 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001359 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001360 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001361 I->getKindAsEnum() == Attribute::NoRecurse ||
1362 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001363 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1364 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001365 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001366 CheckFailed("Attribute '" + I->getAsString() +
1367 "' only applies to functions!", V);
1368 return;
1369 }
1370 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001371 I->getKindAsEnum() == Attribute::WriteOnly ||
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001372 I->getKindAsEnum() == Attribute::ReadNone) {
1373 if (Idx == 0) {
1374 CheckFailed("Attribute '" + I->getAsString() +
1375 "' does not apply to function returns");
1376 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001377 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001378 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001379 CheckFailed("Attribute '" + I->getAsString() +
1380 "' does not apply to functions!", V);
1381 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001382 }
1383 }
1384}
1385
Duncan Sandsc3a79922009-06-11 08:11:03 +00001386// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001387// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001388void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001389 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001390 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001391 return;
1392
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001393 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001394
Bill Wendling908126a2012-10-09 09:51:10 +00001395 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001396 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1397 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1398 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1399 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1400 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001401 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001402 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1403 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001404 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001405 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001406 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001407 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001408
Reid Klecknera534a382013-12-19 02:14:12 +00001409 // Check for mutually incompatible attributes. Only inreg is compatible with
1410 // sret.
1411 unsigned AttrCount = 0;
1412 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1413 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1414 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1415 Attrs.hasAttribute(Idx, Attribute::InReg);
1416 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001417 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1418 "and 'sret' are incompatible!",
1419 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001420
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001421 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1422 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1423 "Attributes "
1424 "'inalloca and readonly' are incompatible!",
1425 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001426
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001427 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1428 Attrs.hasAttribute(Idx, Attribute::Returned)),
1429 "Attributes "
1430 "'sret and returned' are incompatible!",
1431 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001432
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001433 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1434 Attrs.hasAttribute(Idx, Attribute::SExt)),
1435 "Attributes "
1436 "'zeroext and signext' are incompatible!",
1437 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001438
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001439 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1440 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1441 "Attributes "
1442 "'readnone and readonly' are incompatible!",
1443 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001444
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001445 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1446 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1447 "Attributes "
1448 "'readnone and writeonly' are incompatible!",
1449 V);
1450
1451 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1452 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1453 "Attributes "
1454 "'readonly and writeonly' are incompatible!",
1455 V);
1456
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001457 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1458 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1459 "Attributes "
1460 "'noinline and alwaysinline' are incompatible!",
1461 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001462
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001463 Assert(
1464 !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)),
1465 "Wrong types for attribute: " +
1466 AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty))
1467 .getAsString(Idx),
1468 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001469
Reid Klecknera534a382013-12-19 02:14:12 +00001470 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001471 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001472 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001473 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1474 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1475 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1476 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001477 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001478 if (!isa<PointerType>(PTy->getElementType()))
1479 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1480 "Attribute 'swifterror' only applies to parameters "
1481 "with pointer to pointer type!",
1482 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001483 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001484 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1485 "Attribute 'byval' only applies to parameters with pointer type!",
1486 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001487 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1488 "Attribute 'swifterror' only applies to parameters "
1489 "with pointer type!",
1490 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001491 }
Duncan Sands0009c442008-01-12 16:42:01 +00001492}
1493
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001494// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001495// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001496void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001497 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001498 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001499 return;
1500
Duncan Sands8c582282007-12-21 19:19:01 +00001501 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001502 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001503 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001504 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001505 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001506
Chris Lattner8a923e72008-03-12 17:45:29 +00001507 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001508 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001509
Chris Lattner229907c2011-07-18 04:54:35 +00001510 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001511 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001512 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001513 else if (Idx-1 < FT->getNumParams())
1514 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001515 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001516 break; // VarArgs attributes, verified elsewhere.
1517
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001518 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001519
Stephen Linb8bd2322013-04-20 05:14:40 +00001520 if (Idx == 0)
1521 continue;
1522
1523 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001524 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001525 SawNest = true;
1526 }
1527
Stephen Linb8bd2322013-04-20 05:14:40 +00001528 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001529 Assert(!SawReturned, "More than one parameter has attribute returned!",
1530 V);
1531 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1532 "Incompatible "
1533 "argument and return types for 'returned' attribute",
1534 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001535 SawReturned = true;
1536 }
1537
Reid Kleckner79418562014-05-09 22:32:13 +00001538 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001539 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1540 Assert(Idx == 1 || Idx == 2,
1541 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001542 SawSRet = true;
1543 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001544
Manman Renf46262e2016-03-29 17:37:21 +00001545 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1546 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1547 SawSwiftSelf = true;
1548 }
1549
Manman Ren9bfd0d02016-04-01 21:41:15 +00001550 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1551 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1552 V);
1553 SawSwiftError = true;
1554 }
1555
Reid Kleckner60d3a832014-01-16 22:59:24 +00001556 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001557 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1558 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001559 }
Duncan Sands8c582282007-12-21 19:19:01 +00001560 }
Devang Patel9cc98122008-10-01 23:41:25 +00001561
Bill Wendling77543892013-01-18 21:11:39 +00001562 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1563 return;
1564
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001565 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001566
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001567 Assert(
1568 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1569 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1570 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001571
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001572 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001573 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001574 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1575 "Attributes 'readnone and writeonly' are incompatible!", V);
1576
1577 Assert(
1578 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1579 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1580 "Attributes 'readonly and writeonly' are incompatible!", V);
1581
1582 Assert(
1583 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001584 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1585 Attribute::InaccessibleMemOrArgMemOnly)),
1586 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1587
1588 Assert(
1589 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1590 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1591 Attribute::InaccessibleMemOnly)),
1592 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1593
1594 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001595 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1596 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1597 Attribute::AlwaysInline)),
1598 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001599
1600 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1601 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001602 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1603 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001604
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001605 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1606 Attribute::OptimizeForSize),
1607 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001608
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001609 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1610 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001611 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001612
1613 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1614 Attribute::JumpTable)) {
1615 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001616 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001617 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001618 }
George Burgess IV278199f2016-04-12 01:05:35 +00001619
1620 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1621 std::pair<unsigned, Optional<unsigned>> Args =
1622 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1623
1624 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1625 if (ParamNo >= FT->getNumParams()) {
1626 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1627 return false;
1628 }
1629
1630 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1631 CheckFailed("'allocsize' " + Name +
1632 " argument must refer to an integer parameter",
1633 V);
1634 return false;
1635 }
1636
1637 return true;
1638 };
1639
1640 if (!CheckParam("element size", Args.first))
1641 return;
1642
1643 if (Args.second && !CheckParam("number of elements", *Args.second))
1644 return;
1645 }
Duncan Sands8c582282007-12-21 19:19:01 +00001646}
1647
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001648void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001649 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001650 for (const auto &Pair : MDs) {
1651 if (Pair.first == LLVMContext::MD_prof) {
1652 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001653 Assert(MD->getNumOperands() == 2,
1654 "!prof annotations should have exactly 2 operands", MD);
1655
1656 // Check first operand.
1657 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1658 MD);
1659 Assert(isa<MDString>(MD->getOperand(0)),
1660 "expected string with name of the !prof annotation", MD);
1661 MDString *MDS = cast<MDString>(MD->getOperand(0));
1662 StringRef ProfName = MDS->getString();
1663 Assert(ProfName.equals("function_entry_count"),
1664 "first operand should be 'function_entry_count'", MD);
1665
1666 // Check second operand.
1667 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1668 MD);
1669 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1670 "expected integer argument to function_entry_count", MD);
1671 }
1672 }
1673}
1674
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001675void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1676 if (!ConstantExprVisited.insert(EntryC).second)
1677 return;
1678
1679 SmallVector<const Constant *, 16> Stack;
1680 Stack.push_back(EntryC);
1681
1682 while (!Stack.empty()) {
1683 const Constant *C = Stack.pop_back_val();
1684
1685 // Check this constant expression.
1686 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1687 visitConstantExpr(CE);
1688
Keno Fischerf6d17b92016-01-14 22:42:02 +00001689 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1690 // Global Values get visited separately, but we do need to make sure
1691 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001692 Assert(GV->getParent() == &M, "Referencing global in another module!",
1693 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001694 continue;
1695 }
1696
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001697 // Visit all sub-expressions.
1698 for (const Use &U : C->operands()) {
1699 const auto *OpC = dyn_cast<Constant>(U);
1700 if (!OpC)
1701 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001702 if (!ConstantExprVisited.insert(OpC).second)
1703 continue;
1704 Stack.push_back(OpC);
1705 }
1706 }
1707}
1708
1709void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001710 if (CE->getOpcode() == Instruction::BitCast)
1711 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1712 CE->getType()),
1713 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001714
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001715 if (CE->getOpcode() == Instruction::IntToPtr ||
1716 CE->getOpcode() == Instruction::PtrToInt) {
1717 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1718 ? CE->getType()
1719 : CE->getOperand(0)->getType();
1720 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1721 ? "inttoptr not supported for non-integral pointers"
1722 : "ptrtoint not supported for non-integral pointers";
1723 Assert(
1724 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1725 Msg);
1726 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001727}
1728
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001729bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001730 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001731 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001732
Devang Patel82fed672008-09-23 22:35:17 +00001733 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001734 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001735 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001736 || (LastIndex == AttributeSet::FunctionIndex
1737 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001738 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001739
Devang Patel82fed672008-09-23 22:35:17 +00001740 return false;
1741}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001742
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001743/// Verify that statepoint intrinsic is well formed.
1744void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001745 assert(CS.getCalledFunction() &&
1746 CS.getCalledFunction()->getIntrinsicID() ==
1747 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001748
Philip Reames0285c742015-02-03 23:18:47 +00001749 const Instruction &CI = *CS.getInstruction();
1750
Igor Laevsky39d662f2015-07-11 10:30:36 +00001751 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1752 !CS.onlyAccessesArgMemory(),
1753 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001754 "reordering restrictions required by safepoint semantics",
1755 &CI);
1756
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001757 const Value *IDV = CS.getArgument(0);
1758 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1759 &CI);
1760
1761 const Value *NumPatchBytesV = CS.getArgument(1);
1762 Assert(isa<ConstantInt>(NumPatchBytesV),
1763 "gc.statepoint number of patchable bytes must be a constant integer",
1764 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001765 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001766 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1767 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1768 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1769 "positive",
1770 &CI);
1771
1772 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001773 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001774 Assert(PT && PT->getElementType()->isFunctionTy(),
1775 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001776 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001777
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001778 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001779 Assert(isa<ConstantInt>(NumCallArgsV),
1780 "gc.statepoint number of arguments to underlying call "
1781 "must be constant integer",
1782 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001783 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001784 Assert(NumCallArgs >= 0,
1785 "gc.statepoint number of arguments to underlying call "
1786 "must be positive",
1787 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001788 const int NumParams = (int)TargetFuncType->getNumParams();
1789 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001790 Assert(NumCallArgs >= NumParams,
1791 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001792
1793 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001794 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1795 "gc.statepoint doesn't support wrapping non-void "
1796 "vararg functions yet",
1797 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001798 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001799 Assert(NumCallArgs == NumParams,
1800 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001801
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001802 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001803 Assert(isa<ConstantInt>(FlagsV),
1804 "gc.statepoint flags must be constant integer", &CI);
1805 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1806 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1807 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001808
1809 // Verify that the types of the call parameter arguments match
1810 // the type of the wrapped callee.
1811 for (int i = 0; i < NumParams; i++) {
1812 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001813 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001814 Assert(ArgType == ParamType,
1815 "gc.statepoint call argument does not match wrapped "
1816 "function type",
1817 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001818 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001819
1820 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001821
1822 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1823 Assert(isa<ConstantInt>(NumTransitionArgsV),
1824 "gc.statepoint number of transition arguments "
1825 "must be constant integer",
1826 &CI);
1827 const int NumTransitionArgs =
1828 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1829 Assert(NumTransitionArgs >= 0,
1830 "gc.statepoint number of transition arguments must be positive", &CI);
1831 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1832
1833 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001834 Assert(isa<ConstantInt>(NumDeoptArgsV),
1835 "gc.statepoint number of deoptimization arguments "
1836 "must be constant integer",
1837 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001838 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001839 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1840 "must be positive",
1841 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001842
Pat Gavlincc0431d2015-05-08 18:07:42 +00001843 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001844 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001845 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001846 "gc.statepoint too few arguments according to length fields", &CI);
1847
Philip Reames1ffa9372015-01-30 23:28:05 +00001848 // Check that the only uses of this gc.statepoint are gc.result or
1849 // gc.relocate calls which are tied to this statepoint and thus part
1850 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001851 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001852 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001853 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001854 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001855 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001856 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001857 "of a gc.statepoint",
1858 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001859 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001860 Assert(Call->getArgOperand(0) == &CI,
1861 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001862 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001863 Assert(Call->getArgOperand(0) == &CI,
1864 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001865 }
1866 }
1867
1868 // Note: It is legal for a single derived pointer to be listed multiple
1869 // times. It's non-optimal, but it is legal. It can also happen after
1870 // insertion if we strip a bitcast away.
1871 // Note: It is really tempting to check that each base is relocated and
1872 // that a derived pointer is never reused as a base pointer. This turns
1873 // out to be problematic since optimizations run after safepoint insertion
1874 // can recognize equality properties that the insertion logic doesn't know
1875 // about. See example statepoint.ll in the verifier subdirectory
1876}
1877
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001878void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001879 for (auto &Counts : FrameEscapeInfo) {
1880 Function *F = Counts.first;
1881 unsigned EscapedObjectCount = Counts.second.first;
1882 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001883 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001884 "all indices passed to llvm.localrecover must be less than the "
1885 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001886 "function",
1887 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001888 }
1889}
1890
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001891static Instruction *getSuccPad(TerminatorInst *Terminator) {
1892 BasicBlock *UnwindDest;
1893 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1894 UnwindDest = II->getUnwindDest();
1895 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1896 UnwindDest = CSI->getUnwindDest();
1897 else
1898 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1899 return UnwindDest->getFirstNonPHI();
1900}
1901
1902void Verifier::verifySiblingFuncletUnwinds() {
1903 SmallPtrSet<Instruction *, 8> Visited;
1904 SmallPtrSet<Instruction *, 8> Active;
1905 for (const auto &Pair : SiblingFuncletInfo) {
1906 Instruction *PredPad = Pair.first;
1907 if (Visited.count(PredPad))
1908 continue;
1909 Active.insert(PredPad);
1910 TerminatorInst *Terminator = Pair.second;
1911 do {
1912 Instruction *SuccPad = getSuccPad(Terminator);
1913 if (Active.count(SuccPad)) {
1914 // Found a cycle; report error
1915 Instruction *CyclePad = SuccPad;
1916 SmallVector<Instruction *, 8> CycleNodes;
1917 do {
1918 CycleNodes.push_back(CyclePad);
1919 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1920 if (CycleTerminator != CyclePad)
1921 CycleNodes.push_back(CycleTerminator);
1922 CyclePad = getSuccPad(CycleTerminator);
1923 } while (CyclePad != SuccPad);
1924 Assert(false, "EH pads can't handle each other's exceptions",
1925 ArrayRef<Instruction *>(CycleNodes));
1926 }
1927 // Don't re-walk a node we've already checked
1928 if (!Visited.insert(SuccPad).second)
1929 break;
1930 // Walk to this successor if it has a map entry.
1931 PredPad = SuccPad;
1932 auto TermI = SiblingFuncletInfo.find(PredPad);
1933 if (TermI == SiblingFuncletInfo.end())
1934 break;
1935 Terminator = TermI->second;
1936 Active.insert(PredPad);
1937 } while (true);
1938 // Each node only has one successor, so we've walked all the active
1939 // nodes' successors.
1940 Active.clear();
1941 }
1942}
1943
Chris Lattner0e851da2002-04-18 20:37:37 +00001944// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001945//
Chandler Carruth043949d2014-01-19 02:22:18 +00001946void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001947 visitGlobalValue(F);
1948
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001949 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001950 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001951 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001952
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001953 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001954 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001955
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001956 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1957 Assert(FT->getNumParams() == NumArgs,
1958 "# formal arguments must match # of arguments for function type!", &F,
1959 FT);
1960 Assert(F.getReturnType()->isFirstClassType() ||
1961 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1962 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001963
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001964 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1965 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001966
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001967 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001968
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001969 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001970 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001971
Duncan Sands8c582282007-12-21 19:19:01 +00001972 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001973 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001974
Michael Gottesman41748d72013-06-27 00:25:01 +00001975 // On function declarations/definitions, we do not support the builtin
1976 // attribute. We do not check this in VerifyFunctionAttrs since that is
1977 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001978 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1979 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001980
Chris Lattneref13ee32006-05-19 21:25:17 +00001981 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001982 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1983 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001984 switch (F.getCallingConv()) {
1985 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001986 case CallingConv::C:
1987 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001988 case CallingConv::Fast:
1989 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001990 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001991 case CallingConv::PTX_Kernel:
1992 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001993 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1994 "perfect forwarding!",
1995 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001996 break;
1997 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001998
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001999 bool isLLVMdotName = F.getName().size() >= 5 &&
2000 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002001
Chris Lattneraf95e582002-04-13 22:48:46 +00002002 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00002003 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002004 for (const Argument &Arg : F.args()) {
2005 Assert(Arg.getType() == FT->getParamType(i),
2006 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002007 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002008 Assert(Arg.getType()->isFirstClassType(),
2009 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00002010 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002011 Assert(!Arg.getType()->isMetadataTy(),
2012 "Function takes metadata but isn't an intrinsic", &Arg, &F);
2013 Assert(!Arg.getType()->isTokenTy(),
2014 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00002015 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00002016
2017 // Check that swifterror argument is only used by loads and stores.
2018 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
2019 verifySwiftErrorValue(&Arg);
2020 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002021 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00002022 }
Chris Lattneraf95e582002-04-13 22:48:46 +00002023
David Majnemerb611e3f2015-08-14 05:09:07 +00002024 if (!isLLVMdotName)
2025 Assert(!F.getReturnType()->isTokenTy(),
2026 "Functions returns a token but isn't an intrinsic", &F);
2027
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002028 // Get the function metadata attachments.
2029 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2030 F.getAllMetadata(MDs);
2031 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002032 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002033
Keno Fischer2ac0c272015-11-16 05:13:30 +00002034 // Check validity of the personality function
2035 if (F.hasPersonalityFn()) {
2036 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2037 if (Per)
2038 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002039 "Referencing personality function in another module!",
2040 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002041 }
2042
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002043 if (F.isMaterializable()) {
2044 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002045 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2046 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002047 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002048 for (const auto &I : MDs) {
2049 AssertDI(I.first != LLVMContext::MD_dbg,
2050 "function declaration may not have a !dbg attachment", &F);
2051 Assert(I.first != LLVMContext::MD_prof,
2052 "function declaration may not have a !prof attachment", &F);
2053
2054 // Verify the metadata itself.
2055 visitMDNode(*I.second);
2056 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002057 Assert(!F.hasPersonalityFn(),
2058 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002059 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002060 // Verify that this function (which has a body) is not named "llvm.*". It
2061 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002062 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002063
Chris Lattner149376d2002-10-13 20:57:00 +00002064 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002065 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002066 Assert(pred_empty(Entry),
2067 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002068
Chris Lattner27471742009-11-01 04:08:01 +00002069 // The address of the entry block cannot be taken, unless it is dead.
2070 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002071 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2072 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002073 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002074
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002075 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002076 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002077 for (const auto &I : MDs) {
2078 // Verify that the attachment is legal.
2079 switch (I.first) {
2080 default:
2081 break;
2082 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002083 ++NumDebugAttachments;
2084 AssertDI(NumDebugAttachments == 1,
2085 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002086 AssertDI(isa<DISubprogram>(I.second),
2087 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002088 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002089 case LLVMContext::MD_prof:
2090 ++NumProfAttachments;
2091 Assert(NumProfAttachments == 1,
2092 "function must have a single !prof attachment", &F, I.second);
2093 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002094 }
2095
2096 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002097 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002098 }
Chris Lattner149376d2002-10-13 20:57:00 +00002099 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002100
Chris Lattner7730dcc2009-09-11 17:05:29 +00002101 // If this function is actually an intrinsic, verify that it is only used in
2102 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002103 // Only do this if the module is materialized, otherwise we don't have all the
2104 // uses.
2105 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002106 const User *U;
2107 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002108 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002109 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002110
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002111 Assert(!F.hasDLLImportStorageClass() ||
2112 (F.isDeclaration() && F.hasExternalLinkage()) ||
2113 F.hasAvailableExternallyLinkage(),
2114 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002115
2116 auto *N = F.getSubprogram();
2117 if (!N)
2118 return;
2119
Adrian Prantl75819ae2016-04-15 15:57:41 +00002120 visitDISubprogram(*N);
2121
Peter Collingbourned4bff302015-11-05 22:03:56 +00002122 // Check that all !dbg attachments lead to back to N (or, at least, another
2123 // subprogram that describes the same function).
2124 //
2125 // FIXME: Check this incrementally while visiting !dbg attachments.
2126 // FIXME: Only check when N is the canonical subprogram for F.
2127 SmallPtrSet<const MDNode *, 32> Seen;
2128 for (auto &BB : F)
2129 for (auto &I : BB) {
2130 // Be careful about using DILocation here since we might be dealing with
2131 // broken code (this is the Verifier after all).
2132 DILocation *DL =
2133 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2134 if (!DL)
2135 continue;
2136 if (!Seen.insert(DL).second)
2137 continue;
2138
2139 DILocalScope *Scope = DL->getInlinedAtScope();
2140 if (Scope && !Seen.insert(Scope).second)
2141 continue;
2142
2143 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002144
2145 // Scope and SP could be the same MDNode and we don't want to skip
2146 // validation in that case
2147 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002148 continue;
2149
2150 // FIXME: Once N is canonical, check "SP == &N".
Adrian Prantla2ef0472016-09-14 17:30:37 +00002151 AssertDI(SP->describes(&F),
2152 "!dbg attachment points at wrong subprogram for function", N, &F,
2153 &I, DL, Scope, SP);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002154 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002155}
2156
Chris Lattner0e851da2002-04-18 20:37:37 +00002157// verifyBasicBlock - Verify that a basic block is well formed...
2158//
Chris Lattner069a7952002-06-25 15:56:27 +00002159void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002160 InstsInThisBlock.clear();
2161
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002162 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002163 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002164
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002165 // Check constraints that this basic block imposes on all of the PHI nodes in
2166 // it.
2167 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002168 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2169 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002170 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002171 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002172 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002173 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002174 Assert(PN->getNumIncomingValues() != 0,
2175 "PHI nodes must have at least one entry. If the block is dead, "
2176 "the PHI should be removed!",
2177 PN);
2178 Assert(PN->getNumIncomingValues() == Preds.size(),
2179 "PHINode should have one entry for each predecessor of its "
2180 "parent basic block!",
2181 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002182
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002183 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002184 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002185 Values.reserve(PN->getNumIncomingValues());
2186 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2187 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2188 PN->getIncomingValue(i)));
2189 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002190
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002191 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2192 // Check to make sure that if there is more than one entry for a
2193 // particular basic block in this PHI node, that the incoming values are
2194 // all identical.
2195 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002196 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2197 Values[i].second == Values[i - 1].second,
2198 "PHI node has multiple entries for the same basic block with "
2199 "different incoming values!",
2200 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002201
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002202 // Check to make sure that the predecessors and PHI node entries are
2203 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002204 Assert(Values[i].first == Preds[i],
2205 "PHI node entries do not match predecessors!", PN,
2206 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002207 }
2208 }
2209 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002210
2211 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002212 for (auto &I : BB)
2213 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002214 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002215 }
Chris Lattner069a7952002-06-25 15:56:27 +00002216}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002217
Chris Lattner069a7952002-06-25 15:56:27 +00002218void Verifier::visitTerminatorInst(TerminatorInst &I) {
2219 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002220 Assert(&I == I.getParent()->getTerminator(),
2221 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002222 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002223}
2224
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002225void Verifier::visitBranchInst(BranchInst &BI) {
2226 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002227 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2228 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002229 }
2230 visitTerminatorInst(BI);
2231}
2232
Chris Lattner069a7952002-06-25 15:56:27 +00002233void Verifier::visitReturnInst(ReturnInst &RI) {
2234 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002235 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002236 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002237 Assert(N == 0,
2238 "Found return instr that returns non-void in Function of void "
2239 "return type!",
2240 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002241 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002242 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2243 "Function return type does not match operand "
2244 "type of return inst!",
2245 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002246
Misha Brukman7eb05a12003-08-18 14:43:39 +00002247 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002248 // terminators...
2249 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002250}
2251
Chris Lattnerab5aa142004-05-21 16:47:21 +00002252void Verifier::visitSwitchInst(SwitchInst &SI) {
2253 // Check to make sure that all of the constants in the switch instruction
2254 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002255 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002256 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002257 for (auto &Case : SI.cases()) {
2258 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002259 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002260 Assert(Constants.insert(Case.getCaseValue()).second,
2261 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002262 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002263
Chris Lattnerab5aa142004-05-21 16:47:21 +00002264 visitTerminatorInst(SI);
2265}
2266
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002267void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002268 Assert(BI.getAddress()->getType()->isPointerTy(),
2269 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002270 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002271 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2272 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002273
2274 visitTerminatorInst(BI);
2275}
2276
Chris Lattner75648e72004-03-12 05:54:31 +00002277void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002278 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2279 SI.getOperand(2)),
2280 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002281
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002282 Assert(SI.getTrueValue()->getType() == SI.getType(),
2283 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002284 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002285}
2286
Misha Brukmanc566ca362004-03-02 00:22:19 +00002287/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2288/// a pass, if any exist, it's an error.
2289///
Chris Lattner903a25d2002-11-21 16:54:22 +00002290void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002291 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002292}
Chris Lattner0e851da2002-04-18 20:37:37 +00002293
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002294void Verifier::visitTruncInst(TruncInst &I) {
2295 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002296 Type *SrcTy = I.getOperand(0)->getType();
2297 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002298
2299 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002300 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2301 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002302
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002303 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2304 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2305 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2306 "trunc source and destination must both be a vector or neither", &I);
2307 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002308
2309 visitInstruction(I);
2310}
2311
2312void Verifier::visitZExtInst(ZExtInst &I) {
2313 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002314 Type *SrcTy = I.getOperand(0)->getType();
2315 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002316
2317 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002318 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2319 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2320 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2321 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002322 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2323 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002324
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002325 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002326
2327 visitInstruction(I);
2328}
2329
2330void Verifier::visitSExtInst(SExtInst &I) {
2331 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002332 Type *SrcTy = I.getOperand(0)->getType();
2333 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002334
2335 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002336 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2337 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002338
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002339 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2340 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2341 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2342 "sext source and destination must both be a vector or neither", &I);
2343 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002344
2345 visitInstruction(I);
2346}
2347
2348void Verifier::visitFPTruncInst(FPTruncInst &I) {
2349 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002350 Type *SrcTy = I.getOperand(0)->getType();
2351 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002352 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002353 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2354 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002355
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002356 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2357 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2358 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2359 "fptrunc source and destination must both be a vector or neither", &I);
2360 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002361
2362 visitInstruction(I);
2363}
2364
2365void Verifier::visitFPExtInst(FPExtInst &I) {
2366 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002367 Type *SrcTy = I.getOperand(0)->getType();
2368 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002369
2370 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002371 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2372 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002373
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002374 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2375 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2376 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2377 "fpext source and destination must both be a vector or neither", &I);
2378 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002379
2380 visitInstruction(I);
2381}
2382
2383void Verifier::visitUIToFPInst(UIToFPInst &I) {
2384 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002385 Type *SrcTy = I.getOperand(0)->getType();
2386 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002387
Duncan Sands19d0b472010-02-16 11:11:14 +00002388 bool SrcVec = SrcTy->isVectorTy();
2389 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002390
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002391 Assert(SrcVec == DstVec,
2392 "UIToFP source and dest must both be vector or scalar", &I);
2393 Assert(SrcTy->isIntOrIntVectorTy(),
2394 "UIToFP source must be integer or integer vector", &I);
2395 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2396 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002397
2398 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002399 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2400 cast<VectorType>(DestTy)->getNumElements(),
2401 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002402
2403 visitInstruction(I);
2404}
2405
2406void Verifier::visitSIToFPInst(SIToFPInst &I) {
2407 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002408 Type *SrcTy = I.getOperand(0)->getType();
2409 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002410
Duncan Sands19d0b472010-02-16 11:11:14 +00002411 bool SrcVec = SrcTy->isVectorTy();
2412 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002413
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002414 Assert(SrcVec == DstVec,
2415 "SIToFP source and dest must both be vector or scalar", &I);
2416 Assert(SrcTy->isIntOrIntVectorTy(),
2417 "SIToFP source must be integer or integer vector", &I);
2418 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2419 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002420
2421 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002422 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2423 cast<VectorType>(DestTy)->getNumElements(),
2424 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002425
2426 visitInstruction(I);
2427}
2428
2429void Verifier::visitFPToUIInst(FPToUIInst &I) {
2430 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002431 Type *SrcTy = I.getOperand(0)->getType();
2432 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002433
Duncan Sands19d0b472010-02-16 11:11:14 +00002434 bool SrcVec = SrcTy->isVectorTy();
2435 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002436
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002437 Assert(SrcVec == DstVec,
2438 "FPToUI source and dest must both be vector or scalar", &I);
2439 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2440 &I);
2441 Assert(DestTy->isIntOrIntVectorTy(),
2442 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002443
2444 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002445 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2446 cast<VectorType>(DestTy)->getNumElements(),
2447 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002448
2449 visitInstruction(I);
2450}
2451
2452void Verifier::visitFPToSIInst(FPToSIInst &I) {
2453 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002454 Type *SrcTy = I.getOperand(0)->getType();
2455 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002456
Duncan Sands19d0b472010-02-16 11:11:14 +00002457 bool SrcVec = SrcTy->isVectorTy();
2458 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002459
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002460 Assert(SrcVec == DstVec,
2461 "FPToSI source and dest must both be vector or scalar", &I);
2462 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2463 &I);
2464 Assert(DestTy->isIntOrIntVectorTy(),
2465 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002466
2467 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002468 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2469 cast<VectorType>(DestTy)->getNumElements(),
2470 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002471
2472 visitInstruction(I);
2473}
2474
2475void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2476 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002477 Type *SrcTy = I.getOperand(0)->getType();
2478 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002479
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002480 Assert(SrcTy->getScalarType()->isPointerTy(),
2481 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002482
2483 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002484 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002485 "ptrtoint not supported for non-integral pointers");
2486
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002487 Assert(DestTy->getScalarType()->isIntegerTy(),
2488 "PtrToInt result must be integral", &I);
2489 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2490 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002491
2492 if (SrcTy->isVectorTy()) {
2493 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2494 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002495 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2496 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002497 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002498
2499 visitInstruction(I);
2500}
2501
2502void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2503 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002504 Type *SrcTy = I.getOperand(0)->getType();
2505 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002506
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002507 Assert(SrcTy->getScalarType()->isIntegerTy(),
2508 "IntToPtr source must be an integral", &I);
2509 Assert(DestTy->getScalarType()->isPointerTy(),
2510 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002511
2512 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002513 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002514 "inttoptr not supported for non-integral pointers");
2515
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002516 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2517 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002518 if (SrcTy->isVectorTy()) {
2519 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2520 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002521 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2522 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002523 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002524 visitInstruction(I);
2525}
2526
2527void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002528 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002529 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2530 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002531 visitInstruction(I);
2532}
2533
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002534void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2535 Type *SrcTy = I.getOperand(0)->getType();
2536 Type *DestTy = I.getType();
2537
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002538 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2539 &I);
2540 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2541 &I);
2542 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2543 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002544 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002545 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2546 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002547 visitInstruction(I);
2548}
2549
Misha Brukmanc566ca362004-03-02 00:22:19 +00002550/// visitPHINode - Ensure that a PHI node is well formed.
2551///
Chris Lattner069a7952002-06-25 15:56:27 +00002552void Verifier::visitPHINode(PHINode &PN) {
2553 // Ensure that the PHI nodes are all grouped together at the top of the block.
2554 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002555 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002556 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002557 Assert(&PN == &PN.getParent()->front() ||
2558 isa<PHINode>(--BasicBlock::iterator(&PN)),
2559 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002560
David Majnemerb611e3f2015-08-14 05:09:07 +00002561 // Check that a PHI doesn't yield a Token.
2562 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2563
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002564 // Check that all of the values of the PHI node have the same type as the
2565 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002566 for (Value *IncValue : PN.incoming_values()) {
2567 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002568 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002569 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002570
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002571 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002572
2573 visitInstruction(PN);
2574}
2575
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002576void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002577 Instruction *I = CS.getInstruction();
2578
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002579 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2580 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002581 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002582
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002583 Assert(FPTy->getElementType()->isFunctionTy(),
2584 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002585
2586 Assert(FPTy->getElementType() == CS.getFunctionType(),
2587 "Called function is not the same type as the call!", I);
2588
2589 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002590
2591 // Verify that the correct number of arguments are being passed
2592 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002593 Assert(CS.arg_size() >= FTy->getNumParams(),
2594 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002595 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002596 Assert(CS.arg_size() == FTy->getNumParams(),
2597 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002598
Chris Lattner609de002010-05-10 20:58:42 +00002599 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002600 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002601 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2602 "Call parameter type does not match function signature!",
2603 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002604
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002605 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002606
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002607 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002608 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002609
Duncan Sands8c582282007-12-21 19:19:01 +00002610 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002611 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002612
David Majnemer91db08b2014-04-30 17:22:00 +00002613 // Conservatively check the inalloca argument.
2614 // We have a bug if we can find that there is an underlying alloca without
2615 // inalloca.
2616 if (CS.hasInAllocaArgument()) {
2617 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2618 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002619 Assert(AI->isUsedWithInAlloca(),
2620 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002621 }
2622
Manman Ren9bfd0d02016-04-01 21:41:15 +00002623 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002624 // make sure the underlying alloca/parameter it comes from has a swifterror as
2625 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002626 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2627 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2628 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002629 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002630 Assert(AI->isSwiftError(),
2631 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002632 continue;
2633 }
2634 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2635 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2636 Assert(ArgI->hasSwiftErrorAttr(),
2637 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002638 }
2639
Stephen Linb8bd2322013-04-20 05:14:40 +00002640 if (FTy->isVarArg()) {
2641 // FIXME? is 'nest' even legal here?
2642 bool SawNest = false;
2643 bool SawReturned = false;
2644
2645 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2646 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2647 SawNest = true;
2648 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2649 SawReturned = true;
2650 }
2651
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002652 // Check attributes on the varargs part.
2653 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002654 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002655 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002656
Stephen Linb8bd2322013-04-20 05:14:40 +00002657 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002658 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002659 SawNest = true;
2660 }
2661
2662 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002663 Assert(!SawReturned, "More than one parameter has attribute returned!",
2664 I);
2665 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2666 "Incompatible argument and return types for 'returned' "
2667 "attribute",
2668 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002669 SawReturned = true;
2670 }
Duncan Sands0009c442008-01-12 16:42:01 +00002671
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002672 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2673 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002674
2675 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002676 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002677 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002678 }
Duncan Sands8c582282007-12-21 19:19:01 +00002679
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002680 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002681 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002682 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002683 for (Type *ParamTy : FTy->params()) {
2684 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002685 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002686 Assert(!ParamTy->isTokenTy(),
2687 "Function has token parameter but isn't an intrinsic", I);
2688 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002689 }
2690
David Majnemerb611e3f2015-08-14 05:09:07 +00002691 // Verify that indirect calls don't return tokens.
2692 if (CS.getCalledFunction() == nullptr)
2693 Assert(!FTy->getReturnType()->isTokenTy(),
2694 "Return type cannot be token for indirect call!");
2695
Philip Reamesa3c6f002015-06-26 21:39:44 +00002696 if (Function *F = CS.getCalledFunction())
2697 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002698 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002699
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002700 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2701 // at most one "gc-transition" operand bundle.
2702 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2703 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002704 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002705 OperandBundleUse BU = CS.getOperandBundleAt(i);
2706 uint32_t Tag = BU.getTagID();
2707 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002708 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2709 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002710 } else if (Tag == LLVMContext::OB_gc_transition) {
2711 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2712 I);
2713 FoundGCTransitionBundle = true;
2714 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002715 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2716 FoundFuncletBundle = true;
2717 Assert(BU.Inputs.size() == 1,
2718 "Expected exactly one funclet bundle operand", I);
2719 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2720 "Funclet bundle operands should correspond to a FuncletPadInst",
2721 I);
2722 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002723 }
2724
Adrian Prantl93035c82016-04-24 22:23:13 +00002725 // Verify that each inlinable callsite of a debug-info-bearing function in a
2726 // debug-info-bearing function has a debug location attached to it. Failure to
2727 // do so causes assertion failures when the inliner sets up inline scope info.
2728 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2729 CS.getCalledFunction()->getSubprogram())
2730 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2731 "info must have a !dbg location",
2732 I);
2733
Duncan Sands8c582282007-12-21 19:19:01 +00002734 visitInstruction(*I);
2735}
2736
Reid Kleckner5772b772014-04-24 20:14:34 +00002737/// Two types are "congruent" if they are identical, or if they are both pointer
2738/// types with different pointee types and the same address space.
2739static bool isTypeCongruent(Type *L, Type *R) {
2740 if (L == R)
2741 return true;
2742 PointerType *PL = dyn_cast<PointerType>(L);
2743 PointerType *PR = dyn_cast<PointerType>(R);
2744 if (!PL || !PR)
2745 return false;
2746 return PL->getAddressSpace() == PR->getAddressSpace();
2747}
2748
Reid Klecknerd20c9702014-05-15 23:58:57 +00002749static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2750 static const Attribute::AttrKind ABIAttrs[] = {
2751 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002752 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2753 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002754 AttrBuilder Copy;
2755 for (auto AK : ABIAttrs) {
2756 if (Attrs.hasAttribute(I + 1, AK))
2757 Copy.addAttribute(AK);
2758 }
2759 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2760 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2761 return Copy;
2762}
2763
Reid Kleckner5772b772014-04-24 20:14:34 +00002764void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002765 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002766
2767 // - The caller and callee prototypes must match. Pointer types of
2768 // parameters or return types may differ in pointee type, but not
2769 // address space.
2770 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002771 FunctionType *CallerTy = F->getFunctionType();
2772 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002773 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2774 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2775 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2776 "cannot guarantee tail call due to mismatched varargs", &CI);
2777 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2778 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002779 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002780 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002781 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2782 "cannot guarantee tail call due to mismatched parameter types", &CI);
2783 }
2784
2785 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002786 Assert(F->getCallingConv() == CI.getCallingConv(),
2787 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002788
2789 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2790 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002791 AttributeSet CallerAttrs = F->getAttributes();
2792 AttributeSet CalleeAttrs = CI.getAttributes();
2793 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002794 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2795 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002796 Assert(CallerABIAttrs == CalleeABIAttrs,
2797 "cannot guarantee tail call due to mismatched ABI impacting "
2798 "function attributes",
2799 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002800 }
2801
2802 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2803 // or a pointer bitcast followed by a ret instruction.
2804 // - The ret instruction must return the (possibly bitcasted) value
2805 // produced by the call or void.
2806 Value *RetVal = &CI;
2807 Instruction *Next = CI.getNextNode();
2808
2809 // Handle the optional bitcast.
2810 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002811 Assert(BI->getOperand(0) == RetVal,
2812 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002813 RetVal = BI;
2814 Next = BI->getNextNode();
2815 }
2816
2817 // Check the return.
2818 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002819 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2820 &CI);
2821 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2822 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002823}
2824
Duncan Sands8c582282007-12-21 19:19:01 +00002825void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002826 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002827
Reid Kleckner5772b772014-04-24 20:14:34 +00002828 if (CI.isMustTailCall())
2829 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002830}
2831
2832void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002833 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002834
David Majnemer654e1302015-07-31 17:58:14 +00002835 // Verify that the first non-PHI instruction of the unwind destination is an
2836 // exception handling instruction.
2837 Assert(
2838 II.getUnwindDest()->isEHPad(),
2839 "The unwind destination does not have an exception handling instruction!",
2840 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002841
Dan Gohman9c6e1882010-08-02 23:09:14 +00002842 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002843}
Chris Lattner0e851da2002-04-18 20:37:37 +00002844
Misha Brukmanc566ca362004-03-02 00:22:19 +00002845/// visitBinaryOperator - Check that both arguments to the binary operator are
2846/// of the same type!
2847///
Chris Lattner069a7952002-06-25 15:56:27 +00002848void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002849 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2850 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002851
Reid Spencer2341c222007-02-02 02:16:23 +00002852 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002853 // Check that integer arithmetic operators are only used with
2854 // integral operands.
2855 case Instruction::Add:
2856 case Instruction::Sub:
2857 case Instruction::Mul:
2858 case Instruction::SDiv:
2859 case Instruction::UDiv:
2860 case Instruction::SRem:
2861 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002862 Assert(B.getType()->isIntOrIntVectorTy(),
2863 "Integer arithmetic operators only work with integral types!", &B);
2864 Assert(B.getType() == B.getOperand(0)->getType(),
2865 "Integer arithmetic operators must have same type "
2866 "for operands and result!",
2867 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002868 break;
2869 // Check that floating-point arithmetic operators are only used with
2870 // floating-point operands.
2871 case Instruction::FAdd:
2872 case Instruction::FSub:
2873 case Instruction::FMul:
2874 case Instruction::FDiv:
2875 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002876 Assert(B.getType()->isFPOrFPVectorTy(),
2877 "Floating-point arithmetic operators only work with "
2878 "floating-point types!",
2879 &B);
2880 Assert(B.getType() == B.getOperand(0)->getType(),
2881 "Floating-point arithmetic operators must have same type "
2882 "for operands and result!",
2883 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002884 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002885 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002886 case Instruction::And:
2887 case Instruction::Or:
2888 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002889 Assert(B.getType()->isIntOrIntVectorTy(),
2890 "Logical operators only work with integral types!", &B);
2891 Assert(B.getType() == B.getOperand(0)->getType(),
2892 "Logical operators must have same type for operands and result!",
2893 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002894 break;
2895 case Instruction::Shl:
2896 case Instruction::LShr:
2897 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002898 Assert(B.getType()->isIntOrIntVectorTy(),
2899 "Shifts only work with integral types!", &B);
2900 Assert(B.getType() == B.getOperand(0)->getType(),
2901 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002902 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002903 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002904 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002905 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002906
Chris Lattner0e851da2002-04-18 20:37:37 +00002907 visitInstruction(B);
2908}
2909
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002910void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002911 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002912 Type *Op0Ty = IC.getOperand(0)->getType();
2913 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002914 Assert(Op0Ty == Op1Ty,
2915 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002916 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002917 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2918 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002919 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002920 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2921 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2922 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002923
Reid Spencerd9436b62006-11-20 01:22:35 +00002924 visitInstruction(IC);
2925}
2926
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002927void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002928 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002929 Type *Op0Ty = FC.getOperand(0)->getType();
2930 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002931 Assert(Op0Ty == Op1Ty,
2932 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002933 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002934 Assert(Op0Ty->isFPOrFPVectorTy(),
2935 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002936 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002937 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2938 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2939 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002940
Reid Spencerd9436b62006-11-20 01:22:35 +00002941 visitInstruction(FC);
2942}
2943
Robert Bocchino23004482006-01-10 19:05:34 +00002944void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002945 Assert(
2946 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2947 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002948 visitInstruction(EI);
2949}
2950
Robert Bocchinoca27f032006-01-17 20:07:22 +00002951void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002952 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2953 IE.getOperand(2)),
2954 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002955 visitInstruction(IE);
2956}
2957
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002958void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002959 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2960 SV.getOperand(2)),
2961 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002962 visitInstruction(SV);
2963}
2964
Chris Lattner069a7952002-06-25 15:56:27 +00002965void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002966 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002967
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002968 Assert(isa<PointerType>(TargetTy),
2969 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002970 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002971 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002972 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002973 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002974 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002975
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002976 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002977 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002978 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002979
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002980 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002981 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002982 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2983 if (GEP.getPointerOperandType()->isVectorTy())
2984 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2985 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002986 for (Value *Idx : Idxs) {
2987 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002988 if (IndexTy->isVectorTy()) {
2989 unsigned IndexWidth = IndexTy->getVectorNumElements();
2990 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2991 }
2992 Assert(IndexTy->getScalarType()->isIntegerTy(),
2993 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002994 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002995 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002996 visitInstruction(GEP);
2997}
2998
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002999static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
3000 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
3001}
3002
Sanjoy Das26f28a22016-11-09 19:36:39 +00003003void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
3004 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
Philip Reamesbf9676f2014-10-20 23:52:07 +00003005 "precondition violation");
3006
3007 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003008 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003009 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003010 Assert(NumRanges >= 1, "It should have at least one range!", Range);
3011
Philip Reamesbf9676f2014-10-20 23:52:07 +00003012 ConstantRange LastRange(1); // Dummy initial value
3013 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003014 ConstantInt *Low =
3015 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003016 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003017 ConstantInt *High =
3018 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003019 Assert(High, "The upper limit must be an integer!", High);
3020 Assert(High->getType() == Low->getType() && High->getType() == Ty,
3021 "Range types must match instruction type!", &I);
3022
Philip Reamesbf9676f2014-10-20 23:52:07 +00003023 APInt HighV = High->getValue();
3024 APInt LowV = Low->getValue();
3025 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003026 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
3027 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003028 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003029 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
3030 "Intervals are overlapping", Range);
3031 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3032 Range);
3033 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3034 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003035 }
3036 LastRange = ConstantRange(LowV, HighV);
3037 }
3038 if (NumRanges > 2) {
3039 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003040 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003041 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003042 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003043 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003044 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3045 "Intervals are overlapping", Range);
3046 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3047 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003048 }
3049}
3050
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003051void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3052 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003053 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3054 Assert(!(Size & (Size - 1)),
3055 "atomic memory access' operand must have a power-of-two size", Ty, I);
3056}
3057
Chris Lattner069a7952002-06-25 15:56:27 +00003058void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003059 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003060 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003061 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003062 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3063 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003064 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003065 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003066 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3067 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003068 "Load cannot have Release ordering", &LI);
3069 Assert(LI.getAlignment() != 0,
3070 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003071 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3072 ElTy->isFloatingPointTy(),
3073 "atomic load operand must have integer, pointer, or floating point "
3074 "type!",
3075 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003076 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003077 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003078 Assert(LI.getSynchScope() == CrossThread,
3079 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003080 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003081
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003082 visitInstruction(LI);
3083}
3084
Chris Lattner069a7952002-06-25 15:56:27 +00003085void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003086 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003087 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003088 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003089 Assert(ElTy == SI.getOperand(0)->getType(),
3090 "Stored value type does not match pointer operand type!", &SI, ElTy);
3091 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3092 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003093 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003094 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003095 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3096 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003097 "Store cannot have Acquire ordering", &SI);
3098 Assert(SI.getAlignment() != 0,
3099 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003100 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3101 ElTy->isFloatingPointTy(),
3102 "atomic store operand must have integer, pointer, or floating point "
3103 "type!",
3104 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003105 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003106 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003107 Assert(SI.getSynchScope() == CrossThread,
3108 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003109 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003110 visitInstruction(SI);
3111}
3112
Manman Ren9bfd0d02016-04-01 21:41:15 +00003113/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3114void Verifier::verifySwiftErrorCallSite(CallSite CS,
3115 const Value *SwiftErrorVal) {
3116 unsigned Idx = 0;
3117 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3118 I != E; ++I, ++Idx) {
3119 if (*I == SwiftErrorVal) {
3120 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3121 "swifterror value when used in a callsite should be marked "
3122 "with swifterror attribute",
3123 SwiftErrorVal, CS);
3124 }
3125 }
3126}
3127
3128void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3129 // Check that swifterror value is only used by loads, stores, or as
3130 // a swifterror argument.
3131 for (const User *U : SwiftErrorVal->users()) {
3132 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3133 isa<InvokeInst>(U),
3134 "swifterror value can only be loaded and stored from, or "
3135 "as a swifterror argument!",
3136 SwiftErrorVal, U);
3137 // If it is used by a store, check it is the second operand.
3138 if (auto StoreI = dyn_cast<StoreInst>(U))
3139 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3140 "swifterror value should be the second operand when used "
3141 "by stores", SwiftErrorVal, U);
3142 if (auto CallI = dyn_cast<CallInst>(U))
3143 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3144 if (auto II = dyn_cast<InvokeInst>(U))
3145 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3146 }
3147}
3148
Victor Hernandez8acf2952009-10-23 21:09:37 +00003149void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003150 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003151 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003152 Assert(PTy->getAddressSpace() == 0,
3153 "Allocation instruction pointer not in the generic address space!",
3154 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003155 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003156 "Cannot allocate unsized type", &AI);
3157 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3158 "Alloca array size must have integer type", &AI);
3159 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3160 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003161
Manman Ren9bfd0d02016-04-01 21:41:15 +00003162 if (AI.isSwiftError()) {
3163 verifySwiftErrorValue(&AI);
3164 }
3165
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003166 visitInstruction(AI);
3167}
3168
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003169void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003170
3171 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003172 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003173 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003174 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003175 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003176 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003177 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003178 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003179 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003180 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3181 "cmpxchg instructions failure argument shall be no stronger than the "
3182 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003183 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003184 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3185 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003186 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003187
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003188 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003189 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003190 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003191 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3192 "cmpxchg operand must have integer or pointer type",
3193 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003194 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003195 Assert(ElTy == CXI.getOperand(1)->getType(),
3196 "Expected value type does not match pointer operand type!", &CXI,
3197 ElTy);
3198 Assert(ElTy == CXI.getOperand(2)->getType(),
3199 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003200 visitInstruction(CXI);
3201}
3202
3203void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003204 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003205 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003206 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003207 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003208 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003209 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003210 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003211 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3212 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003213 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003214 Assert(ElTy == RMWI.getOperand(1)->getType(),
3215 "Argument value type does not match pointer operand type!", &RMWI,
3216 ElTy);
3217 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3218 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3219 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003220 visitInstruction(RMWI);
3221}
3222
Eli Friedmanfee02c62011-07-25 23:16:38 +00003223void Verifier::visitFenceInst(FenceInst &FI) {
3224 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003225 Assert(Ordering == AtomicOrdering::Acquire ||
3226 Ordering == AtomicOrdering::Release ||
3227 Ordering == AtomicOrdering::AcquireRelease ||
3228 Ordering == AtomicOrdering::SequentiallyConsistent,
3229 "fence instructions may only have acquire, release, acq_rel, or "
3230 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003231 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003232 visitInstruction(FI);
3233}
3234
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003235void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003236 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3237 EVI.getIndices()) == EVI.getType(),
3238 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003239
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003240 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003241}
3242
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003243void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003244 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3245 IVI.getIndices()) ==
3246 IVI.getOperand(1)->getType(),
3247 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003248
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003249 visitInstruction(IVI);
3250}
Chris Lattner0e851da2002-04-18 20:37:37 +00003251
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003252static Value *getParentPad(Value *EHPad) {
3253 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3254 return FPI->getParentPad();
3255
3256 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3257}
3258
David Majnemer85a549d2015-08-11 02:48:30 +00003259void Verifier::visitEHPadPredecessors(Instruction &I) {
3260 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003261
David Majnemer85a549d2015-08-11 02:48:30 +00003262 BasicBlock *BB = I.getParent();
3263 Function *F = BB->getParent();
3264
3265 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3266
3267 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3268 // The landingpad instruction defines its parent as a landing pad block. The
3269 // landing pad block may be branched to only by the unwind edge of an
3270 // invoke.
3271 for (BasicBlock *PredBB : predecessors(BB)) {
3272 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3273 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3274 "Block containing LandingPadInst must be jumped to "
3275 "only by the unwind edge of an invoke.",
3276 LPI);
3277 }
3278 return;
3279 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003280 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3281 if (!pred_empty(BB))
3282 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3283 "Block containg CatchPadInst must be jumped to "
3284 "only by its catchswitch.",
3285 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003286 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3287 "Catchswitch cannot unwind to one of its catchpads",
3288 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003289 return;
3290 }
David Majnemer85a549d2015-08-11 02:48:30 +00003291
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003292 // Verify that each pred has a legal terminator with a legal to/from EH
3293 // pad relationship.
3294 Instruction *ToPad = &I;
3295 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003296 for (BasicBlock *PredBB : predecessors(BB)) {
3297 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003298 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003299 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003300 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003301 "EH pad must be jumped to via an unwind edge", ToPad, II);
3302 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3303 FromPad = Bundle->Inputs[0];
3304 else
3305 FromPad = ConstantTokenNone::get(II->getContext());
3306 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003307 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003308 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3309 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3310 FromPad = CSI;
3311 } else {
3312 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3313 }
3314
3315 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003316 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003317 for (;; FromPad = getParentPad(FromPad)) {
3318 Assert(FromPad != ToPad,
3319 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3320 if (FromPad == ToPadParent) {
3321 // This is a legal unwind edge.
3322 break;
3323 }
3324 Assert(!isa<ConstantTokenNone>(FromPad),
3325 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003326 Assert(Seen.insert(FromPad).second,
3327 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003328 }
David Majnemer85a549d2015-08-11 02:48:30 +00003329 }
3330}
3331
3332void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003333 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3334 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003335 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3336 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003337
David Majnemer85a549d2015-08-11 02:48:30 +00003338 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003339
David Majnemer654e1302015-07-31 17:58:14 +00003340 if (!LandingPadResultTy)
3341 LandingPadResultTy = LPI.getType();
3342 else
3343 Assert(LandingPadResultTy == LPI.getType(),
3344 "The landingpad instruction should have a consistent result type "
3345 "inside a function.",
3346 &LPI);
3347
David Majnemer7fddecc2015-06-17 20:52:32 +00003348 Function *F = LPI.getParent()->getParent();
3349 Assert(F->hasPersonalityFn(),
3350 "LandingPadInst needs to be in a function with a personality.", &LPI);
3351
Bill Wendlingfae14752011-08-12 20:24:12 +00003352 // The landingpad instruction must be the first non-PHI instruction in the
3353 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003354 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3355 "LandingPadInst not the first non-PHI instruction in the block.",
3356 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003357
Duncan Sands86de1a62011-09-27 16:43:19 +00003358 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003359 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003360 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003361 Assert(isa<PointerType>(Clause->getType()),
3362 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003363 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003364 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3365 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3366 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003367 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003368 }
3369
Bill Wendlingfae14752011-08-12 20:24:12 +00003370 visitInstruction(LPI);
3371}
3372
David Majnemerba6665d2016-08-01 18:06:34 +00003373void Verifier::visitResumeInst(ResumeInst &RI) {
3374 Assert(RI.getFunction()->hasPersonalityFn(),
3375 "ResumeInst needs to be in a function with a personality.", &RI);
3376
3377 if (!LandingPadResultTy)
3378 LandingPadResultTy = RI.getValue()->getType();
3379 else
3380 Assert(LandingPadResultTy == RI.getValue()->getType(),
3381 "The resume instruction should have a consistent result type "
3382 "inside a function.",
3383 &RI);
3384
3385 visitTerminatorInst(RI);
3386}
3387
David Majnemer654e1302015-07-31 17:58:14 +00003388void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003389 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003390
David Majnemer654e1302015-07-31 17:58:14 +00003391 Function *F = BB->getParent();
3392 Assert(F->hasPersonalityFn(),
3393 "CatchPadInst needs to be in a function with a personality.", &CPI);
3394
David Majnemer8a1c45d2015-12-12 05:38:55 +00003395 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3396 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3397 CPI.getParentPad());
3398
David Majnemer654e1302015-07-31 17:58:14 +00003399 // The catchpad instruction must be the first non-PHI instruction in the
3400 // block.
3401 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003402 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003403
David Majnemerfe2f7f32016-02-29 22:56:36 +00003404 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003405 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003406}
3407
David Majnemer8a1c45d2015-12-12 05:38:55 +00003408void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3409 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3410 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3411 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003412
David Majnemer8a1c45d2015-12-12 05:38:55 +00003413 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003414}
3415
3416void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3417 BasicBlock *BB = CPI.getParent();
3418
David Majnemer654e1302015-07-31 17:58:14 +00003419 Function *F = BB->getParent();
3420 Assert(F->hasPersonalityFn(),
3421 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3422
3423 // The cleanuppad instruction must be the first non-PHI instruction in the
3424 // block.
3425 Assert(BB->getFirstNonPHI() == &CPI,
3426 "CleanupPadInst not the first non-PHI instruction in the block.",
3427 &CPI);
3428
David Majnemer8a1c45d2015-12-12 05:38:55 +00003429 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003430 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003431 "CleanupPadInst has an invalid parent.", &CPI);
3432
David Majnemerfe2f7f32016-02-29 22:56:36 +00003433 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003434 visitFuncletPadInst(CPI);
3435}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003436
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003437void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3438 User *FirstUser = nullptr;
3439 Value *FirstUnwindPad = nullptr;
3440 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003441 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003442
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003443 while (!Worklist.empty()) {
3444 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003445 Assert(Seen.insert(CurrentPad).second,
3446 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003447 Value *UnresolvedAncestorPad = nullptr;
3448 for (User *U : CurrentPad->users()) {
3449 BasicBlock *UnwindDest;
3450 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3451 UnwindDest = CRI->getUnwindDest();
3452 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3453 // We allow catchswitch unwind to caller to nest
3454 // within an outer pad that unwinds somewhere else,
3455 // because catchswitch doesn't have a nounwind variant.
3456 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3457 if (CSI->unwindsToCaller())
3458 continue;
3459 UnwindDest = CSI->getUnwindDest();
3460 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3461 UnwindDest = II->getUnwindDest();
3462 } else if (isa<CallInst>(U)) {
3463 // Calls which don't unwind may be found inside funclet
3464 // pads that unwind somewhere else. We don't *require*
3465 // such calls to be annotated nounwind.
3466 continue;
3467 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3468 // The unwind dest for a cleanup can only be found by
3469 // recursive search. Add it to the worklist, and we'll
3470 // search for its first use that determines where it unwinds.
3471 Worklist.push_back(CPI);
3472 continue;
3473 } else {
3474 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3475 continue;
3476 }
3477
3478 Value *UnwindPad;
3479 bool ExitsFPI;
3480 if (UnwindDest) {
3481 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003482 if (!cast<Instruction>(UnwindPad)->isEHPad())
3483 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003484 Value *UnwindParent = getParentPad(UnwindPad);
3485 // Ignore unwind edges that don't exit CurrentPad.
3486 if (UnwindParent == CurrentPad)
3487 continue;
3488 // Determine whether the original funclet pad is exited,
3489 // and if we are scanning nested pads determine how many
3490 // of them are exited so we can stop searching their
3491 // children.
3492 Value *ExitedPad = CurrentPad;
3493 ExitsFPI = false;
3494 do {
3495 if (ExitedPad == &FPI) {
3496 ExitsFPI = true;
3497 // Now we can resolve any ancestors of CurrentPad up to
3498 // FPI, but not including FPI since we need to make sure
3499 // to check all direct users of FPI for consistency.
3500 UnresolvedAncestorPad = &FPI;
3501 break;
3502 }
3503 Value *ExitedParent = getParentPad(ExitedPad);
3504 if (ExitedParent == UnwindParent) {
3505 // ExitedPad is the ancestor-most pad which this unwind
3506 // edge exits, so we can resolve up to it, meaning that
3507 // ExitedParent is the first ancestor still unresolved.
3508 UnresolvedAncestorPad = ExitedParent;
3509 break;
3510 }
3511 ExitedPad = ExitedParent;
3512 } while (!isa<ConstantTokenNone>(ExitedPad));
3513 } else {
3514 // Unwinding to caller exits all pads.
3515 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3516 ExitsFPI = true;
3517 UnresolvedAncestorPad = &FPI;
3518 }
3519
3520 if (ExitsFPI) {
3521 // This unwind edge exits FPI. Make sure it agrees with other
3522 // such edges.
3523 if (FirstUser) {
3524 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3525 "pad must have the same unwind "
3526 "dest",
3527 &FPI, U, FirstUser);
3528 } else {
3529 FirstUser = U;
3530 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003531 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3532 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3533 getParentPad(UnwindPad) == getParentPad(&FPI))
3534 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003535 }
3536 }
3537 // Make sure we visit all uses of FPI, but for nested pads stop as
3538 // soon as we know where they unwind to.
3539 if (CurrentPad != &FPI)
3540 break;
3541 }
3542 if (UnresolvedAncestorPad) {
3543 if (CurrentPad == UnresolvedAncestorPad) {
3544 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3545 // we've found an unwind edge that exits it, because we need to verify
3546 // all direct uses of FPI.
3547 assert(CurrentPad == &FPI);
3548 continue;
3549 }
3550 // Pop off the worklist any nested pads that we've found an unwind
3551 // destination for. The pads on the worklist are the uncles,
3552 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3553 // for all ancestors of CurrentPad up to but not including
3554 // UnresolvedAncestorPad.
3555 Value *ResolvedPad = CurrentPad;
3556 while (!Worklist.empty()) {
3557 Value *UnclePad = Worklist.back();
3558 Value *AncestorPad = getParentPad(UnclePad);
3559 // Walk ResolvedPad up the ancestor list until we either find the
3560 // uncle's parent or the last resolved ancestor.
3561 while (ResolvedPad != AncestorPad) {
3562 Value *ResolvedParent = getParentPad(ResolvedPad);
3563 if (ResolvedParent == UnresolvedAncestorPad) {
3564 break;
3565 }
3566 ResolvedPad = ResolvedParent;
3567 }
3568 // If the resolved ancestor search didn't find the uncle's parent,
3569 // then the uncle is not yet resolved.
3570 if (ResolvedPad != AncestorPad)
3571 break;
3572 // This uncle is resolved, so pop it from the worklist.
3573 Worklist.pop_back();
3574 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003575 }
3576 }
3577
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003578 if (FirstUnwindPad) {
3579 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3580 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3581 Value *SwitchUnwindPad;
3582 if (SwitchUnwindDest)
3583 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3584 else
3585 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3586 Assert(SwitchUnwindPad == FirstUnwindPad,
3587 "Unwind edges out of a catch must have the same unwind dest as "
3588 "the parent catchswitch",
3589 &FPI, FirstUser, CatchSwitch);
3590 }
3591 }
3592
3593 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003594}
3595
David Majnemer8a1c45d2015-12-12 05:38:55 +00003596void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003597 BasicBlock *BB = CatchSwitch.getParent();
3598
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003599 Function *F = BB->getParent();
3600 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003601 "CatchSwitchInst needs to be in a function with a personality.",
3602 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003603
David Majnemer8a1c45d2015-12-12 05:38:55 +00003604 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003605 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003606 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3607 "CatchSwitchInst not the first non-PHI instruction in the block.",
3608 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003609
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003610 auto *ParentPad = CatchSwitch.getParentPad();
3611 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3612 "CatchSwitchInst has an invalid parent.", ParentPad);
3613
David Majnemer8a1c45d2015-12-12 05:38:55 +00003614 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003615 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003616 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3617 "CatchSwitchInst must unwind to an EH block which is not a "
3618 "landingpad.",
3619 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003620
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003621 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3622 if (getParentPad(I) == ParentPad)
3623 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3624 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003625
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003626 Assert(CatchSwitch.getNumHandlers() != 0,
3627 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3628
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003629 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003630 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3631 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003632 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003633
David Majnemerfe2f7f32016-02-29 22:56:36 +00003634 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003635 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003636}
3637
David Majnemer654e1302015-07-31 17:58:14 +00003638void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003639 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3640 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3641 CRI.getOperand(0));
3642
David Majnemer654e1302015-07-31 17:58:14 +00003643 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3644 Instruction *I = UnwindDest->getFirstNonPHI();
3645 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3646 "CleanupReturnInst must unwind to an EH block which is not a "
3647 "landingpad.",
3648 &CRI);
3649 }
3650
3651 visitTerminatorInst(CRI);
3652}
3653
Rafael Espindola654320a2012-02-26 02:23:37 +00003654void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3655 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003656 // If the we have an invalid invoke, don't try to compute the dominance.
3657 // We already reject it in the invoke specific checks and the dominance
3658 // computation doesn't handle multiple edges.
3659 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3660 if (II->getNormalDest() == II->getUnwindDest())
3661 return;
3662 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003663
Michael Kruseff379b62016-03-26 23:32:57 +00003664 // Quick check whether the def has already been encountered in the same block.
3665 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3666 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003667 //
3668 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3669 // wrapping an SSA value, assert that we've already encountered it. See
3670 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003671 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3672 return;
3673
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003674 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003675 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003676 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003677}
3678
Artur Pilipenkocca80022015-10-09 17:41:29 +00003679void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3680 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3681 "apply only to pointer types", &I);
3682 Assert(isa<LoadInst>(I),
3683 "dereferenceable, dereferenceable_or_null apply only to load"
3684 " instructions, use attributes for calls or invokes", &I);
3685 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3686 "take one operand!", &I);
3687 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3688 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3689 "dereferenceable_or_null metadata value must be an i64!", &I);
3690}
3691
Misha Brukmanc566ca362004-03-02 00:22:19 +00003692/// verifyInstruction - Verify that an instruction is well formed.
3693///
Chris Lattner069a7952002-06-25 15:56:27 +00003694void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003695 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003696 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003697
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003698 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003699 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003700 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3701 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003702 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003703 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003704
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003705 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003706 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3707 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003708
Chris Lattner5f126b72004-03-29 00:29:36 +00003709 // Check that the return value of the instruction is either void or a legal
3710 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003711 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3712 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003713
Nick Lewycky93e06a52009-09-27 23:27:42 +00003714 // Check that the instruction doesn't produce metadata. Calls are already
3715 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003716 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3717 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003718
Chris Lattner0e851da2002-04-18 20:37:37 +00003719 // Check that all uses of the instruction, if they are instructions
3720 // themselves, actually have parent basic blocks. If the use is not an
3721 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003722 for (Use &U : I.uses()) {
3723 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003724 Assert(Used->getParent() != nullptr,
3725 "Instruction referencing"
3726 " instruction not embedded in a basic block!",
3727 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003728 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003729 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003730 return;
3731 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003732 }
3733
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003734 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003735 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003736
3737 // Check to make sure that only first-class-values are operands to
3738 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003739 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003740 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003741 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003742
Chris Lattner9ece94b2004-03-14 03:23:54 +00003743 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003744 // Check to make sure that the "address of" an intrinsic function is never
3745 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003746 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003747 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003748 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3749 "Cannot take the address of an intrinsic!", &I);
3750 Assert(
3751 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003752 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003753 F->getIntrinsicID() == Intrinsic::coro_resume ||
3754 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003755 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003756 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3757 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003758 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3759 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003760 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003761 Assert(F->getParent() == &M, "Referencing function in another module!",
3762 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003763 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003764 Assert(OpBB->getParent() == BB->getParent(),
3765 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003766 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003767 Assert(OpArg->getParent() == BB->getParent(),
3768 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003769 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003770 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3771 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003772 } else if (isa<Instruction>(I.getOperand(i))) {
3773 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003774 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003775 Assert((i + 1 == e && isa<CallInst>(I)) ||
3776 (i + 3 == e && isa<InvokeInst>(I)),
3777 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003778 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003779 if (CE->getType()->isPtrOrPtrVectorTy() ||
3780 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003781 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003782 // illegal bitcast. If the datalayout string specifies non-integral
3783 // address spaces then we also need to check for illegal ptrtoint and
3784 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003785 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003786 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003787 }
3788 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003789
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003790 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003791 Assert(I.getType()->isFPOrFPVectorTy(),
3792 "fpmath requires a floating point result!", &I);
3793 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003794 if (ConstantFP *CFP0 =
3795 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003796 const APFloat &Accuracy = CFP0->getValueAPF();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003797 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
Matt Arsenault82f41512016-06-27 19:43:15 +00003798 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003799 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3800 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003801 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003802 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003803 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003804 }
3805
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003806 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003807 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3808 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003809 visitRangeMetadata(I, Range, I.getType());
3810 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003811
Philip Reames0ca58b32014-10-21 20:56:29 +00003812 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003813 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3814 &I);
3815 Assert(isa<LoadInst>(I),
3816 "nonnull applies only to load instructions, use attributes"
3817 " for calls or invokes",
3818 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003819 }
3820
Artur Pilipenkocca80022015-10-09 17:41:29 +00003821 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3822 visitDereferenceableMetadata(I, MD);
3823
3824 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3825 visitDereferenceableMetadata(I, MD);
3826
Mehdi Aminia84a8402016-12-16 06:29:14 +00003827 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
3828 TBAAVerifyHelper.visitTBAAMetadata(I, TBAA);
Sanjoy Das2582e692016-11-08 20:46:01 +00003829
Artur Pilipenkocca80022015-10-09 17:41:29 +00003830 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3831 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3832 &I);
3833 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3834 "use attributes for calls or invokes", &I);
3835 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3836 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3837 Assert(CI && CI->getType()->isIntegerTy(64),
3838 "align metadata value must be an i64!", &I);
3839 uint64_t Align = CI->getZExtValue();
3840 Assert(isPowerOf2_64(Align),
3841 "align metadata value must be a power of 2!", &I);
3842 Assert(Align <= Value::MaximumAlignment,
3843 "alignment is larger that implementation defined limit", &I);
3844 }
3845
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003846 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003847 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003848 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003849 }
3850
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003851 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Adrian Prantl941fa752016-12-05 18:04:47 +00003852 verifyFragmentExpression(*DII);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003853
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003854 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003855}
3856
Philip Reames007561a2015-06-26 22:21:52 +00003857/// Allow intrinsics to be verified in different ways.
3858void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003859 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003860 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3861 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003862
Chris Lattner144b6192012-05-27 19:37:05 +00003863 // Verify that the intrinsic prototype lines up with what the .td files
3864 // describe.
3865 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003866 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003867
Chris Lattner144b6192012-05-27 19:37:05 +00003868 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3869 getIntrinsicInfoTableEntries(ID, Table);
3870 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003871
Chris Lattner144b6192012-05-27 19:37:05 +00003872 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003873 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3874 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003875 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003876 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003877 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3878 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003879 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003880
3881 // Verify if the intrinsic call matches the vararg property.
3882 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003883 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003884 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003885 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003886 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003887 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003888
3889 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003890 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003891
3892 // Now that we have the intrinsic ID and the actual argument types (and we
3893 // know they are legal for the intrinsic!) get the intrinsic name through the
3894 // usual means. This allows us to verify the mangling of argument types into
3895 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003896 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003897 Assert(ExpectedName == IF->getName(),
3898 "Intrinsic name not mangled correctly for type arguments! "
3899 "Should be: " +
3900 ExpectedName,
3901 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003902
Chris Lattner588096e2009-12-28 09:07:21 +00003903 // If the intrinsic takes MDNode arguments, verify that they are either global
3904 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003905 for (Value *V : CS.args())
3906 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3907 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003908
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003909 switch (ID) {
3910 default:
3911 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003912 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003913 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003914 if (isa<ConstantPointerNull>(InfoArg))
3915 break;
3916 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3917 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3918 "info argument of llvm.coro.begin must refer to an initialized "
3919 "constant");
3920 Constant *Init = GV->getInitializer();
3921 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3922 "info argument of llvm.coro.begin must refer to either a struct or "
3923 "an array");
3924 break;
3925 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003926 case Intrinsic::ctlz: // llvm.ctlz
3927 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003928 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003929 "is_zero_undef argument of bit counting intrinsics must be a "
3930 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003931 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003932 break;
Andrew Kaylora0a11642017-01-26 23:27:59 +00003933 case Intrinsic::experimental_constrained_fadd:
3934 case Intrinsic::experimental_constrained_fsub:
3935 case Intrinsic::experimental_constrained_fmul:
3936 case Intrinsic::experimental_constrained_fdiv:
3937 case Intrinsic::experimental_constrained_frem:
3938 visitConstrainedFPIntrinsic(
3939 cast<ConstrainedFPIntrinsic>(*CS.getInstruction()));
3940 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003941 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003942 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3943 "invalid llvm.dbg.declare intrinsic call 1", CS);
3944 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003945 break;
3946 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003947 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003948 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003949 case Intrinsic::memcpy:
3950 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003951 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003952 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003953 Assert(AlignCI,
3954 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003955 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003956 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003957 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003958 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003959 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003960 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003961 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003962 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003963 }
Igor Laevsky4f31e522016-12-29 14:31:07 +00003964 case Intrinsic::memcpy_element_atomic: {
3965 ConstantInt *ElementSizeCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3966 Assert(ElementSizeCI, "element size of the element-wise atomic memory "
3967 "intrinsic must be a constant int",
3968 CS);
3969 const APInt &ElementSizeVal = ElementSizeCI->getValue();
3970 Assert(ElementSizeVal.isPowerOf2(),
3971 "element size of the element-wise atomic memory intrinsic "
3972 "must be a power of 2",
3973 CS);
3974
3975 auto IsValidAlignment = [&](uint64_t Alignment) {
3976 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
3977 };
3978
3979 uint64_t DstAlignment = CS.getParamAlignment(1),
3980 SrcAlignment = CS.getParamAlignment(2);
3981
3982 Assert(IsValidAlignment(DstAlignment),
3983 "incorrect alignment of the destination argument",
3984 CS);
3985 Assert(IsValidAlignment(SrcAlignment),
3986 "incorrect alignment of the source argument",
3987 CS);
3988 break;
3989 }
Bill Wendling05604e02008-08-23 09:46:46 +00003990 case Intrinsic::gcroot:
3991 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003992 case Intrinsic::gcread:
3993 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003994 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003995 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3996 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3997 Assert(isa<Constant>(CS.getArgOperand(1)),
3998 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003999 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00004000 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004001 "llvm.gcroot parameter #1 must either be a pointer alloca, "
4002 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00004003 CS);
Talin2e59f142010-09-30 20:23:47 +00004004 }
Chris Lattner25852062008-08-24 20:46:13 +00004005 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00004006
Philip Reames9818dd72015-06-26 22:04:34 +00004007 Assert(CS.getParent()->getParent()->hasGC(),
4008 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00004009 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00004010 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00004011 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004012 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00004013 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004014 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004015 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004016 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4017 isa<ConstantInt>(CS.getArgOperand(2)) &&
4018 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4019 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4020 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004021 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004022 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004023 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4024 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004025 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004026 case Intrinsic::lifetime_start:
4027 case Intrinsic::lifetime_end:
4028 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004029 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004030 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004031 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004032 break;
4033 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004034 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4035 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004036 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004037
Reid Kleckner60381792015-07-07 22:25:32 +00004038 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004039 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004040 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004041 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004042 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004043 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004044 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004045 if (isa<ConstantPointerNull>(Arg))
4046 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004047 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004048 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004049 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004050 }
Philip Reames9818dd72015-06-26 22:04:34 +00004051 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004052 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004053 break;
4054 }
Reid Kleckner60381792015-07-07 22:25:32 +00004055 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004056 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004057 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004058 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004059 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004060 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004061 CS);
4062 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004063 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004064 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004065 auto &Entry = FrameEscapeInfo[Fn];
4066 Entry.second = unsigned(
4067 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004068 break;
4069 }
4070
Philip Reames1ffa9372015-01-30 23:28:05 +00004071 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004072 Assert(!CS.isInlineAsm(),
4073 "gc.statepoint support for inline assembly unimplemented", CS);
4074 Assert(CS.getParent()->getParent()->hasGC(),
4075 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004076
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004077 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004078 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004079 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004080 Assert(CS.getParent()->getParent()->hasGC(),
4081 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004082 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004083 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004084 const Function *StatepointFn =
4085 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004086 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4087 StatepointFn->getIntrinsicID() ==
4088 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004089 "gc.result operand #1 must be from a statepoint", CS,
4090 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004091
Philip Reamesb23713a2014-12-03 22:23:24 +00004092 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004093 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004094 auto *PT = cast<PointerType>(Target->getType());
4095 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004096 Assert(CS.getType() == TargetFuncType->getReturnType(),
4097 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004098 break;
4099 }
4100 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004101 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004102
Philip Reames3e2cf532016-01-07 03:32:11 +00004103 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4104 "gc.relocate must return a pointer or a vector of pointers", CS);
4105
Igor Laevsky9570ff92015-02-19 11:28:47 +00004106 // Check that this relocate is correctly tied to the statepoint
4107
4108 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004109 if (LandingPadInst *LandingPad =
4110 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004111
Sanjoy Das5665c992015-05-11 23:47:27 +00004112 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004113 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004114
4115 // Landingpad relocates should have only one predecessor with invoke
4116 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004117 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004118 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004119 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4120 InvokeBB);
4121 Assert(isStatepoint(InvokeBB->getTerminator()),
4122 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004123 }
4124 else {
4125 // In all other cases relocate should be tied to the statepoint directly.
4126 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004127 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004128 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004129 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004130 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004131 }
4132
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004133 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004134
Manuel Jacob83eefa62016-01-05 04:03:00 +00004135 ImmutableCallSite StatepointCS(
4136 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004137
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004138 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004139 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004140 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004141 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004142
Philip Reames9818dd72015-06-26 22:04:34 +00004143 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004144 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004145 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004146
4147 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4148 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4149 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004150 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004151 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004152 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004153 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004154
4155 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004156 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004157 Assert(StatepointCS.arg_size() > 0,
4158 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004159 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004160 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004161 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004162 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4163 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004164 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004165 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004166 "gc.statepoint: number of transition arguments must be "
4167 "a constant integer");
4168 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004169 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4170 ->getZExtValue();
4171 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004172 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004173 "gc.statepoint: number of deoptimization arguments must be "
4174 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004175 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004176 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4177 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004178 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004179 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004180 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4181 "gc.relocate: statepoint base index doesn't fall within the "
4182 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004183 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004184 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4185 "gc.relocate: statepoint derived index doesn't fall within the "
4186 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004187 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004188
Philip Reames3e2cf532016-01-07 03:32:11 +00004189 // Relocated value must be either a pointer type or vector-of-pointer type,
4190 // but gc_relocate does not need to return the same pointer type as the
4191 // relocated pointer. It can be casted to the correct type later if it's
4192 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004193 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004194 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004195 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004196
Philip Reames3e2cf532016-01-07 03:32:11 +00004197 auto ResultType = CS.getType();
4198 auto DerivedType = Relocate.getDerivedPtr()->getType();
4199 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004200 "gc.relocate: vector relocates to vector and pointer to pointer",
4201 CS);
4202 Assert(
4203 ResultType->getPointerAddressSpace() ==
4204 DerivedType->getPointerAddressSpace(),
4205 "gc.relocate: relocating a pointer shouldn't change its address space",
4206 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004207 break;
4208 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004209 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004210 case Intrinsic::eh_exceptionpointer: {
4211 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4212 "eh.exceptionpointer argument must be a catchpad", CS);
4213 break;
4214 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004215 case Intrinsic::masked_load: {
4216 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4217
4218 Value *Ptr = CS.getArgOperand(0);
4219 //Value *Alignment = CS.getArgOperand(1);
4220 Value *Mask = CS.getArgOperand(2);
4221 Value *PassThru = CS.getArgOperand(3);
4222 Assert(Mask->getType()->isVectorTy(),
4223 "masked_load: mask must be vector", CS);
4224
4225 // DataTy is the overloaded type
4226 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4227 Assert(DataTy == CS.getType(),
4228 "masked_load: return must match pointer type", CS);
4229 Assert(PassThru->getType() == DataTy,
4230 "masked_load: pass through and data type must match", CS);
4231 Assert(Mask->getType()->getVectorNumElements() ==
4232 DataTy->getVectorNumElements(),
4233 "masked_load: vector mask must be same length as data", CS);
4234 break;
4235 }
4236 case Intrinsic::masked_store: {
4237 Value *Val = CS.getArgOperand(0);
4238 Value *Ptr = CS.getArgOperand(1);
4239 //Value *Alignment = CS.getArgOperand(2);
4240 Value *Mask = CS.getArgOperand(3);
4241 Assert(Mask->getType()->isVectorTy(),
4242 "masked_store: mask must be vector", CS);
4243
4244 // DataTy is the overloaded type
4245 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4246 Assert(DataTy == Val->getType(),
4247 "masked_store: storee must match pointer type", CS);
4248 Assert(Mask->getType()->getVectorNumElements() ==
4249 DataTy->getVectorNumElements(),
4250 "masked_store: vector mask must be same length as data", CS);
4251 break;
4252 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004253
Sanjoy Das021de052016-03-31 00:18:46 +00004254 case Intrinsic::experimental_guard: {
4255 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4256 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4257 "experimental_guard must have exactly one "
4258 "\"deopt\" operand bundle");
4259 break;
4260 }
4261
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004262 case Intrinsic::experimental_deoptimize: {
4263 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4264 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4265 "experimental_deoptimize must have exactly one "
4266 "\"deopt\" operand bundle");
4267 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4268 "experimental_deoptimize return type must match caller return type");
4269
4270 if (CS.isCall()) {
4271 auto *DeoptCI = CS.getInstruction();
4272 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4273 Assert(RI,
4274 "calls to experimental_deoptimize must be followed by a return");
4275
4276 if (!CS.getType()->isVoidTy() && RI)
4277 Assert(RI->getReturnValue() == DeoptCI,
4278 "calls to experimental_deoptimize must be followed by a return "
4279 "of the value computed by experimental_deoptimize");
4280 }
4281
4282 break;
4283 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004284 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004285}
4286
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004287/// \brief Carefully grab the subprogram from a local scope.
4288///
4289/// This carefully grabs the subprogram from a local scope, avoiding the
4290/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004291static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004292 if (!LocalScope)
4293 return nullptr;
4294
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004295 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004296 return SP;
4297
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004298 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004299 return getSubprogram(LB->getRawScope());
4300
4301 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004302 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004303 return nullptr;
4304}
4305
Andrew Kaylora0a11642017-01-26 23:27:59 +00004306void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
4307 Assert(isa<MetadataAsValue>(FPI.getOperand(2)),
4308 "invalid rounding mode argument", &FPI);
4309 Assert(FPI.getRoundingMode() != ConstrainedFPIntrinsic::rmInvalid,
4310 "invalid rounding mode argument", &FPI);
4311 Assert(FPI.getExceptionBehavior() != ConstrainedFPIntrinsic::ebInvalid,
4312 "invalid exception behavior argument", &FPI);
4313}
4314
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004315template <class DbgIntrinsicTy>
4316void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4317 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004318 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004319 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4320 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004321 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004322 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4323 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004324 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004325 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4326 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004327
4328 // Ignore broken !dbg attachments; they're checked elsewhere.
4329 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004330 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004331 return;
4332
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004333 BasicBlock *BB = DII.getParent();
4334 Function *F = BB ? BB->getParent() : nullptr;
4335
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004336 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004337 DILocalVariable *Var = DII.getVariable();
4338 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004339 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4340 &DII, BB, F);
4341
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004342 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4343 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004344 if (!VarSP || !LocSP)
4345 return; // Broken scope chains are checked elsewhere.
4346
Adrian Prantla2ef0472016-09-14 17:30:37 +00004347 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4348 " variable and !dbg attachment",
4349 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4350 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004351}
4352
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004353static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004354 // Be careful of broken types (checked elsewhere).
4355 const Metadata *RawType = V.getRawType();
4356 while (RawType) {
4357 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004358 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004359 if (uint64_t Size = T->getSizeInBits())
4360 return Size;
4361
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004362 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004363 // Look at the base type.
4364 RawType = DT->getRawBaseType();
4365 continue;
4366 }
4367
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004368 // Missing type or size.
4369 break;
4370 }
4371
4372 // Fail gracefully.
4373 return 0;
4374}
4375
Adrian Prantl941fa752016-12-05 18:04:47 +00004376void Verifier::verifyFragmentExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004377 DILocalVariable *V;
4378 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004379 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004380 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4381 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004382 } else {
4383 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004384 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4385 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004386 }
4387
4388 // We don't know whether this intrinsic verified correctly.
4389 if (!V || !E || !E->isValid())
4390 return;
4391
Keno Fischer253a7bd2016-01-15 02:12:38 +00004392 // Nothing to do if this isn't a bit piece expression.
Adrian Prantl49797ca2016-12-22 05:27:12 +00004393 auto Fragment = E->getFragmentInfo();
4394 if (!Fragment)
Keno Fischer253a7bd2016-01-15 02:12:38 +00004395 return;
4396
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004397 // The frontend helps out GDB by emitting the members of local anonymous
4398 // unions as artificial local variables with shared storage. When SROA splits
4399 // the storage for artificial local variables that are smaller than the entire
4400 // union, the overhang piece will be outside of the allotted space for the
4401 // variable and this check fails.
4402 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4403 if (V->isArtificial())
4404 return;
4405
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004406 // If there's no size, the type is broken, but that should be checked
4407 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004408 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004409 if (!VarSize)
4410 return;
4411
Adrian Prantl49797ca2016-12-22 05:27:12 +00004412 unsigned FragSize = Fragment->SizeInBits;
4413 unsigned FragOffset = Fragment->OffsetInBits;
Adrian Prantl941fa752016-12-05 18:04:47 +00004414 AssertDI(FragSize + FragOffset <= VarSize,
4415 "fragment is larger than or outside of variable", &I, V, E);
4416 AssertDI(FragSize != VarSize, "fragment covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004417}
4418
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004419void Verifier::verifyCompileUnits() {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004420 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004421 SmallPtrSet<const Metadata *, 2> Listed;
4422 if (CUs)
4423 Listed.insert(CUs->op_begin(), CUs->op_end());
Adrian Prantla2ef0472016-09-14 17:30:37 +00004424 AssertDI(
David Majnemer0a16c222016-08-11 21:15:00 +00004425 all_of(CUVisited,
4426 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004427 "All DICompileUnits must be listed in llvm.dbg.cu");
4428 CUVisited.clear();
4429}
4430
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004431void Verifier::verifyDeoptimizeCallingConvs() {
4432 if (DeoptimizeDeclarations.empty())
4433 return;
4434
4435 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004436 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004437 Assert(First->getCallingConv() == F->getCallingConv(),
4438 "All llvm.experimental.deoptimize declarations must have the same "
4439 "calling convention",
4440 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004441 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004442}
4443
Chris Lattner0e851da2002-04-18 20:37:37 +00004444//===----------------------------------------------------------------------===//
4445// Implement the public interfaces to this file...
4446//===----------------------------------------------------------------------===//
4447
Chandler Carruth043949d2014-01-19 02:22:18 +00004448bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004449 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004450
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004451 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004452 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004453
4454 // Note that this function's return value is inverted from what you would
4455 // expect of a function called "verify".
4456 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004457}
4458
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004459bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4460 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004461 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004462 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004463
Chandler Carruth043949d2014-01-19 02:22:18 +00004464 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004465 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004466 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004467
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004468 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004469 if (BrokenDebugInfo)
4470 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004471 // Note that this function's return value is inverted from what you would
4472 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004473 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004474}
Chandler Carruth043949d2014-01-19 02:22:18 +00004475
4476namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004477
Chandler Carruth4d356312014-01-20 11:34:08 +00004478struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004479 static char ID;
4480
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004481 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004482 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004483
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004484 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004485 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004486 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004487 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004488 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004489 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004490 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004491 }
4492
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004493 bool doInitialization(Module &M) override {
4494 V = llvm::make_unique<Verifier>(
4495 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4496 return false;
4497 }
4498
Craig Topperf398d7c2014-03-05 06:35:38 +00004499 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004500 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004501 report_fatal_error("Broken function found, compilation aborted!");
4502
4503 return false;
4504 }
4505
Craig Topperf398d7c2014-03-05 06:35:38 +00004506 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004507 bool HasErrors = false;
4508 for (Function &F : M)
4509 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004510 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004511
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004512 HasErrors |= !V->verify();
Adrian Prantl94a903e2016-05-25 21:33:20 +00004513 if (FatalErrors) {
4514 if (HasErrors)
4515 report_fatal_error("Broken module found, compilation aborted!");
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004516 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
Adrian Prantl94a903e2016-05-25 21:33:20 +00004517 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004518
Adrian Prantl94a903e2016-05-25 21:33:20 +00004519 // Strip broken debug info.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004520 if (V->hasBrokenDebugInfo()) {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004521 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4522 M.getContext().diagnose(DiagInvalid);
4523 if (!StripDebugInfo(M))
4524 report_fatal_error("Failed to strip malformed debug info");
4525 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004526 return false;
4527 }
4528
4529 void getAnalysisUsage(AnalysisUsage &AU) const override {
4530 AU.setPreservesAll();
4531 }
4532};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004533
4534} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004535
Mehdi Aminia84a8402016-12-16 06:29:14 +00004536/// Helper to issue failure from the TBAA verification
4537template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
4538 if (Diagnostic)
4539 return Diagnostic->CheckFailed(Args...);
4540}
4541
4542#define AssertTBAA(C, ...) \
4543 do { \
4544 if (!(C)) { \
4545 CheckFailed(__VA_ARGS__); \
4546 return false; \
4547 } \
4548 } while (false)
4549
4550/// Verify that \p BaseNode can be used as the "base type" in the struct-path
4551/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
4552/// struct-type node describing an aggregate data structure (like a struct).
4553TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004554TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004555 if (BaseNode->getNumOperands() < 2) {
4556 CheckFailed("Base nodes must have at least two operands", &I, BaseNode);
4557 return {true, ~0u};
4558 }
4559
4560 auto Itr = TBAABaseNodes.find(BaseNode);
4561 if (Itr != TBAABaseNodes.end())
4562 return Itr->second;
4563
4564 auto Result = verifyTBAABaseNodeImpl(I, BaseNode);
4565 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
4566 (void)InsertResult;
4567 assert(InsertResult.second && "We just checked!");
4568 return Result;
4569}
4570
4571TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004572TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004573 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
4574
4575 if (BaseNode->getNumOperands() == 2) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004576 // Scalar nodes can only be accessed at offset 0.
Sanjoy Das00d76a52016-12-29 15:47:05 +00004577 return isValidScalarTBAANode(BaseNode)
4578 ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
4579 : InvalidNode;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004580 }
4581
4582 if (BaseNode->getNumOperands() % 2 != 1) {
4583 CheckFailed("Struct tag nodes must have an odd number of operands!",
4584 BaseNode);
4585 return InvalidNode;
4586 }
4587
Sanjoy Das00d76a52016-12-29 15:47:05 +00004588 if (!isa<MDString>(BaseNode->getOperand(0))) {
4589 CheckFailed("Struct tag nodes have a string as their first operand",
4590 BaseNode);
4591 return InvalidNode;
4592 }
4593
Mehdi Aminia84a8402016-12-16 06:29:14 +00004594 bool Failed = false;
4595
4596 Optional<APInt> PrevOffset;
4597 unsigned BitWidth = ~0u;
4598
4599 // We've already checked that BaseNode is not a degenerate root node with one
4600 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
4601 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4602 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
4603 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
4604 if (!isa<MDNode>(FieldTy)) {
4605 CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode);
4606 Failed = true;
4607 continue;
4608 }
4609
4610 auto *OffsetEntryCI =
4611 mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset);
4612 if (!OffsetEntryCI) {
4613 CheckFailed("Offset entries must be constants!", &I, BaseNode);
4614 Failed = true;
4615 continue;
4616 }
4617
4618 if (BitWidth == ~0u)
4619 BitWidth = OffsetEntryCI->getBitWidth();
4620
4621 if (OffsetEntryCI->getBitWidth() != BitWidth) {
4622 CheckFailed(
4623 "Bitwidth between the offsets and struct type entries must match", &I,
4624 BaseNode);
4625 Failed = true;
4626 continue;
4627 }
4628
4629 // NB! As far as I can tell, we generate a non-strictly increasing offset
4630 // sequence only from structs that have zero size bit fields. When
4631 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
4632 // pick the field lexically the latest in struct type metadata node. This
4633 // mirrors the actual behavior of the alias analysis implementation.
4634 bool IsAscending =
4635 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
4636
4637 if (!IsAscending) {
4638 CheckFailed("Offsets must be increasing!", &I, BaseNode);
4639 Failed = true;
4640 }
4641
4642 PrevOffset = OffsetEntryCI->getValue();
4643 }
4644
4645 return Failed ? InvalidNode
4646 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
4647}
4648
4649static bool IsRootTBAANode(const MDNode *MD) {
4650 return MD->getNumOperands() < 2;
4651}
4652
4653static bool IsScalarTBAANodeImpl(const MDNode *MD,
4654 SmallPtrSetImpl<const MDNode *> &Visited) {
Sanjoy Das00d76a52016-12-29 15:47:05 +00004655 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004656 return false;
4657
Sanjoy Das00d76a52016-12-29 15:47:05 +00004658 if (!isa<MDString>(MD->getOperand(0)))
Mehdi Aminia84a8402016-12-16 06:29:14 +00004659 return false;
4660
Sanjoy Das00d76a52016-12-29 15:47:05 +00004661 if (MD->getNumOperands() == 3) {
4662 auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
4663 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
4664 return false;
4665 }
4666
4667 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4668 return Parent && Visited.insert(Parent).second &&
Mehdi Aminia84a8402016-12-16 06:29:14 +00004669 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
4670}
4671
Sanjoy Das55f12d92016-12-29 15:46:57 +00004672bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
4673 auto ResultIt = TBAAScalarNodes.find(MD);
4674 if (ResultIt != TBAAScalarNodes.end())
4675 return ResultIt->second;
4676
Mehdi Aminia84a8402016-12-16 06:29:14 +00004677 SmallPtrSet<const MDNode *, 4> Visited;
Sanjoy Das55f12d92016-12-29 15:46:57 +00004678 bool Result = IsScalarTBAANodeImpl(MD, Visited);
4679 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
4680 (void)InsertResult;
4681 assert(InsertResult.second && "Just checked!");
4682
4683 return Result;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004684}
4685
4686/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
4687/// Offset in place to be the offset within the field node returned.
4688///
4689/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
4690MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I,
Sanjoy Das600d2a52016-12-29 15:47:01 +00004691 const MDNode *BaseNode,
Mehdi Aminia84a8402016-12-16 06:29:14 +00004692 APInt &Offset) {
4693 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
4694
4695 // Scalar nodes have only one possible "field" -- their parent in the access
4696 // hierarchy. Offset must be zero at this point, but our caller is supposed
4697 // to Assert that.
4698 if (BaseNode->getNumOperands() == 2)
4699 return cast<MDNode>(BaseNode->getOperand(1));
4700
4701 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4702 auto *OffsetEntryCI =
4703 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
4704 if (OffsetEntryCI->getValue().ugt(Offset)) {
4705 if (Idx == 1) {
4706 CheckFailed("Could not find TBAA parent in struct type node", &I,
4707 BaseNode, &Offset);
4708 return nullptr;
4709 }
4710
4711 auto *PrevOffsetEntryCI =
4712 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx - 1));
4713 Offset -= PrevOffsetEntryCI->getValue();
4714 return cast<MDNode>(BaseNode->getOperand(Idx - 2));
4715 }
4716 }
4717
4718 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
4719 BaseNode->getOperand(BaseNode->getNumOperands() - 1));
4720
4721 Offset -= LastOffsetEntryCI->getValue();
4722 return cast<MDNode>(BaseNode->getOperand(BaseNode->getNumOperands() - 2));
4723}
4724
Sanjoy Das600d2a52016-12-29 15:47:01 +00004725bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004726 AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) ||
Sanjoy Das600d2a52016-12-29 15:47:01 +00004727 isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) ||
4728 isa<AtomicCmpXchgInst>(I),
Mehdi Aminia84a8402016-12-16 06:29:14 +00004729 "TBAA is only for loads, stores and calls!", &I);
4730
4731 bool IsStructPathTBAA =
4732 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
4733
4734 AssertTBAA(
4735 IsStructPathTBAA,
4736 "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I);
4737
4738 AssertTBAA(MD->getNumOperands() < 5,
4739 "Struct tag metadata must have either 3 or 4 operands", &I, MD);
4740
4741 MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
4742 MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4743
4744 if (MD->getNumOperands() == 4) {
4745 auto *IsImmutableCI =
4746 mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(3));
4747 AssertTBAA(IsImmutableCI,
4748 "Immutability tag on struct tag metadata must be a constant", &I,
4749 MD);
4750 AssertTBAA(
4751 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
4752 "Immutability part of the struct tag metadata must be either 0 or 1",
4753 &I, MD);
4754 }
4755
4756 AssertTBAA(BaseNode && AccessType,
4757 "Malformed struct tag metadata: base and access-type "
4758 "should be non-null and point to Metadata nodes",
4759 &I, MD, BaseNode, AccessType);
4760
Sanjoy Das55f12d92016-12-29 15:46:57 +00004761 AssertTBAA(isValidScalarTBAANode(AccessType),
Sanjoy Das00d76a52016-12-29 15:47:05 +00004762 "Access type node must be a valid scalar type", &I, MD,
4763 AccessType);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004764
4765 auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2));
4766 AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD);
4767
4768 APInt Offset = OffsetCI->getValue();
4769 bool SeenAccessTypeInPath = false;
4770
4771 SmallPtrSet<MDNode *, 4> StructPath;
4772
4773 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
4774 BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset)) {
4775 if (!StructPath.insert(BaseNode).second) {
4776 CheckFailed("Cycle detected in struct path", &I, MD);
4777 return false;
4778 }
4779
4780 bool Invalid;
4781 unsigned BaseNodeBitWidth;
4782 std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode);
4783
4784 // If the base node is invalid in itself, then we've already printed all the
4785 // errors we wanted to print.
4786 if (Invalid)
4787 return false;
4788
4789 SeenAccessTypeInPath |= BaseNode == AccessType;
4790
Sanjoy Das55f12d92016-12-29 15:46:57 +00004791 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004792 AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access",
4793 &I, MD, &Offset);
4794
4795 AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
4796 (BaseNodeBitWidth == 0 && Offset == 0),
4797 "Access bit-width not the same as description bit-width", &I, MD,
4798 BaseNodeBitWidth, Offset.getBitWidth());
4799 }
4800
4801 AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!",
4802 &I, MD);
4803 return true;
4804}
4805
Chandler Carruth4d356312014-01-20 11:34:08 +00004806char VerifierLegacyPass::ID = 0;
4807INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004808
4809FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004810 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004811}
4812
Chandler Carruthdab4eae2016-11-23 17:53:26 +00004813AnalysisKey VerifierAnalysis::Key;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004814VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4815 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004816 Result Res;
4817 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4818 return Res;
4819}
Chandler Carruth4d356312014-01-20 11:34:08 +00004820
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004821VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4822 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004823 return { llvm::verifyFunction(F, &dbgs()), false };
4824}
4825
4826PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4827 auto Res = AM.getResult<VerifierAnalysis>(M);
4828 if (FatalErrors) {
4829 if (Res.IRBroken)
4830 report_fatal_error("Broken module found, compilation aborted!");
4831 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4832 }
4833
4834 // Strip broken debug info.
4835 if (Res.DebugInfoBroken) {
4836 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4837 M.getContext().diagnose(DiagInvalid);
4838 if (!StripDebugInfo(M))
4839 report_fatal_error("Failed to strip malformed debug info");
4840 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004841 return PreservedAnalyses::all();
4842}
4843
Adrian Prantle3656182016-05-09 19:57:29 +00004844PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4845 auto res = AM.getResult<VerifierAnalysis>(F);
4846 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004847 report_fatal_error("Broken function found, compilation aborted!");
4848
4849 return PreservedAnalyses::all();
4850}