blob: 89af3db34c0dfba01918ba36814b86367c5adb26 [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"
Joseph Tremoulet8ea80862016-01-10 04:31:05 +000052#include "llvm/ADT/MapVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000053#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000054#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000055#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000056#include "llvm/ADT/SmallSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000057#include "llvm/ADT/SmallVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000058#include "llvm/ADT/StringMap.h"
59#include "llvm/ADT/StringRef.h"
60#include "llvm/ADT/Twine.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000061#include "llvm/ADT/ilist.h"
Zachary Turner264b5d92017-06-07 03:48:56 +000062#include "llvm/BinaryFormat/Dwarf.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000063#include "llvm/IR/Argument.h"
64#include "llvm/IR/Attributes.h"
65#include "llvm/IR/BasicBlock.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000066#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000067#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000068#include "llvm/IR/CallingConv.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000069#include "llvm/IR/Comdat.h"
70#include "llvm/IR/Constant.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000071#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000072#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000073#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000074#include "llvm/IR/DebugInfo.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000075#include "llvm/IR/DebugInfoMetadata.h"
76#include "llvm/IR/DebugLoc.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000077#include "llvm/IR/DerivedTypes.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"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000084#include "llvm/IR/InstVisitor.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000085#include "llvm/IR/InstrTypes.h"
86#include "llvm/IR/Instruction.h"
87#include "llvm/IR/Instructions.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"
Torok Edwin6dd27302009-07-08 18:01:40 +0000105#include "llvm/Support/ErrorHandling.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000106#include "llvm/Support/MathExtras.h"
Chris Lattner24025262009-02-28 21:05:51 +0000107#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000108#include <algorithm>
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000109#include <cassert>
110#include <cstdint>
111#include <memory>
112#include <string>
113#include <utility>
114
Chris Lattner189d19f2003-11-21 20:23:48 +0000115using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +0000116
Daniel Jaspera44fd302016-12-16 13:53:46 +0000117namespace llvm {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000118
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000119struct VerifierSupport {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000120 raw_ostream *OS;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000121 const Module &M;
122 ModuleSlotTracker MST;
123 const DataLayout &DL;
124 LLVMContext &Context;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000125
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +0000126 /// Track the brokenness of the module while recursively visiting.
127 bool Broken = false;
Adrian Prantl541a9c52016-05-06 19:26:47 +0000128 /// Broken debug info can be "recovered" from by stripping the debug info.
129 bool BrokenDebugInfo = false;
130 /// Whether to treat broken debug info as an error.
131 bool TreatBrokenDebugInfoAsError = true;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000132
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000133 explicit VerifierSupport(raw_ostream *OS, const Module &M)
134 : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000135
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000136private:
Keno Fischera6c4ce42015-12-01 19:06:36 +0000137 void Write(const Module *M) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000138 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
Keno Fischera6c4ce42015-12-01 19:06:36 +0000139 }
140
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000141 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000142 if (!V)
143 return;
144 if (isa<Instruction>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000145 V->print(*OS, MST);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000146 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000147 } else {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000148 V->printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000149 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000150 }
151 }
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000152
Philip Reames9818dd72015-06-26 22:04:34 +0000153 void Write(ImmutableCallSite CS) {
154 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000155 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000156
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000157 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000158 if (!MD)
159 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000160 MD->print(*OS, MST, &M);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000161 *OS << '\n';
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000162 }
163
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000164 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
165 Write(MD.get());
166 }
167
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000168 void Write(const NamedMDNode *NMD) {
169 if (!NMD)
170 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000171 NMD->print(*OS, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000172 *OS << '\n';
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000173 }
174
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000175 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000176 if (!T)
177 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000178 *OS << ' ' << *T;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000179 }
180
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000181 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000182 if (!C)
183 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000184 *OS << *C;
David Majnemerdad0a642014-06-27 18:19:56 +0000185 }
186
Sanjoy Das3336f682016-12-11 20:07:15 +0000187 void Write(const APInt *AI) {
188 if (!AI)
189 return;
190 *OS << *AI << '\n';
191 }
192
193 void Write(const unsigned i) { *OS << i << '\n'; }
194
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000195 template <typename T> void Write(ArrayRef<T> Vs) {
196 for (const T &V : Vs)
197 Write(V);
198 }
199
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000200 template <typename T1, typename... Ts>
201 void WriteTs(const T1 &V1, const Ts &... Vs) {
202 Write(V1);
203 WriteTs(Vs...);
204 }
205
206 template <typename... Ts> void WriteTs() {}
207
208public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000209 /// \brief A check failed, so printout out the condition and the message.
210 ///
211 /// This provides a nice place to put a breakpoint if you want to see why
212 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000213 void CheckFailed(const Twine &Message) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000214 if (OS)
215 *OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000216 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000217 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000218
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000219 /// \brief A check failed (with values to print).
220 ///
221 /// This calls the Message-only version so that the above is easier to set a
222 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000223 template <typename T1, typename... Ts>
224 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
225 CheckFailed(Message);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000226 if (OS)
227 WriteTs(V1, Vs...);
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000228 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000229
230 /// A debug info check failed.
231 void DebugInfoCheckFailed(const Twine &Message) {
232 if (OS)
233 *OS << Message << '\n';
234 Broken |= TreatBrokenDebugInfoAsError;
235 BrokenDebugInfo = true;
236 }
237
238 /// A debug info check failed (with values to print).
239 template <typename T1, typename... Ts>
240 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
241 const Ts &... Vs) {
242 DebugInfoCheckFailed(Message);
243 if (OS)
244 WriteTs(V1, Vs...);
245 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000246};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000247
Daniel Jaspera44fd302016-12-16 13:53:46 +0000248} // namespace llvm
249
250namespace {
251
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000252class Verifier : public InstVisitor<Verifier>, VerifierSupport {
253 friend class InstVisitor<Verifier>;
254
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000255 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000256
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000257 /// \brief When verifying a basic block, keep track of all of the
258 /// instructions we have seen so far.
259 ///
260 /// This allows us to do efficient dominance checks for the case when an
261 /// instruction has an operand that is an instruction in the same block.
262 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000263
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000264 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000265 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000266
Adrian Prantlc10d0e52017-05-09 19:47:37 +0000267 /// Keep track which DISubprogram is attached to which function.
268 DenseMap<const DISubprogram *, const Function *> DISubprogramAttachments;
269
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();
Adrian Prantlc10d0e52017-05-09 19:47:37 +0000389 DISubprogramAttachments.clear();
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);
Reid Kleckner3cdf7132017-09-07 22:46:24 +0000468 void visitDbgIntrinsic(StringRef Kind, DbgInfoIntrinsic &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000469 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
470 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
471 void visitFenceInst(FenceInst &FI);
472 void visitAllocaInst(AllocaInst &AI);
473 void visitExtractValueInst(ExtractValueInst &EVI);
474 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000475 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000476 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000477 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000478 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000479 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000480 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000481 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000482 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000483 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000484
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000485 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000486 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
487 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000488 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000489 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000490 unsigned ArgNo, std::string &Suffix);
Reid Klecknerb5180542017-03-21 16:57:19 +0000491 bool verifyAttributeCount(AttributeList Attrs, unsigned Params);
Reid Klecknera77172a2017-04-14 00:06:06 +0000492 void verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000493 const Value *V);
Reid Klecknera77172a2017-04-14 00:06:06 +0000494 void verifyParameterAttrs(AttributeSet Attrs, Type *Ty, const Value *V);
Reid Klecknerb5180542017-03-21 16:57:19 +0000495 void verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000496 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000497 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000498
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000499 void visitConstantExprsRecursively(const Constant *EntryC);
500 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000501 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000502 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000503 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000504
Adrian Prantl941fa752016-12-05 18:04:47 +0000505 void verifyFragmentExpression(const DbgInfoIntrinsic &I);
Adrian Prantl28454ef2017-08-31 00:07:33 +0000506 template <typename ValueOrMetadata>
507 void verifyFragmentExpression(const DIVariable &V,
508 DIExpression::FragmentInfo Fragment,
509 ValueOrMetadata *Desc);
Adrian Prantl612ac862017-02-28 23:48:42 +0000510 void verifyFnArgs(const DbgInfoIntrinsic &I);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000511
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000512 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000513 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000514
515 /// Module-level verification that all @llvm.experimental.deoptimize
516 /// declarations share the same calling convention.
517 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000518};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000519
520} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000521
Adrian Prantl541a9c52016-05-06 19:26:47 +0000522/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000523#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000524 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000525
Adrian Prantl541a9c52016-05-06 19:26:47 +0000526/// We know that a debug info condition should be true, if not print
527/// an error message.
528#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000529 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000530
Chris Lattnere5a22c02008-08-28 04:02:44 +0000531void Verifier::visit(Instruction &I) {
532 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000533 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000534 InstVisitor<Verifier>::visit(I);
535}
536
Keno Fischer60f82a22016-01-14 22:20:56 +0000537// Helper to recursively iterate over indirect users. By
538// returning false, the callback can ask to stop recursing
539// further.
540static void forEachUser(const Value *User,
541 SmallPtrSet<const Value *, 32> &Visited,
542 llvm::function_ref<bool(const Value *)> Callback) {
543 if (!Visited.insert(User).second)
544 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000545 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000546 if (Callback(TheNextUser))
547 forEachUser(TheNextUser, Visited, Callback);
548}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000549
Chandler Carruth043949d2014-01-19 02:22:18 +0000550void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000551 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000552 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000553
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000554 Assert(GV.getAlignment() <= Value::MaximumAlignment,
555 "huge alignment values are unsupported", &GV);
556 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
557 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000558
559 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000560 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000561 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000562 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000563 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000564
565 if (GV.isDeclarationForLinker())
566 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000567
Sean Fertilec70d28b2017-10-26 15:00:26 +0000568 if (GV.hasDLLImportStorageClass())
569 Assert(!GV.isDSOLocal(),
570 "GlobalValue with DLLImport Storage is dso_local!", &GV);
571
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000572 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000573 if (const Instruction *I = dyn_cast<Instruction>(V)) {
574 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000575 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
576 I);
577 else if (I->getParent()->getParent()->getParent() != &M)
578 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
579 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000580 I->getParent()->getParent()->getParent());
581 return false;
582 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000583 if (F->getParent() != &M)
584 CheckFailed("Global is used by function in a different module", &GV, &M,
585 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000586 return false;
587 }
588 return true;
589 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000590}
591
Chandler Carruth043949d2014-01-19 02:22:18 +0000592void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000593 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000594 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000595 "Global variable initializer type does not match global "
596 "variable type!",
597 &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000598 // If the global has common linkage, it must have a zero initializer and
599 // cannot be constant.
600 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000601 Assert(GV.getInitializer()->isNullValue(),
602 "'common' global must have a zero initializer!", &GV);
603 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
604 &GV);
605 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000606 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000607 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000608
Nick Lewycky466d0c12011-04-08 07:30:21 +0000609 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
610 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000611 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
612 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000613 // Don't worry about emitting an error for it not being an array,
614 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000615 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000616 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
617 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000618 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000619 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000620 Assert(STy &&
621 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
622 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
623 STy->getTypeAtIndex(1) == FuncPtrTy,
624 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000625 if (STy->getNumElements() == 3) {
626 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000627 Assert(ETy->isPointerTy() &&
628 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
629 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000630 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000631 }
632 }
633
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000634 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000635 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000636 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
637 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000638 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000639 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
640 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000641 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000642 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000643 const Constant *Init = GV.getInitializer();
644 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000645 Assert(InitArray, "wrong initalizer for intrinsic global variable",
646 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000647 for (Value *Op : InitArray->operands()) {
648 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000649 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
650 isa<GlobalAlias>(V),
651 "invalid llvm.used member", V);
652 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000653 }
654 }
655 }
656 }
657
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000658 Assert(!GV.hasDLLImportStorageClass() ||
659 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
660 GV.hasAvailableExternallyLinkage(),
661 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000662
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000663 // Visit any debug info attachments.
664 SmallVector<MDNode *, 1> MDs;
665 GV.getMetadata(LLVMContext::MD_dbg, MDs);
Adrian Prantldc6e0162016-12-20 02:33:30 +0000666 for (auto *MD : MDs) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000667 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
668 visitDIGlobalVariableExpression(*GVE);
669 else
Adrian Prantlfd37e792017-02-23 23:54:29 +0000670 AssertDI(false, "!dbg attachment of global variable must be a "
671 "DIGlobalVariableExpression");
Adrian Prantldc6e0162016-12-20 02:33:30 +0000672 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000673
Matt Arsenault24b49c42013-07-31 17:49:08 +0000674 if (!GV.hasInitializer()) {
675 visitGlobalValue(GV);
676 return;
677 }
678
679 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000680 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000681
Chris Lattnere3400652004-12-15 20:23:49 +0000682 visitGlobalValue(GV);
683}
684
Rafael Espindola64c1e182014-06-03 02:41:57 +0000685void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
686 SmallPtrSet<const GlobalAlias*, 4> Visited;
687 Visited.insert(&GA);
688 visitAliaseeSubExpr(Visited, GA, C);
689}
690
Craig Topper71b7b682014-08-21 05:55:13 +0000691void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000692 const GlobalAlias &GA, const Constant &C) {
693 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000694 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
695 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000696
697 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000698 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000699
Sanjoy Das5ce32722016-04-08 00:48:30 +0000700 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000701 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000702 } else {
703 // Only continue verifying subexpressions of GlobalAliases.
704 // Do not recurse into global initializers.
705 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000706 }
707 }
708
709 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000710 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000711
712 for (const Use &U : C.operands()) {
713 Value *V = &*U;
714 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
715 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
716 else if (const auto *C2 = dyn_cast<Constant>(V))
717 visitAliaseeSubExpr(Visited, GA, *C2);
718 }
719}
720
Chandler Carruth043949d2014-01-19 02:22:18 +0000721void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000722 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
723 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
724 "weak_odr, or external linkage!",
725 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000726 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000727 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
728 Assert(GA.getType() == Aliasee->getType(),
729 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000730
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000731 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
732 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000733
Rafael Espindola64c1e182014-06-03 02:41:57 +0000734 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000735
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000736 visitGlobalValue(GA);
737}
738
Chandler Carruth043949d2014-01-19 02:22:18 +0000739void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000740 // There used to be various other llvm.dbg.* nodes, but we don't support
741 // upgrading them and we want to reserve the namespace for future uses.
742 if (NMD.getName().startswith("llvm.dbg."))
Adrian Prantl7db6b5e2017-08-23 22:02:36 +0000743 AssertDI(NMD.getName() == "llvm.dbg.cu",
Adrian Prantlb3510af2016-10-05 22:15:37 +0000744 "unrecognized named metadata node in the llvm.dbg namespace",
745 &NMD);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000746 for (const MDNode *MD : NMD.operands()) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000747 if (NMD.getName() == "llvm.dbg.cu")
Adrian Prantl541a9c52016-05-06 19:26:47 +0000748 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000749
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000750 if (!MD)
751 continue;
752
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000753 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000754 }
755}
756
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000757void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000758 // Only visit each node once. Metadata can be mutually recursive, so this
759 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000760 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000761 return;
762
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000763 switch (MD.getMetadataID()) {
764 default:
765 llvm_unreachable("Invalid MDNode subclass");
766 case Metadata::MDTupleKind:
767 break;
768#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
769 case Metadata::CLASS##Kind: \
770 visit##CLASS(cast<CLASS>(MD)); \
771 break;
772#include "llvm/IR/Metadata.def"
773 }
774
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000775 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000776 if (!Op)
777 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000778 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
779 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000780 if (auto *N = dyn_cast<MDNode>(Op)) {
781 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000782 continue;
783 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000784 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
785 visitValueAsMetadata(*V, nullptr);
786 continue;
787 }
Duncan Sands76d62172010-04-29 16:10:30 +0000788 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000789
790 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000791 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
792 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000793}
794
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000795void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000796 Assert(MD.getValue(), "Expected valid value", &MD);
797 Assert(!MD.getValue()->getType()->isMetadataTy(),
798 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000799
800 auto *L = dyn_cast<LocalAsMetadata>(&MD);
801 if (!L)
802 return;
803
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000804 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000805
806 // If this was an instruction, bb, or argument, verify that it is in the
807 // function that we expect.
808 Function *ActualF = nullptr;
809 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000810 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000811 ActualF = I->getParent()->getParent();
812 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
813 ActualF = BB->getParent();
814 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
815 ActualF = A->getParent();
816 assert(ActualF && "Unimplemented function local metadata case!");
817
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000818 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000819}
820
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000821void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000822 Metadata *MD = MDV.getMetadata();
823 if (auto *N = dyn_cast<MDNode>(MD)) {
824 visitMDNode(*N);
825 return;
826 }
827
828 // Only visit each node once. Metadata can be mutually recursive, so this
829 // avoids infinite recursion here, as well as being an optimization.
830 if (!MDNodes.insert(MD).second)
831 return;
832
833 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
834 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000835}
836
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000837static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
838static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
839static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000840
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000841void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000842 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
843 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000844 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000845 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Adrian Prantl33aa8ac2017-08-23 21:52:24 +0000846 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
847 AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000848}
849
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000850void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000851 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000852}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000853
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000854void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000855 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000856 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000857}
858
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000859void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000860 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
861 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000862}
863
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000864void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000865 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000866}
867
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000868void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000869 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
870 N.getTag() == dwarf::DW_TAG_unspecified_type,
871 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000872}
873
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000874void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000875 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000876 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000877
Adrian Prantl541a9c52016-05-06 19:26:47 +0000878 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
879 N.getTag() == dwarf::DW_TAG_pointer_type ||
880 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
881 N.getTag() == dwarf::DW_TAG_reference_type ||
882 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
883 N.getTag() == dwarf::DW_TAG_const_type ||
884 N.getTag() == dwarf::DW_TAG_volatile_type ||
885 N.getTag() == dwarf::DW_TAG_restrict_type ||
Victor Leschuke1156c22016-10-31 19:09:38 +0000886 N.getTag() == dwarf::DW_TAG_atomic_type ||
Adrian Prantl541a9c52016-05-06 19:26:47 +0000887 N.getTag() == dwarf::DW_TAG_member ||
888 N.getTag() == dwarf::DW_TAG_inheritance ||
889 N.getTag() == dwarf::DW_TAG_friend,
890 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000891 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000892 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
893 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000894 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000895
Adrian Prantl541a9c52016-05-06 19:26:47 +0000896 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
897 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
898 N.getRawBaseType());
Konstantin Zhuravlyovd5561e02017-03-08 23:55:44 +0000899
900 if (N.getDWARFAddressSpace()) {
901 AssertDI(N.getTag() == dwarf::DW_TAG_pointer_type ||
902 N.getTag() == dwarf::DW_TAG_reference_type,
903 "DWARF address space only applies to pointer or reference types",
904 &N);
905 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000906}
907
Adrian Prantla29aac72018-01-05 01:13:37 +0000908/// Detect mutually exclusive flags.
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000909static bool hasConflictingReferenceFlags(unsigned Flags) {
Adrian Prantla29aac72018-01-05 01:13:37 +0000910 return ((Flags & DINode::FlagLValueReference) &&
911 (Flags & DINode::FlagRValueReference)) ||
912 ((Flags & DINode::FlagTypePassByValue) &&
913 (Flags & DINode::FlagTypePassByReference));
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000914}
915
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000916void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
917 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000918 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000919 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000920 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
921 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000922 }
923}
924
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000925void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000926 // Common scope checks.
927 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000928
Adrian Prantl541a9c52016-05-06 19:26:47 +0000929 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
930 N.getTag() == dwarf::DW_TAG_structure_type ||
931 N.getTag() == dwarf::DW_TAG_union_type ||
932 N.getTag() == dwarf::DW_TAG_enumeration_type ||
933 N.getTag() == dwarf::DW_TAG_class_type,
934 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000935
Adrian Prantl541a9c52016-05-06 19:26:47 +0000936 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
937 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
938 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000939
Adrian Prantl541a9c52016-05-06 19:26:47 +0000940 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
941 "invalid composite elements", &N, N.getRawElements());
942 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
943 N.getRawVTableHolder());
944 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
945 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000946 if (auto *Params = N.getRawTemplateParams())
947 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000948
949 if (N.getTag() == dwarf::DW_TAG_class_type ||
950 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000951 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
952 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000953 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000954}
955
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000956void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000957 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000958 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000959 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000960 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000961 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000962 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000963 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000964 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
965 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000966}
967
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000968void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000969 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Amjad Aboud7faeecc2016-12-25 10:12:09 +0000970 AssertDI((N.getChecksumKind() != DIFile::CSK_None ||
971 N.getChecksum().empty()), "invalid checksum kind", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000972}
973
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000974void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000975 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
976 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000977
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000978 // Don't bother verifying the compilation directory or producer string
979 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000980 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
981 N.getRawFile());
982 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
983 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000984
Adrian Prantl541a9c52016-05-06 19:26:47 +0000985 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
986 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000987
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000988 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000989 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000990 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000991 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000992 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
993 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000994 }
995 }
996 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000997 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000998 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000999 AssertDI(Op && (isa<DIType>(Op) ||
1000 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00001001 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +00001002 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001003 }
1004 }
1005 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001006 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001007 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001008 AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)),
1009 "invalid global variable ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001010 }
1011 }
1012 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001013 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001014 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001015 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
1016 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001017 }
1018 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001019 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001020 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001021 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001022 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001023 }
1024 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +00001025 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001026}
1027
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001028void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001029 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1030 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +00001031 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001032 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Justin Bognerefc3fbf2017-02-17 23:57:42 +00001033 else
1034 AssertDI(N.getLine() == 0, "line specified with no file", &N, N.getLine());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001035 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001036 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1037 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1038 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001039 if (auto *Params = N.getRawTemplateParams())
1040 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001041 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001042 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1043 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001044 if (auto *RawVars = N.getRawVariables()) {
1045 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001046 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001047 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001048 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1049 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001050 }
1051 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001052 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1053 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001054
Adrian Prantl75819ae2016-04-15 15:57:41 +00001055 auto *Unit = N.getRawUnit();
1056 if (N.isDefinition()) {
1057 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001058 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1059 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1060 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001061 } else {
1062 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001063 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001064 }
Adrian Prantl1d12b882017-04-26 22:56:44 +00001065
1066 if (auto *RawThrownTypes = N.getRawThrownTypes()) {
1067 auto *ThrownTypes = dyn_cast<MDTuple>(RawThrownTypes);
1068 AssertDI(ThrownTypes, "invalid thrown types list", &N, RawThrownTypes);
1069 for (Metadata *Op : ThrownTypes->operands())
1070 AssertDI(Op && isa<DIType>(Op), "invalid thrown type", &N, ThrownTypes,
1071 Op);
1072 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001073}
1074
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001075void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001076 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1077 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1078 "invalid local scope", &N, N.getRawScope());
Adrian Prantl33aa8ac2017-08-23 21:52:24 +00001079 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
1080 AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001081}
1082
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001083void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1084 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001085
Adrian Prantl541a9c52016-05-06 19:26:47 +00001086 AssertDI(N.getLine() || !N.getColumn(),
1087 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001088}
1089
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001090void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1091 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001092}
1093
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001094void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001095 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001096 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001097 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001098}
1099
Amjad Abouda9bcf162015-12-10 12:56:35 +00001100void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001101 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1102 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1103 "invalid macinfo type", &N);
1104 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001105 if (!N.getValue().empty()) {
1106 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1107 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001108}
1109
1110void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001111 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1112 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001113 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001114 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001115
1116 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001117 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001118 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001119 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001120 }
1121 }
1122}
1123
Adrian Prantlab1243f2015-06-29 23:03:47 +00001124void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001125 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1126 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001127}
1128
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001129void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001130 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001131}
1132
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001133void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1134 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001135
Adrian Prantl541a9c52016-05-06 19:26:47 +00001136 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1137 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001138}
1139
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001140void Verifier::visitDITemplateValueParameter(
1141 const DITemplateValueParameter &N) {
1142 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001143
Adrian Prantl541a9c52016-05-06 19:26:47 +00001144 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1145 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1146 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1147 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001148}
1149
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001150void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001151 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001152 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001153 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001154 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001155}
1156
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001157void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001158 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001159 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001160
Adrian Prantl541a9c52016-05-06 19:26:47 +00001161 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1162 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Davide Italiano26053812017-08-25 22:08:15 +00001163 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Davide Italianocd213782017-08-16 15:16:33 +00001164 AssertDI(N.getType(), "missing global variable type", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001165 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001166 AssertDI(isa<DIDerivedType>(Member),
1167 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001168 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001169}
1170
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001171void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001172 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001173 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001174
Davide Italiano21221192017-09-24 01:06:35 +00001175 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Adrian Prantl541a9c52016-05-06 19:26:47 +00001176 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1177 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1178 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001179}
1180
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001181void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001182 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001183}
1184
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001185void Verifier::visitDIGlobalVariableExpression(
1186 const DIGlobalVariableExpression &GVE) {
1187 AssertDI(GVE.getVariable(), "missing variable");
Davide Italiano21221192017-09-24 01:06:35 +00001188 if (auto *Var = GVE.getVariable())
1189 visitDIGlobalVariable(*Var);
Adrian Prantl28454ef2017-08-31 00:07:33 +00001190 if (auto *Expr = GVE.getExpression()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001191 visitDIExpression(*Expr);
Adrian Prantl28454ef2017-08-31 00:07:33 +00001192 if (auto Fragment = Expr->getFragmentInfo())
1193 verifyFragmentExpression(*GVE.getVariable(), *Fragment, &GVE);
1194 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001195}
1196
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001197void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001198 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001199 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001200 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001201 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001202 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001203}
1204
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001205void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001206 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1207 N.getTag() == dwarf::DW_TAG_imported_declaration,
1208 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001209 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001210 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1211 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1212 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001213}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001214
David Majnemerdad0a642014-06-27 18:19:56 +00001215void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001216 // The Module is invalid if the GlobalValue has private linkage. Entities
1217 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001218 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001219 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1220 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001221}
1222
Chandler Carruth043949d2014-01-19 02:22:18 +00001223void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001224 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001225 if (!Idents)
Rafael Espindola0018a592013-10-16 01:49:05 +00001226 return;
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001227
Rafael Espindola0018a592013-10-16 01:49:05 +00001228 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1229 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001230 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001231 Assert(N->getNumOperands() == 1,
1232 "incorrect number of operands in llvm.ident metadata", N);
1233 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1234 ("invalid value for llvm.ident metadata entry operand"
1235 "(the operand should be a string)"),
1236 N->getOperand(0));
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001237 }
Rafael Espindola0018a592013-10-16 01:49:05 +00001238}
1239
Chandler Carruth043949d2014-01-19 02:22:18 +00001240void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001241 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1242 if (!Flags) return;
1243
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001244 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001245 DenseMap<const MDString*, const MDNode*> SeenIDs;
1246 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001247 for (const MDNode *MDN : Flags->operands())
1248 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001249
1250 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001251 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001252 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001253 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001254
Chandler Carruth043949d2014-01-19 02:22:18 +00001255 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001256 if (!Op) {
1257 CheckFailed("invalid requirement on flag, flag is not present in module",
1258 Flag);
1259 continue;
1260 }
1261
1262 if (Op->getOperand(2) != ReqValue) {
1263 CheckFailed(("invalid requirement on flag, "
1264 "flag does not have the required value"),
1265 Flag);
1266 continue;
1267 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001268 }
1269}
1270
Chandler Carruth043949d2014-01-19 02:22:18 +00001271void
1272Verifier::visitModuleFlag(const MDNode *Op,
1273 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1274 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001275 // Each module flag should have three arguments, the merge behavior (a
1276 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001277 Assert(Op->getNumOperands() == 3,
1278 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001279 Module::ModFlagBehavior MFB;
1280 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001281 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001282 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001283 "invalid behavior operand in module flag (expected constant integer)",
1284 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001285 Assert(false,
1286 "invalid behavior operand in module flag (unexpected constant)",
1287 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001288 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001289 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001290 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1291 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001292
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001293 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001294 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001295 case Module::Error:
1296 case Module::Warning:
1297 case Module::Override:
1298 // These behavior types accept any value.
1299 break;
1300
Teresa Johnson2db13692017-05-23 00:08:00 +00001301 case Module::Max: {
1302 Assert(mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2)),
1303 "invalid value for 'max' module flag (expected constant integer)",
1304 Op->getOperand(2));
1305 break;
1306 }
1307
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001308 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001309 // The value should itself be an MDNode with two operands, a flag ID (an
1310 // MDString), and a value.
1311 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001312 Assert(Value && Value->getNumOperands() == 2,
1313 "invalid value for 'require' module flag (expected metadata pair)",
1314 Op->getOperand(2));
1315 Assert(isa<MDString>(Value->getOperand(0)),
1316 ("invalid value for 'require' module flag "
1317 "(first value operand should be a string)"),
1318 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001319
1320 // Append it to the list of requirements, to check once all module flags are
1321 // scanned.
1322 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001323 break;
1324 }
1325
1326 case Module::Append:
1327 case Module::AppendUnique: {
1328 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001329 Assert(isa<MDNode>(Op->getOperand(2)),
1330 "invalid value for 'append'-type module flag "
1331 "(expected a metadata node)",
1332 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001333 break;
1334 }
1335 }
1336
1337 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001338 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001339 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001340 Assert(Inserted,
1341 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001342 }
Matthias Braun89f3bcf2017-05-19 22:37:01 +00001343
1344 if (ID->getString() == "wchar_size") {
1345 ConstantInt *Value
1346 = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
1347 Assert(Value, "wchar_size metadata requires constant integer argument");
Matthias Braun89f3bcf2017-05-19 22:37:01 +00001348 }
Peter Collingbourne89061b22017-06-12 20:10:48 +00001349
1350 if (ID->getString() == "Linker Options") {
1351 // If the llvm.linker.options named metadata exists, we assume that the
1352 // bitcode reader has upgraded the module flag. Otherwise the flag might
1353 // have been created by a client directly.
1354 Assert(M.getNamedMetadata("llvm.linker.options"),
1355 "'Linker Options' named metadata no longer supported");
1356 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001357}
1358
Reid Klecknera77172a2017-04-14 00:06:06 +00001359/// Return true if this attribute kind only applies to functions.
1360static bool isFuncOnlyAttr(Attribute::AttrKind Kind) {
1361 switch (Kind) {
1362 case Attribute::NoReturn:
1363 case Attribute::NoUnwind:
1364 case Attribute::NoInline:
1365 case Attribute::AlwaysInline:
1366 case Attribute::OptimizeForSize:
1367 case Attribute::StackProtect:
1368 case Attribute::StackProtectReq:
1369 case Attribute::StackProtectStrong:
1370 case Attribute::SafeStack:
1371 case Attribute::NoRedZone:
1372 case Attribute::NoImplicitFloat:
1373 case Attribute::Naked:
1374 case Attribute::InlineHint:
1375 case Attribute::StackAlignment:
1376 case Attribute::UWTable:
1377 case Attribute::NonLazyBind:
1378 case Attribute::ReturnsTwice:
1379 case Attribute::SanitizeAddress:
Evgeniy Stepanovc667c1f2017-12-09 00:21:41 +00001380 case Attribute::SanitizeHWAddress:
Reid Klecknera77172a2017-04-14 00:06:06 +00001381 case Attribute::SanitizeThread:
1382 case Attribute::SanitizeMemory:
1383 case Attribute::MinSize:
1384 case Attribute::NoDuplicate:
1385 case Attribute::Builtin:
1386 case Attribute::NoBuiltin:
1387 case Attribute::Cold:
1388 case Attribute::OptimizeNone:
1389 case Attribute::JumpTable:
1390 case Attribute::Convergent:
1391 case Attribute::ArgMemOnly:
1392 case Attribute::NoRecurse:
1393 case Attribute::InaccessibleMemOnly:
1394 case Attribute::InaccessibleMemOrArgMemOnly:
1395 case Attribute::AllocSize:
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001396 case Attribute::Speculatable:
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00001397 case Attribute::StrictFP:
Reid Klecknera77172a2017-04-14 00:06:06 +00001398 return true;
1399 default:
1400 break;
1401 }
1402 return false;
1403}
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001404
Reid Klecknera77172a2017-04-14 00:06:06 +00001405/// Return true if this is a function attribute that can also appear on
1406/// arguments.
1407static bool isFuncOrArgAttr(Attribute::AttrKind Kind) {
1408 return Kind == Attribute::ReadOnly || Kind == Attribute::WriteOnly ||
1409 Kind == Attribute::ReadNone;
1410}
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001411
Reid Klecknera77172a2017-04-14 00:06:06 +00001412void Verifier::verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
1413 const Value *V) {
1414 for (Attribute A : Attrs) {
1415 if (A.isStringAttribute())
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001416 continue;
1417
Reid Klecknera77172a2017-04-14 00:06:06 +00001418 if (isFuncOnlyAttr(A.getKindAsEnum())) {
1419 if (!IsFunction) {
1420 CheckFailed("Attribute '" + A.getAsString() +
1421 "' only applies to functions!",
1422 V);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001423 return;
1424 }
Reid Klecknera77172a2017-04-14 00:06:06 +00001425 } else if (IsFunction && !isFuncOrArgAttr(A.getKindAsEnum())) {
1426 CheckFailed("Attribute '" + A.getAsString() +
1427 "' does not apply to functions!",
1428 V);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001429 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001430 }
1431 }
1432}
1433
Duncan Sandsc3a79922009-06-11 08:11:03 +00001434// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001435// value of the specified type. The value V is printed in error messages.
Reid Klecknera77172a2017-04-14 00:06:06 +00001436void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty,
1437 const Value *V) {
1438 if (!Attrs.hasAttributes())
Duncan Sands0009c442008-01-12 16:42:01 +00001439 return;
1440
Reid Klecknera77172a2017-04-14 00:06:06 +00001441 verifyAttributeTypes(Attrs, /*IsFunction=*/false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001442
Reid Klecknera534a382013-12-19 02:14:12 +00001443 // Check for mutually incompatible attributes. Only inreg is compatible with
1444 // sret.
1445 unsigned AttrCount = 0;
Reid Klecknera77172a2017-04-14 00:06:06 +00001446 AttrCount += Attrs.hasAttribute(Attribute::ByVal);
1447 AttrCount += Attrs.hasAttribute(Attribute::InAlloca);
1448 AttrCount += Attrs.hasAttribute(Attribute::StructRet) ||
1449 Attrs.hasAttribute(Attribute::InReg);
1450 AttrCount += Attrs.hasAttribute(Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001451 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1452 "and 'sret' are incompatible!",
1453 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001454
Reid Klecknera77172a2017-04-14 00:06:06 +00001455 Assert(!(Attrs.hasAttribute(Attribute::InAlloca) &&
1456 Attrs.hasAttribute(Attribute::ReadOnly)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001457 "Attributes "
1458 "'inalloca and readonly' are incompatible!",
1459 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001460
Reid Klecknera77172a2017-04-14 00:06:06 +00001461 Assert(!(Attrs.hasAttribute(Attribute::StructRet) &&
1462 Attrs.hasAttribute(Attribute::Returned)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001463 "Attributes "
1464 "'sret and returned' are incompatible!",
1465 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001466
Reid Klecknera77172a2017-04-14 00:06:06 +00001467 Assert(!(Attrs.hasAttribute(Attribute::ZExt) &&
1468 Attrs.hasAttribute(Attribute::SExt)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001469 "Attributes "
1470 "'zeroext and signext' are incompatible!",
1471 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001472
Reid Klecknera77172a2017-04-14 00:06:06 +00001473 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1474 Attrs.hasAttribute(Attribute::ReadOnly)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001475 "Attributes "
1476 "'readnone and readonly' are incompatible!",
1477 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001478
Reid Klecknera77172a2017-04-14 00:06:06 +00001479 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1480 Attrs.hasAttribute(Attribute::WriteOnly)),
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001481 "Attributes "
1482 "'readnone and writeonly' are incompatible!",
1483 V);
1484
Reid Klecknera77172a2017-04-14 00:06:06 +00001485 Assert(!(Attrs.hasAttribute(Attribute::ReadOnly) &&
1486 Attrs.hasAttribute(Attribute::WriteOnly)),
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001487 "Attributes "
1488 "'readonly and writeonly' are incompatible!",
1489 V);
1490
Reid Klecknera77172a2017-04-14 00:06:06 +00001491 Assert(!(Attrs.hasAttribute(Attribute::NoInline) &&
1492 Attrs.hasAttribute(Attribute::AlwaysInline)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001493 "Attributes "
1494 "'noinline and alwaysinline' are incompatible!",
1495 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001496
Reid Klecknera77172a2017-04-14 00:06:06 +00001497 AttrBuilder IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty);
1498 Assert(!AttrBuilder(Attrs).overlaps(IncompatibleAttrs),
1499 "Wrong types for attribute: " +
1500 AttributeSet::get(Context, IncompatibleAttrs).getAsString(),
1501 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001502
Reid Klecknera534a382013-12-19 02:14:12 +00001503 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001504 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001505 if (!PTy->getElementType()->isSized(&Visited)) {
Reid Klecknera77172a2017-04-14 00:06:06 +00001506 Assert(!Attrs.hasAttribute(Attribute::ByVal) &&
1507 !Attrs.hasAttribute(Attribute::InAlloca),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001508 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1509 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001510 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001511 if (!isa<PointerType>(PTy->getElementType()))
Reid Klecknera77172a2017-04-14 00:06:06 +00001512 Assert(!Attrs.hasAttribute(Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00001513 "Attribute 'swifterror' only applies to parameters "
1514 "with pointer to pointer type!",
1515 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001516 } else {
Reid Klecknera77172a2017-04-14 00:06:06 +00001517 Assert(!Attrs.hasAttribute(Attribute::ByVal),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001518 "Attribute 'byval' only applies to parameters with pointer type!",
1519 V);
Reid Klecknera77172a2017-04-14 00:06:06 +00001520 Assert(!Attrs.hasAttribute(Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00001521 "Attribute 'swifterror' only applies to parameters "
1522 "with pointer type!",
1523 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001524 }
Duncan Sands0009c442008-01-12 16:42:01 +00001525}
1526
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001527// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001528// The value V is printed in error messages.
Reid Klecknerb5180542017-03-21 16:57:19 +00001529void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001530 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001531 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001532 return;
1533
Duncan Sands8c582282007-12-21 19:19:01 +00001534 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001535 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001536 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001537 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001538 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001539
Reid Klecknera77172a2017-04-14 00:06:06 +00001540 // Verify return value attributes.
1541 AttributeSet RetAttrs = Attrs.getRetAttributes();
1542 Assert((!RetAttrs.hasAttribute(Attribute::ByVal) &&
1543 !RetAttrs.hasAttribute(Attribute::Nest) &&
1544 !RetAttrs.hasAttribute(Attribute::StructRet) &&
1545 !RetAttrs.hasAttribute(Attribute::NoCapture) &&
1546 !RetAttrs.hasAttribute(Attribute::Returned) &&
1547 !RetAttrs.hasAttribute(Attribute::InAlloca) &&
1548 !RetAttrs.hasAttribute(Attribute::SwiftSelf) &&
1549 !RetAttrs.hasAttribute(Attribute::SwiftError)),
1550 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
1551 "'returned', 'swiftself', and 'swifterror' do not apply to return "
1552 "values!",
1553 V);
1554 Assert((!RetAttrs.hasAttribute(Attribute::ReadOnly) &&
1555 !RetAttrs.hasAttribute(Attribute::WriteOnly) &&
1556 !RetAttrs.hasAttribute(Attribute::ReadNone)),
1557 "Attribute '" + RetAttrs.getAsString() +
1558 "' does not apply to function returns",
1559 V);
1560 verifyParameterAttrs(RetAttrs, FT->getReturnType(), V);
Duncan Sands8c582282007-12-21 19:19:01 +00001561
Reid Klecknera77172a2017-04-14 00:06:06 +00001562 // Verify parameter attributes.
1563 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1564 Type *Ty = FT->getParamType(i);
1565 AttributeSet ArgAttrs = Attrs.getParamAttributes(i);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001566
Reid Klecknera77172a2017-04-14 00:06:06 +00001567 verifyParameterAttrs(ArgAttrs, Ty, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001568
Reid Klecknera77172a2017-04-14 00:06:06 +00001569 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001570 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001571 SawNest = true;
1572 }
1573
Reid Klecknera77172a2017-04-14 00:06:06 +00001574 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001575 Assert(!SawReturned, "More than one parameter has attribute returned!",
1576 V);
1577 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
Reid Klecknera77172a2017-04-14 00:06:06 +00001578 "Incompatible argument and return types for 'returned' attribute",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001579 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001580 SawReturned = true;
1581 }
1582
Reid Klecknera77172a2017-04-14 00:06:06 +00001583 if (ArgAttrs.hasAttribute(Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001584 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
Reid Klecknera77172a2017-04-14 00:06:06 +00001585 Assert(i == 0 || i == 1,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001586 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001587 SawSRet = true;
1588 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001589
Reid Klecknera77172a2017-04-14 00:06:06 +00001590 if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) {
Manman Renf46262e2016-03-29 17:37:21 +00001591 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1592 SawSwiftSelf = true;
1593 }
1594
Reid Klecknera77172a2017-04-14 00:06:06 +00001595 if (ArgAttrs.hasAttribute(Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00001596 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1597 V);
1598 SawSwiftError = true;
1599 }
1600
Reid Klecknera77172a2017-04-14 00:06:06 +00001601 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) {
1602 Assert(i == FT->getNumParams() - 1,
1603 "inalloca isn't on the last parameter!", V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001604 }
Duncan Sands8c582282007-12-21 19:19:01 +00001605 }
Devang Patel9cc98122008-10-01 23:41:25 +00001606
Reid Klecknerb5180542017-03-21 16:57:19 +00001607 if (!Attrs.hasAttributes(AttributeList::FunctionIndex))
Bill Wendling77543892013-01-18 21:11:39 +00001608 return;
1609
Reid Klecknera77172a2017-04-14 00:06:06 +00001610 verifyAttributeTypes(Attrs.getFnAttributes(), /*IsFunction=*/true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001611
Reid Klecknera77172a2017-04-14 00:06:06 +00001612 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1613 Attrs.hasFnAttribute(Attribute::ReadOnly)),
1614 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001615
Reid Klecknera77172a2017-04-14 00:06:06 +00001616 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1617 Attrs.hasFnAttribute(Attribute::WriteOnly)),
1618 "Attributes 'readnone and writeonly' are incompatible!", V);
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001619
Reid Klecknera77172a2017-04-14 00:06:06 +00001620 Assert(!(Attrs.hasFnAttribute(Attribute::ReadOnly) &&
1621 Attrs.hasFnAttribute(Attribute::WriteOnly)),
1622 "Attributes 'readonly and writeonly' are incompatible!", V);
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001623
Reid Klecknera77172a2017-04-14 00:06:06 +00001624 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1625 Attrs.hasFnAttribute(Attribute::InaccessibleMemOrArgMemOnly)),
1626 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are "
1627 "incompatible!",
1628 V);
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001629
Reid Klecknera77172a2017-04-14 00:06:06 +00001630 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1631 Attrs.hasFnAttribute(Attribute::InaccessibleMemOnly)),
1632 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001633
Reid Klecknera77172a2017-04-14 00:06:06 +00001634 Assert(!(Attrs.hasFnAttribute(Attribute::NoInline) &&
1635 Attrs.hasFnAttribute(Attribute::AlwaysInline)),
1636 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001637
Reid Klecknera77172a2017-04-14 00:06:06 +00001638 if (Attrs.hasFnAttribute(Attribute::OptimizeNone)) {
1639 Assert(Attrs.hasFnAttribute(Attribute::NoInline),
1640 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001641
Reid Klecknera77172a2017-04-14 00:06:06 +00001642 Assert(!Attrs.hasFnAttribute(Attribute::OptimizeForSize),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001643 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001644
Reid Klecknera77172a2017-04-14 00:06:06 +00001645 Assert(!Attrs.hasFnAttribute(Attribute::MinSize),
1646 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001647 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001648
Reid Klecknera77172a2017-04-14 00:06:06 +00001649 if (Attrs.hasFnAttribute(Attribute::JumpTable)) {
Tom Roeder44cb65f2014-06-05 19:29:43 +00001650 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001651 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001652 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001653 }
George Burgess IV278199f2016-04-12 01:05:35 +00001654
Reid Klecknera77172a2017-04-14 00:06:06 +00001655 if (Attrs.hasFnAttribute(Attribute::AllocSize)) {
George Burgess IV278199f2016-04-12 01:05:35 +00001656 std::pair<unsigned, Optional<unsigned>> Args =
Reid Klecknerb5180542017-03-21 16:57:19 +00001657 Attrs.getAllocSizeArgs(AttributeList::FunctionIndex);
George Burgess IV278199f2016-04-12 01:05:35 +00001658
1659 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1660 if (ParamNo >= FT->getNumParams()) {
1661 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1662 return false;
1663 }
1664
1665 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1666 CheckFailed("'allocsize' " + Name +
1667 " argument must refer to an integer parameter",
1668 V);
1669 return false;
1670 }
1671
1672 return true;
1673 };
1674
1675 if (!CheckParam("element size", Args.first))
1676 return;
1677
1678 if (Args.second && !CheckParam("number of elements", *Args.second))
1679 return;
1680 }
Duncan Sands8c582282007-12-21 19:19:01 +00001681}
1682
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001683void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001684 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001685 for (const auto &Pair : MDs) {
1686 if (Pair.first == LLVMContext::MD_prof) {
1687 MDNode *MD = Pair.second;
Dehao Chena60cdd32017-02-28 18:09:44 +00001688 Assert(MD->getNumOperands() >= 2,
1689 "!prof annotations should have no less than 2 operands", MD);
Diego Novillo2567f3d2015-05-13 15:13:45 +00001690
1691 // Check first operand.
1692 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1693 MD);
1694 Assert(isa<MDString>(MD->getOperand(0)),
1695 "expected string with name of the !prof annotation", MD);
1696 MDString *MDS = cast<MDString>(MD->getOperand(0));
1697 StringRef ProfName = MDS->getString();
Easwaran Ramanbdf20262018-01-09 19:39:35 +00001698 Assert(ProfName.equals("function_entry_count") ||
1699 ProfName.equals("synthetic_function_entry_count"),
1700 "first operand should be 'function_entry_count'"
1701 " or 'synthetic_function_entry_count'",
1702 MD);
Diego Novillo2567f3d2015-05-13 15:13:45 +00001703
1704 // Check second operand.
1705 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1706 MD);
1707 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1708 "expected integer argument to function_entry_count", MD);
1709 }
1710 }
1711}
1712
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001713void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1714 if (!ConstantExprVisited.insert(EntryC).second)
1715 return;
1716
1717 SmallVector<const Constant *, 16> Stack;
1718 Stack.push_back(EntryC);
1719
1720 while (!Stack.empty()) {
1721 const Constant *C = Stack.pop_back_val();
1722
1723 // Check this constant expression.
1724 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1725 visitConstantExpr(CE);
1726
Keno Fischerf6d17b92016-01-14 22:42:02 +00001727 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1728 // Global Values get visited separately, but we do need to make sure
1729 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001730 Assert(GV->getParent() == &M, "Referencing global in another module!",
1731 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001732 continue;
1733 }
1734
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001735 // Visit all sub-expressions.
1736 for (const Use &U : C->operands()) {
1737 const auto *OpC = dyn_cast<Constant>(U);
1738 if (!OpC)
1739 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001740 if (!ConstantExprVisited.insert(OpC).second)
1741 continue;
1742 Stack.push_back(OpC);
1743 }
1744 }
1745}
1746
1747void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001748 if (CE->getOpcode() == Instruction::BitCast)
1749 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1750 CE->getType()),
1751 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001752
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001753 if (CE->getOpcode() == Instruction::IntToPtr ||
1754 CE->getOpcode() == Instruction::PtrToInt) {
1755 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1756 ? CE->getType()
1757 : CE->getOperand(0)->getType();
1758 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1759 ? "inttoptr not supported for non-integral pointers"
1760 : "ptrtoint not supported for non-integral pointers";
1761 Assert(
1762 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1763 Msg);
1764 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001765}
1766
Reid Klecknerb5180542017-03-21 16:57:19 +00001767bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) {
Reid Kleckner8bf67fe2017-05-23 17:01:48 +00001768 // There shouldn't be more attribute sets than there are parameters plus the
1769 // function and return value.
1770 return Attrs.getNumAttrSets() <= Params + 2;
Devang Patel82fed672008-09-23 22:35:17 +00001771}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001772
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001773/// Verify that statepoint intrinsic is well formed.
1774void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001775 assert(CS.getCalledFunction() &&
1776 CS.getCalledFunction()->getIntrinsicID() ==
1777 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001778
Philip Reames0285c742015-02-03 23:18:47 +00001779 const Instruction &CI = *CS.getInstruction();
1780
Igor Laevsky39d662f2015-07-11 10:30:36 +00001781 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1782 !CS.onlyAccessesArgMemory(),
1783 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001784 "reordering restrictions required by safepoint semantics",
1785 &CI);
1786
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001787 const Value *IDV = CS.getArgument(0);
1788 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1789 &CI);
1790
1791 const Value *NumPatchBytesV = CS.getArgument(1);
1792 Assert(isa<ConstantInt>(NumPatchBytesV),
1793 "gc.statepoint number of patchable bytes must be a constant integer",
1794 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001795 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001796 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1797 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1798 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1799 "positive",
1800 &CI);
1801
1802 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001803 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001804 Assert(PT && PT->getElementType()->isFunctionTy(),
1805 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001806 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001807
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001808 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001809 Assert(isa<ConstantInt>(NumCallArgsV),
1810 "gc.statepoint number of arguments to underlying call "
1811 "must be constant integer",
1812 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001813 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001814 Assert(NumCallArgs >= 0,
1815 "gc.statepoint number of arguments to underlying call "
1816 "must be positive",
1817 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001818 const int NumParams = (int)TargetFuncType->getNumParams();
1819 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001820 Assert(NumCallArgs >= NumParams,
1821 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001822
1823 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001824 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1825 "gc.statepoint doesn't support wrapping non-void "
1826 "vararg functions yet",
1827 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001828 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001829 Assert(NumCallArgs == NumParams,
1830 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001831
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001832 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001833 Assert(isa<ConstantInt>(FlagsV),
1834 "gc.statepoint flags must be constant integer", &CI);
1835 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1836 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1837 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001838
1839 // Verify that the types of the call parameter arguments match
1840 // the type of the wrapped callee.
1841 for (int i = 0; i < NumParams; i++) {
1842 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001843 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001844 Assert(ArgType == ParamType,
1845 "gc.statepoint call argument does not match wrapped "
1846 "function type",
1847 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001848 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001849
1850 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001851
1852 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1853 Assert(isa<ConstantInt>(NumTransitionArgsV),
1854 "gc.statepoint number of transition arguments "
1855 "must be constant integer",
1856 &CI);
1857 const int NumTransitionArgs =
1858 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1859 Assert(NumTransitionArgs >= 0,
1860 "gc.statepoint number of transition arguments must be positive", &CI);
1861 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1862
1863 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001864 Assert(isa<ConstantInt>(NumDeoptArgsV),
1865 "gc.statepoint number of deoptimization arguments "
1866 "must be constant integer",
1867 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001868 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001869 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1870 "must be positive",
1871 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001872
Pat Gavlincc0431d2015-05-08 18:07:42 +00001873 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001874 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001875 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001876 "gc.statepoint too few arguments according to length fields", &CI);
1877
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001878 // Check that the only uses of this gc.statepoint are gc.result or
Philip Reames1ffa9372015-01-30 23:28:05 +00001879 // gc.relocate calls which are tied to this statepoint and thus part
1880 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001881 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001882 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001883 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001884 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001885 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001886 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001887 "of a gc.statepoint",
1888 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001889 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001890 Assert(Call->getArgOperand(0) == &CI,
1891 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001892 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001893 Assert(Call->getArgOperand(0) == &CI,
1894 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001895 }
1896 }
1897
1898 // Note: It is legal for a single derived pointer to be listed multiple
1899 // times. It's non-optimal, but it is legal. It can also happen after
1900 // insertion if we strip a bitcast away.
1901 // Note: It is really tempting to check that each base is relocated and
1902 // that a derived pointer is never reused as a base pointer. This turns
1903 // out to be problematic since optimizations run after safepoint insertion
1904 // can recognize equality properties that the insertion logic doesn't know
1905 // about. See example statepoint.ll in the verifier subdirectory
1906}
1907
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001908void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001909 for (auto &Counts : FrameEscapeInfo) {
1910 Function *F = Counts.first;
1911 unsigned EscapedObjectCount = Counts.second.first;
1912 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001913 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001914 "all indices passed to llvm.localrecover must be less than the "
1915 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001916 "function",
1917 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001918 }
1919}
1920
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001921static Instruction *getSuccPad(TerminatorInst *Terminator) {
1922 BasicBlock *UnwindDest;
1923 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1924 UnwindDest = II->getUnwindDest();
1925 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1926 UnwindDest = CSI->getUnwindDest();
1927 else
1928 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1929 return UnwindDest->getFirstNonPHI();
1930}
1931
1932void Verifier::verifySiblingFuncletUnwinds() {
1933 SmallPtrSet<Instruction *, 8> Visited;
1934 SmallPtrSet<Instruction *, 8> Active;
1935 for (const auto &Pair : SiblingFuncletInfo) {
1936 Instruction *PredPad = Pair.first;
1937 if (Visited.count(PredPad))
1938 continue;
1939 Active.insert(PredPad);
1940 TerminatorInst *Terminator = Pair.second;
1941 do {
1942 Instruction *SuccPad = getSuccPad(Terminator);
1943 if (Active.count(SuccPad)) {
1944 // Found a cycle; report error
1945 Instruction *CyclePad = SuccPad;
1946 SmallVector<Instruction *, 8> CycleNodes;
1947 do {
1948 CycleNodes.push_back(CyclePad);
1949 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1950 if (CycleTerminator != CyclePad)
1951 CycleNodes.push_back(CycleTerminator);
1952 CyclePad = getSuccPad(CycleTerminator);
1953 } while (CyclePad != SuccPad);
1954 Assert(false, "EH pads can't handle each other's exceptions",
1955 ArrayRef<Instruction *>(CycleNodes));
1956 }
1957 // Don't re-walk a node we've already checked
1958 if (!Visited.insert(SuccPad).second)
1959 break;
1960 // Walk to this successor if it has a map entry.
1961 PredPad = SuccPad;
1962 auto TermI = SiblingFuncletInfo.find(PredPad);
1963 if (TermI == SiblingFuncletInfo.end())
1964 break;
1965 Terminator = TermI->second;
1966 Active.insert(PredPad);
1967 } while (true);
1968 // Each node only has one successor, so we've walked all the active
1969 // nodes' successors.
1970 Active.clear();
1971 }
1972}
1973
Chris Lattner0e851da2002-04-18 20:37:37 +00001974// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001975//
Chandler Carruth043949d2014-01-19 02:22:18 +00001976void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001977 visitGlobalValue(F);
1978
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001979 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001980 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001981 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001982
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001983 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001984 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001985
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001986 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1987 Assert(FT->getNumParams() == NumArgs,
1988 "# formal arguments must match # of arguments for function type!", &F,
1989 FT);
1990 Assert(F.getReturnType()->isFirstClassType() ||
1991 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1992 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001993
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001994 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1995 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001996
Reid Klecknerb5180542017-03-21 16:57:19 +00001997 AttributeList Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001998
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001999 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002000 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002001
Duncan Sands8c582282007-12-21 19:19:01 +00002002 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002003 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00002004
Michael Gottesman41748d72013-06-27 00:25:01 +00002005 // On function declarations/definitions, we do not support the builtin
2006 // attribute. We do not check this in VerifyFunctionAttrs since that is
2007 // checking for Attributes that can/can not ever be on functions.
Reid Klecknera77172a2017-04-14 00:06:06 +00002008 Assert(!Attrs.hasFnAttribute(Attribute::Builtin),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002009 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00002010
Chris Lattneref13ee32006-05-19 21:25:17 +00002011 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00002012 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
2013 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00002014 switch (F.getCallingConv()) {
2015 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00002016 case CallingConv::C:
2017 break;
Matt Arsenault33339682017-04-04 18:43:11 +00002018 case CallingConv::AMDGPU_KERNEL:
2019 case CallingConv::SPIR_KERNEL:
2020 Assert(F.getReturnType()->isVoidTy(),
2021 "Calling convention requires void return type", &F);
2022 LLVM_FALLTHROUGH;
2023 case CallingConv::AMDGPU_VS:
Marek Olsaka302a7362017-05-02 15:41:10 +00002024 case CallingConv::AMDGPU_HS:
Matt Arsenault33339682017-04-04 18:43:11 +00002025 case CallingConv::AMDGPU_GS:
2026 case CallingConv::AMDGPU_PS:
2027 case CallingConv::AMDGPU_CS:
2028 Assert(!F.hasStructRetAttr(),
2029 "Calling convention does not allow sret", &F);
2030 LLVM_FALLTHROUGH;
Chris Lattneref13ee32006-05-19 21:25:17 +00002031 case CallingConv::Fast:
2032 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00002033 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00002034 case CallingConv::PTX_Kernel:
2035 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002036 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
2037 "perfect forwarding!",
2038 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00002039 break;
2040 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00002041
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002042 bool isLLVMdotName = F.getName().size() >= 5 &&
2043 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002044
Chris Lattneraf95e582002-04-13 22:48:46 +00002045 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00002046 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002047 for (const Argument &Arg : F.args()) {
2048 Assert(Arg.getType() == FT->getParamType(i),
2049 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002050 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002051 Assert(Arg.getType()->isFirstClassType(),
2052 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00002053 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002054 Assert(!Arg.getType()->isMetadataTy(),
2055 "Function takes metadata but isn't an intrinsic", &Arg, &F);
2056 Assert(!Arg.getType()->isTokenTy(),
2057 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00002058 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00002059
2060 // Check that swifterror argument is only used by loads and stores.
Reid Klecknerf021fab2017-04-13 23:12:13 +00002061 if (Attrs.hasParamAttribute(i, Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002062 verifySwiftErrorValue(&Arg);
2063 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002064 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00002065 }
Chris Lattneraf95e582002-04-13 22:48:46 +00002066
David Majnemerb611e3f2015-08-14 05:09:07 +00002067 if (!isLLVMdotName)
2068 Assert(!F.getReturnType()->isTokenTy(),
2069 "Functions returns a token but isn't an intrinsic", &F);
2070
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002071 // Get the function metadata attachments.
2072 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2073 F.getAllMetadata(MDs);
2074 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002075 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002076
Keno Fischer2ac0c272015-11-16 05:13:30 +00002077 // Check validity of the personality function
2078 if (F.hasPersonalityFn()) {
2079 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2080 if (Per)
2081 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002082 "Referencing personality function in another module!",
2083 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002084 }
2085
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002086 if (F.isMaterializable()) {
2087 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002088 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2089 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002090 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002091 for (const auto &I : MDs) {
2092 AssertDI(I.first != LLVMContext::MD_dbg,
2093 "function declaration may not have a !dbg attachment", &F);
2094 Assert(I.first != LLVMContext::MD_prof,
2095 "function declaration may not have a !prof attachment", &F);
2096
2097 // Verify the metadata itself.
2098 visitMDNode(*I.second);
2099 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002100 Assert(!F.hasPersonalityFn(),
2101 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002102 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002103 // Verify that this function (which has a body) is not named "llvm.*". It
2104 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002105 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002106
Chris Lattner149376d2002-10-13 20:57:00 +00002107 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002108 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002109 Assert(pred_empty(Entry),
2110 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002111
Chris Lattner27471742009-11-01 04:08:01 +00002112 // The address of the entry block cannot be taken, unless it is dead.
2113 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002114 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2115 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002116 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002117
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002118 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002119 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002120 for (const auto &I : MDs) {
2121 // Verify that the attachment is legal.
2122 switch (I.first) {
2123 default:
2124 break;
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002125 case LLVMContext::MD_dbg: {
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002126 ++NumDebugAttachments;
2127 AssertDI(NumDebugAttachments == 1,
2128 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002129 AssertDI(isa<DISubprogram>(I.second),
2130 "function !dbg attachment must be a subprogram", &F, I.second);
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002131 auto *SP = cast<DISubprogram>(I.second);
2132 const Function *&AttachedTo = DISubprogramAttachments[SP];
2133 AssertDI(!AttachedTo || AttachedTo == &F,
2134 "DISubprogram attached to more than one function", SP, &F);
2135 AttachedTo = &F;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002136 break;
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002137 }
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002138 case LLVMContext::MD_prof:
2139 ++NumProfAttachments;
2140 Assert(NumProfAttachments == 1,
2141 "function must have a single !prof attachment", &F, I.second);
2142 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002143 }
2144
2145 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002146 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002147 }
Chris Lattner149376d2002-10-13 20:57:00 +00002148 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002149
Chris Lattner7730dcc2009-09-11 17:05:29 +00002150 // If this function is actually an intrinsic, verify that it is only used in
2151 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002152 // Only do this if the module is materialized, otherwise we don't have all the
2153 // uses.
2154 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002155 const User *U;
2156 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002157 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002158 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002159
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002160 Assert(!F.hasDLLImportStorageClass() ||
2161 (F.isDeclaration() && F.hasExternalLinkage()) ||
2162 F.hasAvailableExternallyLinkage(),
2163 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002164
2165 auto *N = F.getSubprogram();
Adrian Prantl63d96952017-03-07 17:28:54 +00002166 HasDebugInfo = (N != nullptr);
Adrian Prantl39c6fa62017-03-07 17:50:51 +00002167 if (!HasDebugInfo)
Peter Collingbourned4bff302015-11-05 22:03:56 +00002168 return;
2169
2170 // Check that all !dbg attachments lead to back to N (or, at least, another
2171 // subprogram that describes the same function).
2172 //
2173 // FIXME: Check this incrementally while visiting !dbg attachments.
2174 // FIXME: Only check when N is the canonical subprogram for F.
2175 SmallPtrSet<const MDNode *, 32> Seen;
2176 for (auto &BB : F)
2177 for (auto &I : BB) {
2178 // Be careful about using DILocation here since we might be dealing with
2179 // broken code (this is the Verifier after all).
2180 DILocation *DL =
2181 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2182 if (!DL)
2183 continue;
2184 if (!Seen.insert(DL).second)
2185 continue;
2186
2187 DILocalScope *Scope = DL->getInlinedAtScope();
2188 if (Scope && !Seen.insert(Scope).second)
2189 continue;
2190
2191 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002192
2193 // Scope and SP could be the same MDNode and we don't want to skip
2194 // validation in that case
2195 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002196 continue;
2197
2198 // FIXME: Once N is canonical, check "SP == &N".
Adrian Prantla2ef0472016-09-14 17:30:37 +00002199 AssertDI(SP->describes(&F),
2200 "!dbg attachment points at wrong subprogram for function", N, &F,
2201 &I, DL, Scope, SP);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002202 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002203}
2204
Chris Lattner0e851da2002-04-18 20:37:37 +00002205// verifyBasicBlock - Verify that a basic block is well formed...
2206//
Chris Lattner069a7952002-06-25 15:56:27 +00002207void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002208 InstsInThisBlock.clear();
2209
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002210 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002211 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002212
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002213 // Check constraints that this basic block imposes on all of the PHI nodes in
2214 // it.
2215 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002216 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2217 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002218 std::sort(Preds.begin(), Preds.end());
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002219 for (const PHINode &PN : BB.phis()) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002220 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002221 Assert(PN.getNumIncomingValues() != 0,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002222 "PHI nodes must have at least one entry. If the block is dead, "
2223 "the PHI should be removed!",
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002224 &PN);
2225 Assert(PN.getNumIncomingValues() == Preds.size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002226 "PHINode should have one entry for each predecessor of its "
2227 "parent basic block!",
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002228 &PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002229
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002230 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002231 Values.clear();
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002232 Values.reserve(PN.getNumIncomingValues());
2233 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
2234 Values.push_back(
2235 std::make_pair(PN.getIncomingBlock(i), PN.getIncomingValue(i)));
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002236 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002237
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002238 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2239 // Check to make sure that if there is more than one entry for a
2240 // particular basic block in this PHI node, that the incoming values are
2241 // all identical.
2242 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002243 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2244 Values[i].second == Values[i - 1].second,
2245 "PHI node has multiple entries for the same basic block with "
2246 "different incoming values!",
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002247 &PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002248
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002249 // Check to make sure that the predecessors and PHI node entries are
2250 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002251 Assert(Values[i].first == Preds[i],
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002252 "PHI node entries do not match predecessors!", &PN,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002253 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002254 }
2255 }
2256 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002257
2258 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002259 for (auto &I : BB)
2260 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002261 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002262 }
Chris Lattner069a7952002-06-25 15:56:27 +00002263}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002264
Chris Lattner069a7952002-06-25 15:56:27 +00002265void Verifier::visitTerminatorInst(TerminatorInst &I) {
2266 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002267 Assert(&I == I.getParent()->getTerminator(),
2268 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002269 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002270}
2271
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002272void Verifier::visitBranchInst(BranchInst &BI) {
2273 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002274 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2275 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002276 }
2277 visitTerminatorInst(BI);
2278}
2279
Chris Lattner069a7952002-06-25 15:56:27 +00002280void Verifier::visitReturnInst(ReturnInst &RI) {
2281 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002282 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002283 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002284 Assert(N == 0,
2285 "Found return instr that returns non-void in Function of void "
2286 "return type!",
2287 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002288 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002289 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2290 "Function return type does not match operand "
2291 "type of return inst!",
2292 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002293
Misha Brukman7eb05a12003-08-18 14:43:39 +00002294 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002295 // terminators...
2296 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002297}
2298
Chris Lattnerab5aa142004-05-21 16:47:21 +00002299void Verifier::visitSwitchInst(SwitchInst &SI) {
2300 // Check to make sure that all of the constants in the switch instruction
2301 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002302 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002303 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002304 for (auto &Case : SI.cases()) {
2305 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002306 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002307 Assert(Constants.insert(Case.getCaseValue()).second,
2308 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002309 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002310
Chris Lattnerab5aa142004-05-21 16:47:21 +00002311 visitTerminatorInst(SI);
2312}
2313
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002314void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002315 Assert(BI.getAddress()->getType()->isPointerTy(),
2316 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002317 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002318 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2319 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002320
2321 visitTerminatorInst(BI);
2322}
2323
Chris Lattner75648e72004-03-12 05:54:31 +00002324void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002325 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2326 SI.getOperand(2)),
2327 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002328
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002329 Assert(SI.getTrueValue()->getType() == SI.getType(),
2330 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002331 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002332}
2333
Misha Brukmanc566ca362004-03-02 00:22:19 +00002334/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2335/// a pass, if any exist, it's an error.
2336///
Chris Lattner903a25d2002-11-21 16:54:22 +00002337void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002338 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002339}
Chris Lattner0e851da2002-04-18 20:37:37 +00002340
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002341void Verifier::visitTruncInst(TruncInst &I) {
2342 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002343 Type *SrcTy = I.getOperand(0)->getType();
2344 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002345
2346 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002347 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2348 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002349
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002350 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2351 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2352 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2353 "trunc source and destination must both be a vector or neither", &I);
2354 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002355
2356 visitInstruction(I);
2357}
2358
2359void Verifier::visitZExtInst(ZExtInst &I) {
2360 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002361 Type *SrcTy = I.getOperand(0)->getType();
2362 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002363
2364 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002365 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2366 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2367 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2368 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002369 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2370 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002371
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002372 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002373
2374 visitInstruction(I);
2375}
2376
2377void Verifier::visitSExtInst(SExtInst &I) {
2378 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002379 Type *SrcTy = I.getOperand(0)->getType();
2380 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002381
2382 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002383 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2384 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002385
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002386 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2387 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2388 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2389 "sext source and destination must both be a vector or neither", &I);
2390 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002391
2392 visitInstruction(I);
2393}
2394
2395void Verifier::visitFPTruncInst(FPTruncInst &I) {
2396 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002397 Type *SrcTy = I.getOperand(0)->getType();
2398 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002399 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002400 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2401 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002402
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002403 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2404 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2405 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2406 "fptrunc source and destination must both be a vector or neither", &I);
2407 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002408
2409 visitInstruction(I);
2410}
2411
2412void Verifier::visitFPExtInst(FPExtInst &I) {
2413 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002414 Type *SrcTy = I.getOperand(0)->getType();
2415 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002416
2417 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002418 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2419 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002420
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002421 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2422 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2423 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2424 "fpext source and destination must both be a vector or neither", &I);
2425 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002426
2427 visitInstruction(I);
2428}
2429
2430void Verifier::visitUIToFPInst(UIToFPInst &I) {
2431 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002432 Type *SrcTy = I.getOperand(0)->getType();
2433 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002434
Duncan Sands19d0b472010-02-16 11:11:14 +00002435 bool SrcVec = SrcTy->isVectorTy();
2436 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002437
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002438 Assert(SrcVec == DstVec,
2439 "UIToFP source and dest must both be vector or scalar", &I);
2440 Assert(SrcTy->isIntOrIntVectorTy(),
2441 "UIToFP source must be integer or integer vector", &I);
2442 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2443 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002444
2445 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002446 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2447 cast<VectorType>(DestTy)->getNumElements(),
2448 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002449
2450 visitInstruction(I);
2451}
2452
2453void Verifier::visitSIToFPInst(SIToFPInst &I) {
2454 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002455 Type *SrcTy = I.getOperand(0)->getType();
2456 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002457
Duncan Sands19d0b472010-02-16 11:11:14 +00002458 bool SrcVec = SrcTy->isVectorTy();
2459 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002460
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002461 Assert(SrcVec == DstVec,
2462 "SIToFP source and dest must both be vector or scalar", &I);
2463 Assert(SrcTy->isIntOrIntVectorTy(),
2464 "SIToFP source must be integer or integer vector", &I);
2465 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2466 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002467
2468 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002469 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2470 cast<VectorType>(DestTy)->getNumElements(),
2471 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002472
2473 visitInstruction(I);
2474}
2475
2476void Verifier::visitFPToUIInst(FPToUIInst &I) {
2477 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002478 Type *SrcTy = I.getOperand(0)->getType();
2479 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002480
Duncan Sands19d0b472010-02-16 11:11:14 +00002481 bool SrcVec = SrcTy->isVectorTy();
2482 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002483
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002484 Assert(SrcVec == DstVec,
2485 "FPToUI source and dest must both be vector or scalar", &I);
2486 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2487 &I);
2488 Assert(DestTy->isIntOrIntVectorTy(),
2489 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002490
2491 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002492 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2493 cast<VectorType>(DestTy)->getNumElements(),
2494 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002495
2496 visitInstruction(I);
2497}
2498
2499void Verifier::visitFPToSIInst(FPToSIInst &I) {
2500 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002501 Type *SrcTy = I.getOperand(0)->getType();
2502 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002503
Duncan Sands19d0b472010-02-16 11:11:14 +00002504 bool SrcVec = SrcTy->isVectorTy();
2505 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002506
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002507 Assert(SrcVec == DstVec,
2508 "FPToSI source and dest must both be vector or scalar", &I);
2509 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2510 &I);
2511 Assert(DestTy->isIntOrIntVectorTy(),
2512 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002513
2514 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002515 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2516 cast<VectorType>(DestTy)->getNumElements(),
2517 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002518
2519 visitInstruction(I);
2520}
2521
2522void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2523 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002524 Type *SrcTy = I.getOperand(0)->getType();
2525 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002526
Craig Topper95d23472017-07-09 07:04:00 +00002527 Assert(SrcTy->isPtrOrPtrVectorTy(), "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002528
2529 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002530 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002531 "ptrtoint not supported for non-integral pointers");
2532
Craig Topper95d23472017-07-09 07:04:00 +00002533 Assert(DestTy->isIntOrIntVectorTy(), "PtrToInt result must be integral", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002534 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2535 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002536
2537 if (SrcTy->isVectorTy()) {
2538 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2539 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002540 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2541 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002542 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002543
2544 visitInstruction(I);
2545}
2546
2547void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2548 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002549 Type *SrcTy = I.getOperand(0)->getType();
2550 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002551
Craig Topper95d23472017-07-09 07:04:00 +00002552 Assert(SrcTy->isIntOrIntVectorTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002553 "IntToPtr source must be an integral", &I);
Craig Topper95d23472017-07-09 07:04:00 +00002554 Assert(DestTy->isPtrOrPtrVectorTy(), "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002555
2556 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002557 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002558 "inttoptr not supported for non-integral pointers");
2559
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002560 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2561 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002562 if (SrcTy->isVectorTy()) {
2563 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2564 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002565 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2566 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002567 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002568 visitInstruction(I);
2569}
2570
2571void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002572 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002573 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2574 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002575 visitInstruction(I);
2576}
2577
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002578void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2579 Type *SrcTy = I.getOperand(0)->getType();
2580 Type *DestTy = I.getType();
2581
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002582 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2583 &I);
2584 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2585 &I);
2586 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2587 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002588 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002589 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2590 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002591 visitInstruction(I);
2592}
2593
Misha Brukmanc566ca362004-03-02 00:22:19 +00002594/// visitPHINode - Ensure that a PHI node is well formed.
2595///
Chris Lattner069a7952002-06-25 15:56:27 +00002596void Verifier::visitPHINode(PHINode &PN) {
2597 // Ensure that the PHI nodes are all grouped together at the top of the block.
2598 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002599 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002600 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002601 Assert(&PN == &PN.getParent()->front() ||
2602 isa<PHINode>(--BasicBlock::iterator(&PN)),
2603 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002604
David Majnemerb611e3f2015-08-14 05:09:07 +00002605 // Check that a PHI doesn't yield a Token.
2606 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2607
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002608 // Check that all of the values of the PHI node have the same type as the
2609 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002610 for (Value *IncValue : PN.incoming_values()) {
2611 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002612 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002613 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002614
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002615 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002616
2617 visitInstruction(PN);
2618}
2619
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002620void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002621 Instruction *I = CS.getInstruction();
2622
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002623 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2624 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002625 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002626
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002627 Assert(FPTy->getElementType()->isFunctionTy(),
2628 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002629
2630 Assert(FPTy->getElementType() == CS.getFunctionType(),
2631 "Called function is not the same type as the call!", I);
2632
2633 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002634
2635 // Verify that the correct number of arguments are being passed
2636 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002637 Assert(CS.arg_size() >= FTy->getNumParams(),
2638 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002639 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002640 Assert(CS.arg_size() == FTy->getNumParams(),
2641 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002642
Chris Lattner609de002010-05-10 20:58:42 +00002643 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002644 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002645 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2646 "Call parameter type does not match function signature!",
2647 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002648
Reid Klecknerb5180542017-03-21 16:57:19 +00002649 AttributeList Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002650
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002651 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002652 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002653
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00002654 if (Attrs.hasAttribute(AttributeList::FunctionIndex, Attribute::Speculatable)) {
2655 // Don't allow speculatable on call sites, unless the underlying function
2656 // declaration is also speculatable.
2657 Function *Callee
2658 = dyn_cast<Function>(CS.getCalledValue()->stripPointerCasts());
2659 Assert(Callee && Callee->isSpeculatable(),
2660 "speculatable attribute may not apply to call sites", I);
2661 }
2662
Duncan Sands8c582282007-12-21 19:19:01 +00002663 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002664 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002665
David Majnemer91db08b2014-04-30 17:22:00 +00002666 // Conservatively check the inalloca argument.
2667 // We have a bug if we can find that there is an underlying alloca without
2668 // inalloca.
2669 if (CS.hasInAllocaArgument()) {
2670 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2671 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002672 Assert(AI->isUsedWithInAlloca(),
2673 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002674 }
2675
Manman Ren9bfd0d02016-04-01 21:41:15 +00002676 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002677 // make sure the underlying alloca/parameter it comes from has a swifterror as
2678 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002679 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Reid Klecknerfb502d22017-04-14 20:19:02 +00002680 if (CS.paramHasAttr(i, Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002681 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002682 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002683 Assert(AI->isSwiftError(),
2684 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002685 continue;
2686 }
2687 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2688 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2689 Assert(ArgI->hasSwiftErrorAttr(),
2690 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002691 }
2692
Stephen Linb8bd2322013-04-20 05:14:40 +00002693 if (FTy->isVarArg()) {
2694 // FIXME? is 'nest' even legal here?
2695 bool SawNest = false;
2696 bool SawReturned = false;
2697
Reid Klecknera77172a2017-04-14 00:06:06 +00002698 for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) {
2699 if (Attrs.hasParamAttribute(Idx, Attribute::Nest))
Stephen Linb8bd2322013-04-20 05:14:40 +00002700 SawNest = true;
Reid Klecknera77172a2017-04-14 00:06:06 +00002701 if (Attrs.hasParamAttribute(Idx, Attribute::Returned))
Stephen Linb8bd2322013-04-20 05:14:40 +00002702 SawReturned = true;
2703 }
2704
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002705 // Check attributes on the varargs part.
Reid Klecknera77172a2017-04-14 00:06:06 +00002706 for (unsigned Idx = FTy->getNumParams(); Idx < CS.arg_size(); ++Idx) {
2707 Type *Ty = CS.getArgument(Idx)->getType();
2708 AttributeSet ArgAttrs = Attrs.getParamAttributes(Idx);
2709 verifyParameterAttrs(ArgAttrs, Ty, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002710
Reid Klecknera77172a2017-04-14 00:06:06 +00002711 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002712 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002713 SawNest = true;
2714 }
2715
Reid Klecknera77172a2017-04-14 00:06:06 +00002716 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002717 Assert(!SawReturned, "More than one parameter has attribute returned!",
2718 I);
2719 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2720 "Incompatible argument and return types for 'returned' "
2721 "attribute",
2722 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002723 SawReturned = true;
2724 }
Duncan Sands0009c442008-01-12 16:42:01 +00002725
Reid Klecknera77172a2017-04-14 00:06:06 +00002726 Assert(!ArgAttrs.hasAttribute(Attribute::StructRet),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002727 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002728
Reid Klecknera77172a2017-04-14 00:06:06 +00002729 if (ArgAttrs.hasAttribute(Attribute::InAlloca))
2730 Assert(Idx == CS.arg_size() - 1, "inalloca isn't on the last argument!",
2731 I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002732 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002733 }
Duncan Sands8c582282007-12-21 19:19:01 +00002734
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002735 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002736 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002737 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002738 for (Type *ParamTy : FTy->params()) {
2739 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002740 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002741 Assert(!ParamTy->isTokenTy(),
2742 "Function has token parameter but isn't an intrinsic", I);
2743 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002744 }
2745
David Majnemerb611e3f2015-08-14 05:09:07 +00002746 // Verify that indirect calls don't return tokens.
2747 if (CS.getCalledFunction() == nullptr)
2748 Assert(!FTy->getReturnType()->isTokenTy(),
2749 "Return type cannot be token for indirect call!");
2750
Philip Reamesa3c6f002015-06-26 21:39:44 +00002751 if (Function *F = CS.getCalledFunction())
2752 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002753 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002754
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002755 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2756 // at most one "gc-transition" operand bundle.
2757 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2758 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002759 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002760 OperandBundleUse BU = CS.getOperandBundleAt(i);
2761 uint32_t Tag = BU.getTagID();
2762 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002763 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2764 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002765 } else if (Tag == LLVMContext::OB_gc_transition) {
2766 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2767 I);
2768 FoundGCTransitionBundle = true;
2769 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002770 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2771 FoundFuncletBundle = true;
2772 Assert(BU.Inputs.size() == 1,
2773 "Expected exactly one funclet bundle operand", I);
2774 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2775 "Funclet bundle operands should correspond to a FuncletPadInst",
2776 I);
2777 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002778 }
2779
Adrian Prantl93035c82016-04-24 22:23:13 +00002780 // Verify that each inlinable callsite of a debug-info-bearing function in a
2781 // debug-info-bearing function has a debug location attached to it. Failure to
2782 // do so causes assertion failures when the inliner sets up inline scope info.
2783 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2784 CS.getCalledFunction()->getSubprogram())
Adrian Prantlfb80e792017-03-06 21:05:14 +00002785 AssertDI(I->getDebugLoc(), "inlinable function call in a function with "
2786 "debug info must have a !dbg location",
2787 I);
Adrian Prantl93035c82016-04-24 22:23:13 +00002788
Duncan Sands8c582282007-12-21 19:19:01 +00002789 visitInstruction(*I);
2790}
2791
Reid Kleckner5772b772014-04-24 20:14:34 +00002792/// Two types are "congruent" if they are identical, or if they are both pointer
2793/// types with different pointee types and the same address space.
2794static bool isTypeCongruent(Type *L, Type *R) {
2795 if (L == R)
2796 return true;
2797 PointerType *PL = dyn_cast<PointerType>(L);
2798 PointerType *PR = dyn_cast<PointerType>(R);
2799 if (!PL || !PR)
2800 return false;
2801 return PL->getAddressSpace() == PR->getAddressSpace();
2802}
2803
Reid Klecknerb5180542017-03-21 16:57:19 +00002804static AttrBuilder getParameterABIAttributes(int I, AttributeList Attrs) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002805 static const Attribute::AttrKind ABIAttrs[] = {
2806 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002807 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2808 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002809 AttrBuilder Copy;
2810 for (auto AK : ABIAttrs) {
Reid Klecknerf021fab2017-04-13 23:12:13 +00002811 if (Attrs.hasParamAttribute(I, AK))
Reid Klecknerd20c9702014-05-15 23:58:57 +00002812 Copy.addAttribute(AK);
2813 }
Reid Klecknerf021fab2017-04-13 23:12:13 +00002814 if (Attrs.hasParamAttribute(I, Attribute::Alignment))
Reid Kleckner859f8b52017-04-28 20:34:27 +00002815 Copy.addAlignmentAttr(Attrs.getParamAlignment(I));
Reid Klecknerd20c9702014-05-15 23:58:57 +00002816 return Copy;
2817}
2818
Reid Kleckner5772b772014-04-24 20:14:34 +00002819void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002820 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002821
2822 // - The caller and callee prototypes must match. Pointer types of
2823 // parameters or return types may differ in pointee type, but not
2824 // address space.
2825 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002826 FunctionType *CallerTy = F->getFunctionType();
2827 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002828 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2829 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2830 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2831 "cannot guarantee tail call due to mismatched varargs", &CI);
2832 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2833 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002834 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002835 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002836 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2837 "cannot guarantee tail call due to mismatched parameter types", &CI);
2838 }
2839
2840 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002841 Assert(F->getCallingConv() == CI.getCallingConv(),
2842 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002843
2844 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2845 // returned, and inalloca, must match.
Reid Klecknerb5180542017-03-21 16:57:19 +00002846 AttributeList CallerAttrs = F->getAttributes();
2847 AttributeList CalleeAttrs = CI.getAttributes();
Reid Kleckner5772b772014-04-24 20:14:34 +00002848 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002849 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2850 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002851 Assert(CallerABIAttrs == CalleeABIAttrs,
2852 "cannot guarantee tail call due to mismatched ABI impacting "
2853 "function attributes",
2854 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002855 }
2856
2857 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2858 // or a pointer bitcast followed by a ret instruction.
2859 // - The ret instruction must return the (possibly bitcasted) value
2860 // produced by the call or void.
2861 Value *RetVal = &CI;
2862 Instruction *Next = CI.getNextNode();
2863
2864 // Handle the optional bitcast.
2865 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002866 Assert(BI->getOperand(0) == RetVal,
2867 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002868 RetVal = BI;
2869 Next = BI->getNextNode();
2870 }
2871
2872 // Check the return.
2873 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002874 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2875 &CI);
2876 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2877 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002878}
2879
Duncan Sands8c582282007-12-21 19:19:01 +00002880void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002881 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002882
Reid Kleckner5772b772014-04-24 20:14:34 +00002883 if (CI.isMustTailCall())
2884 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002885}
2886
2887void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002888 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002889
David Majnemer654e1302015-07-31 17:58:14 +00002890 // Verify that the first non-PHI instruction of the unwind destination is an
2891 // exception handling instruction.
2892 Assert(
2893 II.getUnwindDest()->isEHPad(),
2894 "The unwind destination does not have an exception handling instruction!",
2895 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002896
Dan Gohman9c6e1882010-08-02 23:09:14 +00002897 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002898}
Chris Lattner0e851da2002-04-18 20:37:37 +00002899
Misha Brukmanc566ca362004-03-02 00:22:19 +00002900/// visitBinaryOperator - Check that both arguments to the binary operator are
2901/// of the same type!
2902///
Chris Lattner069a7952002-06-25 15:56:27 +00002903void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002904 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2905 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002906
Reid Spencer2341c222007-02-02 02:16:23 +00002907 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002908 // Check that integer arithmetic operators are only used with
2909 // integral operands.
2910 case Instruction::Add:
2911 case Instruction::Sub:
2912 case Instruction::Mul:
2913 case Instruction::SDiv:
2914 case Instruction::UDiv:
2915 case Instruction::SRem:
2916 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002917 Assert(B.getType()->isIntOrIntVectorTy(),
2918 "Integer arithmetic operators only work with integral types!", &B);
2919 Assert(B.getType() == B.getOperand(0)->getType(),
2920 "Integer arithmetic operators must have same type "
2921 "for operands and result!",
2922 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002923 break;
2924 // Check that floating-point arithmetic operators are only used with
2925 // floating-point operands.
2926 case Instruction::FAdd:
2927 case Instruction::FSub:
2928 case Instruction::FMul:
2929 case Instruction::FDiv:
2930 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002931 Assert(B.getType()->isFPOrFPVectorTy(),
2932 "Floating-point arithmetic operators only work with "
2933 "floating-point types!",
2934 &B);
2935 Assert(B.getType() == B.getOperand(0)->getType(),
2936 "Floating-point arithmetic operators must have same type "
2937 "for operands and result!",
2938 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002939 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002940 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002941 case Instruction::And:
2942 case Instruction::Or:
2943 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002944 Assert(B.getType()->isIntOrIntVectorTy(),
2945 "Logical operators only work with integral types!", &B);
2946 Assert(B.getType() == B.getOperand(0)->getType(),
2947 "Logical operators must have same type for operands and result!",
2948 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002949 break;
2950 case Instruction::Shl:
2951 case Instruction::LShr:
2952 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002953 Assert(B.getType()->isIntOrIntVectorTy(),
2954 "Shifts only work with integral types!", &B);
2955 Assert(B.getType() == B.getOperand(0)->getType(),
2956 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002957 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002958 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002959 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002960 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002961
Chris Lattner0e851da2002-04-18 20:37:37 +00002962 visitInstruction(B);
2963}
2964
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002965void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002966 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002967 Type *Op0Ty = IC.getOperand(0)->getType();
2968 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002969 Assert(Op0Ty == Op1Ty,
2970 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002971 // Check that the operands are the right type
Craig Topper95d23472017-07-09 07:04:00 +00002972 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPtrOrPtrVectorTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002973 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002974 // Check that the predicate is valid.
Craig Topper45844762017-07-05 23:35:46 +00002975 Assert(IC.isIntPredicate(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002976 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002977
Reid Spencerd9436b62006-11-20 01:22:35 +00002978 visitInstruction(IC);
2979}
2980
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002981void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002982 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002983 Type *Op0Ty = FC.getOperand(0)->getType();
2984 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002985 Assert(Op0Ty == Op1Ty,
2986 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002987 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002988 Assert(Op0Ty->isFPOrFPVectorTy(),
2989 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002990 // Check that the predicate is valid.
Craig Topper45844762017-07-05 23:35:46 +00002991 Assert(FC.isFPPredicate(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002992 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002993
Reid Spencerd9436b62006-11-20 01:22:35 +00002994 visitInstruction(FC);
2995}
2996
Robert Bocchino23004482006-01-10 19:05:34 +00002997void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002998 Assert(
2999 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
3000 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00003001 visitInstruction(EI);
3002}
3003
Robert Bocchinoca27f032006-01-17 20:07:22 +00003004void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003005 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
3006 IE.getOperand(2)),
3007 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00003008 visitInstruction(IE);
3009}
3010
Chris Lattnerbbe0a422006-04-08 01:18:18 +00003011void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003012 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
3013 SV.getOperand(2)),
3014 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00003015 visitInstruction(SV);
3016}
3017
Chris Lattner069a7952002-06-25 15:56:27 +00003018void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00003019 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00003020
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003021 Assert(isa<PointerType>(TargetTy),
3022 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00003023 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Igor Laevsky753395f2017-12-14 09:33:58 +00003024
Chris Lattner84d82c72007-02-10 08:30:29 +00003025 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Igor Laevsky753395f2017-12-14 09:33:58 +00003026 Assert(all_of(
3027 Idxs, [](Value* V) { return V->getType()->isIntOrIntVectorTy(); }),
3028 "GEP indexes must be integers", &GEP);
Chris Lattner229907c2011-07-18 04:54:35 +00003029 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00003030 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003031 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00003032
Craig Topper95d23472017-07-09 07:04:00 +00003033 Assert(GEP.getType()->isPtrOrPtrVectorTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00003034 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003035 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00003036
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003037 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00003038 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003039 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
3040 if (GEP.getPointerOperandType()->isVectorTy())
3041 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
3042 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00003043 for (Value *Idx : Idxs) {
3044 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003045 if (IndexTy->isVectorTy()) {
3046 unsigned IndexWidth = IndexTy->getVectorNumElements();
3047 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
3048 }
Craig Topper95d23472017-07-09 07:04:00 +00003049 Assert(IndexTy->isIntOrIntVectorTy(),
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003050 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00003051 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00003052 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003053 visitInstruction(GEP);
3054}
3055
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00003056static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
3057 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
3058}
3059
Sanjoy Das26f28a22016-11-09 19:36:39 +00003060void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
3061 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
Philip Reamesbf9676f2014-10-20 23:52:07 +00003062 "precondition violation");
3063
3064 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003065 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003066 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003067 Assert(NumRanges >= 1, "It should have at least one range!", Range);
3068
Philip Reamesbf9676f2014-10-20 23:52:07 +00003069 ConstantRange LastRange(1); // Dummy initial value
3070 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003071 ConstantInt *Low =
3072 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003073 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003074 ConstantInt *High =
3075 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003076 Assert(High, "The upper limit must be an integer!", High);
3077 Assert(High->getType() == Low->getType() && High->getType() == Ty,
3078 "Range types must match instruction type!", &I);
3079
Philip Reamesbf9676f2014-10-20 23:52:07 +00003080 APInt HighV = High->getValue();
3081 APInt LowV = Low->getValue();
3082 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003083 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
3084 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003085 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003086 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
3087 "Intervals are overlapping", Range);
3088 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3089 Range);
3090 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3091 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003092 }
3093 LastRange = ConstantRange(LowV, HighV);
3094 }
3095 if (NumRanges > 2) {
3096 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003097 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003098 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003099 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003100 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003101 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3102 "Intervals are overlapping", Range);
3103 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3104 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003105 }
3106}
3107
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003108void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3109 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003110 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3111 Assert(!(Size & (Size - 1)),
3112 "atomic memory access' operand must have a power-of-two size", Ty, I);
3113}
3114
Chris Lattner069a7952002-06-25 15:56:27 +00003115void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003116 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003117 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003118 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003119 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3120 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003121 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003122 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003123 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3124 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003125 "Load cannot have Release ordering", &LI);
3126 Assert(LI.getAlignment() != 0,
3127 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003128 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3129 ElTy->isFloatingPointTy(),
3130 "atomic load operand must have integer, pointer, or floating point "
3131 "type!",
3132 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003133 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003134 } else {
Konstantin Zhuravlyovbb80d3e2017-07-11 22:23:00 +00003135 Assert(LI.getSyncScopeID() == SyncScope::System,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003136 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003137 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003138
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003139 visitInstruction(LI);
3140}
3141
Chris Lattner069a7952002-06-25 15:56:27 +00003142void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003143 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003144 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003145 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003146 Assert(ElTy == SI.getOperand(0)->getType(),
3147 "Stored value type does not match pointer operand type!", &SI, ElTy);
3148 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3149 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003150 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003151 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003152 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3153 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003154 "Store cannot have Acquire ordering", &SI);
3155 Assert(SI.getAlignment() != 0,
3156 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003157 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3158 ElTy->isFloatingPointTy(),
3159 "atomic store operand must have integer, pointer, or floating point "
3160 "type!",
3161 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003162 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003163 } else {
Konstantin Zhuravlyovbb80d3e2017-07-11 22:23:00 +00003164 Assert(SI.getSyncScopeID() == SyncScope::System,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003165 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003166 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003167 visitInstruction(SI);
3168}
3169
Manman Ren9bfd0d02016-04-01 21:41:15 +00003170/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3171void Verifier::verifySwiftErrorCallSite(CallSite CS,
3172 const Value *SwiftErrorVal) {
3173 unsigned Idx = 0;
3174 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3175 I != E; ++I, ++Idx) {
3176 if (*I == SwiftErrorVal) {
Reid Klecknerfb502d22017-04-14 20:19:02 +00003177 Assert(CS.paramHasAttr(Idx, Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00003178 "swifterror value when used in a callsite should be marked "
3179 "with swifterror attribute",
3180 SwiftErrorVal, CS);
3181 }
3182 }
3183}
3184
3185void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3186 // Check that swifterror value is only used by loads, stores, or as
3187 // a swifterror argument.
3188 for (const User *U : SwiftErrorVal->users()) {
3189 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3190 isa<InvokeInst>(U),
3191 "swifterror value can only be loaded and stored from, or "
3192 "as a swifterror argument!",
3193 SwiftErrorVal, U);
3194 // If it is used by a store, check it is the second operand.
3195 if (auto StoreI = dyn_cast<StoreInst>(U))
3196 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3197 "swifterror value should be the second operand when used "
3198 "by stores", SwiftErrorVal, U);
3199 if (auto CallI = dyn_cast<CallInst>(U))
3200 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3201 if (auto II = dyn_cast<InvokeInst>(U))
3202 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3203 }
3204}
3205
Victor Hernandez8acf2952009-10-23 21:09:37 +00003206void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003207 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003208 PointerType *PTy = AI.getType();
Matt Arsenault3c1fc762017-04-10 22:27:50 +00003209 // TODO: Relax this restriction?
3210 Assert(PTy->getAddressSpace() == DL.getAllocaAddrSpace(),
3211 "Allocation instruction pointer not in the stack address space!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003212 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003213 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003214 "Cannot allocate unsized type", &AI);
3215 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3216 "Alloca array size must have integer type", &AI);
3217 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3218 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003219
Manman Ren9bfd0d02016-04-01 21:41:15 +00003220 if (AI.isSwiftError()) {
3221 verifySwiftErrorValue(&AI);
3222 }
3223
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003224 visitInstruction(AI);
3225}
3226
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003227void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003228
3229 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003230 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003231 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003232 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003233 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003234 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003235 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003236 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003237 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003238 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3239 "cmpxchg instructions failure argument shall be no stronger than the "
3240 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003241 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003242 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3243 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003244 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003245
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003246 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003247 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003248 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003249 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3250 "cmpxchg operand must have integer or pointer type",
3251 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003252 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003253 Assert(ElTy == CXI.getOperand(1)->getType(),
3254 "Expected value type does not match pointer operand type!", &CXI,
3255 ElTy);
3256 Assert(ElTy == CXI.getOperand(2)->getType(),
3257 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003258 visitInstruction(CXI);
3259}
3260
3261void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003262 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003263 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003264 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003265 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003266 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003267 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003268 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003269 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3270 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003271 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003272 Assert(ElTy == RMWI.getOperand(1)->getType(),
3273 "Argument value type does not match pointer operand type!", &RMWI,
3274 ElTy);
3275 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3276 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3277 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003278 visitInstruction(RMWI);
3279}
3280
Eli Friedmanfee02c62011-07-25 23:16:38 +00003281void Verifier::visitFenceInst(FenceInst &FI) {
3282 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003283 Assert(Ordering == AtomicOrdering::Acquire ||
3284 Ordering == AtomicOrdering::Release ||
3285 Ordering == AtomicOrdering::AcquireRelease ||
3286 Ordering == AtomicOrdering::SequentiallyConsistent,
3287 "fence instructions may only have acquire, release, acq_rel, or "
3288 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003289 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003290 visitInstruction(FI);
3291}
3292
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003293void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003294 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3295 EVI.getIndices()) == EVI.getType(),
3296 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003297
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003298 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003299}
3300
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003301void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003302 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3303 IVI.getIndices()) ==
3304 IVI.getOperand(1)->getType(),
3305 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003306
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003307 visitInstruction(IVI);
3308}
Chris Lattner0e851da2002-04-18 20:37:37 +00003309
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003310static Value *getParentPad(Value *EHPad) {
3311 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3312 return FPI->getParentPad();
3313
3314 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3315}
3316
David Majnemer85a549d2015-08-11 02:48:30 +00003317void Verifier::visitEHPadPredecessors(Instruction &I) {
3318 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003319
David Majnemer85a549d2015-08-11 02:48:30 +00003320 BasicBlock *BB = I.getParent();
3321 Function *F = BB->getParent();
3322
3323 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3324
3325 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3326 // The landingpad instruction defines its parent as a landing pad block. The
3327 // landing pad block may be branched to only by the unwind edge of an
3328 // invoke.
3329 for (BasicBlock *PredBB : predecessors(BB)) {
3330 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3331 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3332 "Block containing LandingPadInst must be jumped to "
3333 "only by the unwind edge of an invoke.",
3334 LPI);
3335 }
3336 return;
3337 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003338 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3339 if (!pred_empty(BB))
3340 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3341 "Block containg CatchPadInst must be jumped to "
3342 "only by its catchswitch.",
3343 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003344 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3345 "Catchswitch cannot unwind to one of its catchpads",
3346 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003347 return;
3348 }
David Majnemer85a549d2015-08-11 02:48:30 +00003349
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003350 // Verify that each pred has a legal terminator with a legal to/from EH
3351 // pad relationship.
3352 Instruction *ToPad = &I;
3353 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003354 for (BasicBlock *PredBB : predecessors(BB)) {
3355 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003356 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003357 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003358 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003359 "EH pad must be jumped to via an unwind edge", ToPad, II);
3360 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3361 FromPad = Bundle->Inputs[0];
3362 else
3363 FromPad = ConstantTokenNone::get(II->getContext());
3364 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003365 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003366 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3367 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3368 FromPad = CSI;
3369 } else {
3370 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3371 }
3372
3373 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003374 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003375 for (;; FromPad = getParentPad(FromPad)) {
3376 Assert(FromPad != ToPad,
3377 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3378 if (FromPad == ToPadParent) {
3379 // This is a legal unwind edge.
3380 break;
3381 }
3382 Assert(!isa<ConstantTokenNone>(FromPad),
3383 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003384 Assert(Seen.insert(FromPad).second,
3385 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003386 }
David Majnemer85a549d2015-08-11 02:48:30 +00003387 }
3388}
3389
3390void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003391 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3392 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003393 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3394 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003395
David Majnemer85a549d2015-08-11 02:48:30 +00003396 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003397
David Majnemer654e1302015-07-31 17:58:14 +00003398 if (!LandingPadResultTy)
3399 LandingPadResultTy = LPI.getType();
3400 else
3401 Assert(LandingPadResultTy == LPI.getType(),
3402 "The landingpad instruction should have a consistent result type "
3403 "inside a function.",
3404 &LPI);
3405
David Majnemer7fddecc2015-06-17 20:52:32 +00003406 Function *F = LPI.getParent()->getParent();
3407 Assert(F->hasPersonalityFn(),
3408 "LandingPadInst needs to be in a function with a personality.", &LPI);
3409
Bill Wendlingfae14752011-08-12 20:24:12 +00003410 // The landingpad instruction must be the first non-PHI instruction in the
3411 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003412 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3413 "LandingPadInst not the first non-PHI instruction in the block.",
3414 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003415
Duncan Sands86de1a62011-09-27 16:43:19 +00003416 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003417 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003418 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003419 Assert(isa<PointerType>(Clause->getType()),
3420 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003421 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003422 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3423 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3424 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003425 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003426 }
3427
Bill Wendlingfae14752011-08-12 20:24:12 +00003428 visitInstruction(LPI);
3429}
3430
David Majnemerba6665d2016-08-01 18:06:34 +00003431void Verifier::visitResumeInst(ResumeInst &RI) {
3432 Assert(RI.getFunction()->hasPersonalityFn(),
3433 "ResumeInst needs to be in a function with a personality.", &RI);
3434
3435 if (!LandingPadResultTy)
3436 LandingPadResultTy = RI.getValue()->getType();
3437 else
3438 Assert(LandingPadResultTy == RI.getValue()->getType(),
3439 "The resume instruction should have a consistent result type "
3440 "inside a function.",
3441 &RI);
3442
3443 visitTerminatorInst(RI);
3444}
3445
David Majnemer654e1302015-07-31 17:58:14 +00003446void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003447 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003448
David Majnemer654e1302015-07-31 17:58:14 +00003449 Function *F = BB->getParent();
3450 Assert(F->hasPersonalityFn(),
3451 "CatchPadInst needs to be in a function with a personality.", &CPI);
3452
David Majnemer8a1c45d2015-12-12 05:38:55 +00003453 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3454 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3455 CPI.getParentPad());
3456
David Majnemer654e1302015-07-31 17:58:14 +00003457 // The catchpad instruction must be the first non-PHI instruction in the
3458 // block.
3459 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003460 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003461
David Majnemerfe2f7f32016-02-29 22:56:36 +00003462 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003463 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003464}
3465
David Majnemer8a1c45d2015-12-12 05:38:55 +00003466void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3467 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3468 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3469 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003470
David Majnemer8a1c45d2015-12-12 05:38:55 +00003471 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003472}
3473
3474void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3475 BasicBlock *BB = CPI.getParent();
3476
David Majnemer654e1302015-07-31 17:58:14 +00003477 Function *F = BB->getParent();
3478 Assert(F->hasPersonalityFn(),
3479 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3480
3481 // The cleanuppad instruction must be the first non-PHI instruction in the
3482 // block.
3483 Assert(BB->getFirstNonPHI() == &CPI,
3484 "CleanupPadInst not the first non-PHI instruction in the block.",
3485 &CPI);
3486
David Majnemer8a1c45d2015-12-12 05:38:55 +00003487 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003488 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003489 "CleanupPadInst has an invalid parent.", &CPI);
3490
David Majnemerfe2f7f32016-02-29 22:56:36 +00003491 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003492 visitFuncletPadInst(CPI);
3493}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003494
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003495void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3496 User *FirstUser = nullptr;
3497 Value *FirstUnwindPad = nullptr;
3498 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003499 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003500
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003501 while (!Worklist.empty()) {
3502 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003503 Assert(Seen.insert(CurrentPad).second,
3504 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003505 Value *UnresolvedAncestorPad = nullptr;
3506 for (User *U : CurrentPad->users()) {
3507 BasicBlock *UnwindDest;
3508 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3509 UnwindDest = CRI->getUnwindDest();
3510 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3511 // We allow catchswitch unwind to caller to nest
3512 // within an outer pad that unwinds somewhere else,
3513 // because catchswitch doesn't have a nounwind variant.
3514 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3515 if (CSI->unwindsToCaller())
3516 continue;
3517 UnwindDest = CSI->getUnwindDest();
3518 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3519 UnwindDest = II->getUnwindDest();
3520 } else if (isa<CallInst>(U)) {
3521 // Calls which don't unwind may be found inside funclet
3522 // pads that unwind somewhere else. We don't *require*
3523 // such calls to be annotated nounwind.
3524 continue;
3525 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3526 // The unwind dest for a cleanup can only be found by
3527 // recursive search. Add it to the worklist, and we'll
3528 // search for its first use that determines where it unwinds.
3529 Worklist.push_back(CPI);
3530 continue;
3531 } else {
3532 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3533 continue;
3534 }
3535
3536 Value *UnwindPad;
3537 bool ExitsFPI;
3538 if (UnwindDest) {
3539 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003540 if (!cast<Instruction>(UnwindPad)->isEHPad())
3541 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003542 Value *UnwindParent = getParentPad(UnwindPad);
3543 // Ignore unwind edges that don't exit CurrentPad.
3544 if (UnwindParent == CurrentPad)
3545 continue;
3546 // Determine whether the original funclet pad is exited,
3547 // and if we are scanning nested pads determine how many
3548 // of them are exited so we can stop searching their
3549 // children.
3550 Value *ExitedPad = CurrentPad;
3551 ExitsFPI = false;
3552 do {
3553 if (ExitedPad == &FPI) {
3554 ExitsFPI = true;
3555 // Now we can resolve any ancestors of CurrentPad up to
3556 // FPI, but not including FPI since we need to make sure
3557 // to check all direct users of FPI for consistency.
3558 UnresolvedAncestorPad = &FPI;
3559 break;
3560 }
3561 Value *ExitedParent = getParentPad(ExitedPad);
3562 if (ExitedParent == UnwindParent) {
3563 // ExitedPad is the ancestor-most pad which this unwind
3564 // edge exits, so we can resolve up to it, meaning that
3565 // ExitedParent is the first ancestor still unresolved.
3566 UnresolvedAncestorPad = ExitedParent;
3567 break;
3568 }
3569 ExitedPad = ExitedParent;
3570 } while (!isa<ConstantTokenNone>(ExitedPad));
3571 } else {
3572 // Unwinding to caller exits all pads.
3573 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3574 ExitsFPI = true;
3575 UnresolvedAncestorPad = &FPI;
3576 }
3577
3578 if (ExitsFPI) {
3579 // This unwind edge exits FPI. Make sure it agrees with other
3580 // such edges.
3581 if (FirstUser) {
3582 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3583 "pad must have the same unwind "
3584 "dest",
3585 &FPI, U, FirstUser);
3586 } else {
3587 FirstUser = U;
3588 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003589 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3590 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3591 getParentPad(UnwindPad) == getParentPad(&FPI))
3592 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003593 }
3594 }
3595 // Make sure we visit all uses of FPI, but for nested pads stop as
3596 // soon as we know where they unwind to.
3597 if (CurrentPad != &FPI)
3598 break;
3599 }
3600 if (UnresolvedAncestorPad) {
3601 if (CurrentPad == UnresolvedAncestorPad) {
3602 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3603 // we've found an unwind edge that exits it, because we need to verify
3604 // all direct uses of FPI.
3605 assert(CurrentPad == &FPI);
3606 continue;
3607 }
3608 // Pop off the worklist any nested pads that we've found an unwind
3609 // destination for. The pads on the worklist are the uncles,
3610 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3611 // for all ancestors of CurrentPad up to but not including
3612 // UnresolvedAncestorPad.
3613 Value *ResolvedPad = CurrentPad;
3614 while (!Worklist.empty()) {
3615 Value *UnclePad = Worklist.back();
3616 Value *AncestorPad = getParentPad(UnclePad);
3617 // Walk ResolvedPad up the ancestor list until we either find the
3618 // uncle's parent or the last resolved ancestor.
3619 while (ResolvedPad != AncestorPad) {
3620 Value *ResolvedParent = getParentPad(ResolvedPad);
3621 if (ResolvedParent == UnresolvedAncestorPad) {
3622 break;
3623 }
3624 ResolvedPad = ResolvedParent;
3625 }
3626 // If the resolved ancestor search didn't find the uncle's parent,
3627 // then the uncle is not yet resolved.
3628 if (ResolvedPad != AncestorPad)
3629 break;
3630 // This uncle is resolved, so pop it from the worklist.
3631 Worklist.pop_back();
3632 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003633 }
3634 }
3635
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003636 if (FirstUnwindPad) {
3637 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3638 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3639 Value *SwitchUnwindPad;
3640 if (SwitchUnwindDest)
3641 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3642 else
3643 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3644 Assert(SwitchUnwindPad == FirstUnwindPad,
3645 "Unwind edges out of a catch must have the same unwind dest as "
3646 "the parent catchswitch",
3647 &FPI, FirstUser, CatchSwitch);
3648 }
3649 }
3650
3651 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003652}
3653
David Majnemer8a1c45d2015-12-12 05:38:55 +00003654void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003655 BasicBlock *BB = CatchSwitch.getParent();
3656
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003657 Function *F = BB->getParent();
3658 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003659 "CatchSwitchInst needs to be in a function with a personality.",
3660 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003661
David Majnemer8a1c45d2015-12-12 05:38:55 +00003662 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003663 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003664 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3665 "CatchSwitchInst not the first non-PHI instruction in the block.",
3666 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003667
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003668 auto *ParentPad = CatchSwitch.getParentPad();
3669 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3670 "CatchSwitchInst has an invalid parent.", ParentPad);
3671
David Majnemer8a1c45d2015-12-12 05:38:55 +00003672 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003673 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003674 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3675 "CatchSwitchInst must unwind to an EH block which is not a "
3676 "landingpad.",
3677 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003678
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003679 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3680 if (getParentPad(I) == ParentPad)
3681 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3682 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003683
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003684 Assert(CatchSwitch.getNumHandlers() != 0,
3685 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3686
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003687 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003688 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3689 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003690 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003691
David Majnemerfe2f7f32016-02-29 22:56:36 +00003692 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003693 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003694}
3695
David Majnemer654e1302015-07-31 17:58:14 +00003696void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003697 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3698 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3699 CRI.getOperand(0));
3700
David Majnemer654e1302015-07-31 17:58:14 +00003701 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3702 Instruction *I = UnwindDest->getFirstNonPHI();
3703 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3704 "CleanupReturnInst must unwind to an EH block which is not a "
3705 "landingpad.",
3706 &CRI);
3707 }
3708
3709 visitTerminatorInst(CRI);
3710}
3711
Rafael Espindola654320a2012-02-26 02:23:37 +00003712void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3713 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003714 // If the we have an invalid invoke, don't try to compute the dominance.
3715 // We already reject it in the invoke specific checks and the dominance
3716 // computation doesn't handle multiple edges.
3717 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3718 if (II->getNormalDest() == II->getUnwindDest())
3719 return;
3720 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003721
Michael Kruseff379b62016-03-26 23:32:57 +00003722 // Quick check whether the def has already been encountered in the same block.
3723 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3724 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003725 //
3726 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3727 // wrapping an SSA value, assert that we've already encountered it. See
3728 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003729 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3730 return;
3731
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003732 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003733 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003734 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003735}
3736
Artur Pilipenkocca80022015-10-09 17:41:29 +00003737void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3738 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3739 "apply only to pointer types", &I);
3740 Assert(isa<LoadInst>(I),
3741 "dereferenceable, dereferenceable_or_null apply only to load"
3742 " instructions, use attributes for calls or invokes", &I);
3743 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3744 "take one operand!", &I);
3745 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3746 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3747 "dereferenceable_or_null metadata value must be an i64!", &I);
3748}
3749
Misha Brukmanc566ca362004-03-02 00:22:19 +00003750/// verifyInstruction - Verify that an instruction is well formed.
3751///
Chris Lattner069a7952002-06-25 15:56:27 +00003752void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003753 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003754 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003755
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003756 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003757 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003758 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3759 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003760 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003761 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003762
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003763 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003764 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3765 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003766
Chris Lattner5f126b72004-03-29 00:29:36 +00003767 // Check that the return value of the instruction is either void or a legal
3768 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003769 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3770 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003771
Nick Lewycky93e06a52009-09-27 23:27:42 +00003772 // Check that the instruction doesn't produce metadata. Calls are already
3773 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003774 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3775 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003776
Chris Lattner0e851da2002-04-18 20:37:37 +00003777 // Check that all uses of the instruction, if they are instructions
3778 // themselves, actually have parent basic blocks. If the use is not an
3779 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003780 for (Use &U : I.uses()) {
3781 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003782 Assert(Used->getParent() != nullptr,
3783 "Instruction referencing"
3784 " instruction not embedded in a basic block!",
3785 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003786 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003787 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003788 return;
3789 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003790 }
3791
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003792 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003793 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003794
3795 // Check to make sure that only first-class-values are operands to
3796 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003797 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003798 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003799 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003800
Chris Lattner9ece94b2004-03-14 03:23:54 +00003801 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003802 // Check to make sure that the "address of" an intrinsic function is never
3803 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003804 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003805 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003806 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3807 "Cannot take the address of an intrinsic!", &I);
3808 Assert(
3809 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003810 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003811 F->getIntrinsicID() == Intrinsic::coro_resume ||
3812 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003813 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003814 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3815 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003816 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3817 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003818 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003819 Assert(F->getParent() == &M, "Referencing function in another module!",
3820 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003821 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003822 Assert(OpBB->getParent() == BB->getParent(),
3823 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003824 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003825 Assert(OpArg->getParent() == BB->getParent(),
3826 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003827 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003828 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3829 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003830 } else if (isa<Instruction>(I.getOperand(i))) {
3831 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003832 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003833 Assert((i + 1 == e && isa<CallInst>(I)) ||
3834 (i + 3 == e && isa<InvokeInst>(I)),
3835 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003836 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003837 if (CE->getType()->isPtrOrPtrVectorTy() ||
3838 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003839 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003840 // illegal bitcast. If the datalayout string specifies non-integral
3841 // address spaces then we also need to check for illegal ptrtoint and
3842 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003843 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003844 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003845 }
3846 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003847
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003848 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003849 Assert(I.getType()->isFPOrFPVectorTy(),
3850 "fpmath requires a floating point result!", &I);
3851 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003852 if (ConstantFP *CFP0 =
3853 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003854 const APFloat &Accuracy = CFP0->getValueAPF();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003855 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
Matt Arsenault82f41512016-06-27 19:43:15 +00003856 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003857 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3858 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003859 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003860 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003861 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003862 }
3863
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003864 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003865 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3866 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003867 visitRangeMetadata(I, Range, I.getType());
3868 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003869
Philip Reames0ca58b32014-10-21 20:56:29 +00003870 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003871 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3872 &I);
3873 Assert(isa<LoadInst>(I),
3874 "nonnull applies only to load instructions, use attributes"
3875 " for calls or invokes",
3876 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003877 }
3878
Artur Pilipenkocca80022015-10-09 17:41:29 +00003879 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3880 visitDereferenceableMetadata(I, MD);
3881
3882 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3883 visitDereferenceableMetadata(I, MD);
3884
Mehdi Aminia84a8402016-12-16 06:29:14 +00003885 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
3886 TBAAVerifyHelper.visitTBAAMetadata(I, TBAA);
Sanjoy Das2582e692016-11-08 20:46:01 +00003887
Artur Pilipenkocca80022015-10-09 17:41:29 +00003888 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3889 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3890 &I);
3891 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3892 "use attributes for calls or invokes", &I);
3893 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3894 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3895 Assert(CI && CI->getType()->isIntegerTy(64),
3896 "align metadata value must be an i64!", &I);
3897 uint64_t Align = CI->getZExtValue();
3898 Assert(isPowerOf2_64(Align),
3899 "align metadata value must be a power of 2!", &I);
3900 Assert(Align <= Value::MaximumAlignment,
3901 "alignment is larger that implementation defined limit", &I);
3902 }
3903
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003904 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003905 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003906 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003907 }
3908
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003909 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Adrian Prantl941fa752016-12-05 18:04:47 +00003910 verifyFragmentExpression(*DII);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003911
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003912 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003913}
3914
Philip Reames007561a2015-06-26 22:21:52 +00003915/// Allow intrinsics to be verified in different ways.
3916void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003917 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003918 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3919 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003920
Chris Lattner144b6192012-05-27 19:37:05 +00003921 // Verify that the intrinsic prototype lines up with what the .td files
3922 // describe.
3923 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003924 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003925
Chris Lattner144b6192012-05-27 19:37:05 +00003926 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3927 getIntrinsicInfoTableEntries(ID, Table);
3928 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003929
Chris Lattner144b6192012-05-27 19:37:05 +00003930 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003931 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3932 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003933 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003934 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003935 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3936 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003937 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003938
3939 // Verify if the intrinsic call matches the vararg property.
3940 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003941 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003942 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003943 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003944 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003945 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003946
3947 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003948 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003949
3950 // Now that we have the intrinsic ID and the actual argument types (and we
3951 // know they are legal for the intrinsic!) get the intrinsic name through the
3952 // usual means. This allows us to verify the mangling of argument types into
3953 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003954 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003955 Assert(ExpectedName == IF->getName(),
3956 "Intrinsic name not mangled correctly for type arguments! "
3957 "Should be: " +
3958 ExpectedName,
3959 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003960
Chris Lattner588096e2009-12-28 09:07:21 +00003961 // If the intrinsic takes MDNode arguments, verify that they are either global
3962 // or are local to *this* function.
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00003963 for (Value *V : CS.args())
Philip Reames007561a2015-06-26 22:21:52 +00003964 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3965 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003966
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003967 switch (ID) {
3968 default:
3969 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003970 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003971 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003972 if (isa<ConstantPointerNull>(InfoArg))
3973 break;
3974 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3975 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3976 "info argument of llvm.coro.begin must refer to an initialized "
3977 "constant");
3978 Constant *Init = GV->getInitializer();
3979 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3980 "info argument of llvm.coro.begin must refer to either a struct or "
3981 "an array");
3982 break;
3983 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003984 case Intrinsic::ctlz: // llvm.ctlz
3985 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003986 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003987 "is_zero_undef argument of bit counting intrinsics must be a "
3988 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003989 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003990 break;
Andrew Kaylora0a11642017-01-26 23:27:59 +00003991 case Intrinsic::experimental_constrained_fadd:
3992 case Intrinsic::experimental_constrained_fsub:
3993 case Intrinsic::experimental_constrained_fmul:
3994 case Intrinsic::experimental_constrained_fdiv:
3995 case Intrinsic::experimental_constrained_frem:
Wei Dinga131d3f2017-08-24 04:18:24 +00003996 case Intrinsic::experimental_constrained_fma:
Andrew Kaylorf4660012017-05-25 21:31:00 +00003997 case Intrinsic::experimental_constrained_sqrt:
3998 case Intrinsic::experimental_constrained_pow:
3999 case Intrinsic::experimental_constrained_powi:
4000 case Intrinsic::experimental_constrained_sin:
4001 case Intrinsic::experimental_constrained_cos:
4002 case Intrinsic::experimental_constrained_exp:
4003 case Intrinsic::experimental_constrained_exp2:
4004 case Intrinsic::experimental_constrained_log:
4005 case Intrinsic::experimental_constrained_log10:
4006 case Intrinsic::experimental_constrained_log2:
4007 case Intrinsic::experimental_constrained_rint:
4008 case Intrinsic::experimental_constrained_nearbyint:
Andrew Kaylora0a11642017-01-26 23:27:59 +00004009 visitConstrainedFPIntrinsic(
4010 cast<ConstrainedFPIntrinsic>(*CS.getInstruction()));
4011 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00004012 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00004013 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
4014 "invalid llvm.dbg.declare intrinsic call 1", CS);
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004015 visitDbgIntrinsic("declare", cast<DbgInfoIntrinsic>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004016 break;
Reid Kleckner0fe506b2017-09-21 19:52:03 +00004017 case Intrinsic::dbg_addr: // llvm.dbg.addr
4018 visitDbgIntrinsic("addr", cast<DbgInfoIntrinsic>(*CS.getInstruction()));
Reid Kleckner8db62602017-09-22 23:19:52 +00004019 break;
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004020 case Intrinsic::dbg_value: // llvm.dbg.value
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004021 visitDbgIntrinsic("value", cast<DbgInfoIntrinsic>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00004022 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00004023 case Intrinsic::memcpy:
4024 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00004025 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00004026 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004027 Assert(AlignCI,
4028 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004029 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00004030 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004031 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00004032 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00004033 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004034 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004035 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00004036 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00004037 }
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004038 case Intrinsic::memcpy_element_unordered_atomic: {
Daniel Neilsonf9c7d292017-10-30 19:51:48 +00004039 const AtomicMemCpyInst *MI = cast<AtomicMemCpyInst>(CS.getInstruction());
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004040
4041 ConstantInt *ElementSizeCI =
4042 dyn_cast<ConstantInt>(MI->getRawElementSizeInBytes());
4043 Assert(ElementSizeCI,
4044 "element size of the element-wise unordered atomic memory "
4045 "intrinsic must be a constant int",
Igor Laevsky4f31e522016-12-29 14:31:07 +00004046 CS);
4047 const APInt &ElementSizeVal = ElementSizeCI->getValue();
4048 Assert(ElementSizeVal.isPowerOf2(),
4049 "element size of the element-wise atomic memory intrinsic "
4050 "must be a power of 2",
4051 CS);
4052
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004053 if (auto *LengthCI = dyn_cast<ConstantInt>(MI->getLength())) {
4054 uint64_t Length = LengthCI->getZExtValue();
4055 uint64_t ElementSize = MI->getElementSizeInBytes();
4056 Assert((Length % ElementSize) == 0,
4057 "constant length must be a multiple of the element size in the "
4058 "element-wise atomic memory intrinsic",
4059 CS);
4060 }
4061
Igor Laevsky4f31e522016-12-29 14:31:07 +00004062 auto IsValidAlignment = [&](uint64_t Alignment) {
4063 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4064 };
Reid Kleckner859f8b52017-04-28 20:34:27 +00004065 uint64_t DstAlignment = CS.getParamAlignment(0),
4066 SrcAlignment = CS.getParamAlignment(1);
Igor Laevsky4f31e522016-12-29 14:31:07 +00004067 Assert(IsValidAlignment(DstAlignment),
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004068 "incorrect alignment of the destination argument", CS);
Igor Laevsky4f31e522016-12-29 14:31:07 +00004069 Assert(IsValidAlignment(SrcAlignment),
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004070 "incorrect alignment of the source argument", CS);
Igor Laevsky4f31e522016-12-29 14:31:07 +00004071 break;
4072 }
Daniel Neilson57226ef2017-07-12 15:25:26 +00004073 case Intrinsic::memmove_element_unordered_atomic: {
Daniel Neilsonf9c7d292017-10-30 19:51:48 +00004074 auto *MI = cast<AtomicMemMoveInst>(CS.getInstruction());
Daniel Neilson57226ef2017-07-12 15:25:26 +00004075
4076 ConstantInt *ElementSizeCI =
4077 dyn_cast<ConstantInt>(MI->getRawElementSizeInBytes());
4078 Assert(ElementSizeCI,
4079 "element size of the element-wise unordered atomic memory "
4080 "intrinsic must be a constant int",
4081 CS);
4082 const APInt &ElementSizeVal = ElementSizeCI->getValue();
4083 Assert(ElementSizeVal.isPowerOf2(),
4084 "element size of the element-wise atomic memory intrinsic "
4085 "must be a power of 2",
4086 CS);
4087
4088 if (auto *LengthCI = dyn_cast<ConstantInt>(MI->getLength())) {
4089 uint64_t Length = LengthCI->getZExtValue();
4090 uint64_t ElementSize = MI->getElementSizeInBytes();
4091 Assert((Length % ElementSize) == 0,
4092 "constant length must be a multiple of the element size in the "
4093 "element-wise atomic memory intrinsic",
4094 CS);
4095 }
4096
4097 auto IsValidAlignment = [&](uint64_t Alignment) {
4098 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4099 };
4100 uint64_t DstAlignment = CS.getParamAlignment(0),
4101 SrcAlignment = CS.getParamAlignment(1);
4102 Assert(IsValidAlignment(DstAlignment),
4103 "incorrect alignment of the destination argument", CS);
4104 Assert(IsValidAlignment(SrcAlignment),
4105 "incorrect alignment of the source argument", CS);
Daniel Neilson965613e2017-07-12 21:57:23 +00004106 break;
4107 }
4108 case Intrinsic::memset_element_unordered_atomic: {
Daniel Neilsonf9c7d292017-10-30 19:51:48 +00004109 auto *MI = cast<AtomicMemSetInst>(CS.getInstruction());
Daniel Neilson965613e2017-07-12 21:57:23 +00004110
4111 ConstantInt *ElementSizeCI =
4112 dyn_cast<ConstantInt>(MI->getRawElementSizeInBytes());
4113 Assert(ElementSizeCI,
4114 "element size of the element-wise unordered atomic memory "
4115 "intrinsic must be a constant int",
4116 CS);
4117 const APInt &ElementSizeVal = ElementSizeCI->getValue();
4118 Assert(ElementSizeVal.isPowerOf2(),
4119 "element size of the element-wise atomic memory intrinsic "
4120 "must be a power of 2",
4121 CS);
4122
4123 if (auto *LengthCI = dyn_cast<ConstantInt>(MI->getLength())) {
4124 uint64_t Length = LengthCI->getZExtValue();
4125 uint64_t ElementSize = MI->getElementSizeInBytes();
4126 Assert((Length % ElementSize) == 0,
4127 "constant length must be a multiple of the element size in the "
4128 "element-wise atomic memory intrinsic",
4129 CS);
4130 }
4131
4132 auto IsValidAlignment = [&](uint64_t Alignment) {
4133 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4134 };
4135 uint64_t DstAlignment = CS.getParamAlignment(0);
4136 Assert(IsValidAlignment(DstAlignment),
4137 "incorrect alignment of the destination argument", CS);
Daniel Neilson57226ef2017-07-12 15:25:26 +00004138 break;
4139 }
Bill Wendling05604e02008-08-23 09:46:46 +00004140 case Intrinsic::gcroot:
4141 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00004142 case Intrinsic::gcread:
4143 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00004144 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00004145 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
4146 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
4147 Assert(isa<Constant>(CS.getArgOperand(1)),
4148 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00004149 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00004150 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004151 "llvm.gcroot parameter #1 must either be a pointer alloca, "
4152 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00004153 CS);
Talin2e59f142010-09-30 20:23:47 +00004154 }
Chris Lattner25852062008-08-24 20:46:13 +00004155 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00004156
Philip Reames9818dd72015-06-26 22:04:34 +00004157 Assert(CS.getParent()->getParent()->hasGC(),
4158 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00004159 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00004160 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00004161 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004162 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00004163 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004164 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004165 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004166 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4167 isa<ConstantInt>(CS.getArgOperand(2)) &&
4168 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4169 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4170 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004171 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004172 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004173 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4174 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004175 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004176 case Intrinsic::lifetime_start:
4177 case Intrinsic::lifetime_end:
4178 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004179 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004180 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004181 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004182 break;
4183 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004184 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4185 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004186 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004187
Reid Kleckner60381792015-07-07 22:25:32 +00004188 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004189 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004190 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004191 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004192 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004193 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004194 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004195 if (isa<ConstantPointerNull>(Arg))
4196 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004197 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004198 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004199 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004200 }
Philip Reames9818dd72015-06-26 22:04:34 +00004201 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004202 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004203 break;
4204 }
Reid Kleckner60381792015-07-07 22:25:32 +00004205 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004206 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004207 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004208 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004209 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004210 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004211 CS);
4212 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004213 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004214 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004215 auto &Entry = FrameEscapeInfo[Fn];
4216 Entry.second = unsigned(
4217 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004218 break;
4219 }
4220
Philip Reames1ffa9372015-01-30 23:28:05 +00004221 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004222 Assert(!CS.isInlineAsm(),
4223 "gc.statepoint support for inline assembly unimplemented", CS);
4224 Assert(CS.getParent()->getParent()->hasGC(),
4225 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004226
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004227 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004228 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004229 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004230 Assert(CS.getParent()->getParent()->hasGC(),
4231 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004232 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004233 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004234 const Function *StatepointFn =
4235 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004236 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4237 StatepointFn->getIntrinsicID() ==
4238 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004239 "gc.result operand #1 must be from a statepoint", CS,
4240 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004241
Philip Reamesb23713a2014-12-03 22:23:24 +00004242 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004243 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004244 auto *PT = cast<PointerType>(Target->getType());
4245 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004246 Assert(CS.getType() == TargetFuncType->getReturnType(),
4247 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004248 break;
4249 }
4250 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004251 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004252
Philip Reames3e2cf532016-01-07 03:32:11 +00004253 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4254 "gc.relocate must return a pointer or a vector of pointers", CS);
4255
Igor Laevsky9570ff92015-02-19 11:28:47 +00004256 // Check that this relocate is correctly tied to the statepoint
4257
4258 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004259 if (LandingPadInst *LandingPad =
4260 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004261
Sanjoy Das5665c992015-05-11 23:47:27 +00004262 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004263 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004264
4265 // Landingpad relocates should have only one predecessor with invoke
4266 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004267 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004268 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004269 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4270 InvokeBB);
4271 Assert(isStatepoint(InvokeBB->getTerminator()),
4272 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004273 }
4274 else {
4275 // In all other cases relocate should be tied to the statepoint directly.
4276 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004277 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004278 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004279 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004280 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004281 }
4282
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004283 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004284
Manuel Jacob83eefa62016-01-05 04:03:00 +00004285 ImmutableCallSite StatepointCS(
4286 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004287
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004288 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004289 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004290 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004291 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004292
Philip Reames9818dd72015-06-26 22:04:34 +00004293 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004294 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004295 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004296
4297 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4298 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4299 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004300 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004301 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004302 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004303 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004304
4305 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004306 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004307 Assert(StatepointCS.arg_size() > 0,
4308 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004309 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004310 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004311 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004312 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4313 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004314 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004315 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004316 "gc.statepoint: number of transition arguments must be "
4317 "a constant integer");
4318 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004319 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4320 ->getZExtValue();
4321 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004322 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004323 "gc.statepoint: number of deoptimization arguments must be "
4324 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004325 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004326 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4327 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004328 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004329 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004330 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4331 "gc.relocate: statepoint base index doesn't fall within the "
4332 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004333 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004334 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4335 "gc.relocate: statepoint derived index doesn't fall within the "
4336 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004337 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004338
Philip Reames3e2cf532016-01-07 03:32:11 +00004339 // Relocated value must be either a pointer type or vector-of-pointer type,
4340 // but gc_relocate does not need to return the same pointer type as the
4341 // relocated pointer. It can be casted to the correct type later if it's
4342 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004343 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Craig Topper95d23472017-07-09 07:04:00 +00004344 Assert(Relocate.getDerivedPtr()->getType()->isPtrOrPtrVectorTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004345 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004346
Philip Reames3e2cf532016-01-07 03:32:11 +00004347 auto ResultType = CS.getType();
4348 auto DerivedType = Relocate.getDerivedPtr()->getType();
4349 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004350 "gc.relocate: vector relocates to vector and pointer to pointer",
4351 CS);
4352 Assert(
4353 ResultType->getPointerAddressSpace() ==
4354 DerivedType->getPointerAddressSpace(),
4355 "gc.relocate: relocating a pointer shouldn't change its address space",
4356 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004357 break;
4358 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004359 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004360 case Intrinsic::eh_exceptionpointer: {
4361 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4362 "eh.exceptionpointer argument must be a catchpad", CS);
4363 break;
4364 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004365 case Intrinsic::masked_load: {
4366 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004367
Philip Reamesf16d7812016-02-09 21:43:12 +00004368 Value *Ptr = CS.getArgOperand(0);
4369 //Value *Alignment = CS.getArgOperand(1);
4370 Value *Mask = CS.getArgOperand(2);
4371 Value *PassThru = CS.getArgOperand(3);
4372 Assert(Mask->getType()->isVectorTy(),
4373 "masked_load: mask must be vector", CS);
4374
4375 // DataTy is the overloaded type
4376 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004377 Assert(DataTy == CS.getType(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004378 "masked_load: return must match pointer type", CS);
4379 Assert(PassThru->getType() == DataTy,
4380 "masked_load: pass through and data type must match", CS);
4381 Assert(Mask->getType()->getVectorNumElements() ==
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004382 DataTy->getVectorNumElements(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004383 "masked_load: vector mask must be same length as data", CS);
4384 break;
4385 }
4386 case Intrinsic::masked_store: {
4387 Value *Val = CS.getArgOperand(0);
4388 Value *Ptr = CS.getArgOperand(1);
4389 //Value *Alignment = CS.getArgOperand(2);
4390 Value *Mask = CS.getArgOperand(3);
4391 Assert(Mask->getType()->isVectorTy(),
4392 "masked_store: mask must be vector", CS);
4393
4394 // DataTy is the overloaded type
4395 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004396 Assert(DataTy == Val->getType(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004397 "masked_store: storee must match pointer type", CS);
4398 Assert(Mask->getType()->getVectorNumElements() ==
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004399 DataTy->getVectorNumElements(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004400 "masked_store: vector mask must be same length as data", CS);
4401 break;
4402 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004403
Sanjoy Das021de052016-03-31 00:18:46 +00004404 case Intrinsic::experimental_guard: {
4405 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4406 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4407 "experimental_guard must have exactly one "
4408 "\"deopt\" operand bundle");
4409 break;
4410 }
4411
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004412 case Intrinsic::experimental_deoptimize: {
4413 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4414 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4415 "experimental_deoptimize must have exactly one "
4416 "\"deopt\" operand bundle");
4417 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4418 "experimental_deoptimize return type must match caller return type");
4419
4420 if (CS.isCall()) {
4421 auto *DeoptCI = CS.getInstruction();
4422 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4423 Assert(RI,
4424 "calls to experimental_deoptimize must be followed by a return");
4425
4426 if (!CS.getType()->isVoidTy() && RI)
4427 Assert(RI->getReturnValue() == DeoptCI,
4428 "calls to experimental_deoptimize must be followed by a return "
4429 "of the value computed by experimental_deoptimize");
4430 }
4431
4432 break;
4433 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004434 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004435}
4436
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004437/// \brief Carefully grab the subprogram from a local scope.
4438///
4439/// This carefully grabs the subprogram from a local scope, avoiding the
4440/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004441static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004442 if (!LocalScope)
4443 return nullptr;
4444
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004445 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004446 return SP;
4447
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004448 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004449 return getSubprogram(LB->getRawScope());
4450
4451 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004452 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004453 return nullptr;
4454}
4455
Andrew Kaylora0a11642017-01-26 23:27:59 +00004456void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
Andrew Kaylorf4660012017-05-25 21:31:00 +00004457 unsigned NumOperands = FPI.getNumArgOperands();
Wei Dinga131d3f2017-08-24 04:18:24 +00004458 Assert(((NumOperands == 5 && FPI.isTernaryOp()) ||
4459 (NumOperands == 3 && FPI.isUnaryOp()) || (NumOperands == 4)),
4460 "invalid arguments for constrained FP intrinsic", &FPI);
Andrew Kaylorf4660012017-05-25 21:31:00 +00004461 Assert(isa<MetadataAsValue>(FPI.getArgOperand(NumOperands-1)),
4462 "invalid exception behavior argument", &FPI);
4463 Assert(isa<MetadataAsValue>(FPI.getArgOperand(NumOperands-2)),
Andrew Kaylora0a11642017-01-26 23:27:59 +00004464 "invalid rounding mode argument", &FPI);
4465 Assert(FPI.getRoundingMode() != ConstrainedFPIntrinsic::rmInvalid,
4466 "invalid rounding mode argument", &FPI);
4467 Assert(FPI.getExceptionBehavior() != ConstrainedFPIntrinsic::ebInvalid,
4468 "invalid exception behavior argument", &FPI);
4469}
4470
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004471void Verifier::visitDbgIntrinsic(StringRef Kind, DbgInfoIntrinsic &DII) {
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004472 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004473 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004474 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4475 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004476 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004477 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4478 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004479 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004480 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4481 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004482
4483 // Ignore broken !dbg attachments; they're checked elsewhere.
4484 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004485 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004486 return;
4487
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004488 BasicBlock *BB = DII.getParent();
4489 Function *F = BB ? BB->getParent() : nullptr;
4490
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004491 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004492 DILocalVariable *Var = DII.getVariable();
4493 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004494 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4495 &DII, BB, F);
4496
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004497 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4498 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004499 if (!VarSP || !LocSP)
4500 return; // Broken scope chains are checked elsewhere.
4501
Adrian Prantla2ef0472016-09-14 17:30:37 +00004502 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4503 " variable and !dbg attachment",
4504 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4505 Loc->getScope()->getSubprogram());
Adrian Prantl612ac862017-02-28 23:48:42 +00004506
4507 verifyFnArgs(DII);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004508}
4509
Adrian Prantl941fa752016-12-05 18:04:47 +00004510void Verifier::verifyFragmentExpression(const DbgInfoIntrinsic &I) {
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004511 DILocalVariable *V = dyn_cast_or_null<DILocalVariable>(I.getRawVariable());
4512 DIExpression *E = dyn_cast_or_null<DIExpression>(I.getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004513
4514 // We don't know whether this intrinsic verified correctly.
4515 if (!V || !E || !E->isValid())
4516 return;
4517
Adrian Prantl28454ef2017-08-31 00:07:33 +00004518 // Nothing to do if this isn't a DW_OP_LLVM_fragment expression.
Adrian Prantl49797ca2016-12-22 05:27:12 +00004519 auto Fragment = E->getFragmentInfo();
4520 if (!Fragment)
Keno Fischer253a7bd2016-01-15 02:12:38 +00004521 return;
4522
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004523 // The frontend helps out GDB by emitting the members of local anonymous
4524 // unions as artificial local variables with shared storage. When SROA splits
4525 // the storage for artificial local variables that are smaller than the entire
4526 // union, the overhang piece will be outside of the allotted space for the
4527 // variable and this check fails.
4528 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4529 if (V->isArtificial())
4530 return;
4531
Adrian Prantl28454ef2017-08-31 00:07:33 +00004532 verifyFragmentExpression(*V, *Fragment, &I);
4533}
4534
4535template <typename ValueOrMetadata>
4536void Verifier::verifyFragmentExpression(const DIVariable &V,
4537 DIExpression::FragmentInfo Fragment,
4538 ValueOrMetadata *Desc) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004539 // If there's no size, the type is broken, but that should be checked
4540 // elsewhere.
Adrian Prantl3e0e1d02017-11-28 00:57:51 +00004541 auto VarSize = V.getSizeInBits();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004542 if (!VarSize)
4543 return;
4544
Adrian Prantl28454ef2017-08-31 00:07:33 +00004545 unsigned FragSize = Fragment.SizeInBits;
4546 unsigned FragOffset = Fragment.OffsetInBits;
Adrian Prantl3e0e1d02017-11-28 00:57:51 +00004547 AssertDI(FragSize + FragOffset <= *VarSize,
Adrian Prantl28454ef2017-08-31 00:07:33 +00004548 "fragment is larger than or outside of variable", Desc, &V);
Adrian Prantl3e0e1d02017-11-28 00:57:51 +00004549 AssertDI(FragSize != *VarSize, "fragment covers entire variable", Desc, &V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004550}
4551
Adrian Prantl612ac862017-02-28 23:48:42 +00004552void Verifier::verifyFnArgs(const DbgInfoIntrinsic &I) {
Adrian Prantl63d96952017-03-07 17:28:54 +00004553 // This function does not take the scope of noninlined function arguments into
4554 // account. Don't run it if current function is nodebug, because it may
4555 // contain inlined debug intrinsics.
4556 if (!HasDebugInfo)
4557 return;
4558
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004559 // For performance reasons only check non-inlined ones.
4560 if (I.getDebugLoc()->getInlinedAt())
4561 return;
4562
4563 DILocalVariable *Var = I.getVariable();
Adrian Prantl612ac862017-02-28 23:48:42 +00004564 AssertDI(Var, "dbg intrinsic without variable");
4565
4566 unsigned ArgNo = Var->getArg();
4567 if (!ArgNo)
4568 return;
4569
4570 // Verify there are no duplicate function argument debug info entries.
4571 // These will cause hard-to-debug assertions in the DWARF backend.
4572 if (DebugFnArgs.size() < ArgNo)
4573 DebugFnArgs.resize(ArgNo, nullptr);
4574
4575 auto *Prev = DebugFnArgs[ArgNo - 1];
4576 DebugFnArgs[ArgNo - 1] = Var;
4577 AssertDI(!Prev || (Prev == Var), "conflicting debug info for argument", &I,
4578 Prev, Var);
4579}
4580
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004581void Verifier::verifyCompileUnits() {
Adrian Prantl5a82f0a42017-10-18 01:11:01 +00004582 // When more than one Module is imported into the same context, such as during
4583 // an LTO build before linking the modules, ODR type uniquing may cause types
4584 // to point to a different CU. This check does not make sense in this case.
4585 if (M.getContext().isODRUniquingDebugTypes())
4586 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004587 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004588 SmallPtrSet<const Metadata *, 2> Listed;
4589 if (CUs)
4590 Listed.insert(CUs->op_begin(), CUs->op_end());
Davide Italianoa9de0102017-02-20 22:51:42 +00004591 for (auto *CU : CUVisited)
4592 AssertDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU);
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004593 CUVisited.clear();
4594}
4595
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004596void Verifier::verifyDeoptimizeCallingConvs() {
4597 if (DeoptimizeDeclarations.empty())
4598 return;
4599
4600 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004601 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004602 Assert(First->getCallingConv() == F->getCallingConv(),
4603 "All llvm.experimental.deoptimize declarations must have the same "
4604 "calling convention",
4605 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004606 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004607}
4608
Chris Lattner0e851da2002-04-18 20:37:37 +00004609//===----------------------------------------------------------------------===//
4610// Implement the public interfaces to this file...
4611//===----------------------------------------------------------------------===//
4612
Chandler Carruth043949d2014-01-19 02:22:18 +00004613bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004614 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004615
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004616 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004617 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004618
4619 // Note that this function's return value is inverted from what you would
4620 // expect of a function called "verify".
4621 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004622}
4623
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004624bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4625 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004626 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004627 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004628
Chandler Carruth043949d2014-01-19 02:22:18 +00004629 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004630 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004631 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004632
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004633 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004634 if (BrokenDebugInfo)
4635 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004636 // Note that this function's return value is inverted from what you would
4637 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004638 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004639}
Chandler Carruth043949d2014-01-19 02:22:18 +00004640
4641namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004642
Chandler Carruth4d356312014-01-20 11:34:08 +00004643struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004644 static char ID;
4645
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004646 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004647 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004648
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004649 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004650 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004651 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004652 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004653 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004654 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004655 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004656 }
4657
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004658 bool doInitialization(Module &M) override {
4659 V = llvm::make_unique<Verifier>(
4660 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4661 return false;
4662 }
4663
Craig Topperf398d7c2014-03-05 06:35:38 +00004664 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004665 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004666 report_fatal_error("Broken function found, compilation aborted!");
4667
4668 return false;
4669 }
4670
Craig Topperf398d7c2014-03-05 06:35:38 +00004671 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004672 bool HasErrors = false;
4673 for (Function &F : M)
4674 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004675 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004676
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004677 HasErrors |= !V->verify();
Adrian Prantla8b2ddb2017-10-02 18:31:29 +00004678 if (FatalErrors && (HasErrors || V->hasBrokenDebugInfo()))
4679 report_fatal_error("Broken module found, compilation aborted!");
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004680 return false;
4681 }
4682
4683 void getAnalysisUsage(AnalysisUsage &AU) const override {
4684 AU.setPreservesAll();
4685 }
4686};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004687
4688} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004689
Mehdi Aminia84a8402016-12-16 06:29:14 +00004690/// Helper to issue failure from the TBAA verification
4691template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
4692 if (Diagnostic)
4693 return Diagnostic->CheckFailed(Args...);
4694}
4695
4696#define AssertTBAA(C, ...) \
4697 do { \
4698 if (!(C)) { \
4699 CheckFailed(__VA_ARGS__); \
4700 return false; \
4701 } \
4702 } while (false)
4703
4704/// Verify that \p BaseNode can be used as the "base type" in the struct-path
4705/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
4706/// struct-type node describing an aggregate data structure (like a struct).
4707TBAAVerifier::TBAABaseNodeSummary
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004708TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode,
4709 bool IsNewFormat) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004710 if (BaseNode->getNumOperands() < 2) {
4711 CheckFailed("Base nodes must have at least two operands", &I, BaseNode);
4712 return {true, ~0u};
4713 }
4714
4715 auto Itr = TBAABaseNodes.find(BaseNode);
4716 if (Itr != TBAABaseNodes.end())
4717 return Itr->second;
4718
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004719 auto Result = verifyTBAABaseNodeImpl(I, BaseNode, IsNewFormat);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004720 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
4721 (void)InsertResult;
4722 assert(InsertResult.second && "We just checked!");
4723 return Result;
4724}
4725
4726TBAAVerifier::TBAABaseNodeSummary
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004727TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode,
4728 bool IsNewFormat) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004729 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
4730
4731 if (BaseNode->getNumOperands() == 2) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004732 // Scalar nodes can only be accessed at offset 0.
Sanjoy Das00d76a52016-12-29 15:47:05 +00004733 return isValidScalarTBAANode(BaseNode)
4734 ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
4735 : InvalidNode;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004736 }
4737
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004738 if (IsNewFormat) {
4739 if (BaseNode->getNumOperands() % 3 != 0) {
4740 CheckFailed("Access tag nodes must have the number of operands that is a "
4741 "multiple of 3!", BaseNode);
4742 return InvalidNode;
4743 }
4744 } else {
4745 if (BaseNode->getNumOperands() % 2 != 1) {
4746 CheckFailed("Struct tag nodes must have an odd number of operands!",
4747 BaseNode);
4748 return InvalidNode;
4749 }
Mehdi Aminia84a8402016-12-16 06:29:14 +00004750 }
4751
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004752 // Check the type size field.
4753 if (IsNewFormat) {
4754 auto *TypeSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
4755 BaseNode->getOperand(1));
4756 if (!TypeSizeNode) {
4757 CheckFailed("Type size nodes must be constants!", &I, BaseNode);
4758 return InvalidNode;
4759 }
4760 }
4761
4762 // Check the type name field. In the new format it can be anything.
4763 if (!IsNewFormat && !isa<MDString>(BaseNode->getOperand(0))) {
Sanjoy Das00d76a52016-12-29 15:47:05 +00004764 CheckFailed("Struct tag nodes have a string as their first operand",
4765 BaseNode);
4766 return InvalidNode;
4767 }
4768
Mehdi Aminia84a8402016-12-16 06:29:14 +00004769 bool Failed = false;
4770
4771 Optional<APInt> PrevOffset;
4772 unsigned BitWidth = ~0u;
4773
4774 // We've already checked that BaseNode is not a degenerate root node with one
4775 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004776 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
4777 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
4778 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
4779 Idx += NumOpsPerField) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004780 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
4781 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
4782 if (!isa<MDNode>(FieldTy)) {
4783 CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode);
4784 Failed = true;
4785 continue;
4786 }
4787
4788 auto *OffsetEntryCI =
4789 mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset);
4790 if (!OffsetEntryCI) {
4791 CheckFailed("Offset entries must be constants!", &I, BaseNode);
4792 Failed = true;
4793 continue;
4794 }
4795
4796 if (BitWidth == ~0u)
4797 BitWidth = OffsetEntryCI->getBitWidth();
4798
4799 if (OffsetEntryCI->getBitWidth() != BitWidth) {
4800 CheckFailed(
4801 "Bitwidth between the offsets and struct type entries must match", &I,
4802 BaseNode);
4803 Failed = true;
4804 continue;
4805 }
4806
4807 // NB! As far as I can tell, we generate a non-strictly increasing offset
4808 // sequence only from structs that have zero size bit fields. When
4809 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
4810 // pick the field lexically the latest in struct type metadata node. This
4811 // mirrors the actual behavior of the alias analysis implementation.
4812 bool IsAscending =
4813 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
4814
4815 if (!IsAscending) {
4816 CheckFailed("Offsets must be increasing!", &I, BaseNode);
4817 Failed = true;
4818 }
4819
4820 PrevOffset = OffsetEntryCI->getValue();
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004821
4822 if (IsNewFormat) {
4823 auto *MemberSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
4824 BaseNode->getOperand(Idx + 2));
4825 if (!MemberSizeNode) {
4826 CheckFailed("Member size entries must be constants!", &I, BaseNode);
4827 Failed = true;
4828 continue;
4829 }
4830 }
Mehdi Aminia84a8402016-12-16 06:29:14 +00004831 }
4832
4833 return Failed ? InvalidNode
4834 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
4835}
4836
4837static bool IsRootTBAANode(const MDNode *MD) {
4838 return MD->getNumOperands() < 2;
4839}
4840
4841static bool IsScalarTBAANodeImpl(const MDNode *MD,
4842 SmallPtrSetImpl<const MDNode *> &Visited) {
Sanjoy Das00d76a52016-12-29 15:47:05 +00004843 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004844 return false;
4845
Sanjoy Das00d76a52016-12-29 15:47:05 +00004846 if (!isa<MDString>(MD->getOperand(0)))
Mehdi Aminia84a8402016-12-16 06:29:14 +00004847 return false;
4848
Sanjoy Das00d76a52016-12-29 15:47:05 +00004849 if (MD->getNumOperands() == 3) {
4850 auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
4851 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
4852 return false;
4853 }
4854
4855 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4856 return Parent && Visited.insert(Parent).second &&
Mehdi Aminia84a8402016-12-16 06:29:14 +00004857 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
4858}
4859
Sanjoy Das55f12d92016-12-29 15:46:57 +00004860bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
4861 auto ResultIt = TBAAScalarNodes.find(MD);
4862 if (ResultIt != TBAAScalarNodes.end())
4863 return ResultIt->second;
4864
Mehdi Aminia84a8402016-12-16 06:29:14 +00004865 SmallPtrSet<const MDNode *, 4> Visited;
Sanjoy Das55f12d92016-12-29 15:46:57 +00004866 bool Result = IsScalarTBAANodeImpl(MD, Visited);
4867 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
4868 (void)InsertResult;
4869 assert(InsertResult.second && "Just checked!");
4870
4871 return Result;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004872}
4873
4874/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
4875/// Offset in place to be the offset within the field node returned.
4876///
4877/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
4878MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I,
Sanjoy Das600d2a52016-12-29 15:47:01 +00004879 const MDNode *BaseNode,
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004880 APInt &Offset,
4881 bool IsNewFormat) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004882 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
4883
4884 // Scalar nodes have only one possible "field" -- their parent in the access
4885 // hierarchy. Offset must be zero at this point, but our caller is supposed
4886 // to Assert that.
4887 if (BaseNode->getNumOperands() == 2)
4888 return cast<MDNode>(BaseNode->getOperand(1));
4889
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004890 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
4891 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
4892 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
4893 Idx += NumOpsPerField) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004894 auto *OffsetEntryCI =
4895 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
4896 if (OffsetEntryCI->getValue().ugt(Offset)) {
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004897 if (Idx == FirstFieldOpNo) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004898 CheckFailed("Could not find TBAA parent in struct type node", &I,
4899 BaseNode, &Offset);
4900 return nullptr;
4901 }
4902
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004903 unsigned PrevIdx = Idx - NumOpsPerField;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004904 auto *PrevOffsetEntryCI =
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004905 mdconst::extract<ConstantInt>(BaseNode->getOperand(PrevIdx + 1));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004906 Offset -= PrevOffsetEntryCI->getValue();
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004907 return cast<MDNode>(BaseNode->getOperand(PrevIdx));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004908 }
4909 }
4910
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004911 unsigned LastIdx = BaseNode->getNumOperands() - NumOpsPerField;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004912 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004913 BaseNode->getOperand(LastIdx + 1));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004914 Offset -= LastOffsetEntryCI->getValue();
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004915 return cast<MDNode>(BaseNode->getOperand(LastIdx));
4916}
4917
4918static bool isNewFormatTBAATypeNode(llvm::MDNode *Type) {
4919 if (!Type || Type->getNumOperands() < 3)
4920 return false;
4921
4922 // In the new format type nodes shall have a reference to the parent type as
4923 // its first operand.
4924 MDNode *Parent = dyn_cast_or_null<MDNode>(Type->getOperand(0));
4925 if (!Parent)
4926 return false;
4927
4928 return true;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004929}
4930
Sanjoy Das600d2a52016-12-29 15:47:01 +00004931bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004932 AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) ||
Sanjoy Das600d2a52016-12-29 15:47:01 +00004933 isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) ||
4934 isa<AtomicCmpXchgInst>(I),
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004935 "This instruction shall not have a TBAA access tag!", &I);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004936
4937 bool IsStructPathTBAA =
4938 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
4939
4940 AssertTBAA(
4941 IsStructPathTBAA,
4942 "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I);
4943
Mehdi Aminia84a8402016-12-16 06:29:14 +00004944 MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
4945 MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4946
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004947 bool IsNewFormat = isNewFormatTBAATypeNode(AccessType);
4948
4949 if (IsNewFormat) {
4950 AssertTBAA(MD->getNumOperands() == 4 || MD->getNumOperands() == 5,
4951 "Access tag metadata must have either 4 or 5 operands", &I, MD);
4952 } else {
4953 AssertTBAA(MD->getNumOperands() < 5,
4954 "Struct tag metadata must have either 3 or 4 operands", &I, MD);
4955 }
4956
4957 // Check the access size field.
4958 if (IsNewFormat) {
4959 auto *AccessSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
4960 MD->getOperand(3));
4961 AssertTBAA(AccessSizeNode, "Access size field must be a constant", &I, MD);
4962 }
4963
4964 // Check the immutability flag.
4965 unsigned ImmutabilityFlagOpNo = IsNewFormat ? 4 : 3;
4966 if (MD->getNumOperands() == ImmutabilityFlagOpNo + 1) {
4967 auto *IsImmutableCI = mdconst::dyn_extract_or_null<ConstantInt>(
4968 MD->getOperand(ImmutabilityFlagOpNo));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004969 AssertTBAA(IsImmutableCI,
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004970 "Immutability tag on struct tag metadata must be a constant",
4971 &I, MD);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004972 AssertTBAA(
4973 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
4974 "Immutability part of the struct tag metadata must be either 0 or 1",
4975 &I, MD);
4976 }
4977
4978 AssertTBAA(BaseNode && AccessType,
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004979 "Malformed struct tag metadata: base and access-type "
Mehdi Aminia84a8402016-12-16 06:29:14 +00004980 "should be non-null and point to Metadata nodes",
4981 &I, MD, BaseNode, AccessType);
4982
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004983 if (!IsNewFormat) {
4984 AssertTBAA(isValidScalarTBAANode(AccessType),
4985 "Access type node must be a valid scalar type", &I, MD,
4986 AccessType);
4987 }
Mehdi Aminia84a8402016-12-16 06:29:14 +00004988
4989 auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2));
4990 AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD);
4991
4992 APInt Offset = OffsetCI->getValue();
4993 bool SeenAccessTypeInPath = false;
4994
4995 SmallPtrSet<MDNode *, 4> StructPath;
4996
4997 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004998 BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset,
4999 IsNewFormat)) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00005000 if (!StructPath.insert(BaseNode).second) {
5001 CheckFailed("Cycle detected in struct path", &I, MD);
5002 return false;
5003 }
5004
5005 bool Invalid;
5006 unsigned BaseNodeBitWidth;
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00005007 std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode,
5008 IsNewFormat);
Mehdi Aminia84a8402016-12-16 06:29:14 +00005009
5010 // If the base node is invalid in itself, then we've already printed all the
5011 // errors we wanted to print.
5012 if (Invalid)
5013 return false;
5014
5015 SeenAccessTypeInPath |= BaseNode == AccessType;
5016
Sanjoy Das55f12d92016-12-29 15:46:57 +00005017 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
Mehdi Aminia84a8402016-12-16 06:29:14 +00005018 AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access",
5019 &I, MD, &Offset);
5020
5021 AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00005022 (BaseNodeBitWidth == 0 && Offset == 0) ||
5023 (IsNewFormat && BaseNodeBitWidth == ~0u),
Mehdi Aminia84a8402016-12-16 06:29:14 +00005024 "Access bit-width not the same as description bit-width", &I, MD,
5025 BaseNodeBitWidth, Offset.getBitWidth());
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00005026
5027 if (IsNewFormat && SeenAccessTypeInPath)
5028 break;
Mehdi Aminia84a8402016-12-16 06:29:14 +00005029 }
5030
5031 AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!",
5032 &I, MD);
5033 return true;
5034}
5035
Chandler Carruth4d356312014-01-20 11:34:08 +00005036char VerifierLegacyPass::ID = 0;
5037INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00005038
5039FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00005040 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00005041}
5042
Chandler Carruthdab4eae2016-11-23 17:53:26 +00005043AnalysisKey VerifierAnalysis::Key;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00005044VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
5045 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00005046 Result Res;
5047 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
5048 return Res;
5049}
Chandler Carruth4d356312014-01-20 11:34:08 +00005050
Chandler Carruth164a2aa62016-06-17 00:11:01 +00005051VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
5052 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00005053 return { llvm::verifyFunction(F, &dbgs()), false };
5054}
5055
5056PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
5057 auto Res = AM.getResult<VerifierAnalysis>(M);
Adrian Prantla8b2ddb2017-10-02 18:31:29 +00005058 if (FatalErrors && (Res.IRBroken || Res.DebugInfoBroken))
5059 report_fatal_error("Broken module found, compilation aborted!");
Adrian Prantle3656182016-05-09 19:57:29 +00005060
Chandler Carruth4d356312014-01-20 11:34:08 +00005061 return PreservedAnalyses::all();
5062}
5063
Adrian Prantle3656182016-05-09 19:57:29 +00005064PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
5065 auto res = AM.getResult<VerifierAnalysis>(F);
5066 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00005067 report_fatal_error("Broken function found, compilation aborted!");
5068
5069 return PreservedAnalyses::all();
5070}