blob: ff98126529d4d732db06da01ec487546a727046b [file] [log] [blame]
Nick Lewyckyd489edf2012-02-25 07:20:06 +00001//===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chris Lattner3e6e3e62002-03-29 19:06:18 +000010// This file defines the function verifier interface, that can be used for some
Chris Lattner2f7c9632001-06-06 20:29:01 +000011// sanity checking of input to the system.
12//
Misha Brukman1c9de462004-06-24 21:47:35 +000013// Note that this does not provide full `Java style' security and verifications,
14// instead it just tries to ensure that code is well-formed.
Chris Lattner2f7c9632001-06-06 20:29:01 +000015//
Misha Brukman1c9de462004-06-24 21:47:35 +000016// * Both of a binary operator's parameters are of the same type
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000017// * Verify that the indices of mem access instructions match other operands
Misha Brukman1c9de462004-06-24 21:47:35 +000018// * Verify that arithmetic and other things are only performed on first-class
Chris Lattner8e72d6f2002-08-02 17:37:08 +000019// types. Verify that shifts & logicals only happen on integrals f.e.
Misha Brukman1c9de462004-06-24 21:47:35 +000020// * All of the constants in a switch statement are of the correct type
Chris Lattner8e72d6f2002-08-02 17:37:08 +000021// * The code is in valid SSA form
Misha Brukman1c9de462004-06-24 21:47:35 +000022// * It should be illegal to put a label into any other type (like a structure)
Chris Lattner2f7c9632001-06-06 20:29:01 +000023// or to return one. [except constant arrays!]
Nick Lewyckyf88c84f2008-03-28 06:46:51 +000024// * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
Chris Lattnerd02f08d2002-02-20 17:55:43 +000025// * PHI nodes must have an entry for each predecessor, with no extras.
Chris Lattner069a7952002-06-25 15:56:27 +000026// * PHI nodes must be the first thing in a basic block, all grouped together
Chris Lattner4cd9df82002-10-06 21:00:31 +000027// * PHI nodes must have at least one entry
Chris Lattner069a7952002-06-25 15:56:27 +000028// * All basic blocks should only end with terminator insts, not contain them
Chris Lattner3e6e3e62002-03-29 19:06:18 +000029// * The entry node to a function must not have predecessors
Misha Brukmanfa100532003-10-10 17:54:14 +000030// * All Instructions must be embedded into a basic block
Misha Brukman1c9de462004-06-24 21:47:35 +000031// * Functions cannot take a void-typed parameter
Chris Lattneraf95e582002-04-13 22:48:46 +000032// * Verify that a function's argument list agrees with it's declared type.
Chris Lattnerfbf5be52002-03-15 20:25:09 +000033// * It is illegal to specify a name for a void value.
Misha Brukmanfa100532003-10-10 17:54:14 +000034// * It is illegal to have a internal global value with no initializer
Chris Lattner486302a2002-04-12 18:20:49 +000035// * It is illegal to have a ret instruction that returns a value that does not
36// agree with the function return value type.
Chris Lattner338a4622002-05-08 19:49:50 +000037// * Function call argument types match the function prototype
Bill Wendlingfae14752011-08-12 20:24:12 +000038// * A landing pad is defined by a landingpad instruction, and can be jumped to
39// only by the unwind edge of an invoke instruction.
40// * A landingpad instruction must be the first non-PHI instruction in the
41// block.
Vedant Kumar029c3512015-10-21 20:33:31 +000042// * Landingpad instructions must be in a function with a personality function.
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000043// * All other things that are tested by asserts spread about the code...
Chris Lattner2f7c9632001-06-06 20:29:01 +000044//
45//===----------------------------------------------------------------------===//
46
Chandler Carruth5ad5f152014-01-13 09:26:24 +000047#include "llvm/IR/Verifier.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000048#include "llvm/ADT/APFloat.h"
49#include "llvm/ADT/APInt.h"
50#include "llvm/ADT/ArrayRef.h"
51#include "llvm/ADT/DenseMap.h"
52#include "llvm/ADT/ilist.h"
Joseph Tremoulet8ea80862016-01-10 04:31:05 +000053#include "llvm/ADT/MapVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000054#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000055#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000056#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000057#include "llvm/ADT/SmallSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000058#include "llvm/ADT/SmallVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000059#include "llvm/ADT/StringMap.h"
60#include "llvm/ADT/StringRef.h"
61#include "llvm/ADT/Twine.h"
62#include "llvm/IR/Argument.h"
63#include "llvm/IR/Attributes.h"
64#include "llvm/IR/BasicBlock.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000065#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000066#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000067#include "llvm/IR/CallingConv.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000068#include "llvm/IR/Comdat.h"
69#include "llvm/IR/Constant.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000070#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000071#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000072#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000073#include "llvm/IR/DebugInfo.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000074#include "llvm/IR/DebugInfoMetadata.h"
75#include "llvm/IR/DebugLoc.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000076#include "llvm/IR/DerivedTypes.h"
Adrian Prantle3656182016-05-09 19:57:29 +000077#include "llvm/IR/DiagnosticInfo.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000078#include "llvm/IR/Dominators.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000079#include "llvm/IR/Function.h"
80#include "llvm/IR/GlobalAlias.h"
81#include "llvm/IR/GlobalValue.h"
82#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000083#include "llvm/IR/InlineAsm.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000084#include "llvm/IR/InstrTypes.h"
85#include "llvm/IR/Instruction.h"
86#include "llvm/IR/Instructions.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000087#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000088#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000089#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000090#include "llvm/IR/LLVMContext.h"
91#include "llvm/IR/Metadata.h"
92#include "llvm/IR/Module.h"
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +000093#include "llvm/IR/ModuleSlotTracker.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000094#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000095#include "llvm/IR/Statepoint.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000096#include "llvm/IR/Type.h"
97#include "llvm/IR/Use.h"
98#include "llvm/IR/User.h"
99#include "llvm/IR/Value.h"
Chris Lattner8a923e72008-03-12 17:45:29 +0000100#include "llvm/Pass.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000101#include "llvm/Support/AtomicOrdering.h"
102#include "llvm/Support/Casting.h"
Manman Ren74c61b92013-07-19 00:31:03 +0000103#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +0000104#include "llvm/Support/Debug.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000105#include "llvm/Support/Dwarf.h"
Torok Edwin6dd27302009-07-08 18:01:40 +0000106#include "llvm/Support/ErrorHandling.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000107#include "llvm/Support/MathExtras.h"
Chris Lattner24025262009-02-28 21:05:51 +0000108#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000109#include <algorithm>
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000110#include <cassert>
111#include <cstdint>
112#include <memory>
113#include <string>
114#include <utility>
115
Chris Lattner189d19f2003-11-21 20:23:48 +0000116using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +0000117
Duncan P. N. Exon Smith0633fd72015-03-17 17:28:41 +0000118static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
Manman Ren74c61b92013-07-19 00:31:03 +0000119
Daniel Jaspera44fd302016-12-16 13:53:46 +0000120namespace llvm {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000121
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000122struct VerifierSupport {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000123 raw_ostream *OS;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000124 const Module &M;
125 ModuleSlotTracker MST;
126 const DataLayout &DL;
127 LLVMContext &Context;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000128
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +0000129 /// Track the brokenness of the module while recursively visiting.
130 bool Broken = false;
Adrian Prantl541a9c52016-05-06 19:26:47 +0000131 /// Broken debug info can be "recovered" from by stripping the debug info.
132 bool BrokenDebugInfo = false;
133 /// Whether to treat broken debug info as an error.
134 bool TreatBrokenDebugInfoAsError = true;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000135
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000136 explicit VerifierSupport(raw_ostream *OS, const Module &M)
137 : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000138
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000139private:
Keno Fischera6c4ce42015-12-01 19:06:36 +0000140 void Write(const Module *M) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000141 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
Keno Fischera6c4ce42015-12-01 19:06:36 +0000142 }
143
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000144 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000145 if (!V)
146 return;
147 if (isa<Instruction>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000148 V->print(*OS, MST);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000149 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000150 } else {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000151 V->printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000152 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000153 }
154 }
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000155
Philip Reames9818dd72015-06-26 22:04:34 +0000156 void Write(ImmutableCallSite CS) {
157 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000158 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000159
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000160 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000161 if (!MD)
162 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000163 MD->print(*OS, MST, &M);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000164 *OS << '\n';
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000165 }
166
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000167 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
168 Write(MD.get());
169 }
170
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000171 void Write(const NamedMDNode *NMD) {
172 if (!NMD)
173 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000174 NMD->print(*OS, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000175 *OS << '\n';
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000176 }
177
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000178 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000179 if (!T)
180 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000181 *OS << ' ' << *T;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000182 }
183
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000184 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000185 if (!C)
186 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000187 *OS << *C;
David Majnemerdad0a642014-06-27 18:19:56 +0000188 }
189
Sanjoy Das3336f682016-12-11 20:07:15 +0000190 void Write(const APInt *AI) {
191 if (!AI)
192 return;
193 *OS << *AI << '\n';
194 }
195
196 void Write(const unsigned i) { *OS << i << '\n'; }
197
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000198 template <typename T> void Write(ArrayRef<T> Vs) {
199 for (const T &V : Vs)
200 Write(V);
201 }
202
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000203 template <typename T1, typename... Ts>
204 void WriteTs(const T1 &V1, const Ts &... Vs) {
205 Write(V1);
206 WriteTs(Vs...);
207 }
208
209 template <typename... Ts> void WriteTs() {}
210
211public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000212 /// \brief A check failed, so printout out the condition and the message.
213 ///
214 /// This provides a nice place to put a breakpoint if you want to see why
215 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000216 void CheckFailed(const Twine &Message) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000217 if (OS)
218 *OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000219 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000220 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000221
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000222 /// \brief A check failed (with values to print).
223 ///
224 /// This calls the Message-only version so that the above is easier to set a
225 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000226 template <typename T1, typename... Ts>
227 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
228 CheckFailed(Message);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000229 if (OS)
230 WriteTs(V1, Vs...);
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000231 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000232
233 /// A debug info check failed.
234 void DebugInfoCheckFailed(const Twine &Message) {
235 if (OS)
236 *OS << Message << '\n';
237 Broken |= TreatBrokenDebugInfoAsError;
238 BrokenDebugInfo = true;
239 }
240
241 /// A debug info check failed (with values to print).
242 template <typename T1, typename... Ts>
243 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
244 const Ts &... Vs) {
245 DebugInfoCheckFailed(Message);
246 if (OS)
247 WriteTs(V1, Vs...);
248 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000249};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000250
Daniel Jaspera44fd302016-12-16 13:53:46 +0000251} // namespace llvm
252
253namespace {
254
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000255class Verifier : public InstVisitor<Verifier>, VerifierSupport {
256 friend class InstVisitor<Verifier>;
257
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000258 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000259
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000260 /// \brief When verifying a basic block, keep track of all of the
261 /// instructions we have seen so far.
262 ///
263 /// This allows us to do efficient dominance checks for the case when an
264 /// instruction has an operand that is an instruction in the same block.
265 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000266
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000267 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000268 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000269
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000270 /// Track all DICompileUnits visited.
271 SmallPtrSet<const Metadata *, 2> CUVisited;
272
David Majnemer654e1302015-07-31 17:58:14 +0000273 /// \brief The result type for a landingpad.
274 Type *LandingPadResultTy;
275
Reid Kleckner60381792015-07-07 22:25:32 +0000276 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000277 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000278 bool SawFrameEscape;
279
Adrian Prantl63d96952017-03-07 17:28:54 +0000280 /// Whether the current function has a DISubprogram attached to it.
281 bool HasDebugInfo = false;
282
Reid Kleckner60381792015-07-07 22:25:32 +0000283 /// Stores the count of how many objects were passed to llvm.localescape for a
284 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000285 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000286
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000287 // Maps catchswitches and cleanuppads that unwind to siblings to the
288 // terminators that indicate the unwind, used to detect cycles therein.
289 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
290
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000291 /// Cache of constants visited in search of ConstantExprs.
292 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
293
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000294 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
295 SmallVector<const Function *, 4> DeoptimizeDeclarations;
296
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000297 // Verify that this GlobalValue is only used in this module.
298 // This map is used to avoid visiting uses twice. We can arrive at a user
299 // twice, if they have multiple operands. In particular for very large
300 // constant expressions, we can arrive at a particular user many times.
301 SmallPtrSet<const Value *, 32> GlobalValueVisited;
302
Adrian Prantl612ac862017-02-28 23:48:42 +0000303 // Keeps track of duplicate function argument debug info.
304 SmallVector<const DILocalVariable *, 16> DebugFnArgs;
305
Mehdi Aminia84a8402016-12-16 06:29:14 +0000306 TBAAVerifier TBAAVerifyHelper;
Sanjoy Das3336f682016-12-11 20:07:15 +0000307
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000308 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000309
Chandler Carruth043949d2014-01-19 02:22:18 +0000310public:
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000311 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
312 const Module &M)
313 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
Mehdi Aminia84a8402016-12-16 06:29:14 +0000314 SawFrameEscape(false), TBAAVerifyHelper(this) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000315 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
316 }
317
318 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
Chris Lattner0e851da2002-04-18 20:37:37 +0000319
Chandler Carruth043949d2014-01-19 02:22:18 +0000320 bool verify(const Function &F) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000321 assert(F.getParent() == &M &&
322 "An instance of this class only works with a specific module!");
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000323
324 // First ensure the function is well-enough formed to compute dominance
Peter Collingbourne71bb7942016-06-06 22:32:52 +0000325 // information, and directly compute a dominance tree. We don't rely on the
326 // pass manager to provide this as it isolates us from a potentially
327 // out-of-date dominator tree and makes it significantly more complex to run
328 // this code outside of a pass manager.
329 // FIXME: It's really gross that we have to cast away constness here.
330 if (!F.empty())
331 DT.recalculate(const_cast<Function &>(F));
332
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000333 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000334 if (!BB.empty() && BB.back().isTerminator())
335 continue;
336
337 if (OS) {
338 *OS << "Basic Block in function '" << F.getName()
339 << "' does not have terminator!\n";
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000340 BB.printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000341 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000342 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000343 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000344 }
Chandler Carruth76777602014-01-17 10:56:02 +0000345
Chandler Carruth043949d2014-01-19 02:22:18 +0000346 Broken = false;
347 // FIXME: We strip const here because the inst visitor strips const.
348 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000349 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000350 InstsInThisBlock.clear();
Adrian Prantl9b24a452017-03-07 17:28:49 +0000351 DebugFnArgs.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000352 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000353 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000354 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000355
Chandler Carruth043949d2014-01-19 02:22:18 +0000356 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000357 }
358
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000359 /// Verify the module that this instance of \c Verifier was initialized with.
360 bool verify() {
Chandler Carruth043949d2014-01-19 02:22:18 +0000361 Broken = false;
362
Peter Collingbournebb738172016-06-06 23:21:27 +0000363 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
364 for (const Function &F : M)
365 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
366 DeoptimizeDeclarations.push_back(&F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000367
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000368 // Now that we've visited every function, verify that we never asked to
369 // recover a frame index that wasn't escaped.
370 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000371 for (const GlobalVariable &GV : M.globals())
372 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000373
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000374 for (const GlobalAlias &GA : M.aliases())
375 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000376
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000377 for (const NamedMDNode &NMD : M.named_metadata())
378 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000379
David Majnemerdad0a642014-06-27 18:19:56 +0000380 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
381 visitComdat(SMEC.getValue());
382
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000383 visitModuleFlags(M);
384 visitModuleIdents(M);
385
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000386 verifyCompileUnits();
387
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000388 verifyDeoptimizeCallingConvs();
389
Chandler Carruth043949d2014-01-19 02:22:18 +0000390 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000391 }
Chris Lattner9713b842002-04-28 16:04:26 +0000392
Chandler Carruth043949d2014-01-19 02:22:18 +0000393private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000394 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000395 void visitGlobalValue(const GlobalValue &GV);
396 void visitGlobalVariable(const GlobalVariable &GV);
397 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000398 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000399 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000400 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000401 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000402 void visitMDNode(const MDNode &MD);
403 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
404 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000405 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000406 void visitModuleIdents(const Module &M);
407 void visitModuleFlags(const Module &M);
408 void visitModuleFlag(const MDNode *Op,
409 DenseMap<const MDString *, const MDNode *> &SeenIDs,
410 SmallVectorImpl<const MDNode *> &Requirements);
411 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000412 void visitBasicBlock(BasicBlock &BB);
Sanjoy Das26f28a22016-11-09 19:36:39 +0000413 void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty);
414 void visitDereferenceableMetadata(Instruction &I, MDNode *MD);
Sanjoy Das3336f682016-12-11 20:07:15 +0000415
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000416 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000417#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
418#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000419 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000420 void visitDIVariable(const DIVariable &N);
421 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
422 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000423
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000424 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
425
Chandler Carruth043949d2014-01-19 02:22:18 +0000426 // InstVisitor overrides...
427 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000428 void visit(Instruction &I);
429
430 void visitTruncInst(TruncInst &I);
431 void visitZExtInst(ZExtInst &I);
432 void visitSExtInst(SExtInst &I);
433 void visitFPTruncInst(FPTruncInst &I);
434 void visitFPExtInst(FPExtInst &I);
435 void visitFPToUIInst(FPToUIInst &I);
436 void visitFPToSIInst(FPToSIInst &I);
437 void visitUIToFPInst(UIToFPInst &I);
438 void visitSIToFPInst(SIToFPInst &I);
439 void visitIntToPtrInst(IntToPtrInst &I);
440 void visitPtrToIntInst(PtrToIntInst &I);
441 void visitBitCastInst(BitCastInst &I);
442 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
443 void visitPHINode(PHINode &PN);
444 void visitBinaryOperator(BinaryOperator &B);
445 void visitICmpInst(ICmpInst &IC);
446 void visitFCmpInst(FCmpInst &FC);
447 void visitExtractElementInst(ExtractElementInst &EI);
448 void visitInsertElementInst(InsertElementInst &EI);
449 void visitShuffleVectorInst(ShuffleVectorInst &EI);
450 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
451 void visitCallInst(CallInst &CI);
452 void visitInvokeInst(InvokeInst &II);
453 void visitGetElementPtrInst(GetElementPtrInst &GEP);
454 void visitLoadInst(LoadInst &LI);
455 void visitStoreInst(StoreInst &SI);
456 void verifyDominatesUse(Instruction &I, unsigned i);
457 void visitInstruction(Instruction &I);
458 void visitTerminatorInst(TerminatorInst &I);
459 void visitBranchInst(BranchInst &BI);
460 void visitReturnInst(ReturnInst &RI);
461 void visitSwitchInst(SwitchInst &SI);
462 void visitIndirectBrInst(IndirectBrInst &BI);
463 void visitSelectInst(SelectInst &SI);
464 void visitUserOp1(Instruction &I);
465 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000466 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Andrew Kaylora0a11642017-01-26 23:27:59 +0000467 void visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000468 template <class DbgIntrinsicTy>
469 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000470 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
471 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
472 void visitFenceInst(FenceInst &FI);
473 void visitAllocaInst(AllocaInst &AI);
474 void visitExtractValueInst(ExtractValueInst &EVI);
475 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000476 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000477 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000478 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000479 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000480 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000481 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000482 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000483 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000484 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000485
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000486 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000487 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
488 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000489 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000490 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000491 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000492 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
493 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000494 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000495 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000496 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000497 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000498 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000499 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000500
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000501 void visitConstantExprsRecursively(const Constant *EntryC);
502 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000503 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000504 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000505 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000506
Adrian Prantl941fa752016-12-05 18:04:47 +0000507 void verifyFragmentExpression(const DbgInfoIntrinsic &I);
Adrian Prantl612ac862017-02-28 23:48:42 +0000508 void verifyFnArgs(const DbgInfoIntrinsic &I);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000509
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000510 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000511 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000512
513 /// Module-level verification that all @llvm.experimental.deoptimize
514 /// declarations share the same calling convention.
515 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000516};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000517
518} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000519
Adrian Prantl541a9c52016-05-06 19:26:47 +0000520/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000521#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000522 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000523
Adrian Prantl541a9c52016-05-06 19:26:47 +0000524/// We know that a debug info condition should be true, if not print
525/// an error message.
526#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000527 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000528
Chris Lattnere5a22c02008-08-28 04:02:44 +0000529void Verifier::visit(Instruction &I) {
530 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000531 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000532 InstVisitor<Verifier>::visit(I);
533}
534
Keno Fischer60f82a22016-01-14 22:20:56 +0000535// Helper to recursively iterate over indirect users. By
536// returning false, the callback can ask to stop recursing
537// further.
538static void forEachUser(const Value *User,
539 SmallPtrSet<const Value *, 32> &Visited,
540 llvm::function_ref<bool(const Value *)> Callback) {
541 if (!Visited.insert(User).second)
542 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000543 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000544 if (Callback(TheNextUser))
545 forEachUser(TheNextUser, Visited, Callback);
546}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000547
Chandler Carruth043949d2014-01-19 02:22:18 +0000548void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000549 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000550 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000551
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000552 Assert(GV.getAlignment() <= Value::MaximumAlignment,
553 "huge alignment values are unsupported", &GV);
554 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
555 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000556
557 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000558 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000559 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000560 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000561 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000562
563 if (GV.isDeclarationForLinker())
564 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000565
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000566 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000567 if (const Instruction *I = dyn_cast<Instruction>(V)) {
568 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000569 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
570 I);
571 else if (I->getParent()->getParent()->getParent() != &M)
572 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
573 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000574 I->getParent()->getParent()->getParent());
575 return false;
576 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000577 if (F->getParent() != &M)
578 CheckFailed("Global is used by function in a different module", &GV, &M,
579 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000580 return false;
581 }
582 return true;
583 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000584}
585
Chandler Carruth043949d2014-01-19 02:22:18 +0000586void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000587 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000588 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000589 "Global variable initializer type does not match global "
590 "variable type!",
591 &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000592 // If the global has common linkage, it must have a zero initializer and
593 // cannot be constant.
594 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000595 Assert(GV.getInitializer()->isNullValue(),
596 "'common' global must have a zero initializer!", &GV);
597 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
598 &GV);
599 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000600 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000601 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000602
Nick Lewycky466d0c12011-04-08 07:30:21 +0000603 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
604 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000605 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
606 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000607 // Don't worry about emitting an error for it not being an array,
608 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000609 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000610 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
611 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000612 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000613 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000614 Assert(STy &&
615 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
616 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
617 STy->getTypeAtIndex(1) == FuncPtrTy,
618 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000619 if (STy->getNumElements() == 3) {
620 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000621 Assert(ETy->isPointerTy() &&
622 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
623 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000624 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000625 }
626 }
627
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000628 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000629 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000630 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
631 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000632 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000633 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
634 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000635 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000636 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000637 const Constant *Init = GV.getInitializer();
638 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000639 Assert(InitArray, "wrong initalizer for intrinsic global variable",
640 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000641 for (Value *Op : InitArray->operands()) {
642 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000643 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
644 isa<GlobalAlias>(V),
645 "invalid llvm.used member", V);
646 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000647 }
648 }
649 }
650 }
651
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000652 Assert(!GV.hasDLLImportStorageClass() ||
653 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
654 GV.hasAvailableExternallyLinkage(),
655 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000656
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000657 // Visit any debug info attachments.
658 SmallVector<MDNode *, 1> MDs;
659 GV.getMetadata(LLVMContext::MD_dbg, MDs);
Adrian Prantldc6e0162016-12-20 02:33:30 +0000660 for (auto *MD : MDs) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000661 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
662 visitDIGlobalVariableExpression(*GVE);
663 else
Adrian Prantlfd37e792017-02-23 23:54:29 +0000664 AssertDI(false, "!dbg attachment of global variable must be a "
665 "DIGlobalVariableExpression");
Adrian Prantldc6e0162016-12-20 02:33:30 +0000666 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000667
Matt Arsenault24b49c42013-07-31 17:49:08 +0000668 if (!GV.hasInitializer()) {
669 visitGlobalValue(GV);
670 return;
671 }
672
673 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000674 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000675
Chris Lattnere3400652004-12-15 20:23:49 +0000676 visitGlobalValue(GV);
677}
678
Rafael Espindola64c1e182014-06-03 02:41:57 +0000679void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
680 SmallPtrSet<const GlobalAlias*, 4> Visited;
681 Visited.insert(&GA);
682 visitAliaseeSubExpr(Visited, GA, C);
683}
684
Craig Topper71b7b682014-08-21 05:55:13 +0000685void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000686 const GlobalAlias &GA, const Constant &C) {
687 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000688 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
689 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000690
691 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000692 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000693
Sanjoy Das5ce32722016-04-08 00:48:30 +0000694 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000695 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000696 } else {
697 // Only continue verifying subexpressions of GlobalAliases.
698 // Do not recurse into global initializers.
699 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000700 }
701 }
702
703 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000704 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000705
706 for (const Use &U : C.operands()) {
707 Value *V = &*U;
708 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
709 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
710 else if (const auto *C2 = dyn_cast<Constant>(V))
711 visitAliaseeSubExpr(Visited, GA, *C2);
712 }
713}
714
Chandler Carruth043949d2014-01-19 02:22:18 +0000715void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000716 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
717 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
718 "weak_odr, or external linkage!",
719 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000720 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000721 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
722 Assert(GA.getType() == Aliasee->getType(),
723 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000724
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000725 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
726 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000727
Rafael Espindola64c1e182014-06-03 02:41:57 +0000728 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000729
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000730 visitGlobalValue(GA);
731}
732
Chandler Carruth043949d2014-01-19 02:22:18 +0000733void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000734 // There used to be various other llvm.dbg.* nodes, but we don't support
735 // upgrading them and we want to reserve the namespace for future uses.
736 if (NMD.getName().startswith("llvm.dbg."))
737 AssertDI(NMD.getName() == "llvm.dbg.cu",
738 "unrecognized named metadata node in the llvm.dbg namespace",
739 &NMD);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000740 for (const MDNode *MD : NMD.operands()) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000741 if (NMD.getName() == "llvm.dbg.cu")
Adrian Prantl541a9c52016-05-06 19:26:47 +0000742 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000743
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000744 if (!MD)
745 continue;
746
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000747 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000748 }
749}
750
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000751void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000752 // Only visit each node once. Metadata can be mutually recursive, so this
753 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000754 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000755 return;
756
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000757 switch (MD.getMetadataID()) {
758 default:
759 llvm_unreachable("Invalid MDNode subclass");
760 case Metadata::MDTupleKind:
761 break;
762#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
763 case Metadata::CLASS##Kind: \
764 visit##CLASS(cast<CLASS>(MD)); \
765 break;
766#include "llvm/IR/Metadata.def"
767 }
768
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000769 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000770 if (!Op)
771 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000772 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
773 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000774 if (auto *N = dyn_cast<MDNode>(Op)) {
775 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000776 continue;
777 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000778 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
779 visitValueAsMetadata(*V, nullptr);
780 continue;
781 }
Duncan Sands76d62172010-04-29 16:10:30 +0000782 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000783
784 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000785 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
786 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000787}
788
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000789void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000790 Assert(MD.getValue(), "Expected valid value", &MD);
791 Assert(!MD.getValue()->getType()->isMetadataTy(),
792 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000793
794 auto *L = dyn_cast<LocalAsMetadata>(&MD);
795 if (!L)
796 return;
797
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000798 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000799
800 // If this was an instruction, bb, or argument, verify that it is in the
801 // function that we expect.
802 Function *ActualF = nullptr;
803 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000804 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000805 ActualF = I->getParent()->getParent();
806 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
807 ActualF = BB->getParent();
808 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
809 ActualF = A->getParent();
810 assert(ActualF && "Unimplemented function local metadata case!");
811
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000812 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000813}
814
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000815void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000816 Metadata *MD = MDV.getMetadata();
817 if (auto *N = dyn_cast<MDNode>(MD)) {
818 visitMDNode(*N);
819 return;
820 }
821
822 // Only visit each node once. Metadata can be mutually recursive, so this
823 // avoids infinite recursion here, as well as being an optimization.
824 if (!MDNodes.insert(MD).second)
825 return;
826
827 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
828 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000829}
830
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000831static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
832static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
833static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000834
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000835template <class Ty>
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000836static bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000837 for (Metadata *MD : N.operands()) {
838 if (MD) {
839 if (!isa<Ty>(MD))
840 return false;
841 } else {
842 if (!AllowNull)
843 return false;
844 }
845 }
846 return true;
847}
848
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000849template <class Ty> static bool isValidMetadataArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000850 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
851}
852
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000853template <class Ty> static bool isValidMetadataNullArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000854 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
855}
856
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000857void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000858 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
859 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000860 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000861 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000862}
863
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000864void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000865 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000866}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000867
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000868void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000869 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000870 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000871}
872
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000873void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000874 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
875 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000876}
877
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000878void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000879 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000880}
881
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000882void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000883 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
884 N.getTag() == dwarf::DW_TAG_unspecified_type,
885 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000886}
887
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000888void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000889 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000890 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000891
Adrian Prantl541a9c52016-05-06 19:26:47 +0000892 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
893 N.getTag() == dwarf::DW_TAG_pointer_type ||
894 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
895 N.getTag() == dwarf::DW_TAG_reference_type ||
896 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
897 N.getTag() == dwarf::DW_TAG_const_type ||
898 N.getTag() == dwarf::DW_TAG_volatile_type ||
899 N.getTag() == dwarf::DW_TAG_restrict_type ||
Victor Leschuke1156c22016-10-31 19:09:38 +0000900 N.getTag() == dwarf::DW_TAG_atomic_type ||
Adrian Prantl541a9c52016-05-06 19:26:47 +0000901 N.getTag() == dwarf::DW_TAG_member ||
902 N.getTag() == dwarf::DW_TAG_inheritance ||
903 N.getTag() == dwarf::DW_TAG_friend,
904 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000905 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000906 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
907 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000908 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000909
Adrian Prantl541a9c52016-05-06 19:26:47 +0000910 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
911 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
912 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000913}
914
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000915static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000916 return (Flags & DINode::FlagLValueReference) &&
917 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000918}
919
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000920void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
921 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000922 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000923 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000924 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
925 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000926 }
927}
928
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000929void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000930 // Common scope checks.
931 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000932
Adrian Prantl541a9c52016-05-06 19:26:47 +0000933 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
934 N.getTag() == dwarf::DW_TAG_structure_type ||
935 N.getTag() == dwarf::DW_TAG_union_type ||
936 N.getTag() == dwarf::DW_TAG_enumeration_type ||
937 N.getTag() == dwarf::DW_TAG_class_type,
938 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000939
Adrian Prantl541a9c52016-05-06 19:26:47 +0000940 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
941 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
942 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000943
Adrian Prantl541a9c52016-05-06 19:26:47 +0000944 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
945 "invalid composite elements", &N, N.getRawElements());
946 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
947 N.getRawVTableHolder());
948 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
949 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000950 if (auto *Params = N.getRawTemplateParams())
951 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000952
953 if (N.getTag() == dwarf::DW_TAG_class_type ||
954 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000955 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
956 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000957 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000958}
959
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000960void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000961 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000962 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000963 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000964 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000965 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000966 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000967 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000968 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
969 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000970}
971
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000972void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000973 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Amjad Aboud7faeecc2016-12-25 10:12:09 +0000974 AssertDI((N.getChecksumKind() != DIFile::CSK_None ||
975 N.getChecksum().empty()), "invalid checksum kind", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000976}
977
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000978void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000979 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
980 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000981
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000982 // Don't bother verifying the compilation directory or producer string
983 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000984 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
985 N.getRawFile());
986 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
987 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000988
Adrian Prantl541a9c52016-05-06 19:26:47 +0000989 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
990 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000991
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000992 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000993 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000994 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000995 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000996 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
997 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000998 }
999 }
1000 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001001 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001002 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001003 AssertDI(Op && (isa<DIType>(Op) ||
1004 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00001005 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +00001006 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001007 }
1008 }
1009 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001010 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001011 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001012 AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)),
1013 "invalid global variable ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001014 }
1015 }
1016 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001017 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001018 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001019 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
1020 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001021 }
1022 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001023 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001024 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001025 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001026 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001027 }
1028 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +00001029 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001030}
1031
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001032void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001033 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1034 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +00001035 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001036 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Justin Bognerefc3fbf2017-02-17 23:57:42 +00001037 else
1038 AssertDI(N.getLine() == 0, "line specified with no file", &N, N.getLine());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001039 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001040 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1041 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1042 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001043 if (auto *Params = N.getRawTemplateParams())
1044 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001045 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001046 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1047 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001048 if (auto *RawVars = N.getRawVariables()) {
1049 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001050 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001051 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001052 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1053 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001054 }
1055 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001056 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1057 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001058
Adrian Prantl75819ae2016-04-15 15:57:41 +00001059 auto *Unit = N.getRawUnit();
1060 if (N.isDefinition()) {
1061 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001062 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1063 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1064 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001065 } else {
1066 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001067 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001068 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001069}
1070
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001071void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001072 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1073 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1074 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001075}
1076
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001077void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1078 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001079
Adrian Prantl541a9c52016-05-06 19:26:47 +00001080 AssertDI(N.getLine() || !N.getColumn(),
1081 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001082}
1083
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001084void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1085 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001086}
1087
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001088void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001089 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001090 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001091 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001092}
1093
Amjad Abouda9bcf162015-12-10 12:56:35 +00001094void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001095 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1096 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1097 "invalid macinfo type", &N);
1098 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001099 if (!N.getValue().empty()) {
1100 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1101 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001102}
1103
1104void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001105 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1106 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001107 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001108 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001109
1110 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001111 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001112 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001113 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001114 }
1115 }
1116}
1117
Adrian Prantlab1243f2015-06-29 23:03:47 +00001118void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001119 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1120 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001121}
1122
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001123void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001124 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001125}
1126
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001127void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1128 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001129
Adrian Prantl541a9c52016-05-06 19:26:47 +00001130 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1131 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001132}
1133
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001134void Verifier::visitDITemplateValueParameter(
1135 const DITemplateValueParameter &N) {
1136 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001137
Adrian Prantl541a9c52016-05-06 19:26:47 +00001138 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1139 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1140 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1141 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001142}
1143
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001144void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001145 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001146 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1147 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001148 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001149 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001150}
1151
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001152void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001153 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001154 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001155
Adrian Prantl541a9c52016-05-06 19:26:47 +00001156 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1157 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001158 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001159 AssertDI(isa<DIDerivedType>(Member),
1160 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001161 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001162}
1163
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001164void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001165 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001166 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001167
Adrian Prantl541a9c52016-05-06 19:26:47 +00001168 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1169 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1170 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001171}
1172
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001173void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001174 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001175}
1176
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001177void Verifier::visitDIGlobalVariableExpression(
1178 const DIGlobalVariableExpression &GVE) {
1179 AssertDI(GVE.getVariable(), "missing variable");
1180 if (auto *Var = GVE.getVariable())
1181 visitDIGlobalVariable(*Var);
1182 if (auto *Expr = GVE.getExpression())
1183 visitDIExpression(*Expr);
1184}
1185
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001186void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001187 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001188 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001189 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001190 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001191 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001192}
1193
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001194void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001195 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1196 N.getTag() == dwarf::DW_TAG_imported_declaration,
1197 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001198 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001199 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1200 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1201 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001202}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001203
David Majnemerdad0a642014-06-27 18:19:56 +00001204void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001205 // The Module is invalid if the GlobalValue has private linkage. Entities
1206 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001207 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001208 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1209 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001210}
1211
Chandler Carruth043949d2014-01-19 02:22:18 +00001212void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001213 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1214 if (!Idents)
1215 return;
1216
1217 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1218 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001219 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001220 Assert(N->getNumOperands() == 1,
1221 "incorrect number of operands in llvm.ident metadata", N);
1222 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1223 ("invalid value for llvm.ident metadata entry operand"
1224 "(the operand should be a string)"),
1225 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001226 }
1227}
1228
Chandler Carruth043949d2014-01-19 02:22:18 +00001229void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001230 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1231 if (!Flags) return;
1232
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001233 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001234 DenseMap<const MDString*, const MDNode*> SeenIDs;
1235 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001236 for (const MDNode *MDN : Flags->operands())
1237 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001238
1239 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001240 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001241 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001242 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001243
Chandler Carruth043949d2014-01-19 02:22:18 +00001244 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001245 if (!Op) {
1246 CheckFailed("invalid requirement on flag, flag is not present in module",
1247 Flag);
1248 continue;
1249 }
1250
1251 if (Op->getOperand(2) != ReqValue) {
1252 CheckFailed(("invalid requirement on flag, "
1253 "flag does not have the required value"),
1254 Flag);
1255 continue;
1256 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001257 }
1258}
1259
Chandler Carruth043949d2014-01-19 02:22:18 +00001260void
1261Verifier::visitModuleFlag(const MDNode *Op,
1262 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1263 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001264 // Each module flag should have three arguments, the merge behavior (a
1265 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001266 Assert(Op->getNumOperands() == 3,
1267 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001268 Module::ModFlagBehavior MFB;
1269 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001270 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001271 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001272 "invalid behavior operand in module flag (expected constant integer)",
1273 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001274 Assert(false,
1275 "invalid behavior operand in module flag (unexpected constant)",
1276 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001277 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001278 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001279 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1280 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001281
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001282 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001283 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001284 case Module::Error:
1285 case Module::Warning:
1286 case Module::Override:
1287 // These behavior types accept any value.
1288 break;
1289
1290 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001291 // The value should itself be an MDNode with two operands, a flag ID (an
1292 // MDString), and a value.
1293 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001294 Assert(Value && Value->getNumOperands() == 2,
1295 "invalid value for 'require' module flag (expected metadata pair)",
1296 Op->getOperand(2));
1297 Assert(isa<MDString>(Value->getOperand(0)),
1298 ("invalid value for 'require' module flag "
1299 "(first value operand should be a string)"),
1300 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001301
1302 // Append it to the list of requirements, to check once all module flags are
1303 // scanned.
1304 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001305 break;
1306 }
1307
1308 case Module::Append:
1309 case Module::AppendUnique: {
1310 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001311 Assert(isa<MDNode>(Op->getOperand(2)),
1312 "invalid value for 'append'-type module flag "
1313 "(expected a metadata node)",
1314 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001315 break;
1316 }
1317 }
1318
1319 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001320 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001321 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001322 Assert(Inserted,
1323 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001324 }
1325}
1326
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001327void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001328 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001329 unsigned Slot = ~0U;
1330 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1331 if (Attrs.getSlotIndex(I) == Idx) {
1332 Slot = I;
1333 break;
1334 }
1335
1336 assert(Slot != ~0U && "Attribute set inconsistency!");
1337
1338 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1339 I != E; ++I) {
1340 if (I->isStringAttribute())
1341 continue;
1342
1343 if (I->getKindAsEnum() == Attribute::NoReturn ||
1344 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001345 I->getKindAsEnum() == Attribute::NoInline ||
1346 I->getKindAsEnum() == Attribute::AlwaysInline ||
1347 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1348 I->getKindAsEnum() == Attribute::StackProtect ||
1349 I->getKindAsEnum() == Attribute::StackProtectReq ||
1350 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001351 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001352 I->getKindAsEnum() == Attribute::NoRedZone ||
1353 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1354 I->getKindAsEnum() == Attribute::Naked ||
1355 I->getKindAsEnum() == Attribute::InlineHint ||
1356 I->getKindAsEnum() == Attribute::StackAlignment ||
1357 I->getKindAsEnum() == Attribute::UWTable ||
1358 I->getKindAsEnum() == Attribute::NonLazyBind ||
1359 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1360 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1361 I->getKindAsEnum() == Attribute::SanitizeThread ||
1362 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1363 I->getKindAsEnum() == Attribute::MinSize ||
1364 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001365 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001366 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001367 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001368 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001369 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001370 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001371 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001372 I->getKindAsEnum() == Attribute::NoRecurse ||
1373 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001374 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1375 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001376 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001377 CheckFailed("Attribute '" + I->getAsString() +
1378 "' only applies to functions!", V);
1379 return;
1380 }
1381 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001382 I->getKindAsEnum() == Attribute::WriteOnly ||
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001383 I->getKindAsEnum() == Attribute::ReadNone) {
1384 if (Idx == 0) {
1385 CheckFailed("Attribute '" + I->getAsString() +
1386 "' does not apply to function returns");
1387 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001388 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001389 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001390 CheckFailed("Attribute '" + I->getAsString() +
1391 "' does not apply to functions!", V);
1392 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001393 }
1394 }
1395}
1396
Duncan Sandsc3a79922009-06-11 08:11:03 +00001397// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001398// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001399void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001400 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001401 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001402 return;
1403
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001404 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001405
Bill Wendling908126a2012-10-09 09:51:10 +00001406 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001407 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1408 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1409 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1410 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1411 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001412 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001413 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1414 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001415 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001416 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001417 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001418 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001419
Reid Klecknera534a382013-12-19 02:14:12 +00001420 // Check for mutually incompatible attributes. Only inreg is compatible with
1421 // sret.
1422 unsigned AttrCount = 0;
1423 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1424 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1425 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1426 Attrs.hasAttribute(Idx, Attribute::InReg);
1427 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001428 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1429 "and 'sret' are incompatible!",
1430 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001431
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001432 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1433 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1434 "Attributes "
1435 "'inalloca and readonly' are incompatible!",
1436 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001437
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001438 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1439 Attrs.hasAttribute(Idx, Attribute::Returned)),
1440 "Attributes "
1441 "'sret and returned' are incompatible!",
1442 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001443
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001444 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1445 Attrs.hasAttribute(Idx, Attribute::SExt)),
1446 "Attributes "
1447 "'zeroext and signext' are incompatible!",
1448 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001449
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001450 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1451 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1452 "Attributes "
1453 "'readnone and readonly' are incompatible!",
1454 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001455
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001456 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1457 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1458 "Attributes "
1459 "'readnone and writeonly' are incompatible!",
1460 V);
1461
1462 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1463 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1464 "Attributes "
1465 "'readonly and writeonly' are incompatible!",
1466 V);
1467
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001468 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1469 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1470 "Attributes "
1471 "'noinline and alwaysinline' are incompatible!",
1472 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001473
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001474 Assert(
1475 !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)),
1476 "Wrong types for attribute: " +
1477 AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty))
1478 .getAsString(Idx),
1479 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001480
Reid Klecknera534a382013-12-19 02:14:12 +00001481 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001482 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001483 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001484 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1485 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1486 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1487 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001488 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001489 if (!isa<PointerType>(PTy->getElementType()))
1490 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1491 "Attribute 'swifterror' only applies to parameters "
1492 "with pointer to pointer type!",
1493 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001494 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001495 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1496 "Attribute 'byval' only applies to parameters with pointer type!",
1497 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001498 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1499 "Attribute 'swifterror' only applies to parameters "
1500 "with pointer type!",
1501 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001502 }
Duncan Sands0009c442008-01-12 16:42:01 +00001503}
1504
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001505// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001506// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001507void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001508 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001509 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001510 return;
1511
Duncan Sands8c582282007-12-21 19:19:01 +00001512 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001513 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001514 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001515 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001516 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001517
Chris Lattner8a923e72008-03-12 17:45:29 +00001518 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001519 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001520
Chris Lattner229907c2011-07-18 04:54:35 +00001521 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001522 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001523 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001524 else if (Idx-1 < FT->getNumParams())
1525 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001526 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001527 break; // VarArgs attributes, verified elsewhere.
1528
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001529 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001530
Stephen Linb8bd2322013-04-20 05:14:40 +00001531 if (Idx == 0)
1532 continue;
1533
1534 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001535 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001536 SawNest = true;
1537 }
1538
Stephen Linb8bd2322013-04-20 05:14:40 +00001539 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001540 Assert(!SawReturned, "More than one parameter has attribute returned!",
1541 V);
1542 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1543 "Incompatible "
1544 "argument and return types for 'returned' attribute",
1545 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001546 SawReturned = true;
1547 }
1548
Reid Kleckner79418562014-05-09 22:32:13 +00001549 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001550 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1551 Assert(Idx == 1 || Idx == 2,
1552 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001553 SawSRet = true;
1554 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001555
Manman Renf46262e2016-03-29 17:37:21 +00001556 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1557 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1558 SawSwiftSelf = true;
1559 }
1560
Manman Ren9bfd0d02016-04-01 21:41:15 +00001561 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1562 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1563 V);
1564 SawSwiftError = true;
1565 }
1566
Reid Kleckner60d3a832014-01-16 22:59:24 +00001567 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001568 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1569 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001570 }
Duncan Sands8c582282007-12-21 19:19:01 +00001571 }
Devang Patel9cc98122008-10-01 23:41:25 +00001572
Bill Wendling77543892013-01-18 21:11:39 +00001573 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1574 return;
1575
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001576 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001577
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001578 Assert(
1579 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1580 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1581 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001582
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001583 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001584 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001585 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1586 "Attributes 'readnone and writeonly' are incompatible!", V);
1587
1588 Assert(
1589 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1590 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1591 "Attributes 'readonly and writeonly' are incompatible!", V);
1592
1593 Assert(
1594 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001595 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1596 Attribute::InaccessibleMemOrArgMemOnly)),
1597 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1598
1599 Assert(
1600 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1601 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1602 Attribute::InaccessibleMemOnly)),
1603 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1604
1605 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001606 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1607 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1608 Attribute::AlwaysInline)),
1609 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001610
1611 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1612 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001613 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1614 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001615
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001616 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1617 Attribute::OptimizeForSize),
1618 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001619
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001620 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1621 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001622 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001623
1624 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1625 Attribute::JumpTable)) {
1626 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001627 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001628 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001629 }
George Burgess IV278199f2016-04-12 01:05:35 +00001630
1631 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1632 std::pair<unsigned, Optional<unsigned>> Args =
1633 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1634
1635 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1636 if (ParamNo >= FT->getNumParams()) {
1637 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1638 return false;
1639 }
1640
1641 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1642 CheckFailed("'allocsize' " + Name +
1643 " argument must refer to an integer parameter",
1644 V);
1645 return false;
1646 }
1647
1648 return true;
1649 };
1650
1651 if (!CheckParam("element size", Args.first))
1652 return;
1653
1654 if (Args.second && !CheckParam("number of elements", *Args.second))
1655 return;
1656 }
Duncan Sands8c582282007-12-21 19:19:01 +00001657}
1658
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001659void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001660 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001661 for (const auto &Pair : MDs) {
1662 if (Pair.first == LLVMContext::MD_prof) {
1663 MDNode *MD = Pair.second;
Dehao Chena60cdd32017-02-28 18:09:44 +00001664 Assert(MD->getNumOperands() >= 2,
1665 "!prof annotations should have no less than 2 operands", MD);
Diego Novillo2567f3d2015-05-13 15:13:45 +00001666
1667 // Check first operand.
1668 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1669 MD);
1670 Assert(isa<MDString>(MD->getOperand(0)),
1671 "expected string with name of the !prof annotation", MD);
1672 MDString *MDS = cast<MDString>(MD->getOperand(0));
1673 StringRef ProfName = MDS->getString();
1674 Assert(ProfName.equals("function_entry_count"),
1675 "first operand should be 'function_entry_count'", MD);
1676
1677 // Check second operand.
1678 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1679 MD);
1680 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1681 "expected integer argument to function_entry_count", MD);
1682 }
1683 }
1684}
1685
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001686void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1687 if (!ConstantExprVisited.insert(EntryC).second)
1688 return;
1689
1690 SmallVector<const Constant *, 16> Stack;
1691 Stack.push_back(EntryC);
1692
1693 while (!Stack.empty()) {
1694 const Constant *C = Stack.pop_back_val();
1695
1696 // Check this constant expression.
1697 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1698 visitConstantExpr(CE);
1699
Keno Fischerf6d17b92016-01-14 22:42:02 +00001700 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1701 // Global Values get visited separately, but we do need to make sure
1702 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001703 Assert(GV->getParent() == &M, "Referencing global in another module!",
1704 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001705 continue;
1706 }
1707
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001708 // Visit all sub-expressions.
1709 for (const Use &U : C->operands()) {
1710 const auto *OpC = dyn_cast<Constant>(U);
1711 if (!OpC)
1712 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001713 if (!ConstantExprVisited.insert(OpC).second)
1714 continue;
1715 Stack.push_back(OpC);
1716 }
1717 }
1718}
1719
1720void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001721 if (CE->getOpcode() == Instruction::BitCast)
1722 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1723 CE->getType()),
1724 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001725
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001726 if (CE->getOpcode() == Instruction::IntToPtr ||
1727 CE->getOpcode() == Instruction::PtrToInt) {
1728 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1729 ? CE->getType()
1730 : CE->getOperand(0)->getType();
1731 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1732 ? "inttoptr not supported for non-integral pointers"
1733 : "ptrtoint not supported for non-integral pointers";
1734 Assert(
1735 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1736 Msg);
1737 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001738}
1739
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001740bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001741 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001742 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001743
Devang Patel82fed672008-09-23 22:35:17 +00001744 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001745 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001746 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001747 || (LastIndex == AttributeSet::FunctionIndex
1748 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001749 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001750
Devang Patel82fed672008-09-23 22:35:17 +00001751 return false;
1752}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001753
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001754/// Verify that statepoint intrinsic is well formed.
1755void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001756 assert(CS.getCalledFunction() &&
1757 CS.getCalledFunction()->getIntrinsicID() ==
1758 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001759
Philip Reames0285c742015-02-03 23:18:47 +00001760 const Instruction &CI = *CS.getInstruction();
1761
Igor Laevsky39d662f2015-07-11 10:30:36 +00001762 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1763 !CS.onlyAccessesArgMemory(),
1764 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001765 "reordering restrictions required by safepoint semantics",
1766 &CI);
1767
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001768 const Value *IDV = CS.getArgument(0);
1769 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1770 &CI);
1771
1772 const Value *NumPatchBytesV = CS.getArgument(1);
1773 Assert(isa<ConstantInt>(NumPatchBytesV),
1774 "gc.statepoint number of patchable bytes must be a constant integer",
1775 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001776 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001777 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1778 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1779 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1780 "positive",
1781 &CI);
1782
1783 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001784 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001785 Assert(PT && PT->getElementType()->isFunctionTy(),
1786 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001787 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001788
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001789 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001790 Assert(isa<ConstantInt>(NumCallArgsV),
1791 "gc.statepoint number of arguments to underlying call "
1792 "must be constant integer",
1793 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001794 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001795 Assert(NumCallArgs >= 0,
1796 "gc.statepoint number of arguments to underlying call "
1797 "must be positive",
1798 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001799 const int NumParams = (int)TargetFuncType->getNumParams();
1800 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001801 Assert(NumCallArgs >= NumParams,
1802 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001803
1804 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001805 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1806 "gc.statepoint doesn't support wrapping non-void "
1807 "vararg functions yet",
1808 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001809 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001810 Assert(NumCallArgs == NumParams,
1811 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001812
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001813 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001814 Assert(isa<ConstantInt>(FlagsV),
1815 "gc.statepoint flags must be constant integer", &CI);
1816 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1817 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1818 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001819
1820 // Verify that the types of the call parameter arguments match
1821 // the type of the wrapped callee.
1822 for (int i = 0; i < NumParams; i++) {
1823 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001824 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001825 Assert(ArgType == ParamType,
1826 "gc.statepoint call argument does not match wrapped "
1827 "function type",
1828 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001829 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001830
1831 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001832
1833 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1834 Assert(isa<ConstantInt>(NumTransitionArgsV),
1835 "gc.statepoint number of transition arguments "
1836 "must be constant integer",
1837 &CI);
1838 const int NumTransitionArgs =
1839 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1840 Assert(NumTransitionArgs >= 0,
1841 "gc.statepoint number of transition arguments must be positive", &CI);
1842 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1843
1844 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001845 Assert(isa<ConstantInt>(NumDeoptArgsV),
1846 "gc.statepoint number of deoptimization arguments "
1847 "must be constant integer",
1848 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001849 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001850 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1851 "must be positive",
1852 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001853
Pat Gavlincc0431d2015-05-08 18:07:42 +00001854 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001855 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001856 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001857 "gc.statepoint too few arguments according to length fields", &CI);
1858
Philip Reames1ffa9372015-01-30 23:28:05 +00001859 // Check that the only uses of this gc.statepoint are gc.result or
1860 // gc.relocate calls which are tied to this statepoint and thus part
1861 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001862 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001863 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001864 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001865 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001866 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001867 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001868 "of a gc.statepoint",
1869 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001870 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001871 Assert(Call->getArgOperand(0) == &CI,
1872 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001873 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001874 Assert(Call->getArgOperand(0) == &CI,
1875 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001876 }
1877 }
1878
1879 // Note: It is legal for a single derived pointer to be listed multiple
1880 // times. It's non-optimal, but it is legal. It can also happen after
1881 // insertion if we strip a bitcast away.
1882 // Note: It is really tempting to check that each base is relocated and
1883 // that a derived pointer is never reused as a base pointer. This turns
1884 // out to be problematic since optimizations run after safepoint insertion
1885 // can recognize equality properties that the insertion logic doesn't know
1886 // about. See example statepoint.ll in the verifier subdirectory
1887}
1888
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001889void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001890 for (auto &Counts : FrameEscapeInfo) {
1891 Function *F = Counts.first;
1892 unsigned EscapedObjectCount = Counts.second.first;
1893 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001894 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001895 "all indices passed to llvm.localrecover must be less than the "
1896 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001897 "function",
1898 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001899 }
1900}
1901
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001902static Instruction *getSuccPad(TerminatorInst *Terminator) {
1903 BasicBlock *UnwindDest;
1904 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1905 UnwindDest = II->getUnwindDest();
1906 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1907 UnwindDest = CSI->getUnwindDest();
1908 else
1909 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1910 return UnwindDest->getFirstNonPHI();
1911}
1912
1913void Verifier::verifySiblingFuncletUnwinds() {
1914 SmallPtrSet<Instruction *, 8> Visited;
1915 SmallPtrSet<Instruction *, 8> Active;
1916 for (const auto &Pair : SiblingFuncletInfo) {
1917 Instruction *PredPad = Pair.first;
1918 if (Visited.count(PredPad))
1919 continue;
1920 Active.insert(PredPad);
1921 TerminatorInst *Terminator = Pair.second;
1922 do {
1923 Instruction *SuccPad = getSuccPad(Terminator);
1924 if (Active.count(SuccPad)) {
1925 // Found a cycle; report error
1926 Instruction *CyclePad = SuccPad;
1927 SmallVector<Instruction *, 8> CycleNodes;
1928 do {
1929 CycleNodes.push_back(CyclePad);
1930 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1931 if (CycleTerminator != CyclePad)
1932 CycleNodes.push_back(CycleTerminator);
1933 CyclePad = getSuccPad(CycleTerminator);
1934 } while (CyclePad != SuccPad);
1935 Assert(false, "EH pads can't handle each other's exceptions",
1936 ArrayRef<Instruction *>(CycleNodes));
1937 }
1938 // Don't re-walk a node we've already checked
1939 if (!Visited.insert(SuccPad).second)
1940 break;
1941 // Walk to this successor if it has a map entry.
1942 PredPad = SuccPad;
1943 auto TermI = SiblingFuncletInfo.find(PredPad);
1944 if (TermI == SiblingFuncletInfo.end())
1945 break;
1946 Terminator = TermI->second;
1947 Active.insert(PredPad);
1948 } while (true);
1949 // Each node only has one successor, so we've walked all the active
1950 // nodes' successors.
1951 Active.clear();
1952 }
1953}
1954
Chris Lattner0e851da2002-04-18 20:37:37 +00001955// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001956//
Chandler Carruth043949d2014-01-19 02:22:18 +00001957void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001958 visitGlobalValue(F);
1959
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001960 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001961 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001962 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001963
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001964 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001965 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001966
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001967 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1968 Assert(FT->getNumParams() == NumArgs,
1969 "# formal arguments must match # of arguments for function type!", &F,
1970 FT);
1971 Assert(F.getReturnType()->isFirstClassType() ||
1972 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1973 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001974
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001975 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1976 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001977
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001978 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001979
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001980 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001981 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001982
Duncan Sands8c582282007-12-21 19:19:01 +00001983 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001984 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001985
Michael Gottesman41748d72013-06-27 00:25:01 +00001986 // On function declarations/definitions, we do not support the builtin
1987 // attribute. We do not check this in VerifyFunctionAttrs since that is
1988 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001989 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1990 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001991
Chris Lattneref13ee32006-05-19 21:25:17 +00001992 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001993 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1994 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001995 switch (F.getCallingConv()) {
1996 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001997 case CallingConv::C:
1998 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001999 case CallingConv::Fast:
2000 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00002001 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00002002 case CallingConv::PTX_Kernel:
2003 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002004 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
2005 "perfect forwarding!",
2006 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00002007 break;
2008 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00002009
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002010 bool isLLVMdotName = F.getName().size() >= 5 &&
2011 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002012
Chris Lattneraf95e582002-04-13 22:48:46 +00002013 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00002014 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002015 for (const Argument &Arg : F.args()) {
2016 Assert(Arg.getType() == FT->getParamType(i),
2017 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002018 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002019 Assert(Arg.getType()->isFirstClassType(),
2020 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00002021 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002022 Assert(!Arg.getType()->isMetadataTy(),
2023 "Function takes metadata but isn't an intrinsic", &Arg, &F);
2024 Assert(!Arg.getType()->isTokenTy(),
2025 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00002026 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00002027
2028 // Check that swifterror argument is only used by loads and stores.
2029 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
2030 verifySwiftErrorValue(&Arg);
2031 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002032 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00002033 }
Chris Lattneraf95e582002-04-13 22:48:46 +00002034
David Majnemerb611e3f2015-08-14 05:09:07 +00002035 if (!isLLVMdotName)
2036 Assert(!F.getReturnType()->isTokenTy(),
2037 "Functions returns a token but isn't an intrinsic", &F);
2038
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002039 // Get the function metadata attachments.
2040 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2041 F.getAllMetadata(MDs);
2042 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002043 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002044
Keno Fischer2ac0c272015-11-16 05:13:30 +00002045 // Check validity of the personality function
2046 if (F.hasPersonalityFn()) {
2047 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2048 if (Per)
2049 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002050 "Referencing personality function in another module!",
2051 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002052 }
2053
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002054 if (F.isMaterializable()) {
2055 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002056 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2057 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002058 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002059 for (const auto &I : MDs) {
2060 AssertDI(I.first != LLVMContext::MD_dbg,
2061 "function declaration may not have a !dbg attachment", &F);
2062 Assert(I.first != LLVMContext::MD_prof,
2063 "function declaration may not have a !prof attachment", &F);
2064
2065 // Verify the metadata itself.
2066 visitMDNode(*I.second);
2067 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002068 Assert(!F.hasPersonalityFn(),
2069 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002070 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002071 // Verify that this function (which has a body) is not named "llvm.*". It
2072 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002073 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002074
Chris Lattner149376d2002-10-13 20:57:00 +00002075 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002076 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002077 Assert(pred_empty(Entry),
2078 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002079
Chris Lattner27471742009-11-01 04:08:01 +00002080 // The address of the entry block cannot be taken, unless it is dead.
2081 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002082 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2083 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002084 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002085
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002086 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002087 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002088 for (const auto &I : MDs) {
2089 // Verify that the attachment is legal.
2090 switch (I.first) {
2091 default:
2092 break;
2093 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002094 ++NumDebugAttachments;
2095 AssertDI(NumDebugAttachments == 1,
2096 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002097 AssertDI(isa<DISubprogram>(I.second),
2098 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002099 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002100 case LLVMContext::MD_prof:
2101 ++NumProfAttachments;
2102 Assert(NumProfAttachments == 1,
2103 "function must have a single !prof attachment", &F, I.second);
2104 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002105 }
2106
2107 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002108 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002109 }
Chris Lattner149376d2002-10-13 20:57:00 +00002110 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002111
Chris Lattner7730dcc2009-09-11 17:05:29 +00002112 // If this function is actually an intrinsic, verify that it is only used in
2113 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002114 // Only do this if the module is materialized, otherwise we don't have all the
2115 // uses.
2116 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002117 const User *U;
2118 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002119 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002120 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002121
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002122 Assert(!F.hasDLLImportStorageClass() ||
2123 (F.isDeclaration() && F.hasExternalLinkage()) ||
2124 F.hasAvailableExternallyLinkage(),
2125 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002126
2127 auto *N = F.getSubprogram();
Adrian Prantl63d96952017-03-07 17:28:54 +00002128 HasDebugInfo = (N != nullptr);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002129 if (!N)
2130 return;
2131
2132 // Check that all !dbg attachments lead to back to N (or, at least, another
2133 // subprogram that describes the same function).
2134 //
2135 // FIXME: Check this incrementally while visiting !dbg attachments.
2136 // FIXME: Only check when N is the canonical subprogram for F.
2137 SmallPtrSet<const MDNode *, 32> Seen;
2138 for (auto &BB : F)
2139 for (auto &I : BB) {
2140 // Be careful about using DILocation here since we might be dealing with
2141 // broken code (this is the Verifier after all).
2142 DILocation *DL =
2143 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2144 if (!DL)
2145 continue;
2146 if (!Seen.insert(DL).second)
2147 continue;
2148
2149 DILocalScope *Scope = DL->getInlinedAtScope();
2150 if (Scope && !Seen.insert(Scope).second)
2151 continue;
2152
2153 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002154
2155 // Scope and SP could be the same MDNode and we don't want to skip
2156 // validation in that case
2157 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002158 continue;
2159
2160 // FIXME: Once N is canonical, check "SP == &N".
Adrian Prantla2ef0472016-09-14 17:30:37 +00002161 AssertDI(SP->describes(&F),
2162 "!dbg attachment points at wrong subprogram for function", N, &F,
2163 &I, DL, Scope, SP);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002164 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002165}
2166
Chris Lattner0e851da2002-04-18 20:37:37 +00002167// verifyBasicBlock - Verify that a basic block is well formed...
2168//
Chris Lattner069a7952002-06-25 15:56:27 +00002169void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002170 InstsInThisBlock.clear();
2171
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002172 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002173 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002174
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002175 // Check constraints that this basic block imposes on all of the PHI nodes in
2176 // it.
2177 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002178 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2179 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002180 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002181 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002182 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002183 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002184 Assert(PN->getNumIncomingValues() != 0,
2185 "PHI nodes must have at least one entry. If the block is dead, "
2186 "the PHI should be removed!",
2187 PN);
2188 Assert(PN->getNumIncomingValues() == Preds.size(),
2189 "PHINode should have one entry for each predecessor of its "
2190 "parent basic block!",
2191 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002192
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002193 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002194 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002195 Values.reserve(PN->getNumIncomingValues());
2196 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2197 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2198 PN->getIncomingValue(i)));
2199 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002200
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002201 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2202 // Check to make sure that if there is more than one entry for a
2203 // particular basic block in this PHI node, that the incoming values are
2204 // all identical.
2205 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002206 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2207 Values[i].second == Values[i - 1].second,
2208 "PHI node has multiple entries for the same basic block with "
2209 "different incoming values!",
2210 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002211
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002212 // Check to make sure that the predecessors and PHI node entries are
2213 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002214 Assert(Values[i].first == Preds[i],
2215 "PHI node entries do not match predecessors!", PN,
2216 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002217 }
2218 }
2219 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002220
2221 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002222 for (auto &I : BB)
2223 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002224 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002225 }
Chris Lattner069a7952002-06-25 15:56:27 +00002226}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002227
Chris Lattner069a7952002-06-25 15:56:27 +00002228void Verifier::visitTerminatorInst(TerminatorInst &I) {
2229 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002230 Assert(&I == I.getParent()->getTerminator(),
2231 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002232 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002233}
2234
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002235void Verifier::visitBranchInst(BranchInst &BI) {
2236 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002237 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2238 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002239 }
2240 visitTerminatorInst(BI);
2241}
2242
Chris Lattner069a7952002-06-25 15:56:27 +00002243void Verifier::visitReturnInst(ReturnInst &RI) {
2244 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002245 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002246 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002247 Assert(N == 0,
2248 "Found return instr that returns non-void in Function of void "
2249 "return type!",
2250 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002251 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002252 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2253 "Function return type does not match operand "
2254 "type of return inst!",
2255 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002256
Misha Brukman7eb05a12003-08-18 14:43:39 +00002257 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002258 // terminators...
2259 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002260}
2261
Chris Lattnerab5aa142004-05-21 16:47:21 +00002262void Verifier::visitSwitchInst(SwitchInst &SI) {
2263 // Check to make sure that all of the constants in the switch instruction
2264 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002265 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002266 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002267 for (auto &Case : SI.cases()) {
2268 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002269 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002270 Assert(Constants.insert(Case.getCaseValue()).second,
2271 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002272 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002273
Chris Lattnerab5aa142004-05-21 16:47:21 +00002274 visitTerminatorInst(SI);
2275}
2276
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002277void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002278 Assert(BI.getAddress()->getType()->isPointerTy(),
2279 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002280 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002281 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2282 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002283
2284 visitTerminatorInst(BI);
2285}
2286
Chris Lattner75648e72004-03-12 05:54:31 +00002287void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002288 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2289 SI.getOperand(2)),
2290 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002291
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002292 Assert(SI.getTrueValue()->getType() == SI.getType(),
2293 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002294 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002295}
2296
Misha Brukmanc566ca362004-03-02 00:22:19 +00002297/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2298/// a pass, if any exist, it's an error.
2299///
Chris Lattner903a25d2002-11-21 16:54:22 +00002300void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002301 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002302}
Chris Lattner0e851da2002-04-18 20:37:37 +00002303
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002304void Verifier::visitTruncInst(TruncInst &I) {
2305 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002306 Type *SrcTy = I.getOperand(0)->getType();
2307 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002308
2309 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002310 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2311 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002312
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002313 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2314 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2315 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2316 "trunc source and destination must both be a vector or neither", &I);
2317 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002318
2319 visitInstruction(I);
2320}
2321
2322void Verifier::visitZExtInst(ZExtInst &I) {
2323 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002324 Type *SrcTy = I.getOperand(0)->getType();
2325 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002326
2327 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002328 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2329 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2330 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2331 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002332 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2333 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002334
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002335 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002336
2337 visitInstruction(I);
2338}
2339
2340void Verifier::visitSExtInst(SExtInst &I) {
2341 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002342 Type *SrcTy = I.getOperand(0)->getType();
2343 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002344
2345 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002346 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2347 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002348
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002349 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2350 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2351 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2352 "sext source and destination must both be a vector or neither", &I);
2353 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002354
2355 visitInstruction(I);
2356}
2357
2358void Verifier::visitFPTruncInst(FPTruncInst &I) {
2359 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002360 Type *SrcTy = I.getOperand(0)->getType();
2361 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002362 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002363 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2364 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002365
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002366 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2367 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2368 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2369 "fptrunc source and destination must both be a vector or neither", &I);
2370 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002371
2372 visitInstruction(I);
2373}
2374
2375void Verifier::visitFPExtInst(FPExtInst &I) {
2376 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002377 Type *SrcTy = I.getOperand(0)->getType();
2378 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002379
2380 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002381 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2382 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002383
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002384 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2385 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2386 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2387 "fpext source and destination must both be a vector or neither", &I);
2388 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002389
2390 visitInstruction(I);
2391}
2392
2393void Verifier::visitUIToFPInst(UIToFPInst &I) {
2394 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002395 Type *SrcTy = I.getOperand(0)->getType();
2396 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002397
Duncan Sands19d0b472010-02-16 11:11:14 +00002398 bool SrcVec = SrcTy->isVectorTy();
2399 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002400
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002401 Assert(SrcVec == DstVec,
2402 "UIToFP source and dest must both be vector or scalar", &I);
2403 Assert(SrcTy->isIntOrIntVectorTy(),
2404 "UIToFP source must be integer or integer vector", &I);
2405 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2406 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002407
2408 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002409 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2410 cast<VectorType>(DestTy)->getNumElements(),
2411 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002412
2413 visitInstruction(I);
2414}
2415
2416void Verifier::visitSIToFPInst(SIToFPInst &I) {
2417 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002418 Type *SrcTy = I.getOperand(0)->getType();
2419 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002420
Duncan Sands19d0b472010-02-16 11:11:14 +00002421 bool SrcVec = SrcTy->isVectorTy();
2422 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002423
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002424 Assert(SrcVec == DstVec,
2425 "SIToFP source and dest must both be vector or scalar", &I);
2426 Assert(SrcTy->isIntOrIntVectorTy(),
2427 "SIToFP source must be integer or integer vector", &I);
2428 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2429 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002430
2431 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002432 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2433 cast<VectorType>(DestTy)->getNumElements(),
2434 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002435
2436 visitInstruction(I);
2437}
2438
2439void Verifier::visitFPToUIInst(FPToUIInst &I) {
2440 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002441 Type *SrcTy = I.getOperand(0)->getType();
2442 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002443
Duncan Sands19d0b472010-02-16 11:11:14 +00002444 bool SrcVec = SrcTy->isVectorTy();
2445 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002446
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002447 Assert(SrcVec == DstVec,
2448 "FPToUI source and dest must both be vector or scalar", &I);
2449 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2450 &I);
2451 Assert(DestTy->isIntOrIntVectorTy(),
2452 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002453
2454 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002455 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2456 cast<VectorType>(DestTy)->getNumElements(),
2457 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002458
2459 visitInstruction(I);
2460}
2461
2462void Verifier::visitFPToSIInst(FPToSIInst &I) {
2463 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002464 Type *SrcTy = I.getOperand(0)->getType();
2465 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002466
Duncan Sands19d0b472010-02-16 11:11:14 +00002467 bool SrcVec = SrcTy->isVectorTy();
2468 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002469
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002470 Assert(SrcVec == DstVec,
2471 "FPToSI source and dest must both be vector or scalar", &I);
2472 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2473 &I);
2474 Assert(DestTy->isIntOrIntVectorTy(),
2475 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002476
2477 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002478 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2479 cast<VectorType>(DestTy)->getNumElements(),
2480 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002481
2482 visitInstruction(I);
2483}
2484
2485void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2486 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002487 Type *SrcTy = I.getOperand(0)->getType();
2488 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002489
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002490 Assert(SrcTy->getScalarType()->isPointerTy(),
2491 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002492
2493 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002494 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002495 "ptrtoint not supported for non-integral pointers");
2496
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002497 Assert(DestTy->getScalarType()->isIntegerTy(),
2498 "PtrToInt result must be integral", &I);
2499 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2500 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002501
2502 if (SrcTy->isVectorTy()) {
2503 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2504 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002505 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2506 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002507 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002508
2509 visitInstruction(I);
2510}
2511
2512void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2513 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002514 Type *SrcTy = I.getOperand(0)->getType();
2515 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002516
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002517 Assert(SrcTy->getScalarType()->isIntegerTy(),
2518 "IntToPtr source must be an integral", &I);
2519 Assert(DestTy->getScalarType()->isPointerTy(),
2520 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002521
2522 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002523 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002524 "inttoptr not supported for non-integral pointers");
2525
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002526 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2527 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002528 if (SrcTy->isVectorTy()) {
2529 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2530 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002531 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2532 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002533 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002534 visitInstruction(I);
2535}
2536
2537void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002538 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002539 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2540 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002541 visitInstruction(I);
2542}
2543
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002544void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2545 Type *SrcTy = I.getOperand(0)->getType();
2546 Type *DestTy = I.getType();
2547
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002548 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2549 &I);
2550 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2551 &I);
2552 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2553 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002554 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002555 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2556 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002557 visitInstruction(I);
2558}
2559
Misha Brukmanc566ca362004-03-02 00:22:19 +00002560/// visitPHINode - Ensure that a PHI node is well formed.
2561///
Chris Lattner069a7952002-06-25 15:56:27 +00002562void Verifier::visitPHINode(PHINode &PN) {
2563 // Ensure that the PHI nodes are all grouped together at the top of the block.
2564 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002565 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002566 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002567 Assert(&PN == &PN.getParent()->front() ||
2568 isa<PHINode>(--BasicBlock::iterator(&PN)),
2569 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002570
David Majnemerb611e3f2015-08-14 05:09:07 +00002571 // Check that a PHI doesn't yield a Token.
2572 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2573
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002574 // Check that all of the values of the PHI node have the same type as the
2575 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002576 for (Value *IncValue : PN.incoming_values()) {
2577 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002578 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002579 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002580
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002581 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002582
2583 visitInstruction(PN);
2584}
2585
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002586void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002587 Instruction *I = CS.getInstruction();
2588
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002589 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2590 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002591 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002592
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002593 Assert(FPTy->getElementType()->isFunctionTy(),
2594 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002595
2596 Assert(FPTy->getElementType() == CS.getFunctionType(),
2597 "Called function is not the same type as the call!", I);
2598
2599 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002600
2601 // Verify that the correct number of arguments are being passed
2602 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002603 Assert(CS.arg_size() >= FTy->getNumParams(),
2604 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002605 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002606 Assert(CS.arg_size() == FTy->getNumParams(),
2607 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002608
Chris Lattner609de002010-05-10 20:58:42 +00002609 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002610 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002611 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2612 "Call parameter type does not match function signature!",
2613 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002614
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002615 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002616
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002617 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002618 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002619
Duncan Sands8c582282007-12-21 19:19:01 +00002620 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002621 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002622
David Majnemer91db08b2014-04-30 17:22:00 +00002623 // Conservatively check the inalloca argument.
2624 // We have a bug if we can find that there is an underlying alloca without
2625 // inalloca.
2626 if (CS.hasInAllocaArgument()) {
2627 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2628 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002629 Assert(AI->isUsedWithInAlloca(),
2630 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002631 }
2632
Manman Ren9bfd0d02016-04-01 21:41:15 +00002633 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002634 // make sure the underlying alloca/parameter it comes from has a swifterror as
2635 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002636 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2637 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2638 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002639 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002640 Assert(AI->isSwiftError(),
2641 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002642 continue;
2643 }
2644 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2645 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2646 Assert(ArgI->hasSwiftErrorAttr(),
2647 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002648 }
2649
Stephen Linb8bd2322013-04-20 05:14:40 +00002650 if (FTy->isVarArg()) {
2651 // FIXME? is 'nest' even legal here?
2652 bool SawNest = false;
2653 bool SawReturned = false;
2654
2655 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2656 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2657 SawNest = true;
2658 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2659 SawReturned = true;
2660 }
2661
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002662 // Check attributes on the varargs part.
2663 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002664 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002665 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002666
Stephen Linb8bd2322013-04-20 05:14:40 +00002667 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002668 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002669 SawNest = true;
2670 }
2671
2672 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002673 Assert(!SawReturned, "More than one parameter has attribute returned!",
2674 I);
2675 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2676 "Incompatible argument and return types for 'returned' "
2677 "attribute",
2678 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002679 SawReturned = true;
2680 }
Duncan Sands0009c442008-01-12 16:42:01 +00002681
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002682 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2683 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002684
2685 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002686 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002687 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002688 }
Duncan Sands8c582282007-12-21 19:19:01 +00002689
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002690 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002691 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002692 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002693 for (Type *ParamTy : FTy->params()) {
2694 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002695 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002696 Assert(!ParamTy->isTokenTy(),
2697 "Function has token parameter but isn't an intrinsic", I);
2698 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002699 }
2700
David Majnemerb611e3f2015-08-14 05:09:07 +00002701 // Verify that indirect calls don't return tokens.
2702 if (CS.getCalledFunction() == nullptr)
2703 Assert(!FTy->getReturnType()->isTokenTy(),
2704 "Return type cannot be token for indirect call!");
2705
Philip Reamesa3c6f002015-06-26 21:39:44 +00002706 if (Function *F = CS.getCalledFunction())
2707 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002708 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002709
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002710 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2711 // at most one "gc-transition" operand bundle.
2712 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2713 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002714 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002715 OperandBundleUse BU = CS.getOperandBundleAt(i);
2716 uint32_t Tag = BU.getTagID();
2717 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002718 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2719 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002720 } else if (Tag == LLVMContext::OB_gc_transition) {
2721 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2722 I);
2723 FoundGCTransitionBundle = true;
2724 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002725 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2726 FoundFuncletBundle = true;
2727 Assert(BU.Inputs.size() == 1,
2728 "Expected exactly one funclet bundle operand", I);
2729 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2730 "Funclet bundle operands should correspond to a FuncletPadInst",
2731 I);
2732 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002733 }
2734
Adrian Prantl93035c82016-04-24 22:23:13 +00002735 // Verify that each inlinable callsite of a debug-info-bearing function in a
2736 // debug-info-bearing function has a debug location attached to it. Failure to
2737 // do so causes assertion failures when the inliner sets up inline scope info.
2738 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2739 CS.getCalledFunction()->getSubprogram())
Adrian Prantlfb80e792017-03-06 21:05:14 +00002740 AssertDI(I->getDebugLoc(), "inlinable function call in a function with "
2741 "debug info must have a !dbg location",
2742 I);
Adrian Prantl93035c82016-04-24 22:23:13 +00002743
Duncan Sands8c582282007-12-21 19:19:01 +00002744 visitInstruction(*I);
2745}
2746
Reid Kleckner5772b772014-04-24 20:14:34 +00002747/// Two types are "congruent" if they are identical, or if they are both pointer
2748/// types with different pointee types and the same address space.
2749static bool isTypeCongruent(Type *L, Type *R) {
2750 if (L == R)
2751 return true;
2752 PointerType *PL = dyn_cast<PointerType>(L);
2753 PointerType *PR = dyn_cast<PointerType>(R);
2754 if (!PL || !PR)
2755 return false;
2756 return PL->getAddressSpace() == PR->getAddressSpace();
2757}
2758
Reid Klecknerd20c9702014-05-15 23:58:57 +00002759static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2760 static const Attribute::AttrKind ABIAttrs[] = {
2761 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002762 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2763 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002764 AttrBuilder Copy;
2765 for (auto AK : ABIAttrs) {
2766 if (Attrs.hasAttribute(I + 1, AK))
2767 Copy.addAttribute(AK);
2768 }
2769 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2770 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2771 return Copy;
2772}
2773
Reid Kleckner5772b772014-04-24 20:14:34 +00002774void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002775 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002776
2777 // - The caller and callee prototypes must match. Pointer types of
2778 // parameters or return types may differ in pointee type, but not
2779 // address space.
2780 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002781 FunctionType *CallerTy = F->getFunctionType();
2782 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002783 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2784 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2785 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2786 "cannot guarantee tail call due to mismatched varargs", &CI);
2787 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2788 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002789 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002790 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002791 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2792 "cannot guarantee tail call due to mismatched parameter types", &CI);
2793 }
2794
2795 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002796 Assert(F->getCallingConv() == CI.getCallingConv(),
2797 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002798
2799 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2800 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002801 AttributeSet CallerAttrs = F->getAttributes();
2802 AttributeSet CalleeAttrs = CI.getAttributes();
2803 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002804 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2805 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002806 Assert(CallerABIAttrs == CalleeABIAttrs,
2807 "cannot guarantee tail call due to mismatched ABI impacting "
2808 "function attributes",
2809 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002810 }
2811
2812 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2813 // or a pointer bitcast followed by a ret instruction.
2814 // - The ret instruction must return the (possibly bitcasted) value
2815 // produced by the call or void.
2816 Value *RetVal = &CI;
2817 Instruction *Next = CI.getNextNode();
2818
2819 // Handle the optional bitcast.
2820 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002821 Assert(BI->getOperand(0) == RetVal,
2822 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002823 RetVal = BI;
2824 Next = BI->getNextNode();
2825 }
2826
2827 // Check the return.
2828 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002829 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2830 &CI);
2831 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2832 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002833}
2834
Duncan Sands8c582282007-12-21 19:19:01 +00002835void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002836 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002837
Reid Kleckner5772b772014-04-24 20:14:34 +00002838 if (CI.isMustTailCall())
2839 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002840}
2841
2842void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002843 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002844
David Majnemer654e1302015-07-31 17:58:14 +00002845 // Verify that the first non-PHI instruction of the unwind destination is an
2846 // exception handling instruction.
2847 Assert(
2848 II.getUnwindDest()->isEHPad(),
2849 "The unwind destination does not have an exception handling instruction!",
2850 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002851
Dan Gohman9c6e1882010-08-02 23:09:14 +00002852 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002853}
Chris Lattner0e851da2002-04-18 20:37:37 +00002854
Misha Brukmanc566ca362004-03-02 00:22:19 +00002855/// visitBinaryOperator - Check that both arguments to the binary operator are
2856/// of the same type!
2857///
Chris Lattner069a7952002-06-25 15:56:27 +00002858void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002859 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2860 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002861
Reid Spencer2341c222007-02-02 02:16:23 +00002862 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002863 // Check that integer arithmetic operators are only used with
2864 // integral operands.
2865 case Instruction::Add:
2866 case Instruction::Sub:
2867 case Instruction::Mul:
2868 case Instruction::SDiv:
2869 case Instruction::UDiv:
2870 case Instruction::SRem:
2871 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002872 Assert(B.getType()->isIntOrIntVectorTy(),
2873 "Integer arithmetic operators only work with integral types!", &B);
2874 Assert(B.getType() == B.getOperand(0)->getType(),
2875 "Integer arithmetic operators must have same type "
2876 "for operands and result!",
2877 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002878 break;
2879 // Check that floating-point arithmetic operators are only used with
2880 // floating-point operands.
2881 case Instruction::FAdd:
2882 case Instruction::FSub:
2883 case Instruction::FMul:
2884 case Instruction::FDiv:
2885 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002886 Assert(B.getType()->isFPOrFPVectorTy(),
2887 "Floating-point arithmetic operators only work with "
2888 "floating-point types!",
2889 &B);
2890 Assert(B.getType() == B.getOperand(0)->getType(),
2891 "Floating-point arithmetic operators must have same type "
2892 "for operands and result!",
2893 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002894 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002895 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002896 case Instruction::And:
2897 case Instruction::Or:
2898 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002899 Assert(B.getType()->isIntOrIntVectorTy(),
2900 "Logical operators only work with integral types!", &B);
2901 Assert(B.getType() == B.getOperand(0)->getType(),
2902 "Logical operators must have same type for operands and result!",
2903 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002904 break;
2905 case Instruction::Shl:
2906 case Instruction::LShr:
2907 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002908 Assert(B.getType()->isIntOrIntVectorTy(),
2909 "Shifts only work with integral types!", &B);
2910 Assert(B.getType() == B.getOperand(0)->getType(),
2911 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002912 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002913 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002914 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002915 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002916
Chris Lattner0e851da2002-04-18 20:37:37 +00002917 visitInstruction(B);
2918}
2919
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002920void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002921 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002922 Type *Op0Ty = IC.getOperand(0)->getType();
2923 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002924 Assert(Op0Ty == Op1Ty,
2925 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002926 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002927 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2928 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002929 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002930 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2931 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2932 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002933
Reid Spencerd9436b62006-11-20 01:22:35 +00002934 visitInstruction(IC);
2935}
2936
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002937void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002938 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002939 Type *Op0Ty = FC.getOperand(0)->getType();
2940 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002941 Assert(Op0Ty == Op1Ty,
2942 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002943 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002944 Assert(Op0Ty->isFPOrFPVectorTy(),
2945 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002946 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002947 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2948 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2949 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002950
Reid Spencerd9436b62006-11-20 01:22:35 +00002951 visitInstruction(FC);
2952}
2953
Robert Bocchino23004482006-01-10 19:05:34 +00002954void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002955 Assert(
2956 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2957 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002958 visitInstruction(EI);
2959}
2960
Robert Bocchinoca27f032006-01-17 20:07:22 +00002961void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002962 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2963 IE.getOperand(2)),
2964 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002965 visitInstruction(IE);
2966}
2967
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002968void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002969 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2970 SV.getOperand(2)),
2971 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002972 visitInstruction(SV);
2973}
2974
Chris Lattner069a7952002-06-25 15:56:27 +00002975void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002976 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002977
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002978 Assert(isa<PointerType>(TargetTy),
2979 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002980 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002981 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002982 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002983 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002984 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002985
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002986 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002987 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002988 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002989
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002990 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002991 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002992 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2993 if (GEP.getPointerOperandType()->isVectorTy())
2994 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2995 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002996 for (Value *Idx : Idxs) {
2997 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002998 if (IndexTy->isVectorTy()) {
2999 unsigned IndexWidth = IndexTy->getVectorNumElements();
3000 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
3001 }
3002 Assert(IndexTy->getScalarType()->isIntegerTy(),
3003 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00003004 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00003005 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003006 visitInstruction(GEP);
3007}
3008
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00003009static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
3010 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
3011}
3012
Sanjoy Das26f28a22016-11-09 19:36:39 +00003013void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
3014 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
Philip Reamesbf9676f2014-10-20 23:52:07 +00003015 "precondition violation");
3016
3017 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003018 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003019 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003020 Assert(NumRanges >= 1, "It should have at least one range!", Range);
3021
Philip Reamesbf9676f2014-10-20 23:52:07 +00003022 ConstantRange LastRange(1); // Dummy initial value
3023 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003024 ConstantInt *Low =
3025 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003026 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003027 ConstantInt *High =
3028 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003029 Assert(High, "The upper limit must be an integer!", High);
3030 Assert(High->getType() == Low->getType() && High->getType() == Ty,
3031 "Range types must match instruction type!", &I);
3032
Philip Reamesbf9676f2014-10-20 23:52:07 +00003033 APInt HighV = High->getValue();
3034 APInt LowV = Low->getValue();
3035 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003036 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
3037 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003038 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003039 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
3040 "Intervals are overlapping", Range);
3041 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3042 Range);
3043 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3044 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003045 }
3046 LastRange = ConstantRange(LowV, HighV);
3047 }
3048 if (NumRanges > 2) {
3049 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003050 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003051 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003052 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003053 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003054 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3055 "Intervals are overlapping", Range);
3056 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3057 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003058 }
3059}
3060
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003061void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3062 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003063 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3064 Assert(!(Size & (Size - 1)),
3065 "atomic memory access' operand must have a power-of-two size", Ty, I);
3066}
3067
Chris Lattner069a7952002-06-25 15:56:27 +00003068void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003069 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003070 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003071 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003072 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3073 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003074 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003075 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003076 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3077 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003078 "Load cannot have Release ordering", &LI);
3079 Assert(LI.getAlignment() != 0,
3080 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003081 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3082 ElTy->isFloatingPointTy(),
3083 "atomic load operand must have integer, pointer, or floating point "
3084 "type!",
3085 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003086 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003087 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003088 Assert(LI.getSynchScope() == CrossThread,
3089 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003090 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003091
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003092 visitInstruction(LI);
3093}
3094
Chris Lattner069a7952002-06-25 15:56:27 +00003095void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003096 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003097 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003098 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003099 Assert(ElTy == SI.getOperand(0)->getType(),
3100 "Stored value type does not match pointer operand type!", &SI, ElTy);
3101 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3102 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003103 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003104 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003105 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3106 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003107 "Store cannot have Acquire ordering", &SI);
3108 Assert(SI.getAlignment() != 0,
3109 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003110 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3111 ElTy->isFloatingPointTy(),
3112 "atomic store operand must have integer, pointer, or floating point "
3113 "type!",
3114 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003115 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003116 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003117 Assert(SI.getSynchScope() == CrossThread,
3118 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003119 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003120 visitInstruction(SI);
3121}
3122
Manman Ren9bfd0d02016-04-01 21:41:15 +00003123/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3124void Verifier::verifySwiftErrorCallSite(CallSite CS,
3125 const Value *SwiftErrorVal) {
3126 unsigned Idx = 0;
3127 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3128 I != E; ++I, ++Idx) {
3129 if (*I == SwiftErrorVal) {
3130 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3131 "swifterror value when used in a callsite should be marked "
3132 "with swifterror attribute",
3133 SwiftErrorVal, CS);
3134 }
3135 }
3136}
3137
3138void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3139 // Check that swifterror value is only used by loads, stores, or as
3140 // a swifterror argument.
3141 for (const User *U : SwiftErrorVal->users()) {
3142 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3143 isa<InvokeInst>(U),
3144 "swifterror value can only be loaded and stored from, or "
3145 "as a swifterror argument!",
3146 SwiftErrorVal, U);
3147 // If it is used by a store, check it is the second operand.
3148 if (auto StoreI = dyn_cast<StoreInst>(U))
3149 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3150 "swifterror value should be the second operand when used "
3151 "by stores", SwiftErrorVal, U);
3152 if (auto CallI = dyn_cast<CallInst>(U))
3153 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3154 if (auto II = dyn_cast<InvokeInst>(U))
3155 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3156 }
3157}
3158
Victor Hernandez8acf2952009-10-23 21:09:37 +00003159void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003160 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003161 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003162 Assert(PTy->getAddressSpace() == 0,
3163 "Allocation instruction pointer not in the generic address space!",
3164 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003165 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003166 "Cannot allocate unsized type", &AI);
3167 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3168 "Alloca array size must have integer type", &AI);
3169 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3170 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003171
Manman Ren9bfd0d02016-04-01 21:41:15 +00003172 if (AI.isSwiftError()) {
3173 verifySwiftErrorValue(&AI);
3174 }
3175
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003176 visitInstruction(AI);
3177}
3178
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003179void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003180
3181 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003182 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003183 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003184 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003185 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003186 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003187 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003188 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003189 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003190 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3191 "cmpxchg instructions failure argument shall be no stronger than the "
3192 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003193 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003194 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3195 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003196 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003197
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003198 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003199 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003200 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003201 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3202 "cmpxchg operand must have integer or pointer type",
3203 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003204 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003205 Assert(ElTy == CXI.getOperand(1)->getType(),
3206 "Expected value type does not match pointer operand type!", &CXI,
3207 ElTy);
3208 Assert(ElTy == CXI.getOperand(2)->getType(),
3209 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003210 visitInstruction(CXI);
3211}
3212
3213void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003214 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003215 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003216 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003217 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003218 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003219 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003220 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003221 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3222 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003223 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003224 Assert(ElTy == RMWI.getOperand(1)->getType(),
3225 "Argument value type does not match pointer operand type!", &RMWI,
3226 ElTy);
3227 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3228 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3229 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003230 visitInstruction(RMWI);
3231}
3232
Eli Friedmanfee02c62011-07-25 23:16:38 +00003233void Verifier::visitFenceInst(FenceInst &FI) {
3234 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003235 Assert(Ordering == AtomicOrdering::Acquire ||
3236 Ordering == AtomicOrdering::Release ||
3237 Ordering == AtomicOrdering::AcquireRelease ||
3238 Ordering == AtomicOrdering::SequentiallyConsistent,
3239 "fence instructions may only have acquire, release, acq_rel, or "
3240 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003241 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003242 visitInstruction(FI);
3243}
3244
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003245void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003246 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3247 EVI.getIndices()) == EVI.getType(),
3248 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003249
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003250 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003251}
3252
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003253void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003254 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3255 IVI.getIndices()) ==
3256 IVI.getOperand(1)->getType(),
3257 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003258
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003259 visitInstruction(IVI);
3260}
Chris Lattner0e851da2002-04-18 20:37:37 +00003261
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003262static Value *getParentPad(Value *EHPad) {
3263 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3264 return FPI->getParentPad();
3265
3266 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3267}
3268
David Majnemer85a549d2015-08-11 02:48:30 +00003269void Verifier::visitEHPadPredecessors(Instruction &I) {
3270 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003271
David Majnemer85a549d2015-08-11 02:48:30 +00003272 BasicBlock *BB = I.getParent();
3273 Function *F = BB->getParent();
3274
3275 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3276
3277 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3278 // The landingpad instruction defines its parent as a landing pad block. The
3279 // landing pad block may be branched to only by the unwind edge of an
3280 // invoke.
3281 for (BasicBlock *PredBB : predecessors(BB)) {
3282 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3283 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3284 "Block containing LandingPadInst must be jumped to "
3285 "only by the unwind edge of an invoke.",
3286 LPI);
3287 }
3288 return;
3289 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003290 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3291 if (!pred_empty(BB))
3292 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3293 "Block containg CatchPadInst must be jumped to "
3294 "only by its catchswitch.",
3295 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003296 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3297 "Catchswitch cannot unwind to one of its catchpads",
3298 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003299 return;
3300 }
David Majnemer85a549d2015-08-11 02:48:30 +00003301
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003302 // Verify that each pred has a legal terminator with a legal to/from EH
3303 // pad relationship.
3304 Instruction *ToPad = &I;
3305 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003306 for (BasicBlock *PredBB : predecessors(BB)) {
3307 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003308 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003309 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003310 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003311 "EH pad must be jumped to via an unwind edge", ToPad, II);
3312 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3313 FromPad = Bundle->Inputs[0];
3314 else
3315 FromPad = ConstantTokenNone::get(II->getContext());
3316 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003317 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003318 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3319 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3320 FromPad = CSI;
3321 } else {
3322 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3323 }
3324
3325 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003326 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003327 for (;; FromPad = getParentPad(FromPad)) {
3328 Assert(FromPad != ToPad,
3329 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3330 if (FromPad == ToPadParent) {
3331 // This is a legal unwind edge.
3332 break;
3333 }
3334 Assert(!isa<ConstantTokenNone>(FromPad),
3335 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003336 Assert(Seen.insert(FromPad).second,
3337 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003338 }
David Majnemer85a549d2015-08-11 02:48:30 +00003339 }
3340}
3341
3342void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003343 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3344 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003345 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3346 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003347
David Majnemer85a549d2015-08-11 02:48:30 +00003348 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003349
David Majnemer654e1302015-07-31 17:58:14 +00003350 if (!LandingPadResultTy)
3351 LandingPadResultTy = LPI.getType();
3352 else
3353 Assert(LandingPadResultTy == LPI.getType(),
3354 "The landingpad instruction should have a consistent result type "
3355 "inside a function.",
3356 &LPI);
3357
David Majnemer7fddecc2015-06-17 20:52:32 +00003358 Function *F = LPI.getParent()->getParent();
3359 Assert(F->hasPersonalityFn(),
3360 "LandingPadInst needs to be in a function with a personality.", &LPI);
3361
Bill Wendlingfae14752011-08-12 20:24:12 +00003362 // The landingpad instruction must be the first non-PHI instruction in the
3363 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003364 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3365 "LandingPadInst not the first non-PHI instruction in the block.",
3366 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003367
Duncan Sands86de1a62011-09-27 16:43:19 +00003368 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003369 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003370 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003371 Assert(isa<PointerType>(Clause->getType()),
3372 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003373 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003374 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3375 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3376 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003377 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003378 }
3379
Bill Wendlingfae14752011-08-12 20:24:12 +00003380 visitInstruction(LPI);
3381}
3382
David Majnemerba6665d2016-08-01 18:06:34 +00003383void Verifier::visitResumeInst(ResumeInst &RI) {
3384 Assert(RI.getFunction()->hasPersonalityFn(),
3385 "ResumeInst needs to be in a function with a personality.", &RI);
3386
3387 if (!LandingPadResultTy)
3388 LandingPadResultTy = RI.getValue()->getType();
3389 else
3390 Assert(LandingPadResultTy == RI.getValue()->getType(),
3391 "The resume instruction should have a consistent result type "
3392 "inside a function.",
3393 &RI);
3394
3395 visitTerminatorInst(RI);
3396}
3397
David Majnemer654e1302015-07-31 17:58:14 +00003398void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003399 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003400
David Majnemer654e1302015-07-31 17:58:14 +00003401 Function *F = BB->getParent();
3402 Assert(F->hasPersonalityFn(),
3403 "CatchPadInst needs to be in a function with a personality.", &CPI);
3404
David Majnemer8a1c45d2015-12-12 05:38:55 +00003405 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3406 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3407 CPI.getParentPad());
3408
David Majnemer654e1302015-07-31 17:58:14 +00003409 // The catchpad instruction must be the first non-PHI instruction in the
3410 // block.
3411 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003412 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003413
David Majnemerfe2f7f32016-02-29 22:56:36 +00003414 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003415 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003416}
3417
David Majnemer8a1c45d2015-12-12 05:38:55 +00003418void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3419 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3420 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3421 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003422
David Majnemer8a1c45d2015-12-12 05:38:55 +00003423 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003424}
3425
3426void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3427 BasicBlock *BB = CPI.getParent();
3428
David Majnemer654e1302015-07-31 17:58:14 +00003429 Function *F = BB->getParent();
3430 Assert(F->hasPersonalityFn(),
3431 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3432
3433 // The cleanuppad instruction must be the first non-PHI instruction in the
3434 // block.
3435 Assert(BB->getFirstNonPHI() == &CPI,
3436 "CleanupPadInst not the first non-PHI instruction in the block.",
3437 &CPI);
3438
David Majnemer8a1c45d2015-12-12 05:38:55 +00003439 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003440 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003441 "CleanupPadInst has an invalid parent.", &CPI);
3442
David Majnemerfe2f7f32016-02-29 22:56:36 +00003443 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003444 visitFuncletPadInst(CPI);
3445}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003446
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003447void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3448 User *FirstUser = nullptr;
3449 Value *FirstUnwindPad = nullptr;
3450 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003451 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003452
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003453 while (!Worklist.empty()) {
3454 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003455 Assert(Seen.insert(CurrentPad).second,
3456 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003457 Value *UnresolvedAncestorPad = nullptr;
3458 for (User *U : CurrentPad->users()) {
3459 BasicBlock *UnwindDest;
3460 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3461 UnwindDest = CRI->getUnwindDest();
3462 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3463 // We allow catchswitch unwind to caller to nest
3464 // within an outer pad that unwinds somewhere else,
3465 // because catchswitch doesn't have a nounwind variant.
3466 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3467 if (CSI->unwindsToCaller())
3468 continue;
3469 UnwindDest = CSI->getUnwindDest();
3470 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3471 UnwindDest = II->getUnwindDest();
3472 } else if (isa<CallInst>(U)) {
3473 // Calls which don't unwind may be found inside funclet
3474 // pads that unwind somewhere else. We don't *require*
3475 // such calls to be annotated nounwind.
3476 continue;
3477 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3478 // The unwind dest for a cleanup can only be found by
3479 // recursive search. Add it to the worklist, and we'll
3480 // search for its first use that determines where it unwinds.
3481 Worklist.push_back(CPI);
3482 continue;
3483 } else {
3484 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3485 continue;
3486 }
3487
3488 Value *UnwindPad;
3489 bool ExitsFPI;
3490 if (UnwindDest) {
3491 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003492 if (!cast<Instruction>(UnwindPad)->isEHPad())
3493 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003494 Value *UnwindParent = getParentPad(UnwindPad);
3495 // Ignore unwind edges that don't exit CurrentPad.
3496 if (UnwindParent == CurrentPad)
3497 continue;
3498 // Determine whether the original funclet pad is exited,
3499 // and if we are scanning nested pads determine how many
3500 // of them are exited so we can stop searching their
3501 // children.
3502 Value *ExitedPad = CurrentPad;
3503 ExitsFPI = false;
3504 do {
3505 if (ExitedPad == &FPI) {
3506 ExitsFPI = true;
3507 // Now we can resolve any ancestors of CurrentPad up to
3508 // FPI, but not including FPI since we need to make sure
3509 // to check all direct users of FPI for consistency.
3510 UnresolvedAncestorPad = &FPI;
3511 break;
3512 }
3513 Value *ExitedParent = getParentPad(ExitedPad);
3514 if (ExitedParent == UnwindParent) {
3515 // ExitedPad is the ancestor-most pad which this unwind
3516 // edge exits, so we can resolve up to it, meaning that
3517 // ExitedParent is the first ancestor still unresolved.
3518 UnresolvedAncestorPad = ExitedParent;
3519 break;
3520 }
3521 ExitedPad = ExitedParent;
3522 } while (!isa<ConstantTokenNone>(ExitedPad));
3523 } else {
3524 // Unwinding to caller exits all pads.
3525 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3526 ExitsFPI = true;
3527 UnresolvedAncestorPad = &FPI;
3528 }
3529
3530 if (ExitsFPI) {
3531 // This unwind edge exits FPI. Make sure it agrees with other
3532 // such edges.
3533 if (FirstUser) {
3534 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3535 "pad must have the same unwind "
3536 "dest",
3537 &FPI, U, FirstUser);
3538 } else {
3539 FirstUser = U;
3540 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003541 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3542 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3543 getParentPad(UnwindPad) == getParentPad(&FPI))
3544 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003545 }
3546 }
3547 // Make sure we visit all uses of FPI, but for nested pads stop as
3548 // soon as we know where they unwind to.
3549 if (CurrentPad != &FPI)
3550 break;
3551 }
3552 if (UnresolvedAncestorPad) {
3553 if (CurrentPad == UnresolvedAncestorPad) {
3554 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3555 // we've found an unwind edge that exits it, because we need to verify
3556 // all direct uses of FPI.
3557 assert(CurrentPad == &FPI);
3558 continue;
3559 }
3560 // Pop off the worklist any nested pads that we've found an unwind
3561 // destination for. The pads on the worklist are the uncles,
3562 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3563 // for all ancestors of CurrentPad up to but not including
3564 // UnresolvedAncestorPad.
3565 Value *ResolvedPad = CurrentPad;
3566 while (!Worklist.empty()) {
3567 Value *UnclePad = Worklist.back();
3568 Value *AncestorPad = getParentPad(UnclePad);
3569 // Walk ResolvedPad up the ancestor list until we either find the
3570 // uncle's parent or the last resolved ancestor.
3571 while (ResolvedPad != AncestorPad) {
3572 Value *ResolvedParent = getParentPad(ResolvedPad);
3573 if (ResolvedParent == UnresolvedAncestorPad) {
3574 break;
3575 }
3576 ResolvedPad = ResolvedParent;
3577 }
3578 // If the resolved ancestor search didn't find the uncle's parent,
3579 // then the uncle is not yet resolved.
3580 if (ResolvedPad != AncestorPad)
3581 break;
3582 // This uncle is resolved, so pop it from the worklist.
3583 Worklist.pop_back();
3584 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003585 }
3586 }
3587
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003588 if (FirstUnwindPad) {
3589 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3590 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3591 Value *SwitchUnwindPad;
3592 if (SwitchUnwindDest)
3593 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3594 else
3595 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3596 Assert(SwitchUnwindPad == FirstUnwindPad,
3597 "Unwind edges out of a catch must have the same unwind dest as "
3598 "the parent catchswitch",
3599 &FPI, FirstUser, CatchSwitch);
3600 }
3601 }
3602
3603 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003604}
3605
David Majnemer8a1c45d2015-12-12 05:38:55 +00003606void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003607 BasicBlock *BB = CatchSwitch.getParent();
3608
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003609 Function *F = BB->getParent();
3610 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003611 "CatchSwitchInst needs to be in a function with a personality.",
3612 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003613
David Majnemer8a1c45d2015-12-12 05:38:55 +00003614 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003615 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003616 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3617 "CatchSwitchInst not the first non-PHI instruction in the block.",
3618 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003619
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003620 auto *ParentPad = CatchSwitch.getParentPad();
3621 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3622 "CatchSwitchInst has an invalid parent.", ParentPad);
3623
David Majnemer8a1c45d2015-12-12 05:38:55 +00003624 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003625 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003626 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3627 "CatchSwitchInst must unwind to an EH block which is not a "
3628 "landingpad.",
3629 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003630
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003631 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3632 if (getParentPad(I) == ParentPad)
3633 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3634 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003635
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003636 Assert(CatchSwitch.getNumHandlers() != 0,
3637 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3638
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003639 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003640 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3641 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003642 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003643
David Majnemerfe2f7f32016-02-29 22:56:36 +00003644 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003645 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003646}
3647
David Majnemer654e1302015-07-31 17:58:14 +00003648void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003649 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3650 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3651 CRI.getOperand(0));
3652
David Majnemer654e1302015-07-31 17:58:14 +00003653 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3654 Instruction *I = UnwindDest->getFirstNonPHI();
3655 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3656 "CleanupReturnInst must unwind to an EH block which is not a "
3657 "landingpad.",
3658 &CRI);
3659 }
3660
3661 visitTerminatorInst(CRI);
3662}
3663
Rafael Espindola654320a2012-02-26 02:23:37 +00003664void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3665 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003666 // If the we have an invalid invoke, don't try to compute the dominance.
3667 // We already reject it in the invoke specific checks and the dominance
3668 // computation doesn't handle multiple edges.
3669 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3670 if (II->getNormalDest() == II->getUnwindDest())
3671 return;
3672 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003673
Michael Kruseff379b62016-03-26 23:32:57 +00003674 // Quick check whether the def has already been encountered in the same block.
3675 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3676 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003677 //
3678 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3679 // wrapping an SSA value, assert that we've already encountered it. See
3680 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003681 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3682 return;
3683
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003684 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003685 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003686 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003687}
3688
Artur Pilipenkocca80022015-10-09 17:41:29 +00003689void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3690 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3691 "apply only to pointer types", &I);
3692 Assert(isa<LoadInst>(I),
3693 "dereferenceable, dereferenceable_or_null apply only to load"
3694 " instructions, use attributes for calls or invokes", &I);
3695 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3696 "take one operand!", &I);
3697 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3698 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3699 "dereferenceable_or_null metadata value must be an i64!", &I);
3700}
3701
Misha Brukmanc566ca362004-03-02 00:22:19 +00003702/// verifyInstruction - Verify that an instruction is well formed.
3703///
Chris Lattner069a7952002-06-25 15:56:27 +00003704void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003705 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003706 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003707
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003708 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003709 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003710 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3711 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003712 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003713 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003714
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003715 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003716 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3717 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003718
Chris Lattner5f126b72004-03-29 00:29:36 +00003719 // Check that the return value of the instruction is either void or a legal
3720 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003721 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3722 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003723
Nick Lewycky93e06a52009-09-27 23:27:42 +00003724 // Check that the instruction doesn't produce metadata. Calls are already
3725 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003726 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3727 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003728
Chris Lattner0e851da2002-04-18 20:37:37 +00003729 // Check that all uses of the instruction, if they are instructions
3730 // themselves, actually have parent basic blocks. If the use is not an
3731 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003732 for (Use &U : I.uses()) {
3733 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003734 Assert(Used->getParent() != nullptr,
3735 "Instruction referencing"
3736 " instruction not embedded in a basic block!",
3737 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003738 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003739 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003740 return;
3741 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003742 }
3743
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003744 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003745 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003746
3747 // Check to make sure that only first-class-values are operands to
3748 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003749 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003750 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003751 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003752
Chris Lattner9ece94b2004-03-14 03:23:54 +00003753 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003754 // Check to make sure that the "address of" an intrinsic function is never
3755 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003756 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003757 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003758 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3759 "Cannot take the address of an intrinsic!", &I);
3760 Assert(
3761 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003762 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003763 F->getIntrinsicID() == Intrinsic::coro_resume ||
3764 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003765 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003766 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3767 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003768 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3769 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003770 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003771 Assert(F->getParent() == &M, "Referencing function in another module!",
3772 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003773 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003774 Assert(OpBB->getParent() == BB->getParent(),
3775 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003776 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003777 Assert(OpArg->getParent() == BB->getParent(),
3778 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003779 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003780 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3781 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003782 } else if (isa<Instruction>(I.getOperand(i))) {
3783 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003784 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003785 Assert((i + 1 == e && isa<CallInst>(I)) ||
3786 (i + 3 == e && isa<InvokeInst>(I)),
3787 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003788 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003789 if (CE->getType()->isPtrOrPtrVectorTy() ||
3790 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003791 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003792 // illegal bitcast. If the datalayout string specifies non-integral
3793 // address spaces then we also need to check for illegal ptrtoint and
3794 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003795 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003796 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003797 }
3798 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003799
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003800 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003801 Assert(I.getType()->isFPOrFPVectorTy(),
3802 "fpmath requires a floating point result!", &I);
3803 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003804 if (ConstantFP *CFP0 =
3805 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003806 const APFloat &Accuracy = CFP0->getValueAPF();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003807 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
Matt Arsenault82f41512016-06-27 19:43:15 +00003808 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003809 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3810 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003811 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003812 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003813 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003814 }
3815
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003816 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003817 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3818 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003819 visitRangeMetadata(I, Range, I.getType());
3820 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003821
Philip Reames0ca58b32014-10-21 20:56:29 +00003822 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003823 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3824 &I);
3825 Assert(isa<LoadInst>(I),
3826 "nonnull applies only to load instructions, use attributes"
3827 " for calls or invokes",
3828 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003829 }
3830
Artur Pilipenkocca80022015-10-09 17:41:29 +00003831 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3832 visitDereferenceableMetadata(I, MD);
3833
3834 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3835 visitDereferenceableMetadata(I, MD);
3836
Mehdi Aminia84a8402016-12-16 06:29:14 +00003837 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
3838 TBAAVerifyHelper.visitTBAAMetadata(I, TBAA);
Sanjoy Das2582e692016-11-08 20:46:01 +00003839
Artur Pilipenkocca80022015-10-09 17:41:29 +00003840 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3841 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3842 &I);
3843 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3844 "use attributes for calls or invokes", &I);
3845 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3846 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3847 Assert(CI && CI->getType()->isIntegerTy(64),
3848 "align metadata value must be an i64!", &I);
3849 uint64_t Align = CI->getZExtValue();
3850 Assert(isPowerOf2_64(Align),
3851 "align metadata value must be a power of 2!", &I);
3852 Assert(Align <= Value::MaximumAlignment,
3853 "alignment is larger that implementation defined limit", &I);
3854 }
3855
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003856 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003857 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003858 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003859 }
3860
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003861 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Adrian Prantl941fa752016-12-05 18:04:47 +00003862 verifyFragmentExpression(*DII);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003863
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003864 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003865}
3866
Philip Reames007561a2015-06-26 22:21:52 +00003867/// Allow intrinsics to be verified in different ways.
3868void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003869 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003870 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3871 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003872
Chris Lattner144b6192012-05-27 19:37:05 +00003873 // Verify that the intrinsic prototype lines up with what the .td files
3874 // describe.
3875 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003876 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003877
Chris Lattner144b6192012-05-27 19:37:05 +00003878 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3879 getIntrinsicInfoTableEntries(ID, Table);
3880 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003881
Chris Lattner144b6192012-05-27 19:37:05 +00003882 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003883 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3884 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003885 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003886 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003887 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3888 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003889 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003890
3891 // Verify if the intrinsic call matches the vararg property.
3892 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003893 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003894 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003895 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003896 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003897 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003898
3899 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003900 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003901
3902 // Now that we have the intrinsic ID and the actual argument types (and we
3903 // know they are legal for the intrinsic!) get the intrinsic name through the
3904 // usual means. This allows us to verify the mangling of argument types into
3905 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003906 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003907 Assert(ExpectedName == IF->getName(),
3908 "Intrinsic name not mangled correctly for type arguments! "
3909 "Should be: " +
3910 ExpectedName,
3911 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003912
Chris Lattner588096e2009-12-28 09:07:21 +00003913 // If the intrinsic takes MDNode arguments, verify that they are either global
3914 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003915 for (Value *V : CS.args())
3916 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3917 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003918
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003919 switch (ID) {
3920 default:
3921 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003922 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003923 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003924 if (isa<ConstantPointerNull>(InfoArg))
3925 break;
3926 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3927 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3928 "info argument of llvm.coro.begin must refer to an initialized "
3929 "constant");
3930 Constant *Init = GV->getInitializer();
3931 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3932 "info argument of llvm.coro.begin must refer to either a struct or "
3933 "an array");
3934 break;
3935 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003936 case Intrinsic::ctlz: // llvm.ctlz
3937 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003938 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003939 "is_zero_undef argument of bit counting intrinsics must be a "
3940 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003941 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003942 break;
Andrew Kaylora0a11642017-01-26 23:27:59 +00003943 case Intrinsic::experimental_constrained_fadd:
3944 case Intrinsic::experimental_constrained_fsub:
3945 case Intrinsic::experimental_constrained_fmul:
3946 case Intrinsic::experimental_constrained_fdiv:
3947 case Intrinsic::experimental_constrained_frem:
3948 visitConstrainedFPIntrinsic(
3949 cast<ConstrainedFPIntrinsic>(*CS.getInstruction()));
3950 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003951 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003952 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3953 "invalid llvm.dbg.declare intrinsic call 1", CS);
3954 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003955 break;
3956 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003957 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003958 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003959 case Intrinsic::memcpy:
3960 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003961 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003962 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003963 Assert(AlignCI,
3964 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003965 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003966 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003967 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003968 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003969 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003970 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003971 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003972 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003973 }
Igor Laevsky4f31e522016-12-29 14:31:07 +00003974 case Intrinsic::memcpy_element_atomic: {
3975 ConstantInt *ElementSizeCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3976 Assert(ElementSizeCI, "element size of the element-wise atomic memory "
3977 "intrinsic must be a constant int",
3978 CS);
3979 const APInt &ElementSizeVal = ElementSizeCI->getValue();
3980 Assert(ElementSizeVal.isPowerOf2(),
3981 "element size of the element-wise atomic memory intrinsic "
3982 "must be a power of 2",
3983 CS);
3984
3985 auto IsValidAlignment = [&](uint64_t Alignment) {
3986 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
3987 };
3988
3989 uint64_t DstAlignment = CS.getParamAlignment(1),
3990 SrcAlignment = CS.getParamAlignment(2);
3991
3992 Assert(IsValidAlignment(DstAlignment),
3993 "incorrect alignment of the destination argument",
3994 CS);
3995 Assert(IsValidAlignment(SrcAlignment),
3996 "incorrect alignment of the source argument",
3997 CS);
3998 break;
3999 }
Bill Wendling05604e02008-08-23 09:46:46 +00004000 case Intrinsic::gcroot:
4001 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00004002 case Intrinsic::gcread:
4003 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00004004 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00004005 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
4006 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
4007 Assert(isa<Constant>(CS.getArgOperand(1)),
4008 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00004009 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00004010 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004011 "llvm.gcroot parameter #1 must either be a pointer alloca, "
4012 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00004013 CS);
Talin2e59f142010-09-30 20:23:47 +00004014 }
Chris Lattner25852062008-08-24 20:46:13 +00004015 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00004016
Philip Reames9818dd72015-06-26 22:04:34 +00004017 Assert(CS.getParent()->getParent()->hasGC(),
4018 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00004019 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00004020 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00004021 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004022 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00004023 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004024 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004025 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004026 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4027 isa<ConstantInt>(CS.getArgOperand(2)) &&
4028 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4029 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4030 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004031 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004032 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004033 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4034 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004035 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004036 case Intrinsic::lifetime_start:
4037 case Intrinsic::lifetime_end:
4038 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004039 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004040 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004041 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004042 break;
4043 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004044 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4045 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004046 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004047
Reid Kleckner60381792015-07-07 22:25:32 +00004048 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004049 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004050 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004051 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004052 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004053 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004054 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004055 if (isa<ConstantPointerNull>(Arg))
4056 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004057 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004058 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004059 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004060 }
Philip Reames9818dd72015-06-26 22:04:34 +00004061 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004062 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004063 break;
4064 }
Reid Kleckner60381792015-07-07 22:25:32 +00004065 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004066 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004067 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004068 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004069 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004070 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004071 CS);
4072 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004073 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004074 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004075 auto &Entry = FrameEscapeInfo[Fn];
4076 Entry.second = unsigned(
4077 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004078 break;
4079 }
4080
Philip Reames1ffa9372015-01-30 23:28:05 +00004081 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004082 Assert(!CS.isInlineAsm(),
4083 "gc.statepoint support for inline assembly unimplemented", CS);
4084 Assert(CS.getParent()->getParent()->hasGC(),
4085 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004086
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004087 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004088 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004089 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004090 Assert(CS.getParent()->getParent()->hasGC(),
4091 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004092 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004093 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004094 const Function *StatepointFn =
4095 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004096 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4097 StatepointFn->getIntrinsicID() ==
4098 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004099 "gc.result operand #1 must be from a statepoint", CS,
4100 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004101
Philip Reamesb23713a2014-12-03 22:23:24 +00004102 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004103 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004104 auto *PT = cast<PointerType>(Target->getType());
4105 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004106 Assert(CS.getType() == TargetFuncType->getReturnType(),
4107 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004108 break;
4109 }
4110 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004111 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004112
Philip Reames3e2cf532016-01-07 03:32:11 +00004113 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4114 "gc.relocate must return a pointer or a vector of pointers", CS);
4115
Igor Laevsky9570ff92015-02-19 11:28:47 +00004116 // Check that this relocate is correctly tied to the statepoint
4117
4118 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004119 if (LandingPadInst *LandingPad =
4120 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004121
Sanjoy Das5665c992015-05-11 23:47:27 +00004122 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004123 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004124
4125 // Landingpad relocates should have only one predecessor with invoke
4126 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004127 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004128 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004129 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4130 InvokeBB);
4131 Assert(isStatepoint(InvokeBB->getTerminator()),
4132 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004133 }
4134 else {
4135 // In all other cases relocate should be tied to the statepoint directly.
4136 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004137 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004138 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004139 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004140 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004141 }
4142
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004143 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004144
Manuel Jacob83eefa62016-01-05 04:03:00 +00004145 ImmutableCallSite StatepointCS(
4146 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004147
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004148 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004149 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004150 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004151 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004152
Philip Reames9818dd72015-06-26 22:04:34 +00004153 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004154 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004155 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004156
4157 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4158 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4159 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004160 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004161 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004162 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004163 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004164
4165 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004166 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004167 Assert(StatepointCS.arg_size() > 0,
4168 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004169 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004170 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004171 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004172 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4173 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004174 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004175 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004176 "gc.statepoint: number of transition arguments must be "
4177 "a constant integer");
4178 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004179 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4180 ->getZExtValue();
4181 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004182 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004183 "gc.statepoint: number of deoptimization arguments must be "
4184 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004185 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004186 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4187 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004188 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004189 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004190 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4191 "gc.relocate: statepoint base index doesn't fall within the "
4192 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004193 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004194 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4195 "gc.relocate: statepoint derived index doesn't fall within the "
4196 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004197 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004198
Philip Reames3e2cf532016-01-07 03:32:11 +00004199 // Relocated value must be either a pointer type or vector-of-pointer type,
4200 // but gc_relocate does not need to return the same pointer type as the
4201 // relocated pointer. It can be casted to the correct type later if it's
4202 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004203 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004204 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004205 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004206
Philip Reames3e2cf532016-01-07 03:32:11 +00004207 auto ResultType = CS.getType();
4208 auto DerivedType = Relocate.getDerivedPtr()->getType();
4209 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004210 "gc.relocate: vector relocates to vector and pointer to pointer",
4211 CS);
4212 Assert(
4213 ResultType->getPointerAddressSpace() ==
4214 DerivedType->getPointerAddressSpace(),
4215 "gc.relocate: relocating a pointer shouldn't change its address space",
4216 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004217 break;
4218 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004219 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004220 case Intrinsic::eh_exceptionpointer: {
4221 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4222 "eh.exceptionpointer argument must be a catchpad", CS);
4223 break;
4224 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004225 case Intrinsic::masked_load: {
4226 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4227
4228 Value *Ptr = CS.getArgOperand(0);
4229 //Value *Alignment = CS.getArgOperand(1);
4230 Value *Mask = CS.getArgOperand(2);
4231 Value *PassThru = CS.getArgOperand(3);
4232 Assert(Mask->getType()->isVectorTy(),
4233 "masked_load: mask must be vector", CS);
4234
4235 // DataTy is the overloaded type
4236 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4237 Assert(DataTy == CS.getType(),
4238 "masked_load: return must match pointer type", CS);
4239 Assert(PassThru->getType() == DataTy,
4240 "masked_load: pass through and data type must match", CS);
4241 Assert(Mask->getType()->getVectorNumElements() ==
4242 DataTy->getVectorNumElements(),
4243 "masked_load: vector mask must be same length as data", CS);
4244 break;
4245 }
4246 case Intrinsic::masked_store: {
4247 Value *Val = CS.getArgOperand(0);
4248 Value *Ptr = CS.getArgOperand(1);
4249 //Value *Alignment = CS.getArgOperand(2);
4250 Value *Mask = CS.getArgOperand(3);
4251 Assert(Mask->getType()->isVectorTy(),
4252 "masked_store: mask must be vector", CS);
4253
4254 // DataTy is the overloaded type
4255 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4256 Assert(DataTy == Val->getType(),
4257 "masked_store: storee must match pointer type", CS);
4258 Assert(Mask->getType()->getVectorNumElements() ==
4259 DataTy->getVectorNumElements(),
4260 "masked_store: vector mask must be same length as data", CS);
4261 break;
4262 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004263
Sanjoy Das021de052016-03-31 00:18:46 +00004264 case Intrinsic::experimental_guard: {
4265 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4266 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4267 "experimental_guard must have exactly one "
4268 "\"deopt\" operand bundle");
4269 break;
4270 }
4271
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004272 case Intrinsic::experimental_deoptimize: {
4273 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4274 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4275 "experimental_deoptimize must have exactly one "
4276 "\"deopt\" operand bundle");
4277 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4278 "experimental_deoptimize return type must match caller return type");
4279
4280 if (CS.isCall()) {
4281 auto *DeoptCI = CS.getInstruction();
4282 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4283 Assert(RI,
4284 "calls to experimental_deoptimize must be followed by a return");
4285
4286 if (!CS.getType()->isVoidTy() && RI)
4287 Assert(RI->getReturnValue() == DeoptCI,
4288 "calls to experimental_deoptimize must be followed by a return "
4289 "of the value computed by experimental_deoptimize");
4290 }
4291
4292 break;
4293 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004294 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004295}
4296
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004297/// \brief Carefully grab the subprogram from a local scope.
4298///
4299/// This carefully grabs the subprogram from a local scope, avoiding the
4300/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004301static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004302 if (!LocalScope)
4303 return nullptr;
4304
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004305 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004306 return SP;
4307
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004308 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004309 return getSubprogram(LB->getRawScope());
4310
4311 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004312 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004313 return nullptr;
4314}
4315
Andrew Kaylora0a11642017-01-26 23:27:59 +00004316void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
4317 Assert(isa<MetadataAsValue>(FPI.getOperand(2)),
4318 "invalid rounding mode argument", &FPI);
4319 Assert(FPI.getRoundingMode() != ConstrainedFPIntrinsic::rmInvalid,
4320 "invalid rounding mode argument", &FPI);
4321 Assert(FPI.getExceptionBehavior() != ConstrainedFPIntrinsic::ebInvalid,
4322 "invalid exception behavior argument", &FPI);
4323}
4324
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004325template <class DbgIntrinsicTy>
4326void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4327 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004328 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004329 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4330 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004331 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004332 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4333 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004334 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004335 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4336 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004337
4338 // Ignore broken !dbg attachments; they're checked elsewhere.
4339 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004340 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004341 return;
4342
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004343 BasicBlock *BB = DII.getParent();
4344 Function *F = BB ? BB->getParent() : nullptr;
4345
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004346 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004347 DILocalVariable *Var = DII.getVariable();
4348 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004349 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4350 &DII, BB, F);
4351
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004352 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4353 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004354 if (!VarSP || !LocSP)
4355 return; // Broken scope chains are checked elsewhere.
4356
Adrian Prantla2ef0472016-09-14 17:30:37 +00004357 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4358 " variable and !dbg attachment",
4359 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4360 Loc->getScope()->getSubprogram());
Adrian Prantl612ac862017-02-28 23:48:42 +00004361
4362 verifyFnArgs(DII);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004363}
4364
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004365static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004366 // Be careful of broken types (checked elsewhere).
4367 const Metadata *RawType = V.getRawType();
4368 while (RawType) {
4369 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004370 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004371 if (uint64_t Size = T->getSizeInBits())
4372 return Size;
4373
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004374 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004375 // Look at the base type.
4376 RawType = DT->getRawBaseType();
4377 continue;
4378 }
4379
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004380 // Missing type or size.
4381 break;
4382 }
4383
4384 // Fail gracefully.
4385 return 0;
4386}
4387
Adrian Prantl941fa752016-12-05 18:04:47 +00004388void Verifier::verifyFragmentExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004389 DILocalVariable *V;
4390 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004391 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004392 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4393 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004394 } else {
4395 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004396 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4397 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004398 }
4399
4400 // We don't know whether this intrinsic verified correctly.
4401 if (!V || !E || !E->isValid())
4402 return;
4403
Keno Fischer253a7bd2016-01-15 02:12:38 +00004404 // Nothing to do if this isn't a bit piece expression.
Adrian Prantl49797ca2016-12-22 05:27:12 +00004405 auto Fragment = E->getFragmentInfo();
4406 if (!Fragment)
Keno Fischer253a7bd2016-01-15 02:12:38 +00004407 return;
4408
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004409 // The frontend helps out GDB by emitting the members of local anonymous
4410 // unions as artificial local variables with shared storage. When SROA splits
4411 // the storage for artificial local variables that are smaller than the entire
4412 // union, the overhang piece will be outside of the allotted space for the
4413 // variable and this check fails.
4414 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4415 if (V->isArtificial())
4416 return;
4417
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004418 // If there's no size, the type is broken, but that should be checked
4419 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004420 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004421 if (!VarSize)
4422 return;
4423
Adrian Prantl49797ca2016-12-22 05:27:12 +00004424 unsigned FragSize = Fragment->SizeInBits;
4425 unsigned FragOffset = Fragment->OffsetInBits;
Adrian Prantl941fa752016-12-05 18:04:47 +00004426 AssertDI(FragSize + FragOffset <= VarSize,
4427 "fragment is larger than or outside of variable", &I, V, E);
4428 AssertDI(FragSize != VarSize, "fragment covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004429}
4430
Adrian Prantl612ac862017-02-28 23:48:42 +00004431void Verifier::verifyFnArgs(const DbgInfoIntrinsic &I) {
Adrian Prantl63d96952017-03-07 17:28:54 +00004432 // This function does not take the scope of noninlined function arguments into
4433 // account. Don't run it if current function is nodebug, because it may
4434 // contain inlined debug intrinsics.
4435 if (!HasDebugInfo)
4436 return;
4437
Adrian Prantl612ac862017-02-28 23:48:42 +00004438 DILocalVariable *Var;
4439 if (auto *DV = dyn_cast<DbgValueInst>(&I)) {
4440 // For performance reasons only check non-inlined ones.
4441 if (DV->getDebugLoc()->getInlinedAt())
4442 return;
4443 Var = DV->getVariable();
4444 } else {
4445 auto *DD = cast<DbgDeclareInst>(&I);
4446 if (DD->getDebugLoc()->getInlinedAt())
4447 return;
4448 Var = DD->getVariable();
4449 }
4450 AssertDI(Var, "dbg intrinsic without variable");
4451
4452 unsigned ArgNo = Var->getArg();
4453 if (!ArgNo)
4454 return;
4455
4456 // Verify there are no duplicate function argument debug info entries.
4457 // These will cause hard-to-debug assertions in the DWARF backend.
4458 if (DebugFnArgs.size() < ArgNo)
4459 DebugFnArgs.resize(ArgNo, nullptr);
4460
4461 auto *Prev = DebugFnArgs[ArgNo - 1];
4462 DebugFnArgs[ArgNo - 1] = Var;
4463 AssertDI(!Prev || (Prev == Var), "conflicting debug info for argument", &I,
4464 Prev, Var);
4465}
4466
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004467void Verifier::verifyCompileUnits() {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004468 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004469 SmallPtrSet<const Metadata *, 2> Listed;
4470 if (CUs)
4471 Listed.insert(CUs->op_begin(), CUs->op_end());
Davide Italianoa9de0102017-02-20 22:51:42 +00004472 for (auto *CU : CUVisited)
4473 AssertDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU);
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004474 CUVisited.clear();
4475}
4476
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004477void Verifier::verifyDeoptimizeCallingConvs() {
4478 if (DeoptimizeDeclarations.empty())
4479 return;
4480
4481 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004482 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004483 Assert(First->getCallingConv() == F->getCallingConv(),
4484 "All llvm.experimental.deoptimize declarations must have the same "
4485 "calling convention",
4486 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004487 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004488}
4489
Chris Lattner0e851da2002-04-18 20:37:37 +00004490//===----------------------------------------------------------------------===//
4491// Implement the public interfaces to this file...
4492//===----------------------------------------------------------------------===//
4493
Chandler Carruth043949d2014-01-19 02:22:18 +00004494bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004495 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004496
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004497 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004498 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004499
4500 // Note that this function's return value is inverted from what you would
4501 // expect of a function called "verify".
4502 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004503}
4504
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004505bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4506 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004507 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004508 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004509
Chandler Carruth043949d2014-01-19 02:22:18 +00004510 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004511 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004512 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004513
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004514 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004515 if (BrokenDebugInfo)
4516 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004517 // Note that this function's return value is inverted from what you would
4518 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004519 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004520}
Chandler Carruth043949d2014-01-19 02:22:18 +00004521
4522namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004523
Chandler Carruth4d356312014-01-20 11:34:08 +00004524struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004525 static char ID;
4526
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004527 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004528 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004529
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004530 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004531 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004532 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004533 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004534 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004535 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004536 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004537 }
4538
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004539 bool doInitialization(Module &M) override {
4540 V = llvm::make_unique<Verifier>(
4541 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4542 return false;
4543 }
4544
Craig Topperf398d7c2014-03-05 06:35:38 +00004545 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004546 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004547 report_fatal_error("Broken function found, compilation aborted!");
4548
4549 return false;
4550 }
4551
Craig Topperf398d7c2014-03-05 06:35:38 +00004552 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004553 bool HasErrors = false;
4554 for (Function &F : M)
4555 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004556 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004557
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004558 HasErrors |= !V->verify();
Adrian Prantl94a903e2016-05-25 21:33:20 +00004559 if (FatalErrors) {
4560 if (HasErrors)
4561 report_fatal_error("Broken module found, compilation aborted!");
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004562 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
Adrian Prantl94a903e2016-05-25 21:33:20 +00004563 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004564
Adrian Prantl94a903e2016-05-25 21:33:20 +00004565 // Strip broken debug info.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004566 if (V->hasBrokenDebugInfo()) {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004567 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4568 M.getContext().diagnose(DiagInvalid);
4569 if (!StripDebugInfo(M))
4570 report_fatal_error("Failed to strip malformed debug info");
4571 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004572 return false;
4573 }
4574
4575 void getAnalysisUsage(AnalysisUsage &AU) const override {
4576 AU.setPreservesAll();
4577 }
4578};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004579
4580} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004581
Mehdi Aminia84a8402016-12-16 06:29:14 +00004582/// Helper to issue failure from the TBAA verification
4583template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
4584 if (Diagnostic)
4585 return Diagnostic->CheckFailed(Args...);
4586}
4587
4588#define AssertTBAA(C, ...) \
4589 do { \
4590 if (!(C)) { \
4591 CheckFailed(__VA_ARGS__); \
4592 return false; \
4593 } \
4594 } while (false)
4595
4596/// Verify that \p BaseNode can be used as the "base type" in the struct-path
4597/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
4598/// struct-type node describing an aggregate data structure (like a struct).
4599TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004600TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004601 if (BaseNode->getNumOperands() < 2) {
4602 CheckFailed("Base nodes must have at least two operands", &I, BaseNode);
4603 return {true, ~0u};
4604 }
4605
4606 auto Itr = TBAABaseNodes.find(BaseNode);
4607 if (Itr != TBAABaseNodes.end())
4608 return Itr->second;
4609
4610 auto Result = verifyTBAABaseNodeImpl(I, BaseNode);
4611 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
4612 (void)InsertResult;
4613 assert(InsertResult.second && "We just checked!");
4614 return Result;
4615}
4616
4617TBAAVerifier::TBAABaseNodeSummary
Sanjoy Das600d2a52016-12-29 15:47:01 +00004618TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004619 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
4620
4621 if (BaseNode->getNumOperands() == 2) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004622 // Scalar nodes can only be accessed at offset 0.
Sanjoy Das00d76a52016-12-29 15:47:05 +00004623 return isValidScalarTBAANode(BaseNode)
4624 ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
4625 : InvalidNode;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004626 }
4627
4628 if (BaseNode->getNumOperands() % 2 != 1) {
4629 CheckFailed("Struct tag nodes must have an odd number of operands!",
4630 BaseNode);
4631 return InvalidNode;
4632 }
4633
Sanjoy Das00d76a52016-12-29 15:47:05 +00004634 if (!isa<MDString>(BaseNode->getOperand(0))) {
4635 CheckFailed("Struct tag nodes have a string as their first operand",
4636 BaseNode);
4637 return InvalidNode;
4638 }
4639
Mehdi Aminia84a8402016-12-16 06:29:14 +00004640 bool Failed = false;
4641
4642 Optional<APInt> PrevOffset;
4643 unsigned BitWidth = ~0u;
4644
4645 // We've already checked that BaseNode is not a degenerate root node with one
4646 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
4647 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4648 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
4649 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
4650 if (!isa<MDNode>(FieldTy)) {
4651 CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode);
4652 Failed = true;
4653 continue;
4654 }
4655
4656 auto *OffsetEntryCI =
4657 mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset);
4658 if (!OffsetEntryCI) {
4659 CheckFailed("Offset entries must be constants!", &I, BaseNode);
4660 Failed = true;
4661 continue;
4662 }
4663
4664 if (BitWidth == ~0u)
4665 BitWidth = OffsetEntryCI->getBitWidth();
4666
4667 if (OffsetEntryCI->getBitWidth() != BitWidth) {
4668 CheckFailed(
4669 "Bitwidth between the offsets and struct type entries must match", &I,
4670 BaseNode);
4671 Failed = true;
4672 continue;
4673 }
4674
4675 // NB! As far as I can tell, we generate a non-strictly increasing offset
4676 // sequence only from structs that have zero size bit fields. When
4677 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
4678 // pick the field lexically the latest in struct type metadata node. This
4679 // mirrors the actual behavior of the alias analysis implementation.
4680 bool IsAscending =
4681 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
4682
4683 if (!IsAscending) {
4684 CheckFailed("Offsets must be increasing!", &I, BaseNode);
4685 Failed = true;
4686 }
4687
4688 PrevOffset = OffsetEntryCI->getValue();
4689 }
4690
4691 return Failed ? InvalidNode
4692 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
4693}
4694
4695static bool IsRootTBAANode(const MDNode *MD) {
4696 return MD->getNumOperands() < 2;
4697}
4698
4699static bool IsScalarTBAANodeImpl(const MDNode *MD,
4700 SmallPtrSetImpl<const MDNode *> &Visited) {
Sanjoy Das00d76a52016-12-29 15:47:05 +00004701 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004702 return false;
4703
Sanjoy Das00d76a52016-12-29 15:47:05 +00004704 if (!isa<MDString>(MD->getOperand(0)))
Mehdi Aminia84a8402016-12-16 06:29:14 +00004705 return false;
4706
Sanjoy Das00d76a52016-12-29 15:47:05 +00004707 if (MD->getNumOperands() == 3) {
4708 auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
4709 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
4710 return false;
4711 }
4712
4713 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4714 return Parent && Visited.insert(Parent).second &&
Mehdi Aminia84a8402016-12-16 06:29:14 +00004715 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
4716}
4717
Sanjoy Das55f12d92016-12-29 15:46:57 +00004718bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
4719 auto ResultIt = TBAAScalarNodes.find(MD);
4720 if (ResultIt != TBAAScalarNodes.end())
4721 return ResultIt->second;
4722
Mehdi Aminia84a8402016-12-16 06:29:14 +00004723 SmallPtrSet<const MDNode *, 4> Visited;
Sanjoy Das55f12d92016-12-29 15:46:57 +00004724 bool Result = IsScalarTBAANodeImpl(MD, Visited);
4725 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
4726 (void)InsertResult;
4727 assert(InsertResult.second && "Just checked!");
4728
4729 return Result;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004730}
4731
4732/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
4733/// Offset in place to be the offset within the field node returned.
4734///
4735/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
4736MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I,
Sanjoy Das600d2a52016-12-29 15:47:01 +00004737 const MDNode *BaseNode,
Mehdi Aminia84a8402016-12-16 06:29:14 +00004738 APInt &Offset) {
4739 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
4740
4741 // Scalar nodes have only one possible "field" -- their parent in the access
4742 // hierarchy. Offset must be zero at this point, but our caller is supposed
4743 // to Assert that.
4744 if (BaseNode->getNumOperands() == 2)
4745 return cast<MDNode>(BaseNode->getOperand(1));
4746
4747 for (unsigned Idx = 1; Idx < BaseNode->getNumOperands(); Idx += 2) {
4748 auto *OffsetEntryCI =
4749 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
4750 if (OffsetEntryCI->getValue().ugt(Offset)) {
4751 if (Idx == 1) {
4752 CheckFailed("Could not find TBAA parent in struct type node", &I,
4753 BaseNode, &Offset);
4754 return nullptr;
4755 }
4756
4757 auto *PrevOffsetEntryCI =
4758 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx - 1));
4759 Offset -= PrevOffsetEntryCI->getValue();
4760 return cast<MDNode>(BaseNode->getOperand(Idx - 2));
4761 }
4762 }
4763
4764 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
4765 BaseNode->getOperand(BaseNode->getNumOperands() - 1));
4766
4767 Offset -= LastOffsetEntryCI->getValue();
4768 return cast<MDNode>(BaseNode->getOperand(BaseNode->getNumOperands() - 2));
4769}
4770
Sanjoy Das600d2a52016-12-29 15:47:01 +00004771bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004772 AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) ||
Sanjoy Das600d2a52016-12-29 15:47:01 +00004773 isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) ||
4774 isa<AtomicCmpXchgInst>(I),
Mehdi Aminia84a8402016-12-16 06:29:14 +00004775 "TBAA is only for loads, stores and calls!", &I);
4776
4777 bool IsStructPathTBAA =
4778 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
4779
4780 AssertTBAA(
4781 IsStructPathTBAA,
4782 "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I);
4783
4784 AssertTBAA(MD->getNumOperands() < 5,
4785 "Struct tag metadata must have either 3 or 4 operands", &I, MD);
4786
4787 MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
4788 MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4789
4790 if (MD->getNumOperands() == 4) {
4791 auto *IsImmutableCI =
4792 mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(3));
4793 AssertTBAA(IsImmutableCI,
4794 "Immutability tag on struct tag metadata must be a constant", &I,
4795 MD);
4796 AssertTBAA(
4797 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
4798 "Immutability part of the struct tag metadata must be either 0 or 1",
4799 &I, MD);
4800 }
4801
4802 AssertTBAA(BaseNode && AccessType,
4803 "Malformed struct tag metadata: base and access-type "
4804 "should be non-null and point to Metadata nodes",
4805 &I, MD, BaseNode, AccessType);
4806
Sanjoy Das55f12d92016-12-29 15:46:57 +00004807 AssertTBAA(isValidScalarTBAANode(AccessType),
Sanjoy Das00d76a52016-12-29 15:47:05 +00004808 "Access type node must be a valid scalar type", &I, MD,
4809 AccessType);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004810
4811 auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2));
4812 AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD);
4813
4814 APInt Offset = OffsetCI->getValue();
4815 bool SeenAccessTypeInPath = false;
4816
4817 SmallPtrSet<MDNode *, 4> StructPath;
4818
4819 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
4820 BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset)) {
4821 if (!StructPath.insert(BaseNode).second) {
4822 CheckFailed("Cycle detected in struct path", &I, MD);
4823 return false;
4824 }
4825
4826 bool Invalid;
4827 unsigned BaseNodeBitWidth;
4828 std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode);
4829
4830 // If the base node is invalid in itself, then we've already printed all the
4831 // errors we wanted to print.
4832 if (Invalid)
4833 return false;
4834
4835 SeenAccessTypeInPath |= BaseNode == AccessType;
4836
Sanjoy Das55f12d92016-12-29 15:46:57 +00004837 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004838 AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access",
4839 &I, MD, &Offset);
4840
4841 AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
4842 (BaseNodeBitWidth == 0 && Offset == 0),
4843 "Access bit-width not the same as description bit-width", &I, MD,
4844 BaseNodeBitWidth, Offset.getBitWidth());
4845 }
4846
4847 AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!",
4848 &I, MD);
4849 return true;
4850}
4851
Chandler Carruth4d356312014-01-20 11:34:08 +00004852char VerifierLegacyPass::ID = 0;
4853INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004854
4855FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004856 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004857}
4858
Chandler Carruthdab4eae2016-11-23 17:53:26 +00004859AnalysisKey VerifierAnalysis::Key;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004860VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4861 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004862 Result Res;
4863 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4864 return Res;
4865}
Chandler Carruth4d356312014-01-20 11:34:08 +00004866
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004867VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4868 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004869 return { llvm::verifyFunction(F, &dbgs()), false };
4870}
4871
4872PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4873 auto Res = AM.getResult<VerifierAnalysis>(M);
4874 if (FatalErrors) {
4875 if (Res.IRBroken)
4876 report_fatal_error("Broken module found, compilation aborted!");
4877 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4878 }
4879
4880 // Strip broken debug info.
4881 if (Res.DebugInfoBroken) {
4882 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4883 M.getContext().diagnose(DiagInvalid);
4884 if (!StripDebugInfo(M))
4885 report_fatal_error("Failed to strip malformed debug info");
4886 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004887 return PreservedAnalyses::all();
4888}
4889
Adrian Prantle3656182016-05-09 19:57:29 +00004890PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4891 auto res = AM.getResult<VerifierAnalysis>(F);
4892 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004893 report_fatal_error("Broken function found, compilation aborted!");
4894
4895 return PreservedAnalyses::all();
4896}