blob: 4f074a7b7787c1e3833c8fbcba394922ead7f02c [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 Prantlc10d0e52017-05-09 19:47:37 +0000270 /// Keep track which DISubprogram is attached to which function.
271 DenseMap<const DISubprogram *, const Function *> DISubprogramAttachments;
272
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000273 /// Track all DICompileUnits visited.
274 SmallPtrSet<const Metadata *, 2> CUVisited;
275
David Majnemer654e1302015-07-31 17:58:14 +0000276 /// \brief The result type for a landingpad.
277 Type *LandingPadResultTy;
278
Reid Kleckner60381792015-07-07 22:25:32 +0000279 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000280 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000281 bool SawFrameEscape;
282
Adrian Prantl63d96952017-03-07 17:28:54 +0000283 /// Whether the current function has a DISubprogram attached to it.
284 bool HasDebugInfo = false;
285
Reid Kleckner60381792015-07-07 22:25:32 +0000286 /// Stores the count of how many objects were passed to llvm.localescape for a
287 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000288 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000289
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000290 // Maps catchswitches and cleanuppads that unwind to siblings to the
291 // terminators that indicate the unwind, used to detect cycles therein.
292 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
293
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000294 /// Cache of constants visited in search of ConstantExprs.
295 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
296
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000297 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
298 SmallVector<const Function *, 4> DeoptimizeDeclarations;
299
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000300 // Verify that this GlobalValue is only used in this module.
301 // This map is used to avoid visiting uses twice. We can arrive at a user
302 // twice, if they have multiple operands. In particular for very large
303 // constant expressions, we can arrive at a particular user many times.
304 SmallPtrSet<const Value *, 32> GlobalValueVisited;
305
Adrian Prantl612ac862017-02-28 23:48:42 +0000306 // Keeps track of duplicate function argument debug info.
307 SmallVector<const DILocalVariable *, 16> DebugFnArgs;
308
Mehdi Aminia84a8402016-12-16 06:29:14 +0000309 TBAAVerifier TBAAVerifyHelper;
Sanjoy Das3336f682016-12-11 20:07:15 +0000310
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000311 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000312
Chandler Carruth043949d2014-01-19 02:22:18 +0000313public:
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000314 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
315 const Module &M)
316 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
Mehdi Aminia84a8402016-12-16 06:29:14 +0000317 SawFrameEscape(false), TBAAVerifyHelper(this) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000318 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
319 }
320
321 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
Chris Lattner0e851da2002-04-18 20:37:37 +0000322
Chandler Carruth043949d2014-01-19 02:22:18 +0000323 bool verify(const Function &F) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000324 assert(F.getParent() == &M &&
325 "An instance of this class only works with a specific module!");
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000326
327 // First ensure the function is well-enough formed to compute dominance
Peter Collingbourne71bb7942016-06-06 22:32:52 +0000328 // information, and directly compute a dominance tree. We don't rely on the
329 // pass manager to provide this as it isolates us from a potentially
330 // out-of-date dominator tree and makes it significantly more complex to run
331 // this code outside of a pass manager.
332 // FIXME: It's really gross that we have to cast away constness here.
333 if (!F.empty())
334 DT.recalculate(const_cast<Function &>(F));
335
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000336 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000337 if (!BB.empty() && BB.back().isTerminator())
338 continue;
339
340 if (OS) {
341 *OS << "Basic Block in function '" << F.getName()
342 << "' does not have terminator!\n";
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000343 BB.printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000344 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000345 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000346 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000347 }
Chandler Carruth76777602014-01-17 10:56:02 +0000348
Chandler Carruth043949d2014-01-19 02:22:18 +0000349 Broken = false;
350 // FIXME: We strip const here because the inst visitor strips const.
351 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000352 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000353 InstsInThisBlock.clear();
Adrian Prantl9b24a452017-03-07 17:28:49 +0000354 DebugFnArgs.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000355 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000356 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000357 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000358
Chandler Carruth043949d2014-01-19 02:22:18 +0000359 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000360 }
361
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000362 /// Verify the module that this instance of \c Verifier was initialized with.
363 bool verify() {
Chandler Carruth043949d2014-01-19 02:22:18 +0000364 Broken = false;
365
Peter Collingbournebb738172016-06-06 23:21:27 +0000366 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
367 for (const Function &F : M)
368 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
369 DeoptimizeDeclarations.push_back(&F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000370
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000371 // Now that we've visited every function, verify that we never asked to
372 // recover a frame index that wasn't escaped.
373 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000374 for (const GlobalVariable &GV : M.globals())
375 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000376
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000377 for (const GlobalAlias &GA : M.aliases())
378 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000379
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000380 for (const NamedMDNode &NMD : M.named_metadata())
381 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000382
David Majnemerdad0a642014-06-27 18:19:56 +0000383 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
384 visitComdat(SMEC.getValue());
385
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000386 visitModuleFlags(M);
387 visitModuleIdents(M);
388
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000389 verifyCompileUnits();
390
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000391 verifyDeoptimizeCallingConvs();
Adrian Prantlc10d0e52017-05-09 19:47:37 +0000392 DISubprogramAttachments.clear();
Chandler Carruth043949d2014-01-19 02:22:18 +0000393 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000394 }
Chris Lattner9713b842002-04-28 16:04:26 +0000395
Chandler Carruth043949d2014-01-19 02:22:18 +0000396private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000397 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000398 void visitGlobalValue(const GlobalValue &GV);
399 void visitGlobalVariable(const GlobalVariable &GV);
400 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000401 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000402 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000403 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000404 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000405 void visitMDNode(const MDNode &MD);
406 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
407 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000408 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000409 void visitModuleIdents(const Module &M);
410 void visitModuleFlags(const Module &M);
411 void visitModuleFlag(const MDNode *Op,
412 DenseMap<const MDString *, const MDNode *> &SeenIDs,
413 SmallVectorImpl<const MDNode *> &Requirements);
414 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000415 void visitBasicBlock(BasicBlock &BB);
Sanjoy Das26f28a22016-11-09 19:36:39 +0000416 void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty);
417 void visitDereferenceableMetadata(Instruction &I, MDNode *MD);
Sanjoy Das3336f682016-12-11 20:07:15 +0000418
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000419 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000420#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
421#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000422 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000423 void visitDIVariable(const DIVariable &N);
424 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
425 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000426
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000427 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
428
Chandler Carruth043949d2014-01-19 02:22:18 +0000429 // InstVisitor overrides...
430 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000431 void visit(Instruction &I);
432
433 void visitTruncInst(TruncInst &I);
434 void visitZExtInst(ZExtInst &I);
435 void visitSExtInst(SExtInst &I);
436 void visitFPTruncInst(FPTruncInst &I);
437 void visitFPExtInst(FPExtInst &I);
438 void visitFPToUIInst(FPToUIInst &I);
439 void visitFPToSIInst(FPToSIInst &I);
440 void visitUIToFPInst(UIToFPInst &I);
441 void visitSIToFPInst(SIToFPInst &I);
442 void visitIntToPtrInst(IntToPtrInst &I);
443 void visitPtrToIntInst(PtrToIntInst &I);
444 void visitBitCastInst(BitCastInst &I);
445 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
446 void visitPHINode(PHINode &PN);
447 void visitBinaryOperator(BinaryOperator &B);
448 void visitICmpInst(ICmpInst &IC);
449 void visitFCmpInst(FCmpInst &FC);
450 void visitExtractElementInst(ExtractElementInst &EI);
451 void visitInsertElementInst(InsertElementInst &EI);
452 void visitShuffleVectorInst(ShuffleVectorInst &EI);
453 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
454 void visitCallInst(CallInst &CI);
455 void visitInvokeInst(InvokeInst &II);
456 void visitGetElementPtrInst(GetElementPtrInst &GEP);
457 void visitLoadInst(LoadInst &LI);
458 void visitStoreInst(StoreInst &SI);
459 void verifyDominatesUse(Instruction &I, unsigned i);
460 void visitInstruction(Instruction &I);
461 void visitTerminatorInst(TerminatorInst &I);
462 void visitBranchInst(BranchInst &BI);
463 void visitReturnInst(ReturnInst &RI);
464 void visitSwitchInst(SwitchInst &SI);
465 void visitIndirectBrInst(IndirectBrInst &BI);
466 void visitSelectInst(SelectInst &SI);
467 void visitUserOp1(Instruction &I);
468 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000469 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Andrew Kaylora0a11642017-01-26 23:27:59 +0000470 void visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000471 template <class DbgIntrinsicTy>
472 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000473 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
474 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
475 void visitFenceInst(FenceInst &FI);
476 void visitAllocaInst(AllocaInst &AI);
477 void visitExtractValueInst(ExtractValueInst &EVI);
478 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000479 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000480 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000481 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000482 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000483 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000484 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000485 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000486 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000487 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000488
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000489 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000490 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
491 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000492 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000493 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000494 unsigned ArgNo, std::string &Suffix);
Reid Klecknerb5180542017-03-21 16:57:19 +0000495 bool verifyAttributeCount(AttributeList Attrs, unsigned Params);
Reid Klecknera77172a2017-04-14 00:06:06 +0000496 void verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000497 const Value *V);
Reid Klecknera77172a2017-04-14 00:06:06 +0000498 void verifyParameterAttrs(AttributeSet Attrs, Type *Ty, const Value *V);
Reid Klecknerb5180542017-03-21 16:57:19 +0000499 void verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000500 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000501 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000502
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000503 void visitConstantExprsRecursively(const Constant *EntryC);
504 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000505 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000506 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000507 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000508
Adrian Prantl941fa752016-12-05 18:04:47 +0000509 void verifyFragmentExpression(const DbgInfoIntrinsic &I);
Adrian Prantl612ac862017-02-28 23:48:42 +0000510 void verifyFnArgs(const DbgInfoIntrinsic &I);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000511
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000512 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000513 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000514
515 /// Module-level verification that all @llvm.experimental.deoptimize
516 /// declarations share the same calling convention.
517 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000518};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000519
520} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000521
Adrian Prantl541a9c52016-05-06 19:26:47 +0000522/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000523#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000524 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000525
Adrian Prantl541a9c52016-05-06 19:26:47 +0000526/// We know that a debug info condition should be true, if not print
527/// an error message.
528#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000529 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000530
Chris Lattnere5a22c02008-08-28 04:02:44 +0000531void Verifier::visit(Instruction &I) {
532 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000533 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000534 InstVisitor<Verifier>::visit(I);
535}
536
Keno Fischer60f82a22016-01-14 22:20:56 +0000537// Helper to recursively iterate over indirect users. By
538// returning false, the callback can ask to stop recursing
539// further.
540static void forEachUser(const Value *User,
541 SmallPtrSet<const Value *, 32> &Visited,
542 llvm::function_ref<bool(const Value *)> Callback) {
543 if (!Visited.insert(User).second)
544 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000545 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000546 if (Callback(TheNextUser))
547 forEachUser(TheNextUser, Visited, Callback);
548}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000549
Chandler Carruth043949d2014-01-19 02:22:18 +0000550void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000551 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000552 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000553
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000554 Assert(GV.getAlignment() <= Value::MaximumAlignment,
555 "huge alignment values are unsupported", &GV);
556 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
557 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000558
559 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000560 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000561 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000562 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000563 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000564
565 if (GV.isDeclarationForLinker())
566 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000567
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000568 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000569 if (const Instruction *I = dyn_cast<Instruction>(V)) {
570 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000571 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
572 I);
573 else if (I->getParent()->getParent()->getParent() != &M)
574 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
575 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000576 I->getParent()->getParent()->getParent());
577 return false;
578 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000579 if (F->getParent() != &M)
580 CheckFailed("Global is used by function in a different module", &GV, &M,
581 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000582 return false;
583 }
584 return true;
585 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000586}
587
Chandler Carruth043949d2014-01-19 02:22:18 +0000588void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000589 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000590 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000591 "Global variable initializer type does not match global "
592 "variable type!",
593 &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000594 // If the global has common linkage, it must have a zero initializer and
595 // cannot be constant.
596 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000597 Assert(GV.getInitializer()->isNullValue(),
598 "'common' global must have a zero initializer!", &GV);
599 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
600 &GV);
601 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000602 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000603 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000604
Nick Lewycky466d0c12011-04-08 07:30:21 +0000605 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
606 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000607 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
608 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000609 // Don't worry about emitting an error for it not being an array,
610 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000611 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000612 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
613 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000614 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000615 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000616 Assert(STy &&
617 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
618 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
619 STy->getTypeAtIndex(1) == FuncPtrTy,
620 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000621 if (STy->getNumElements() == 3) {
622 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000623 Assert(ETy->isPointerTy() &&
624 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
625 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000626 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000627 }
628 }
629
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000630 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000631 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000632 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
633 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000634 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000635 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
636 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000637 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000638 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000639 const Constant *Init = GV.getInitializer();
640 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000641 Assert(InitArray, "wrong initalizer for intrinsic global variable",
642 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000643 for (Value *Op : InitArray->operands()) {
644 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000645 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
646 isa<GlobalAlias>(V),
647 "invalid llvm.used member", V);
648 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000649 }
650 }
651 }
652 }
653
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000654 Assert(!GV.hasDLLImportStorageClass() ||
655 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
656 GV.hasAvailableExternallyLinkage(),
657 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000658
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000659 // Visit any debug info attachments.
660 SmallVector<MDNode *, 1> MDs;
661 GV.getMetadata(LLVMContext::MD_dbg, MDs);
Adrian Prantldc6e0162016-12-20 02:33:30 +0000662 for (auto *MD : MDs) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000663 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
664 visitDIGlobalVariableExpression(*GVE);
665 else
Adrian Prantlfd37e792017-02-23 23:54:29 +0000666 AssertDI(false, "!dbg attachment of global variable must be a "
667 "DIGlobalVariableExpression");
Adrian Prantldc6e0162016-12-20 02:33:30 +0000668 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000669
Matt Arsenault24b49c42013-07-31 17:49:08 +0000670 if (!GV.hasInitializer()) {
671 visitGlobalValue(GV);
672 return;
673 }
674
675 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000676 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000677
Chris Lattnere3400652004-12-15 20:23:49 +0000678 visitGlobalValue(GV);
679}
680
Rafael Espindola64c1e182014-06-03 02:41:57 +0000681void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
682 SmallPtrSet<const GlobalAlias*, 4> Visited;
683 Visited.insert(&GA);
684 visitAliaseeSubExpr(Visited, GA, C);
685}
686
Craig Topper71b7b682014-08-21 05:55:13 +0000687void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000688 const GlobalAlias &GA, const Constant &C) {
689 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000690 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
691 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000692
693 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000694 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000695
Sanjoy Das5ce32722016-04-08 00:48:30 +0000696 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000697 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000698 } else {
699 // Only continue verifying subexpressions of GlobalAliases.
700 // Do not recurse into global initializers.
701 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000702 }
703 }
704
705 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000706 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000707
708 for (const Use &U : C.operands()) {
709 Value *V = &*U;
710 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
711 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
712 else if (const auto *C2 = dyn_cast<Constant>(V))
713 visitAliaseeSubExpr(Visited, GA, *C2);
714 }
715}
716
Chandler Carruth043949d2014-01-19 02:22:18 +0000717void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000718 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
719 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
720 "weak_odr, or external linkage!",
721 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000722 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000723 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
724 Assert(GA.getType() == Aliasee->getType(),
725 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000726
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000727 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
728 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000729
Rafael Espindola64c1e182014-06-03 02:41:57 +0000730 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000731
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000732 visitGlobalValue(GA);
733}
734
Chandler Carruth043949d2014-01-19 02:22:18 +0000735void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000736 // There used to be various other llvm.dbg.* nodes, but we don't support
737 // upgrading them and we want to reserve the namespace for future uses.
738 if (NMD.getName().startswith("llvm.dbg."))
739 AssertDI(NMD.getName() == "llvm.dbg.cu",
740 "unrecognized named metadata node in the llvm.dbg namespace",
741 &NMD);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000742 for (const MDNode *MD : NMD.operands()) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000743 if (NMD.getName() == "llvm.dbg.cu")
Adrian Prantl541a9c52016-05-06 19:26:47 +0000744 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000745
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000746 if (!MD)
747 continue;
748
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000749 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000750 }
751}
752
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000753void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000754 // Only visit each node once. Metadata can be mutually recursive, so this
755 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000756 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000757 return;
758
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000759 switch (MD.getMetadataID()) {
760 default:
761 llvm_unreachable("Invalid MDNode subclass");
762 case Metadata::MDTupleKind:
763 break;
764#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
765 case Metadata::CLASS##Kind: \
766 visit##CLASS(cast<CLASS>(MD)); \
767 break;
768#include "llvm/IR/Metadata.def"
769 }
770
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000771 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000772 if (!Op)
773 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000774 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
775 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000776 if (auto *N = dyn_cast<MDNode>(Op)) {
777 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000778 continue;
779 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000780 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
781 visitValueAsMetadata(*V, nullptr);
782 continue;
783 }
Duncan Sands76d62172010-04-29 16:10:30 +0000784 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000785
786 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000787 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
788 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000789}
790
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000791void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000792 Assert(MD.getValue(), "Expected valid value", &MD);
793 Assert(!MD.getValue()->getType()->isMetadataTy(),
794 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000795
796 auto *L = dyn_cast<LocalAsMetadata>(&MD);
797 if (!L)
798 return;
799
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000800 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000801
802 // If this was an instruction, bb, or argument, verify that it is in the
803 // function that we expect.
804 Function *ActualF = nullptr;
805 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000806 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000807 ActualF = I->getParent()->getParent();
808 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
809 ActualF = BB->getParent();
810 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
811 ActualF = A->getParent();
812 assert(ActualF && "Unimplemented function local metadata case!");
813
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000814 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000815}
816
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000817void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000818 Metadata *MD = MDV.getMetadata();
819 if (auto *N = dyn_cast<MDNode>(MD)) {
820 visitMDNode(*N);
821 return;
822 }
823
824 // Only visit each node once. Metadata can be mutually recursive, so this
825 // avoids infinite recursion here, as well as being an optimization.
826 if (!MDNodes.insert(MD).second)
827 return;
828
829 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
830 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000831}
832
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000833static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
834static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
835static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000836
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000837void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000838 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
839 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000840 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000841 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000842}
843
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000844void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000845 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000846}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000847
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000848void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000849 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000850 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000851}
852
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000853void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000854 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
855 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000856}
857
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000858void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000859 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000860}
861
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000862void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000863 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
864 N.getTag() == dwarf::DW_TAG_unspecified_type,
865 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000866}
867
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000868void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000869 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000870 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000871
Adrian Prantl541a9c52016-05-06 19:26:47 +0000872 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
873 N.getTag() == dwarf::DW_TAG_pointer_type ||
874 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
875 N.getTag() == dwarf::DW_TAG_reference_type ||
876 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
877 N.getTag() == dwarf::DW_TAG_const_type ||
878 N.getTag() == dwarf::DW_TAG_volatile_type ||
879 N.getTag() == dwarf::DW_TAG_restrict_type ||
Victor Leschuke1156c22016-10-31 19:09:38 +0000880 N.getTag() == dwarf::DW_TAG_atomic_type ||
Adrian Prantl541a9c52016-05-06 19:26:47 +0000881 N.getTag() == dwarf::DW_TAG_member ||
882 N.getTag() == dwarf::DW_TAG_inheritance ||
883 N.getTag() == dwarf::DW_TAG_friend,
884 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000885 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000886 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
887 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000888 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000889
Adrian Prantl541a9c52016-05-06 19:26:47 +0000890 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
891 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
892 N.getRawBaseType());
Konstantin Zhuravlyovd5561e02017-03-08 23:55:44 +0000893
894 if (N.getDWARFAddressSpace()) {
895 AssertDI(N.getTag() == dwarf::DW_TAG_pointer_type ||
896 N.getTag() == dwarf::DW_TAG_reference_type,
897 "DWARF address space only applies to pointer or reference types",
898 &N);
899 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000900}
901
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000902static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000903 return (Flags & DINode::FlagLValueReference) &&
904 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000905}
906
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000907void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
908 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000909 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000910 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000911 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
912 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000913 }
914}
915
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000916void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000917 // Common scope checks.
918 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000919
Adrian Prantl541a9c52016-05-06 19:26:47 +0000920 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
921 N.getTag() == dwarf::DW_TAG_structure_type ||
922 N.getTag() == dwarf::DW_TAG_union_type ||
923 N.getTag() == dwarf::DW_TAG_enumeration_type ||
924 N.getTag() == dwarf::DW_TAG_class_type,
925 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000926
Adrian Prantl541a9c52016-05-06 19:26:47 +0000927 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
928 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
929 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000930
Adrian Prantl541a9c52016-05-06 19:26:47 +0000931 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
932 "invalid composite elements", &N, N.getRawElements());
933 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
934 N.getRawVTableHolder());
935 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
936 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000937 if (auto *Params = N.getRawTemplateParams())
938 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000939
940 if (N.getTag() == dwarf::DW_TAG_class_type ||
941 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000942 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
943 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000944 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000945}
946
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000947void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000948 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000949 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000950 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000951 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000952 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000953 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000954 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000955 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
956 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000957}
958
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000959void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000960 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Amjad Aboud7faeecc2016-12-25 10:12:09 +0000961 AssertDI((N.getChecksumKind() != DIFile::CSK_None ||
962 N.getChecksum().empty()), "invalid checksum kind", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000963}
964
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000965void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000966 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
967 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000968
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000969 // Don't bother verifying the compilation directory or producer string
970 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000971 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
972 N.getRawFile());
973 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
974 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000975
Adrian Prantl541a9c52016-05-06 19:26:47 +0000976 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
977 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000978
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000979 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000980 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000981 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000982 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000983 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
984 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000985 }
986 }
987 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000988 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000989 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000990 AssertDI(Op && (isa<DIType>(Op) ||
991 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000992 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000993 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000994 }
995 }
996 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000997 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000998 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000999 AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)),
1000 "invalid global variable ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001001 }
1002 }
1003 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001004 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001005 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001006 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
1007 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001008 }
1009 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001010 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001011 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001012 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001013 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001014 }
1015 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +00001016 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001017}
1018
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001019void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001020 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1021 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +00001022 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001023 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Justin Bognerefc3fbf2017-02-17 23:57:42 +00001024 else
1025 AssertDI(N.getLine() == 0, "line specified with no file", &N, N.getLine());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001026 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001027 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1028 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1029 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001030 if (auto *Params = N.getRawTemplateParams())
1031 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001032 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001033 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1034 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001035 if (auto *RawVars = N.getRawVariables()) {
1036 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001037 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001038 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001039 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1040 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001041 }
1042 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001043 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1044 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001045
Adrian Prantl75819ae2016-04-15 15:57:41 +00001046 auto *Unit = N.getRawUnit();
1047 if (N.isDefinition()) {
1048 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001049 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1050 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1051 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001052 } else {
1053 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001054 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001055 }
Adrian Prantl1d12b882017-04-26 22:56:44 +00001056
1057 if (auto *RawThrownTypes = N.getRawThrownTypes()) {
1058 auto *ThrownTypes = dyn_cast<MDTuple>(RawThrownTypes);
1059 AssertDI(ThrownTypes, "invalid thrown types list", &N, RawThrownTypes);
1060 for (Metadata *Op : ThrownTypes->operands())
1061 AssertDI(Op && isa<DIType>(Op), "invalid thrown type", &N, ThrownTypes,
1062 Op);
1063 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001064}
1065
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001066void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001067 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1068 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1069 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001070}
1071
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001072void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1073 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001074
Adrian Prantl541a9c52016-05-06 19:26:47 +00001075 AssertDI(N.getLine() || !N.getColumn(),
1076 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001077}
1078
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001079void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1080 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001081}
1082
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001083void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001084 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001085 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001086 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001087}
1088
Amjad Abouda9bcf162015-12-10 12:56:35 +00001089void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001090 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1091 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1092 "invalid macinfo type", &N);
1093 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001094 if (!N.getValue().empty()) {
1095 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1096 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001097}
1098
1099void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001100 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1101 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001102 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001103 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001104
1105 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001106 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001107 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001108 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001109 }
1110 }
1111}
1112
Adrian Prantlab1243f2015-06-29 23:03:47 +00001113void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001114 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1115 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001116}
1117
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001118void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001119 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001120}
1121
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001122void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1123 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001124
Adrian Prantl541a9c52016-05-06 19:26:47 +00001125 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1126 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001127}
1128
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001129void Verifier::visitDITemplateValueParameter(
1130 const DITemplateValueParameter &N) {
1131 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001132
Adrian Prantl541a9c52016-05-06 19:26:47 +00001133 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1134 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1135 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1136 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001137}
1138
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001139void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001140 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001141 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1142 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001143 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001144 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001145}
1146
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001147void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001148 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001149 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001150
Adrian Prantl541a9c52016-05-06 19:26:47 +00001151 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1152 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001153 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001154 AssertDI(isa<DIDerivedType>(Member),
1155 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001156 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001157}
1158
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001159void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001160 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001161 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001162
Adrian Prantl541a9c52016-05-06 19:26:47 +00001163 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1164 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1165 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001166}
1167
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001168void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001169 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001170}
1171
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001172void Verifier::visitDIGlobalVariableExpression(
1173 const DIGlobalVariableExpression &GVE) {
1174 AssertDI(GVE.getVariable(), "missing variable");
1175 if (auto *Var = GVE.getVariable())
1176 visitDIGlobalVariable(*Var);
1177 if (auto *Expr = GVE.getExpression())
1178 visitDIExpression(*Expr);
1179}
1180
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001181void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001182 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001183 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001184 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001185 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001186 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001187}
1188
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001189void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001190 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1191 N.getTag() == dwarf::DW_TAG_imported_declaration,
1192 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001193 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001194 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1195 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1196 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001197}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001198
David Majnemerdad0a642014-06-27 18:19:56 +00001199void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001200 // The Module is invalid if the GlobalValue has private linkage. Entities
1201 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001202 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001203 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1204 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001205}
1206
Chandler Carruth043949d2014-01-19 02:22:18 +00001207void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001208 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001209 if (!Idents)
Rafael Espindola0018a592013-10-16 01:49:05 +00001210 return;
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001211
Rafael Espindola0018a592013-10-16 01:49:05 +00001212 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1213 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001214 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001215 Assert(N->getNumOperands() == 1,
1216 "incorrect number of operands in llvm.ident metadata", N);
1217 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1218 ("invalid value for llvm.ident metadata entry operand"
1219 "(the operand should be a string)"),
1220 N->getOperand(0));
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001221 }
Rafael Espindola0018a592013-10-16 01:49:05 +00001222}
1223
Chandler Carruth043949d2014-01-19 02:22:18 +00001224void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001225 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1226 if (!Flags) return;
1227
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001228 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001229 DenseMap<const MDString*, const MDNode*> SeenIDs;
1230 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001231 for (const MDNode *MDN : Flags->operands())
1232 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001233
1234 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001235 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001236 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001237 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001238
Chandler Carruth043949d2014-01-19 02:22:18 +00001239 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001240 if (!Op) {
1241 CheckFailed("invalid requirement on flag, flag is not present in module",
1242 Flag);
1243 continue;
1244 }
1245
1246 if (Op->getOperand(2) != ReqValue) {
1247 CheckFailed(("invalid requirement on flag, "
1248 "flag does not have the required value"),
1249 Flag);
1250 continue;
1251 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001252 }
1253}
1254
Chandler Carruth043949d2014-01-19 02:22:18 +00001255void
1256Verifier::visitModuleFlag(const MDNode *Op,
1257 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1258 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001259 // Each module flag should have three arguments, the merge behavior (a
1260 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001261 Assert(Op->getNumOperands() == 3,
1262 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001263 Module::ModFlagBehavior MFB;
1264 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001265 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001266 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001267 "invalid behavior operand in module flag (expected constant integer)",
1268 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001269 Assert(false,
1270 "invalid behavior operand in module flag (unexpected constant)",
1271 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001272 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001273 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001274 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1275 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001276
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001277 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001278 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001279 case Module::Error:
1280 case Module::Warning:
1281 case Module::Override:
1282 // These behavior types accept any value.
1283 break;
1284
Teresa Johnson2db13692017-05-23 00:08:00 +00001285 case Module::Max: {
1286 Assert(mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2)),
1287 "invalid value for 'max' module flag (expected constant integer)",
1288 Op->getOperand(2));
1289 break;
1290 }
1291
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001292 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001293 // The value should itself be an MDNode with two operands, a flag ID (an
1294 // MDString), and a value.
1295 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001296 Assert(Value && Value->getNumOperands() == 2,
1297 "invalid value for 'require' module flag (expected metadata pair)",
1298 Op->getOperand(2));
1299 Assert(isa<MDString>(Value->getOperand(0)),
1300 ("invalid value for 'require' module flag "
1301 "(first value operand should be a string)"),
1302 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001303
1304 // Append it to the list of requirements, to check once all module flags are
1305 // scanned.
1306 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001307 break;
1308 }
1309
1310 case Module::Append:
1311 case Module::AppendUnique: {
1312 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001313 Assert(isa<MDNode>(Op->getOperand(2)),
1314 "invalid value for 'append'-type module flag "
1315 "(expected a metadata node)",
1316 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001317 break;
1318 }
1319 }
1320
1321 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001322 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001323 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001324 Assert(Inserted,
1325 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001326 }
Matthias Braun89f3bcf2017-05-19 22:37:01 +00001327
1328 if (ID->getString() == "wchar_size") {
1329 ConstantInt *Value
1330 = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
1331 Assert(Value, "wchar_size metadata requires constant integer argument");
Matthias Braun89f3bcf2017-05-19 22:37:01 +00001332 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001333}
1334
Reid Klecknera77172a2017-04-14 00:06:06 +00001335/// Return true if this attribute kind only applies to functions.
1336static bool isFuncOnlyAttr(Attribute::AttrKind Kind) {
1337 switch (Kind) {
1338 case Attribute::NoReturn:
1339 case Attribute::NoUnwind:
1340 case Attribute::NoInline:
1341 case Attribute::AlwaysInline:
1342 case Attribute::OptimizeForSize:
1343 case Attribute::StackProtect:
1344 case Attribute::StackProtectReq:
1345 case Attribute::StackProtectStrong:
1346 case Attribute::SafeStack:
1347 case Attribute::NoRedZone:
1348 case Attribute::NoImplicitFloat:
1349 case Attribute::Naked:
1350 case Attribute::InlineHint:
1351 case Attribute::StackAlignment:
1352 case Attribute::UWTable:
1353 case Attribute::NonLazyBind:
1354 case Attribute::ReturnsTwice:
1355 case Attribute::SanitizeAddress:
1356 case Attribute::SanitizeThread:
1357 case Attribute::SanitizeMemory:
1358 case Attribute::MinSize:
1359 case Attribute::NoDuplicate:
1360 case Attribute::Builtin:
1361 case Attribute::NoBuiltin:
1362 case Attribute::Cold:
1363 case Attribute::OptimizeNone:
1364 case Attribute::JumpTable:
1365 case Attribute::Convergent:
1366 case Attribute::ArgMemOnly:
1367 case Attribute::NoRecurse:
1368 case Attribute::InaccessibleMemOnly:
1369 case Attribute::InaccessibleMemOrArgMemOnly:
1370 case Attribute::AllocSize:
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001371 case Attribute::Speculatable:
Reid Klecknera77172a2017-04-14 00:06:06 +00001372 return true;
1373 default:
1374 break;
1375 }
1376 return false;
1377}
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001378
Reid Klecknera77172a2017-04-14 00:06:06 +00001379/// Return true if this is a function attribute that can also appear on
1380/// arguments.
1381static bool isFuncOrArgAttr(Attribute::AttrKind Kind) {
1382 return Kind == Attribute::ReadOnly || Kind == Attribute::WriteOnly ||
1383 Kind == Attribute::ReadNone;
1384}
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001385
Reid Klecknera77172a2017-04-14 00:06:06 +00001386void Verifier::verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
1387 const Value *V) {
1388 for (Attribute A : Attrs) {
1389 if (A.isStringAttribute())
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001390 continue;
1391
Reid Klecknera77172a2017-04-14 00:06:06 +00001392 if (isFuncOnlyAttr(A.getKindAsEnum())) {
1393 if (!IsFunction) {
1394 CheckFailed("Attribute '" + A.getAsString() +
1395 "' only applies to functions!",
1396 V);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001397 return;
1398 }
Reid Klecknera77172a2017-04-14 00:06:06 +00001399 } else if (IsFunction && !isFuncOrArgAttr(A.getKindAsEnum())) {
1400 CheckFailed("Attribute '" + A.getAsString() +
1401 "' does not apply to functions!",
1402 V);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001403 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001404 }
1405 }
1406}
1407
Duncan Sandsc3a79922009-06-11 08:11:03 +00001408// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001409// value of the specified type. The value V is printed in error messages.
Reid Klecknera77172a2017-04-14 00:06:06 +00001410void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty,
1411 const Value *V) {
1412 if (!Attrs.hasAttributes())
Duncan Sands0009c442008-01-12 16:42:01 +00001413 return;
1414
Reid Klecknera77172a2017-04-14 00:06:06 +00001415 verifyAttributeTypes(Attrs, /*IsFunction=*/false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001416
Reid Klecknera534a382013-12-19 02:14:12 +00001417 // Check for mutually incompatible attributes. Only inreg is compatible with
1418 // sret.
1419 unsigned AttrCount = 0;
Reid Klecknera77172a2017-04-14 00:06:06 +00001420 AttrCount += Attrs.hasAttribute(Attribute::ByVal);
1421 AttrCount += Attrs.hasAttribute(Attribute::InAlloca);
1422 AttrCount += Attrs.hasAttribute(Attribute::StructRet) ||
1423 Attrs.hasAttribute(Attribute::InReg);
1424 AttrCount += Attrs.hasAttribute(Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001425 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1426 "and 'sret' are incompatible!",
1427 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001428
Reid Klecknera77172a2017-04-14 00:06:06 +00001429 Assert(!(Attrs.hasAttribute(Attribute::InAlloca) &&
1430 Attrs.hasAttribute(Attribute::ReadOnly)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001431 "Attributes "
1432 "'inalloca and readonly' are incompatible!",
1433 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001434
Reid Klecknera77172a2017-04-14 00:06:06 +00001435 Assert(!(Attrs.hasAttribute(Attribute::StructRet) &&
1436 Attrs.hasAttribute(Attribute::Returned)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001437 "Attributes "
1438 "'sret and returned' are incompatible!",
1439 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001440
Reid Klecknera77172a2017-04-14 00:06:06 +00001441 Assert(!(Attrs.hasAttribute(Attribute::ZExt) &&
1442 Attrs.hasAttribute(Attribute::SExt)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001443 "Attributes "
1444 "'zeroext and signext' are incompatible!",
1445 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001446
Reid Klecknera77172a2017-04-14 00:06:06 +00001447 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1448 Attrs.hasAttribute(Attribute::ReadOnly)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001449 "Attributes "
1450 "'readnone and readonly' are incompatible!",
1451 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001452
Reid Klecknera77172a2017-04-14 00:06:06 +00001453 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1454 Attrs.hasAttribute(Attribute::WriteOnly)),
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001455 "Attributes "
1456 "'readnone and writeonly' are incompatible!",
1457 V);
1458
Reid Klecknera77172a2017-04-14 00:06:06 +00001459 Assert(!(Attrs.hasAttribute(Attribute::ReadOnly) &&
1460 Attrs.hasAttribute(Attribute::WriteOnly)),
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001461 "Attributes "
1462 "'readonly and writeonly' are incompatible!",
1463 V);
1464
Reid Klecknera77172a2017-04-14 00:06:06 +00001465 Assert(!(Attrs.hasAttribute(Attribute::NoInline) &&
1466 Attrs.hasAttribute(Attribute::AlwaysInline)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001467 "Attributes "
1468 "'noinline and alwaysinline' are incompatible!",
1469 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001470
Reid Klecknera77172a2017-04-14 00:06:06 +00001471 AttrBuilder IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty);
1472 Assert(!AttrBuilder(Attrs).overlaps(IncompatibleAttrs),
1473 "Wrong types for attribute: " +
1474 AttributeSet::get(Context, IncompatibleAttrs).getAsString(),
1475 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001476
Reid Klecknera534a382013-12-19 02:14:12 +00001477 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001478 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001479 if (!PTy->getElementType()->isSized(&Visited)) {
Reid Klecknera77172a2017-04-14 00:06:06 +00001480 Assert(!Attrs.hasAttribute(Attribute::ByVal) &&
1481 !Attrs.hasAttribute(Attribute::InAlloca),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001482 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1483 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001484 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001485 if (!isa<PointerType>(PTy->getElementType()))
Reid Klecknera77172a2017-04-14 00:06:06 +00001486 Assert(!Attrs.hasAttribute(Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00001487 "Attribute 'swifterror' only applies to parameters "
1488 "with pointer to pointer type!",
1489 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001490 } else {
Reid Klecknera77172a2017-04-14 00:06:06 +00001491 Assert(!Attrs.hasAttribute(Attribute::ByVal),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001492 "Attribute 'byval' only applies to parameters with pointer type!",
1493 V);
Reid Klecknera77172a2017-04-14 00:06:06 +00001494 Assert(!Attrs.hasAttribute(Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00001495 "Attribute 'swifterror' only applies to parameters "
1496 "with pointer type!",
1497 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001498 }
Duncan Sands0009c442008-01-12 16:42:01 +00001499}
1500
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001501// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001502// The value V is printed in error messages.
Reid Klecknerb5180542017-03-21 16:57:19 +00001503void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001504 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001505 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001506 return;
1507
Duncan Sands8c582282007-12-21 19:19:01 +00001508 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001509 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001510 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001511 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001512 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001513
Reid Klecknera77172a2017-04-14 00:06:06 +00001514 // Verify return value attributes.
1515 AttributeSet RetAttrs = Attrs.getRetAttributes();
1516 Assert((!RetAttrs.hasAttribute(Attribute::ByVal) &&
1517 !RetAttrs.hasAttribute(Attribute::Nest) &&
1518 !RetAttrs.hasAttribute(Attribute::StructRet) &&
1519 !RetAttrs.hasAttribute(Attribute::NoCapture) &&
1520 !RetAttrs.hasAttribute(Attribute::Returned) &&
1521 !RetAttrs.hasAttribute(Attribute::InAlloca) &&
1522 !RetAttrs.hasAttribute(Attribute::SwiftSelf) &&
1523 !RetAttrs.hasAttribute(Attribute::SwiftError)),
1524 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
1525 "'returned', 'swiftself', and 'swifterror' do not apply to return "
1526 "values!",
1527 V);
1528 Assert((!RetAttrs.hasAttribute(Attribute::ReadOnly) &&
1529 !RetAttrs.hasAttribute(Attribute::WriteOnly) &&
1530 !RetAttrs.hasAttribute(Attribute::ReadNone)),
1531 "Attribute '" + RetAttrs.getAsString() +
1532 "' does not apply to function returns",
1533 V);
1534 verifyParameterAttrs(RetAttrs, FT->getReturnType(), V);
Duncan Sands8c582282007-12-21 19:19:01 +00001535
Reid Klecknera77172a2017-04-14 00:06:06 +00001536 // Verify parameter attributes.
1537 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1538 Type *Ty = FT->getParamType(i);
1539 AttributeSet ArgAttrs = Attrs.getParamAttributes(i);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001540
Reid Klecknera77172a2017-04-14 00:06:06 +00001541 verifyParameterAttrs(ArgAttrs, Ty, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001542
Reid Klecknera77172a2017-04-14 00:06:06 +00001543 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001544 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001545 SawNest = true;
1546 }
1547
Reid Klecknera77172a2017-04-14 00:06:06 +00001548 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001549 Assert(!SawReturned, "More than one parameter has attribute returned!",
1550 V);
1551 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
Reid Klecknera77172a2017-04-14 00:06:06 +00001552 "Incompatible argument and return types for 'returned' attribute",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001553 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001554 SawReturned = true;
1555 }
1556
Reid Klecknera77172a2017-04-14 00:06:06 +00001557 if (ArgAttrs.hasAttribute(Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001558 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
Reid Klecknera77172a2017-04-14 00:06:06 +00001559 Assert(i == 0 || i == 1,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001560 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001561 SawSRet = true;
1562 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001563
Reid Klecknera77172a2017-04-14 00:06:06 +00001564 if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) {
Manman Renf46262e2016-03-29 17:37:21 +00001565 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1566 SawSwiftSelf = true;
1567 }
1568
Reid Klecknera77172a2017-04-14 00:06:06 +00001569 if (ArgAttrs.hasAttribute(Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00001570 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1571 V);
1572 SawSwiftError = true;
1573 }
1574
Reid Klecknera77172a2017-04-14 00:06:06 +00001575 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) {
1576 Assert(i == FT->getNumParams() - 1,
1577 "inalloca isn't on the last parameter!", V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001578 }
Duncan Sands8c582282007-12-21 19:19:01 +00001579 }
Devang Patel9cc98122008-10-01 23:41:25 +00001580
Reid Klecknerb5180542017-03-21 16:57:19 +00001581 if (!Attrs.hasAttributes(AttributeList::FunctionIndex))
Bill Wendling77543892013-01-18 21:11:39 +00001582 return;
1583
Reid Klecknera77172a2017-04-14 00:06:06 +00001584 verifyAttributeTypes(Attrs.getFnAttributes(), /*IsFunction=*/true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001585
Reid Klecknera77172a2017-04-14 00:06:06 +00001586 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1587 Attrs.hasFnAttribute(Attribute::ReadOnly)),
1588 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001589
Reid Klecknera77172a2017-04-14 00:06:06 +00001590 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1591 Attrs.hasFnAttribute(Attribute::WriteOnly)),
1592 "Attributes 'readnone and writeonly' are incompatible!", V);
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001593
Reid Klecknera77172a2017-04-14 00:06:06 +00001594 Assert(!(Attrs.hasFnAttribute(Attribute::ReadOnly) &&
1595 Attrs.hasFnAttribute(Attribute::WriteOnly)),
1596 "Attributes 'readonly and writeonly' are incompatible!", V);
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001597
Reid Klecknera77172a2017-04-14 00:06:06 +00001598 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1599 Attrs.hasFnAttribute(Attribute::InaccessibleMemOrArgMemOnly)),
1600 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are "
1601 "incompatible!",
1602 V);
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001603
Reid Klecknera77172a2017-04-14 00:06:06 +00001604 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1605 Attrs.hasFnAttribute(Attribute::InaccessibleMemOnly)),
1606 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001607
Reid Klecknera77172a2017-04-14 00:06:06 +00001608 Assert(!(Attrs.hasFnAttribute(Attribute::NoInline) &&
1609 Attrs.hasFnAttribute(Attribute::AlwaysInline)),
1610 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001611
Reid Klecknera77172a2017-04-14 00:06:06 +00001612 if (Attrs.hasFnAttribute(Attribute::OptimizeNone)) {
1613 Assert(Attrs.hasFnAttribute(Attribute::NoInline),
1614 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001615
Reid Klecknera77172a2017-04-14 00:06:06 +00001616 Assert(!Attrs.hasFnAttribute(Attribute::OptimizeForSize),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001617 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001618
Reid Klecknera77172a2017-04-14 00:06:06 +00001619 Assert(!Attrs.hasFnAttribute(Attribute::MinSize),
1620 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001621 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001622
Reid Klecknera77172a2017-04-14 00:06:06 +00001623 if (Attrs.hasFnAttribute(Attribute::JumpTable)) {
Tom Roeder44cb65f2014-06-05 19:29:43 +00001624 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001625 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001626 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001627 }
George Burgess IV278199f2016-04-12 01:05:35 +00001628
Reid Klecknera77172a2017-04-14 00:06:06 +00001629 if (Attrs.hasFnAttribute(Attribute::AllocSize)) {
George Burgess IV278199f2016-04-12 01:05:35 +00001630 std::pair<unsigned, Optional<unsigned>> Args =
Reid Klecknerb5180542017-03-21 16:57:19 +00001631 Attrs.getAllocSizeArgs(AttributeList::FunctionIndex);
George Burgess IV278199f2016-04-12 01:05:35 +00001632
1633 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1634 if (ParamNo >= FT->getNumParams()) {
1635 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1636 return false;
1637 }
1638
1639 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1640 CheckFailed("'allocsize' " + Name +
1641 " argument must refer to an integer parameter",
1642 V);
1643 return false;
1644 }
1645
1646 return true;
1647 };
1648
1649 if (!CheckParam("element size", Args.first))
1650 return;
1651
1652 if (Args.second && !CheckParam("number of elements", *Args.second))
1653 return;
1654 }
Duncan Sands8c582282007-12-21 19:19:01 +00001655}
1656
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001657void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001658 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001659 for (const auto &Pair : MDs) {
1660 if (Pair.first == LLVMContext::MD_prof) {
1661 MDNode *MD = Pair.second;
Dehao Chena60cdd32017-02-28 18:09:44 +00001662 Assert(MD->getNumOperands() >= 2,
1663 "!prof annotations should have no less than 2 operands", MD);
Diego Novillo2567f3d2015-05-13 15:13:45 +00001664
1665 // Check first operand.
1666 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1667 MD);
1668 Assert(isa<MDString>(MD->getOperand(0)),
1669 "expected string with name of the !prof annotation", MD);
1670 MDString *MDS = cast<MDString>(MD->getOperand(0));
1671 StringRef ProfName = MDS->getString();
1672 Assert(ProfName.equals("function_entry_count"),
1673 "first operand should be 'function_entry_count'", MD);
1674
1675 // Check second operand.
1676 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1677 MD);
1678 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1679 "expected integer argument to function_entry_count", MD);
1680 }
1681 }
1682}
1683
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001684void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1685 if (!ConstantExprVisited.insert(EntryC).second)
1686 return;
1687
1688 SmallVector<const Constant *, 16> Stack;
1689 Stack.push_back(EntryC);
1690
1691 while (!Stack.empty()) {
1692 const Constant *C = Stack.pop_back_val();
1693
1694 // Check this constant expression.
1695 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1696 visitConstantExpr(CE);
1697
Keno Fischerf6d17b92016-01-14 22:42:02 +00001698 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1699 // Global Values get visited separately, but we do need to make sure
1700 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001701 Assert(GV->getParent() == &M, "Referencing global in another module!",
1702 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001703 continue;
1704 }
1705
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001706 // Visit all sub-expressions.
1707 for (const Use &U : C->operands()) {
1708 const auto *OpC = dyn_cast<Constant>(U);
1709 if (!OpC)
1710 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001711 if (!ConstantExprVisited.insert(OpC).second)
1712 continue;
1713 Stack.push_back(OpC);
1714 }
1715 }
1716}
1717
1718void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001719 if (CE->getOpcode() == Instruction::BitCast)
1720 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1721 CE->getType()),
1722 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001723
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001724 if (CE->getOpcode() == Instruction::IntToPtr ||
1725 CE->getOpcode() == Instruction::PtrToInt) {
1726 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1727 ? CE->getType()
1728 : CE->getOperand(0)->getType();
1729 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1730 ? "inttoptr not supported for non-integral pointers"
1731 : "ptrtoint not supported for non-integral pointers";
1732 Assert(
1733 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1734 Msg);
1735 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001736}
1737
Reid Klecknerb5180542017-03-21 16:57:19 +00001738bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) {
Reid Kleckner8bf67fe2017-05-23 17:01:48 +00001739 // There shouldn't be more attribute sets than there are parameters plus the
1740 // function and return value.
1741 return Attrs.getNumAttrSets() <= Params + 2;
Devang Patel82fed672008-09-23 22:35:17 +00001742}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001743
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001744/// Verify that statepoint intrinsic is well formed.
1745void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001746 assert(CS.getCalledFunction() &&
1747 CS.getCalledFunction()->getIntrinsicID() ==
1748 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001749
Philip Reames0285c742015-02-03 23:18:47 +00001750 const Instruction &CI = *CS.getInstruction();
1751
Igor Laevsky39d662f2015-07-11 10:30:36 +00001752 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1753 !CS.onlyAccessesArgMemory(),
1754 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001755 "reordering restrictions required by safepoint semantics",
1756 &CI);
1757
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001758 const Value *IDV = CS.getArgument(0);
1759 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1760 &CI);
1761
1762 const Value *NumPatchBytesV = CS.getArgument(1);
1763 Assert(isa<ConstantInt>(NumPatchBytesV),
1764 "gc.statepoint number of patchable bytes must be a constant integer",
1765 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001766 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001767 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1768 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1769 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1770 "positive",
1771 &CI);
1772
1773 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001774 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001775 Assert(PT && PT->getElementType()->isFunctionTy(),
1776 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001777 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001778
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001779 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001780 Assert(isa<ConstantInt>(NumCallArgsV),
1781 "gc.statepoint number of arguments to underlying call "
1782 "must be constant integer",
1783 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001784 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001785 Assert(NumCallArgs >= 0,
1786 "gc.statepoint number of arguments to underlying call "
1787 "must be positive",
1788 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001789 const int NumParams = (int)TargetFuncType->getNumParams();
1790 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001791 Assert(NumCallArgs >= NumParams,
1792 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001793
1794 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001795 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1796 "gc.statepoint doesn't support wrapping non-void "
1797 "vararg functions yet",
1798 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001799 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001800 Assert(NumCallArgs == NumParams,
1801 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001802
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001803 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001804 Assert(isa<ConstantInt>(FlagsV),
1805 "gc.statepoint flags must be constant integer", &CI);
1806 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1807 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1808 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001809
1810 // Verify that the types of the call parameter arguments match
1811 // the type of the wrapped callee.
1812 for (int i = 0; i < NumParams; i++) {
1813 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001814 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001815 Assert(ArgType == ParamType,
1816 "gc.statepoint call argument does not match wrapped "
1817 "function type",
1818 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001819 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001820
1821 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001822
1823 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1824 Assert(isa<ConstantInt>(NumTransitionArgsV),
1825 "gc.statepoint number of transition arguments "
1826 "must be constant integer",
1827 &CI);
1828 const int NumTransitionArgs =
1829 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1830 Assert(NumTransitionArgs >= 0,
1831 "gc.statepoint number of transition arguments must be positive", &CI);
1832 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1833
1834 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001835 Assert(isa<ConstantInt>(NumDeoptArgsV),
1836 "gc.statepoint number of deoptimization arguments "
1837 "must be constant integer",
1838 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001839 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001840 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1841 "must be positive",
1842 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001843
Pat Gavlincc0431d2015-05-08 18:07:42 +00001844 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001845 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001846 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001847 "gc.statepoint too few arguments according to length fields", &CI);
1848
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001849 // Check that the only uses of this gc.statepoint are gc.result or
Philip Reames1ffa9372015-01-30 23:28:05 +00001850 // gc.relocate calls which are tied to this statepoint and thus part
1851 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001852 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001853 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001854 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001855 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001856 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001857 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001858 "of a gc.statepoint",
1859 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001860 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001861 Assert(Call->getArgOperand(0) == &CI,
1862 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001863 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001864 Assert(Call->getArgOperand(0) == &CI,
1865 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001866 }
1867 }
1868
1869 // Note: It is legal for a single derived pointer to be listed multiple
1870 // times. It's non-optimal, but it is legal. It can also happen after
1871 // insertion if we strip a bitcast away.
1872 // Note: It is really tempting to check that each base is relocated and
1873 // that a derived pointer is never reused as a base pointer. This turns
1874 // out to be problematic since optimizations run after safepoint insertion
1875 // can recognize equality properties that the insertion logic doesn't know
1876 // about. See example statepoint.ll in the verifier subdirectory
1877}
1878
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001879void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001880 for (auto &Counts : FrameEscapeInfo) {
1881 Function *F = Counts.first;
1882 unsigned EscapedObjectCount = Counts.second.first;
1883 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001884 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001885 "all indices passed to llvm.localrecover must be less than the "
1886 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001887 "function",
1888 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001889 }
1890}
1891
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001892static Instruction *getSuccPad(TerminatorInst *Terminator) {
1893 BasicBlock *UnwindDest;
1894 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1895 UnwindDest = II->getUnwindDest();
1896 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1897 UnwindDest = CSI->getUnwindDest();
1898 else
1899 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1900 return UnwindDest->getFirstNonPHI();
1901}
1902
1903void Verifier::verifySiblingFuncletUnwinds() {
1904 SmallPtrSet<Instruction *, 8> Visited;
1905 SmallPtrSet<Instruction *, 8> Active;
1906 for (const auto &Pair : SiblingFuncletInfo) {
1907 Instruction *PredPad = Pair.first;
1908 if (Visited.count(PredPad))
1909 continue;
1910 Active.insert(PredPad);
1911 TerminatorInst *Terminator = Pair.second;
1912 do {
1913 Instruction *SuccPad = getSuccPad(Terminator);
1914 if (Active.count(SuccPad)) {
1915 // Found a cycle; report error
1916 Instruction *CyclePad = SuccPad;
1917 SmallVector<Instruction *, 8> CycleNodes;
1918 do {
1919 CycleNodes.push_back(CyclePad);
1920 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1921 if (CycleTerminator != CyclePad)
1922 CycleNodes.push_back(CycleTerminator);
1923 CyclePad = getSuccPad(CycleTerminator);
1924 } while (CyclePad != SuccPad);
1925 Assert(false, "EH pads can't handle each other's exceptions",
1926 ArrayRef<Instruction *>(CycleNodes));
1927 }
1928 // Don't re-walk a node we've already checked
1929 if (!Visited.insert(SuccPad).second)
1930 break;
1931 // Walk to this successor if it has a map entry.
1932 PredPad = SuccPad;
1933 auto TermI = SiblingFuncletInfo.find(PredPad);
1934 if (TermI == SiblingFuncletInfo.end())
1935 break;
1936 Terminator = TermI->second;
1937 Active.insert(PredPad);
1938 } while (true);
1939 // Each node only has one successor, so we've walked all the active
1940 // nodes' successors.
1941 Active.clear();
1942 }
1943}
1944
Chris Lattner0e851da2002-04-18 20:37:37 +00001945// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001946//
Chandler Carruth043949d2014-01-19 02:22:18 +00001947void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001948 visitGlobalValue(F);
1949
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001950 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001951 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001952 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001953
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001954 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001955 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001956
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001957 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1958 Assert(FT->getNumParams() == NumArgs,
1959 "# formal arguments must match # of arguments for function type!", &F,
1960 FT);
1961 Assert(F.getReturnType()->isFirstClassType() ||
1962 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1963 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001964
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001965 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1966 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001967
Reid Klecknerb5180542017-03-21 16:57:19 +00001968 AttributeList Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001969
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001970 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001971 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001972
Duncan Sands8c582282007-12-21 19:19:01 +00001973 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001974 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001975
Michael Gottesman41748d72013-06-27 00:25:01 +00001976 // On function declarations/definitions, we do not support the builtin
1977 // attribute. We do not check this in VerifyFunctionAttrs since that is
1978 // checking for Attributes that can/can not ever be on functions.
Reid Klecknera77172a2017-04-14 00:06:06 +00001979 Assert(!Attrs.hasFnAttribute(Attribute::Builtin),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001980 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001981
Chris Lattneref13ee32006-05-19 21:25:17 +00001982 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001983 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1984 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001985 switch (F.getCallingConv()) {
1986 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001987 case CallingConv::C:
1988 break;
Matt Arsenault33339682017-04-04 18:43:11 +00001989 case CallingConv::AMDGPU_KERNEL:
1990 case CallingConv::SPIR_KERNEL:
1991 Assert(F.getReturnType()->isVoidTy(),
1992 "Calling convention requires void return type", &F);
1993 LLVM_FALLTHROUGH;
1994 case CallingConv::AMDGPU_VS:
Marek Olsaka302a7362017-05-02 15:41:10 +00001995 case CallingConv::AMDGPU_HS:
Matt Arsenault33339682017-04-04 18:43:11 +00001996 case CallingConv::AMDGPU_GS:
1997 case CallingConv::AMDGPU_PS:
1998 case CallingConv::AMDGPU_CS:
1999 Assert(!F.hasStructRetAttr(),
2000 "Calling convention does not allow sret", &F);
2001 LLVM_FALLTHROUGH;
Chris Lattneref13ee32006-05-19 21:25:17 +00002002 case CallingConv::Fast:
2003 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00002004 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00002005 case CallingConv::PTX_Kernel:
2006 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002007 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
2008 "perfect forwarding!",
2009 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00002010 break;
2011 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00002012
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002013 bool isLLVMdotName = F.getName().size() >= 5 &&
2014 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002015
Chris Lattneraf95e582002-04-13 22:48:46 +00002016 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00002017 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002018 for (const Argument &Arg : F.args()) {
2019 Assert(Arg.getType() == FT->getParamType(i),
2020 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002021 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002022 Assert(Arg.getType()->isFirstClassType(),
2023 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00002024 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002025 Assert(!Arg.getType()->isMetadataTy(),
2026 "Function takes metadata but isn't an intrinsic", &Arg, &F);
2027 Assert(!Arg.getType()->isTokenTy(),
2028 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00002029 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00002030
2031 // Check that swifterror argument is only used by loads and stores.
Reid Klecknerf021fab2017-04-13 23:12:13 +00002032 if (Attrs.hasParamAttribute(i, Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002033 verifySwiftErrorValue(&Arg);
2034 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002035 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00002036 }
Chris Lattneraf95e582002-04-13 22:48:46 +00002037
David Majnemerb611e3f2015-08-14 05:09:07 +00002038 if (!isLLVMdotName)
2039 Assert(!F.getReturnType()->isTokenTy(),
2040 "Functions returns a token but isn't an intrinsic", &F);
2041
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002042 // Get the function metadata attachments.
2043 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2044 F.getAllMetadata(MDs);
2045 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002046 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002047
Keno Fischer2ac0c272015-11-16 05:13:30 +00002048 // Check validity of the personality function
2049 if (F.hasPersonalityFn()) {
2050 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2051 if (Per)
2052 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002053 "Referencing personality function in another module!",
2054 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002055 }
2056
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002057 if (F.isMaterializable()) {
2058 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002059 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2060 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002061 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002062 for (const auto &I : MDs) {
2063 AssertDI(I.first != LLVMContext::MD_dbg,
2064 "function declaration may not have a !dbg attachment", &F);
2065 Assert(I.first != LLVMContext::MD_prof,
2066 "function declaration may not have a !prof attachment", &F);
2067
2068 // Verify the metadata itself.
2069 visitMDNode(*I.second);
2070 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002071 Assert(!F.hasPersonalityFn(),
2072 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002073 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002074 // Verify that this function (which has a body) is not named "llvm.*". It
2075 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002076 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002077
Chris Lattner149376d2002-10-13 20:57:00 +00002078 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002079 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002080 Assert(pred_empty(Entry),
2081 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002082
Chris Lattner27471742009-11-01 04:08:01 +00002083 // The address of the entry block cannot be taken, unless it is dead.
2084 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002085 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2086 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002087 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002088
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002089 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002090 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002091 for (const auto &I : MDs) {
2092 // Verify that the attachment is legal.
2093 switch (I.first) {
2094 default:
2095 break;
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002096 case LLVMContext::MD_dbg: {
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002097 ++NumDebugAttachments;
2098 AssertDI(NumDebugAttachments == 1,
2099 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002100 AssertDI(isa<DISubprogram>(I.second),
2101 "function !dbg attachment must be a subprogram", &F, I.second);
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002102 auto *SP = cast<DISubprogram>(I.second);
2103 const Function *&AttachedTo = DISubprogramAttachments[SP];
2104 AssertDI(!AttachedTo || AttachedTo == &F,
2105 "DISubprogram attached to more than one function", SP, &F);
2106 AttachedTo = &F;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002107 break;
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002108 }
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002109 case LLVMContext::MD_prof:
2110 ++NumProfAttachments;
2111 Assert(NumProfAttachments == 1,
2112 "function must have a single !prof attachment", &F, I.second);
2113 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002114 }
2115
2116 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002117 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002118 }
Chris Lattner149376d2002-10-13 20:57:00 +00002119 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002120
Chris Lattner7730dcc2009-09-11 17:05:29 +00002121 // If this function is actually an intrinsic, verify that it is only used in
2122 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002123 // Only do this if the module is materialized, otherwise we don't have all the
2124 // uses.
2125 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002126 const User *U;
2127 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002128 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002129 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002130
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002131 Assert(!F.hasDLLImportStorageClass() ||
2132 (F.isDeclaration() && F.hasExternalLinkage()) ||
2133 F.hasAvailableExternallyLinkage(),
2134 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002135
2136 auto *N = F.getSubprogram();
Adrian Prantl63d96952017-03-07 17:28:54 +00002137 HasDebugInfo = (N != nullptr);
Adrian Prantl39c6fa62017-03-07 17:50:51 +00002138 if (!HasDebugInfo)
Peter Collingbourned4bff302015-11-05 22:03:56 +00002139 return;
2140
2141 // Check that all !dbg attachments lead to back to N (or, at least, another
2142 // subprogram that describes the same function).
2143 //
2144 // FIXME: Check this incrementally while visiting !dbg attachments.
2145 // FIXME: Only check when N is the canonical subprogram for F.
2146 SmallPtrSet<const MDNode *, 32> Seen;
2147 for (auto &BB : F)
2148 for (auto &I : BB) {
2149 // Be careful about using DILocation here since we might be dealing with
2150 // broken code (this is the Verifier after all).
2151 DILocation *DL =
2152 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2153 if (!DL)
2154 continue;
2155 if (!Seen.insert(DL).second)
2156 continue;
2157
2158 DILocalScope *Scope = DL->getInlinedAtScope();
2159 if (Scope && !Seen.insert(Scope).second)
2160 continue;
2161
2162 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002163
2164 // Scope and SP could be the same MDNode and we don't want to skip
2165 // validation in that case
2166 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002167 continue;
2168
2169 // FIXME: Once N is canonical, check "SP == &N".
Adrian Prantla2ef0472016-09-14 17:30:37 +00002170 AssertDI(SP->describes(&F),
2171 "!dbg attachment points at wrong subprogram for function", N, &F,
2172 &I, DL, Scope, SP);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002173 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002174}
2175
Chris Lattner0e851da2002-04-18 20:37:37 +00002176// verifyBasicBlock - Verify that a basic block is well formed...
2177//
Chris Lattner069a7952002-06-25 15:56:27 +00002178void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002179 InstsInThisBlock.clear();
2180
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002181 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002182 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002183
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002184 // Check constraints that this basic block imposes on all of the PHI nodes in
2185 // it.
2186 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002187 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2188 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002189 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002190 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002191 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002192 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002193 Assert(PN->getNumIncomingValues() != 0,
2194 "PHI nodes must have at least one entry. If the block is dead, "
2195 "the PHI should be removed!",
2196 PN);
2197 Assert(PN->getNumIncomingValues() == Preds.size(),
2198 "PHINode should have one entry for each predecessor of its "
2199 "parent basic block!",
2200 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002201
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002202 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002203 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002204 Values.reserve(PN->getNumIncomingValues());
2205 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2206 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2207 PN->getIncomingValue(i)));
2208 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002209
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002210 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2211 // Check to make sure that if there is more than one entry for a
2212 // particular basic block in this PHI node, that the incoming values are
2213 // all identical.
2214 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002215 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2216 Values[i].second == Values[i - 1].second,
2217 "PHI node has multiple entries for the same basic block with "
2218 "different incoming values!",
2219 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002220
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002221 // Check to make sure that the predecessors and PHI node entries are
2222 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002223 Assert(Values[i].first == Preds[i],
2224 "PHI node entries do not match predecessors!", PN,
2225 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002226 }
2227 }
2228 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002229
2230 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002231 for (auto &I : BB)
2232 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002233 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002234 }
Chris Lattner069a7952002-06-25 15:56:27 +00002235}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002236
Chris Lattner069a7952002-06-25 15:56:27 +00002237void Verifier::visitTerminatorInst(TerminatorInst &I) {
2238 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002239 Assert(&I == I.getParent()->getTerminator(),
2240 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002241 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002242}
2243
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002244void Verifier::visitBranchInst(BranchInst &BI) {
2245 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002246 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2247 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002248 }
2249 visitTerminatorInst(BI);
2250}
2251
Chris Lattner069a7952002-06-25 15:56:27 +00002252void Verifier::visitReturnInst(ReturnInst &RI) {
2253 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002254 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002255 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002256 Assert(N == 0,
2257 "Found return instr that returns non-void in Function of void "
2258 "return type!",
2259 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002260 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002261 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2262 "Function return type does not match operand "
2263 "type of return inst!",
2264 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002265
Misha Brukman7eb05a12003-08-18 14:43:39 +00002266 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002267 // terminators...
2268 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002269}
2270
Chris Lattnerab5aa142004-05-21 16:47:21 +00002271void Verifier::visitSwitchInst(SwitchInst &SI) {
2272 // Check to make sure that all of the constants in the switch instruction
2273 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002274 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002275 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002276 for (auto &Case : SI.cases()) {
2277 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002278 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002279 Assert(Constants.insert(Case.getCaseValue()).second,
2280 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002281 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002282
Chris Lattnerab5aa142004-05-21 16:47:21 +00002283 visitTerminatorInst(SI);
2284}
2285
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002286void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002287 Assert(BI.getAddress()->getType()->isPointerTy(),
2288 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002289 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002290 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2291 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002292
2293 visitTerminatorInst(BI);
2294}
2295
Chris Lattner75648e72004-03-12 05:54:31 +00002296void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002297 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2298 SI.getOperand(2)),
2299 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002300
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002301 Assert(SI.getTrueValue()->getType() == SI.getType(),
2302 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002303 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002304}
2305
Misha Brukmanc566ca362004-03-02 00:22:19 +00002306/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2307/// a pass, if any exist, it's an error.
2308///
Chris Lattner903a25d2002-11-21 16:54:22 +00002309void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002310 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002311}
Chris Lattner0e851da2002-04-18 20:37:37 +00002312
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002313void Verifier::visitTruncInst(TruncInst &I) {
2314 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002315 Type *SrcTy = I.getOperand(0)->getType();
2316 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002317
2318 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002319 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2320 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002321
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002322 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2323 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2324 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2325 "trunc source and destination must both be a vector or neither", &I);
2326 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002327
2328 visitInstruction(I);
2329}
2330
2331void Verifier::visitZExtInst(ZExtInst &I) {
2332 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002333 Type *SrcTy = I.getOperand(0)->getType();
2334 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002335
2336 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002337 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2338 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2339 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2340 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002341 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2342 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002343
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002344 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002345
2346 visitInstruction(I);
2347}
2348
2349void Verifier::visitSExtInst(SExtInst &I) {
2350 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002351 Type *SrcTy = I.getOperand(0)->getType();
2352 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002353
2354 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002355 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2356 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002357
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002358 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2359 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2360 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2361 "sext source and destination must both be a vector or neither", &I);
2362 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002363
2364 visitInstruction(I);
2365}
2366
2367void Verifier::visitFPTruncInst(FPTruncInst &I) {
2368 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002369 Type *SrcTy = I.getOperand(0)->getType();
2370 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002371 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002372 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2373 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002374
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002375 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2376 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2377 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2378 "fptrunc source and destination must both be a vector or neither", &I);
2379 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002380
2381 visitInstruction(I);
2382}
2383
2384void Verifier::visitFPExtInst(FPExtInst &I) {
2385 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002386 Type *SrcTy = I.getOperand(0)->getType();
2387 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002388
2389 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002390 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2391 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002392
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002393 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2394 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2395 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2396 "fpext source and destination must both be a vector or neither", &I);
2397 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002398
2399 visitInstruction(I);
2400}
2401
2402void Verifier::visitUIToFPInst(UIToFPInst &I) {
2403 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002404 Type *SrcTy = I.getOperand(0)->getType();
2405 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002406
Duncan Sands19d0b472010-02-16 11:11:14 +00002407 bool SrcVec = SrcTy->isVectorTy();
2408 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002409
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002410 Assert(SrcVec == DstVec,
2411 "UIToFP source and dest must both be vector or scalar", &I);
2412 Assert(SrcTy->isIntOrIntVectorTy(),
2413 "UIToFP source must be integer or integer vector", &I);
2414 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2415 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002416
2417 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002418 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2419 cast<VectorType>(DestTy)->getNumElements(),
2420 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002421
2422 visitInstruction(I);
2423}
2424
2425void Verifier::visitSIToFPInst(SIToFPInst &I) {
2426 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002427 Type *SrcTy = I.getOperand(0)->getType();
2428 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002429
Duncan Sands19d0b472010-02-16 11:11:14 +00002430 bool SrcVec = SrcTy->isVectorTy();
2431 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002432
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002433 Assert(SrcVec == DstVec,
2434 "SIToFP source and dest must both be vector or scalar", &I);
2435 Assert(SrcTy->isIntOrIntVectorTy(),
2436 "SIToFP source must be integer or integer vector", &I);
2437 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2438 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002439
2440 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002441 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2442 cast<VectorType>(DestTy)->getNumElements(),
2443 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002444
2445 visitInstruction(I);
2446}
2447
2448void Verifier::visitFPToUIInst(FPToUIInst &I) {
2449 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002450 Type *SrcTy = I.getOperand(0)->getType();
2451 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002452
Duncan Sands19d0b472010-02-16 11:11:14 +00002453 bool SrcVec = SrcTy->isVectorTy();
2454 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002455
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002456 Assert(SrcVec == DstVec,
2457 "FPToUI source and dest must both be vector or scalar", &I);
2458 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2459 &I);
2460 Assert(DestTy->isIntOrIntVectorTy(),
2461 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002462
2463 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002464 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2465 cast<VectorType>(DestTy)->getNumElements(),
2466 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002467
2468 visitInstruction(I);
2469}
2470
2471void Verifier::visitFPToSIInst(FPToSIInst &I) {
2472 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002473 Type *SrcTy = I.getOperand(0)->getType();
2474 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002475
Duncan Sands19d0b472010-02-16 11:11:14 +00002476 bool SrcVec = SrcTy->isVectorTy();
2477 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002478
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002479 Assert(SrcVec == DstVec,
2480 "FPToSI source and dest must both be vector or scalar", &I);
2481 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2482 &I);
2483 Assert(DestTy->isIntOrIntVectorTy(),
2484 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002485
2486 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002487 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2488 cast<VectorType>(DestTy)->getNumElements(),
2489 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002490
2491 visitInstruction(I);
2492}
2493
2494void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2495 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002496 Type *SrcTy = I.getOperand(0)->getType();
2497 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002498
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002499 Assert(SrcTy->getScalarType()->isPointerTy(),
2500 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002501
2502 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002503 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002504 "ptrtoint not supported for non-integral pointers");
2505
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002506 Assert(DestTy->getScalarType()->isIntegerTy(),
2507 "PtrToInt result must be integral", &I);
2508 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2509 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002510
2511 if (SrcTy->isVectorTy()) {
2512 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2513 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002514 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2515 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002516 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002517
2518 visitInstruction(I);
2519}
2520
2521void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2522 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002523 Type *SrcTy = I.getOperand(0)->getType();
2524 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002525
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002526 Assert(SrcTy->getScalarType()->isIntegerTy(),
2527 "IntToPtr source must be an integral", &I);
2528 Assert(DestTy->getScalarType()->isPointerTy(),
2529 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002530
2531 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002532 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002533 "inttoptr not supported for non-integral pointers");
2534
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002535 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2536 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002537 if (SrcTy->isVectorTy()) {
2538 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2539 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002540 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2541 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002542 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002543 visitInstruction(I);
2544}
2545
2546void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002547 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002548 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2549 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002550 visitInstruction(I);
2551}
2552
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002553void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2554 Type *SrcTy = I.getOperand(0)->getType();
2555 Type *DestTy = I.getType();
2556
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002557 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2558 &I);
2559 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2560 &I);
2561 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2562 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002563 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002564 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2565 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002566 visitInstruction(I);
2567}
2568
Misha Brukmanc566ca362004-03-02 00:22:19 +00002569/// visitPHINode - Ensure that a PHI node is well formed.
2570///
Chris Lattner069a7952002-06-25 15:56:27 +00002571void Verifier::visitPHINode(PHINode &PN) {
2572 // Ensure that the PHI nodes are all grouped together at the top of the block.
2573 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002574 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002575 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002576 Assert(&PN == &PN.getParent()->front() ||
2577 isa<PHINode>(--BasicBlock::iterator(&PN)),
2578 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002579
David Majnemerb611e3f2015-08-14 05:09:07 +00002580 // Check that a PHI doesn't yield a Token.
2581 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2582
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002583 // Check that all of the values of the PHI node have the same type as the
2584 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002585 for (Value *IncValue : PN.incoming_values()) {
2586 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002587 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002588 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002589
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002590 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002591
2592 visitInstruction(PN);
2593}
2594
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002595void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002596 Instruction *I = CS.getInstruction();
2597
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002598 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2599 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002600 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002601
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002602 Assert(FPTy->getElementType()->isFunctionTy(),
2603 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002604
2605 Assert(FPTy->getElementType() == CS.getFunctionType(),
2606 "Called function is not the same type as the call!", I);
2607
2608 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002609
2610 // Verify that the correct number of arguments are being passed
2611 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002612 Assert(CS.arg_size() >= FTy->getNumParams(),
2613 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002614 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002615 Assert(CS.arg_size() == FTy->getNumParams(),
2616 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002617
Chris Lattner609de002010-05-10 20:58:42 +00002618 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002619 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002620 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2621 "Call parameter type does not match function signature!",
2622 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002623
Reid Klecknerb5180542017-03-21 16:57:19 +00002624 AttributeList Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002625
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002626 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002627 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002628
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00002629 if (Attrs.hasAttribute(AttributeList::FunctionIndex, Attribute::Speculatable)) {
2630 // Don't allow speculatable on call sites, unless the underlying function
2631 // declaration is also speculatable.
2632 Function *Callee
2633 = dyn_cast<Function>(CS.getCalledValue()->stripPointerCasts());
2634 Assert(Callee && Callee->isSpeculatable(),
2635 "speculatable attribute may not apply to call sites", I);
2636 }
2637
Duncan Sands8c582282007-12-21 19:19:01 +00002638 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002639 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002640
David Majnemer91db08b2014-04-30 17:22:00 +00002641 // Conservatively check the inalloca argument.
2642 // We have a bug if we can find that there is an underlying alloca without
2643 // inalloca.
2644 if (CS.hasInAllocaArgument()) {
2645 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2646 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002647 Assert(AI->isUsedWithInAlloca(),
2648 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002649 }
2650
Manman Ren9bfd0d02016-04-01 21:41:15 +00002651 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002652 // make sure the underlying alloca/parameter it comes from has a swifterror as
2653 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002654 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Reid Klecknerfb502d22017-04-14 20:19:02 +00002655 if (CS.paramHasAttr(i, Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002656 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002657 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002658 Assert(AI->isSwiftError(),
2659 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002660 continue;
2661 }
2662 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2663 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2664 Assert(ArgI->hasSwiftErrorAttr(),
2665 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002666 }
2667
Stephen Linb8bd2322013-04-20 05:14:40 +00002668 if (FTy->isVarArg()) {
2669 // FIXME? is 'nest' even legal here?
2670 bool SawNest = false;
2671 bool SawReturned = false;
2672
Reid Klecknera77172a2017-04-14 00:06:06 +00002673 for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) {
2674 if (Attrs.hasParamAttribute(Idx, Attribute::Nest))
Stephen Linb8bd2322013-04-20 05:14:40 +00002675 SawNest = true;
Reid Klecknera77172a2017-04-14 00:06:06 +00002676 if (Attrs.hasParamAttribute(Idx, Attribute::Returned))
Stephen Linb8bd2322013-04-20 05:14:40 +00002677 SawReturned = true;
2678 }
2679
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002680 // Check attributes on the varargs part.
Reid Klecknera77172a2017-04-14 00:06:06 +00002681 for (unsigned Idx = FTy->getNumParams(); Idx < CS.arg_size(); ++Idx) {
2682 Type *Ty = CS.getArgument(Idx)->getType();
2683 AttributeSet ArgAttrs = Attrs.getParamAttributes(Idx);
2684 verifyParameterAttrs(ArgAttrs, Ty, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002685
Reid Klecknera77172a2017-04-14 00:06:06 +00002686 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002687 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002688 SawNest = true;
2689 }
2690
Reid Klecknera77172a2017-04-14 00:06:06 +00002691 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002692 Assert(!SawReturned, "More than one parameter has attribute returned!",
2693 I);
2694 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2695 "Incompatible argument and return types for 'returned' "
2696 "attribute",
2697 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002698 SawReturned = true;
2699 }
Duncan Sands0009c442008-01-12 16:42:01 +00002700
Reid Klecknera77172a2017-04-14 00:06:06 +00002701 Assert(!ArgAttrs.hasAttribute(Attribute::StructRet),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002702 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002703
Reid Klecknera77172a2017-04-14 00:06:06 +00002704 if (ArgAttrs.hasAttribute(Attribute::InAlloca))
2705 Assert(Idx == CS.arg_size() - 1, "inalloca isn't on the last argument!",
2706 I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002707 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002708 }
Duncan Sands8c582282007-12-21 19:19:01 +00002709
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002710 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002711 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002712 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002713 for (Type *ParamTy : FTy->params()) {
2714 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002715 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002716 Assert(!ParamTy->isTokenTy(),
2717 "Function has token parameter but isn't an intrinsic", I);
2718 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002719 }
2720
David Majnemerb611e3f2015-08-14 05:09:07 +00002721 // Verify that indirect calls don't return tokens.
2722 if (CS.getCalledFunction() == nullptr)
2723 Assert(!FTy->getReturnType()->isTokenTy(),
2724 "Return type cannot be token for indirect call!");
2725
Philip Reamesa3c6f002015-06-26 21:39:44 +00002726 if (Function *F = CS.getCalledFunction())
2727 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002728 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002729
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002730 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2731 // at most one "gc-transition" operand bundle.
2732 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2733 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002734 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002735 OperandBundleUse BU = CS.getOperandBundleAt(i);
2736 uint32_t Tag = BU.getTagID();
2737 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002738 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2739 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002740 } else if (Tag == LLVMContext::OB_gc_transition) {
2741 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2742 I);
2743 FoundGCTransitionBundle = true;
2744 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002745 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2746 FoundFuncletBundle = true;
2747 Assert(BU.Inputs.size() == 1,
2748 "Expected exactly one funclet bundle operand", I);
2749 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2750 "Funclet bundle operands should correspond to a FuncletPadInst",
2751 I);
2752 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002753 }
2754
Adrian Prantl93035c82016-04-24 22:23:13 +00002755 // Verify that each inlinable callsite of a debug-info-bearing function in a
2756 // debug-info-bearing function has a debug location attached to it. Failure to
2757 // do so causes assertion failures when the inliner sets up inline scope info.
2758 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2759 CS.getCalledFunction()->getSubprogram())
Adrian Prantlfb80e792017-03-06 21:05:14 +00002760 AssertDI(I->getDebugLoc(), "inlinable function call in a function with "
2761 "debug info must have a !dbg location",
2762 I);
Adrian Prantl93035c82016-04-24 22:23:13 +00002763
Duncan Sands8c582282007-12-21 19:19:01 +00002764 visitInstruction(*I);
2765}
2766
Reid Kleckner5772b772014-04-24 20:14:34 +00002767/// Two types are "congruent" if they are identical, or if they are both pointer
2768/// types with different pointee types and the same address space.
2769static bool isTypeCongruent(Type *L, Type *R) {
2770 if (L == R)
2771 return true;
2772 PointerType *PL = dyn_cast<PointerType>(L);
2773 PointerType *PR = dyn_cast<PointerType>(R);
2774 if (!PL || !PR)
2775 return false;
2776 return PL->getAddressSpace() == PR->getAddressSpace();
2777}
2778
Reid Klecknerb5180542017-03-21 16:57:19 +00002779static AttrBuilder getParameterABIAttributes(int I, AttributeList Attrs) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002780 static const Attribute::AttrKind ABIAttrs[] = {
2781 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002782 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2783 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002784 AttrBuilder Copy;
2785 for (auto AK : ABIAttrs) {
Reid Klecknerf021fab2017-04-13 23:12:13 +00002786 if (Attrs.hasParamAttribute(I, AK))
Reid Klecknerd20c9702014-05-15 23:58:57 +00002787 Copy.addAttribute(AK);
2788 }
Reid Klecknerf021fab2017-04-13 23:12:13 +00002789 if (Attrs.hasParamAttribute(I, Attribute::Alignment))
Reid Kleckner859f8b52017-04-28 20:34:27 +00002790 Copy.addAlignmentAttr(Attrs.getParamAlignment(I));
Reid Klecknerd20c9702014-05-15 23:58:57 +00002791 return Copy;
2792}
2793
Reid Kleckner5772b772014-04-24 20:14:34 +00002794void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002795 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002796
2797 // - The caller and callee prototypes must match. Pointer types of
2798 // parameters or return types may differ in pointee type, but not
2799 // address space.
2800 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002801 FunctionType *CallerTy = F->getFunctionType();
2802 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002803 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2804 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2805 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2806 "cannot guarantee tail call due to mismatched varargs", &CI);
2807 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2808 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002809 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002810 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002811 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2812 "cannot guarantee tail call due to mismatched parameter types", &CI);
2813 }
2814
2815 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002816 Assert(F->getCallingConv() == CI.getCallingConv(),
2817 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002818
2819 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2820 // returned, and inalloca, must match.
Reid Klecknerb5180542017-03-21 16:57:19 +00002821 AttributeList CallerAttrs = F->getAttributes();
2822 AttributeList CalleeAttrs = CI.getAttributes();
Reid Kleckner5772b772014-04-24 20:14:34 +00002823 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002824 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2825 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002826 Assert(CallerABIAttrs == CalleeABIAttrs,
2827 "cannot guarantee tail call due to mismatched ABI impacting "
2828 "function attributes",
2829 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002830 }
2831
2832 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2833 // or a pointer bitcast followed by a ret instruction.
2834 // - The ret instruction must return the (possibly bitcasted) value
2835 // produced by the call or void.
2836 Value *RetVal = &CI;
2837 Instruction *Next = CI.getNextNode();
2838
2839 // Handle the optional bitcast.
2840 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002841 Assert(BI->getOperand(0) == RetVal,
2842 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002843 RetVal = BI;
2844 Next = BI->getNextNode();
2845 }
2846
2847 // Check the return.
2848 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002849 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2850 &CI);
2851 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2852 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002853}
2854
Duncan Sands8c582282007-12-21 19:19:01 +00002855void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002856 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002857
Reid Kleckner5772b772014-04-24 20:14:34 +00002858 if (CI.isMustTailCall())
2859 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002860}
2861
2862void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002863 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002864
David Majnemer654e1302015-07-31 17:58:14 +00002865 // Verify that the first non-PHI instruction of the unwind destination is an
2866 // exception handling instruction.
2867 Assert(
2868 II.getUnwindDest()->isEHPad(),
2869 "The unwind destination does not have an exception handling instruction!",
2870 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002871
Dan Gohman9c6e1882010-08-02 23:09:14 +00002872 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002873}
Chris Lattner0e851da2002-04-18 20:37:37 +00002874
Misha Brukmanc566ca362004-03-02 00:22:19 +00002875/// visitBinaryOperator - Check that both arguments to the binary operator are
2876/// of the same type!
2877///
Chris Lattner069a7952002-06-25 15:56:27 +00002878void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002879 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2880 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002881
Reid Spencer2341c222007-02-02 02:16:23 +00002882 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002883 // Check that integer arithmetic operators are only used with
2884 // integral operands.
2885 case Instruction::Add:
2886 case Instruction::Sub:
2887 case Instruction::Mul:
2888 case Instruction::SDiv:
2889 case Instruction::UDiv:
2890 case Instruction::SRem:
2891 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002892 Assert(B.getType()->isIntOrIntVectorTy(),
2893 "Integer arithmetic operators only work with integral types!", &B);
2894 Assert(B.getType() == B.getOperand(0)->getType(),
2895 "Integer arithmetic operators must have same type "
2896 "for operands and result!",
2897 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002898 break;
2899 // Check that floating-point arithmetic operators are only used with
2900 // floating-point operands.
2901 case Instruction::FAdd:
2902 case Instruction::FSub:
2903 case Instruction::FMul:
2904 case Instruction::FDiv:
2905 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002906 Assert(B.getType()->isFPOrFPVectorTy(),
2907 "Floating-point arithmetic operators only work with "
2908 "floating-point types!",
2909 &B);
2910 Assert(B.getType() == B.getOperand(0)->getType(),
2911 "Floating-point arithmetic operators must have same type "
2912 "for operands and result!",
2913 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002914 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002915 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002916 case Instruction::And:
2917 case Instruction::Or:
2918 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002919 Assert(B.getType()->isIntOrIntVectorTy(),
2920 "Logical operators only work with integral types!", &B);
2921 Assert(B.getType() == B.getOperand(0)->getType(),
2922 "Logical operators must have same type for operands and result!",
2923 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002924 break;
2925 case Instruction::Shl:
2926 case Instruction::LShr:
2927 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002928 Assert(B.getType()->isIntOrIntVectorTy(),
2929 "Shifts only work with integral types!", &B);
2930 Assert(B.getType() == B.getOperand(0)->getType(),
2931 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002932 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002933 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002934 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002935 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002936
Chris Lattner0e851da2002-04-18 20:37:37 +00002937 visitInstruction(B);
2938}
2939
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002940void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002941 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002942 Type *Op0Ty = IC.getOperand(0)->getType();
2943 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002944 Assert(Op0Ty == Op1Ty,
2945 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002946 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002947 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2948 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002949 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002950 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2951 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2952 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002953
Reid Spencerd9436b62006-11-20 01:22:35 +00002954 visitInstruction(IC);
2955}
2956
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002957void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002958 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002959 Type *Op0Ty = FC.getOperand(0)->getType();
2960 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002961 Assert(Op0Ty == Op1Ty,
2962 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002963 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002964 Assert(Op0Ty->isFPOrFPVectorTy(),
2965 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002966 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002967 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2968 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2969 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002970
Reid Spencerd9436b62006-11-20 01:22:35 +00002971 visitInstruction(FC);
2972}
2973
Robert Bocchino23004482006-01-10 19:05:34 +00002974void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002975 Assert(
2976 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2977 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002978 visitInstruction(EI);
2979}
2980
Robert Bocchinoca27f032006-01-17 20:07:22 +00002981void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002982 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2983 IE.getOperand(2)),
2984 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002985 visitInstruction(IE);
2986}
2987
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002988void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002989 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2990 SV.getOperand(2)),
2991 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002992 visitInstruction(SV);
2993}
2994
Chris Lattner069a7952002-06-25 15:56:27 +00002995void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002996 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002997
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002998 Assert(isa<PointerType>(TargetTy),
2999 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00003000 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00003001 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00003002 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00003003 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003004 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00003005
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003006 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00003007 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003008 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00003009
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003010 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00003011 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003012 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
3013 if (GEP.getPointerOperandType()->isVectorTy())
3014 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
3015 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00003016 for (Value *Idx : Idxs) {
3017 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003018 if (IndexTy->isVectorTy()) {
3019 unsigned IndexWidth = IndexTy->getVectorNumElements();
3020 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
3021 }
3022 Assert(IndexTy->getScalarType()->isIntegerTy(),
3023 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00003024 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00003025 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003026 visitInstruction(GEP);
3027}
3028
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00003029static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
3030 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
3031}
3032
Sanjoy Das26f28a22016-11-09 19:36:39 +00003033void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
3034 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
Philip Reamesbf9676f2014-10-20 23:52:07 +00003035 "precondition violation");
3036
3037 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003038 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003039 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003040 Assert(NumRanges >= 1, "It should have at least one range!", Range);
3041
Philip Reamesbf9676f2014-10-20 23:52:07 +00003042 ConstantRange LastRange(1); // Dummy initial value
3043 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003044 ConstantInt *Low =
3045 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003046 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003047 ConstantInt *High =
3048 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003049 Assert(High, "The upper limit must be an integer!", High);
3050 Assert(High->getType() == Low->getType() && High->getType() == Ty,
3051 "Range types must match instruction type!", &I);
3052
Philip Reamesbf9676f2014-10-20 23:52:07 +00003053 APInt HighV = High->getValue();
3054 APInt LowV = Low->getValue();
3055 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003056 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
3057 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003058 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003059 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
3060 "Intervals are overlapping", Range);
3061 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3062 Range);
3063 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3064 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003065 }
3066 LastRange = ConstantRange(LowV, HighV);
3067 }
3068 if (NumRanges > 2) {
3069 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003070 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003071 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003072 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003073 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003074 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3075 "Intervals are overlapping", Range);
3076 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3077 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003078 }
3079}
3080
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003081void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3082 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003083 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3084 Assert(!(Size & (Size - 1)),
3085 "atomic memory access' operand must have a power-of-two size", Ty, I);
3086}
3087
Chris Lattner069a7952002-06-25 15:56:27 +00003088void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003089 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003090 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003091 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003092 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3093 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003094 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003095 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003096 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3097 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003098 "Load cannot have Release ordering", &LI);
3099 Assert(LI.getAlignment() != 0,
3100 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003101 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3102 ElTy->isFloatingPointTy(),
3103 "atomic load operand must have integer, pointer, or floating point "
3104 "type!",
3105 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003106 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003107 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003108 Assert(LI.getSynchScope() == CrossThread,
3109 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003110 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003111
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003112 visitInstruction(LI);
3113}
3114
Chris Lattner069a7952002-06-25 15:56:27 +00003115void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003116 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003117 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003118 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003119 Assert(ElTy == SI.getOperand(0)->getType(),
3120 "Stored value type does not match pointer operand type!", &SI, ElTy);
3121 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3122 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003123 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003124 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003125 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3126 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003127 "Store cannot have Acquire ordering", &SI);
3128 Assert(SI.getAlignment() != 0,
3129 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003130 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3131 ElTy->isFloatingPointTy(),
3132 "atomic store operand must have integer, pointer, or floating point "
3133 "type!",
3134 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003135 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003136 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003137 Assert(SI.getSynchScope() == CrossThread,
3138 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003139 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003140 visitInstruction(SI);
3141}
3142
Manman Ren9bfd0d02016-04-01 21:41:15 +00003143/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3144void Verifier::verifySwiftErrorCallSite(CallSite CS,
3145 const Value *SwiftErrorVal) {
3146 unsigned Idx = 0;
3147 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3148 I != E; ++I, ++Idx) {
3149 if (*I == SwiftErrorVal) {
Reid Klecknerfb502d22017-04-14 20:19:02 +00003150 Assert(CS.paramHasAttr(Idx, Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00003151 "swifterror value when used in a callsite should be marked "
3152 "with swifterror attribute",
3153 SwiftErrorVal, CS);
3154 }
3155 }
3156}
3157
3158void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3159 // Check that swifterror value is only used by loads, stores, or as
3160 // a swifterror argument.
3161 for (const User *U : SwiftErrorVal->users()) {
3162 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3163 isa<InvokeInst>(U),
3164 "swifterror value can only be loaded and stored from, or "
3165 "as a swifterror argument!",
3166 SwiftErrorVal, U);
3167 // If it is used by a store, check it is the second operand.
3168 if (auto StoreI = dyn_cast<StoreInst>(U))
3169 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3170 "swifterror value should be the second operand when used "
3171 "by stores", SwiftErrorVal, U);
3172 if (auto CallI = dyn_cast<CallInst>(U))
3173 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3174 if (auto II = dyn_cast<InvokeInst>(U))
3175 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3176 }
3177}
3178
Victor Hernandez8acf2952009-10-23 21:09:37 +00003179void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003180 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003181 PointerType *PTy = AI.getType();
Matt Arsenault3c1fc762017-04-10 22:27:50 +00003182 // TODO: Relax this restriction?
3183 Assert(PTy->getAddressSpace() == DL.getAllocaAddrSpace(),
3184 "Allocation instruction pointer not in the stack address space!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003185 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003186 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003187 "Cannot allocate unsized type", &AI);
3188 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3189 "Alloca array size must have integer type", &AI);
3190 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3191 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003192
Manman Ren9bfd0d02016-04-01 21:41:15 +00003193 if (AI.isSwiftError()) {
3194 verifySwiftErrorValue(&AI);
3195 }
3196
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003197 visitInstruction(AI);
3198}
3199
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003200void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003201
3202 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003203 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003204 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003205 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003206 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003207 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003208 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003209 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003210 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003211 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3212 "cmpxchg instructions failure argument shall be no stronger than the "
3213 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003214 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003215 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3216 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003217 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003218
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003219 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003220 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003221 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003222 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3223 "cmpxchg operand must have integer or pointer type",
3224 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003225 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003226 Assert(ElTy == CXI.getOperand(1)->getType(),
3227 "Expected value type does not match pointer operand type!", &CXI,
3228 ElTy);
3229 Assert(ElTy == CXI.getOperand(2)->getType(),
3230 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003231 visitInstruction(CXI);
3232}
3233
3234void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003235 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003236 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003237 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003238 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003239 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003240 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003241 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003242 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3243 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003244 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003245 Assert(ElTy == RMWI.getOperand(1)->getType(),
3246 "Argument value type does not match pointer operand type!", &RMWI,
3247 ElTy);
3248 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3249 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3250 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003251 visitInstruction(RMWI);
3252}
3253
Eli Friedmanfee02c62011-07-25 23:16:38 +00003254void Verifier::visitFenceInst(FenceInst &FI) {
3255 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003256 Assert(Ordering == AtomicOrdering::Acquire ||
3257 Ordering == AtomicOrdering::Release ||
3258 Ordering == AtomicOrdering::AcquireRelease ||
3259 Ordering == AtomicOrdering::SequentiallyConsistent,
3260 "fence instructions may only have acquire, release, acq_rel, or "
3261 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003262 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003263 visitInstruction(FI);
3264}
3265
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003266void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003267 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3268 EVI.getIndices()) == EVI.getType(),
3269 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003270
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003271 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003272}
3273
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003274void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003275 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3276 IVI.getIndices()) ==
3277 IVI.getOperand(1)->getType(),
3278 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003279
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003280 visitInstruction(IVI);
3281}
Chris Lattner0e851da2002-04-18 20:37:37 +00003282
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003283static Value *getParentPad(Value *EHPad) {
3284 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3285 return FPI->getParentPad();
3286
3287 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3288}
3289
David Majnemer85a549d2015-08-11 02:48:30 +00003290void Verifier::visitEHPadPredecessors(Instruction &I) {
3291 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003292
David Majnemer85a549d2015-08-11 02:48:30 +00003293 BasicBlock *BB = I.getParent();
3294 Function *F = BB->getParent();
3295
3296 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3297
3298 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3299 // The landingpad instruction defines its parent as a landing pad block. The
3300 // landing pad block may be branched to only by the unwind edge of an
3301 // invoke.
3302 for (BasicBlock *PredBB : predecessors(BB)) {
3303 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3304 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3305 "Block containing LandingPadInst must be jumped to "
3306 "only by the unwind edge of an invoke.",
3307 LPI);
3308 }
3309 return;
3310 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003311 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3312 if (!pred_empty(BB))
3313 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3314 "Block containg CatchPadInst must be jumped to "
3315 "only by its catchswitch.",
3316 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003317 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3318 "Catchswitch cannot unwind to one of its catchpads",
3319 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003320 return;
3321 }
David Majnemer85a549d2015-08-11 02:48:30 +00003322
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003323 // Verify that each pred has a legal terminator with a legal to/from EH
3324 // pad relationship.
3325 Instruction *ToPad = &I;
3326 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003327 for (BasicBlock *PredBB : predecessors(BB)) {
3328 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003329 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003330 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003331 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003332 "EH pad must be jumped to via an unwind edge", ToPad, II);
3333 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3334 FromPad = Bundle->Inputs[0];
3335 else
3336 FromPad = ConstantTokenNone::get(II->getContext());
3337 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003338 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003339 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3340 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3341 FromPad = CSI;
3342 } else {
3343 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3344 }
3345
3346 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003347 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003348 for (;; FromPad = getParentPad(FromPad)) {
3349 Assert(FromPad != ToPad,
3350 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3351 if (FromPad == ToPadParent) {
3352 // This is a legal unwind edge.
3353 break;
3354 }
3355 Assert(!isa<ConstantTokenNone>(FromPad),
3356 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003357 Assert(Seen.insert(FromPad).second,
3358 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003359 }
David Majnemer85a549d2015-08-11 02:48:30 +00003360 }
3361}
3362
3363void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003364 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3365 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003366 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3367 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003368
David Majnemer85a549d2015-08-11 02:48:30 +00003369 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003370
David Majnemer654e1302015-07-31 17:58:14 +00003371 if (!LandingPadResultTy)
3372 LandingPadResultTy = LPI.getType();
3373 else
3374 Assert(LandingPadResultTy == LPI.getType(),
3375 "The landingpad instruction should have a consistent result type "
3376 "inside a function.",
3377 &LPI);
3378
David Majnemer7fddecc2015-06-17 20:52:32 +00003379 Function *F = LPI.getParent()->getParent();
3380 Assert(F->hasPersonalityFn(),
3381 "LandingPadInst needs to be in a function with a personality.", &LPI);
3382
Bill Wendlingfae14752011-08-12 20:24:12 +00003383 // The landingpad instruction must be the first non-PHI instruction in the
3384 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003385 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3386 "LandingPadInst not the first non-PHI instruction in the block.",
3387 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003388
Duncan Sands86de1a62011-09-27 16:43:19 +00003389 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003390 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003391 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003392 Assert(isa<PointerType>(Clause->getType()),
3393 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003394 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003395 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3396 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3397 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003398 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003399 }
3400
Bill Wendlingfae14752011-08-12 20:24:12 +00003401 visitInstruction(LPI);
3402}
3403
David Majnemerba6665d2016-08-01 18:06:34 +00003404void Verifier::visitResumeInst(ResumeInst &RI) {
3405 Assert(RI.getFunction()->hasPersonalityFn(),
3406 "ResumeInst needs to be in a function with a personality.", &RI);
3407
3408 if (!LandingPadResultTy)
3409 LandingPadResultTy = RI.getValue()->getType();
3410 else
3411 Assert(LandingPadResultTy == RI.getValue()->getType(),
3412 "The resume instruction should have a consistent result type "
3413 "inside a function.",
3414 &RI);
3415
3416 visitTerminatorInst(RI);
3417}
3418
David Majnemer654e1302015-07-31 17:58:14 +00003419void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003420 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003421
David Majnemer654e1302015-07-31 17:58:14 +00003422 Function *F = BB->getParent();
3423 Assert(F->hasPersonalityFn(),
3424 "CatchPadInst needs to be in a function with a personality.", &CPI);
3425
David Majnemer8a1c45d2015-12-12 05:38:55 +00003426 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3427 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3428 CPI.getParentPad());
3429
David Majnemer654e1302015-07-31 17:58:14 +00003430 // The catchpad instruction must be the first non-PHI instruction in the
3431 // block.
3432 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003433 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003434
David Majnemerfe2f7f32016-02-29 22:56:36 +00003435 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003436 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003437}
3438
David Majnemer8a1c45d2015-12-12 05:38:55 +00003439void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3440 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3441 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3442 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003443
David Majnemer8a1c45d2015-12-12 05:38:55 +00003444 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003445}
3446
3447void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3448 BasicBlock *BB = CPI.getParent();
3449
David Majnemer654e1302015-07-31 17:58:14 +00003450 Function *F = BB->getParent();
3451 Assert(F->hasPersonalityFn(),
3452 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3453
3454 // The cleanuppad instruction must be the first non-PHI instruction in the
3455 // block.
3456 Assert(BB->getFirstNonPHI() == &CPI,
3457 "CleanupPadInst not the first non-PHI instruction in the block.",
3458 &CPI);
3459
David Majnemer8a1c45d2015-12-12 05:38:55 +00003460 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003461 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003462 "CleanupPadInst has an invalid parent.", &CPI);
3463
David Majnemerfe2f7f32016-02-29 22:56:36 +00003464 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003465 visitFuncletPadInst(CPI);
3466}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003467
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003468void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3469 User *FirstUser = nullptr;
3470 Value *FirstUnwindPad = nullptr;
3471 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003472 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003473
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003474 while (!Worklist.empty()) {
3475 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003476 Assert(Seen.insert(CurrentPad).second,
3477 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003478 Value *UnresolvedAncestorPad = nullptr;
3479 for (User *U : CurrentPad->users()) {
3480 BasicBlock *UnwindDest;
3481 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3482 UnwindDest = CRI->getUnwindDest();
3483 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3484 // We allow catchswitch unwind to caller to nest
3485 // within an outer pad that unwinds somewhere else,
3486 // because catchswitch doesn't have a nounwind variant.
3487 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3488 if (CSI->unwindsToCaller())
3489 continue;
3490 UnwindDest = CSI->getUnwindDest();
3491 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3492 UnwindDest = II->getUnwindDest();
3493 } else if (isa<CallInst>(U)) {
3494 // Calls which don't unwind may be found inside funclet
3495 // pads that unwind somewhere else. We don't *require*
3496 // such calls to be annotated nounwind.
3497 continue;
3498 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3499 // The unwind dest for a cleanup can only be found by
3500 // recursive search. Add it to the worklist, and we'll
3501 // search for its first use that determines where it unwinds.
3502 Worklist.push_back(CPI);
3503 continue;
3504 } else {
3505 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3506 continue;
3507 }
3508
3509 Value *UnwindPad;
3510 bool ExitsFPI;
3511 if (UnwindDest) {
3512 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003513 if (!cast<Instruction>(UnwindPad)->isEHPad())
3514 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003515 Value *UnwindParent = getParentPad(UnwindPad);
3516 // Ignore unwind edges that don't exit CurrentPad.
3517 if (UnwindParent == CurrentPad)
3518 continue;
3519 // Determine whether the original funclet pad is exited,
3520 // and if we are scanning nested pads determine how many
3521 // of them are exited so we can stop searching their
3522 // children.
3523 Value *ExitedPad = CurrentPad;
3524 ExitsFPI = false;
3525 do {
3526 if (ExitedPad == &FPI) {
3527 ExitsFPI = true;
3528 // Now we can resolve any ancestors of CurrentPad up to
3529 // FPI, but not including FPI since we need to make sure
3530 // to check all direct users of FPI for consistency.
3531 UnresolvedAncestorPad = &FPI;
3532 break;
3533 }
3534 Value *ExitedParent = getParentPad(ExitedPad);
3535 if (ExitedParent == UnwindParent) {
3536 // ExitedPad is the ancestor-most pad which this unwind
3537 // edge exits, so we can resolve up to it, meaning that
3538 // ExitedParent is the first ancestor still unresolved.
3539 UnresolvedAncestorPad = ExitedParent;
3540 break;
3541 }
3542 ExitedPad = ExitedParent;
3543 } while (!isa<ConstantTokenNone>(ExitedPad));
3544 } else {
3545 // Unwinding to caller exits all pads.
3546 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3547 ExitsFPI = true;
3548 UnresolvedAncestorPad = &FPI;
3549 }
3550
3551 if (ExitsFPI) {
3552 // This unwind edge exits FPI. Make sure it agrees with other
3553 // such edges.
3554 if (FirstUser) {
3555 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3556 "pad must have the same unwind "
3557 "dest",
3558 &FPI, U, FirstUser);
3559 } else {
3560 FirstUser = U;
3561 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003562 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3563 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3564 getParentPad(UnwindPad) == getParentPad(&FPI))
3565 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003566 }
3567 }
3568 // Make sure we visit all uses of FPI, but for nested pads stop as
3569 // soon as we know where they unwind to.
3570 if (CurrentPad != &FPI)
3571 break;
3572 }
3573 if (UnresolvedAncestorPad) {
3574 if (CurrentPad == UnresolvedAncestorPad) {
3575 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3576 // we've found an unwind edge that exits it, because we need to verify
3577 // all direct uses of FPI.
3578 assert(CurrentPad == &FPI);
3579 continue;
3580 }
3581 // Pop off the worklist any nested pads that we've found an unwind
3582 // destination for. The pads on the worklist are the uncles,
3583 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3584 // for all ancestors of CurrentPad up to but not including
3585 // UnresolvedAncestorPad.
3586 Value *ResolvedPad = CurrentPad;
3587 while (!Worklist.empty()) {
3588 Value *UnclePad = Worklist.back();
3589 Value *AncestorPad = getParentPad(UnclePad);
3590 // Walk ResolvedPad up the ancestor list until we either find the
3591 // uncle's parent or the last resolved ancestor.
3592 while (ResolvedPad != AncestorPad) {
3593 Value *ResolvedParent = getParentPad(ResolvedPad);
3594 if (ResolvedParent == UnresolvedAncestorPad) {
3595 break;
3596 }
3597 ResolvedPad = ResolvedParent;
3598 }
3599 // If the resolved ancestor search didn't find the uncle's parent,
3600 // then the uncle is not yet resolved.
3601 if (ResolvedPad != AncestorPad)
3602 break;
3603 // This uncle is resolved, so pop it from the worklist.
3604 Worklist.pop_back();
3605 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003606 }
3607 }
3608
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003609 if (FirstUnwindPad) {
3610 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3611 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3612 Value *SwitchUnwindPad;
3613 if (SwitchUnwindDest)
3614 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3615 else
3616 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3617 Assert(SwitchUnwindPad == FirstUnwindPad,
3618 "Unwind edges out of a catch must have the same unwind dest as "
3619 "the parent catchswitch",
3620 &FPI, FirstUser, CatchSwitch);
3621 }
3622 }
3623
3624 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003625}
3626
David Majnemer8a1c45d2015-12-12 05:38:55 +00003627void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003628 BasicBlock *BB = CatchSwitch.getParent();
3629
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003630 Function *F = BB->getParent();
3631 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003632 "CatchSwitchInst needs to be in a function with a personality.",
3633 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003634
David Majnemer8a1c45d2015-12-12 05:38:55 +00003635 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003636 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003637 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3638 "CatchSwitchInst not the first non-PHI instruction in the block.",
3639 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003640
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003641 auto *ParentPad = CatchSwitch.getParentPad();
3642 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3643 "CatchSwitchInst has an invalid parent.", ParentPad);
3644
David Majnemer8a1c45d2015-12-12 05:38:55 +00003645 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003646 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003647 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3648 "CatchSwitchInst must unwind to an EH block which is not a "
3649 "landingpad.",
3650 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003651
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003652 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3653 if (getParentPad(I) == ParentPad)
3654 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3655 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003656
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003657 Assert(CatchSwitch.getNumHandlers() != 0,
3658 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3659
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003660 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003661 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3662 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003663 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003664
David Majnemerfe2f7f32016-02-29 22:56:36 +00003665 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003666 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003667}
3668
David Majnemer654e1302015-07-31 17:58:14 +00003669void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003670 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3671 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3672 CRI.getOperand(0));
3673
David Majnemer654e1302015-07-31 17:58:14 +00003674 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3675 Instruction *I = UnwindDest->getFirstNonPHI();
3676 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3677 "CleanupReturnInst must unwind to an EH block which is not a "
3678 "landingpad.",
3679 &CRI);
3680 }
3681
3682 visitTerminatorInst(CRI);
3683}
3684
Rafael Espindola654320a2012-02-26 02:23:37 +00003685void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3686 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003687 // If the we have an invalid invoke, don't try to compute the dominance.
3688 // We already reject it in the invoke specific checks and the dominance
3689 // computation doesn't handle multiple edges.
3690 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3691 if (II->getNormalDest() == II->getUnwindDest())
3692 return;
3693 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003694
Michael Kruseff379b62016-03-26 23:32:57 +00003695 // Quick check whether the def has already been encountered in the same block.
3696 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3697 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003698 //
3699 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3700 // wrapping an SSA value, assert that we've already encountered it. See
3701 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003702 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3703 return;
3704
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003705 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003706 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003707 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003708}
3709
Artur Pilipenkocca80022015-10-09 17:41:29 +00003710void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3711 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3712 "apply only to pointer types", &I);
3713 Assert(isa<LoadInst>(I),
3714 "dereferenceable, dereferenceable_or_null apply only to load"
3715 " instructions, use attributes for calls or invokes", &I);
3716 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3717 "take one operand!", &I);
3718 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3719 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3720 "dereferenceable_or_null metadata value must be an i64!", &I);
3721}
3722
Misha Brukmanc566ca362004-03-02 00:22:19 +00003723/// verifyInstruction - Verify that an instruction is well formed.
3724///
Chris Lattner069a7952002-06-25 15:56:27 +00003725void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003726 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003727 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003728
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003729 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003730 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003731 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3732 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003733 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003734 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003735
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003736 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003737 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3738 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003739
Chris Lattner5f126b72004-03-29 00:29:36 +00003740 // Check that the return value of the instruction is either void or a legal
3741 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003742 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3743 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003744
Nick Lewycky93e06a52009-09-27 23:27:42 +00003745 // Check that the instruction doesn't produce metadata. Calls are already
3746 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003747 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3748 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003749
Chris Lattner0e851da2002-04-18 20:37:37 +00003750 // Check that all uses of the instruction, if they are instructions
3751 // themselves, actually have parent basic blocks. If the use is not an
3752 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003753 for (Use &U : I.uses()) {
3754 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003755 Assert(Used->getParent() != nullptr,
3756 "Instruction referencing"
3757 " instruction not embedded in a basic block!",
3758 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003759 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003760 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003761 return;
3762 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003763 }
3764
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003765 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003766 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003767
3768 // Check to make sure that only first-class-values are operands to
3769 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003770 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003771 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003772 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003773
Chris Lattner9ece94b2004-03-14 03:23:54 +00003774 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003775 // Check to make sure that the "address of" an intrinsic function is never
3776 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003777 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003778 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003779 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3780 "Cannot take the address of an intrinsic!", &I);
3781 Assert(
3782 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003783 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003784 F->getIntrinsicID() == Intrinsic::coro_resume ||
3785 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003786 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003787 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3788 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003789 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3790 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003791 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003792 Assert(F->getParent() == &M, "Referencing function in another module!",
3793 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003794 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003795 Assert(OpBB->getParent() == BB->getParent(),
3796 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003797 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003798 Assert(OpArg->getParent() == BB->getParent(),
3799 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003800 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003801 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3802 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003803 } else if (isa<Instruction>(I.getOperand(i))) {
3804 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003805 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003806 Assert((i + 1 == e && isa<CallInst>(I)) ||
3807 (i + 3 == e && isa<InvokeInst>(I)),
3808 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003809 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003810 if (CE->getType()->isPtrOrPtrVectorTy() ||
3811 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003812 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003813 // illegal bitcast. If the datalayout string specifies non-integral
3814 // address spaces then we also need to check for illegal ptrtoint and
3815 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003816 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003817 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003818 }
3819 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003820
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003821 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003822 Assert(I.getType()->isFPOrFPVectorTy(),
3823 "fpmath requires a floating point result!", &I);
3824 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003825 if (ConstantFP *CFP0 =
3826 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003827 const APFloat &Accuracy = CFP0->getValueAPF();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003828 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
Matt Arsenault82f41512016-06-27 19:43:15 +00003829 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003830 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3831 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003832 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003833 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003834 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003835 }
3836
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003837 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003838 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3839 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003840 visitRangeMetadata(I, Range, I.getType());
3841 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003842
Philip Reames0ca58b32014-10-21 20:56:29 +00003843 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003844 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3845 &I);
3846 Assert(isa<LoadInst>(I),
3847 "nonnull applies only to load instructions, use attributes"
3848 " for calls or invokes",
3849 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003850 }
3851
Artur Pilipenkocca80022015-10-09 17:41:29 +00003852 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3853 visitDereferenceableMetadata(I, MD);
3854
3855 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3856 visitDereferenceableMetadata(I, MD);
3857
Mehdi Aminia84a8402016-12-16 06:29:14 +00003858 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
3859 TBAAVerifyHelper.visitTBAAMetadata(I, TBAA);
Sanjoy Das2582e692016-11-08 20:46:01 +00003860
Artur Pilipenkocca80022015-10-09 17:41:29 +00003861 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3862 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3863 &I);
3864 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3865 "use attributes for calls or invokes", &I);
3866 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3867 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3868 Assert(CI && CI->getType()->isIntegerTy(64),
3869 "align metadata value must be an i64!", &I);
3870 uint64_t Align = CI->getZExtValue();
3871 Assert(isPowerOf2_64(Align),
3872 "align metadata value must be a power of 2!", &I);
3873 Assert(Align <= Value::MaximumAlignment,
3874 "alignment is larger that implementation defined limit", &I);
3875 }
3876
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003877 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003878 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003879 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003880 }
3881
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003882 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Adrian Prantl941fa752016-12-05 18:04:47 +00003883 verifyFragmentExpression(*DII);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003884
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003885 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003886}
3887
Philip Reames007561a2015-06-26 22:21:52 +00003888/// Allow intrinsics to be verified in different ways.
3889void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003890 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003891 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3892 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003893
Chris Lattner144b6192012-05-27 19:37:05 +00003894 // Verify that the intrinsic prototype lines up with what the .td files
3895 // describe.
3896 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003897 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003898
Chris Lattner144b6192012-05-27 19:37:05 +00003899 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3900 getIntrinsicInfoTableEntries(ID, Table);
3901 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003902
Chris Lattner144b6192012-05-27 19:37:05 +00003903 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003904 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3905 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003906 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003907 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003908 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3909 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003910 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003911
3912 // Verify if the intrinsic call matches the vararg property.
3913 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003914 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003915 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003916 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003917 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003918 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003919
3920 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003921 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003922
3923 // Now that we have the intrinsic ID and the actual argument types (and we
3924 // know they are legal for the intrinsic!) get the intrinsic name through the
3925 // usual means. This allows us to verify the mangling of argument types into
3926 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003927 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003928 Assert(ExpectedName == IF->getName(),
3929 "Intrinsic name not mangled correctly for type arguments! "
3930 "Should be: " +
3931 ExpectedName,
3932 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003933
Chris Lattner588096e2009-12-28 09:07:21 +00003934 // If the intrinsic takes MDNode arguments, verify that they are either global
3935 // or are local to *this* function.
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00003936 for (Value *V : CS.args())
Philip Reames007561a2015-06-26 22:21:52 +00003937 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3938 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003939
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003940 switch (ID) {
3941 default:
3942 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003943 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003944 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003945 if (isa<ConstantPointerNull>(InfoArg))
3946 break;
3947 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3948 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3949 "info argument of llvm.coro.begin must refer to an initialized "
3950 "constant");
3951 Constant *Init = GV->getInitializer();
3952 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3953 "info argument of llvm.coro.begin must refer to either a struct or "
3954 "an array");
3955 break;
3956 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003957 case Intrinsic::ctlz: // llvm.ctlz
3958 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003959 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003960 "is_zero_undef argument of bit counting intrinsics must be a "
3961 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003962 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003963 break;
Andrew Kaylora0a11642017-01-26 23:27:59 +00003964 case Intrinsic::experimental_constrained_fadd:
3965 case Intrinsic::experimental_constrained_fsub:
3966 case Intrinsic::experimental_constrained_fmul:
3967 case Intrinsic::experimental_constrained_fdiv:
3968 case Intrinsic::experimental_constrained_frem:
3969 visitConstrainedFPIntrinsic(
3970 cast<ConstrainedFPIntrinsic>(*CS.getInstruction()));
3971 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003972 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003973 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3974 "invalid llvm.dbg.declare intrinsic call 1", CS);
3975 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003976 break;
3977 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003978 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003979 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003980 case Intrinsic::memcpy:
3981 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003982 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003983 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003984 Assert(AlignCI,
3985 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003986 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003987 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003988 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003989 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003990 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003991 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003992 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003993 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003994 }
Igor Laevsky4f31e522016-12-29 14:31:07 +00003995 case Intrinsic::memcpy_element_atomic: {
3996 ConstantInt *ElementSizeCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3997 Assert(ElementSizeCI, "element size of the element-wise atomic memory "
3998 "intrinsic must be a constant int",
3999 CS);
4000 const APInt &ElementSizeVal = ElementSizeCI->getValue();
4001 Assert(ElementSizeVal.isPowerOf2(),
4002 "element size of the element-wise atomic memory intrinsic "
4003 "must be a power of 2",
4004 CS);
4005
4006 auto IsValidAlignment = [&](uint64_t Alignment) {
4007 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4008 };
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004009
Reid Kleckner859f8b52017-04-28 20:34:27 +00004010 uint64_t DstAlignment = CS.getParamAlignment(0),
4011 SrcAlignment = CS.getParamAlignment(1);
Igor Laevsky4f31e522016-12-29 14:31:07 +00004012
4013 Assert(IsValidAlignment(DstAlignment),
4014 "incorrect alignment of the destination argument",
4015 CS);
4016 Assert(IsValidAlignment(SrcAlignment),
4017 "incorrect alignment of the source argument",
4018 CS);
4019 break;
4020 }
Bill Wendling05604e02008-08-23 09:46:46 +00004021 case Intrinsic::gcroot:
4022 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00004023 case Intrinsic::gcread:
4024 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00004025 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00004026 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
4027 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
4028 Assert(isa<Constant>(CS.getArgOperand(1)),
4029 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00004030 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00004031 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004032 "llvm.gcroot parameter #1 must either be a pointer alloca, "
4033 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00004034 CS);
Talin2e59f142010-09-30 20:23:47 +00004035 }
Chris Lattner25852062008-08-24 20:46:13 +00004036 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00004037
Philip Reames9818dd72015-06-26 22:04:34 +00004038 Assert(CS.getParent()->getParent()->hasGC(),
4039 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00004040 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00004041 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00004042 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004043 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00004044 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004045 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004046 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004047 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4048 isa<ConstantInt>(CS.getArgOperand(2)) &&
4049 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4050 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4051 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004052 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004053 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004054 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4055 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004056 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004057 case Intrinsic::lifetime_start:
4058 case Intrinsic::lifetime_end:
4059 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004060 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004061 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004062 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004063 break;
4064 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004065 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4066 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004067 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004068
Reid Kleckner60381792015-07-07 22:25:32 +00004069 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004070 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004071 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004072 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004073 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004074 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004075 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004076 if (isa<ConstantPointerNull>(Arg))
4077 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004078 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004079 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004080 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004081 }
Philip Reames9818dd72015-06-26 22:04:34 +00004082 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004083 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004084 break;
4085 }
Reid Kleckner60381792015-07-07 22:25:32 +00004086 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004087 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004088 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004089 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004090 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004091 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004092 CS);
4093 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004094 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004095 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004096 auto &Entry = FrameEscapeInfo[Fn];
4097 Entry.second = unsigned(
4098 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004099 break;
4100 }
4101
Philip Reames1ffa9372015-01-30 23:28:05 +00004102 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004103 Assert(!CS.isInlineAsm(),
4104 "gc.statepoint support for inline assembly unimplemented", CS);
4105 Assert(CS.getParent()->getParent()->hasGC(),
4106 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004107
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004108 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004109 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004110 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004111 Assert(CS.getParent()->getParent()->hasGC(),
4112 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004113 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004114 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004115 const Function *StatepointFn =
4116 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004117 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4118 StatepointFn->getIntrinsicID() ==
4119 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004120 "gc.result operand #1 must be from a statepoint", CS,
4121 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004122
Philip Reamesb23713a2014-12-03 22:23:24 +00004123 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004124 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004125 auto *PT = cast<PointerType>(Target->getType());
4126 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004127 Assert(CS.getType() == TargetFuncType->getReturnType(),
4128 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004129 break;
4130 }
4131 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004132 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004133
Philip Reames3e2cf532016-01-07 03:32:11 +00004134 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4135 "gc.relocate must return a pointer or a vector of pointers", CS);
4136
Igor Laevsky9570ff92015-02-19 11:28:47 +00004137 // Check that this relocate is correctly tied to the statepoint
4138
4139 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004140 if (LandingPadInst *LandingPad =
4141 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004142
Sanjoy Das5665c992015-05-11 23:47:27 +00004143 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004144 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004145
4146 // Landingpad relocates should have only one predecessor with invoke
4147 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004148 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004149 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004150 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4151 InvokeBB);
4152 Assert(isStatepoint(InvokeBB->getTerminator()),
4153 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004154 }
4155 else {
4156 // In all other cases relocate should be tied to the statepoint directly.
4157 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004158 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004159 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004160 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004161 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004162 }
4163
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004164 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004165
Manuel Jacob83eefa62016-01-05 04:03:00 +00004166 ImmutableCallSite StatepointCS(
4167 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004168
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004169 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004170 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004171 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004172 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004173
Philip Reames9818dd72015-06-26 22:04:34 +00004174 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004175 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004176 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004177
4178 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4179 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4180 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004181 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004182 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004183 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004184 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004185
4186 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004187 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004188 Assert(StatepointCS.arg_size() > 0,
4189 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004190 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004191 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004192 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004193 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4194 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004195 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004196 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004197 "gc.statepoint: number of transition arguments must be "
4198 "a constant integer");
4199 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004200 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4201 ->getZExtValue();
4202 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004203 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004204 "gc.statepoint: number of deoptimization arguments must be "
4205 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004206 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004207 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4208 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004209 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004210 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004211 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4212 "gc.relocate: statepoint base index doesn't fall within the "
4213 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004214 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004215 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4216 "gc.relocate: statepoint derived index doesn't fall within the "
4217 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004218 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004219
Philip Reames3e2cf532016-01-07 03:32:11 +00004220 // Relocated value must be either a pointer type or vector-of-pointer type,
4221 // but gc_relocate does not need to return the same pointer type as the
4222 // relocated pointer. It can be casted to the correct type later if it's
4223 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004224 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004225 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004226 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004227
Philip Reames3e2cf532016-01-07 03:32:11 +00004228 auto ResultType = CS.getType();
4229 auto DerivedType = Relocate.getDerivedPtr()->getType();
4230 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004231 "gc.relocate: vector relocates to vector and pointer to pointer",
4232 CS);
4233 Assert(
4234 ResultType->getPointerAddressSpace() ==
4235 DerivedType->getPointerAddressSpace(),
4236 "gc.relocate: relocating a pointer shouldn't change its address space",
4237 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004238 break;
4239 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004240 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004241 case Intrinsic::eh_exceptionpointer: {
4242 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4243 "eh.exceptionpointer argument must be a catchpad", CS);
4244 break;
4245 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004246 case Intrinsic::masked_load: {
4247 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004248
Philip Reamesf16d7812016-02-09 21:43:12 +00004249 Value *Ptr = CS.getArgOperand(0);
4250 //Value *Alignment = CS.getArgOperand(1);
4251 Value *Mask = CS.getArgOperand(2);
4252 Value *PassThru = CS.getArgOperand(3);
4253 Assert(Mask->getType()->isVectorTy(),
4254 "masked_load: mask must be vector", CS);
4255
4256 // DataTy is the overloaded type
4257 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004258 Assert(DataTy == CS.getType(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004259 "masked_load: return must match pointer type", CS);
4260 Assert(PassThru->getType() == DataTy,
4261 "masked_load: pass through and data type must match", CS);
4262 Assert(Mask->getType()->getVectorNumElements() ==
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004263 DataTy->getVectorNumElements(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004264 "masked_load: vector mask must be same length as data", CS);
4265 break;
4266 }
4267 case Intrinsic::masked_store: {
4268 Value *Val = CS.getArgOperand(0);
4269 Value *Ptr = CS.getArgOperand(1);
4270 //Value *Alignment = CS.getArgOperand(2);
4271 Value *Mask = CS.getArgOperand(3);
4272 Assert(Mask->getType()->isVectorTy(),
4273 "masked_store: mask must be vector", CS);
4274
4275 // DataTy is the overloaded type
4276 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004277 Assert(DataTy == Val->getType(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004278 "masked_store: storee must match pointer type", CS);
4279 Assert(Mask->getType()->getVectorNumElements() ==
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004280 DataTy->getVectorNumElements(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004281 "masked_store: vector mask must be same length as data", CS);
4282 break;
4283 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004284
Sanjoy Das021de052016-03-31 00:18:46 +00004285 case Intrinsic::experimental_guard: {
4286 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4287 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4288 "experimental_guard must have exactly one "
4289 "\"deopt\" operand bundle");
4290 break;
4291 }
4292
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004293 case Intrinsic::experimental_deoptimize: {
4294 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4295 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4296 "experimental_deoptimize must have exactly one "
4297 "\"deopt\" operand bundle");
4298 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4299 "experimental_deoptimize return type must match caller return type");
4300
4301 if (CS.isCall()) {
4302 auto *DeoptCI = CS.getInstruction();
4303 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4304 Assert(RI,
4305 "calls to experimental_deoptimize must be followed by a return");
4306
4307 if (!CS.getType()->isVoidTy() && RI)
4308 Assert(RI->getReturnValue() == DeoptCI,
4309 "calls to experimental_deoptimize must be followed by a return "
4310 "of the value computed by experimental_deoptimize");
4311 }
4312
4313 break;
4314 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004315 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004316}
4317
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004318/// \brief Carefully grab the subprogram from a local scope.
4319///
4320/// This carefully grabs the subprogram from a local scope, avoiding the
4321/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004322static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004323 if (!LocalScope)
4324 return nullptr;
4325
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004326 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004327 return SP;
4328
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004329 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004330 return getSubprogram(LB->getRawScope());
4331
4332 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004333 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004334 return nullptr;
4335}
4336
Andrew Kaylora0a11642017-01-26 23:27:59 +00004337void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
4338 Assert(isa<MetadataAsValue>(FPI.getOperand(2)),
4339 "invalid rounding mode argument", &FPI);
4340 Assert(FPI.getRoundingMode() != ConstrainedFPIntrinsic::rmInvalid,
4341 "invalid rounding mode argument", &FPI);
4342 Assert(FPI.getExceptionBehavior() != ConstrainedFPIntrinsic::ebInvalid,
4343 "invalid exception behavior argument", &FPI);
4344}
4345
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004346template <class DbgIntrinsicTy>
4347void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4348 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004349 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004350 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4351 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004352 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004353 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4354 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004355 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004356 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4357 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004358
4359 // Ignore broken !dbg attachments; they're checked elsewhere.
4360 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004361 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004362 return;
4363
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004364 BasicBlock *BB = DII.getParent();
4365 Function *F = BB ? BB->getParent() : nullptr;
4366
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004367 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004368 DILocalVariable *Var = DII.getVariable();
4369 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004370 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4371 &DII, BB, F);
4372
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004373 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4374 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004375 if (!VarSP || !LocSP)
4376 return; // Broken scope chains are checked elsewhere.
4377
Adrian Prantla2ef0472016-09-14 17:30:37 +00004378 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4379 " variable and !dbg attachment",
4380 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4381 Loc->getScope()->getSubprogram());
Adrian Prantl612ac862017-02-28 23:48:42 +00004382
4383 verifyFnArgs(DII);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004384}
4385
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004386static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004387 // Be careful of broken types (checked elsewhere).
4388 const Metadata *RawType = V.getRawType();
4389 while (RawType) {
4390 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004391 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004392 if (uint64_t Size = T->getSizeInBits())
4393 return Size;
4394
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004395 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004396 // Look at the base type.
4397 RawType = DT->getRawBaseType();
4398 continue;
4399 }
4400
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004401 // Missing type or size.
4402 break;
4403 }
4404
4405 // Fail gracefully.
4406 return 0;
4407}
4408
Adrian Prantl941fa752016-12-05 18:04:47 +00004409void Verifier::verifyFragmentExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004410 DILocalVariable *V;
4411 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004412 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004413 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4414 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004415 } else {
4416 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004417 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4418 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004419 }
4420
4421 // We don't know whether this intrinsic verified correctly.
4422 if (!V || !E || !E->isValid())
4423 return;
4424
Keno Fischer253a7bd2016-01-15 02:12:38 +00004425 // Nothing to do if this isn't a bit piece expression.
Adrian Prantl49797ca2016-12-22 05:27:12 +00004426 auto Fragment = E->getFragmentInfo();
4427 if (!Fragment)
Keno Fischer253a7bd2016-01-15 02:12:38 +00004428 return;
4429
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004430 // The frontend helps out GDB by emitting the members of local anonymous
4431 // unions as artificial local variables with shared storage. When SROA splits
4432 // the storage for artificial local variables that are smaller than the entire
4433 // union, the overhang piece will be outside of the allotted space for the
4434 // variable and this check fails.
4435 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4436 if (V->isArtificial())
4437 return;
4438
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004439 // If there's no size, the type is broken, but that should be checked
4440 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004441 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004442 if (!VarSize)
4443 return;
4444
Adrian Prantl49797ca2016-12-22 05:27:12 +00004445 unsigned FragSize = Fragment->SizeInBits;
4446 unsigned FragOffset = Fragment->OffsetInBits;
Adrian Prantl941fa752016-12-05 18:04:47 +00004447 AssertDI(FragSize + FragOffset <= VarSize,
4448 "fragment is larger than or outside of variable", &I, V, E);
4449 AssertDI(FragSize != VarSize, "fragment covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004450}
4451
Adrian Prantl612ac862017-02-28 23:48:42 +00004452void Verifier::verifyFnArgs(const DbgInfoIntrinsic &I) {
Adrian Prantl63d96952017-03-07 17:28:54 +00004453 // This function does not take the scope of noninlined function arguments into
4454 // account. Don't run it if current function is nodebug, because it may
4455 // contain inlined debug intrinsics.
4456 if (!HasDebugInfo)
4457 return;
4458
Adrian Prantl612ac862017-02-28 23:48:42 +00004459 DILocalVariable *Var;
4460 if (auto *DV = dyn_cast<DbgValueInst>(&I)) {
4461 // For performance reasons only check non-inlined ones.
4462 if (DV->getDebugLoc()->getInlinedAt())
4463 return;
4464 Var = DV->getVariable();
4465 } else {
4466 auto *DD = cast<DbgDeclareInst>(&I);
4467 if (DD->getDebugLoc()->getInlinedAt())
4468 return;
4469 Var = DD->getVariable();
4470 }
4471 AssertDI(Var, "dbg intrinsic without variable");
4472
4473 unsigned ArgNo = Var->getArg();
4474 if (!ArgNo)
4475 return;
4476
4477 // Verify there are no duplicate function argument debug info entries.
4478 // These will cause hard-to-debug assertions in the DWARF backend.
4479 if (DebugFnArgs.size() < ArgNo)
4480 DebugFnArgs.resize(ArgNo, nullptr);
4481
4482 auto *Prev = DebugFnArgs[ArgNo - 1];
4483 DebugFnArgs[ArgNo - 1] = Var;
4484 AssertDI(!Prev || (Prev == Var), "conflicting debug info for argument", &I,
4485 Prev, Var);
4486}
4487
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004488void Verifier::verifyCompileUnits() {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004489 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004490 SmallPtrSet<const Metadata *, 2> Listed;
4491 if (CUs)
4492 Listed.insert(CUs->op_begin(), CUs->op_end());
Davide Italianoa9de0102017-02-20 22:51:42 +00004493 for (auto *CU : CUVisited)
4494 AssertDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU);
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004495 CUVisited.clear();
4496}
4497
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004498void Verifier::verifyDeoptimizeCallingConvs() {
4499 if (DeoptimizeDeclarations.empty())
4500 return;
4501
4502 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004503 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004504 Assert(First->getCallingConv() == F->getCallingConv(),
4505 "All llvm.experimental.deoptimize declarations must have the same "
4506 "calling convention",
4507 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004508 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004509}
4510
Chris Lattner0e851da2002-04-18 20:37:37 +00004511//===----------------------------------------------------------------------===//
4512// Implement the public interfaces to this file...
4513//===----------------------------------------------------------------------===//
4514
Chandler Carruth043949d2014-01-19 02:22:18 +00004515bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004516 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004517
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004518 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004519 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004520
4521 // Note that this function's return value is inverted from what you would
4522 // expect of a function called "verify".
4523 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004524}
4525
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004526bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4527 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004528 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004529 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004530
Chandler Carruth043949d2014-01-19 02:22:18 +00004531 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004532 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004533 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004534
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004535 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004536 if (BrokenDebugInfo)
4537 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004538 // Note that this function's return value is inverted from what you would
4539 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004540 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004541}
Chandler Carruth043949d2014-01-19 02:22:18 +00004542
4543namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004544
Chandler Carruth4d356312014-01-20 11:34:08 +00004545struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004546 static char ID;
4547
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004548 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004549 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004550
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004551 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004552 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004553 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004554 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004555 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004556 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004557 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004558 }
4559
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004560 bool doInitialization(Module &M) override {
4561 V = llvm::make_unique<Verifier>(
4562 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4563 return false;
4564 }
4565
Craig Topperf398d7c2014-03-05 06:35:38 +00004566 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004567 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004568 report_fatal_error("Broken function found, compilation aborted!");
4569
4570 return false;
4571 }
4572
Craig Topperf398d7c2014-03-05 06:35:38 +00004573 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004574 bool HasErrors = false;
4575 for (Function &F : M)
4576 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004577 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004578
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004579 HasErrors |= !V->verify();
Adrian Prantl94a903e2016-05-25 21:33:20 +00004580 if (FatalErrors) {
4581 if (HasErrors)
4582 report_fatal_error("Broken module found, compilation aborted!");
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004583 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
Adrian Prantl94a903e2016-05-25 21:33:20 +00004584 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004585
Adrian Prantl94a903e2016-05-25 21:33:20 +00004586 // Strip broken debug info.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004587 if (V->hasBrokenDebugInfo()) {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004588 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4589 M.getContext().diagnose(DiagInvalid);
4590 if (!StripDebugInfo(M))
4591 report_fatal_error("Failed to strip malformed debug info");
4592 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004593 return false;
4594 }
4595
4596 void getAnalysisUsage(AnalysisUsage &AU) const override {
4597 AU.setPreservesAll();
4598 }
4599};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004600
4601} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004602
Mehdi Aminia84a8402016-12-16 06:29:14 +00004603/// Helper to issue failure from the TBAA verification
4604template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
4605 if (Diagnostic)
4606 return Diagnostic->CheckFailed(Args...);
4607}
4608
4609#define AssertTBAA(C, ...) \
4610 do { \
4611 if (!(C)) { \
4612 CheckFailed(__VA_ARGS__); \
4613 return false; \
4614 } \
4615 } while (false)
4616
4617/// Verify that \p BaseNode can be used as the "base type" in the struct-path
4618/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
4619/// struct-type node describing an aggregate data structure (like a struct).
4620TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004621TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004622 if (BaseNode->getNumOperands() < 2) {
4623 CheckFailed("Base nodes must have at least two operands", &I, BaseNode);
4624 return {true, ~0u};
4625 }
4626
4627 auto Itr = TBAABaseNodes.find(BaseNode);
4628 if (Itr != TBAABaseNodes.end())
4629 return Itr->second;
4630
4631 auto Result = verifyTBAABaseNodeImpl(I, BaseNode);
4632 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
4633 (void)InsertResult;
4634 assert(InsertResult.second && "We just checked!");
4635 return Result;
4636}
4637
4638TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004639TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004640 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
4641
4642 if (BaseNode->getNumOperands() == 2) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004643 // Scalar nodes can only be accessed at offset 0.
Sanjoy Das00d76a52016-12-29 15:47:05 +00004644 return isValidScalarTBAANode(BaseNode)
4645 ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
4646 : InvalidNode;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004647 }
4648
4649 if (BaseNode->getNumOperands() % 2 != 1) {
4650 CheckFailed("Struct tag nodes must have an odd number of operands!",
4651 BaseNode);
4652 return InvalidNode;
4653 }
4654
Sanjoy Das00d76a52016-12-29 15:47:05 +00004655 if (!isa<MDString>(BaseNode->getOperand(0))) {
4656 CheckFailed("Struct tag nodes have a string as their first operand",
4657 BaseNode);
4658 return InvalidNode;
4659 }
4660
Mehdi Aminia84a8402016-12-16 06:29:14 +00004661 bool Failed = false;
4662
4663 Optional<APInt> PrevOffset;
4664 unsigned BitWidth = ~0u;
4665
4666 // We've already checked that BaseNode is not a degenerate root node with one
4667 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
4668 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4669 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
4670 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
4671 if (!isa<MDNode>(FieldTy)) {
4672 CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode);
4673 Failed = true;
4674 continue;
4675 }
4676
4677 auto *OffsetEntryCI =
4678 mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset);
4679 if (!OffsetEntryCI) {
4680 CheckFailed("Offset entries must be constants!", &I, BaseNode);
4681 Failed = true;
4682 continue;
4683 }
4684
4685 if (BitWidth == ~0u)
4686 BitWidth = OffsetEntryCI->getBitWidth();
4687
4688 if (OffsetEntryCI->getBitWidth() != BitWidth) {
4689 CheckFailed(
4690 "Bitwidth between the offsets and struct type entries must match", &I,
4691 BaseNode);
4692 Failed = true;
4693 continue;
4694 }
4695
4696 // NB! As far as I can tell, we generate a non-strictly increasing offset
4697 // sequence only from structs that have zero size bit fields. When
4698 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
4699 // pick the field lexically the latest in struct type metadata node. This
4700 // mirrors the actual behavior of the alias analysis implementation.
4701 bool IsAscending =
4702 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
4703
4704 if (!IsAscending) {
4705 CheckFailed("Offsets must be increasing!", &I, BaseNode);
4706 Failed = true;
4707 }
4708
4709 PrevOffset = OffsetEntryCI->getValue();
4710 }
4711
4712 return Failed ? InvalidNode
4713 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
4714}
4715
4716static bool IsRootTBAANode(const MDNode *MD) {
4717 return MD->getNumOperands() < 2;
4718}
4719
4720static bool IsScalarTBAANodeImpl(const MDNode *MD,
4721 SmallPtrSetImpl<const MDNode *> &Visited) {
Sanjoy Das00d76a52016-12-29 15:47:05 +00004722 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004723 return false;
4724
Sanjoy Das00d76a52016-12-29 15:47:05 +00004725 if (!isa<MDString>(MD->getOperand(0)))
Mehdi Aminia84a8402016-12-16 06:29:14 +00004726 return false;
4727
Sanjoy Das00d76a52016-12-29 15:47:05 +00004728 if (MD->getNumOperands() == 3) {
4729 auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
4730 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
4731 return false;
4732 }
4733
4734 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4735 return Parent && Visited.insert(Parent).second &&
Mehdi Aminia84a8402016-12-16 06:29:14 +00004736 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
4737}
4738
Sanjoy Das55f12d92016-12-29 15:46:57 +00004739bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
4740 auto ResultIt = TBAAScalarNodes.find(MD);
4741 if (ResultIt != TBAAScalarNodes.end())
4742 return ResultIt->second;
4743
Mehdi Aminia84a8402016-12-16 06:29:14 +00004744 SmallPtrSet<const MDNode *, 4> Visited;
Sanjoy Das55f12d92016-12-29 15:46:57 +00004745 bool Result = IsScalarTBAANodeImpl(MD, Visited);
4746 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
4747 (void)InsertResult;
4748 assert(InsertResult.second && "Just checked!");
4749
4750 return Result;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004751}
4752
4753/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
4754/// Offset in place to be the offset within the field node returned.
4755///
4756/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
4757MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I,
Sanjoy Das600d2a52016-12-29 15:47:01 +00004758 const MDNode *BaseNode,
Mehdi Aminia84a8402016-12-16 06:29:14 +00004759 APInt &Offset) {
4760 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
4761
4762 // Scalar nodes have only one possible "field" -- their parent in the access
4763 // hierarchy. Offset must be zero at this point, but our caller is supposed
4764 // to Assert that.
4765 if (BaseNode->getNumOperands() == 2)
4766 return cast<MDNode>(BaseNode->getOperand(1));
4767
4768 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4769 auto *OffsetEntryCI =
4770 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
4771 if (OffsetEntryCI->getValue().ugt(Offset)) {
4772 if (Idx == 1) {
4773 CheckFailed("Could not find TBAA parent in struct type node", &I,
4774 BaseNode, &Offset);
4775 return nullptr;
4776 }
4777
4778 auto *PrevOffsetEntryCI =
4779 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx - 1));
4780 Offset -= PrevOffsetEntryCI->getValue();
4781 return cast<MDNode>(BaseNode->getOperand(Idx - 2));
4782 }
4783 }
4784
4785 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
4786 BaseNode->getOperand(BaseNode->getNumOperands() - 1));
4787
4788 Offset -= LastOffsetEntryCI->getValue();
4789 return cast<MDNode>(BaseNode->getOperand(BaseNode->getNumOperands() - 2));
4790}
4791
Sanjoy Das600d2a52016-12-29 15:47:01 +00004792bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004793 AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) ||
Sanjoy Das600d2a52016-12-29 15:47:01 +00004794 isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) ||
4795 isa<AtomicCmpXchgInst>(I),
Mehdi Aminia84a8402016-12-16 06:29:14 +00004796 "TBAA is only for loads, stores and calls!", &I);
4797
4798 bool IsStructPathTBAA =
4799 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
4800
4801 AssertTBAA(
4802 IsStructPathTBAA,
4803 "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I);
4804
4805 AssertTBAA(MD->getNumOperands() < 5,
4806 "Struct tag metadata must have either 3 or 4 operands", &I, MD);
4807
4808 MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
4809 MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4810
4811 if (MD->getNumOperands() == 4) {
4812 auto *IsImmutableCI =
4813 mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(3));
4814 AssertTBAA(IsImmutableCI,
4815 "Immutability tag on struct tag metadata must be a constant", &I,
4816 MD);
4817 AssertTBAA(
4818 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
4819 "Immutability part of the struct tag metadata must be either 0 or 1",
4820 &I, MD);
4821 }
4822
4823 AssertTBAA(BaseNode && AccessType,
4824 "Malformed struct tag metadata: base and access-type "
4825 "should be non-null and point to Metadata nodes",
4826 &I, MD, BaseNode, AccessType);
4827
Sanjoy Das55f12d92016-12-29 15:46:57 +00004828 AssertTBAA(isValidScalarTBAANode(AccessType),
Sanjoy Das00d76a52016-12-29 15:47:05 +00004829 "Access type node must be a valid scalar type", &I, MD,
4830 AccessType);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004831
4832 auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2));
4833 AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD);
4834
4835 APInt Offset = OffsetCI->getValue();
4836 bool SeenAccessTypeInPath = false;
4837
4838 SmallPtrSet<MDNode *, 4> StructPath;
4839
4840 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
4841 BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset)) {
4842 if (!StructPath.insert(BaseNode).second) {
4843 CheckFailed("Cycle detected in struct path", &I, MD);
4844 return false;
4845 }
4846
4847 bool Invalid;
4848 unsigned BaseNodeBitWidth;
4849 std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode);
4850
4851 // If the base node is invalid in itself, then we've already printed all the
4852 // errors we wanted to print.
4853 if (Invalid)
4854 return false;
4855
4856 SeenAccessTypeInPath |= BaseNode == AccessType;
4857
Sanjoy Das55f12d92016-12-29 15:46:57 +00004858 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004859 AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access",
4860 &I, MD, &Offset);
4861
4862 AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
4863 (BaseNodeBitWidth == 0 && Offset == 0),
4864 "Access bit-width not the same as description bit-width", &I, MD,
4865 BaseNodeBitWidth, Offset.getBitWidth());
4866 }
4867
4868 AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!",
4869 &I, MD);
4870 return true;
4871}
4872
Chandler Carruth4d356312014-01-20 11:34:08 +00004873char VerifierLegacyPass::ID = 0;
4874INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004875
4876FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004877 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004878}
4879
Chandler Carruthdab4eae2016-11-23 17:53:26 +00004880AnalysisKey VerifierAnalysis::Key;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004881VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4882 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004883 Result Res;
4884 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4885 return Res;
4886}
Chandler Carruth4d356312014-01-20 11:34:08 +00004887
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004888VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4889 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004890 return { llvm::verifyFunction(F, &dbgs()), false };
4891}
4892
4893PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4894 auto Res = AM.getResult<VerifierAnalysis>(M);
4895 if (FatalErrors) {
4896 if (Res.IRBroken)
4897 report_fatal_error("Broken module found, compilation aborted!");
4898 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4899 }
4900
4901 // Strip broken debug info.
4902 if (Res.DebugInfoBroken) {
4903 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4904 M.getContext().diagnose(DiagInvalid);
4905 if (!StripDebugInfo(M))
4906 report_fatal_error("Failed to strip malformed debug info");
4907 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004908 return PreservedAnalyses::all();
4909}
4910
Adrian Prantle3656182016-05-09 19:57:29 +00004911PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4912 auto res = AM.getResult<VerifierAnalysis>(F);
4913 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004914 report_fatal_error("Broken function found, compilation aborted!");
4915
4916 return PreservedAnalyses::all();
4917}