blob: b83201f982ff79cbf567deea229c336930dff4bd [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"
Paul Robinsoncc9c8b92018-01-11 22:03:43 +000058#include "llvm/ADT/StringExtras.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000059#include "llvm/ADT/StringMap.h"
60#include "llvm/ADT/StringRef.h"
61#include "llvm/ADT/Twine.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000062#include "llvm/ADT/ilist.h"
Zachary Turner264b5d92017-06-07 03:48:56 +000063#include "llvm/BinaryFormat/Dwarf.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000064#include "llvm/IR/Argument.h"
65#include "llvm/IR/Attributes.h"
66#include "llvm/IR/BasicBlock.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000067#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000068#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000069#include "llvm/IR/CallingConv.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000070#include "llvm/IR/Comdat.h"
71#include "llvm/IR/Constant.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000072#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000073#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000074#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000075#include "llvm/IR/DebugInfo.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000076#include "llvm/IR/DebugInfoMetadata.h"
77#include "llvm/IR/DebugLoc.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000078#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000079#include "llvm/IR/Dominators.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000080#include "llvm/IR/Function.h"
81#include "llvm/IR/GlobalAlias.h"
82#include "llvm/IR/GlobalValue.h"
83#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000084#include "llvm/IR/InlineAsm.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000085#include "llvm/IR/InstVisitor.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000086#include "llvm/IR/InstrTypes.h"
87#include "llvm/IR/Instruction.h"
88#include "llvm/IR/Instructions.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000089#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000090#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000091#include "llvm/IR/LLVMContext.h"
92#include "llvm/IR/Metadata.h"
93#include "llvm/IR/Module.h"
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +000094#include "llvm/IR/ModuleSlotTracker.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000095#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000096#include "llvm/IR/Statepoint.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000097#include "llvm/IR/Type.h"
98#include "llvm/IR/Use.h"
99#include "llvm/IR/User.h"
100#include "llvm/IR/Value.h"
Chris Lattner8a923e72008-03-12 17:45:29 +0000101#include "llvm/Pass.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000102#include "llvm/Support/AtomicOrdering.h"
103#include "llvm/Support/Casting.h"
Manman Ren74c61b92013-07-19 00:31:03 +0000104#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +0000105#include "llvm/Support/Debug.h"
Torok Edwin6dd27302009-07-08 18:01:40 +0000106#include "llvm/Support/ErrorHandling.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000107#include "llvm/Support/MathExtras.h"
Chris Lattner24025262009-02-28 21:05:51 +0000108#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000109#include <algorithm>
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000110#include <cassert>
111#include <cstdint>
112#include <memory>
113#include <string>
114#include <utility>
115
Chris Lattner189d19f2003-11-21 20:23:48 +0000116using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +0000117
Daniel Jaspera44fd302016-12-16 13:53:46 +0000118namespace llvm {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000119
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000120struct VerifierSupport {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000121 raw_ostream *OS;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000122 const Module &M;
123 ModuleSlotTracker MST;
124 const DataLayout &DL;
125 LLVMContext &Context;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000126
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +0000127 /// Track the brokenness of the module while recursively visiting.
128 bool Broken = false;
Adrian Prantl541a9c52016-05-06 19:26:47 +0000129 /// Broken debug info can be "recovered" from by stripping the debug info.
130 bool BrokenDebugInfo = false;
131 /// Whether to treat broken debug info as an error.
132 bool TreatBrokenDebugInfoAsError = true;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000133
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000134 explicit VerifierSupport(raw_ostream *OS, const Module &M)
135 : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000136
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000137private:
Keno Fischera6c4ce42015-12-01 19:06:36 +0000138 void Write(const Module *M) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000139 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
Keno Fischera6c4ce42015-12-01 19:06:36 +0000140 }
141
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000142 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000143 if (!V)
144 return;
145 if (isa<Instruction>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000146 V->print(*OS, MST);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000147 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000148 } else {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000149 V->printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000150 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000151 }
152 }
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000153
Philip Reames9818dd72015-06-26 22:04:34 +0000154 void Write(ImmutableCallSite CS) {
155 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000156 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000157
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000158 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000159 if (!MD)
160 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000161 MD->print(*OS, MST, &M);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000162 *OS << '\n';
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000163 }
164
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000165 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
166 Write(MD.get());
167 }
168
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000169 void Write(const NamedMDNode *NMD) {
170 if (!NMD)
171 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000172 NMD->print(*OS, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000173 *OS << '\n';
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000174 }
175
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000176 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000177 if (!T)
178 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000179 *OS << ' ' << *T;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000180 }
181
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000182 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000183 if (!C)
184 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000185 *OS << *C;
David Majnemerdad0a642014-06-27 18:19:56 +0000186 }
187
Sanjoy Das3336f682016-12-11 20:07:15 +0000188 void Write(const APInt *AI) {
189 if (!AI)
190 return;
191 *OS << *AI << '\n';
192 }
193
194 void Write(const unsigned i) { *OS << i << '\n'; }
195
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000196 template <typename T> void Write(ArrayRef<T> Vs) {
197 for (const T &V : Vs)
198 Write(V);
199 }
200
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000201 template <typename T1, typename... Ts>
202 void WriteTs(const T1 &V1, const Ts &... Vs) {
203 Write(V1);
204 WriteTs(Vs...);
205 }
206
207 template <typename... Ts> void WriteTs() {}
208
209public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000210 /// \brief A check failed, so printout out the condition and the message.
211 ///
212 /// This provides a nice place to put a breakpoint if you want to see why
213 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000214 void CheckFailed(const Twine &Message) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000215 if (OS)
216 *OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000217 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000218 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000219
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000220 /// \brief A check failed (with values to print).
221 ///
222 /// This calls the Message-only version so that the above is easier to set a
223 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000224 template <typename T1, typename... Ts>
225 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
226 CheckFailed(Message);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000227 if (OS)
228 WriteTs(V1, Vs...);
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000229 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000230
231 /// A debug info check failed.
232 void DebugInfoCheckFailed(const Twine &Message) {
233 if (OS)
234 *OS << Message << '\n';
235 Broken |= TreatBrokenDebugInfoAsError;
236 BrokenDebugInfo = true;
237 }
238
239 /// A debug info check failed (with values to print).
240 template <typename T1, typename... Ts>
241 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
242 const Ts &... Vs) {
243 DebugInfoCheckFailed(Message);
244 if (OS)
245 WriteTs(V1, Vs...);
246 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000247};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000248
Daniel Jaspera44fd302016-12-16 13:53:46 +0000249} // namespace llvm
250
251namespace {
252
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000253class Verifier : public InstVisitor<Verifier>, VerifierSupport {
254 friend class InstVisitor<Verifier>;
255
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000256 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000257
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000258 /// \brief When verifying a basic block, keep track of all of the
259 /// instructions we have seen so far.
260 ///
261 /// This allows us to do efficient dominance checks for the case when an
262 /// instruction has an operand that is an instruction in the same block.
263 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000264
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000265 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000266 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000267
Adrian Prantlc10d0e52017-05-09 19:47:37 +0000268 /// Keep track which DISubprogram is attached to which function.
269 DenseMap<const DISubprogram *, const Function *> DISubprogramAttachments;
270
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000271 /// Track all DICompileUnits visited.
272 SmallPtrSet<const Metadata *, 2> CUVisited;
273
David Majnemer654e1302015-07-31 17:58:14 +0000274 /// \brief The result type for a landingpad.
275 Type *LandingPadResultTy;
276
Reid Kleckner60381792015-07-07 22:25:32 +0000277 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000278 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000279 bool SawFrameEscape;
280
Adrian Prantl63d96952017-03-07 17:28:54 +0000281 /// Whether the current function has a DISubprogram attached to it.
282 bool HasDebugInfo = false;
283
Reid Kleckner60381792015-07-07 22:25:32 +0000284 /// Stores the count of how many objects were passed to llvm.localescape for a
285 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000286 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000287
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000288 // Maps catchswitches and cleanuppads that unwind to siblings to the
289 // terminators that indicate the unwind, used to detect cycles therein.
290 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
291
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000292 /// Cache of constants visited in search of ConstantExprs.
293 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
294
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000295 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
296 SmallVector<const Function *, 4> DeoptimizeDeclarations;
297
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000298 // Verify that this GlobalValue is only used in this module.
299 // This map is used to avoid visiting uses twice. We can arrive at a user
300 // twice, if they have multiple operands. In particular for very large
301 // constant expressions, we can arrive at a particular user many times.
302 SmallPtrSet<const Value *, 32> GlobalValueVisited;
303
Adrian Prantl612ac862017-02-28 23:48:42 +0000304 // Keeps track of duplicate function argument debug info.
305 SmallVector<const DILocalVariable *, 16> DebugFnArgs;
306
Mehdi Aminia84a8402016-12-16 06:29:14 +0000307 TBAAVerifier TBAAVerifyHelper;
Sanjoy Das3336f682016-12-11 20:07:15 +0000308
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000309 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000310
Chandler Carruth043949d2014-01-19 02:22:18 +0000311public:
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000312 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
313 const Module &M)
314 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
Mehdi Aminia84a8402016-12-16 06:29:14 +0000315 SawFrameEscape(false), TBAAVerifyHelper(this) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000316 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
317 }
318
319 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
Chris Lattner0e851da2002-04-18 20:37:37 +0000320
Chandler Carruth043949d2014-01-19 02:22:18 +0000321 bool verify(const Function &F) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000322 assert(F.getParent() == &M &&
323 "An instance of this class only works with a specific module!");
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000324
325 // First ensure the function is well-enough formed to compute dominance
Peter Collingbourne71bb7942016-06-06 22:32:52 +0000326 // information, and directly compute a dominance tree. We don't rely on the
327 // pass manager to provide this as it isolates us from a potentially
328 // out-of-date dominator tree and makes it significantly more complex to run
329 // this code outside of a pass manager.
330 // FIXME: It's really gross that we have to cast away constness here.
331 if (!F.empty())
332 DT.recalculate(const_cast<Function &>(F));
333
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000334 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000335 if (!BB.empty() && BB.back().isTerminator())
336 continue;
337
338 if (OS) {
339 *OS << "Basic Block in function '" << F.getName()
340 << "' does not have terminator!\n";
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000341 BB.printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000342 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000343 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000344 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000345 }
Chandler Carruth76777602014-01-17 10:56:02 +0000346
Chandler Carruth043949d2014-01-19 02:22:18 +0000347 Broken = false;
348 // FIXME: We strip const here because the inst visitor strips const.
349 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000350 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000351 InstsInThisBlock.clear();
Adrian Prantl9b24a452017-03-07 17:28:49 +0000352 DebugFnArgs.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000353 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000354 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000355 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000356
Chandler Carruth043949d2014-01-19 02:22:18 +0000357 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000358 }
359
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000360 /// Verify the module that this instance of \c Verifier was initialized with.
361 bool verify() {
Chandler Carruth043949d2014-01-19 02:22:18 +0000362 Broken = false;
363
Peter Collingbournebb738172016-06-06 23:21:27 +0000364 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
365 for (const Function &F : M)
366 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
367 DeoptimizeDeclarations.push_back(&F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000368
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000369 // Now that we've visited every function, verify that we never asked to
370 // recover a frame index that wasn't escaped.
371 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000372 for (const GlobalVariable &GV : M.globals())
373 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000374
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000375 for (const GlobalAlias &GA : M.aliases())
376 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000377
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000378 for (const NamedMDNode &NMD : M.named_metadata())
379 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000380
David Majnemerdad0a642014-06-27 18:19:56 +0000381 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
382 visitComdat(SMEC.getValue());
383
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000384 visitModuleFlags(M);
385 visitModuleIdents(M);
386
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000387 verifyCompileUnits();
388
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000389 verifyDeoptimizeCallingConvs();
Adrian Prantlc10d0e52017-05-09 19:47:37 +0000390 DISubprogramAttachments.clear();
Chandler Carruth043949d2014-01-19 02:22:18 +0000391 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000392 }
Chris Lattner9713b842002-04-28 16:04:26 +0000393
Chandler Carruth043949d2014-01-19 02:22:18 +0000394private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000395 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000396 void visitGlobalValue(const GlobalValue &GV);
397 void visitGlobalVariable(const GlobalVariable &GV);
398 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000399 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000400 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000401 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000402 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000403 void visitMDNode(const MDNode &MD);
404 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
405 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000406 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000407 void visitModuleIdents(const Module &M);
408 void visitModuleFlags(const Module &M);
409 void visitModuleFlag(const MDNode *Op,
410 DenseMap<const MDString *, const MDNode *> &SeenIDs,
411 SmallVectorImpl<const MDNode *> &Requirements);
412 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000413 void visitBasicBlock(BasicBlock &BB);
Sanjoy Das26f28a22016-11-09 19:36:39 +0000414 void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty);
415 void visitDereferenceableMetadata(Instruction &I, MDNode *MD);
Sanjoy Das3336f682016-12-11 20:07:15 +0000416
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000417 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000418#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
419#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000420 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000421 void visitDIVariable(const DIVariable &N);
422 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
423 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000424
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000425 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
426
Chandler Carruth043949d2014-01-19 02:22:18 +0000427 // InstVisitor overrides...
428 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000429 void visit(Instruction &I);
430
431 void visitTruncInst(TruncInst &I);
432 void visitZExtInst(ZExtInst &I);
433 void visitSExtInst(SExtInst &I);
434 void visitFPTruncInst(FPTruncInst &I);
435 void visitFPExtInst(FPExtInst &I);
436 void visitFPToUIInst(FPToUIInst &I);
437 void visitFPToSIInst(FPToSIInst &I);
438 void visitUIToFPInst(UIToFPInst &I);
439 void visitSIToFPInst(SIToFPInst &I);
440 void visitIntToPtrInst(IntToPtrInst &I);
441 void visitPtrToIntInst(PtrToIntInst &I);
442 void visitBitCastInst(BitCastInst &I);
443 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
444 void visitPHINode(PHINode &PN);
445 void visitBinaryOperator(BinaryOperator &B);
446 void visitICmpInst(ICmpInst &IC);
447 void visitFCmpInst(FCmpInst &FC);
448 void visitExtractElementInst(ExtractElementInst &EI);
449 void visitInsertElementInst(InsertElementInst &EI);
450 void visitShuffleVectorInst(ShuffleVectorInst &EI);
451 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
452 void visitCallInst(CallInst &CI);
453 void visitInvokeInst(InvokeInst &II);
454 void visitGetElementPtrInst(GetElementPtrInst &GEP);
455 void visitLoadInst(LoadInst &LI);
456 void visitStoreInst(StoreInst &SI);
457 void verifyDominatesUse(Instruction &I, unsigned i);
458 void visitInstruction(Instruction &I);
459 void visitTerminatorInst(TerminatorInst &I);
460 void visitBranchInst(BranchInst &BI);
461 void visitReturnInst(ReturnInst &RI);
462 void visitSwitchInst(SwitchInst &SI);
463 void visitIndirectBrInst(IndirectBrInst &BI);
464 void visitSelectInst(SelectInst &SI);
465 void visitUserOp1(Instruction &I);
466 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000467 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Andrew Kaylora0a11642017-01-26 23:27:59 +0000468 void visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI);
Reid Kleckner3cdf7132017-09-07 22:46:24 +0000469 void visitDbgIntrinsic(StringRef Kind, DbgInfoIntrinsic &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000470 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
471 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
472 void visitFenceInst(FenceInst &FI);
473 void visitAllocaInst(AllocaInst &AI);
474 void visitExtractValueInst(ExtractValueInst &EVI);
475 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000476 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000477 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000478 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000479 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000480 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000481 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000482 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000483 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000484 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000485
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000486 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000487 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
488 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000489 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000490 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000491 unsigned ArgNo, std::string &Suffix);
Reid Klecknerb5180542017-03-21 16:57:19 +0000492 bool verifyAttributeCount(AttributeList Attrs, unsigned Params);
Reid Klecknera77172a2017-04-14 00:06:06 +0000493 void verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000494 const Value *V);
Reid Klecknera77172a2017-04-14 00:06:06 +0000495 void verifyParameterAttrs(AttributeSet Attrs, Type *Ty, const Value *V);
Reid Klecknerb5180542017-03-21 16:57:19 +0000496 void verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000497 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000498 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000499
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000500 void visitConstantExprsRecursively(const Constant *EntryC);
501 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000502 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000503 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000504 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000505
Adrian Prantl941fa752016-12-05 18:04:47 +0000506 void verifyFragmentExpression(const DbgInfoIntrinsic &I);
Adrian Prantl28454ef2017-08-31 00:07:33 +0000507 template <typename ValueOrMetadata>
508 void verifyFragmentExpression(const DIVariable &V,
509 DIExpression::FragmentInfo Fragment,
510 ValueOrMetadata *Desc);
Adrian Prantl612ac862017-02-28 23:48:42 +0000511 void verifyFnArgs(const DbgInfoIntrinsic &I);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000512
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000513 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000514 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000515
516 /// Module-level verification that all @llvm.experimental.deoptimize
517 /// declarations share the same calling convention.
518 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000519};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000520
521} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000522
Adrian Prantl541a9c52016-05-06 19:26:47 +0000523/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000524#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000525 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000526
Adrian Prantl541a9c52016-05-06 19:26:47 +0000527/// We know that a debug info condition should be true, if not print
528/// an error message.
529#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000530 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000531
Chris Lattnere5a22c02008-08-28 04:02:44 +0000532void Verifier::visit(Instruction &I) {
533 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000534 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000535 InstVisitor<Verifier>::visit(I);
536}
537
Keno Fischer60f82a22016-01-14 22:20:56 +0000538// Helper to recursively iterate over indirect users. By
539// returning false, the callback can ask to stop recursing
540// further.
541static void forEachUser(const Value *User,
542 SmallPtrSet<const Value *, 32> &Visited,
543 llvm::function_ref<bool(const Value *)> Callback) {
544 if (!Visited.insert(User).second)
545 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000546 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000547 if (Callback(TheNextUser))
548 forEachUser(TheNextUser, Visited, Callback);
549}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000550
Chandler Carruth043949d2014-01-19 02:22:18 +0000551void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000552 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000553 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000554
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000555 Assert(GV.getAlignment() <= Value::MaximumAlignment,
556 "huge alignment values are unsupported", &GV);
557 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
558 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000559
560 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000561 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000562 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000563 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000564 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000565
566 if (GV.isDeclarationForLinker())
567 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000568
Sean Fertilec70d28b2017-10-26 15:00:26 +0000569 if (GV.hasDLLImportStorageClass())
570 Assert(!GV.isDSOLocal(),
571 "GlobalValue with DLLImport Storage is dso_local!", &GV);
572
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000573 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000574 if (const Instruction *I = dyn_cast<Instruction>(V)) {
575 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000576 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
577 I);
578 else if (I->getParent()->getParent()->getParent() != &M)
579 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
580 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000581 I->getParent()->getParent()->getParent());
582 return false;
583 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000584 if (F->getParent() != &M)
585 CheckFailed("Global is used by function in a different module", &GV, &M,
586 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000587 return false;
588 }
589 return true;
590 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000591}
592
Chandler Carruth043949d2014-01-19 02:22:18 +0000593void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000594 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000595 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000596 "Global variable initializer type does not match global "
597 "variable type!",
598 &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000599 // If the global has common linkage, it must have a zero initializer and
600 // cannot be constant.
601 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000602 Assert(GV.getInitializer()->isNullValue(),
603 "'common' global must have a zero initializer!", &GV);
604 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
605 &GV);
606 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000607 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000608 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000609
Nick Lewycky466d0c12011-04-08 07:30:21 +0000610 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
611 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000612 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
613 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000614 // Don't worry about emitting an error for it not being an array,
615 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000616 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000617 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
618 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000619 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000620 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000621 Assert(STy &&
622 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
623 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
624 STy->getTypeAtIndex(1) == FuncPtrTy,
625 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000626 if (STy->getNumElements() == 3) {
627 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000628 Assert(ETy->isPointerTy() &&
629 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
630 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000631 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000632 }
633 }
634
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000635 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000636 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000637 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
638 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000639 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000640 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
641 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000642 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000643 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000644 const Constant *Init = GV.getInitializer();
645 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000646 Assert(InitArray, "wrong initalizer for intrinsic global variable",
647 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000648 for (Value *Op : InitArray->operands()) {
649 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000650 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
651 isa<GlobalAlias>(V),
652 "invalid llvm.used member", V);
653 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000654 }
655 }
656 }
657 }
658
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000659 Assert(!GV.hasDLLImportStorageClass() ||
660 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
661 GV.hasAvailableExternallyLinkage(),
662 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000663
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000664 // Visit any debug info attachments.
665 SmallVector<MDNode *, 1> MDs;
666 GV.getMetadata(LLVMContext::MD_dbg, MDs);
Adrian Prantldc6e0162016-12-20 02:33:30 +0000667 for (auto *MD : MDs) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000668 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD))
669 visitDIGlobalVariableExpression(*GVE);
670 else
Adrian Prantlfd37e792017-02-23 23:54:29 +0000671 AssertDI(false, "!dbg attachment of global variable must be a "
672 "DIGlobalVariableExpression");
Adrian Prantldc6e0162016-12-20 02:33:30 +0000673 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +0000674
Matt Arsenault24b49c42013-07-31 17:49:08 +0000675 if (!GV.hasInitializer()) {
676 visitGlobalValue(GV);
677 return;
678 }
679
680 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000681 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000682
Chris Lattnere3400652004-12-15 20:23:49 +0000683 visitGlobalValue(GV);
684}
685
Rafael Espindola64c1e182014-06-03 02:41:57 +0000686void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
687 SmallPtrSet<const GlobalAlias*, 4> Visited;
688 Visited.insert(&GA);
689 visitAliaseeSubExpr(Visited, GA, C);
690}
691
Craig Topper71b7b682014-08-21 05:55:13 +0000692void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000693 const GlobalAlias &GA, const Constant &C) {
694 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000695 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
696 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000697
698 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000699 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000700
Sanjoy Das5ce32722016-04-08 00:48:30 +0000701 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000702 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000703 } else {
704 // Only continue verifying subexpressions of GlobalAliases.
705 // Do not recurse into global initializers.
706 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000707 }
708 }
709
710 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000711 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000712
713 for (const Use &U : C.operands()) {
714 Value *V = &*U;
715 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
716 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
717 else if (const auto *C2 = dyn_cast<Constant>(V))
718 visitAliaseeSubExpr(Visited, GA, *C2);
719 }
720}
721
Chandler Carruth043949d2014-01-19 02:22:18 +0000722void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000723 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
724 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
725 "weak_odr, or external linkage!",
726 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000727 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000728 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
729 Assert(GA.getType() == Aliasee->getType(),
730 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000731
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000732 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
733 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000734
Rafael Espindola64c1e182014-06-03 02:41:57 +0000735 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000736
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000737 visitGlobalValue(GA);
738}
739
Chandler Carruth043949d2014-01-19 02:22:18 +0000740void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000741 // There used to be various other llvm.dbg.* nodes, but we don't support
742 // upgrading them and we want to reserve the namespace for future uses.
743 if (NMD.getName().startswith("llvm.dbg."))
Adrian Prantl7db6b5e2017-08-23 22:02:36 +0000744 AssertDI(NMD.getName() == "llvm.dbg.cu",
Adrian Prantlb3510af2016-10-05 22:15:37 +0000745 "unrecognized named metadata node in the llvm.dbg namespace",
746 &NMD);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000747 for (const MDNode *MD : NMD.operands()) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000748 if (NMD.getName() == "llvm.dbg.cu")
Adrian Prantl541a9c52016-05-06 19:26:47 +0000749 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000750
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000751 if (!MD)
752 continue;
753
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000754 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000755 }
756}
757
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000758void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000759 // Only visit each node once. Metadata can be mutually recursive, so this
760 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000761 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000762 return;
763
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000764 switch (MD.getMetadataID()) {
765 default:
766 llvm_unreachable("Invalid MDNode subclass");
767 case Metadata::MDTupleKind:
768 break;
769#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
770 case Metadata::CLASS##Kind: \
771 visit##CLASS(cast<CLASS>(MD)); \
772 break;
773#include "llvm/IR/Metadata.def"
774 }
775
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000776 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000777 if (!Op)
778 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000779 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
780 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000781 if (auto *N = dyn_cast<MDNode>(Op)) {
782 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000783 continue;
784 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000785 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
786 visitValueAsMetadata(*V, nullptr);
787 continue;
788 }
Duncan Sands76d62172010-04-29 16:10:30 +0000789 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000790
791 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000792 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
793 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000794}
795
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000796void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000797 Assert(MD.getValue(), "Expected valid value", &MD);
798 Assert(!MD.getValue()->getType()->isMetadataTy(),
799 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000800
801 auto *L = dyn_cast<LocalAsMetadata>(&MD);
802 if (!L)
803 return;
804
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000805 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000806
807 // If this was an instruction, bb, or argument, verify that it is in the
808 // function that we expect.
809 Function *ActualF = nullptr;
810 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000811 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000812 ActualF = I->getParent()->getParent();
813 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
814 ActualF = BB->getParent();
815 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
816 ActualF = A->getParent();
817 assert(ActualF && "Unimplemented function local metadata case!");
818
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000819 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000820}
821
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000822void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000823 Metadata *MD = MDV.getMetadata();
824 if (auto *N = dyn_cast<MDNode>(MD)) {
825 visitMDNode(*N);
826 return;
827 }
828
829 // Only visit each node once. Metadata can be mutually recursive, so this
830 // avoids infinite recursion here, as well as being an optimization.
831 if (!MDNodes.insert(MD).second)
832 return;
833
834 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
835 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000836}
837
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000838static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
839static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
840static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000841
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000842void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000843 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
844 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000845 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000846 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Adrian Prantl33aa8ac2017-08-23 21:52:24 +0000847 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
848 AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000849}
850
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000851void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000852 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000853}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000854
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000855void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000856 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000857 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000858}
859
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000860void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000861 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
862 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000863}
864
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000865void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000866 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000867}
868
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000869void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000870 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
871 N.getTag() == dwarf::DW_TAG_unspecified_type,
872 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000873}
874
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000875void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000876 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000877 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000878
Adrian Prantl541a9c52016-05-06 19:26:47 +0000879 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
880 N.getTag() == dwarf::DW_TAG_pointer_type ||
881 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
882 N.getTag() == dwarf::DW_TAG_reference_type ||
883 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
884 N.getTag() == dwarf::DW_TAG_const_type ||
885 N.getTag() == dwarf::DW_TAG_volatile_type ||
886 N.getTag() == dwarf::DW_TAG_restrict_type ||
Victor Leschuke1156c22016-10-31 19:09:38 +0000887 N.getTag() == dwarf::DW_TAG_atomic_type ||
Adrian Prantl541a9c52016-05-06 19:26:47 +0000888 N.getTag() == dwarf::DW_TAG_member ||
889 N.getTag() == dwarf::DW_TAG_inheritance ||
890 N.getTag() == dwarf::DW_TAG_friend,
891 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000892 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000893 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
894 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000895 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000896
Adrian Prantl541a9c52016-05-06 19:26:47 +0000897 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
898 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
899 N.getRawBaseType());
Konstantin Zhuravlyovd5561e02017-03-08 23:55:44 +0000900
901 if (N.getDWARFAddressSpace()) {
902 AssertDI(N.getTag() == dwarf::DW_TAG_pointer_type ||
903 N.getTag() == dwarf::DW_TAG_reference_type,
904 "DWARF address space only applies to pointer or reference types",
905 &N);
906 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000907}
908
Adrian Prantla29aac72018-01-05 01:13:37 +0000909/// Detect mutually exclusive flags.
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000910static bool hasConflictingReferenceFlags(unsigned Flags) {
Adrian Prantla29aac72018-01-05 01:13:37 +0000911 return ((Flags & DINode::FlagLValueReference) &&
912 (Flags & DINode::FlagRValueReference)) ||
913 ((Flags & DINode::FlagTypePassByValue) &&
914 (Flags & DINode::FlagTypePassByReference));
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000915}
916
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000917void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
918 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000919 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000920 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000921 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
922 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000923 }
924}
925
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000926void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000927 // Common scope checks.
928 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000929
Adrian Prantl541a9c52016-05-06 19:26:47 +0000930 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
931 N.getTag() == dwarf::DW_TAG_structure_type ||
932 N.getTag() == dwarf::DW_TAG_union_type ||
933 N.getTag() == dwarf::DW_TAG_enumeration_type ||
934 N.getTag() == dwarf::DW_TAG_class_type,
935 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000936
Adrian Prantl541a9c52016-05-06 19:26:47 +0000937 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
938 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
939 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000940
Adrian Prantl541a9c52016-05-06 19:26:47 +0000941 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
942 "invalid composite elements", &N, N.getRawElements());
943 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
944 N.getRawVTableHolder());
945 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
946 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000947 if (auto *Params = N.getRawTemplateParams())
948 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000949
950 if (N.getTag() == dwarf::DW_TAG_class_type ||
951 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000952 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
953 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000954 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000955}
956
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000957void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000958 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000959 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000960 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000961 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000962 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000963 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000964 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000965 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
966 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000967}
968
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000969void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000970 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Paul Robinsoncc9c8b92018-01-11 22:03:43 +0000971 AssertDI(N.getChecksumKind() <= DIFile::CSK_Last, "invalid checksum kind",
972 &N);
973 size_t Size;
974 switch (N.getChecksumKind()) {
975 case DIFile::CSK_None:
976 Size = 0;
977 break;
978 case DIFile::CSK_MD5:
979 Size = 32;
980 break;
981 case DIFile::CSK_SHA1:
982 Size = 40;
983 break;
984 }
985 AssertDI(N.getChecksum().size() == Size, "invalid checksum length", &N);
986 AssertDI(N.getChecksum().find_if_not(llvm::isHexDigit) == StringRef::npos,
987 "invalid checksum", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000988}
989
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000990void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000991 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
992 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000993
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000994 // Don't bother verifying the compilation directory or producer string
995 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000996 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
997 N.getRawFile());
998 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
999 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +00001000
Adrian Prantl541a9c52016-05-06 19:26:47 +00001001 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
1002 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +00001003
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001004 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001005 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001006 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001007 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001008 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
1009 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001010 }
1011 }
1012 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001013 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001014 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001015 AssertDI(Op && (isa<DIType>(Op) ||
1016 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00001017 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +00001018 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001019 }
1020 }
1021 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001022 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001023 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001024 AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)),
1025 "invalid global variable ref", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001026 }
1027 }
1028 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001029 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001030 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001031 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
1032 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +00001033 }
1034 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001035 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001036 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001037 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001038 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001039 }
1040 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +00001041 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001042}
1043
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001044void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001045 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
1046 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +00001047 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001048 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Justin Bognerefc3fbf2017-02-17 23:57:42 +00001049 else
1050 AssertDI(N.getLine() == 0, "line specified with no file", &N, N.getLine());
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001051 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001052 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1053 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1054 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001055 if (auto *Params = N.getRawTemplateParams())
1056 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001057 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001058 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1059 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001060 if (auto *RawVars = N.getRawVariables()) {
1061 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001062 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001063 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001064 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1065 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001066 }
1067 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001068 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1069 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001070
Adrian Prantl75819ae2016-04-15 15:57:41 +00001071 auto *Unit = N.getRawUnit();
1072 if (N.isDefinition()) {
1073 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001074 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1075 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1076 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001077 } else {
1078 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001079 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001080 }
Adrian Prantl1d12b882017-04-26 22:56:44 +00001081
1082 if (auto *RawThrownTypes = N.getRawThrownTypes()) {
1083 auto *ThrownTypes = dyn_cast<MDTuple>(RawThrownTypes);
1084 AssertDI(ThrownTypes, "invalid thrown types list", &N, RawThrownTypes);
1085 for (Metadata *Op : ThrownTypes->operands())
1086 AssertDI(Op && isa<DIType>(Op), "invalid thrown type", &N, ThrownTypes,
1087 Op);
1088 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001089}
1090
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001091void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001092 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1093 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1094 "invalid local scope", &N, N.getRawScope());
Adrian Prantl33aa8ac2017-08-23 21:52:24 +00001095 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope()))
1096 AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001097}
1098
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001099void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1100 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001101
Adrian Prantl541a9c52016-05-06 19:26:47 +00001102 AssertDI(N.getLine() || !N.getColumn(),
1103 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001104}
1105
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001106void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1107 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001108}
1109
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001110void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001111 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001112 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001113 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001114}
1115
Amjad Abouda9bcf162015-12-10 12:56:35 +00001116void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001117 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1118 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1119 "invalid macinfo type", &N);
1120 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001121 if (!N.getValue().empty()) {
1122 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1123 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001124}
1125
1126void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001127 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1128 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001129 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001130 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001131
1132 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001133 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001134 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001135 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001136 }
1137 }
1138}
1139
Adrian Prantlab1243f2015-06-29 23:03:47 +00001140void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001141 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1142 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001143}
1144
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001145void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001146 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001147}
1148
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001149void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1150 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001151
Adrian Prantl541a9c52016-05-06 19:26:47 +00001152 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1153 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001154}
1155
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001156void Verifier::visitDITemplateValueParameter(
1157 const DITemplateValueParameter &N) {
1158 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001159
Adrian Prantl541a9c52016-05-06 19:26:47 +00001160 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1161 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1162 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1163 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001164}
1165
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001166void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001167 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001168 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001169 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001170 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001171}
1172
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001173void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001174 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001175 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001176
Adrian Prantl541a9c52016-05-06 19:26:47 +00001177 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1178 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Davide Italiano26053812017-08-25 22:08:15 +00001179 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Davide Italianocd213782017-08-16 15:16:33 +00001180 AssertDI(N.getType(), "missing global variable type", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001181 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001182 AssertDI(isa<DIDerivedType>(Member),
1183 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001184 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001185}
1186
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001187void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001188 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001189 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001190
Davide Italiano21221192017-09-24 01:06:35 +00001191 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Adrian Prantl541a9c52016-05-06 19:26:47 +00001192 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1193 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1194 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001195}
1196
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001197void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001198 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001199}
1200
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001201void Verifier::visitDIGlobalVariableExpression(
1202 const DIGlobalVariableExpression &GVE) {
1203 AssertDI(GVE.getVariable(), "missing variable");
Davide Italiano21221192017-09-24 01:06:35 +00001204 if (auto *Var = GVE.getVariable())
1205 visitDIGlobalVariable(*Var);
Adrian Prantl28454ef2017-08-31 00:07:33 +00001206 if (auto *Expr = GVE.getExpression()) {
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001207 visitDIExpression(*Expr);
Adrian Prantl28454ef2017-08-31 00:07:33 +00001208 if (auto Fragment = Expr->getFragmentInfo())
1209 verifyFragmentExpression(*GVE.getVariable(), *Fragment, &GVE);
1210 }
Adrian Prantlbceaaa92016-12-20 02:09:43 +00001211}
1212
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001213void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001214 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001215 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001216 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001217 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001218 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001219}
1220
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001221void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001222 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1223 N.getTag() == dwarf::DW_TAG_imported_declaration,
1224 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001225 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001226 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1227 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1228 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001229}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001230
David Majnemerdad0a642014-06-27 18:19:56 +00001231void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001232 // The Module is invalid if the GlobalValue has private linkage. Entities
1233 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001234 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001235 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1236 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001237}
1238
Chandler Carruth043949d2014-01-19 02:22:18 +00001239void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001240 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001241 if (!Idents)
Rafael Espindola0018a592013-10-16 01:49:05 +00001242 return;
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001243
Rafael Espindola0018a592013-10-16 01:49:05 +00001244 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1245 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001246 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001247 Assert(N->getNumOperands() == 1,
1248 "incorrect number of operands in llvm.ident metadata", N);
1249 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1250 ("invalid value for llvm.ident metadata entry operand"
1251 "(the operand should be a string)"),
1252 N->getOperand(0));
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001253 }
Rafael Espindola0018a592013-10-16 01:49:05 +00001254}
1255
Chandler Carruth043949d2014-01-19 02:22:18 +00001256void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001257 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1258 if (!Flags) return;
1259
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001260 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001261 DenseMap<const MDString*, const MDNode*> SeenIDs;
1262 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001263 for (const MDNode *MDN : Flags->operands())
1264 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001265
1266 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001267 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001268 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001269 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001270
Chandler Carruth043949d2014-01-19 02:22:18 +00001271 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001272 if (!Op) {
1273 CheckFailed("invalid requirement on flag, flag is not present in module",
1274 Flag);
1275 continue;
1276 }
1277
1278 if (Op->getOperand(2) != ReqValue) {
1279 CheckFailed(("invalid requirement on flag, "
1280 "flag does not have the required value"),
1281 Flag);
1282 continue;
1283 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001284 }
1285}
1286
Chandler Carruth043949d2014-01-19 02:22:18 +00001287void
1288Verifier::visitModuleFlag(const MDNode *Op,
1289 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1290 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001291 // Each module flag should have three arguments, the merge behavior (a
1292 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001293 Assert(Op->getNumOperands() == 3,
1294 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001295 Module::ModFlagBehavior MFB;
1296 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001297 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001298 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001299 "invalid behavior operand in module flag (expected constant integer)",
1300 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001301 Assert(false,
1302 "invalid behavior operand in module flag (unexpected constant)",
1303 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001304 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001305 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001306 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1307 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001308
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001309 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001310 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001311 case Module::Error:
1312 case Module::Warning:
1313 case Module::Override:
1314 // These behavior types accept any value.
1315 break;
1316
Teresa Johnson2db13692017-05-23 00:08:00 +00001317 case Module::Max: {
1318 Assert(mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2)),
1319 "invalid value for 'max' module flag (expected constant integer)",
1320 Op->getOperand(2));
1321 break;
1322 }
1323
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001324 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001325 // The value should itself be an MDNode with two operands, a flag ID (an
1326 // MDString), and a value.
1327 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001328 Assert(Value && Value->getNumOperands() == 2,
1329 "invalid value for 'require' module flag (expected metadata pair)",
1330 Op->getOperand(2));
1331 Assert(isa<MDString>(Value->getOperand(0)),
1332 ("invalid value for 'require' module flag "
1333 "(first value operand should be a string)"),
1334 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001335
1336 // Append it to the list of requirements, to check once all module flags are
1337 // scanned.
1338 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001339 break;
1340 }
1341
1342 case Module::Append:
1343 case Module::AppendUnique: {
1344 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001345 Assert(isa<MDNode>(Op->getOperand(2)),
1346 "invalid value for 'append'-type module flag "
1347 "(expected a metadata node)",
1348 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001349 break;
1350 }
1351 }
1352
1353 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001354 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001355 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001356 Assert(Inserted,
1357 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001358 }
Matthias Braun89f3bcf2017-05-19 22:37:01 +00001359
1360 if (ID->getString() == "wchar_size") {
1361 ConstantInt *Value
1362 = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2));
1363 Assert(Value, "wchar_size metadata requires constant integer argument");
Matthias Braun89f3bcf2017-05-19 22:37:01 +00001364 }
Peter Collingbourne89061b22017-06-12 20:10:48 +00001365
1366 if (ID->getString() == "Linker Options") {
1367 // If the llvm.linker.options named metadata exists, we assume that the
1368 // bitcode reader has upgraded the module flag. Otherwise the flag might
1369 // have been created by a client directly.
1370 Assert(M.getNamedMetadata("llvm.linker.options"),
1371 "'Linker Options' named metadata no longer supported");
1372 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001373}
1374
Reid Klecknera77172a2017-04-14 00:06:06 +00001375/// Return true if this attribute kind only applies to functions.
1376static bool isFuncOnlyAttr(Attribute::AttrKind Kind) {
1377 switch (Kind) {
1378 case Attribute::NoReturn:
1379 case Attribute::NoUnwind:
1380 case Attribute::NoInline:
1381 case Attribute::AlwaysInline:
1382 case Attribute::OptimizeForSize:
1383 case Attribute::StackProtect:
1384 case Attribute::StackProtectReq:
1385 case Attribute::StackProtectStrong:
1386 case Attribute::SafeStack:
1387 case Attribute::NoRedZone:
1388 case Attribute::NoImplicitFloat:
1389 case Attribute::Naked:
1390 case Attribute::InlineHint:
1391 case Attribute::StackAlignment:
1392 case Attribute::UWTable:
1393 case Attribute::NonLazyBind:
1394 case Attribute::ReturnsTwice:
1395 case Attribute::SanitizeAddress:
Evgeniy Stepanovc667c1f2017-12-09 00:21:41 +00001396 case Attribute::SanitizeHWAddress:
Reid Klecknera77172a2017-04-14 00:06:06 +00001397 case Attribute::SanitizeThread:
1398 case Attribute::SanitizeMemory:
1399 case Attribute::MinSize:
1400 case Attribute::NoDuplicate:
1401 case Attribute::Builtin:
1402 case Attribute::NoBuiltin:
1403 case Attribute::Cold:
1404 case Attribute::OptimizeNone:
1405 case Attribute::JumpTable:
1406 case Attribute::Convergent:
1407 case Attribute::ArgMemOnly:
1408 case Attribute::NoRecurse:
1409 case Attribute::InaccessibleMemOnly:
1410 case Attribute::InaccessibleMemOrArgMemOnly:
1411 case Attribute::AllocSize:
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001412 case Attribute::Speculatable:
Andrew Kaylor53a5fbb2017-08-14 21:15:13 +00001413 case Attribute::StrictFP:
Reid Klecknera77172a2017-04-14 00:06:06 +00001414 return true;
1415 default:
1416 break;
1417 }
1418 return false;
1419}
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001420
Reid Klecknera77172a2017-04-14 00:06:06 +00001421/// Return true if this is a function attribute that can also appear on
1422/// arguments.
1423static bool isFuncOrArgAttr(Attribute::AttrKind Kind) {
1424 return Kind == Attribute::ReadOnly || Kind == Attribute::WriteOnly ||
1425 Kind == Attribute::ReadNone;
1426}
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001427
Reid Klecknera77172a2017-04-14 00:06:06 +00001428void Verifier::verifyAttributeTypes(AttributeSet Attrs, bool IsFunction,
1429 const Value *V) {
1430 for (Attribute A : Attrs) {
1431 if (A.isStringAttribute())
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001432 continue;
1433
Reid Klecknera77172a2017-04-14 00:06:06 +00001434 if (isFuncOnlyAttr(A.getKindAsEnum())) {
1435 if (!IsFunction) {
1436 CheckFailed("Attribute '" + A.getAsString() +
1437 "' only applies to functions!",
1438 V);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001439 return;
1440 }
Reid Klecknera77172a2017-04-14 00:06:06 +00001441 } else if (IsFunction && !isFuncOrArgAttr(A.getKindAsEnum())) {
1442 CheckFailed("Attribute '" + A.getAsString() +
1443 "' does not apply to functions!",
1444 V);
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001445 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001446 }
1447 }
1448}
1449
Duncan Sandsc3a79922009-06-11 08:11:03 +00001450// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001451// value of the specified type. The value V is printed in error messages.
Reid Klecknera77172a2017-04-14 00:06:06 +00001452void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty,
1453 const Value *V) {
1454 if (!Attrs.hasAttributes())
Duncan Sands0009c442008-01-12 16:42:01 +00001455 return;
1456
Reid Klecknera77172a2017-04-14 00:06:06 +00001457 verifyAttributeTypes(Attrs, /*IsFunction=*/false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001458
Reid Klecknera534a382013-12-19 02:14:12 +00001459 // Check for mutually incompatible attributes. Only inreg is compatible with
1460 // sret.
1461 unsigned AttrCount = 0;
Reid Klecknera77172a2017-04-14 00:06:06 +00001462 AttrCount += Attrs.hasAttribute(Attribute::ByVal);
1463 AttrCount += Attrs.hasAttribute(Attribute::InAlloca);
1464 AttrCount += Attrs.hasAttribute(Attribute::StructRet) ||
1465 Attrs.hasAttribute(Attribute::InReg);
1466 AttrCount += Attrs.hasAttribute(Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001467 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1468 "and 'sret' are incompatible!",
1469 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001470
Reid Klecknera77172a2017-04-14 00:06:06 +00001471 Assert(!(Attrs.hasAttribute(Attribute::InAlloca) &&
1472 Attrs.hasAttribute(Attribute::ReadOnly)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001473 "Attributes "
1474 "'inalloca and readonly' are incompatible!",
1475 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001476
Reid Klecknera77172a2017-04-14 00:06:06 +00001477 Assert(!(Attrs.hasAttribute(Attribute::StructRet) &&
1478 Attrs.hasAttribute(Attribute::Returned)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001479 "Attributes "
1480 "'sret and returned' are incompatible!",
1481 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001482
Reid Klecknera77172a2017-04-14 00:06:06 +00001483 Assert(!(Attrs.hasAttribute(Attribute::ZExt) &&
1484 Attrs.hasAttribute(Attribute::SExt)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001485 "Attributes "
1486 "'zeroext and signext' are incompatible!",
1487 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001488
Reid Klecknera77172a2017-04-14 00:06:06 +00001489 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1490 Attrs.hasAttribute(Attribute::ReadOnly)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001491 "Attributes "
1492 "'readnone and readonly' are incompatible!",
1493 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001494
Reid Klecknera77172a2017-04-14 00:06:06 +00001495 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) &&
1496 Attrs.hasAttribute(Attribute::WriteOnly)),
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001497 "Attributes "
1498 "'readnone and writeonly' are incompatible!",
1499 V);
1500
Reid Klecknera77172a2017-04-14 00:06:06 +00001501 Assert(!(Attrs.hasAttribute(Attribute::ReadOnly) &&
1502 Attrs.hasAttribute(Attribute::WriteOnly)),
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001503 "Attributes "
1504 "'readonly and writeonly' are incompatible!",
1505 V);
1506
Reid Klecknera77172a2017-04-14 00:06:06 +00001507 Assert(!(Attrs.hasAttribute(Attribute::NoInline) &&
1508 Attrs.hasAttribute(Attribute::AlwaysInline)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001509 "Attributes "
1510 "'noinline and alwaysinline' are incompatible!",
1511 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001512
Reid Klecknera77172a2017-04-14 00:06:06 +00001513 AttrBuilder IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty);
1514 Assert(!AttrBuilder(Attrs).overlaps(IncompatibleAttrs),
1515 "Wrong types for attribute: " +
1516 AttributeSet::get(Context, IncompatibleAttrs).getAsString(),
1517 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001518
Reid Klecknera534a382013-12-19 02:14:12 +00001519 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001520 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001521 if (!PTy->getElementType()->isSized(&Visited)) {
Reid Klecknera77172a2017-04-14 00:06:06 +00001522 Assert(!Attrs.hasAttribute(Attribute::ByVal) &&
1523 !Attrs.hasAttribute(Attribute::InAlloca),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001524 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1525 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001526 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001527 if (!isa<PointerType>(PTy->getElementType()))
Reid Klecknera77172a2017-04-14 00:06:06 +00001528 Assert(!Attrs.hasAttribute(Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00001529 "Attribute 'swifterror' only applies to parameters "
1530 "with pointer to pointer type!",
1531 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001532 } else {
Reid Klecknera77172a2017-04-14 00:06:06 +00001533 Assert(!Attrs.hasAttribute(Attribute::ByVal),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001534 "Attribute 'byval' only applies to parameters with pointer type!",
1535 V);
Reid Klecknera77172a2017-04-14 00:06:06 +00001536 Assert(!Attrs.hasAttribute(Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00001537 "Attribute 'swifterror' only applies to parameters "
1538 "with pointer type!",
1539 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001540 }
Duncan Sands0009c442008-01-12 16:42:01 +00001541}
1542
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001543// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001544// The value V is printed in error messages.
Reid Klecknerb5180542017-03-21 16:57:19 +00001545void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001546 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001547 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001548 return;
1549
Duncan Sands8c582282007-12-21 19:19:01 +00001550 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001551 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001552 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001553 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001554 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001555
Reid Klecknera77172a2017-04-14 00:06:06 +00001556 // Verify return value attributes.
1557 AttributeSet RetAttrs = Attrs.getRetAttributes();
1558 Assert((!RetAttrs.hasAttribute(Attribute::ByVal) &&
1559 !RetAttrs.hasAttribute(Attribute::Nest) &&
1560 !RetAttrs.hasAttribute(Attribute::StructRet) &&
1561 !RetAttrs.hasAttribute(Attribute::NoCapture) &&
1562 !RetAttrs.hasAttribute(Attribute::Returned) &&
1563 !RetAttrs.hasAttribute(Attribute::InAlloca) &&
1564 !RetAttrs.hasAttribute(Attribute::SwiftSelf) &&
1565 !RetAttrs.hasAttribute(Attribute::SwiftError)),
1566 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
1567 "'returned', 'swiftself', and 'swifterror' do not apply to return "
1568 "values!",
1569 V);
1570 Assert((!RetAttrs.hasAttribute(Attribute::ReadOnly) &&
1571 !RetAttrs.hasAttribute(Attribute::WriteOnly) &&
1572 !RetAttrs.hasAttribute(Attribute::ReadNone)),
1573 "Attribute '" + RetAttrs.getAsString() +
1574 "' does not apply to function returns",
1575 V);
1576 verifyParameterAttrs(RetAttrs, FT->getReturnType(), V);
Duncan Sands8c582282007-12-21 19:19:01 +00001577
Reid Klecknera77172a2017-04-14 00:06:06 +00001578 // Verify parameter attributes.
1579 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1580 Type *Ty = FT->getParamType(i);
1581 AttributeSet ArgAttrs = Attrs.getParamAttributes(i);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001582
Reid Klecknera77172a2017-04-14 00:06:06 +00001583 verifyParameterAttrs(ArgAttrs, Ty, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001584
Reid Klecknera77172a2017-04-14 00:06:06 +00001585 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001586 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001587 SawNest = true;
1588 }
1589
Reid Klecknera77172a2017-04-14 00:06:06 +00001590 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001591 Assert(!SawReturned, "More than one parameter has attribute returned!",
1592 V);
1593 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
Reid Klecknera77172a2017-04-14 00:06:06 +00001594 "Incompatible argument and return types for 'returned' attribute",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001595 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001596 SawReturned = true;
1597 }
1598
Reid Klecknera77172a2017-04-14 00:06:06 +00001599 if (ArgAttrs.hasAttribute(Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001600 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
Reid Klecknera77172a2017-04-14 00:06:06 +00001601 Assert(i == 0 || i == 1,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001602 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001603 SawSRet = true;
1604 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001605
Reid Klecknera77172a2017-04-14 00:06:06 +00001606 if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) {
Manman Renf46262e2016-03-29 17:37:21 +00001607 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1608 SawSwiftSelf = true;
1609 }
1610
Reid Klecknera77172a2017-04-14 00:06:06 +00001611 if (ArgAttrs.hasAttribute(Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00001612 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1613 V);
1614 SawSwiftError = true;
1615 }
1616
Reid Klecknera77172a2017-04-14 00:06:06 +00001617 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) {
1618 Assert(i == FT->getNumParams() - 1,
1619 "inalloca isn't on the last parameter!", V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001620 }
Duncan Sands8c582282007-12-21 19:19:01 +00001621 }
Devang Patel9cc98122008-10-01 23:41:25 +00001622
Reid Klecknerb5180542017-03-21 16:57:19 +00001623 if (!Attrs.hasAttributes(AttributeList::FunctionIndex))
Bill Wendling77543892013-01-18 21:11:39 +00001624 return;
1625
Reid Klecknera77172a2017-04-14 00:06:06 +00001626 verifyAttributeTypes(Attrs.getFnAttributes(), /*IsFunction=*/true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001627
Reid Klecknera77172a2017-04-14 00:06:06 +00001628 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1629 Attrs.hasFnAttribute(Attribute::ReadOnly)),
1630 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001631
Reid Klecknera77172a2017-04-14 00:06:06 +00001632 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1633 Attrs.hasFnAttribute(Attribute::WriteOnly)),
1634 "Attributes 'readnone and writeonly' are incompatible!", V);
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001635
Reid Klecknera77172a2017-04-14 00:06:06 +00001636 Assert(!(Attrs.hasFnAttribute(Attribute::ReadOnly) &&
1637 Attrs.hasFnAttribute(Attribute::WriteOnly)),
1638 "Attributes 'readonly and writeonly' are incompatible!", V);
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001639
Reid Klecknera77172a2017-04-14 00:06:06 +00001640 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1641 Attrs.hasFnAttribute(Attribute::InaccessibleMemOrArgMemOnly)),
1642 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are "
1643 "incompatible!",
1644 V);
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001645
Reid Klecknera77172a2017-04-14 00:06:06 +00001646 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) &&
1647 Attrs.hasFnAttribute(Attribute::InaccessibleMemOnly)),
1648 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001649
Reid Klecknera77172a2017-04-14 00:06:06 +00001650 Assert(!(Attrs.hasFnAttribute(Attribute::NoInline) &&
1651 Attrs.hasFnAttribute(Attribute::AlwaysInline)),
1652 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001653
Reid Klecknera77172a2017-04-14 00:06:06 +00001654 if (Attrs.hasFnAttribute(Attribute::OptimizeNone)) {
1655 Assert(Attrs.hasFnAttribute(Attribute::NoInline),
1656 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001657
Reid Klecknera77172a2017-04-14 00:06:06 +00001658 Assert(!Attrs.hasFnAttribute(Attribute::OptimizeForSize),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001659 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001660
Reid Klecknera77172a2017-04-14 00:06:06 +00001661 Assert(!Attrs.hasFnAttribute(Attribute::MinSize),
1662 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001663 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001664
Reid Klecknera77172a2017-04-14 00:06:06 +00001665 if (Attrs.hasFnAttribute(Attribute::JumpTable)) {
Tom Roeder44cb65f2014-06-05 19:29:43 +00001666 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001667 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001668 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001669 }
George Burgess IV278199f2016-04-12 01:05:35 +00001670
Reid Klecknera77172a2017-04-14 00:06:06 +00001671 if (Attrs.hasFnAttribute(Attribute::AllocSize)) {
George Burgess IV278199f2016-04-12 01:05:35 +00001672 std::pair<unsigned, Optional<unsigned>> Args =
Reid Klecknerb5180542017-03-21 16:57:19 +00001673 Attrs.getAllocSizeArgs(AttributeList::FunctionIndex);
George Burgess IV278199f2016-04-12 01:05:35 +00001674
1675 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1676 if (ParamNo >= FT->getNumParams()) {
1677 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1678 return false;
1679 }
1680
1681 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1682 CheckFailed("'allocsize' " + Name +
1683 " argument must refer to an integer parameter",
1684 V);
1685 return false;
1686 }
1687
1688 return true;
1689 };
1690
1691 if (!CheckParam("element size", Args.first))
1692 return;
1693
1694 if (Args.second && !CheckParam("number of elements", *Args.second))
1695 return;
1696 }
Duncan Sands8c582282007-12-21 19:19:01 +00001697}
1698
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001699void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001700 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001701 for (const auto &Pair : MDs) {
1702 if (Pair.first == LLVMContext::MD_prof) {
1703 MDNode *MD = Pair.second;
Dehao Chena60cdd32017-02-28 18:09:44 +00001704 Assert(MD->getNumOperands() >= 2,
1705 "!prof annotations should have no less than 2 operands", MD);
Diego Novillo2567f3d2015-05-13 15:13:45 +00001706
1707 // Check first operand.
1708 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1709 MD);
1710 Assert(isa<MDString>(MD->getOperand(0)),
1711 "expected string with name of the !prof annotation", MD);
1712 MDString *MDS = cast<MDString>(MD->getOperand(0));
1713 StringRef ProfName = MDS->getString();
Easwaran Ramanbdf20262018-01-09 19:39:35 +00001714 Assert(ProfName.equals("function_entry_count") ||
1715 ProfName.equals("synthetic_function_entry_count"),
1716 "first operand should be 'function_entry_count'"
1717 " or 'synthetic_function_entry_count'",
1718 MD);
Diego Novillo2567f3d2015-05-13 15:13:45 +00001719
1720 // Check second operand.
1721 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1722 MD);
1723 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1724 "expected integer argument to function_entry_count", MD);
1725 }
1726 }
1727}
1728
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001729void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1730 if (!ConstantExprVisited.insert(EntryC).second)
1731 return;
1732
1733 SmallVector<const Constant *, 16> Stack;
1734 Stack.push_back(EntryC);
1735
1736 while (!Stack.empty()) {
1737 const Constant *C = Stack.pop_back_val();
1738
1739 // Check this constant expression.
1740 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1741 visitConstantExpr(CE);
1742
Keno Fischerf6d17b92016-01-14 22:42:02 +00001743 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1744 // Global Values get visited separately, but we do need to make sure
1745 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001746 Assert(GV->getParent() == &M, "Referencing global in another module!",
1747 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001748 continue;
1749 }
1750
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001751 // Visit all sub-expressions.
1752 for (const Use &U : C->operands()) {
1753 const auto *OpC = dyn_cast<Constant>(U);
1754 if (!OpC)
1755 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001756 if (!ConstantExprVisited.insert(OpC).second)
1757 continue;
1758 Stack.push_back(OpC);
1759 }
1760 }
1761}
1762
1763void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001764 if (CE->getOpcode() == Instruction::BitCast)
1765 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1766 CE->getType()),
1767 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001768
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001769 if (CE->getOpcode() == Instruction::IntToPtr ||
1770 CE->getOpcode() == Instruction::PtrToInt) {
1771 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1772 ? CE->getType()
1773 : CE->getOperand(0)->getType();
1774 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1775 ? "inttoptr not supported for non-integral pointers"
1776 : "ptrtoint not supported for non-integral pointers";
1777 Assert(
1778 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1779 Msg);
1780 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001781}
1782
Reid Klecknerb5180542017-03-21 16:57:19 +00001783bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) {
Reid Kleckner8bf67fe2017-05-23 17:01:48 +00001784 // There shouldn't be more attribute sets than there are parameters plus the
1785 // function and return value.
1786 return Attrs.getNumAttrSets() <= Params + 2;
Devang Patel82fed672008-09-23 22:35:17 +00001787}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001788
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001789/// Verify that statepoint intrinsic is well formed.
1790void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001791 assert(CS.getCalledFunction() &&
1792 CS.getCalledFunction()->getIntrinsicID() ==
1793 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001794
Philip Reames0285c742015-02-03 23:18:47 +00001795 const Instruction &CI = *CS.getInstruction();
1796
Igor Laevsky39d662f2015-07-11 10:30:36 +00001797 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1798 !CS.onlyAccessesArgMemory(),
1799 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001800 "reordering restrictions required by safepoint semantics",
1801 &CI);
1802
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001803 const Value *IDV = CS.getArgument(0);
1804 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1805 &CI);
1806
1807 const Value *NumPatchBytesV = CS.getArgument(1);
1808 Assert(isa<ConstantInt>(NumPatchBytesV),
1809 "gc.statepoint number of patchable bytes must be a constant integer",
1810 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001811 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001812 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1813 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1814 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1815 "positive",
1816 &CI);
1817
1818 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001819 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001820 Assert(PT && PT->getElementType()->isFunctionTy(),
1821 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001822 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001823
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001824 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001825 Assert(isa<ConstantInt>(NumCallArgsV),
1826 "gc.statepoint number of arguments to underlying call "
1827 "must be constant integer",
1828 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001829 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001830 Assert(NumCallArgs >= 0,
1831 "gc.statepoint number of arguments to underlying call "
1832 "must be positive",
1833 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001834 const int NumParams = (int)TargetFuncType->getNumParams();
1835 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001836 Assert(NumCallArgs >= NumParams,
1837 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001838
1839 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001840 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1841 "gc.statepoint doesn't support wrapping non-void "
1842 "vararg functions yet",
1843 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001844 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001845 Assert(NumCallArgs == NumParams,
1846 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001847
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001848 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001849 Assert(isa<ConstantInt>(FlagsV),
1850 "gc.statepoint flags must be constant integer", &CI);
1851 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1852 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1853 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001854
1855 // Verify that the types of the call parameter arguments match
1856 // the type of the wrapped callee.
1857 for (int i = 0; i < NumParams; i++) {
1858 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001859 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001860 Assert(ArgType == ParamType,
1861 "gc.statepoint call argument does not match wrapped "
1862 "function type",
1863 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001864 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001865
1866 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001867
1868 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1869 Assert(isa<ConstantInt>(NumTransitionArgsV),
1870 "gc.statepoint number of transition arguments "
1871 "must be constant integer",
1872 &CI);
1873 const int NumTransitionArgs =
1874 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1875 Assert(NumTransitionArgs >= 0,
1876 "gc.statepoint number of transition arguments must be positive", &CI);
1877 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1878
1879 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001880 Assert(isa<ConstantInt>(NumDeoptArgsV),
1881 "gc.statepoint number of deoptimization arguments "
1882 "must be constant integer",
1883 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001884 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001885 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1886 "must be positive",
1887 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001888
Pat Gavlincc0431d2015-05-08 18:07:42 +00001889 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001890 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001891 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001892 "gc.statepoint too few arguments according to length fields", &CI);
1893
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00001894 // Check that the only uses of this gc.statepoint are gc.result or
Philip Reames1ffa9372015-01-30 23:28:05 +00001895 // gc.relocate calls which are tied to this statepoint and thus part
1896 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001897 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001898 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001899 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001900 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001901 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001902 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001903 "of a gc.statepoint",
1904 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001905 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001906 Assert(Call->getArgOperand(0) == &CI,
1907 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001908 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001909 Assert(Call->getArgOperand(0) == &CI,
1910 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001911 }
1912 }
1913
1914 // Note: It is legal for a single derived pointer to be listed multiple
1915 // times. It's non-optimal, but it is legal. It can also happen after
1916 // insertion if we strip a bitcast away.
1917 // Note: It is really tempting to check that each base is relocated and
1918 // that a derived pointer is never reused as a base pointer. This turns
1919 // out to be problematic since optimizations run after safepoint insertion
1920 // can recognize equality properties that the insertion logic doesn't know
1921 // about. See example statepoint.ll in the verifier subdirectory
1922}
1923
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001924void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001925 for (auto &Counts : FrameEscapeInfo) {
1926 Function *F = Counts.first;
1927 unsigned EscapedObjectCount = Counts.second.first;
1928 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001929 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001930 "all indices passed to llvm.localrecover must be less than the "
1931 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001932 "function",
1933 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001934 }
1935}
1936
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001937static Instruction *getSuccPad(TerminatorInst *Terminator) {
1938 BasicBlock *UnwindDest;
1939 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1940 UnwindDest = II->getUnwindDest();
1941 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1942 UnwindDest = CSI->getUnwindDest();
1943 else
1944 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1945 return UnwindDest->getFirstNonPHI();
1946}
1947
1948void Verifier::verifySiblingFuncletUnwinds() {
1949 SmallPtrSet<Instruction *, 8> Visited;
1950 SmallPtrSet<Instruction *, 8> Active;
1951 for (const auto &Pair : SiblingFuncletInfo) {
1952 Instruction *PredPad = Pair.first;
1953 if (Visited.count(PredPad))
1954 continue;
1955 Active.insert(PredPad);
1956 TerminatorInst *Terminator = Pair.second;
1957 do {
1958 Instruction *SuccPad = getSuccPad(Terminator);
1959 if (Active.count(SuccPad)) {
1960 // Found a cycle; report error
1961 Instruction *CyclePad = SuccPad;
1962 SmallVector<Instruction *, 8> CycleNodes;
1963 do {
1964 CycleNodes.push_back(CyclePad);
1965 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1966 if (CycleTerminator != CyclePad)
1967 CycleNodes.push_back(CycleTerminator);
1968 CyclePad = getSuccPad(CycleTerminator);
1969 } while (CyclePad != SuccPad);
1970 Assert(false, "EH pads can't handle each other's exceptions",
1971 ArrayRef<Instruction *>(CycleNodes));
1972 }
1973 // Don't re-walk a node we've already checked
1974 if (!Visited.insert(SuccPad).second)
1975 break;
1976 // Walk to this successor if it has a map entry.
1977 PredPad = SuccPad;
1978 auto TermI = SiblingFuncletInfo.find(PredPad);
1979 if (TermI == SiblingFuncletInfo.end())
1980 break;
1981 Terminator = TermI->second;
1982 Active.insert(PredPad);
1983 } while (true);
1984 // Each node only has one successor, so we've walked all the active
1985 // nodes' successors.
1986 Active.clear();
1987 }
1988}
1989
Chris Lattner0e851da2002-04-18 20:37:37 +00001990// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001991//
Chandler Carruth043949d2014-01-19 02:22:18 +00001992void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001993 visitGlobalValue(F);
1994
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001995 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001996 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001997 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001998
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001999 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002000 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00002001
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002002 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
2003 Assert(FT->getNumParams() == NumArgs,
2004 "# formal arguments must match # of arguments for function type!", &F,
2005 FT);
2006 Assert(F.getReturnType()->isFirstClassType() ||
2007 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
2008 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00002009
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002010 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
2011 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00002012
Reid Klecknerb5180542017-03-21 16:57:19 +00002013 AttributeList Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002014
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002015 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002016 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002017
Duncan Sands8c582282007-12-21 19:19:01 +00002018 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002019 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00002020
Michael Gottesman41748d72013-06-27 00:25:01 +00002021 // On function declarations/definitions, we do not support the builtin
2022 // attribute. We do not check this in VerifyFunctionAttrs since that is
2023 // checking for Attributes that can/can not ever be on functions.
Reid Klecknera77172a2017-04-14 00:06:06 +00002024 Assert(!Attrs.hasFnAttribute(Attribute::Builtin),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002025 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00002026
Chris Lattneref13ee32006-05-19 21:25:17 +00002027 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00002028 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
2029 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00002030 switch (F.getCallingConv()) {
2031 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00002032 case CallingConv::C:
2033 break;
Matt Arsenault33339682017-04-04 18:43:11 +00002034 case CallingConv::AMDGPU_KERNEL:
2035 case CallingConv::SPIR_KERNEL:
2036 Assert(F.getReturnType()->isVoidTy(),
2037 "Calling convention requires void return type", &F);
2038 LLVM_FALLTHROUGH;
2039 case CallingConv::AMDGPU_VS:
Marek Olsaka302a7362017-05-02 15:41:10 +00002040 case CallingConv::AMDGPU_HS:
Matt Arsenault33339682017-04-04 18:43:11 +00002041 case CallingConv::AMDGPU_GS:
2042 case CallingConv::AMDGPU_PS:
2043 case CallingConv::AMDGPU_CS:
2044 Assert(!F.hasStructRetAttr(),
2045 "Calling convention does not allow sret", &F);
2046 LLVM_FALLTHROUGH;
Chris Lattneref13ee32006-05-19 21:25:17 +00002047 case CallingConv::Fast:
2048 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00002049 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00002050 case CallingConv::PTX_Kernel:
2051 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002052 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
2053 "perfect forwarding!",
2054 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00002055 break;
2056 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00002057
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002058 bool isLLVMdotName = F.getName().size() >= 5 &&
2059 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002060
Chris Lattneraf95e582002-04-13 22:48:46 +00002061 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00002062 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002063 for (const Argument &Arg : F.args()) {
2064 Assert(Arg.getType() == FT->getParamType(i),
2065 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002066 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002067 Assert(Arg.getType()->isFirstClassType(),
2068 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00002069 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002070 Assert(!Arg.getType()->isMetadataTy(),
2071 "Function takes metadata but isn't an intrinsic", &Arg, &F);
2072 Assert(!Arg.getType()->isTokenTy(),
2073 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00002074 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00002075
2076 // Check that swifterror argument is only used by loads and stores.
Reid Klecknerf021fab2017-04-13 23:12:13 +00002077 if (Attrs.hasParamAttribute(i, Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002078 verifySwiftErrorValue(&Arg);
2079 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002080 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00002081 }
Chris Lattneraf95e582002-04-13 22:48:46 +00002082
David Majnemerb611e3f2015-08-14 05:09:07 +00002083 if (!isLLVMdotName)
2084 Assert(!F.getReturnType()->isTokenTy(),
2085 "Functions returns a token but isn't an intrinsic", &F);
2086
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002087 // Get the function metadata attachments.
2088 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
2089 F.getAllMetadata(MDs);
2090 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002091 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002092
Keno Fischer2ac0c272015-11-16 05:13:30 +00002093 // Check validity of the personality function
2094 if (F.hasPersonalityFn()) {
2095 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2096 if (Per)
2097 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002098 "Referencing personality function in another module!",
2099 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002100 }
2101
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002102 if (F.isMaterializable()) {
2103 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002104 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2105 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002106 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002107 for (const auto &I : MDs) {
2108 AssertDI(I.first != LLVMContext::MD_dbg,
2109 "function declaration may not have a !dbg attachment", &F);
2110 Assert(I.first != LLVMContext::MD_prof,
2111 "function declaration may not have a !prof attachment", &F);
2112
2113 // Verify the metadata itself.
2114 visitMDNode(*I.second);
2115 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002116 Assert(!F.hasPersonalityFn(),
2117 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002118 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002119 // Verify that this function (which has a body) is not named "llvm.*". It
2120 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002121 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002122
Chris Lattner149376d2002-10-13 20:57:00 +00002123 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002124 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002125 Assert(pred_empty(Entry),
2126 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002127
Chris Lattner27471742009-11-01 04:08:01 +00002128 // The address of the entry block cannot be taken, unless it is dead.
2129 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002130 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2131 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002132 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002133
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002134 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002135 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002136 for (const auto &I : MDs) {
2137 // Verify that the attachment is legal.
2138 switch (I.first) {
2139 default:
2140 break;
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002141 case LLVMContext::MD_dbg: {
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002142 ++NumDebugAttachments;
2143 AssertDI(NumDebugAttachments == 1,
2144 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002145 AssertDI(isa<DISubprogram>(I.second),
2146 "function !dbg attachment must be a subprogram", &F, I.second);
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002147 auto *SP = cast<DISubprogram>(I.second);
2148 const Function *&AttachedTo = DISubprogramAttachments[SP];
2149 AssertDI(!AttachedTo || AttachedTo == &F,
2150 "DISubprogram attached to more than one function", SP, &F);
2151 AttachedTo = &F;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002152 break;
Adrian Prantlc10d0e52017-05-09 19:47:37 +00002153 }
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002154 case LLVMContext::MD_prof:
2155 ++NumProfAttachments;
2156 Assert(NumProfAttachments == 1,
2157 "function must have a single !prof attachment", &F, I.second);
2158 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002159 }
2160
2161 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002162 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002163 }
Chris Lattner149376d2002-10-13 20:57:00 +00002164 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002165
Chris Lattner7730dcc2009-09-11 17:05:29 +00002166 // If this function is actually an intrinsic, verify that it is only used in
2167 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002168 // Only do this if the module is materialized, otherwise we don't have all the
2169 // uses.
2170 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002171 const User *U;
2172 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002173 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002174 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002175
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002176 Assert(!F.hasDLLImportStorageClass() ||
2177 (F.isDeclaration() && F.hasExternalLinkage()) ||
2178 F.hasAvailableExternallyLinkage(),
2179 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002180
2181 auto *N = F.getSubprogram();
Adrian Prantl63d96952017-03-07 17:28:54 +00002182 HasDebugInfo = (N != nullptr);
Adrian Prantl39c6fa62017-03-07 17:50:51 +00002183 if (!HasDebugInfo)
Peter Collingbourned4bff302015-11-05 22:03:56 +00002184 return;
2185
2186 // Check that all !dbg attachments lead to back to N (or, at least, another
2187 // subprogram that describes the same function).
2188 //
2189 // FIXME: Check this incrementally while visiting !dbg attachments.
2190 // FIXME: Only check when N is the canonical subprogram for F.
2191 SmallPtrSet<const MDNode *, 32> Seen;
2192 for (auto &BB : F)
2193 for (auto &I : BB) {
2194 // Be careful about using DILocation here since we might be dealing with
2195 // broken code (this is the Verifier after all).
2196 DILocation *DL =
2197 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2198 if (!DL)
2199 continue;
2200 if (!Seen.insert(DL).second)
2201 continue;
2202
2203 DILocalScope *Scope = DL->getInlinedAtScope();
2204 if (Scope && !Seen.insert(Scope).second)
2205 continue;
2206
2207 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002208
2209 // Scope and SP could be the same MDNode and we don't want to skip
2210 // validation in that case
2211 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002212 continue;
2213
2214 // FIXME: Once N is canonical, check "SP == &N".
Adrian Prantla2ef0472016-09-14 17:30:37 +00002215 AssertDI(SP->describes(&F),
2216 "!dbg attachment points at wrong subprogram for function", N, &F,
2217 &I, DL, Scope, SP);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002218 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002219}
2220
Chris Lattner0e851da2002-04-18 20:37:37 +00002221// verifyBasicBlock - Verify that a basic block is well formed...
2222//
Chris Lattner069a7952002-06-25 15:56:27 +00002223void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002224 InstsInThisBlock.clear();
2225
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002226 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002227 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002228
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002229 // Check constraints that this basic block imposes on all of the PHI nodes in
2230 // it.
2231 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002232 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2233 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002234 std::sort(Preds.begin(), Preds.end());
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002235 for (const PHINode &PN : BB.phis()) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002236 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002237 Assert(PN.getNumIncomingValues() != 0,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002238 "PHI nodes must have at least one entry. If the block is dead, "
2239 "the PHI should be removed!",
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002240 &PN);
2241 Assert(PN.getNumIncomingValues() == Preds.size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002242 "PHINode should have one entry for each predecessor of its "
2243 "parent basic block!",
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002244 &PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002245
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002246 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002247 Values.clear();
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002248 Values.reserve(PN.getNumIncomingValues());
2249 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
2250 Values.push_back(
2251 std::make_pair(PN.getIncomingBlock(i), PN.getIncomingValue(i)));
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002252 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002253
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002254 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2255 // Check to make sure that if there is more than one entry for a
2256 // particular basic block in this PHI node, that the incoming values are
2257 // all identical.
2258 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002259 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2260 Values[i].second == Values[i - 1].second,
2261 "PHI node has multiple entries for the same basic block with "
2262 "different incoming values!",
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002263 &PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002264
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002265 // Check to make sure that the predecessors and PHI node entries are
2266 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002267 Assert(Values[i].first == Preds[i],
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00002268 "PHI node entries do not match predecessors!", &PN,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002269 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002270 }
2271 }
2272 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002273
2274 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002275 for (auto &I : BB)
2276 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002277 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002278 }
Chris Lattner069a7952002-06-25 15:56:27 +00002279}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002280
Chris Lattner069a7952002-06-25 15:56:27 +00002281void Verifier::visitTerminatorInst(TerminatorInst &I) {
2282 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002283 Assert(&I == I.getParent()->getTerminator(),
2284 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002285 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002286}
2287
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002288void Verifier::visitBranchInst(BranchInst &BI) {
2289 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002290 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2291 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002292 }
2293 visitTerminatorInst(BI);
2294}
2295
Chris Lattner069a7952002-06-25 15:56:27 +00002296void Verifier::visitReturnInst(ReturnInst &RI) {
2297 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002298 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002299 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002300 Assert(N == 0,
2301 "Found return instr that returns non-void in Function of void "
2302 "return type!",
2303 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002304 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002305 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2306 "Function return type does not match operand "
2307 "type of return inst!",
2308 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002309
Misha Brukman7eb05a12003-08-18 14:43:39 +00002310 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002311 // terminators...
2312 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002313}
2314
Chris Lattnerab5aa142004-05-21 16:47:21 +00002315void Verifier::visitSwitchInst(SwitchInst &SI) {
2316 // Check to make sure that all of the constants in the switch instruction
2317 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002318 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002319 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002320 for (auto &Case : SI.cases()) {
2321 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002322 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002323 Assert(Constants.insert(Case.getCaseValue()).second,
2324 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002325 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002326
Chris Lattnerab5aa142004-05-21 16:47:21 +00002327 visitTerminatorInst(SI);
2328}
2329
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002330void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002331 Assert(BI.getAddress()->getType()->isPointerTy(),
2332 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002333 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002334 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2335 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002336
2337 visitTerminatorInst(BI);
2338}
2339
Chris Lattner75648e72004-03-12 05:54:31 +00002340void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002341 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2342 SI.getOperand(2)),
2343 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002344
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002345 Assert(SI.getTrueValue()->getType() == SI.getType(),
2346 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002347 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002348}
2349
Misha Brukmanc566ca362004-03-02 00:22:19 +00002350/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2351/// a pass, if any exist, it's an error.
2352///
Chris Lattner903a25d2002-11-21 16:54:22 +00002353void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002354 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002355}
Chris Lattner0e851da2002-04-18 20:37:37 +00002356
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002357void Verifier::visitTruncInst(TruncInst &I) {
2358 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002359 Type *SrcTy = I.getOperand(0)->getType();
2360 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002361
2362 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002363 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2364 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002365
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002366 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2367 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2368 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2369 "trunc source and destination must both be a vector or neither", &I);
2370 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002371
2372 visitInstruction(I);
2373}
2374
2375void Verifier::visitZExtInst(ZExtInst &I) {
2376 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002377 Type *SrcTy = I.getOperand(0)->getType();
2378 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002379
2380 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002381 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2382 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2383 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2384 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002385 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2386 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002387
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002388 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002389
2390 visitInstruction(I);
2391}
2392
2393void Verifier::visitSExtInst(SExtInst &I) {
2394 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002395 Type *SrcTy = I.getOperand(0)->getType();
2396 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002397
2398 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002399 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2400 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002401
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002402 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2403 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2404 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2405 "sext source and destination must both be a vector or neither", &I);
2406 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002407
2408 visitInstruction(I);
2409}
2410
2411void Verifier::visitFPTruncInst(FPTruncInst &I) {
2412 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002413 Type *SrcTy = I.getOperand(0)->getType();
2414 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002415 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002416 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2417 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002418
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002419 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2420 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2421 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2422 "fptrunc source and destination must both be a vector or neither", &I);
2423 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002424
2425 visitInstruction(I);
2426}
2427
2428void Verifier::visitFPExtInst(FPExtInst &I) {
2429 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002430 Type *SrcTy = I.getOperand(0)->getType();
2431 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002432
2433 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002434 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2435 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002436
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002437 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2438 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2439 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2440 "fpext source and destination must both be a vector or neither", &I);
2441 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002442
2443 visitInstruction(I);
2444}
2445
2446void Verifier::visitUIToFPInst(UIToFPInst &I) {
2447 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002448 Type *SrcTy = I.getOperand(0)->getType();
2449 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002450
Duncan Sands19d0b472010-02-16 11:11:14 +00002451 bool SrcVec = SrcTy->isVectorTy();
2452 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002453
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002454 Assert(SrcVec == DstVec,
2455 "UIToFP source and dest must both be vector or scalar", &I);
2456 Assert(SrcTy->isIntOrIntVectorTy(),
2457 "UIToFP source must be integer or integer vector", &I);
2458 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2459 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002460
2461 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002462 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2463 cast<VectorType>(DestTy)->getNumElements(),
2464 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002465
2466 visitInstruction(I);
2467}
2468
2469void Verifier::visitSIToFPInst(SIToFPInst &I) {
2470 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002471 Type *SrcTy = I.getOperand(0)->getType();
2472 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002473
Duncan Sands19d0b472010-02-16 11:11:14 +00002474 bool SrcVec = SrcTy->isVectorTy();
2475 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002476
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002477 Assert(SrcVec == DstVec,
2478 "SIToFP source and dest must both be vector or scalar", &I);
2479 Assert(SrcTy->isIntOrIntVectorTy(),
2480 "SIToFP source must be integer or integer vector", &I);
2481 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2482 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002483
2484 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002485 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2486 cast<VectorType>(DestTy)->getNumElements(),
2487 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002488
2489 visitInstruction(I);
2490}
2491
2492void Verifier::visitFPToUIInst(FPToUIInst &I) {
2493 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002494 Type *SrcTy = I.getOperand(0)->getType();
2495 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002496
Duncan Sands19d0b472010-02-16 11:11:14 +00002497 bool SrcVec = SrcTy->isVectorTy();
2498 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002499
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002500 Assert(SrcVec == DstVec,
2501 "FPToUI source and dest must both be vector or scalar", &I);
2502 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2503 &I);
2504 Assert(DestTy->isIntOrIntVectorTy(),
2505 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002506
2507 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002508 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2509 cast<VectorType>(DestTy)->getNumElements(),
2510 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002511
2512 visitInstruction(I);
2513}
2514
2515void Verifier::visitFPToSIInst(FPToSIInst &I) {
2516 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002517 Type *SrcTy = I.getOperand(0)->getType();
2518 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002519
Duncan Sands19d0b472010-02-16 11:11:14 +00002520 bool SrcVec = SrcTy->isVectorTy();
2521 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002522
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002523 Assert(SrcVec == DstVec,
2524 "FPToSI source and dest must both be vector or scalar", &I);
2525 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2526 &I);
2527 Assert(DestTy->isIntOrIntVectorTy(),
2528 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002529
2530 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002531 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2532 cast<VectorType>(DestTy)->getNumElements(),
2533 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002534
2535 visitInstruction(I);
2536}
2537
2538void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2539 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002540 Type *SrcTy = I.getOperand(0)->getType();
2541 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002542
Craig Topper95d23472017-07-09 07:04:00 +00002543 Assert(SrcTy->isPtrOrPtrVectorTy(), "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002544
2545 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002546 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002547 "ptrtoint not supported for non-integral pointers");
2548
Craig Topper95d23472017-07-09 07:04:00 +00002549 Assert(DestTy->isIntOrIntVectorTy(), "PtrToInt result must be integral", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002550 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2551 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002552
2553 if (SrcTy->isVectorTy()) {
2554 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2555 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002556 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2557 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002558 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002559
2560 visitInstruction(I);
2561}
2562
2563void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2564 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002565 Type *SrcTy = I.getOperand(0)->getType();
2566 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002567
Craig Topper95d23472017-07-09 07:04:00 +00002568 Assert(SrcTy->isIntOrIntVectorTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002569 "IntToPtr source must be an integral", &I);
Craig Topper95d23472017-07-09 07:04:00 +00002570 Assert(DestTy->isPtrOrPtrVectorTy(), "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002571
2572 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002573 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002574 "inttoptr not supported for non-integral pointers");
2575
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002576 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2577 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002578 if (SrcTy->isVectorTy()) {
2579 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2580 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002581 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2582 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002583 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002584 visitInstruction(I);
2585}
2586
2587void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002588 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002589 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2590 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002591 visitInstruction(I);
2592}
2593
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002594void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2595 Type *SrcTy = I.getOperand(0)->getType();
2596 Type *DestTy = I.getType();
2597
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002598 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2599 &I);
2600 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2601 &I);
2602 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2603 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002604 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002605 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2606 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002607 visitInstruction(I);
2608}
2609
Misha Brukmanc566ca362004-03-02 00:22:19 +00002610/// visitPHINode - Ensure that a PHI node is well formed.
2611///
Chris Lattner069a7952002-06-25 15:56:27 +00002612void Verifier::visitPHINode(PHINode &PN) {
2613 // Ensure that the PHI nodes are all grouped together at the top of the block.
2614 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002615 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002616 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002617 Assert(&PN == &PN.getParent()->front() ||
2618 isa<PHINode>(--BasicBlock::iterator(&PN)),
2619 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002620
David Majnemerb611e3f2015-08-14 05:09:07 +00002621 // Check that a PHI doesn't yield a Token.
2622 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2623
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002624 // Check that all of the values of the PHI node have the same type as the
2625 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002626 for (Value *IncValue : PN.incoming_values()) {
2627 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002628 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002629 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002630
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002631 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002632
2633 visitInstruction(PN);
2634}
2635
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002636void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002637 Instruction *I = CS.getInstruction();
2638
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002639 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2640 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002641 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002642
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002643 Assert(FPTy->getElementType()->isFunctionTy(),
2644 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002645
2646 Assert(FPTy->getElementType() == CS.getFunctionType(),
2647 "Called function is not the same type as the call!", I);
2648
2649 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002650
2651 // Verify that the correct number of arguments are being passed
2652 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002653 Assert(CS.arg_size() >= FTy->getNumParams(),
2654 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002655 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002656 Assert(CS.arg_size() == FTy->getNumParams(),
2657 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002658
Chris Lattner609de002010-05-10 20:58:42 +00002659 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002660 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002661 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2662 "Call parameter type does not match function signature!",
2663 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002664
Reid Klecknerb5180542017-03-21 16:57:19 +00002665 AttributeList Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002666
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002667 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002668 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002669
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00002670 if (Attrs.hasAttribute(AttributeList::FunctionIndex, Attribute::Speculatable)) {
2671 // Don't allow speculatable on call sites, unless the underlying function
2672 // declaration is also speculatable.
2673 Function *Callee
2674 = dyn_cast<Function>(CS.getCalledValue()->stripPointerCasts());
2675 Assert(Callee && Callee->isSpeculatable(),
2676 "speculatable attribute may not apply to call sites", I);
2677 }
2678
Duncan Sands8c582282007-12-21 19:19:01 +00002679 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002680 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002681
David Majnemer91db08b2014-04-30 17:22:00 +00002682 // Conservatively check the inalloca argument.
2683 // We have a bug if we can find that there is an underlying alloca without
2684 // inalloca.
2685 if (CS.hasInAllocaArgument()) {
2686 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2687 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002688 Assert(AI->isUsedWithInAlloca(),
2689 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002690 }
2691
Manman Ren9bfd0d02016-04-01 21:41:15 +00002692 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002693 // make sure the underlying alloca/parameter it comes from has a swifterror as
2694 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002695 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Reid Klecknerfb502d22017-04-14 20:19:02 +00002696 if (CS.paramHasAttr(i, Attribute::SwiftError)) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002697 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002698 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002699 Assert(AI->isSwiftError(),
2700 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002701 continue;
2702 }
2703 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2704 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2705 Assert(ArgI->hasSwiftErrorAttr(),
2706 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002707 }
2708
Stephen Linb8bd2322013-04-20 05:14:40 +00002709 if (FTy->isVarArg()) {
2710 // FIXME? is 'nest' even legal here?
2711 bool SawNest = false;
2712 bool SawReturned = false;
2713
Reid Klecknera77172a2017-04-14 00:06:06 +00002714 for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) {
2715 if (Attrs.hasParamAttribute(Idx, Attribute::Nest))
Stephen Linb8bd2322013-04-20 05:14:40 +00002716 SawNest = true;
Reid Klecknera77172a2017-04-14 00:06:06 +00002717 if (Attrs.hasParamAttribute(Idx, Attribute::Returned))
Stephen Linb8bd2322013-04-20 05:14:40 +00002718 SawReturned = true;
2719 }
2720
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002721 // Check attributes on the varargs part.
Reid Klecknera77172a2017-04-14 00:06:06 +00002722 for (unsigned Idx = FTy->getNumParams(); Idx < CS.arg_size(); ++Idx) {
2723 Type *Ty = CS.getArgument(Idx)->getType();
2724 AttributeSet ArgAttrs = Attrs.getParamAttributes(Idx);
2725 verifyParameterAttrs(ArgAttrs, Ty, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002726
Reid Klecknera77172a2017-04-14 00:06:06 +00002727 if (ArgAttrs.hasAttribute(Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002728 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002729 SawNest = true;
2730 }
2731
Reid Klecknera77172a2017-04-14 00:06:06 +00002732 if (ArgAttrs.hasAttribute(Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002733 Assert(!SawReturned, "More than one parameter has attribute returned!",
2734 I);
2735 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2736 "Incompatible argument and return types for 'returned' "
2737 "attribute",
2738 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002739 SawReturned = true;
2740 }
Duncan Sands0009c442008-01-12 16:42:01 +00002741
Reid Klecknera77172a2017-04-14 00:06:06 +00002742 Assert(!ArgAttrs.hasAttribute(Attribute::StructRet),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002743 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002744
Reid Klecknera77172a2017-04-14 00:06:06 +00002745 if (ArgAttrs.hasAttribute(Attribute::InAlloca))
2746 Assert(Idx == CS.arg_size() - 1, "inalloca isn't on the last argument!",
2747 I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002748 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002749 }
Duncan Sands8c582282007-12-21 19:19:01 +00002750
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002751 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002752 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002753 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002754 for (Type *ParamTy : FTy->params()) {
2755 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002756 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002757 Assert(!ParamTy->isTokenTy(),
2758 "Function has token parameter but isn't an intrinsic", I);
2759 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002760 }
2761
David Majnemerb611e3f2015-08-14 05:09:07 +00002762 // Verify that indirect calls don't return tokens.
2763 if (CS.getCalledFunction() == nullptr)
2764 Assert(!FTy->getReturnType()->isTokenTy(),
2765 "Return type cannot be token for indirect call!");
2766
Philip Reamesa3c6f002015-06-26 21:39:44 +00002767 if (Function *F = CS.getCalledFunction())
2768 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002769 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002770
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002771 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2772 // at most one "gc-transition" operand bundle.
2773 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2774 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002775 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002776 OperandBundleUse BU = CS.getOperandBundleAt(i);
2777 uint32_t Tag = BU.getTagID();
2778 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002779 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2780 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002781 } else if (Tag == LLVMContext::OB_gc_transition) {
2782 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2783 I);
2784 FoundGCTransitionBundle = true;
2785 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002786 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2787 FoundFuncletBundle = true;
2788 Assert(BU.Inputs.size() == 1,
2789 "Expected exactly one funclet bundle operand", I);
2790 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2791 "Funclet bundle operands should correspond to a FuncletPadInst",
2792 I);
2793 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002794 }
2795
Adrian Prantl93035c82016-04-24 22:23:13 +00002796 // Verify that each inlinable callsite of a debug-info-bearing function in a
2797 // debug-info-bearing function has a debug location attached to it. Failure to
2798 // do so causes assertion failures when the inliner sets up inline scope info.
2799 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2800 CS.getCalledFunction()->getSubprogram())
Adrian Prantlfb80e792017-03-06 21:05:14 +00002801 AssertDI(I->getDebugLoc(), "inlinable function call in a function with "
2802 "debug info must have a !dbg location",
2803 I);
Adrian Prantl93035c82016-04-24 22:23:13 +00002804
Duncan Sands8c582282007-12-21 19:19:01 +00002805 visitInstruction(*I);
2806}
2807
Reid Kleckner5772b772014-04-24 20:14:34 +00002808/// Two types are "congruent" if they are identical, or if they are both pointer
2809/// types with different pointee types and the same address space.
2810static bool isTypeCongruent(Type *L, Type *R) {
2811 if (L == R)
2812 return true;
2813 PointerType *PL = dyn_cast<PointerType>(L);
2814 PointerType *PR = dyn_cast<PointerType>(R);
2815 if (!PL || !PR)
2816 return false;
2817 return PL->getAddressSpace() == PR->getAddressSpace();
2818}
2819
Reid Klecknerb5180542017-03-21 16:57:19 +00002820static AttrBuilder getParameterABIAttributes(int I, AttributeList Attrs) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002821 static const Attribute::AttrKind ABIAttrs[] = {
2822 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002823 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2824 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002825 AttrBuilder Copy;
2826 for (auto AK : ABIAttrs) {
Reid Klecknerf021fab2017-04-13 23:12:13 +00002827 if (Attrs.hasParamAttribute(I, AK))
Reid Klecknerd20c9702014-05-15 23:58:57 +00002828 Copy.addAttribute(AK);
2829 }
Reid Klecknerf021fab2017-04-13 23:12:13 +00002830 if (Attrs.hasParamAttribute(I, Attribute::Alignment))
Reid Kleckner859f8b52017-04-28 20:34:27 +00002831 Copy.addAlignmentAttr(Attrs.getParamAlignment(I));
Reid Klecknerd20c9702014-05-15 23:58:57 +00002832 return Copy;
2833}
2834
Reid Kleckner5772b772014-04-24 20:14:34 +00002835void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002836 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002837
2838 // - The caller and callee prototypes must match. Pointer types of
2839 // parameters or return types may differ in pointee type, but not
2840 // address space.
2841 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002842 FunctionType *CallerTy = F->getFunctionType();
2843 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002844 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2845 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2846 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2847 "cannot guarantee tail call due to mismatched varargs", &CI);
2848 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2849 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002850 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002851 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002852 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2853 "cannot guarantee tail call due to mismatched parameter types", &CI);
2854 }
2855
2856 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002857 Assert(F->getCallingConv() == CI.getCallingConv(),
2858 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002859
2860 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2861 // returned, and inalloca, must match.
Reid Klecknerb5180542017-03-21 16:57:19 +00002862 AttributeList CallerAttrs = F->getAttributes();
2863 AttributeList CalleeAttrs = CI.getAttributes();
Reid Kleckner5772b772014-04-24 20:14:34 +00002864 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002865 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2866 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002867 Assert(CallerABIAttrs == CalleeABIAttrs,
2868 "cannot guarantee tail call due to mismatched ABI impacting "
2869 "function attributes",
2870 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002871 }
2872
2873 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2874 // or a pointer bitcast followed by a ret instruction.
2875 // - The ret instruction must return the (possibly bitcasted) value
2876 // produced by the call or void.
2877 Value *RetVal = &CI;
2878 Instruction *Next = CI.getNextNode();
2879
2880 // Handle the optional bitcast.
2881 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002882 Assert(BI->getOperand(0) == RetVal,
2883 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002884 RetVal = BI;
2885 Next = BI->getNextNode();
2886 }
2887
2888 // Check the return.
2889 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002890 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2891 &CI);
2892 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2893 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002894}
2895
Duncan Sands8c582282007-12-21 19:19:01 +00002896void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002897 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002898
Reid Kleckner5772b772014-04-24 20:14:34 +00002899 if (CI.isMustTailCall())
2900 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002901}
2902
2903void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002904 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002905
David Majnemer654e1302015-07-31 17:58:14 +00002906 // Verify that the first non-PHI instruction of the unwind destination is an
2907 // exception handling instruction.
2908 Assert(
2909 II.getUnwindDest()->isEHPad(),
2910 "The unwind destination does not have an exception handling instruction!",
2911 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002912
Dan Gohman9c6e1882010-08-02 23:09:14 +00002913 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002914}
Chris Lattner0e851da2002-04-18 20:37:37 +00002915
Misha Brukmanc566ca362004-03-02 00:22:19 +00002916/// visitBinaryOperator - Check that both arguments to the binary operator are
2917/// of the same type!
2918///
Chris Lattner069a7952002-06-25 15:56:27 +00002919void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002920 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2921 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002922
Reid Spencer2341c222007-02-02 02:16:23 +00002923 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002924 // Check that integer arithmetic operators are only used with
2925 // integral operands.
2926 case Instruction::Add:
2927 case Instruction::Sub:
2928 case Instruction::Mul:
2929 case Instruction::SDiv:
2930 case Instruction::UDiv:
2931 case Instruction::SRem:
2932 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002933 Assert(B.getType()->isIntOrIntVectorTy(),
2934 "Integer arithmetic operators only work with integral types!", &B);
2935 Assert(B.getType() == B.getOperand(0)->getType(),
2936 "Integer arithmetic operators must have same type "
2937 "for operands and result!",
2938 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002939 break;
2940 // Check that floating-point arithmetic operators are only used with
2941 // floating-point operands.
2942 case Instruction::FAdd:
2943 case Instruction::FSub:
2944 case Instruction::FMul:
2945 case Instruction::FDiv:
2946 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002947 Assert(B.getType()->isFPOrFPVectorTy(),
2948 "Floating-point arithmetic operators only work with "
2949 "floating-point types!",
2950 &B);
2951 Assert(B.getType() == B.getOperand(0)->getType(),
2952 "Floating-point arithmetic operators must have same type "
2953 "for operands and result!",
2954 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002955 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002956 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002957 case Instruction::And:
2958 case Instruction::Or:
2959 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002960 Assert(B.getType()->isIntOrIntVectorTy(),
2961 "Logical operators only work with integral types!", &B);
2962 Assert(B.getType() == B.getOperand(0)->getType(),
2963 "Logical operators must have same type for operands and result!",
2964 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002965 break;
2966 case Instruction::Shl:
2967 case Instruction::LShr:
2968 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002969 Assert(B.getType()->isIntOrIntVectorTy(),
2970 "Shifts only work with integral types!", &B);
2971 Assert(B.getType() == B.getOperand(0)->getType(),
2972 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002973 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002974 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002975 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002976 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002977
Chris Lattner0e851da2002-04-18 20:37:37 +00002978 visitInstruction(B);
2979}
2980
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002981void Verifier::visitICmpInst(ICmpInst &IC) {
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 = IC.getOperand(0)->getType();
2984 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002985 Assert(Op0Ty == Op1Ty,
2986 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002987 // Check that the operands are the right type
Craig Topper95d23472017-07-09 07:04:00 +00002988 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPtrOrPtrVectorTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002989 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002990 // Check that the predicate is valid.
Craig Topper45844762017-07-05 23:35:46 +00002991 Assert(IC.isIntPredicate(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002992 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002993
Reid Spencerd9436b62006-11-20 01:22:35 +00002994 visitInstruction(IC);
2995}
2996
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002997void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002998 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002999 Type *Op0Ty = FC.getOperand(0)->getType();
3000 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003001 Assert(Op0Ty == Op1Ty,
3002 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00003003 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003004 Assert(Op0Ty->isFPOrFPVectorTy(),
3005 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00003006 // Check that the predicate is valid.
Craig Topper45844762017-07-05 23:35:46 +00003007 Assert(FC.isFPPredicate(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003008 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00003009
Reid Spencerd9436b62006-11-20 01:22:35 +00003010 visitInstruction(FC);
3011}
3012
Robert Bocchino23004482006-01-10 19:05:34 +00003013void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003014 Assert(
3015 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
3016 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00003017 visitInstruction(EI);
3018}
3019
Robert Bocchinoca27f032006-01-17 20:07:22 +00003020void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003021 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
3022 IE.getOperand(2)),
3023 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00003024 visitInstruction(IE);
3025}
3026
Chris Lattnerbbe0a422006-04-08 01:18:18 +00003027void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003028 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
3029 SV.getOperand(2)),
3030 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00003031 visitInstruction(SV);
3032}
3033
Chris Lattner069a7952002-06-25 15:56:27 +00003034void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00003035 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00003036
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003037 Assert(isa<PointerType>(TargetTy),
3038 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00003039 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Igor Laevsky753395f2017-12-14 09:33:58 +00003040
Chris Lattner84d82c72007-02-10 08:30:29 +00003041 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Igor Laevsky753395f2017-12-14 09:33:58 +00003042 Assert(all_of(
3043 Idxs, [](Value* V) { return V->getType()->isIntOrIntVectorTy(); }),
3044 "GEP indexes must be integers", &GEP);
Chris Lattner229907c2011-07-18 04:54:35 +00003045 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00003046 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003047 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00003048
Craig Topper95d23472017-07-09 07:04:00 +00003049 Assert(GEP.getType()->isPtrOrPtrVectorTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00003050 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003051 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00003052
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003053 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00003054 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003055 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
3056 if (GEP.getPointerOperandType()->isVectorTy())
3057 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
3058 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00003059 for (Value *Idx : Idxs) {
3060 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003061 if (IndexTy->isVectorTy()) {
3062 unsigned IndexWidth = IndexTy->getVectorNumElements();
3063 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
3064 }
Craig Topper95d23472017-07-09 07:04:00 +00003065 Assert(IndexTy->isIntOrIntVectorTy(),
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00003066 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00003067 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00003068 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003069 visitInstruction(GEP);
3070}
3071
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00003072static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
3073 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
3074}
3075
Sanjoy Das26f28a22016-11-09 19:36:39 +00003076void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) {
3077 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) &&
Philip Reamesbf9676f2014-10-20 23:52:07 +00003078 "precondition violation");
3079
3080 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003081 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003082 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003083 Assert(NumRanges >= 1, "It should have at least one range!", Range);
3084
Philip Reamesbf9676f2014-10-20 23:52:07 +00003085 ConstantRange LastRange(1); // Dummy initial value
3086 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003087 ConstantInt *Low =
3088 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003089 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003090 ConstantInt *High =
3091 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003092 Assert(High, "The upper limit must be an integer!", High);
3093 Assert(High->getType() == Low->getType() && High->getType() == Ty,
3094 "Range types must match instruction type!", &I);
3095
Philip Reamesbf9676f2014-10-20 23:52:07 +00003096 APInt HighV = High->getValue();
3097 APInt LowV = Low->getValue();
3098 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003099 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
3100 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003101 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003102 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
3103 "Intervals are overlapping", Range);
3104 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3105 Range);
3106 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3107 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003108 }
3109 LastRange = ConstantRange(LowV, HighV);
3110 }
3111 if (NumRanges > 2) {
3112 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003113 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003114 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003115 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003116 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003117 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3118 "Intervals are overlapping", Range);
3119 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3120 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003121 }
3122}
3123
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003124void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3125 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003126 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3127 Assert(!(Size & (Size - 1)),
3128 "atomic memory access' operand must have a power-of-two size", Ty, I);
3129}
3130
Chris Lattner069a7952002-06-25 15:56:27 +00003131void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003132 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003133 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003134 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003135 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3136 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003137 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003138 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003139 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3140 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003141 "Load cannot have Release ordering", &LI);
3142 Assert(LI.getAlignment() != 0,
3143 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003144 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3145 ElTy->isFloatingPointTy(),
3146 "atomic load operand must have integer, pointer, or floating point "
3147 "type!",
3148 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003149 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003150 } else {
Konstantin Zhuravlyovbb80d3e2017-07-11 22:23:00 +00003151 Assert(LI.getSyncScopeID() == SyncScope::System,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003152 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003153 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003154
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003155 visitInstruction(LI);
3156}
3157
Chris Lattner069a7952002-06-25 15:56:27 +00003158void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003159 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003160 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003161 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003162 Assert(ElTy == SI.getOperand(0)->getType(),
3163 "Stored value type does not match pointer operand type!", &SI, ElTy);
3164 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3165 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003166 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003167 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003168 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3169 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003170 "Store cannot have Acquire ordering", &SI);
3171 Assert(SI.getAlignment() != 0,
3172 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003173 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3174 ElTy->isFloatingPointTy(),
3175 "atomic store operand must have integer, pointer, or floating point "
3176 "type!",
3177 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003178 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003179 } else {
Konstantin Zhuravlyovbb80d3e2017-07-11 22:23:00 +00003180 Assert(SI.getSyncScopeID() == SyncScope::System,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003181 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003182 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003183 visitInstruction(SI);
3184}
3185
Manman Ren9bfd0d02016-04-01 21:41:15 +00003186/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3187void Verifier::verifySwiftErrorCallSite(CallSite CS,
3188 const Value *SwiftErrorVal) {
3189 unsigned Idx = 0;
3190 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3191 I != E; ++I, ++Idx) {
3192 if (*I == SwiftErrorVal) {
Reid Klecknerfb502d22017-04-14 20:19:02 +00003193 Assert(CS.paramHasAttr(Idx, Attribute::SwiftError),
Manman Ren9bfd0d02016-04-01 21:41:15 +00003194 "swifterror value when used in a callsite should be marked "
3195 "with swifterror attribute",
3196 SwiftErrorVal, CS);
3197 }
3198 }
3199}
3200
3201void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3202 // Check that swifterror value is only used by loads, stores, or as
3203 // a swifterror argument.
3204 for (const User *U : SwiftErrorVal->users()) {
3205 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3206 isa<InvokeInst>(U),
3207 "swifterror value can only be loaded and stored from, or "
3208 "as a swifterror argument!",
3209 SwiftErrorVal, U);
3210 // If it is used by a store, check it is the second operand.
3211 if (auto StoreI = dyn_cast<StoreInst>(U))
3212 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3213 "swifterror value should be the second operand when used "
3214 "by stores", SwiftErrorVal, U);
3215 if (auto CallI = dyn_cast<CallInst>(U))
3216 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3217 if (auto II = dyn_cast<InvokeInst>(U))
3218 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3219 }
3220}
3221
Victor Hernandez8acf2952009-10-23 21:09:37 +00003222void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003223 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003224 PointerType *PTy = AI.getType();
Matt Arsenault3c1fc762017-04-10 22:27:50 +00003225 // TODO: Relax this restriction?
3226 Assert(PTy->getAddressSpace() == DL.getAllocaAddrSpace(),
3227 "Allocation instruction pointer not in the stack address space!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003228 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003229 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003230 "Cannot allocate unsized type", &AI);
3231 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3232 "Alloca array size must have integer type", &AI);
3233 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3234 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003235
Manman Ren9bfd0d02016-04-01 21:41:15 +00003236 if (AI.isSwiftError()) {
3237 verifySwiftErrorValue(&AI);
3238 }
3239
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003240 visitInstruction(AI);
3241}
3242
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003243void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003244
3245 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003246 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003247 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003248 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003249 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003250 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003251 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003252 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003253 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003254 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3255 "cmpxchg instructions failure argument shall be no stronger than the "
3256 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003257 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003258 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3259 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003260 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003261
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003262 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003263 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003264 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003265 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3266 "cmpxchg operand must have integer or pointer type",
3267 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003268 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003269 Assert(ElTy == CXI.getOperand(1)->getType(),
3270 "Expected value type does not match pointer operand type!", &CXI,
3271 ElTy);
3272 Assert(ElTy == CXI.getOperand(2)->getType(),
3273 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003274 visitInstruction(CXI);
3275}
3276
3277void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003278 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003279 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003280 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003281 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003282 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003283 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003284 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003285 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3286 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003287 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003288 Assert(ElTy == RMWI.getOperand(1)->getType(),
3289 "Argument value type does not match pointer operand type!", &RMWI,
3290 ElTy);
3291 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3292 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3293 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003294 visitInstruction(RMWI);
3295}
3296
Eli Friedmanfee02c62011-07-25 23:16:38 +00003297void Verifier::visitFenceInst(FenceInst &FI) {
3298 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003299 Assert(Ordering == AtomicOrdering::Acquire ||
3300 Ordering == AtomicOrdering::Release ||
3301 Ordering == AtomicOrdering::AcquireRelease ||
3302 Ordering == AtomicOrdering::SequentiallyConsistent,
3303 "fence instructions may only have acquire, release, acq_rel, or "
3304 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003305 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003306 visitInstruction(FI);
3307}
3308
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003309void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003310 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3311 EVI.getIndices()) == EVI.getType(),
3312 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003313
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003314 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003315}
3316
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003317void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003318 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3319 IVI.getIndices()) ==
3320 IVI.getOperand(1)->getType(),
3321 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003322
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003323 visitInstruction(IVI);
3324}
Chris Lattner0e851da2002-04-18 20:37:37 +00003325
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003326static Value *getParentPad(Value *EHPad) {
3327 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3328 return FPI->getParentPad();
3329
3330 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3331}
3332
David Majnemer85a549d2015-08-11 02:48:30 +00003333void Verifier::visitEHPadPredecessors(Instruction &I) {
3334 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003335
David Majnemer85a549d2015-08-11 02:48:30 +00003336 BasicBlock *BB = I.getParent();
3337 Function *F = BB->getParent();
3338
3339 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3340
3341 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3342 // The landingpad instruction defines its parent as a landing pad block. The
3343 // landing pad block may be branched to only by the unwind edge of an
3344 // invoke.
3345 for (BasicBlock *PredBB : predecessors(BB)) {
3346 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3347 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3348 "Block containing LandingPadInst must be jumped to "
3349 "only by the unwind edge of an invoke.",
3350 LPI);
3351 }
3352 return;
3353 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003354 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3355 if (!pred_empty(BB))
3356 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3357 "Block containg CatchPadInst must be jumped to "
3358 "only by its catchswitch.",
3359 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003360 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3361 "Catchswitch cannot unwind to one of its catchpads",
3362 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003363 return;
3364 }
David Majnemer85a549d2015-08-11 02:48:30 +00003365
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003366 // Verify that each pred has a legal terminator with a legal to/from EH
3367 // pad relationship.
3368 Instruction *ToPad = &I;
3369 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003370 for (BasicBlock *PredBB : predecessors(BB)) {
3371 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003372 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003373 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003374 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003375 "EH pad must be jumped to via an unwind edge", ToPad, II);
3376 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3377 FromPad = Bundle->Inputs[0];
3378 else
3379 FromPad = ConstantTokenNone::get(II->getContext());
3380 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003381 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003382 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3383 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3384 FromPad = CSI;
3385 } else {
3386 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3387 }
3388
3389 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003390 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003391 for (;; FromPad = getParentPad(FromPad)) {
3392 Assert(FromPad != ToPad,
3393 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3394 if (FromPad == ToPadParent) {
3395 // This is a legal unwind edge.
3396 break;
3397 }
3398 Assert(!isa<ConstantTokenNone>(FromPad),
3399 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003400 Assert(Seen.insert(FromPad).second,
3401 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003402 }
David Majnemer85a549d2015-08-11 02:48:30 +00003403 }
3404}
3405
3406void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003407 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3408 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003409 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3410 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003411
David Majnemer85a549d2015-08-11 02:48:30 +00003412 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003413
David Majnemer654e1302015-07-31 17:58:14 +00003414 if (!LandingPadResultTy)
3415 LandingPadResultTy = LPI.getType();
3416 else
3417 Assert(LandingPadResultTy == LPI.getType(),
3418 "The landingpad instruction should have a consistent result type "
3419 "inside a function.",
3420 &LPI);
3421
David Majnemer7fddecc2015-06-17 20:52:32 +00003422 Function *F = LPI.getParent()->getParent();
3423 Assert(F->hasPersonalityFn(),
3424 "LandingPadInst needs to be in a function with a personality.", &LPI);
3425
Bill Wendlingfae14752011-08-12 20:24:12 +00003426 // The landingpad instruction must be the first non-PHI instruction in the
3427 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003428 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3429 "LandingPadInst not the first non-PHI instruction in the block.",
3430 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003431
Duncan Sands86de1a62011-09-27 16:43:19 +00003432 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003433 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003434 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003435 Assert(isa<PointerType>(Clause->getType()),
3436 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003437 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003438 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3439 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3440 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003441 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003442 }
3443
Bill Wendlingfae14752011-08-12 20:24:12 +00003444 visitInstruction(LPI);
3445}
3446
David Majnemerba6665d2016-08-01 18:06:34 +00003447void Verifier::visitResumeInst(ResumeInst &RI) {
3448 Assert(RI.getFunction()->hasPersonalityFn(),
3449 "ResumeInst needs to be in a function with a personality.", &RI);
3450
3451 if (!LandingPadResultTy)
3452 LandingPadResultTy = RI.getValue()->getType();
3453 else
3454 Assert(LandingPadResultTy == RI.getValue()->getType(),
3455 "The resume instruction should have a consistent result type "
3456 "inside a function.",
3457 &RI);
3458
3459 visitTerminatorInst(RI);
3460}
3461
David Majnemer654e1302015-07-31 17:58:14 +00003462void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003463 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003464
David Majnemer654e1302015-07-31 17:58:14 +00003465 Function *F = BB->getParent();
3466 Assert(F->hasPersonalityFn(),
3467 "CatchPadInst needs to be in a function with a personality.", &CPI);
3468
David Majnemer8a1c45d2015-12-12 05:38:55 +00003469 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3470 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3471 CPI.getParentPad());
3472
David Majnemer654e1302015-07-31 17:58:14 +00003473 // The catchpad instruction must be the first non-PHI instruction in the
3474 // block.
3475 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003476 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003477
David Majnemerfe2f7f32016-02-29 22:56:36 +00003478 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003479 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003480}
3481
David Majnemer8a1c45d2015-12-12 05:38:55 +00003482void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3483 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3484 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3485 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003486
David Majnemer8a1c45d2015-12-12 05:38:55 +00003487 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003488}
3489
3490void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3491 BasicBlock *BB = CPI.getParent();
3492
David Majnemer654e1302015-07-31 17:58:14 +00003493 Function *F = BB->getParent();
3494 Assert(F->hasPersonalityFn(),
3495 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3496
3497 // The cleanuppad instruction must be the first non-PHI instruction in the
3498 // block.
3499 Assert(BB->getFirstNonPHI() == &CPI,
3500 "CleanupPadInst not the first non-PHI instruction in the block.",
3501 &CPI);
3502
David Majnemer8a1c45d2015-12-12 05:38:55 +00003503 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003504 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003505 "CleanupPadInst has an invalid parent.", &CPI);
3506
David Majnemerfe2f7f32016-02-29 22:56:36 +00003507 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003508 visitFuncletPadInst(CPI);
3509}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003510
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003511void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3512 User *FirstUser = nullptr;
3513 Value *FirstUnwindPad = nullptr;
3514 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003515 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003516
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003517 while (!Worklist.empty()) {
3518 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003519 Assert(Seen.insert(CurrentPad).second,
3520 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003521 Value *UnresolvedAncestorPad = nullptr;
3522 for (User *U : CurrentPad->users()) {
3523 BasicBlock *UnwindDest;
3524 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3525 UnwindDest = CRI->getUnwindDest();
3526 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3527 // We allow catchswitch unwind to caller to nest
3528 // within an outer pad that unwinds somewhere else,
3529 // because catchswitch doesn't have a nounwind variant.
3530 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3531 if (CSI->unwindsToCaller())
3532 continue;
3533 UnwindDest = CSI->getUnwindDest();
3534 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3535 UnwindDest = II->getUnwindDest();
3536 } else if (isa<CallInst>(U)) {
3537 // Calls which don't unwind may be found inside funclet
3538 // pads that unwind somewhere else. We don't *require*
3539 // such calls to be annotated nounwind.
3540 continue;
3541 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3542 // The unwind dest for a cleanup can only be found by
3543 // recursive search. Add it to the worklist, and we'll
3544 // search for its first use that determines where it unwinds.
3545 Worklist.push_back(CPI);
3546 continue;
3547 } else {
3548 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3549 continue;
3550 }
3551
3552 Value *UnwindPad;
3553 bool ExitsFPI;
3554 if (UnwindDest) {
3555 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003556 if (!cast<Instruction>(UnwindPad)->isEHPad())
3557 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003558 Value *UnwindParent = getParentPad(UnwindPad);
3559 // Ignore unwind edges that don't exit CurrentPad.
3560 if (UnwindParent == CurrentPad)
3561 continue;
3562 // Determine whether the original funclet pad is exited,
3563 // and if we are scanning nested pads determine how many
3564 // of them are exited so we can stop searching their
3565 // children.
3566 Value *ExitedPad = CurrentPad;
3567 ExitsFPI = false;
3568 do {
3569 if (ExitedPad == &FPI) {
3570 ExitsFPI = true;
3571 // Now we can resolve any ancestors of CurrentPad up to
3572 // FPI, but not including FPI since we need to make sure
3573 // to check all direct users of FPI for consistency.
3574 UnresolvedAncestorPad = &FPI;
3575 break;
3576 }
3577 Value *ExitedParent = getParentPad(ExitedPad);
3578 if (ExitedParent == UnwindParent) {
3579 // ExitedPad is the ancestor-most pad which this unwind
3580 // edge exits, so we can resolve up to it, meaning that
3581 // ExitedParent is the first ancestor still unresolved.
3582 UnresolvedAncestorPad = ExitedParent;
3583 break;
3584 }
3585 ExitedPad = ExitedParent;
3586 } while (!isa<ConstantTokenNone>(ExitedPad));
3587 } else {
3588 // Unwinding to caller exits all pads.
3589 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3590 ExitsFPI = true;
3591 UnresolvedAncestorPad = &FPI;
3592 }
3593
3594 if (ExitsFPI) {
3595 // This unwind edge exits FPI. Make sure it agrees with other
3596 // such edges.
3597 if (FirstUser) {
3598 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3599 "pad must have the same unwind "
3600 "dest",
3601 &FPI, U, FirstUser);
3602 } else {
3603 FirstUser = U;
3604 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003605 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3606 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3607 getParentPad(UnwindPad) == getParentPad(&FPI))
3608 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003609 }
3610 }
3611 // Make sure we visit all uses of FPI, but for nested pads stop as
3612 // soon as we know where they unwind to.
3613 if (CurrentPad != &FPI)
3614 break;
3615 }
3616 if (UnresolvedAncestorPad) {
3617 if (CurrentPad == UnresolvedAncestorPad) {
3618 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3619 // we've found an unwind edge that exits it, because we need to verify
3620 // all direct uses of FPI.
3621 assert(CurrentPad == &FPI);
3622 continue;
3623 }
3624 // Pop off the worklist any nested pads that we've found an unwind
3625 // destination for. The pads on the worklist are the uncles,
3626 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3627 // for all ancestors of CurrentPad up to but not including
3628 // UnresolvedAncestorPad.
3629 Value *ResolvedPad = CurrentPad;
3630 while (!Worklist.empty()) {
3631 Value *UnclePad = Worklist.back();
3632 Value *AncestorPad = getParentPad(UnclePad);
3633 // Walk ResolvedPad up the ancestor list until we either find the
3634 // uncle's parent or the last resolved ancestor.
3635 while (ResolvedPad != AncestorPad) {
3636 Value *ResolvedParent = getParentPad(ResolvedPad);
3637 if (ResolvedParent == UnresolvedAncestorPad) {
3638 break;
3639 }
3640 ResolvedPad = ResolvedParent;
3641 }
3642 // If the resolved ancestor search didn't find the uncle's parent,
3643 // then the uncle is not yet resolved.
3644 if (ResolvedPad != AncestorPad)
3645 break;
3646 // This uncle is resolved, so pop it from the worklist.
3647 Worklist.pop_back();
3648 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003649 }
3650 }
3651
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003652 if (FirstUnwindPad) {
3653 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3654 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3655 Value *SwitchUnwindPad;
3656 if (SwitchUnwindDest)
3657 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3658 else
3659 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3660 Assert(SwitchUnwindPad == FirstUnwindPad,
3661 "Unwind edges out of a catch must have the same unwind dest as "
3662 "the parent catchswitch",
3663 &FPI, FirstUser, CatchSwitch);
3664 }
3665 }
3666
3667 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003668}
3669
David Majnemer8a1c45d2015-12-12 05:38:55 +00003670void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003671 BasicBlock *BB = CatchSwitch.getParent();
3672
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003673 Function *F = BB->getParent();
3674 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003675 "CatchSwitchInst needs to be in a function with a personality.",
3676 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003677
David Majnemer8a1c45d2015-12-12 05:38:55 +00003678 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003679 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003680 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3681 "CatchSwitchInst not the first non-PHI instruction in the block.",
3682 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003683
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003684 auto *ParentPad = CatchSwitch.getParentPad();
3685 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3686 "CatchSwitchInst has an invalid parent.", ParentPad);
3687
David Majnemer8a1c45d2015-12-12 05:38:55 +00003688 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003689 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003690 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3691 "CatchSwitchInst must unwind to an EH block which is not a "
3692 "landingpad.",
3693 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003694
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003695 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3696 if (getParentPad(I) == ParentPad)
3697 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3698 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003699
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003700 Assert(CatchSwitch.getNumHandlers() != 0,
3701 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3702
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003703 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003704 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3705 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003706 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003707
David Majnemerfe2f7f32016-02-29 22:56:36 +00003708 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003709 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003710}
3711
David Majnemer654e1302015-07-31 17:58:14 +00003712void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003713 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3714 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3715 CRI.getOperand(0));
3716
David Majnemer654e1302015-07-31 17:58:14 +00003717 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3718 Instruction *I = UnwindDest->getFirstNonPHI();
3719 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3720 "CleanupReturnInst must unwind to an EH block which is not a "
3721 "landingpad.",
3722 &CRI);
3723 }
3724
3725 visitTerminatorInst(CRI);
3726}
3727
Rafael Espindola654320a2012-02-26 02:23:37 +00003728void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3729 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003730 // If the we have an invalid invoke, don't try to compute the dominance.
3731 // We already reject it in the invoke specific checks and the dominance
3732 // computation doesn't handle multiple edges.
3733 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3734 if (II->getNormalDest() == II->getUnwindDest())
3735 return;
3736 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003737
Michael Kruseff379b62016-03-26 23:32:57 +00003738 // Quick check whether the def has already been encountered in the same block.
3739 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3740 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003741 //
3742 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3743 // wrapping an SSA value, assert that we've already encountered it. See
3744 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003745 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3746 return;
3747
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003748 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003749 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003750 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003751}
3752
Artur Pilipenkocca80022015-10-09 17:41:29 +00003753void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3754 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3755 "apply only to pointer types", &I);
3756 Assert(isa<LoadInst>(I),
3757 "dereferenceable, dereferenceable_or_null apply only to load"
3758 " instructions, use attributes for calls or invokes", &I);
3759 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3760 "take one operand!", &I);
3761 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3762 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3763 "dereferenceable_or_null metadata value must be an i64!", &I);
3764}
3765
Misha Brukmanc566ca362004-03-02 00:22:19 +00003766/// verifyInstruction - Verify that an instruction is well formed.
3767///
Chris Lattner069a7952002-06-25 15:56:27 +00003768void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003769 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003770 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003771
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003772 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003773 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003774 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3775 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003776 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003777 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003778
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003779 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003780 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3781 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003782
Chris Lattner5f126b72004-03-29 00:29:36 +00003783 // Check that the return value of the instruction is either void or a legal
3784 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003785 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3786 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003787
Nick Lewycky93e06a52009-09-27 23:27:42 +00003788 // Check that the instruction doesn't produce metadata. Calls are already
3789 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003790 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3791 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003792
Chris Lattner0e851da2002-04-18 20:37:37 +00003793 // Check that all uses of the instruction, if they are instructions
3794 // themselves, actually have parent basic blocks. If the use is not an
3795 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003796 for (Use &U : I.uses()) {
3797 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003798 Assert(Used->getParent() != nullptr,
3799 "Instruction referencing"
3800 " instruction not embedded in a basic block!",
3801 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003802 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003803 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003804 return;
3805 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003806 }
3807
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003808 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003809 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003810
3811 // Check to make sure that only first-class-values are operands to
3812 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003813 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003814 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003815 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003816
Chris Lattner9ece94b2004-03-14 03:23:54 +00003817 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003818 // Check to make sure that the "address of" an intrinsic function is never
3819 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003820 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003821 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003822 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3823 "Cannot take the address of an intrinsic!", &I);
3824 Assert(
3825 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003826 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003827 F->getIntrinsicID() == Intrinsic::coro_resume ||
3828 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003829 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003830 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3831 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003832 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3833 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003834 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003835 Assert(F->getParent() == &M, "Referencing function in another module!",
3836 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003837 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003838 Assert(OpBB->getParent() == BB->getParent(),
3839 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003840 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003841 Assert(OpArg->getParent() == BB->getParent(),
3842 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003843 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003844 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3845 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003846 } else if (isa<Instruction>(I.getOperand(i))) {
3847 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003848 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003849 Assert((i + 1 == e && isa<CallInst>(I)) ||
3850 (i + 3 == e && isa<InvokeInst>(I)),
3851 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003852 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003853 if (CE->getType()->isPtrOrPtrVectorTy() ||
3854 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003855 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003856 // illegal bitcast. If the datalayout string specifies non-integral
3857 // address spaces then we also need to check for illegal ptrtoint and
3858 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003859 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003860 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003861 }
3862 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003863
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003864 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003865 Assert(I.getType()->isFPOrFPVectorTy(),
3866 "fpmath requires a floating point result!", &I);
3867 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003868 if (ConstantFP *CFP0 =
3869 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003870 const APFloat &Accuracy = CFP0->getValueAPF();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003871 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(),
Matt Arsenault82f41512016-06-27 19:43:15 +00003872 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003873 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3874 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003875 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003876 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003877 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003878 }
3879
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003880 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003881 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3882 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003883 visitRangeMetadata(I, Range, I.getType());
3884 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003885
Philip Reames0ca58b32014-10-21 20:56:29 +00003886 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003887 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3888 &I);
3889 Assert(isa<LoadInst>(I),
3890 "nonnull applies only to load instructions, use attributes"
3891 " for calls or invokes",
3892 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003893 }
3894
Artur Pilipenkocca80022015-10-09 17:41:29 +00003895 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3896 visitDereferenceableMetadata(I, MD);
3897
3898 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3899 visitDereferenceableMetadata(I, MD);
3900
Mehdi Aminia84a8402016-12-16 06:29:14 +00003901 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa))
3902 TBAAVerifyHelper.visitTBAAMetadata(I, TBAA);
Sanjoy Das2582e692016-11-08 20:46:01 +00003903
Artur Pilipenkocca80022015-10-09 17:41:29 +00003904 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3905 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3906 &I);
3907 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3908 "use attributes for calls or invokes", &I);
3909 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3910 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3911 Assert(CI && CI->getType()->isIntegerTy(64),
3912 "align metadata value must be an i64!", &I);
3913 uint64_t Align = CI->getZExtValue();
3914 Assert(isPowerOf2_64(Align),
3915 "align metadata value must be a power of 2!", &I);
3916 Assert(Align <= Value::MaximumAlignment,
3917 "alignment is larger that implementation defined limit", &I);
3918 }
3919
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003920 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003921 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003922 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003923 }
3924
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003925 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
Adrian Prantl941fa752016-12-05 18:04:47 +00003926 verifyFragmentExpression(*DII);
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003927
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003928 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003929}
3930
Philip Reames007561a2015-06-26 22:21:52 +00003931/// Allow intrinsics to be verified in different ways.
3932void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003933 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003934 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3935 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003936
Chris Lattner144b6192012-05-27 19:37:05 +00003937 // Verify that the intrinsic prototype lines up with what the .td files
3938 // describe.
3939 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003940 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003941
Chris Lattner144b6192012-05-27 19:37:05 +00003942 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3943 getIntrinsicInfoTableEntries(ID, Table);
3944 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003945
Chris Lattner144b6192012-05-27 19:37:05 +00003946 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003947 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3948 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003949 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003950 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003951 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3952 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003953 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003954
3955 // Verify if the intrinsic call matches the vararg property.
3956 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003957 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003958 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003959 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003960 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003961 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003962
3963 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003964 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003965
3966 // Now that we have the intrinsic ID and the actual argument types (and we
3967 // know they are legal for the intrinsic!) get the intrinsic name through the
3968 // usual means. This allows us to verify the mangling of argument types into
3969 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003970 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003971 Assert(ExpectedName == IF->getName(),
3972 "Intrinsic name not mangled correctly for type arguments! "
3973 "Should be: " +
3974 ExpectedName,
3975 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003976
Chris Lattner588096e2009-12-28 09:07:21 +00003977 // If the intrinsic takes MDNode arguments, verify that they are either global
3978 // or are local to *this* function.
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00003979 for (Value *V : CS.args())
Philip Reames007561a2015-06-26 22:21:52 +00003980 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3981 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003982
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003983 switch (ID) {
3984 default:
3985 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003986 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003987 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003988 if (isa<ConstantPointerNull>(InfoArg))
3989 break;
3990 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3991 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3992 "info argument of llvm.coro.begin must refer to an initialized "
3993 "constant");
3994 Constant *Init = GV->getInitializer();
3995 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3996 "info argument of llvm.coro.begin must refer to either a struct or "
3997 "an array");
3998 break;
3999 }
Chandler Carruth026cc372011-12-12 04:36:02 +00004000 case Intrinsic::ctlz: // llvm.ctlz
4001 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00004002 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004003 "is_zero_undef argument of bit counting intrinsics must be a "
4004 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004005 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00004006 break;
Andrew Kaylora0a11642017-01-26 23:27:59 +00004007 case Intrinsic::experimental_constrained_fadd:
4008 case Intrinsic::experimental_constrained_fsub:
4009 case Intrinsic::experimental_constrained_fmul:
4010 case Intrinsic::experimental_constrained_fdiv:
4011 case Intrinsic::experimental_constrained_frem:
Wei Dinga131d3f2017-08-24 04:18:24 +00004012 case Intrinsic::experimental_constrained_fma:
Andrew Kaylorf4660012017-05-25 21:31:00 +00004013 case Intrinsic::experimental_constrained_sqrt:
4014 case Intrinsic::experimental_constrained_pow:
4015 case Intrinsic::experimental_constrained_powi:
4016 case Intrinsic::experimental_constrained_sin:
4017 case Intrinsic::experimental_constrained_cos:
4018 case Intrinsic::experimental_constrained_exp:
4019 case Intrinsic::experimental_constrained_exp2:
4020 case Intrinsic::experimental_constrained_log:
4021 case Intrinsic::experimental_constrained_log10:
4022 case Intrinsic::experimental_constrained_log2:
4023 case Intrinsic::experimental_constrained_rint:
4024 case Intrinsic::experimental_constrained_nearbyint:
Andrew Kaylora0a11642017-01-26 23:27:59 +00004025 visitConstrainedFPIntrinsic(
4026 cast<ConstrainedFPIntrinsic>(*CS.getInstruction()));
4027 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00004028 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00004029 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
4030 "invalid llvm.dbg.declare intrinsic call 1", CS);
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004031 visitDbgIntrinsic("declare", cast<DbgInfoIntrinsic>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004032 break;
Reid Kleckner0fe506b2017-09-21 19:52:03 +00004033 case Intrinsic::dbg_addr: // llvm.dbg.addr
4034 visitDbgIntrinsic("addr", cast<DbgInfoIntrinsic>(*CS.getInstruction()));
Reid Kleckner8db62602017-09-22 23:19:52 +00004035 break;
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004036 case Intrinsic::dbg_value: // llvm.dbg.value
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004037 visitDbgIntrinsic("value", cast<DbgInfoIntrinsic>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00004038 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00004039 case Intrinsic::memcpy:
4040 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00004041 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00004042 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004043 Assert(AlignCI,
4044 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004045 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00004046 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004047 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00004048 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00004049 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004050 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004051 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00004052 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00004053 }
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004054 case Intrinsic::memcpy_element_unordered_atomic: {
Daniel Neilsonf9c7d292017-10-30 19:51:48 +00004055 const AtomicMemCpyInst *MI = cast<AtomicMemCpyInst>(CS.getInstruction());
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004056
4057 ConstantInt *ElementSizeCI =
4058 dyn_cast<ConstantInt>(MI->getRawElementSizeInBytes());
4059 Assert(ElementSizeCI,
4060 "element size of the element-wise unordered atomic memory "
4061 "intrinsic must be a constant int",
Igor Laevsky4f31e522016-12-29 14:31:07 +00004062 CS);
4063 const APInt &ElementSizeVal = ElementSizeCI->getValue();
4064 Assert(ElementSizeVal.isPowerOf2(),
4065 "element size of the element-wise atomic memory intrinsic "
4066 "must be a power of 2",
4067 CS);
4068
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004069 if (auto *LengthCI = dyn_cast<ConstantInt>(MI->getLength())) {
4070 uint64_t Length = LengthCI->getZExtValue();
4071 uint64_t ElementSize = MI->getElementSizeInBytes();
4072 Assert((Length % ElementSize) == 0,
4073 "constant length must be a multiple of the element size in the "
4074 "element-wise atomic memory intrinsic",
4075 CS);
4076 }
4077
Igor Laevsky4f31e522016-12-29 14:31:07 +00004078 auto IsValidAlignment = [&](uint64_t Alignment) {
4079 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4080 };
Reid Kleckner859f8b52017-04-28 20:34:27 +00004081 uint64_t DstAlignment = CS.getParamAlignment(0),
4082 SrcAlignment = CS.getParamAlignment(1);
Igor Laevsky4f31e522016-12-29 14:31:07 +00004083 Assert(IsValidAlignment(DstAlignment),
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004084 "incorrect alignment of the destination argument", CS);
Igor Laevsky4f31e522016-12-29 14:31:07 +00004085 Assert(IsValidAlignment(SrcAlignment),
Daniel Neilson3faabbb2017-06-16 14:43:59 +00004086 "incorrect alignment of the source argument", CS);
Igor Laevsky4f31e522016-12-29 14:31:07 +00004087 break;
4088 }
Daniel Neilson57226ef2017-07-12 15:25:26 +00004089 case Intrinsic::memmove_element_unordered_atomic: {
Daniel Neilsonf9c7d292017-10-30 19:51:48 +00004090 auto *MI = cast<AtomicMemMoveInst>(CS.getInstruction());
Daniel Neilson57226ef2017-07-12 15:25:26 +00004091
4092 ConstantInt *ElementSizeCI =
4093 dyn_cast<ConstantInt>(MI->getRawElementSizeInBytes());
4094 Assert(ElementSizeCI,
4095 "element size of the element-wise unordered atomic memory "
4096 "intrinsic must be a constant int",
4097 CS);
4098 const APInt &ElementSizeVal = ElementSizeCI->getValue();
4099 Assert(ElementSizeVal.isPowerOf2(),
4100 "element size of the element-wise atomic memory intrinsic "
4101 "must be a power of 2",
4102 CS);
4103
4104 if (auto *LengthCI = dyn_cast<ConstantInt>(MI->getLength())) {
4105 uint64_t Length = LengthCI->getZExtValue();
4106 uint64_t ElementSize = MI->getElementSizeInBytes();
4107 Assert((Length % ElementSize) == 0,
4108 "constant length must be a multiple of the element size in the "
4109 "element-wise atomic memory intrinsic",
4110 CS);
4111 }
4112
4113 auto IsValidAlignment = [&](uint64_t Alignment) {
4114 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4115 };
4116 uint64_t DstAlignment = CS.getParamAlignment(0),
4117 SrcAlignment = CS.getParamAlignment(1);
4118 Assert(IsValidAlignment(DstAlignment),
4119 "incorrect alignment of the destination argument", CS);
4120 Assert(IsValidAlignment(SrcAlignment),
4121 "incorrect alignment of the source argument", CS);
Daniel Neilson965613e2017-07-12 21:57:23 +00004122 break;
4123 }
4124 case Intrinsic::memset_element_unordered_atomic: {
Daniel Neilsonf9c7d292017-10-30 19:51:48 +00004125 auto *MI = cast<AtomicMemSetInst>(CS.getInstruction());
Daniel Neilson965613e2017-07-12 21:57:23 +00004126
4127 ConstantInt *ElementSizeCI =
4128 dyn_cast<ConstantInt>(MI->getRawElementSizeInBytes());
4129 Assert(ElementSizeCI,
4130 "element size of the element-wise unordered atomic memory "
4131 "intrinsic must be a constant int",
4132 CS);
4133 const APInt &ElementSizeVal = ElementSizeCI->getValue();
4134 Assert(ElementSizeVal.isPowerOf2(),
4135 "element size of the element-wise atomic memory intrinsic "
4136 "must be a power of 2",
4137 CS);
4138
4139 if (auto *LengthCI = dyn_cast<ConstantInt>(MI->getLength())) {
4140 uint64_t Length = LengthCI->getZExtValue();
4141 uint64_t ElementSize = MI->getElementSizeInBytes();
4142 Assert((Length % ElementSize) == 0,
4143 "constant length must be a multiple of the element size in the "
4144 "element-wise atomic memory intrinsic",
4145 CS);
4146 }
4147
4148 auto IsValidAlignment = [&](uint64_t Alignment) {
4149 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment);
4150 };
4151 uint64_t DstAlignment = CS.getParamAlignment(0);
4152 Assert(IsValidAlignment(DstAlignment),
4153 "incorrect alignment of the destination argument", CS);
Daniel Neilson57226ef2017-07-12 15:25:26 +00004154 break;
4155 }
Bill Wendling05604e02008-08-23 09:46:46 +00004156 case Intrinsic::gcroot:
4157 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00004158 case Intrinsic::gcread:
4159 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00004160 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00004161 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
4162 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
4163 Assert(isa<Constant>(CS.getArgOperand(1)),
4164 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00004165 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00004166 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004167 "llvm.gcroot parameter #1 must either be a pointer alloca, "
4168 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00004169 CS);
Talin2e59f142010-09-30 20:23:47 +00004170 }
Chris Lattner25852062008-08-24 20:46:13 +00004171 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00004172
Philip Reames9818dd72015-06-26 22:04:34 +00004173 Assert(CS.getParent()->getParent()->hasGC(),
4174 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00004175 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00004176 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00004177 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004178 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00004179 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00004180 break;
Chris Lattner229f7652008-10-16 06:00:36 +00004181 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00004182 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
4183 isa<ConstantInt>(CS.getArgOperand(2)) &&
4184 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
4185 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
4186 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00004187 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004188 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00004189 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
4190 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00004191 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00004192 case Intrinsic::lifetime_start:
4193 case Intrinsic::lifetime_end:
4194 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00004195 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004196 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00004197 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004198 break;
4199 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00004200 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
4201 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00004202 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00004203
Reid Kleckner60381792015-07-07 22:25:32 +00004204 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00004205 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004206 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00004207 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004208 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00004209 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00004210 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00004211 if (isa<ConstantPointerNull>(Arg))
4212 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004213 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004214 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00004215 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004216 }
Philip Reames9818dd72015-06-26 22:04:34 +00004217 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004218 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00004219 break;
4220 }
Reid Kleckner60381792015-07-07 22:25:32 +00004221 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00004222 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00004223 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004224 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00004225 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004226 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00004227 CS);
4228 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00004229 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00004230 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00004231 auto &Entry = FrameEscapeInfo[Fn];
4232 Entry.second = unsigned(
4233 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00004234 break;
4235 }
4236
Philip Reames1ffa9372015-01-30 23:28:05 +00004237 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004238 Assert(!CS.isInlineAsm(),
4239 "gc.statepoint support for inline assembly unimplemented", CS);
4240 Assert(CS.getParent()->getParent()->hasGC(),
4241 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004242
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004243 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004244 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004245 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004246 Assert(CS.getParent()->getParent()->hasGC(),
4247 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004248 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004249 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004250 const Function *StatepointFn =
4251 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004252 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4253 StatepointFn->getIntrinsicID() ==
4254 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004255 "gc.result operand #1 must be from a statepoint", CS,
4256 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004257
Philip Reamesb23713a2014-12-03 22:23:24 +00004258 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004259 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004260 auto *PT = cast<PointerType>(Target->getType());
4261 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004262 Assert(CS.getType() == TargetFuncType->getReturnType(),
4263 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004264 break;
4265 }
4266 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004267 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004268
Philip Reames3e2cf532016-01-07 03:32:11 +00004269 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4270 "gc.relocate must return a pointer or a vector of pointers", CS);
4271
Igor Laevsky9570ff92015-02-19 11:28:47 +00004272 // Check that this relocate is correctly tied to the statepoint
4273
4274 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004275 if (LandingPadInst *LandingPad =
4276 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004277
Sanjoy Das5665c992015-05-11 23:47:27 +00004278 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004279 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004280
4281 // Landingpad relocates should have only one predecessor with invoke
4282 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004283 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004284 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004285 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4286 InvokeBB);
4287 Assert(isStatepoint(InvokeBB->getTerminator()),
4288 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004289 }
4290 else {
4291 // In all other cases relocate should be tied to the statepoint directly.
4292 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004293 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004294 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004295 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004296 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004297 }
4298
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004299 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004300
Manuel Jacob83eefa62016-01-05 04:03:00 +00004301 ImmutableCallSite StatepointCS(
4302 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004303
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004304 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004305 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004306 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004307 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004308
Philip Reames9818dd72015-06-26 22:04:34 +00004309 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004310 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004311 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004312
4313 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4314 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4315 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004316 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004317 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004318 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004319 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004320
4321 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004322 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004323 Assert(StatepointCS.arg_size() > 0,
4324 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004325 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004326 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004327 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004328 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4329 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004330 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004331 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004332 "gc.statepoint: number of transition arguments must be "
4333 "a constant integer");
4334 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004335 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4336 ->getZExtValue();
4337 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004338 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004339 "gc.statepoint: number of deoptimization arguments must be "
4340 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004341 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004342 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4343 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004344 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004345 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004346 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4347 "gc.relocate: statepoint base index doesn't fall within the "
4348 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004349 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004350 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4351 "gc.relocate: statepoint derived index doesn't fall within the "
4352 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004353 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004354
Philip Reames3e2cf532016-01-07 03:32:11 +00004355 // Relocated value must be either a pointer type or vector-of-pointer type,
4356 // but gc_relocate does not need to return the same pointer type as the
4357 // relocated pointer. It can be casted to the correct type later if it's
4358 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004359 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Craig Topper95d23472017-07-09 07:04:00 +00004360 Assert(Relocate.getDerivedPtr()->getType()->isPtrOrPtrVectorTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004361 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004362
Philip Reames3e2cf532016-01-07 03:32:11 +00004363 auto ResultType = CS.getType();
4364 auto DerivedType = Relocate.getDerivedPtr()->getType();
4365 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004366 "gc.relocate: vector relocates to vector and pointer to pointer",
4367 CS);
4368 Assert(
4369 ResultType->getPointerAddressSpace() ==
4370 DerivedType->getPointerAddressSpace(),
4371 "gc.relocate: relocating a pointer shouldn't change its address space",
4372 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004373 break;
4374 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004375 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004376 case Intrinsic::eh_exceptionpointer: {
4377 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4378 "eh.exceptionpointer argument must be a catchpad", CS);
4379 break;
4380 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004381 case Intrinsic::masked_load: {
4382 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004383
Philip Reamesf16d7812016-02-09 21:43:12 +00004384 Value *Ptr = CS.getArgOperand(0);
4385 //Value *Alignment = CS.getArgOperand(1);
4386 Value *Mask = CS.getArgOperand(2);
4387 Value *PassThru = CS.getArgOperand(3);
4388 Assert(Mask->getType()->isVectorTy(),
4389 "masked_load: mask must be vector", CS);
4390
4391 // DataTy is the overloaded type
4392 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004393 Assert(DataTy == CS.getType(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004394 "masked_load: return must match pointer type", CS);
4395 Assert(PassThru->getType() == DataTy,
4396 "masked_load: pass through and data type must match", CS);
4397 Assert(Mask->getType()->getVectorNumElements() ==
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004398 DataTy->getVectorNumElements(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004399 "masked_load: vector mask must be same length as data", CS);
4400 break;
4401 }
4402 case Intrinsic::masked_store: {
4403 Value *Val = CS.getArgOperand(0);
4404 Value *Ptr = CS.getArgOperand(1);
4405 //Value *Alignment = CS.getArgOperand(2);
4406 Value *Mask = CS.getArgOperand(3);
4407 Assert(Mask->getType()->isVectorTy(),
4408 "masked_store: mask must be vector", CS);
4409
4410 // DataTy is the overloaded type
4411 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004412 Assert(DataTy == Val->getType(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004413 "masked_store: storee must match pointer type", CS);
4414 Assert(Mask->getType()->getVectorNumElements() ==
Matt Arsenaultb19b57e2017-04-28 20:25:27 +00004415 DataTy->getVectorNumElements(),
Philip Reamesf16d7812016-02-09 21:43:12 +00004416 "masked_store: vector mask must be same length as data", CS);
4417 break;
4418 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004419
Sanjoy Das021de052016-03-31 00:18:46 +00004420 case Intrinsic::experimental_guard: {
4421 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4422 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4423 "experimental_guard must have exactly one "
4424 "\"deopt\" operand bundle");
4425 break;
4426 }
4427
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004428 case Intrinsic::experimental_deoptimize: {
4429 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4430 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4431 "experimental_deoptimize must have exactly one "
4432 "\"deopt\" operand bundle");
4433 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4434 "experimental_deoptimize return type must match caller return type");
4435
4436 if (CS.isCall()) {
4437 auto *DeoptCI = CS.getInstruction();
4438 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4439 Assert(RI,
4440 "calls to experimental_deoptimize must be followed by a return");
4441
4442 if (!CS.getType()->isVoidTy() && RI)
4443 Assert(RI->getReturnValue() == DeoptCI,
4444 "calls to experimental_deoptimize must be followed by a return "
4445 "of the value computed by experimental_deoptimize");
4446 }
4447
4448 break;
4449 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004450 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004451}
4452
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004453/// \brief Carefully grab the subprogram from a local scope.
4454///
4455/// This carefully grabs the subprogram from a local scope, avoiding the
4456/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004457static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004458 if (!LocalScope)
4459 return nullptr;
4460
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004461 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004462 return SP;
4463
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004464 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004465 return getSubprogram(LB->getRawScope());
4466
4467 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004468 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004469 return nullptr;
4470}
4471
Andrew Kaylora0a11642017-01-26 23:27:59 +00004472void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) {
Andrew Kaylorf4660012017-05-25 21:31:00 +00004473 unsigned NumOperands = FPI.getNumArgOperands();
Wei Dinga131d3f2017-08-24 04:18:24 +00004474 Assert(((NumOperands == 5 && FPI.isTernaryOp()) ||
4475 (NumOperands == 3 && FPI.isUnaryOp()) || (NumOperands == 4)),
4476 "invalid arguments for constrained FP intrinsic", &FPI);
Andrew Kaylorf4660012017-05-25 21:31:00 +00004477 Assert(isa<MetadataAsValue>(FPI.getArgOperand(NumOperands-1)),
4478 "invalid exception behavior argument", &FPI);
4479 Assert(isa<MetadataAsValue>(FPI.getArgOperand(NumOperands-2)),
Andrew Kaylora0a11642017-01-26 23:27:59 +00004480 "invalid rounding mode argument", &FPI);
4481 Assert(FPI.getRoundingMode() != ConstrainedFPIntrinsic::rmInvalid,
4482 "invalid rounding mode argument", &FPI);
4483 Assert(FPI.getExceptionBehavior() != ConstrainedFPIntrinsic::ebInvalid,
4484 "invalid exception behavior argument", &FPI);
4485}
4486
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004487void Verifier::visitDbgIntrinsic(StringRef Kind, DbgInfoIntrinsic &DII) {
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004488 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004489 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004490 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4491 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004492 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004493 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4494 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004495 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004496 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4497 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004498
4499 // Ignore broken !dbg attachments; they're checked elsewhere.
4500 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004501 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004502 return;
4503
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004504 BasicBlock *BB = DII.getParent();
4505 Function *F = BB ? BB->getParent() : nullptr;
4506
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004507 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004508 DILocalVariable *Var = DII.getVariable();
4509 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004510 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4511 &DII, BB, F);
4512
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004513 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4514 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004515 if (!VarSP || !LocSP)
4516 return; // Broken scope chains are checked elsewhere.
4517
Adrian Prantla2ef0472016-09-14 17:30:37 +00004518 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4519 " variable and !dbg attachment",
4520 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4521 Loc->getScope()->getSubprogram());
Adrian Prantl612ac862017-02-28 23:48:42 +00004522
4523 verifyFnArgs(DII);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004524}
4525
Adrian Prantl941fa752016-12-05 18:04:47 +00004526void Verifier::verifyFragmentExpression(const DbgInfoIntrinsic &I) {
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004527 DILocalVariable *V = dyn_cast_or_null<DILocalVariable>(I.getRawVariable());
4528 DIExpression *E = dyn_cast_or_null<DIExpression>(I.getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004529
4530 // We don't know whether this intrinsic verified correctly.
4531 if (!V || !E || !E->isValid())
4532 return;
4533
Adrian Prantl28454ef2017-08-31 00:07:33 +00004534 // Nothing to do if this isn't a DW_OP_LLVM_fragment expression.
Adrian Prantl49797ca2016-12-22 05:27:12 +00004535 auto Fragment = E->getFragmentInfo();
4536 if (!Fragment)
Keno Fischer253a7bd2016-01-15 02:12:38 +00004537 return;
4538
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004539 // The frontend helps out GDB by emitting the members of local anonymous
4540 // unions as artificial local variables with shared storage. When SROA splits
4541 // the storage for artificial local variables that are smaller than the entire
4542 // union, the overhang piece will be outside of the allotted space for the
4543 // variable and this check fails.
4544 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4545 if (V->isArtificial())
4546 return;
4547
Adrian Prantl28454ef2017-08-31 00:07:33 +00004548 verifyFragmentExpression(*V, *Fragment, &I);
4549}
4550
4551template <typename ValueOrMetadata>
4552void Verifier::verifyFragmentExpression(const DIVariable &V,
4553 DIExpression::FragmentInfo Fragment,
4554 ValueOrMetadata *Desc) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004555 // If there's no size, the type is broken, but that should be checked
4556 // elsewhere.
Adrian Prantl3e0e1d02017-11-28 00:57:51 +00004557 auto VarSize = V.getSizeInBits();
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004558 if (!VarSize)
4559 return;
4560
Adrian Prantl28454ef2017-08-31 00:07:33 +00004561 unsigned FragSize = Fragment.SizeInBits;
4562 unsigned FragOffset = Fragment.OffsetInBits;
Adrian Prantl3e0e1d02017-11-28 00:57:51 +00004563 AssertDI(FragSize + FragOffset <= *VarSize,
Adrian Prantl28454ef2017-08-31 00:07:33 +00004564 "fragment is larger than or outside of variable", Desc, &V);
Adrian Prantl3e0e1d02017-11-28 00:57:51 +00004565 AssertDI(FragSize != *VarSize, "fragment covers entire variable", Desc, &V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004566}
4567
Adrian Prantl612ac862017-02-28 23:48:42 +00004568void Verifier::verifyFnArgs(const DbgInfoIntrinsic &I) {
Adrian Prantl63d96952017-03-07 17:28:54 +00004569 // This function does not take the scope of noninlined function arguments into
4570 // account. Don't run it if current function is nodebug, because it may
4571 // contain inlined debug intrinsics.
4572 if (!HasDebugInfo)
4573 return;
4574
Reid Kleckner3cdf7132017-09-07 22:46:24 +00004575 // For performance reasons only check non-inlined ones.
4576 if (I.getDebugLoc()->getInlinedAt())
4577 return;
4578
4579 DILocalVariable *Var = I.getVariable();
Adrian Prantl612ac862017-02-28 23:48:42 +00004580 AssertDI(Var, "dbg intrinsic without variable");
4581
4582 unsigned ArgNo = Var->getArg();
4583 if (!ArgNo)
4584 return;
4585
4586 // Verify there are no duplicate function argument debug info entries.
4587 // These will cause hard-to-debug assertions in the DWARF backend.
4588 if (DebugFnArgs.size() < ArgNo)
4589 DebugFnArgs.resize(ArgNo, nullptr);
4590
4591 auto *Prev = DebugFnArgs[ArgNo - 1];
4592 DebugFnArgs[ArgNo - 1] = Var;
4593 AssertDI(!Prev || (Prev == Var), "conflicting debug info for argument", &I,
4594 Prev, Var);
4595}
4596
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004597void Verifier::verifyCompileUnits() {
Adrian Prantl5a82f0a42017-10-18 01:11:01 +00004598 // When more than one Module is imported into the same context, such as during
4599 // an LTO build before linking the modules, ODR type uniquing may cause types
4600 // to point to a different CU. This check does not make sense in this case.
4601 if (M.getContext().isODRUniquingDebugTypes())
4602 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004603 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004604 SmallPtrSet<const Metadata *, 2> Listed;
4605 if (CUs)
4606 Listed.insert(CUs->op_begin(), CUs->op_end());
Davide Italianoa9de0102017-02-20 22:51:42 +00004607 for (auto *CU : CUVisited)
4608 AssertDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU);
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004609 CUVisited.clear();
4610}
4611
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004612void Verifier::verifyDeoptimizeCallingConvs() {
4613 if (DeoptimizeDeclarations.empty())
4614 return;
4615
4616 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004617 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004618 Assert(First->getCallingConv() == F->getCallingConv(),
4619 "All llvm.experimental.deoptimize declarations must have the same "
4620 "calling convention",
4621 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004622 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004623}
4624
Chris Lattner0e851da2002-04-18 20:37:37 +00004625//===----------------------------------------------------------------------===//
4626// Implement the public interfaces to this file...
4627//===----------------------------------------------------------------------===//
4628
Chandler Carruth043949d2014-01-19 02:22:18 +00004629bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004630 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004631
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004632 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004633 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004634
4635 // Note that this function's return value is inverted from what you would
4636 // expect of a function called "verify".
4637 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004638}
4639
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004640bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4641 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004642 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004643 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004644
Chandler Carruth043949d2014-01-19 02:22:18 +00004645 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004646 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004647 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004648
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004649 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004650 if (BrokenDebugInfo)
4651 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004652 // Note that this function's return value is inverted from what you would
4653 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004654 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004655}
Chandler Carruth043949d2014-01-19 02:22:18 +00004656
4657namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004658
Chandler Carruth4d356312014-01-20 11:34:08 +00004659struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004660 static char ID;
4661
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004662 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004663 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004664
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004665 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004666 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004667 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004668 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004669 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004670 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004671 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004672 }
4673
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004674 bool doInitialization(Module &M) override {
4675 V = llvm::make_unique<Verifier>(
4676 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4677 return false;
4678 }
4679
Craig Topperf398d7c2014-03-05 06:35:38 +00004680 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004681 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004682 report_fatal_error("Broken function found, compilation aborted!");
4683
4684 return false;
4685 }
4686
Craig Topperf398d7c2014-03-05 06:35:38 +00004687 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004688 bool HasErrors = false;
4689 for (Function &F : M)
4690 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004691 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004692
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004693 HasErrors |= !V->verify();
Adrian Prantla8b2ddb2017-10-02 18:31:29 +00004694 if (FatalErrors && (HasErrors || V->hasBrokenDebugInfo()))
4695 report_fatal_error("Broken module found, compilation aborted!");
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004696 return false;
4697 }
4698
4699 void getAnalysisUsage(AnalysisUsage &AU) const override {
4700 AU.setPreservesAll();
4701 }
4702};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004703
4704} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004705
Mehdi Aminia84a8402016-12-16 06:29:14 +00004706/// Helper to issue failure from the TBAA verification
4707template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) {
4708 if (Diagnostic)
4709 return Diagnostic->CheckFailed(Args...);
4710}
4711
4712#define AssertTBAA(C, ...) \
4713 do { \
4714 if (!(C)) { \
4715 CheckFailed(__VA_ARGS__); \
4716 return false; \
4717 } \
4718 } while (false)
4719
4720/// Verify that \p BaseNode can be used as the "base type" in the struct-path
4721/// TBAA scheme. This means \p BaseNode is either a scalar node, or a
4722/// struct-type node describing an aggregate data structure (like a struct).
4723TBAAVerifier::TBAABaseNodeSummary
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004724TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode,
4725 bool IsNewFormat) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004726 if (BaseNode->getNumOperands() < 2) {
4727 CheckFailed("Base nodes must have at least two operands", &I, BaseNode);
4728 return {true, ~0u};
4729 }
4730
4731 auto Itr = TBAABaseNodes.find(BaseNode);
4732 if (Itr != TBAABaseNodes.end())
4733 return Itr->second;
4734
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004735 auto Result = verifyTBAABaseNodeImpl(I, BaseNode, IsNewFormat);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004736 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result});
4737 (void)InsertResult;
4738 assert(InsertResult.second && "We just checked!");
4739 return Result;
4740}
4741
4742TBAAVerifier::TBAABaseNodeSummary
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004743TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode,
4744 bool IsNewFormat) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004745 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u};
4746
4747 if (BaseNode->getNumOperands() == 2) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004748 // Scalar nodes can only be accessed at offset 0.
Sanjoy Das00d76a52016-12-29 15:47:05 +00004749 return isValidScalarTBAANode(BaseNode)
4750 ? TBAAVerifier::TBAABaseNodeSummary({false, 0})
4751 : InvalidNode;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004752 }
4753
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004754 if (IsNewFormat) {
4755 if (BaseNode->getNumOperands() % 3 != 0) {
4756 CheckFailed("Access tag nodes must have the number of operands that is a "
4757 "multiple of 3!", BaseNode);
4758 return InvalidNode;
4759 }
4760 } else {
4761 if (BaseNode->getNumOperands() % 2 != 1) {
4762 CheckFailed("Struct tag nodes must have an odd number of operands!",
4763 BaseNode);
4764 return InvalidNode;
4765 }
Mehdi Aminia84a8402016-12-16 06:29:14 +00004766 }
4767
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004768 // Check the type size field.
4769 if (IsNewFormat) {
4770 auto *TypeSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
4771 BaseNode->getOperand(1));
4772 if (!TypeSizeNode) {
4773 CheckFailed("Type size nodes must be constants!", &I, BaseNode);
4774 return InvalidNode;
4775 }
4776 }
4777
4778 // Check the type name field. In the new format it can be anything.
4779 if (!IsNewFormat && !isa<MDString>(BaseNode->getOperand(0))) {
Sanjoy Das00d76a52016-12-29 15:47:05 +00004780 CheckFailed("Struct tag nodes have a string as their first operand",
4781 BaseNode);
4782 return InvalidNode;
4783 }
4784
Mehdi Aminia84a8402016-12-16 06:29:14 +00004785 bool Failed = false;
4786
4787 Optional<APInt> PrevOffset;
4788 unsigned BitWidth = ~0u;
4789
4790 // We've already checked that BaseNode is not a degenerate root node with one
4791 // operand in \c verifyTBAABaseNode, so this loop should run at least once.
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004792 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
4793 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
4794 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
4795 Idx += NumOpsPerField) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004796 const MDOperand &FieldTy = BaseNode->getOperand(Idx);
4797 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1);
4798 if (!isa<MDNode>(FieldTy)) {
4799 CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode);
4800 Failed = true;
4801 continue;
4802 }
4803
4804 auto *OffsetEntryCI =
4805 mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset);
4806 if (!OffsetEntryCI) {
4807 CheckFailed("Offset entries must be constants!", &I, BaseNode);
4808 Failed = true;
4809 continue;
4810 }
4811
4812 if (BitWidth == ~0u)
4813 BitWidth = OffsetEntryCI->getBitWidth();
4814
4815 if (OffsetEntryCI->getBitWidth() != BitWidth) {
4816 CheckFailed(
4817 "Bitwidth between the offsets and struct type entries must match", &I,
4818 BaseNode);
4819 Failed = true;
4820 continue;
4821 }
4822
4823 // NB! As far as I can tell, we generate a non-strictly increasing offset
4824 // sequence only from structs that have zero size bit fields. When
4825 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we
4826 // pick the field lexically the latest in struct type metadata node. This
4827 // mirrors the actual behavior of the alias analysis implementation.
4828 bool IsAscending =
4829 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue());
4830
4831 if (!IsAscending) {
4832 CheckFailed("Offsets must be increasing!", &I, BaseNode);
4833 Failed = true;
4834 }
4835
4836 PrevOffset = OffsetEntryCI->getValue();
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004837
4838 if (IsNewFormat) {
4839 auto *MemberSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
4840 BaseNode->getOperand(Idx + 2));
4841 if (!MemberSizeNode) {
4842 CheckFailed("Member size entries must be constants!", &I, BaseNode);
4843 Failed = true;
4844 continue;
4845 }
4846 }
Mehdi Aminia84a8402016-12-16 06:29:14 +00004847 }
4848
4849 return Failed ? InvalidNode
4850 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth);
4851}
4852
4853static bool IsRootTBAANode(const MDNode *MD) {
4854 return MD->getNumOperands() < 2;
4855}
4856
4857static bool IsScalarTBAANodeImpl(const MDNode *MD,
4858 SmallPtrSetImpl<const MDNode *> &Visited) {
Sanjoy Das00d76a52016-12-29 15:47:05 +00004859 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3)
Mehdi Aminia84a8402016-12-16 06:29:14 +00004860 return false;
4861
Sanjoy Das00d76a52016-12-29 15:47:05 +00004862 if (!isa<MDString>(MD->getOperand(0)))
Mehdi Aminia84a8402016-12-16 06:29:14 +00004863 return false;
4864
Sanjoy Das00d76a52016-12-29 15:47:05 +00004865 if (MD->getNumOperands() == 3) {
4866 auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2));
4867 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0))))
4868 return false;
4869 }
4870
4871 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4872 return Parent && Visited.insert(Parent).second &&
Mehdi Aminia84a8402016-12-16 06:29:14 +00004873 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited));
4874}
4875
Sanjoy Das55f12d92016-12-29 15:46:57 +00004876bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) {
4877 auto ResultIt = TBAAScalarNodes.find(MD);
4878 if (ResultIt != TBAAScalarNodes.end())
4879 return ResultIt->second;
4880
Mehdi Aminia84a8402016-12-16 06:29:14 +00004881 SmallPtrSet<const MDNode *, 4> Visited;
Sanjoy Das55f12d92016-12-29 15:46:57 +00004882 bool Result = IsScalarTBAANodeImpl(MD, Visited);
4883 auto InsertResult = TBAAScalarNodes.insert({MD, Result});
4884 (void)InsertResult;
4885 assert(InsertResult.second && "Just checked!");
4886
4887 return Result;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004888}
4889
4890/// Returns the field node at the offset \p Offset in \p BaseNode. Update \p
4891/// Offset in place to be the offset within the field node returned.
4892///
4893/// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode.
4894MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I,
Sanjoy Das600d2a52016-12-29 15:47:01 +00004895 const MDNode *BaseNode,
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004896 APInt &Offset,
4897 bool IsNewFormat) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004898 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!");
4899
4900 // Scalar nodes have only one possible "field" -- their parent in the access
4901 // hierarchy. Offset must be zero at this point, but our caller is supposed
4902 // to Assert that.
4903 if (BaseNode->getNumOperands() == 2)
4904 return cast<MDNode>(BaseNode->getOperand(1));
4905
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004906 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1;
4907 unsigned NumOpsPerField = IsNewFormat ? 3 : 2;
4908 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands();
4909 Idx += NumOpsPerField) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004910 auto *OffsetEntryCI =
4911 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1));
4912 if (OffsetEntryCI->getValue().ugt(Offset)) {
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004913 if (Idx == FirstFieldOpNo) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004914 CheckFailed("Could not find TBAA parent in struct type node", &I,
4915 BaseNode, &Offset);
4916 return nullptr;
4917 }
4918
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004919 unsigned PrevIdx = Idx - NumOpsPerField;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004920 auto *PrevOffsetEntryCI =
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004921 mdconst::extract<ConstantInt>(BaseNode->getOperand(PrevIdx + 1));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004922 Offset -= PrevOffsetEntryCI->getValue();
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004923 return cast<MDNode>(BaseNode->getOperand(PrevIdx));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004924 }
4925 }
4926
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004927 unsigned LastIdx = BaseNode->getNumOperands() - NumOpsPerField;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004928 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>(
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004929 BaseNode->getOperand(LastIdx + 1));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004930 Offset -= LastOffsetEntryCI->getValue();
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004931 return cast<MDNode>(BaseNode->getOperand(LastIdx));
4932}
4933
4934static bool isNewFormatTBAATypeNode(llvm::MDNode *Type) {
4935 if (!Type || Type->getNumOperands() < 3)
4936 return false;
4937
4938 // In the new format type nodes shall have a reference to the parent type as
4939 // its first operand.
4940 MDNode *Parent = dyn_cast_or_null<MDNode>(Type->getOperand(0));
4941 if (!Parent)
4942 return false;
4943
4944 return true;
Mehdi Aminia84a8402016-12-16 06:29:14 +00004945}
4946
Sanjoy Das600d2a52016-12-29 15:47:01 +00004947bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00004948 AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) ||
Sanjoy Das600d2a52016-12-29 15:47:01 +00004949 isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) ||
4950 isa<AtomicCmpXchgInst>(I),
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004951 "This instruction shall not have a TBAA access tag!", &I);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004952
4953 bool IsStructPathTBAA =
4954 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3;
4955
4956 AssertTBAA(
4957 IsStructPathTBAA,
4958 "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I);
4959
Mehdi Aminia84a8402016-12-16 06:29:14 +00004960 MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0));
4961 MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1));
4962
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004963 bool IsNewFormat = isNewFormatTBAATypeNode(AccessType);
4964
4965 if (IsNewFormat) {
4966 AssertTBAA(MD->getNumOperands() == 4 || MD->getNumOperands() == 5,
4967 "Access tag metadata must have either 4 or 5 operands", &I, MD);
4968 } else {
4969 AssertTBAA(MD->getNumOperands() < 5,
4970 "Struct tag metadata must have either 3 or 4 operands", &I, MD);
4971 }
4972
4973 // Check the access size field.
4974 if (IsNewFormat) {
4975 auto *AccessSizeNode = mdconst::dyn_extract_or_null<ConstantInt>(
4976 MD->getOperand(3));
4977 AssertTBAA(AccessSizeNode, "Access size field must be a constant", &I, MD);
4978 }
4979
4980 // Check the immutability flag.
4981 unsigned ImmutabilityFlagOpNo = IsNewFormat ? 4 : 3;
4982 if (MD->getNumOperands() == ImmutabilityFlagOpNo + 1) {
4983 auto *IsImmutableCI = mdconst::dyn_extract_or_null<ConstantInt>(
4984 MD->getOperand(ImmutabilityFlagOpNo));
Mehdi Aminia84a8402016-12-16 06:29:14 +00004985 AssertTBAA(IsImmutableCI,
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004986 "Immutability tag on struct tag metadata must be a constant",
4987 &I, MD);
Mehdi Aminia84a8402016-12-16 06:29:14 +00004988 AssertTBAA(
4989 IsImmutableCI->isZero() || IsImmutableCI->isOne(),
4990 "Immutability part of the struct tag metadata must be either 0 or 1",
4991 &I, MD);
4992 }
4993
4994 AssertTBAA(BaseNode && AccessType,
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004995 "Malformed struct tag metadata: base and access-type "
Mehdi Aminia84a8402016-12-16 06:29:14 +00004996 "should be non-null and point to Metadata nodes",
4997 &I, MD, BaseNode, AccessType);
4998
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00004999 if (!IsNewFormat) {
5000 AssertTBAA(isValidScalarTBAANode(AccessType),
5001 "Access type node must be a valid scalar type", &I, MD,
5002 AccessType);
5003 }
Mehdi Aminia84a8402016-12-16 06:29:14 +00005004
5005 auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2));
5006 AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD);
5007
5008 APInt Offset = OffsetCI->getValue();
5009 bool SeenAccessTypeInPath = false;
5010
5011 SmallPtrSet<MDNode *, 4> StructPath;
5012
5013 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode);
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00005014 BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset,
5015 IsNewFormat)) {
Mehdi Aminia84a8402016-12-16 06:29:14 +00005016 if (!StructPath.insert(BaseNode).second) {
5017 CheckFailed("Cycle detected in struct path", &I, MD);
5018 return false;
5019 }
5020
5021 bool Invalid;
5022 unsigned BaseNodeBitWidth;
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00005023 std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode,
5024 IsNewFormat);
Mehdi Aminia84a8402016-12-16 06:29:14 +00005025
5026 // If the base node is invalid in itself, then we've already printed all the
5027 // errors we wanted to print.
5028 if (Invalid)
5029 return false;
5030
5031 SeenAccessTypeInPath |= BaseNode == AccessType;
5032
Sanjoy Das55f12d92016-12-29 15:46:57 +00005033 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType)
Mehdi Aminia84a8402016-12-16 06:29:14 +00005034 AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access",
5035 &I, MD, &Offset);
5036
5037 AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() ||
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00005038 (BaseNodeBitWidth == 0 && Offset == 0) ||
5039 (IsNewFormat && BaseNodeBitWidth == ~0u),
Mehdi Aminia84a8402016-12-16 06:29:14 +00005040 "Access bit-width not the same as description bit-width", &I, MD,
5041 BaseNodeBitWidth, Offset.getBitWidth());
Ivan A. Kosarev422a3802017-12-18 18:46:44 +00005042
5043 if (IsNewFormat && SeenAccessTypeInPath)
5044 break;
Mehdi Aminia84a8402016-12-16 06:29:14 +00005045 }
5046
5047 AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!",
5048 &I, MD);
5049 return true;
5050}
5051
Chandler Carruth4d356312014-01-20 11:34:08 +00005052char VerifierLegacyPass::ID = 0;
5053INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00005054
5055FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00005056 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00005057}
5058
Chandler Carruthdab4eae2016-11-23 17:53:26 +00005059AnalysisKey VerifierAnalysis::Key;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00005060VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
5061 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00005062 Result Res;
5063 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
5064 return Res;
5065}
Chandler Carruth4d356312014-01-20 11:34:08 +00005066
Chandler Carruth164a2aa62016-06-17 00:11:01 +00005067VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
5068 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00005069 return { llvm::verifyFunction(F, &dbgs()), false };
5070}
5071
5072PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
5073 auto Res = AM.getResult<VerifierAnalysis>(M);
Adrian Prantla8b2ddb2017-10-02 18:31:29 +00005074 if (FatalErrors && (Res.IRBroken || Res.DebugInfoBroken))
5075 report_fatal_error("Broken module found, compilation aborted!");
Adrian Prantle3656182016-05-09 19:57:29 +00005076
Chandler Carruth4d356312014-01-20 11:34:08 +00005077 return PreservedAnalyses::all();
5078}
5079
Adrian Prantle3656182016-05-09 19:57:29 +00005080PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
5081 auto res = AM.getResult<VerifierAnalysis>(F);
5082 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00005083 report_fatal_error("Broken function found, compilation aborted!");
5084
5085 return PreservedAnalyses::all();
5086}